add example `low-level API for the chain head driver`
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 489
- Forks
- 293
- Avg merge
- 18h 35m
- Merged PRs (30d)
- 3
Description
Currently we have only provided one example how to initialize the chainHead backend with the background task provided by subxt, found here
However, it's also possible to use the low-level API where the user is responsible for polling the driver themselves and we need be extra clear that the driver to be run to completion to shutdown properly.
For instance if one bail on the first error seen, the stopped state may not be propagated properly. See #1817 for further explanation about that.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with subxt/examples/setup_rpc_chainhead_backend.rs and the low-level API in subxt/src/backend/chain_head/mod.rs. Add an example showing users polling the driver themselves and running it to completion so shutdown state is propagated correctly; use #1817 for the error-handling context.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100