kylefang/bitcoin-indexer
1
0
Fork 0
mirror of https://github.com/alexgo-io/bitcoin-indexer.git synced 2026-01-12 16:52:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: upgrade service start implementation + documentation

Browse Source
This commit is contained in:
Ludo Galabru
2023-04-04 11:14:02 -04:00
parent 6516155055
commit 02db65e417
6 changed files with 142 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -604,7 +604,24 @@ Tbe first time this command run, a chainstate archive will be downloaded, uncomp
The subsequent scans will use the cached chainstate if already present, speeding up iterations and the overall feedback loop.
---
## Running `chainhook` in production mode
## Run `chainhook` as a service for streaming new blocks
To be documented.
`chainhook` can be ran as a background service for streaming and processing new canonical blocks appended to the Bitcoin and Stacks blockchains.
When running chainhook as a service, `if_this` / `then_that` predicates can be registered by passing the path of the `json` file in the command line:
```bash
$ chainhook service start --predicate-path=./path/to/predicate-1.json --predicate-path=./path/to/predicate-2.json --config-path=./path/to/config.toml
```
Predicates can also be added dynamically. When the `--predicate-path` option is not passed or when the `--start-http-api` option is passed, `chainhook` will instantiate a REST API allowing developers to list, add and removes preducates at runtime:
```bash
$ chainhook service start --config-path=./path/to/config.toml
```
```bash
$ chainhook service start --predicate-path=./path/to/predicate-1.json --start-http-api --config-path=./path/to/config.toml
```
A comprehensive OpenAPI spcification explaining how to interact with the Chainhook REST API can be found [here](./docs/chainhook-openapi.json).