Add runtime API calls guide with SDK examples #1325
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
brunopgalvao
temporarily deployed
to
n8n-sending
GitHub Actions
Inactive
brunopgalvao
added
B0 - Needs Review
brunopgalvao
temporarily deployed
to
n8n-receiving
GitHub Actions
Inactive
nhussein11
reviewed
Dec 11, 2025
- 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
Contributor
Author
Updated. |
nhussein11
approved these changes
Dec 12, 2025
Collaborator
nhussein11
left a comment
nhussein11
left a comment
There was a problem hiding this comment.
@brunopgalvao approved, left some minor comments. Many thanks!
| - **[Python Substrate Interface](/reference/tools/py-substrate-interface/){target=\_blank}** - Python library for Substrate chains | ||
| - **[Subxt](/reference/tools/subxt/){target=\_blank}** - Rust library with compile-time type safety | ||
|
|
||
| Select your preferred SDK below to see complete, runnable examples that query Polkadot Hub TestNet (Paseo Asset Hub) for account nonces and metadata information. |
Collaborator
There was a problem hiding this comment.
Suggested change
| Select your preferred SDK below to see complete, runnable examples that query Polkadot Hub TestNet (Paseo Asset Hub) for account nonces and metadata information. | |
| Select your preferred SDK below to see complete, runnable examples that query Polkadot Hub TestNet for account nonces and metadata information. |
| import { withPolkadotSdkCompat } from 'polkadot-api/polkadot-sdk-compat'; | ||
| import { polkadotTestNet } from '@polkadot-api/descriptors'; | ||
|
|
||
| const ASSET_HUB_RPC = 'INSERT_WS_ENDPOINT'; |
Collaborator
There was a problem hiding this comment.
This should be "POLKADOT_TESTNET_RPC"
| @@ -0,0 +1,34 @@ | |||
| import { ApiPromise, WsProvider } from '@polkadot/api'; | |||
|
|
|||
| const ASSET_HUB_RPC = 'INSERT_WS_ENDPOINT'; | |||
|
|
||
|
|
||
| def main(): | ||
| # Connect to Polkadot Hub TestNet (Paseo Asset Hub) |
Collaborator
There was a problem hiding this comment.
Suggested change
| # Connect to Polkadot Hub TestNet (Paseo Asset Hub) | |
| # Connect to Polkadot Hub TestNet |
| @@ -0,0 +1,33 @@ | |||
| from substrateinterface import SubstrateInterface | |||
|
|
|||
| ASSET_HUB_RPC = "INSERT_WS_ENDPOINT" | |||
| 3. Download the Polkadot Hub TestNet metadata: | ||
|
|
||
| ```bash | ||
| subxt metadata --url INSERT_WS_ENDPOINT -o asset_hub_metadata.scale |
Collaborator
There was a problem hiding this comment.
Ideally this should be something like: polkadot_testnet_metadata.scale but I failed to do that in other tests, any idea what might be the reason?
| subxt metadata --url INSERT_WS_ENDPOINT -o asset_hub_metadata.scale | ||
| ``` | ||
|
|
||
| Ensure to replace `INSERT_WS_ENDPOINT` with the proper WebSocket endpoint, such as `wss://asset-hub-paseo.dotters.network` for Polkadot Hub TestNet (Paseo Asset Hub). |
Collaborator
There was a problem hiding this comment.
Suggested change
| Ensure to replace `INSERT_WS_ENDPOINT` with the proper WebSocket endpoint, such as `wss://asset-hub-paseo.dotters.network` for Polkadot Hub TestNet (Paseo Asset Hub). | |
| Ensure to replace `INSERT_WS_ENDPOINT` with the proper WebSocket endpoint, such as `wss://asset-hub-paseo.dotters.network` for Polkadot Hub TestNet. |
| import { DedotClient, WsProvider } from 'dedot'; | ||
| import type { PolkadotAssetHubApi } from '@dedot/chaintypes'; | ||
|
|
||
| const ASSET_HUB_RPC = 'INSERT_WS_ENDPOINT'; |
| const ADDRESS = 'INSERT_ADDRESS'; | ||
|
|
||
| async function main() { | ||
| // Initialize provider and client with Asset Hub types |
Collaborator
There was a problem hiding this comment.
Suggested change
| // Initialize provider and client with Asset Hub types | |
| // Initialize provider and client with Polkadot TestNet types |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Description
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.
🔍 Review Preference
Choose one:
🤖 AI-Ready Docs
If content changed, regenerate AI files:
python3 scripts/generate_llms.py✅ Checklist