Skip to content

Commit

Permalink
[CI Skip] release/stable 0.0.295
Browse files Browse the repository at this point in the history
skip-checks: true
  • Loading branch information
github-actions[bot] committed Mar 3, 2025
1 parent 954a86d commit 62deaf8
Show file tree
Hide file tree
Showing 28 changed files with 744 additions and 236 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTORS
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
1 Spaceforce Change order of params to match example (#90)
1 Stéphane P Fix doc typo (#300)
1 sulaman Update simple-connect.md (#464)
1 Valentin Fernandez Add Api Derives docs (#489)
1 Wil Wade Small fixes for cookbook (#302)
1 yaohsin Update verify-signature.md (#198)
1 Zoheb Salam Update Readme with `keysAt()` and `entriesAt()` (#218)
15 changes: 15 additions & 0 deletions docs/asset-hub-kusama/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ Events are emitted for certain operations on the runtime. The following sections

- **[system](#system)**

- **[toPolkadotXcmRouter](#topolkadotxcmrouter)**

- **[transactionPayment](#transactionpayment)**

- **[uniques](#uniques)**
Expand Down Expand Up @@ -993,6 +995,19 @@ ___
___


## toPolkadotXcmRouter

### DeliveryFeeFactorDecreased(`u128`)
- **interface**: `api.events.toPolkadotXcmRouter.DeliveryFeeFactorDecreased.is`
- **summary**: Delivery fee factor has been decreased.

### DeliveryFeeFactorIncreased(`u128`)
- **interface**: `api.events.toPolkadotXcmRouter.DeliveryFeeFactorIncreased.is`
- **summary**: Delivery fee factor has been increased.

___


## transactionPayment

### TransactionFeePaid(`AccountId32`, `u128`, `u128`)
Expand Down
68 changes: 43 additions & 25 deletions docs/asset-hub-kusama/extrinsics.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ ___

NOTE: when encountering an incorrect exchange rate and non-withdrawable pool liquidity, batch an atomic call with [`Pallet::add_liquidity`] and [`Pallet::swap_exact_tokens_for_tokens`] or [`Pallet::swap_tokens_for_exact_tokens`] calls to render the liquidity withdrawable and rectify the exchange rate.

Once liquidity is added, someone may successfully call [`Pallet::swap_exact_tokens_for_tokens`] successfully.
Once liquidity is added, someone may successfully call [`Pallet::swap_exact_tokens_for_tokens`].

### createPool(asset1: `StagingXcmV4Location`, asset2: `StagingXcmV4Location`)
- **interface**: `api.tx.assetConversion.createPool`
Expand Down Expand Up @@ -484,8 +484,6 @@ ___
The origin must conform to `ForceOrigin` or must be `Signed` by the asset's `owner`.

- `id`: The identifier of the asset to be destroyed. This must identify an existing asset.

The asset class must be frozen before calling `start_destroy`.

### thaw(id: `Compact<u32>`, who: `MultiAddress`)
- **interface**: `api.tx.assets.thaw`
Expand Down Expand Up @@ -555,6 +553,20 @@ ___

Weight: `O(1)` Modes: Pre-existence of `target`; Post-existence of sender; Account pre-existence of `target`.

### transferAll(id: `Compact<u32>`, dest: `MultiAddress`, keep_alive: `bool`)
- **interface**: `api.tx.assets.transferAll`
- **summary**: Transfer the entire transferable balance from the caller asset account.

NOTE: This function only attempts to transfer _transferable_ balances. This means that any held, frozen, or minimum balance (when `keep_alive` is `true`), will not be transferred by this function. To ensure that this function results in a killed account, you might need to prepare the account by removing any reference counters, storage deposits, etc...

The dispatch origin of this call must be Signed.

- `id`: The identifier of the asset for the account holding a deposit.

- `dest`: The recipient of the transfer.

- `keep_alive`: A boolean to determine if the `transfer_all` operation should send all of the funds the asset account has, causing the sender asset account to be killed (false), or transfer everything except at least the minimum balance, which will guarantee to keep the sender asset account alive (true).

### transferApproved(id: `Compact<u32>`, owner: `MultiAddress`, destination: `MultiAddress`, amount: `Compact<u128>`)
- **interface**: `api.tx.assets.transferApproved`
- **summary**: Transfer some asset balance from a previously delegated account to some third-party account.
Expand Down Expand Up @@ -1136,8 +1148,6 @@ ___
The origin must conform to `ForceOrigin` or must be `Signed` by the asset's `owner`.

- `id`: The identifier of the asset to be destroyed. This must identify an existing asset.

The asset class must be frozen before calling `start_destroy`.

### thaw(id: `StagingXcmV4Location`, who: `MultiAddress`)
- **interface**: `api.tx.foreignAssets.thaw`
Expand Down Expand Up @@ -1207,6 +1217,20 @@ ___

Weight: `O(1)` Modes: Pre-existence of `target`; Post-existence of sender; Account pre-existence of `target`.

### transferAll(id: `StagingXcmV4Location`, dest: `MultiAddress`, keep_alive: `bool`)
- **interface**: `api.tx.foreignAssets.transferAll`
- **summary**: Transfer the entire transferable balance from the caller asset account.

NOTE: This function only attempts to transfer _transferable_ balances. This means that any held, frozen, or minimum balance (when `keep_alive` is `true`), will not be transferred by this function. To ensure that this function results in a killed account, you might need to prepare the account by removing any reference counters, storage deposits, etc...

The dispatch origin of this call must be Signed.

- `id`: The identifier of the asset for the account holding a deposit.

- `dest`: The recipient of the transfer.

- `keep_alive`: A boolean to determine if the `transfer_all` operation should send all of the funds the asset account has, causing the sender asset account to be killed (false), or transfer everything except at least the minimum balance, which will guarantee to keep the sender asset account alive (true).

### transferApproved(id: `StagingXcmV4Location`, owner: `MultiAddress`, destination: `MultiAddress`, amount: `Compact<u128>`)
- **interface**: `api.tx.foreignAssets.transferApproved`
- **summary**: Transfer some asset balance from a previously delegated account to some third-party account.
Expand Down Expand Up @@ -2119,24 +2143,6 @@ ___

## parachainSystem

### authorizeUpgrade(code_hash: `H256`, check_version: `bool`)
- **interface**: `api.tx.parachainSystem.authorizeUpgrade`
- **summary**: Authorize an upgrade to a given `code_hash` for the runtime. The runtime can be supplied later.

The `check_version` parameter sets a boolean flag for whether or not the runtime's spec version and name should be verified on upgrade. Since the authorization only has a hash, it cannot actually perform the verification.

This call requires Root origin.

### enactAuthorizedUpgrade(code: `Bytes`)
- **interface**: `api.tx.parachainSystem.enactAuthorizedUpgrade`
- **summary**: Provide the preimage (runtime binary) `code` for an upgrade that has been authorized.

If the authorization required a version check, this call will ensure the spec name remains unchanged and that the spec version has increased.

Note that this function will not apply the new `code`, but only attempt to schedule the upgrade with the Relay Chain.

All origins are allowed.

### setValidationData(data: `CumulusPrimitivesParachainInherentParachainInherentData`)
- **interface**: `api.tx.parachainSystem.setValidationData`
- **summary**: Set the current validation data.
Expand Down Expand Up @@ -2754,8 +2760,6 @@ ___
The origin must conform to `ForceOrigin` or must be `Signed` by the asset's `owner`.

- `id`: The identifier of the asset to be destroyed. This must identify an existing asset.

The asset class must be frozen before calling `start_destroy`.

### thaw(id: `u32`, who: `MultiAddress`)
- **interface**: `api.tx.poolAssets.thaw`
Expand Down Expand Up @@ -2825,6 +2829,20 @@ ___

Weight: `O(1)` Modes: Pre-existence of `target`; Post-existence of sender; Account pre-existence of `target`.

### transferAll(id: `u32`, dest: `MultiAddress`, keep_alive: `bool`)
- **interface**: `api.tx.poolAssets.transferAll`
- **summary**: Transfer the entire transferable balance from the caller asset account.

NOTE: This function only attempts to transfer _transferable_ balances. This means that any held, frozen, or minimum balance (when `keep_alive` is `true`), will not be transferred by this function. To ensure that this function results in a killed account, you might need to prepare the account by removing any reference counters, storage deposits, etc...

The dispatch origin of this call must be Signed.

- `id`: The identifier of the asset for the account holding a deposit.

- `dest`: The recipient of the transfer.

- `keep_alive`: A boolean to determine if the `transfer_all` operation should send all of the funds the asset account has, causing the sender asset account to be killed (false), or transfer everything except at least the minimum balance, which will guarantee to keep the sender asset account alive (true).

### transferApproved(id: `u32`, owner: `MultiAddress`, destination: `MultiAddress`, amount: `Compact<u128>`)
- **interface**: `api.tx.poolAssets.transferApproved`
- **summary**: Transfer some asset balance from a previously delegated account to some third-party account.
Expand Down
17 changes: 17 additions & 0 deletions docs/asset-hub-kusama/rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ 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 @@ -162,6 +164,21 @@ ___
___


## 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

### localStorageGet(kind: `StorageKind`, key: `Bytes`): `Option<Bytes>`
Expand Down
2 changes: 1 addition & 1 deletion docs/asset-hub-kusama/runtime.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ ___
### getPreset(id: `Option<Text>`): `Option<Bytes>`
- **interface**: `api.call.genesisBuilder.getPreset`
- **runtime**: `genesisBuilder_get_preset`
- **summary**: Returns a JSON blob representation of the built-in `RuntimeGenesisConfig` identified by, `id`.,, If `id` is `None` the function returns JSON blob representation of the default, `RuntimeGenesisConfig` struct of the runtime. Implementation must provide default, `RuntimeGenesisConfig`.,, Otherwise function returns a JSON representation of the built-in, named, `RuntimeGenesisConfig` preset identified by `id`, or `None` if such preset does not, exists. Returned `Vec<u8>` contains bytes of JSON blob (patch) which comprises a list of, (potentially nested) key-value pairs that are intended for customizing the default, runtime genesis config. The patch shall be merged (rfc7386) with the JSON representation, of the default `RuntimeGenesisConfig` to create a comprehensive genesis config that can, be used in `build_state` method.
- **summary**: Returns a JSON blob representation of the built-in `RuntimeGenesisConfig` identified by, `id`.,, If `id` is `None` the function returns JSON blob representation of the default, `RuntimeGenesisConfig` struct of the runtime. Implementation must provide default, `RuntimeGenesisConfig`.,, Otherwise function returns a JSON representation of the built-in, named, `RuntimeGenesisConfig` preset identified by `id`, or `None` if such preset does not, exist. Returned `Vec<u8>` contains bytes of JSON blob (patch) which comprises a list of, (potentially nested) key-value pairs that are intended for customizing the default, runtime genesis config. The patch shall be merged (rfc7386) with the JSON representation, of the default `RuntimeGenesisConfig` to create a comprehensive genesis config that can, be used in `build_state` method.

### presetNames(): `Vec<Text>`
- **interface**: `api.call.genesisBuilder.presetNames`
Expand Down
20 changes: 16 additions & 4 deletions docs/asset-hub-kusama/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,7 @@ ___
- **interface**: `api.query.parachainSystem.didSetValidationCode`
- **summary**: Were the validation data set to notify the relay chain?

### hostConfiguration(): `Option<PolkadotPrimitivesV7AbridgedHostConfiguration>`
### hostConfiguration(): `Option<PolkadotPrimitivesV8AbridgedHostConfiguration>`
- **interface**: `api.query.parachainSystem.hostConfiguration`
- **summary**: The parachain host configuration that was obtained from the relay parent.

Expand Down Expand Up @@ -472,13 +472,13 @@ ___

The segment length is limited by the capacity returned from the [`ConsensusHook`] configured in the pallet.

### upgradeGoAhead(): `Option<PolkadotPrimitivesV7UpgradeGoAhead>`
### upgradeGoAhead(): `Option<PolkadotPrimitivesV8UpgradeGoAhead>`
- **interface**: `api.query.parachainSystem.upgradeGoAhead`
- **summary**: Optional upgrade go-ahead signal from the relay-chain.

This storage item is a mirror of the corresponding value for the current parachain from the relay-chain. This value is ephemeral which means it doesn't hit the storage. This value is set after the inherent.

### upgradeRestrictionSignal(): `Option<PolkadotPrimitivesV7UpgradeRestriction>`
### upgradeRestrictionSignal(): `Option<PolkadotPrimitivesV8UpgradeRestriction>`
- **interface**: `api.query.parachainSystem.upgradeRestrictionSignal`
- **summary**: An option which indicates if the relay-chain restricts signalling a validation code upgrade. In other words, if this is `Some` and [`NewValidationCode`] is `Some` then the produced candidate will be invalid.

Expand All @@ -494,7 +494,7 @@ ___

This will be cleared in `on_initialize` of each new block.

### validationData(): `Option<PolkadotPrimitivesV7PersistedValidationData>`
### validationData(): `Option<PolkadotPrimitivesV8PersistedValidationData>`
- **interface**: `api.query.parachainSystem.validationData`
- **summary**: The [`PersistedValidationData`] set for this block. This value is expected to be set only once per block and it's never stored in the trie.

Expand Down Expand Up @@ -661,6 +661,10 @@ _These are well-known keys that are always available to the runtime implementati
- **interface**: `api.query.substrate.code`
- **summary**: Wasm code of the runtime.

### defaultChildStorageKeyPrefix(): `u32`
- **interface**: `api.query.substrate.defaultChildStorageKeyPrefix`
- **summary**: Prefix of the default child storage keys in the top trie.

### extrinsicIndex(): `u32`
- **interface**: `api.query.substrate.extrinsicIndex`
- **summary**: Current extrinsic index (u32) is stored under this key.
Expand All @@ -672,6 +676,14 @@ _These are well-known keys that are always available to the runtime implementati
### intrablockEntropy(): `[u8;32]`
- **interface**: `api.query.substrate.intrablockEntropy`
- **summary**: Current intra-block entropy (a universally unique `[u8; 32]` value) is stored here.

### storageVersionStorageKeyPostfix(): `u16`
- **interface**: `api.query.substrate.storageVersionStorageKeyPostfix`
- **summary**: The storage key postfix that is used to store the [`StorageVersion`] per pallet.

### transactionLevelKey(): `u32`
- **interface**: `api.query.substrate.transactionLevelKey`
- **summary**: The key that holds the current number of active layers.

___

Expand Down
15 changes: 15 additions & 0 deletions docs/asset-hub-polkadot/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ Events are emitted for certain operations on the runtime. The following sections

- **[system](#system)**

- **[toKusamaXcmRouter](#tokusamaxcmrouter)**

- **[transactionPayment](#transactionpayment)**

- **[uniques](#uniques)**
Expand Down Expand Up @@ -978,6 +980,19 @@ ___
___


## toKusamaXcmRouter

### DeliveryFeeFactorDecreased(`u128`)
- **interface**: `api.events.toKusamaXcmRouter.DeliveryFeeFactorDecreased.is`
- **summary**: Delivery fee factor has been decreased.

### DeliveryFeeFactorIncreased(`u128`)
- **interface**: `api.events.toKusamaXcmRouter.DeliveryFeeFactorIncreased.is`
- **summary**: Delivery fee factor has been increased.

___


## transactionPayment

### TransactionFeePaid(`AccountId32`, `u128`, `u128`)
Expand Down
Loading

0 comments on commit 62deaf8

Please sign in to comment.