Add proper examples to `subxt_rpcs`
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 489
- Forks
- 293
- Avg merge
- 18h 35m
- Merged PRs (30d)
- 3
Description
https://github.com/jsdw/dot-block-decoder/blob/main/src/main.rs shows a use of subxt_rpcs in isolation.
It would be good to have proper examples with the crate or in the docs! eg what should the RpcConfig look like? The usual approach and one taken above is to just import subxt_core to get the core configs eg PolkadotConfig and then enable the subxt feature in subxt_rpcs to allow us to use this as our RPC Config too.
Let's show this in a proper example or two.
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 the linked src/main.rs example and inspect the existing subxt_rpcs documentation and example structure. Add one or two proper examples showing RpcConfig, including the subxt feature and use of subxt_core's PolkadotConfig, then verify that the examples compile and clearly demonstrate the usual setup.
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
- Mostly clear
- Newbie friendliness
- 45/100