-
Notifications
You must be signed in to change notification settings - Fork 78
Show the Chain Interactions section #1344
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: staging/product-ia
Are you sure you want to change the base?
Conversation
* Add runtime API calls guide with SDK examples Add comprehensive guide for calling runtime APIs using PAPI, Polkadot.js, Dedot, Python Substrate Interface, and Subxt. Examples demonstrate AccountNonceApi and Metadata runtime API calls with complete, tested code snippets for each SDK. * Refactor runtime API calls guide to use Polkadot Hub TestNet - Update all examples to use Paseo Asset Hub endpoint (wss://asset-hub-paseo.dotters.network) - Change PAPI types generation to use polkadotTestNet descriptor - Update console output messages to show "Connected to Polkadot Hub TestNet" - Update HTML output snippets to reflect testnet connection - Update Python output to show asset-hub-paseo spec name * Update .chain-interactions/query-data/runtime-api-calls.md Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> * Update .snippets/code/chain-interactions/query-data/runtime-api-calls/psi/runtime_apis.py Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> * Update .chain-interactions/query-data/runtime-api-calls.md Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> * Update .snippets/code/chain-interactions/query-data/runtime-api-calls/dedot/runtime-apis.ts Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> * Rename ASSET_HUB_RPC to POLKADOT_TESTNET_RPC in all code snippets * Rename Subxt metadata file to polkadot_testnet_metadata.scale * Update .snippets/code/chain-interactions/query-data/runtime-api-calls/papi/runtime-apis.ts Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> * formating review * Update .chain-interactions/query-data/runtime-api-calls.md * Update .chain-interactions/query-data/runtime-api-calls.md --------- Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> Co-authored-by: 0xlukem <lucas.malizia27@gmail.com> Co-authored-by: Erin Shaben <eshaben@icloud.com>
* add query with rest api * Fix Cargo.toml workspace member referencing removed tutorial * Add dummy crate to satisfy Cargo workspace CI requirements * update content * Remove unused Cargo workspace and CI workflow * Update .chain-interactions/query-data/query-rest.md Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> * Use placeholders consistently in asset balance queries Replace hardcoded asset IDs with placeholders in the main code blocks and add collapsible example sections with real USDT/USDC asset IDs. * wip * styling * feedback * Convert REST API responses to termynal format and document pallet storage fields - Convert all JSON response snippets to termynal HTML format for consistency - Add pallet, palletIndex, storageItem, and keys field documentation for Query Asset Metadata and Query Asset Details sections - Include at.hash and at.height fields in response tables --------- Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> Co-authored-by: 0xlukem <lucas.malizia27@gmail.com> Co-authored-by: Erin Shaben <eshaben@icloud.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR introduces a comprehensive "Chain Interactions" section to the documentation, providing guides for developers to query blockchain data, send transactions, manage tokens, and handle accounts across the Polkadot ecosystem. The section is being prepared for launch and includes extensive documentation with code examples across multiple SDKs (PAPI, Polkadot.js, Dedot, Python Substrate Interface, and Subxt).
Key changes:
- Uncommented the "Where to Go Next" section in the Polkadot Hub assets documentation to enable navigation to Chain Interactions
- Added comprehensive documentation covering query operations, transactions, XCM transfers, token operations, and account management
- Included code examples and tutorials for five different SDK implementations
Reviewed changes
Copilot reviewed 23 out of 45 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| reference/polkadot-hub/assets.md | Uncommented navigation section linking to Chain Interactions |
| chain-interactions/index.md | Overview page introducing all chain interaction patterns |
| chain-interactions/query-data/*.md | Guides for querying on-chain state via SDKs, REST API, and runtime APIs |
| chain-interactions/send-transactions/*.md | Transaction guides including fee calculation and alternative token payments |
| chain-interactions/send-transactions/interoperability/*.md | XCM and cross-chain transaction guides |
| chain-interactions/token-operations/*.md | Asset registration and conversion guides for Asset Hub |
| chain-interactions/accounts/*.md | Account creation and query guides |
| .nav.yml and chain-interactions/.nav.yml | Navigation structure for the new section |
| .snippets/code/** | Code examples and expected outputs for all SDKs |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
This PR should be reviewed after merging #1341 in |
📝 Description
This PR is a base branch for the Chain Interactions section, so we can have this section as ready for launch as possible.