update generated config with additional comments #382
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mefrem
reviewed
Aug 11, 2023
| # 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.
"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". |
MicaiahReid
reviewed
Aug 11, 2023
| @@ -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.
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.
MicaiahReid
reviewed
Aug 14, 2023
Added @MicaiahReid's suggestions.
Co-authored-by: Micaiah Reid <[email protected]>
lgalabru
had a problem deploying
to
Development-mainnet
GitHub Actions
Failure
lgalabru
had a problem deploying
to
Development-testnet
GitHub Actions
Failure
|
🎉 This PR is included in version 1.2.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
update comments in the generated
Chainhook.tomlfile around thestacks_node_rpc_urlandbitcoind_zmq_urlto add a bit more clarity around what they are and when to use one over the other.Checklist