Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
539 changes: 538 additions & 1 deletion docs/asset-hub-kusama/constants.md

Large diffs are not rendered by default.

1,270 changes: 1,252 additions & 18 deletions docs/asset-hub-kusama/errors.md

Large diffs are not rendered by default.

1,074 changes: 1,041 additions & 33 deletions docs/asset-hub-kusama/events.md

Large diffs are not rendered by default.

5,491 changes: 3,935 additions & 1,556 deletions docs/asset-hub-kusama/extrinsics.md

Large diffs are not rendered by default.

17 changes: 0 additions & 17 deletions docs/asset-hub-kusama/rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ The following sections contain known RPC methods that may be available on specif

- **[dev](#dev)**

- **[engine](#engine)**

- **[offchain](#offchain)**

- **[payment](#payment)**
Expand Down Expand Up @@ -164,21 +162,6 @@ ___
___


## engine

### createBlock(createEmpty: `bool`, finalize: `bool`, parentHash?: `BlockHash`): `CreatedBlock`
- **interface**: `api.rpc.engine.createBlock`
- **jsonrpc**: `engine_createBlock`
- **summary**: Instructs the manual-seal authorship task to create a new block

### finalizeBlock(hash: `BlockHash`, justification?: `Justification`): `bool`
- **interface**: `api.rpc.engine.finalizeBlock`
- **jsonrpc**: `engine_finalizeBlock`
- **summary**: Instructs the manual-seal authorship task to finalize a block

___


## offchain

### localStorageClear(kind: `StorageKind`, key: `Bytes`): `Null`
Expand Down
182 changes: 178 additions & 4 deletions docs/asset-hub-kusama/runtime.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ The following section contains known runtime calls that may be available on spec

- **[auraUnincludedSegmentApi](#auraunincludedsegmentapi)**

- **[authorizedAliasersApi](#authorizedaliasersapi)**

- **[blockBuilder](#blockbuilder)**

- **[collectCollationInfo](#collectcollationinfo)**
Expand All @@ -24,22 +26,34 @@ The following section contains known runtime calls that may be available on spec

- **[genesisBuilder](#genesisbuilder)**

- **[getParachainInfo](#getparachaininfo)**

- **[locationToAccountApi](#locationtoaccountapi)**

- **[metadata](#metadata)**

- **[nominationPoolsApi](#nominationpoolsapi)**

- **[offchainWorkerApi](#offchainworkerapi)**

- **[relayParentOffsetApi](#relayparentoffsetapi)**

- **[reviveApi](#reviveapi)**

- **[runtimeViewFunction](#runtimeviewfunction)**

- **[sessionKeys](#sessionkeys)**

- **[stakingApi](#stakingapi)**

- **[taggedTransactionQueue](#taggedtransactionqueue)**

- **[transactionPaymentApi](#transactionpaymentapi)**

- **[transactionPaymentCallApi](#transactionpaymentcallapi)**

- **[trustedQueryApi](#trustedqueryapi)**

- **[xcmPaymentApi](#xcmpaymentapi)**


Expand All @@ -58,17 +72,17 @@ ___

## assetConversionApi

### getReserves(asset1: `StagingXcmV4Location`, asset2: `StagingXcmV4Location`): `Option<(u128,u128)>`
### getReserves(asset1: `StagingXcmV5Location`, asset2: `StagingXcmV5Location`): `Option<(u128,u128)>`
- **interface**: `api.call.assetConversionApi.getReserves`
- **runtime**: `assetConversionApi_get_reserves`
- **summary**: Returns the size of the liquidity pool for the given asset pair.

### quotePriceExactTokensForTokens(asset1: `StagingXcmV4Location`, asset2: `StagingXcmV4Location`, amount: `u128`, include_fee: `bool`): `Option<u128>`
### quotePriceExactTokensForTokens(asset1: `StagingXcmV5Location`, asset2: `StagingXcmV5Location`, amount: `u128`, include_fee: `bool`): `Option<u128>`
- **interface**: `api.call.assetConversionApi.quotePriceExactTokensForTokens`
- **runtime**: `assetConversionApi_quote_price_exact_tokens_for_tokens`
- **summary**: Provides a quote for [`Pallet::swap_exact_tokens_for_tokens`].,, Note that the price may have changed by the time the transaction is executed., (Use `amount_out_min` to control slippage.)

### quotePriceTokensForExactTokens(asset1: `StagingXcmV4Location`, asset2: `StagingXcmV4Location`, amount: `u128`, include_fee: `bool`): `Option<u128>`
### quotePriceTokensForExactTokens(asset1: `StagingXcmV5Location`, asset2: `StagingXcmV5Location`, amount: `u128`, include_fee: `bool`): `Option<u128>`
- **interface**: `api.call.assetConversionApi.quotePriceTokensForExactTokens`
- **runtime**: `assetConversionApi_quote_price_tokens_for_exact_tokens`
- **summary**: Provides a quote for [`Pallet::swap_tokens_for_exact_tokens`].,, Note that the price may have changed by the time the transaction is executed., (Use `amount_in_max` to control slippage.)
Expand Down Expand Up @@ -101,6 +115,21 @@ ___
___


## authorizedAliasersApi

### authorizedAliasers(target: `XcmVersionedLocation`): `Result<Vec<XcmRuntimeApisAuthorizedAliasesOriginAliaser>, XcmRuntimeApisAuthorizedAliasesError>`
- **interface**: `api.call.authorizedAliasersApi.authorizedAliasers`
- **runtime**: `authorizedAliasersApi_authorized_aliasers`
- **summary**: Returns locations allowed to alias into and act as `target`.

### isAuthorizedAlias(origin: `XcmVersionedLocation`, target: `XcmVersionedLocation`): `Result<bool, XcmRuntimeApisAuthorizedAliasesError>`
- **interface**: `api.call.authorizedAliasersApi.isAuthorizedAlias`
- **runtime**: `authorizedAliasersApi_is_authorized_alias`
- **summary**: Returns whether `origin` is allowed to alias into and act as `target`.

___


## blockBuilder

### applyExtrinsic(extrinsic: `SpRuntimeUncheckedExtrinsic`): `Result<Result<Null, SpRuntimeDispatchError>, SpRuntimeTransactionValidityTransactionValidityError>`
Expand Down Expand Up @@ -201,6 +230,16 @@ ___
___


## getParachainInfo

### parachainId(): `PolkadotParachainPrimitivesPrimitivesId`
- **interface**: `api.call.getParachainInfo.parachainId`
- **runtime**: `getParachainInfo_parachain_id`
- **summary**: Retrieve the parachain id used for runtime.

___


## locationToAccountApi

### convertLocation(location: `XcmVersionedLocation`): `Result<AccountId32, XcmRuntimeApisConversionsError>`
Expand Down Expand Up @@ -231,6 +270,61 @@ ___
___


## nominationPoolsApi

### balanceToPoints(pool_id: `u32`, new_funds: `u128`): `u128`
- **interface**: `api.call.nominationPoolsApi.balanceToPoints`
- **runtime**: `nominationPoolsApi_balance_to_points`
- **summary**: Returns the equivalent points of `new_funds` for a given pool.

### memberNeedsDelegateMigration(member: `SpCoreCryptoAccountId32`): `bool`
- **interface**: `api.call.nominationPoolsApi.memberNeedsDelegateMigration`
- **runtime**: `nominationPoolsApi_member_needs_delegate_migration`
- **summary**: Returns true if the delegated funds of the pool `member` needs migration.,, Once a pool has successfully migrated to the strategy, [`DelegateStake`](pallet_nomination_pools::adapter::DelegateStake), the funds of the, member can be migrated from pool account to the member's account. Use, [`migrate_delegation`](pallet_nomination_pools::Call::migrate_delegation), to migrate the funds of the pool member.

### memberPendingSlash(member: `SpCoreCryptoAccountId32`): `u128`
- **interface**: `api.call.nominationPoolsApi.memberPendingSlash`
- **runtime**: `nominationPoolsApi_member_pending_slash`
- **summary**: Returns the pending slash for a given pool member.,, If pending slash of the member exceeds `ExistentialDeposit`, it can be reported on, chain.

### memberTotalBalance(who: `SpCoreCryptoAccountId32`): `u128`
- **interface**: `api.call.nominationPoolsApi.memberTotalBalance`
- **runtime**: `nominationPoolsApi_member_total_balance`
- **summary**: Returns the total contribution of a pool member including any balance that is unbonding.

### pendingRewards(who: `SpCoreCryptoAccountId32`): `u128`
- **interface**: `api.call.nominationPoolsApi.pendingRewards`
- **runtime**: `nominationPoolsApi_pending_rewards`
- **summary**: Returns the pending rewards for the member that the AccountId was given for.

### pointsToBalance(pool_id: `u32`, points: `u128`): `u128`
- **interface**: `api.call.nominationPoolsApi.pointsToBalance`
- **runtime**: `nominationPoolsApi_points_to_balance`
- **summary**: Returns the equivalent balance of `points` for a given pool.

### poolAccounts(pool_id: `u32`): `(AccountId32,AccountId32)`
- **interface**: `api.call.nominationPoolsApi.poolAccounts`
- **runtime**: `nominationPoolsApi_pool_accounts`
- **summary**: Returns the bonded account and reward account associated with the pool_id.

### poolBalance(pool_id: `u32`): `u128`
- **interface**: `api.call.nominationPoolsApi.poolBalance`
- **runtime**: `nominationPoolsApi_pool_balance`
- **summary**: Total balance contributed to the pool.

### poolNeedsDelegateMigration(pool_id: `u32`): `bool`
- **interface**: `api.call.nominationPoolsApi.poolNeedsDelegateMigration`
- **runtime**: `nominationPoolsApi_pool_needs_delegate_migration`
- **summary**: Returns true if the pool with `pool_id` needs migration.,, This can happen when the `pallet-nomination-pools` has switched to using strategy, [`DelegateStake`](pallet_nomination_pools::adapter::DelegateStake) but the pool, still has funds that were staked using the older strategy, [TransferStake](pallet_nomination_pools::adapter::TransferStake). Use, [`migrate_pool_to_delegate_stake`](pallet_nomination_pools::Call::migrate_pool_to_delegate_stake), to migrate the pool.

### poolPendingSlash(pool_id: `u32`): `u128`
- **interface**: `api.call.nominationPoolsApi.poolPendingSlash`
- **runtime**: `nominationPoolsApi_pool_pending_slash`
- **summary**: Returns the pending slash for a given pool.

___


## offchainWorkerApi

### offchainWorker(header: `SpRuntimeHeader`): `Null`
Expand All @@ -241,13 +335,33 @@ ___
___


## relayParentOffsetApi

### relayParentOffset(): `u32`
- **interface**: `api.call.relayParentOffsetApi.relayParentOffset`
- **runtime**: `relayParentOffsetApi_relay_parent_offset`
- **summary**: Fetch the slot offset that is expected from the relay chain.

___


## reviveApi

### address(account_id: `SpCoreCryptoAccountId32`): `PrimitiveTypesH160`
- **interface**: `api.call.reviveApi.address`
- **runtime**: `reviveApi_address`
- **summary**: Get the H160 address associated to this account id

### balance(address: `PrimitiveTypesH160`): `PrimitiveTypesU256`
- **interface**: `api.call.reviveApi.balance`
- **runtime**: `reviveApi_balance`
- **summary**: Returns the free balance of the given `[H160]` address, using EVM decimals.

### blockAuthor(): `Option<H160>`
- **interface**: `api.call.reviveApi.blockAuthor`
- **runtime**: `reviveApi_block_author`
- **summary**: The address of the validator that produced the current block.

### blockGasLimit(): `PrimitiveTypesU256`
- **interface**: `api.call.reviveApi.blockGasLimit`
- **runtime**: `reviveApi_block_gas_limit`
Expand All @@ -258,10 +372,15 @@ ___
- **runtime**: `reviveApi_call`
- **summary**: Perform a call from a specified account to a given contract.,, See [`crate::Pallet::bare_call`].

### code(address: `PrimitiveTypesH160`): `Bytes`
- **interface**: `api.call.reviveApi.code`
- **runtime**: `reviveApi_code`
- **summary**: The code at the specified address taking pre-compiles into account.

### ethTransact(tx: `PalletReviveEvmApiRpcTypesGenGenericTransaction`): `Result<PalletRevivePrimitivesEthTransactInfo, PalletRevivePrimitivesEthTransactError>`
- **interface**: `api.call.reviveApi.ethTransact`
- **runtime**: `reviveApi_eth_transact`
- **summary**: Perform an Ethereum call.,, See [`crate::Pallet::bare_eth_transact`]
- **summary**: Perform an Ethereum call.,, See [`crate::Pallet::dry_run_eth_transact`]

### gasPrice(): `PrimitiveTypesU256`
- **interface**: `api.call.reviveApi.gasPrice`
Expand All @@ -273,6 +392,11 @@ ___
- **runtime**: `reviveApi_get_storage`
- **summary**: Query a given storage key in a given contract.,, Returns `Ok(Some(Vec<u8>))` if the storage value exists under the given key in the, specified account and `Ok(None)` if it doesn't. If the account specified by the address, doesn't exist, or doesn't have a contract then `Err` is returned.

### getStorageVarKey(address: `PrimitiveTypesH160`, key: `Bytes`): `Result<Option<Bytes>, PalletRevivePrimitivesContractAccessError>`
- **interface**: `api.call.reviveApi.getStorageVarKey`
- **runtime**: `reviveApi_get_storage_var_key`
- **summary**: Query a given variable-sized storage key in a given contract.,, Returns `Ok(Some(Vec<u8>))` if the storage value exists under the given key in the, specified account and `Ok(None)` if it doesn't. If the account specified by the address, doesn't exist, or doesn't have a contract then `Err` is returned.

### instantiate(origin: `SpCoreCryptoAccountId32`, value: `u128`, gas_limit: `Option<SpWeightsWeightV2Weight>`, storage_deposit_limit: `Option<u128>`, code: `PalletRevivePrimitivesCode`, data: `Bytes`, salt: `Option<[u8;32]>`): `PalletRevivePrimitivesContractResultInstantiateReturnValue`
- **interface**: `api.call.reviveApi.instantiate`
- **runtime**: `reviveApi_instantiate`
Expand All @@ -283,6 +407,11 @@ ___
- **runtime**: `reviveApi_nonce`
- **summary**: Returns the nonce of the given `[H160]` address.

### runtimePalletsAddress(): `PrimitiveTypesH160`
- **interface**: `api.call.reviveApi.runtimePalletsAddress`
- **runtime**: `reviveApi_runtime_pallets_address`
- **summary**: The address used to call the runtime's pallets dispatchables

### traceBlock(block: `SpRuntimeBlock`, config: `PalletReviveEvmApiDebugRpcTypesTracerType`): `Vec<(u32,PalletReviveEvmApiDebugRpcTypesTrace)>`
- **interface**: `api.call.reviveApi.traceBlock`
- **runtime**: `reviveApi_trace_block`
Expand All @@ -306,6 +435,16 @@ ___
___


## runtimeViewFunction

### executeViewFunction(query_id: `FrameSupportViewFunctionsViewFunctionId`, input: `Bytes`): `Result<Bytes, FrameSupportViewFunctionsViewFunctionDispatchError>`
- **interface**: `api.call.runtimeViewFunction.executeViewFunction`
- **runtime**: `runtimeViewFunction_execute_view_function`
- **summary**: Execute a view function query.

___


## sessionKeys

### decodeSessionKeys(encoded: `Bytes`): `Option<Vec<(Bytes,SpCoreCryptoKeyTypeId)>>`
Expand All @@ -321,6 +460,26 @@ ___
___


## stakingApi

### erasStakersPageCount(era: `u32`, account: `SpCoreCryptoAccountId32`): `u32`
- **interface**: `api.call.stakingApi.erasStakersPageCount`
- **runtime**: `stakingApi_eras_stakers_page_count`
- **summary**: Returns the page count of exposures for a validator `account` in a given era.

### nominationsQuota(balance: `u128`): `u32`
- **interface**: `api.call.stakingApi.nominationsQuota`
- **runtime**: `stakingApi_nominations_quota`
- **summary**: Returns the nominations quota for a nominator with a given balance.

### pendingRewards(era: `u32`, account: `SpCoreCryptoAccountId32`): `bool`
- **interface**: `api.call.stakingApi.pendingRewards`
- **runtime**: `stakingApi_pending_rewards`
- **summary**: Returns true if validator `account` has pages to be claimed for the given era.

___


## taggedTransactionQueue

### validateTransaction(source: `SpRuntimeTransactionValidityTransactionSource`, tx: `SpRuntimeUncheckedExtrinsic`, block_hash: `PrimitiveTypesH256`): `Result<SpRuntimeTransactionValidityValidTransaction, SpRuntimeTransactionValidityTransactionValidityError>`
Expand Down Expand Up @@ -381,6 +540,21 @@ ___
___


## trustedQueryApi

### isTrustedReserve(asset: `XcmVersionedAsset`, location: `XcmVersionedLocation`): `Result<bool, XcmRuntimeApisTrustedQueryError>`
- **interface**: `api.call.trustedQueryApi.isTrustedReserve`
- **runtime**: `trustedQueryApi_is_trusted_reserve`
- **summary**: Returns if the location is a trusted reserve for the asset.,, # Arguments, * `asset`: `VersionedAsset`., * `location`: `VersionedLocation`.

### isTrustedTeleporter(asset: `XcmVersionedAsset`, location: `XcmVersionedLocation`): `Result<bool, XcmRuntimeApisTrustedQueryError>`
- **interface**: `api.call.trustedQueryApi.isTrustedTeleporter`
- **runtime**: `trustedQueryApi_is_trusted_teleporter`
- **summary**: Returns if the asset can be teleported to the location.,, # Arguments, * `asset`: `VersionedAsset`., * `location`: `VersionedLocation`.

___


## xcmPaymentApi

### queryAcceptablePaymentAssets(xcm_version: `u32`): `Result<Vec<XcmVersionedAssetId>, XcmRuntimeApisFeesError>`
Expand Down
Loading