Skip to content

Commit

Permalink
Merge branch 'v0.1' into update-v1.7-to-v1.10
Browse files Browse the repository at this point in the history
  • Loading branch information
ozgunozerk authored Apr 17, 2024
2 parents 53715f3 + 07e0f94 commit ecbec1f
Show file tree
Hide file tree
Showing 14 changed files with 191 additions and 49 deletions.
4 changes: 2 additions & 2 deletions docs/antora.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
name: substrate-runtimes
title: Substrate Runtime
title: Substrate Runtimes
version: 0.1.0
nav:
- modules/ROOT/nav.adoc
asciidoc:
attributes:
page-sidebar-collapse-default: false
page-sidebar-collapse-default: false
12 changes: 7 additions & 5 deletions docs/modules/ROOT/pages/pallets/assets.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@

= pallet_assets

Branch/Release: `release-polkadot-v1.7.0`
Branch/Release: `release-polkadot-v1.10.0`

== Source Code link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.10.0/substrate/frame/assets/src/lib.rs[{github-icon},role=heading-link]

== Purpose

Expand All @@ -17,7 +19,7 @@ The `pallet_assets` module is designed to manage and manipulate custom fungible
** `Admin` - The account that has administrative privileges over an asset, such as: `minting`, `burning`, `freezing`, and `thawing`.
** `Sufficiency` - The amount of an asset that is required to be held in an account in order to perform certain operations, such as: `transfers`, `freezing`, and `thawing`.

== Config link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.7.0/substrate/frame/assets/src/lib.rs#L231[{github-icon},role=heading-link]
== Config

* Pallet-specific configs
** `Balance` -- The balance unit type.
Expand All @@ -41,7 +43,7 @@ The `pallet_assets` module is designed to manage and manipulate custom fungible
** `RuntimeEvent` -- The overarching event type.
** `WeightInfo` -- xref:glossary.adoc#weight[Weight] information for extrinsics in this pallet.

== Events link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.7.0/substrate/frame/assets/src/lib.rs#L442[{github-icon},role=heading-link]
== Events

* `Created(asset_id, creator, owner)` -- An asset was created.
* `Issued(asset_id, owner, amount)` -- An asset was issued.
Expand All @@ -68,7 +70,7 @@ The `pallet_assets` module is designed to manage and manipulate custom fungible
* `Touched(asset_id, who, depositor)` -- An account `who` was created with a deposit from `depositor`.
* `Blocked(asset_id, who)` -- An account `who` was blocked.

== Errors link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.7.0/substrate/frame/assets/src/lib.rs#L526[{github-icon},role=heading-link]
== Errors

* `BalanceLow` -- Account balance must be greater than or equal to the transfer amount.
* `NoAccount` -- The account to alter does not exist.
Expand All @@ -91,7 +93,7 @@ The `pallet_assets` module is designed to manage and manipulate custom fungible
* `NotFrozen` -- The asset should be frozen before the given operation.
* `CallbackFailed` -- Callback action resulted in error.

== Dispatchables link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.7.0/substrate/frame/assets/src/lib.rs#L573[{github-icon},role=heading-link]
== Dispatchables

[.contract-item]
[[create]]
Expand Down
4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/pallets/aura_ext.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

= cumulus_pallet_aura_ext

Branch/Release: `release-polkadot-v1.7.0`
Branch/Release: `release-polkadot-v1.10.0`

== Purpose

Expand All @@ -13,7 +13,7 @@ This pallet integrates parachain’s own block production mechanism (for example
- to manage the unincluded blocks from the current slot
- to validate produced block against the relay chain

== Configuration and Integration link:https://github.com/paritytech/polkadot-sdk/tree/release-polkadot-v1.7.0/cumulus/pallets/aura-ext[{github-icon},role=heading-link]
== Configuration and Integration link:https://github.com/paritytech/polkadot-sdk/tree/release-polkadot-v1.10.0/cumulus/pallets/aura-ext[{github-icon},role=heading-link]

There is no special config for this integration and it has no dispatchables, but you need to integrate it with other `parachain-system` crate:

Expand Down
12 changes: 7 additions & 5 deletions docs/modules/ROOT/pages/pallets/balances.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@

= pallet_balances

Branch/Release: `release-polkadot-v1.7.0`
Branch/Release: `release-polkadot-v1.10.0`

== Source Code link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.10.0/substrate/frame/balances/src/lib.rs[{github-icon},role=heading-link]

== Purpose

Expand All @@ -19,7 +21,7 @@ The Balances pallet provides functions for:
* Managing total issuance.
* Setting and managing xref:glossary.adoc#lock[locks].

== Config link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.7.0/substrate/frame/balances/src/lib.rs#L251[{github-icon},role=heading-link]
== Config

* Pallet-specific configs
** `RuntimeHoldReason` -- The overarching xref:glossary.adoc#hold[hold] reason.
Expand All @@ -37,7 +39,7 @@ The Balances pallet provides functions for:
** `RuntimeEvent` -- The overarching event type.
** `WeightInfo` -- xref:glossary.adoc#weight[Weight] information for extrinsics in this pallet.

== Events link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.7.0/substrate/frame/balances/src/lib.rs#L333[{github-icon},role=heading-link]
== Events

* `Endowed(account, free_balance)` -- An account was created with some free balance.
* `DustLost(account, amount)` -- An account was removed whose balance was non-zero but below ExistentialDeposit, resulting in an outright loss.
Expand All @@ -62,7 +64,7 @@ The Balances pallet provides functions for:
* `Thawed(who, amount)` -- Some balance was thawed.
* `TotalIssuanceForced(old, new)` -- Total issuance was forcefully changed.

== Errors link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.7.0/substrate/frame/balances/src/lib.rs#L388[{github-icon},role=heading-link]
== Errors

* `VestingBalance` -- Vesting balance too high to send value.
* `LiquidityRestrictions` -- Account liquidity restrictions prevent withdrawal.
Expand All @@ -77,7 +79,7 @@ The Balances pallet provides functions for:
* `IssuanceDeactivated` -- The issuance cannot be modified since it is already deactivated.
* `DeltaZero` -- The delta cannot be zero.

== Dispatchables link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.7.0/substrate/frame/balances/src/lib.rs#L566[{github-icon},role=heading-link]
== Dispatchables

[.contract-item]
[[transfer_allow_death]]
Expand Down
16 changes: 9 additions & 7 deletions docs/modules/ROOT/pages/pallets/collator-selection.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@

= collator_selection

Branch/Release: `release-polkadot-v1.7.0`
Branch/Release: `release-polkadot-v1.10.0`

== Source Code link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.10.0/cumulus/pallets/collator-selection/src/lib.rs[{github-icon},role=heading-link]

== Purpose

This pallet is needed to manage the set of xref:glossary.adoc#collator[collators] for each session and to provision the next session with the actual list of collators.

== Config link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.7.0/cumulus/pallets/collator-selection/src/lib.rs#L138[{github-icon},role=heading-link]
== Config

* Pallet-specific configs
** `UpdateOrigin` — defines the list of origins that are able to modify the settings of collators (e.g. set and remove list of xref:glossary.adoc#invulnerable[invulnerables], desired xref:glossary.adoc#candidates[candidates], xref:glossary.adoc#candidacy_bond[candidacy bond]). This type should implement the trait `EnsureOrigin`.
Expand All @@ -27,7 +29,7 @@ This pallet is needed to manage the set of xref:glossary.adoc#collator[collators
** `Currency`
** `WeightInfo`

== Dispatchables link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.7.0/cumulus/pallets/collator-selection/src/lib.rs#L354[{github-icon},role=heading-link]
== Dispatchables

[.contract-item]
[[set_invulnerables]]
Expand All @@ -36,7 +38,7 @@ This pallet is needed to manage the set of xref:glossary.adoc#collator[collators
----
pub fn set_invulnerables(new: Vec<T::AccountId>)
----
Sets a new list of invulnerable collators. The call must be signed and origin of the call must fulfill the EnsureOrigin check.
Sets a new list of invulnerable collators. The call must be signed and origin of the call must fulfill the EnsureOrigin check.

IMPORTANT: This call does not maintain the mutual exclusiveness of candidates and invulnerables lists.

Expand Down Expand Up @@ -83,7 +85,7 @@ Set a new maximum possible number of candidates. If it is higher than `Config::M
----
pub fn set_candidacy_bond(max: u32)
----
Set the amount for the deposit to be a candidate for collator.
Set the amount for the deposit to be a candidate for collator.

**Params:**

Expand Down Expand Up @@ -228,7 +230,7 @@ pub fn take_candidate_slot(
target: T::AccountId,
)
----
Try to replace the target's candidacy by making a bigger candidacy bond.
Try to replace the target's candidacy by making a bigger candidacy bond.

*Params:*

Expand All @@ -250,4 +252,4 @@ Try to replace the target's candidacy by making a bigger candidacy bond.

**Events:**

- `CandidateReplaced(old, new, deposit)`
- `CandidateReplaced(old, new, deposit)`
11 changes: 7 additions & 4 deletions docs/modules/ROOT/pages/pallets/message-queue.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,29 @@

= pallet_message_queue

Branch/Release: `release-polkadot-v1.7.0`
Branch/Release: `release-polkadot-v1.10.0`

Source Code link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.10.0/substrate/frame/message-queue/src/lib.rs[{github-icon},role=heading-link]

== Purpose

Flexible FRAME pallet for implementing message queues. This pallet can also initiate message processing using the `MessageProcessor` (see `Config`).

== Config link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.7.0/substrate/frame/message-queue/src/lib.rs#L469[{github-icon},role=heading-link]
== Config
* Pallet-specific configs:
** `MessageProcessor` -- Processor for messages
** `Size` -- Page/heap size type.
** `QueueChangeHandler` -- Code to be called when a message queue changes - either with items introduced or removed.
** `QueuePausedQuery` -- Queried by the pallet to check whether a queue can be serviced.
** `HeapSize` -- The size of the page; this also serves as the maximum message size which can be sent.
** `MaxStale` -- The maximum number of stale pages (i.e. of overweight messages) allowed before culling can happen. Once there are more stale pages than this, then historical pages may be dropped, even if they contain unprocessed overweight messages.
** `ServiceWeight` -- The amount of weight (if any) which should be provided to the message queue for servicing enqueued items. This may be legitimately `None` in the case that you will call `ServiceQueues::service_queues` manually.
** `ServiceWeight` -- The amount of weight (if any) which should be provided to the message queue for servicing enqueued items `on_initialize`. This may be legitimately `None` in the case that you will call `ServiceQueues::service_queues` manually or set [`Self::IdleMaxServiceWeight`] to have it run in `on_idle`.
** `IdleMaxServiceWeight` -- The maximum amount of weight (if any) to be used from remaining weight `on_idle` which should be provided to the message queue for servicing enqueued items `on_idle`. Useful for parachains to process messages at the same block they are received. If `None`, it will not call `ServiceQueues::service_queues` in `on_idle`.
* Common configs:
** `RuntimeEvent` -- The overarching event type.
** `WeightInfo` -- Weight information for extrinsics in this pallet.

== Dispatchables link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.7.0/substrate/frame/message-queue/src/lib.rs#L657[{github-icon},role=heading-link]
== Dispatchables

[.contract-item]
[[execute_overweight]]
Expand Down
8 changes: 5 additions & 3 deletions docs/modules/ROOT/pages/pallets/multisig.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@

= pallet_multisig

Branch/Release: `release-polkadot-v1.7.0`
Branch/Release: `release-polkadot-v1.10.0`

== Source Code: link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.10.0/substrate/frame/multisig/src/lib.rs[{github-icon},role=heading-link]

== Purpose

This module enables multi-signature operations in your runtime. It allows multiple signed origins (accounts) to coordinate and dispatch a call. For the call to execute, the threshold number of accounts from the set (signatories) must approve it.

== Config link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.7.0/substrate/frame/multisig/src/lib.rs#L135[{github-icon},role=heading-link]
== Config

* Pallet-specific configs
** `DepositBase` -- The base amount of currency needed to xref:glossary.adoc#reserve[reserve] for creating a multisig execution or to store a dispatch call for later. Recall: The deposit to be made by the account that creates the multisig is: `threshold * DepositFactor + DepositBase`
Expand All @@ -23,7 +25,7 @@ This module enables multi-signature operations in your runtime. It allows multip
** `WeightInfo` -- xref:glossary.adoc#weight[Weight] information for extrinsics in this pallet.


== Dispatchables link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.7.0/substrate/frame/multisig/src/lib.rs#L254[{github-icon},role=heading-link]
== Dispatchables

[.contract-item]
[[approve_as_multi]]
Expand Down
10 changes: 6 additions & 4 deletions docs/modules/ROOT/pages/pallets/parachain-system.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@

= parachain_system

Branch/Release: `release-polkadot-v1.7.0`
Branch/Release: `release-polkadot-v1.10.0`

== Source Code link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.10.0/cumulus/pallets/parachain-system/src/lib.rs[{github-icon},role=heading-link]

== Purpose

Expand All @@ -16,12 +18,12 @@ This pallet is a core element of each parachain. It will:
- Send outgoing messages to relay chain and other parachains
- Build collation info when requested by xref:glossary.adoc#collator[collator]

== Config link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.7.0/cumulus/pallets/parachain-system/src/lib.rs#L200[{github-icon},role=heading-link]
== Config

* Pallet-specific configs:
** `OnSystemEvent` — a handler that will be called when new xref:glossary.adoc#validation_data[validation data] will be set (once each block). New validation data will also be passed to it. Look to `trait OnSystemEvent` for more details.
** `SelfParaId` — getter for a parachain id of this chain
** `OutboundXcmpMessageSource` — source of outgoing XCMP messages. It is queried in `finalize_block` and later included into collation information
** `OutboundXcmpMessageSource` — source of outgoing XCMP messages. It is queried in `finalize_block` and later included into collation information
** `DmpQueue` — a handler for the incoming *downward* messages from relay chain
** `ReservedDmpWeight` — xref:glossary.adoc#weight[weight] reserved for DMP message processing. This config seems to be is not used as the function that processes these messages (`enqueue_inbound_downward_messages`) returns used weight.
** `XcmpMessageHandler` — a handler for the incoming _horizontal_ messages from other parachains
Expand All @@ -32,7 +34,7 @@ This pallet is a core element of each parachain. It will:
** `RuntimeEvent`
** `WeightInfo`

== Dispatchables link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.7.0/cumulus/pallets/parachain-system/src/lib.rs#L503[{github-icon},role=heading-link]
== Dispatchables

[.contract-item]
[[set_validation_data]]
Expand Down
8 changes: 5 additions & 3 deletions docs/modules/ROOT/pages/pallets/proxy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@

= pallet_proxy

Branch/Release: `release-polkadot-v1.7.0`
Branch/Release: `release-polkadot-v1.10.0`

== Source Code link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.10.0/substrate/frame/proxy/src/lib.rs[{github-icon},role=heading-link]

== Purpose

This pallet enables delegation of rights to execute certain call types from one origin to another.

== Config link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.7.0/substrate/frame/proxy/src/lib.rs#L107[{github-icon},role=heading-link]
== Config

* Pallet-specific configs:
** `ProxyType` -- a type that describes different variants of xref:glossary.adoc#proxy[proxy]. It must implement `Default` trait and `InstanceFilter<RuntimeCall>` trait.
Expand All @@ -26,7 +28,7 @@ This pallet enables delegation of rights to execute certain call types from one
** `RuntimeCall`
** `Currency`

== Dispatchables link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.7.0/substrate/frame/proxy/src/lib.rs#L179[{github-icon},role=heading-link]
== Dispatchables

[.contract-item]
[[add_proxy]]
Expand Down
6 changes: 4 additions & 2 deletions docs/modules/ROOT/pages/pallets/transaction_payment.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@

= pallet_transaction_payment

Branch/Release: `release-polkadot-v1.7.0`
Branch/Release: `release-polkadot-v1.10.0`

== Source Code link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.10.0/substrate/frame/transaction-payment/src/lib.rs[{github-icon},role=heading-link]

== Purpose

Expand All @@ -25,7 +27,7 @@ final_fee = inclusion_fee + tip;
```
The inputs are defined below in the glossary and config sections.

== Config link:https://github.com/paritytech/polkadot-sdk/blob/release-polkadot-v1.7.0/substrate/frame/transaction-payment/src/lib.rs#L342[{github-icon},role=heading-link]
== Config

* Pallet-specific handlers:
** `OnChargeTransaction` -- Handler for withdrawing, refunding and depositing the transaction fee. Type must implement the trait `OnChargeTransaction<Self>`.
Expand Down
Loading

0 comments on commit ecbec1f

Please sign in to comment.