Updated "chainhooks service with bitcoind" How To doc #377
Conversation
|
|
||
| > **_NOTE:_** | ||
| > | ||
| > While bitcoind can and will start syncing a Bitcoin node, customizing this node to your use cases beyond supporting a Chainhook is out of scope for this guide. See the Bitcoin wiki for [bitcoind](https://en.bitcoin.it/wiki/Bitcoind), ["Running Bitcoin"](https://en.bitcoin.it/wiki/Running_Bitcoin), or bitcoin.org's [Running A Full Node guide](https://bitcoin.org/en/full-node). |
There was a problem hiding this comment.
Did you mean? https://bitcoin.org/ for bitcoin.org's?
| - Now, the predicate registration server is running at `localhost:20456`. To dynamically register a new predicate, send a POST request to `localhost:20456/v1/chainhooks` with the new predicate, in JSON format, included in the request body. For complete documentation on the API endpoints available, see the [OpenAPI](https://raw.githubusercontent.com/hirosystems/chainhook/develop/docs/chainhook-openapi.json) specification. | ||
| -  | ||
|
|
||
| The sample payload response should look like this: |
There was a problem hiding this comment.
Is it intended to remove the sample payload response?
| chainhook service start --predicate-path=ordinals_protocol.json --config-path=Chainhook.toml | ||
| ``` | ||
|
|
||
| The above command registers the predicates based on the predicate definition in the `ordinals_protocol.json` file. |
There was a problem hiding this comment.
I think it is important to specify. May I know why we are deleting this?
|
|
||
| - Initiate the chainhook service by passing the predicate path to the command as shown below. | ||
|
|
||
| ```console |
There was a problem hiding this comment.
How do we start the service if this is removed?
Some typos and language changes.
|
so there's a couple things here that ill create some issues for, but wanted to add here to provide some context since its docs related: ingesting historical data and triggering actions based on predicates when using Chainhook as a Service:
better examples:
|
Clarifying language to bitcoind guide
| - Get the downloaded path of the bitcoind from the [prerequisites section](#prerequisites) and use it in the `datadir` configuration below. | ||
| > **_NOTE:_** | ||
| > | ||
| > While bitcoind can and will start syncing a Bitcoin node, customizing this node to your use cases beyond supporting a Chainhook is out of scope for this guide. See the Bitcoin wiki for ["Running Bitcoin"](https://en.bitcoin.it/wiki/Running_Bitcoin) or bitcoin.org [Running A Full Node guide](https://bitcoin.org/en/full-node). |
| @@ -2,18 +2,22 @@ | |||
| title: Run Chainhook as a Service using Bitcoind | |||
| --- | |||
|
|
|||
| You can run Chainhook as a service to evaluate Bitcoin against your predicates. You can also dynamically register new predicates by enabling predicates registration API. | |||
| You can run Chainhook as a service to evaluate your `if_this / then_that` predicates against the Bitcoin blockchain, delivering results—either file appendations or HTTP POST requests to a server you designate—for your application's use case. You can also dynamically register new predicates as the service is running by enabling the predicates registration API. | |||
There was a problem hiding this comment.
Chainhook can be used as a service to assess your 'if_this / then_that' predicates against the Bitcoin blockchain. This delivers outcomes by appending files or making HTTP POST requests to your chosen server for your application's needs. You can also dynamically register new predicates as the service runs by enabling the predicates registration API.
|
@mefrem @ryanwaits: LGTM, just a few re-wordings that I suggested. |
|
🎉 This PR is included in version 1.1.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Description
The "Run Chainhook as a Service using Bitcoind" guide was revamped in advance of Chainhooks general launch.
Breaking change?
N/A
Example
N/A
Checklist