-
Notifications
You must be signed in to change notification settings - Fork 61
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
update generated config with additional comments #382
Conversation
# Chainhook must be able to receive Bitcoin block events. | ||
# These events can originate from either a Stacks node or a Bitcoin node's ZeroMQ interface. | ||
|
||
# By default, the service is set to receive Bitcoin block events from the Stacks node (via burnchain): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"via burnchain" might beg some context... Burnchain is a deprecated PoX v1 term that persists in old Stacks Node software. Not even some (a lot of?) Stacks users might know what it is. Is there a better way to put it?
Made a comment, otherwise looks great! This is exactly what @MicaiahReid thought would make the docs stronger is providing more context to developers about "what is needed and when". |
@@ -36,6 +39,9 @@ max_number_of_processing_threads = 16 | |||
max_number_of_networking_threads = 16 | |||
max_caching_memory_size_mb = 32000 | |||
|
|||
# If you don't require historical data for your predicates or wish to avoid downloading |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The TSV file is not downloaded every time. It is downloaded once, and future runs use that cached version until a new one is available.
Added @MicaiahReid's suggestions.
Co-authored-by: Micaiah Reid <micaiahreid@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @ryanwaits!
🎉 This PR is included in version 1.2.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Description
update comments in the generated
Chainhook.toml
file around thestacks_node_rpc_url
andbitcoind_zmq_url
to add a bit more clarity around what they are and when to use one over the other.Checklist