docs: update chainhook guides #384
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
Fixed a pathname error in docs, fixed a typo, and added some clarifying language to other sections. - Fixed `bitcoind` and `bitcoin.conf` pathnames - Removed double words "predicates" - Clarified bitcoind node setup instructions
ryanwaits
reviewed
Aug 15, 2023
MicaiahReid
suggested changes
Aug 16, 2023
docs/how-to-guides/how-to-run-chainhook-as-a-service-using-bitcoind.md
Outdated
Show resolved
Hide resolved
docs/how-to-guides/how-to-run-chainhook-as-a-service-using-bitcoind.md
Outdated
Show resolved
Hide resolved
docs/how-to-guides/how-to-run-chainhook-as-a-service-using-bitcoind.md
Outdated
Show resolved
Hide resolved
docs/how-to-guides/how-to-run-chainhook-as-a-service-using-bitcoind.md
Outdated
Show resolved
Hide resolved
| @@ -132,7 +130,7 @@ Here is a table of the relevant parameters this guide changes in our configurati | |||
|
|
|||
| ## Scan blockchain based on predicates | |||
|
|
|||
| Now that your bitcoind and Chainhook configurations are complete, you can define the [predicates](../overview.md#if-this-predicate-design) you would like to scan against bitcoin blocks [predicates](../overview.md#if-this-predicate-design). These predicates are where the user specifies the kinds of blockchain events they want their Chainhook to trigger to the deliver a result (either a file appendation or an HTTP POST result). This section helps you with an example JSON file to scan a range of blocks in the blockchain to trigger results. To understand the supported predicates for Bitcoin, refer to [how to use chainhooks with bitcoin](how-to-use-chainhooks-with-bitcoin.md). | |||
| Now that your bitcoind and Chainhook configurations are complete, you can define the Chainhook [predicates](../overview.md#if-this-predicate-design) you would like to scan against bitcoin blocks. These predicates are where the user specifies the kinds of blockchain events that trigger a Chainhook to the deliver a result (either a file appendation or an HTTP POST request). This section helps you with an example JSON file to scan a range of blocks in the blockchain to trigger results. To understand the supported predicates for Bitcoin, refer to [how to use chainhooks with bitcoin](how-to-use-chainhooks-with-bitcoin.md). | |||
There was a problem hiding this comment.
Suggested change
| Now that your bitcoind and Chainhook configurations are complete, you can define the Chainhook [predicates](../overview.md#if-this-predicate-design) you would like to scan against bitcoin blocks. These predicates are where the user specifies the kinds of blockchain events that trigger a Chainhook to the deliver a result (either a file appendation or an HTTP POST request). This section helps you with an example JSON file to scan a range of blocks in the blockchain to trigger results. To understand the supported predicates for Bitcoin, refer to [how to use chainhooks with bitcoin](how-to-use-chainhooks-with-bitcoin.md). | |
| Now that your bitcoind and Chainhook configurations are complete, you can define the Chainhook [predicates](../overview.md#if-this-predicate-design) you would like to scan against bitcoin blocks. These predicates are where the user specifies the kinds of blockchain events that trigger Chainhook to deliver a result (either a file appendation or an HTTP POST request). This section helps you with an example JSON file to scan a range of blocks in the blockchain to trigger results. To understand the supported predicates for Bitcoin, refer to [how to use chainhooks with bitcoin](how-to-use-chainhooks-with-bitcoin.md). |
Including @MicaiahReid's and @ryanwaits's comments, added some other small changes.
Two more Micaiah additions.
|
All changes suggested by @MicaiahReid look good to me, manually added. Would love to merge and get one more Docs release update before webinar. |
MicaiahReid
approved these changes
Aug 17, 2023
|
🎉 This PR is included in version 1.1.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
@mefrem: Fixed a pathname error in docs, fixed a typo, and added some clarifying language to other sections.
bitcoindandbitcoin.confpathnames@ryanwaits to add changes/comments to the "Run Chainhook as a Service using Stacks" How To guide