diff --git a/README.md b/README.md
index 18f6d18da6240d03d6406ffd8fb6fcd95d43e09e..f2fe8eb1a705d80b52f0d210fc2434d1fbea2c82 100644
--- a/README.md
+++ b/README.md
@@ -10,40 +10,46 @@
<img alt="logov2" src="https://duniter.fr/img/duniterv2.svg" width="128" height="128"/>
</div>
-## Documentation TOC
-Full up to date technical doc (auto-generated) : https://doc-duniter-org.ipns.pagu.re/gdev_runtime/
+## Documentation
-- [README](./README.md)
+Multiple documentation sources are available depending on the level of detail you need.
+
+- Full technical Rust doc (auto-generated with `cargo xtask gen-doc`) : https://doc-duniter-org.ipns.pagu.re/duniter/
+- User and client developer doc (official website) : https://duniter.org/wiki/duniter-v2/
+- Internal documentation (within git repository), see table of contents below : [./doc](./doc)
+
+### Internal documentation TOC
+
+- [README](./README.md) (this file)
- [Use](#use)
- - [Test](#test)
- [Contribute](#contribute)
- - [Structure](#project-structure)
-- [docker](./docker/) docker-related documentation
-- [docs](./docs/)
- - [api](./docs/api/)
- - [manual](./docs/api/manual.md)
+ - [License](#license)
+- [docs](./docs/) internal documentation
+ - [api](./docs/api/) API
+ - [manual](./docs/api/manual.md) manage account and identities
- [runtime-calls](./docs/api/runtime-calls.md) the calls you can submit through the RPC API
- [runtime-errors](./docs/api/runtime-errors.md) the errors you can get submitting a call
- [runtime-events](./docs/api/runtime-events.md) the events you can get submitting a call
- - [dev](./docs/dev/)
+ - [dev](./docs/dev/) developer documentation
- [beginner-walkthrough](./docs/dev/beginner-walkthrough.md)
- [git-conventions](./docs/dev/git-conventions.md)
+ - [pallet_conventions](./docs/dev/pallet_conventions.md)
- [launch-a-live-network](./docs/dev/launch-a-live-network.md)
- [setup](./docs/dev/setup.md)
- [compilation features](./docs/dev/compilation.md)
- [verify-runtime-code](./docs/dev/verify-runtime-code.md)
- [weights-benchmarking](./docs/dev/weights-benchmarking.md)
- [upgrade-substrate](./docs/dev/upgrade-substrate.md)
- - [test](./docs/test/)
- [replay-block](./docs/test/replay-block.md)
- - [user](./docs/user/)
+ - [user](./docs/user/) user documentation
- [autocompletion](./docs/user/autocompletion.md)
- - [mirror](./docs/user/mirror.md) deploy a permanent ǦDev mirror node
- - [smith](./docs/user/smith.md) deploy a permanent ǦDev validator node
- [debian installation](./docs/user/installation_debian.md)
- - [packaging](./docs/packaging/)
- - [build-for-arm](./docs/packaging/build-for-arm.md)
+ - [distance](./docs/user/distance.md)
+ - [fees](./docs/user/fees.md)
+ - [packaging](./docs/packaging/) packaging
+ - [build-for-arm](./docs/packaging/build-for-arm.md) build for ARM architecture
- [build-debian](./docs/packaging/build-deb.md) build a native Debian package
+- [docker](./docker/) docker-related documentation
- [end2end-tests](./end2end-tests/) automated end to end tests written with cucumber
- [live-tests](./live-tests/) sanity checks to test the storage of a live chain
@@ -53,23 +59,23 @@ Full up to date technical doc (auto-generated) : https://doc-duniter-org.ipns.pa
The easiest way is to use the docker image.
-Minimal command to deploy a **temporary** mirror peer:
+Minimal command to deploy a temporary mirror peer:
```docker
-docker run -it -p9944:9944 -e DUNITER_CHAIN_NAME=gdev duniter/duniter-v2s:v0.4.0 --tmp --execution=Wasm
+docker run -it -p9944:9944 -e DUNITER_CHAIN_NAME=gdev duniter/duniter-v2s-gdev-800:latest
```
-To go further, read [How to deploy a permanent mirror node on ÄžDev network](./docs/user/rpc.md).
+To go further, read [How to deploy a permanent mirror node on ĞDev network 🔗](https://duniter.org/wiki/duniter-v2/#run-a-mirror-node).
### Create your local blockchain
It can be useful to deploy your local blockchain, for instance to have a controlled environment to develop/test an application that interacts with the blockchain.
```docker
-docker run -it -p9944:9944 duniter/duniter-v2s:v0.4.0 --tmp
+docker run -it -p9944:9944 duniter/duniter-v2s-gdev-800:latest
```
-Or use the `docker-compose.yml` at the root of this repository.
+Or use the [`docker-compose.yml`](./docker-compose.yml) at the root of this repository.
#### Control when your local blockchain should produce blocks
@@ -80,34 +86,9 @@ You can decide when to produce blocks with the cli option `--sealing` which has
- `--sealing=instant`: produce a block immediately upon receiving a transaction into the transaction pool
- `--sealing=manual`: produce a block upon receiving an RPC request (method `engine_createBlock`).
-### Autocompletion
-
-See [autocompletion](./docs/user/autocompletion.md).
+### Shell autocompletion
-## Test
-
-### Test a specific commit
-
-At each commit on master, an image with the tag `debug-sha-********` is published, where `********`
-corresponds to the first 8 hash characters of the commit.
-
-Usage:
-
-```docker
-docker run -it -p9944:9944 --name duniter-v2s duniter/duniter-v2s:debug-sha-b836f1a6
-```
-
-Then open `https://polkadot.js.org/apps/?rpc=ws%3A%2F%2F127.0.0.1%3A9944` in a browser.
-
-Enable detailed logging:
-
-```docker
-docker run -it -p9944:9944 --name duniter-v2s \
- -e RUST_LOG=debug \
- -e RUST_BACKTRACE=1 \
- -lruntime=debug \
- duniter/duniter-v2s:debug-sha-b836f1a6
-```
+See [autocompletion](./docs/user/autocompletion.md) to generate shell autocompletion for duniter commands.
## Contribute
@@ -134,20 +115,11 @@ cargo build
Use Rust's native `cargo` command to build and launch the node:
```sh
-cargo run -- --dev --tmp
+cargo run -- --dev
```
This will deploy a local blockchain with test accounts (Alice, Bob, etc) in the genesis.
-
-## Single-Node Development Chain
-
-This command will start the single-node development chain with persistent state:
-
-```bash
-./target/debug/duniter --dev --tmp
-```
-
-Then open `https://polkadot.js.org/apps/?rpc=ws%3A%2F%2F127.0.0.1%3A9944` in a browser.
+Open `https://polkadot.js.org/apps/?rpc=ws%3A%2F%2F127.0.0.1%3A9944` to watch and interact with your node.
Start the development chain with detailed logging:
@@ -155,138 +127,11 @@ Start the development chain with detailed logging:
RUST_LOG=debug RUST_BACKTRACE=1 ./target/debug/duniter -lruntime=debug --dev
```
-## Multi-Node Local Testnet
-
-If you want to see the multi-node consensus algorithm in action, refer to
-[our Start a Private Network tutorial](https://substrate.dev/docs/en/tutorials/start-a-private-network/).
-
-### Purge previous local testnet
-
-```
-./target/debug/duniter purge-chain --base-path /tmp/alice --chain local
-./target/debug/duniter purge-chain --base-path /tmp/bob --chain local
-
-```
-
-### Start Alice's node
-
-```bash
-./target/debug/duniter \
- --base-path /tmp/alice \
- --chain local \
- --alice \
- --port 30333 \
- --rpc-port 9944 \
- --node-key 0000000000000000000000000000000000000000000000000000000000000001 \
- --validator
-```
-
-### Start Bob's node
+## License
-```bash
-./target/debug/duniter \
- --base-path /tmp/bob \
- --chain local \
- --bob \
- --port 30334 \
- --rpc-port 9945 \
- --validator \
- --bootnodes /ip4/127.0.0.1/tcp/30333/p2p/12D3KooWEyoppNCUx8Yx66oV9fJnriXwCcXwDDUA2kj6vnc6iDEp
-```
+See [LICENSE](./LICENSE)
-## Project Structure
-
-A Substrate project such as this consists of a number of components that are spread across a few
-directories.
-
-### Node
-
-A blockchain node is an application that allows users to participate in a blockchain network.
-Substrate-based blockchain nodes expose a number of capabilities:
-
-- Networking: Substrate nodes use the [`libp2p`](https://libp2p.io/) networking stack to allow the
- nodes in the network to communicate with one another.
-- Consensus: Blockchains must have a way to come to
- [consensus](https://substrate.dev/docs/en/knowledgebase/advanced/consensus) on the state of the
- network. Substrate makes it possible to supply custom consensus engines and also ships with
- several consensus mechanisms that have been built on top of
- [Web3 Foundation research](https://research.web3.foundation/en/latest/polkadot/NPoS/index.html).
-- RPC Server: A remote procedure call (RPC) server is used to interact with Substrate nodes.
-
-There are several files in the `node` directory - take special note of the following:
-
-- [`chain_spec.rs`](./node/src/chain_spec.rs): A
- [chain specification](https://substrate.dev/docs/en/knowledgebase/integrate/chain-spec) is a
- source code file that defines a Substrate chain's initial (genesis) state. Chain specifications
- are useful for development and testing, and critical when architecting the launch of a
- production chain. Take note of the `development_chain_spec` and `testnet_genesis` functions, which
- are used to define the genesis state for the local development chain configuration. These
- functions identify some
- [well-known accounts](https://substrate.dev/docs/en/knowledgebase/integrate/subkey#well-known-keys)
- and use them to configure the blockchain's initial state.
-- [`service.rs`](./node/src/service.rs): This file defines the node implementation. Take note of
- the libraries that this file imports and the names of the functions it invokes. In particular,
- there are references to consensus-related topics, such as the
- [longest chain rule](https://substrate.dev/docs/en/knowledgebase/advanced/consensus#longest-chain-rule),
- the [Babe](https://substrate.dev/docs/en/knowledgebase/advanced/consensus#babe) block authoring
- mechanism and the
- [GRANDPA](https://substrate.dev/docs/en/knowledgebase/advanced/consensus#grandpa) finality
- gadget.
-
-After the node has been [built](#build), refer to the embedded documentation to learn more about the
-capabilities and configuration parameters that it exposes:
-
-```shell
-./target/debug/duniter --help
```
-
-### Runtime
-
-In Substrate, the terms
-"[runtime](https://substrate.dev/docs/en/knowledgebase/getting-started/glossary#runtime)" and
-"[state transition function](https://substrate.dev/docs/en/knowledgebase/getting-started/glossary#stf-state-transition-function)"
-are analogous - they refer to the core logic of the blockchain that is responsible for validating
-blocks and executing the state changes they define. The Substrate project in this repository uses
-the [FRAME](https://substrate.dev/docs/en/knowledgebase/runtime/frame) framework to construct a
-blockchain runtime. FRAME allows runtime developers to declare domain-specific logic in modules
-called "pallets". At the heart of FRAME is a helpful
-[macro language](https://substrate.dev/docs/en/knowledgebase/runtime/macros) that makes it easy to
-create pallets and flexibly compose them to create blockchains that can address
-[a variety of needs](https://www.substrate.io/substrate-users/).
-
-Review the [FRAME runtime implementation](./runtime/src/lib.rs) included in this template and note
-the following:
-
-- This file configures several pallets to include in the runtime. Each pallet configuration is
- defined by a code block that begins with `impl $PALLET_NAME::Config for Runtime`.
-- The pallets are composed into a single runtime by way of the
- [`construct_runtime!`](https://crates.parity.io/frame_support/macro.construct_runtime.html)
- macro, which is part of the core
- [FRAME Support](https://substrate.dev/docs/en/knowledgebase/runtime/frame#support-library)
- library.
-
-### Pallets
-
-The runtime in this project is constructed using many FRAME pallets that ship with the
-[core Substrate repository](https://github.com/paritytech/substrate/tree/master/frame) and a
-template pallet that is [defined in the `pallets`](./pallets/template/src/lib.rs) directory.
-
-A FRAME pallet is compromised of a number of blockchain primitives:
-
-- Storage: FRAME defines a rich set of powerful
- [storage abstractions](https://substrate.dev/docs/en/knowledgebase/runtime/storage) that makes
- it easy to use Substrate's efficient key-value database to manage the evolving state of a
- blockchain.
-- Dispatchables: FRAME pallets define special types of functions that can be invoked (dispatched)
- from outside of the runtime in order to update its state.
-- Events: Substrate uses [events](https://substrate.dev/docs/en/knowledgebase/runtime/events) to
- notify users of important changes in the runtime.
-- Errors: When a dispatchable fails, it returns an error.
-- Config: The `Config` configuration interface is used to define the types and parameters upon
- which a FRAME pallet depends.
-
-## License
-
CopyLeft 2021-2023 Axiom-Team
Some parts borrowed from Polkadot (Parity Technologies (UK) Ltd.)
@@ -302,3 +147,4 @@ GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with Duniter-v2S. If not, see <https://www.gnu.org/licenses/>.
+```
diff --git a/docker-compose.yml b/docker-compose.yml
index 85dac1986254ae50a35fd08e9e303dcd59edf593..699e3920a09102e4fb0f52e7145a60a4b5569c4a 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -5,7 +5,7 @@ services:
container_name: duniter-v2s-mirror
# the image tells which network you are connecting to
# here it is gdev network
- image: duniter/duniter-v2s-gdev:latest
+ image: duniter/duniter-v2s-gdev-800:latest
ports:
# prometheus telemetry to monitor resource use
- 9615:9615
diff --git a/docker/compose/docker-compose.smith.yml b/docker/compose/docker-compose.smith.yml
index cf36c98ed0cd71ba368011871b9750592a31e0e8..fc1a48fe3e1901f8ba69e61be9d2e4b0c1a59a36 100644
--- a/docker/compose/docker-compose.smith.yml
+++ b/docker/compose/docker-compose.smith.yml
@@ -4,7 +4,7 @@ services:
# duniter smith node
duniter-v2s-smith:
container_name: duniter-v2s-smith
- image: duniter/duniter-v2s-gdev:latest
+ image: duniter/duniter-v2s-gdev-800:latest
ports:
# RPC API of a smith node should not be exposed publicly!
- 127.0.0.1:9944:9944
diff --git a/docs/api/manual.md b/docs/api/manual.md
index 0b9a91eb7f77a347a0379ee6e4515435460db990..a43b76b1c5679adf47e1e53a057cef9e0bdc0101 100644
--- a/docs/api/manual.md
+++ b/docs/api/manual.md
@@ -3,7 +3,7 @@
This functional documentation presents how wallets can interact with the blockchain.
It is intended to complete the [runtime calls documentation](./runtime-calls.md) in a runtime-specific way to fit the real needs of wallet developers.
-Only ÄžDev is covered for now.
+NOTE : a more detailed doc is available at <https://duniter.org/wiki/duniter-v2/doc/>
## Notations
@@ -11,26 +11,27 @@ Only ÄžDev is covered for now.
## Account existence
-An account exists if and only if it contains at least the existential deposit (2 ÄžD).
+An account exists if and only if it contains at least the existential deposit (`balances.existentialDeposit` = 1 ÄžD).
## Become member
-Only use `identity` pallet. The `membership` calls are disabled.
+Only use `identity` pallet.
1. The account that wants to gain membership needs to exists.
1. Any account that already has membership and respects the identity creation period can create an identity for another account, using `identity.createIdentity`.
-1. The account has to confirm its identity with a name, using `identity.confirmIdentity`. The name must be ASCII alphanumeric, punctuation or space characters: ``/^[-!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~a-zA-Z0-9 ]{3,64}$/`` (additionally, trailing spaces and double spaces are forbidden, as a phishing countermeasure). If the name is already used, the call will fail.
+1. The account has to confirm its identity with a name, using `identity.confirmIdentity`. The name must be ASCII alphanumeric, punctuation or space characters: `` /^[-!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~a-zA-Z0-9 ]{3,64}$/ `` (additionally, trailing spaces and double spaces are forbidden, as a phishing countermeasure). If the name is already used, the call will fail.
1. 4 different member accounts must certify the account using `cert.addCert`.
-1. The distance evaluation must be requested for the pending identity using `distance.evaluateDistance`.
-1. 3 sessions later, if the distance rule is respected, `identity.validateIdentity` can be called.
+1. The distance evaluation must be requested for the pending identity using `distance.requestDistanceEvaluation`.
+1. 3 distance sessions later, if the distance rule is respected, identity is validated automatically.
## Change key
A member can request a key change via the `identity.change_onwner_key` call. It needs the following SCALE encoded (see SCALE encoding section below) payload:
-* The new owner key payload prefix (rust definition: `b"icok"`)
-* the genesis block hash. (rust type `[u8; 32]` (`H256`))
-* The identity index (rust type `u64`)
-* The old key (rust type `u64`)
+
+- The new owner key payload prefix (rust definition: `b"icok"`)
+- the genesis block hash. (rust type `[u8; 32]` (`H256`))
+- The identity index (rust type `u64`)
+- The old key (rust type `u64`)
This payload must be signed with the new key.
@@ -43,9 +44,10 @@ This feature is useful in case the user has lost their private key since the rev
### Generate the revocation payload
The revocation needs this SCALE encoded (see SCALE encoding section below) payload:
-* The revocation payload prefix (rust definition: `b"revo"`)
-* The identity index (rust type `u64`)
-* the genesis block hash. (rust type `[u8; 32]` (`H256`))
+
+- The revocation payload prefix (rust definition: `b"revo"`)
+- The identity index (rust type `u64`)
+- the genesis block hash. (rust type `[u8; 32]` (`H256`))
This payload must be signed with the corresponding revocation key.
diff --git a/docs/api/runtime-calls.md b/docs/api/runtime-calls.md
index 3ab03a9326b6db1555a061be6a0dc5cd63c3f172..064ef8b059bb138b7c1d74a635822a813939d7d0 100644
--- a/docs/api/runtime-calls.md
+++ b/docs/api/runtime-calls.md
@@ -3,243 +3,40 @@
Calls are categorized according to the dispatch origin they require:
1. **User calls**: the dispatch origin for this kind of call must be signed by
-the transactor. This is the only call category that can be submitted with an extrinsic.
+ the transactor. This is the only call category that can be submitted with an extrinsic.
1. **Root calls**: This kind of call requires a special origin that can only be invoked
-through on-chain governance mechanisms.
+ through on-chain governance mechanisms.
1. **Inherent calls**: This kind of call is invoked by the author of the block itself
-(usually automatically by the node).
+ (usually automatically by the node).
1. **Disabled calls**: These calls can not be called directly, they are reserved for internal use by other runtime calls.
+We only document user calls below.
-## User calls
+There are **64** user calls from **17** pallets.
-There are **86** user calls from **21** pallets.
+## Account - 1
-### Account - 1
-
-#### unlink_identity - 0
+### unlink_identity - 0
<details><summary><code>unlink_identity()</code></summary>
-Taking 0.0111 % of a block.
-
-```rust
-```
-</details>
-
-
-Unlink the identity associated with the account.
-
-### Scheduler - 2
-
-#### schedule - 0
-
-<details><summary><code>schedule(when, maybe_periodic, priority, call)</code></summary>
-
-Taking 0.0122 % of a block.
-
-```rust
-when: BlockNumberFor<T>
-maybe_periodic: Option<schedule::Period<BlockNumberFor<T>>>
-priority: schedule::Priority
-call: Box<<T as Config>::RuntimeCall>
-```
-</details>
-
-
-Anonymously schedule a task.
-
-#### cancel - 1
-
-<details><summary><code>cancel(when, index)</code></summary>
-
-Taking 0.0236 % of a block.
-
-```rust
-when: BlockNumberFor<T>
-index: u32
-```
-</details>
-
-
-Cancel an anonymously scheduled task.
-
-#### schedule_named - 2
-
-<details><summary><code>schedule_named(id, when, maybe_periodic, priority, call)</code></summary>
-
-Taking 0.0189 % of a block.
-
-```rust
-id: TaskName
-when: BlockNumberFor<T>
-maybe_periodic: Option<schedule::Period<BlockNumberFor<T>>>
-priority: schedule::Priority
-call: Box<<T as Config>::RuntimeCall>
-```
-</details>
-
-
-Schedule a named task.
-
-#### cancel_named - 3
-
-<details><summary><code>cancel_named(id)</code></summary>
-
-Taking 0.0248 % of a block.
-
-```rust
-id: TaskName
-```
-</details>
-
-
-Cancel a named scheduled task.
-
-#### schedule_after - 4
-
-<details><summary><code>schedule_after(after, maybe_periodic, priority, call)</code></summary>
-
-No weight available.
-
-```rust
-after: BlockNumberFor<T>
-maybe_periodic: Option<schedule::Period<BlockNumberFor<T>>>
-priority: schedule::Priority
-call: Box<<T as Config>::RuntimeCall>
-```
-</details>
-
-
-Anonymously schedule a task after a delay.
-
-#### schedule_named_after - 5
-
-<details><summary><code>schedule_named_after(id, after, maybe_periodic, priority, call)</code></summary>
-
-No weight available.
-
-```rust
-id: TaskName
-after: BlockNumberFor<T>
-maybe_periodic: Option<schedule::Period<BlockNumberFor<T>>>
-priority: schedule::Priority
-call: Box<<T as Config>::RuntimeCall>
-```
-</details>
-
-
-Schedule a named task after a delay.
-
-#### set_retry - 6
-
-<details><summary><code>set_retry(task, retries, period)</code></summary>
-
-Taking 0.012 % of a block.
-
-```rust
-task: TaskAddress<BlockNumberFor<T>>
-retries: u8
-period: BlockNumberFor<T>
-```
-</details>
-
-
-Set a retry configuration for a task so that, in case its scheduled run fails, it will
-be retried after `period` blocks, for a total amount of `retries` retries or until it
-succeeds.
-
-Tasks which need to be scheduled for a retry are still subject to weight metering and
-agenda space, same as a regular task. If a periodic task fails, it will be scheduled
-normally while the task is retrying.
-
-Tasks scheduled as a result of a retry for a periodic task are unnamed, non-periodic
-clones of the original task. Their retry configuration will be derived from the
-original task's configuration, but will have a lower value for `remaining` than the
-original `total_retries`.
-
-#### set_retry_named - 7
-
-<details><summary><code>set_retry_named(id, retries, period)</code></summary>
-
-Taking 0.0132 % of a block.
-
-```rust
-id: TaskName
-retries: u8
-period: BlockNumberFor<T>
-```
-</details>
-
-
-Set a retry configuration for a named task so that, in case its scheduled run fails, it
-will be retried after `period` blocks, for a total amount of `retries` retries or until
-it succeeds.
-
-Tasks which need to be scheduled for a retry are still subject to weight metering and
-agenda space, same as a regular task. If a periodic task fails, it will be scheduled
-normally while the task is retrying.
-
-Tasks scheduled as a result of a retry for a periodic task are unnamed, non-periodic
-clones of the original task. Their retry configuration will be derived from the
-original task's configuration, but will have a lower value for `remaining` than the
-original `total_retries`.
-
-#### cancel_retry - 8
-
-<details><summary><code>cancel_retry(task)</code></summary>
-
-Taking 0.012 % of a block.
-
-```rust
-task: TaskAddress<BlockNumberFor<T>>
-```
-</details>
-
-
-Removes the retry configuration of a task.
-
-#### cancel_retry_named - 9
-
-<details><summary><code>cancel_retry_named(id)</code></summary>
-
-Taking 0.0132 % of a block.
+Taking 0.0109 % of a block.
```rust
-id: TaskName
```
</details>
-Cancel the retry configuration of a named task.
-
-### Babe - 3
-
-#### report_equivocation - 0
-
-<details><summary><code>report_equivocation(equivocation_proof, key_owner_proof)</code></summary>
-
-No weight available.
-
-```rust
-equivocation_proof: Box<EquivocationProof<HeaderFor<T>>>
-key_owner_proof: T::KeyOwnerProof
-```
-</details>
-
-Report authority equivocation/misbehavior. This method will verify
-the equivocation proof and validate the given key ownership proof
-against the extracted offender. If both are valid, the offence will
-be reported.
+Unlink the identity associated with the account.
-### Balances - 6
+## Balances - 6
-#### transfer_allow_death - 0
+### transfer_allow_death - 0
<details><summary><code>transfer_allow_death(dest, value)</code></summary>
-Taking 0.0199 % of a block.
+Taking 0.0194 % of a block.
```rust
dest: AccountIdLookupOf<T>
@@ -248,6 +45,7 @@ value: T::Balance
</details>
+
Transfer some liquid free balance to another account.
`transfer_allow_death` will set the `FreeBalance` of the sender and receiver.
@@ -256,11 +54,11 @@ of the transfer, the account will be reaped.
The dispatch origin for this call must be `Signed` by the transactor.
-#### transfer_keep_alive - 3
+### transfer_keep_alive - 3
<details><summary><code>transfer_keep_alive(dest, value)</code></summary>
-Taking 0.0125 % of a block.
+Taking 0.0122 % of a block.
```rust
dest: AccountIdLookupOf<T>
@@ -269,6 +67,7 @@ value: T::Balance
</details>
+
Same as the [`transfer_allow_death`] call, but with a check that the transfer will not
kill the origin account.
@@ -276,11 +75,11 @@ kill the origin account.
[`transfer_allow_death`]: struct.Pallet.html#method.transfer
-#### transfer_all - 4
+### transfer_all - 4
<details><summary><code>transfer_all(dest, keep_alive)</code></summary>
-Taking 0.0129 % of a block.
+Taking 0.0126 % of a block.
```rust
dest: AccountIdLookupOf<T>
@@ -289,6 +88,7 @@ keep_alive: bool
</details>
+
Transfer the entire transferable balance from the caller account.
NOTE: This function only attempts to transfer _transferable_ balances. This means that
@@ -305,51 +105,7 @@ The dispatch origin of this call must be Signed.
transfer everything except at least the existential deposit, which will guarantee to
keep the sender account alive (true).
-#### force_set_balance - 8
-
-<details><summary><code>force_set_balance(who, new_free)</code></summary>
-
-No weight available.
-
-```rust
-who: AccountIdLookupOf<T>
-new_free: T::Balance
-```
-</details>
-
-
-Upgrade a specified account.
-
-- `origin`: Must be `Signed`.
-- `who`: The account to be upgraded.
-
-This will waive the transaction fee if at least all but 10% of the accounts needed to
-be upgraded. (We let some not have to be upgraded just in order to allow for the
-possibility of churn).
-Set the regular balance of a given account.
-
-The dispatch origin for this call is `root`.
-
-#### force_adjust_total_issuance - 9
-
-<details><summary><code>force_adjust_total_issuance(direction, delta)</code></summary>
-
-Taking 0.0048 % of a block.
-
-```rust
-direction: AdjustmentDirection
-delta: T::Balance
-```
-</details>
-
-
-Adjust the total issuance in a saturating way.
-
-Can only be called by root and always needs a positive `delta`.
-
-# Example
-
-#### burn - 10
+### burn - 10
<details><summary><code>burn(value, keep_alive)</code></summary>
@@ -362,6 +118,7 @@ keep_alive: bool
</details>
+
Burn the specified liquid free balance from the origin account.
If the origin's account ends up below the existential deposit as a result
@@ -370,13 +127,13 @@ of the burn and `keep_alive` is false, the account will be reaped.
Unlike sending funds to a _burn_ address, which merely makes the funds inaccessible,
this `burn` operation will reduce total issuance by the amount _burned_.
-### OneshotAccount - 7
+## OneshotAccount - 7
-#### create_oneshot_account - 0
+### create_oneshot_account - 0
<details><summary><code>create_oneshot_account(dest, value)</code></summary>
-Taking 0.012 % of a block.
+Taking 0.0117 % of a block.
```rust
dest: <T::Lookup as StaticLookup>::Source
@@ -385,6 +142,7 @@ value: BalanceOf<T>
</details>
+
Create an account that can only be consumed once
- `dest`: The oneshot account to be created.
@@ -392,11 +150,11 @@ Create an account that can only be consumed once
Origin account is kept alive.
-#### consume_oneshot_account - 1
+### consume_oneshot_account - 1
<details><summary><code>consume_oneshot_account(block_height, dest)</code></summary>
-Taking 0.0197 % of a block.
+Taking 0.0195 % of a block.
```rust
block_height: BlockNumberFor<T>
@@ -405,17 +163,18 @@ dest: Account<<T::Lookup as StaticLookup>::Source>
</details>
+
Consume a oneshot account and transfer its balance to an account
- `block_height`: Must be a recent block number. The limit is `BlockHashCount` in the past. (this is to prevent replay attacks)
- `dest`: The destination account.
- `dest_is_oneshot`: If set to `true`, then a oneshot account is created at `dest`. Else, `dest` has to be an existing account.
-#### consume_oneshot_account_with_remaining - 2
+### consume_oneshot_account_with_remaining - 2
<details><summary><code>consume_oneshot_account_with_remaining(block_height, dest, remaining_to, balance)</code></summary>
-Taking 0.0268 % of a block.
+Taking 0.0265 % of a block.
```rust
block_height: BlockNumberFor<T>
@@ -426,6 +185,7 @@ balance: BalanceOf<T>
</details>
+
Consume a oneshot account then transfer some amount to an account,
and the remaining amount to another account.
@@ -437,13 +197,13 @@ and the remaining amount to another account.
- `dest2_is_oneshot`: If set to `true`, then a oneshot account is created at `dest2`. Else, `dest2` has to be an existing account.
- `balance1`: The amount transfered to `dest`, the leftover being transfered to `dest2`.
-### SmithMembers - 10
+## SmithMembers - 10
-#### invite_smith - 0
+### invite_smith - 0
<details><summary><code>invite_smith(receiver)</code></summary>
-Taking 0.0235 % of a block.
+Taking 0.024 % of a block.
```rust
receiver: T::IdtyIndex
@@ -451,22 +211,24 @@ receiver: T::IdtyIndex
</details>
+
Invite a member of the Web of Trust to attempt becoming a Smith.
-#### accept_invitation - 1
+### accept_invitation - 1
<details><summary><code>accept_invitation()</code></summary>
-Taking 0.0127 % of a block.
+Taking 0.0126 % of a block.
```rust
```
</details>
+
Accept an invitation to become a Smith (must have been invited first).
-#### certify_smith - 2
+### certify_smith - 2
<details><summary><code>certify_smith(receiver)</code></summary>
@@ -478,41 +240,44 @@ receiver: T::IdtyIndex
</details>
+
Certify an invited Smith, which can lead the certified to become a Smith.
-### AuthorityMembers - 11
+## AuthorityMembers - 11
-#### go_offline - 0
+### go_offline - 0
<details><summary><code>go_offline()</code></summary>
-Taking 0.0167 % of a block.
+Taking 0.0172 % of a block.
```rust
```
</details>
+
Request to leave the set of validators two sessions later.
-#### go_online - 1
+### go_online - 1
<details><summary><code>go_online()</code></summary>
-Taking 0.0189 % of a block.
+Taking 0.0199 % of a block.
```rust
```
</details>
+
Request to join the set of validators two sessions later.
-#### set_session_keys - 2
+### set_session_keys - 2
<details><summary><code>set_session_keys(keys)</code></summary>
-Taking 0.0249 % of a block.
+Taking 0.0256 % of a block.
```rust
keys: T::Keys
@@ -520,71 +285,16 @@ keys: T::Keys
</details>
-Declare new session keys to replace current ones.
-
-#### remove_member_from_blacklist - 4
-
-<details><summary><code>remove_member_from_blacklist(member_id)</code></summary>
-
-Taking 0.0114 % of a block.
-
-```rust
-member_id: T::MemberId
-```
-</details>
-
-
-Remove a member from the blacklist.
-remove an identity from the blacklist
-
-### Grandpa - 16
-
-#### report_equivocation - 0
-
-<details><summary><code>report_equivocation(equivocation_proof, key_owner_proof)</code></summary>
-
-No weight available.
-
-```rust
-equivocation_proof: Box<EquivocationProof<T::Hash, BlockNumberFor<T>>>
-key_owner_proof: T::KeyOwnerProof
-```
-</details>
-
-
-Report voter equivocation/misbehavior. This method will verify the
-equivocation proof and validate the given key ownership proof
-against the extracted offender. If both are valid, the offence
-will be reported.
-
-### UpgradeOrigin - 21
-
-#### dispatch_as_root_unchecked_weight - 1
-
-<details><summary><code>dispatch_as_root_unchecked_weight(call, weight)</code></summary>
-
-No weight available.
-
-```rust
-call: Box<<T as Config>::Call>
-weight: Weight
-```
-</details>
-
-
-Dispatches a function call from root origin.
-This function does not check the weight of the call, and instead allows the
-caller to specify the weight of the call.
-The weight of this call is defined by the caller.
+Declare new session keys to replace current ones.
-### Preimage - 22
+## Preimage - 22
-#### note_preimage - 0
+### note_preimage - 0
<details><summary><code>note_preimage(bytes)</code></summary>
-Taking 0.2947 % of a block.
+Taking 0.2845 % of a block.
```rust
bytes: Vec<u8>
@@ -592,16 +302,17 @@ bytes: Vec<u8>
</details>
+
Register a preimage on-chain.
If the preimage was previously requested, no fees or deposits are taken for providing
the preimage. Otherwise, a deposit is taken proportional to the size of the preimage.
-#### unnote_preimage - 1
+### unnote_preimage - 1
<details><summary><code>unnote_preimage(hash)</code></summary>
-Taking 0.0184 % of a block.
+Taking 0.0181 % of a block.
```rust
hash: T::Hash
@@ -609,6 +320,7 @@ hash: T::Hash
</details>
+
Clear an unrequested preimage from the runtime storage.
If `len` is provided, then it will be a much cheaper operation.
@@ -616,11 +328,11 @@ If `len` is provided, then it will be a much cheaper operation.
- `hash`: The hash of the preimage to be removed from the store.
- `len`: The length of the preimage of `hash`.
-#### request_preimage - 2
+### request_preimage - 2
<details><summary><code>request_preimage(hash)</code></summary>
-Taking 0.0129 % of a block.
+Taking 0.0128 % of a block.
```rust
hash: T::Hash
@@ -628,16 +340,17 @@ hash: T::Hash
</details>
+
Request a preimage be uploaded to the chain without paying any fees or deposits.
If the preimage requests has already been provided on-chain, we unreserve any deposit
a user may have paid, and take the control of the preimage out of their hands.
-#### unrequest_preimage - 3
+### unrequest_preimage - 3
<details><summary><code>unrequest_preimage(hash)</code></summary>
-Taking 0.0184 % of a block.
+Taking 0.018 % of a block.
```rust
hash: T::Hash
@@ -645,15 +358,16 @@ hash: T::Hash
</details>
+
Clear a previously made request for a preimage.
NOTE: THIS MUST NOT BE CALLED ON `hash` MORE TIMES THAN `request_preimage`.
-#### ensure_updated - 4
+### ensure_updated - 4
<details><summary><code>ensure_updated(hashes)</code></summary>
-Taking 19.3634 % of a block.
+Taking 18.8992 % of a block.
```rust
hashes: Vec<T::Hash>
@@ -661,13 +375,14 @@ hashes: Vec<T::Hash>
</details>
+
Ensure that the a bulk of pre-images is upgraded.
The caller pays no fee if at least 90% of pre-images were successfully updated.
-### TechnicalCommittee - 23
+## TechnicalCommittee - 23
-#### execute - 1
+### execute - 1
<details><summary><code>execute(proposal, length_bound)</code></summary>
@@ -680,17 +395,18 @@ length_bound: u32
</details>
+
Dispatch a proposal from a member using the `Member` origin.
Origin must be a member of the collective.
-**Complexity**:
+###### Complexity:
- `O(B + M + P)` where:
- `B` is `proposal` size in bytes (length-fee-bounded)
- `M` members-count (code-bounded)
- `P` complexity of dispatching `proposal`
-#### propose - 2
+### propose - 2
<details><summary><code>propose(threshold, proposal, length_bound)</code></summary>
@@ -704,6 +420,7 @@ length_bound: u32
</details>
+
Add a new proposal to either be voted on or executed directly.
Requires the sender to be member.
@@ -711,7 +428,7 @@ Requires the sender to be member.
`threshold` determines whether `proposal` is executed directly (`threshold < 2`)
or put up for voting.
-**Complexity**
+###### Complexity
- `O(B + M + P1)` or `O(B + M + P2)` where:
- `B` is `proposal` size in bytes (length-fee-bounded)
- `M` is members-count (code- and governance-bounded)
@@ -719,11 +436,11 @@ or put up for voting.
- `P1` is proposal execution complexity (`threshold < 2`)
- `P2` is proposals-count (code-bounded) (`threshold >= 2`)
-#### vote - 3
+### vote - 3
<details><summary><code>vote(proposal, index, approve)</code></summary>
-Taking 0.0129 % of a block.
+Taking 0.0128 % of a block.
```rust
proposal: T::Hash
@@ -733,6 +450,7 @@ approve: bool
</details>
+
Add an aye or nay vote for the sender to the given proposal.
Requires the sender to be a member.
@@ -740,10 +458,10 @@ Requires the sender to be a member.
Transaction fees will be waived if the member is voting on any particular proposal
for the first time and the call is successful. Subsequent vote changes will charge a
fee.
-**Complexity**
+###### Complexity
- `O(M)` where `M` is members-count (code- and governance-bounded)
-#### close - 6
+### close - 6
<details><summary><code>close(proposal_hash, index, proposal_weight_bound, length_bound)</code></summary>
@@ -758,6 +476,7 @@ length_bound: u32
</details>
+
Close a vote that is either approved, disapproved or whose voting period has ended.
May be called by any signed account in order to finish voting and close the proposal.
@@ -776,33 +495,34 @@ proposal.
+ `length_bound`: The upper bound for the length of the proposal in storage. Checked via
`storage::read` so it is `size_of::<u32>() == 4` larger than the pure length.
-**Complexity**
+###### Complexity
- `O(B + M + P1 + P2)` where:
- `B` is `proposal` size in bytes (length-fee-bounded)
- `M` is members-count (code- and governance-bounded)
- `P1` is the complexity of `proposal` preimage.
- `P2` is proposal-count (code-bounded)
-### UniversalDividend - 30
+## UniversalDividend - 30
-#### claim_uds - 0
+### claim_uds - 0
<details><summary><code>claim_uds()</code></summary>
-Taking 0.0218 % of a block.
+Taking 0.0219 % of a block.
```rust
```
</details>
+
Claim Universal Dividends.
-#### transfer_ud - 1
+### transfer_ud - 1
<details><summary><code>transfer_ud(dest, value)</code></summary>
-Taking 0.021 % of a block.
+Taking 0.0207 % of a block.
```rust
dest: <T::Lookup as StaticLookup>::Source
@@ -811,13 +531,14 @@ value: BalanceOf<T>
</details>
+
Transfer some liquid free balance to another account, in milliUD.
-#### transfer_ud_keep_alive - 2
+### transfer_ud_keep_alive - 2
<details><summary><code>transfer_ud_keep_alive(dest, value)</code></summary>
-Taking 0.0135 % of a block.
+Taking 0.0134 % of a block.
```rust
dest: <T::Lookup as StaticLookup>::Source
@@ -826,15 +547,16 @@ value: BalanceOf<T>
</details>
+
Transfer some liquid free balance to another account in milliUD and keep the account alive.
-### Identity - 41
+## Identity - 41
-#### create_identity - 0
+### create_identity - 0
<details><summary><code>create_identity(owner_key)</code></summary>
-Taking 0.0856 % of a block.
+Taking 0.0843 % of a block.
```rust
owner_key: T::AccountId
@@ -842,17 +564,18 @@ owner_key: T::AccountId
</details>
+
Create an identity for an existing account
- `owner_key`: the public key corresponding to the identity to be created
The origin must be allowed to create an identity.
-#### confirm_identity - 1
+### confirm_identity - 1
<details><summary><code>confirm_identity(idty_name)</code></summary>
-Taking 0.0327 % of a block.
+Taking 0.0322 % of a block.
```rust
idty_name: IdtyName
@@ -860,17 +583,18 @@ idty_name: IdtyName
</details>
+
Confirm the creation of an identity and give it a name
- `idty_name`: the name uniquely associated to this identity. Must match the validation rules defined by the runtime.
The identity must have been created using `create_identity` before it can be confirmed.
-#### change_owner_key - 3
+### change_owner_key - 3
<details><summary><code>change_owner_key(new_key, new_key_sig)</code></summary>
-Taking 0.0424 % of a block.
+Taking 0.0421 % of a block.
```rust
new_key: T::AccountId
@@ -879,6 +603,7 @@ new_key_sig: T::Signature
</details>
+
Change identity owner key.
- `new_key`: the new owner key.
@@ -887,11 +612,11 @@ Change identity owner key.
The origin should be the old identity owner key.
-#### revoke_identity - 4
+### revoke_identity - 4
<details><summary><code>revoke_identity(idty_index, revocation_key, revocation_sig)</code></summary>
-Taking 0.0399 % of a block.
+Taking 0.0392 % of a block.
```rust
idty_index: T::IdtyIndex
@@ -901,6 +626,7 @@ revocation_sig: T::Signature
</details>
+
Revoke an identity using a revocation signature
- `idty_index`: the index of the identity to be revoked.
@@ -910,30 +636,26 @@ Revoke an identity using a revocation signature
Any signed origin can execute this call.
-#### fix_sufficients - 7
+### revoke_identity_legacy - 9
-<details><summary><code>fix_sufficients(owner_key, inc)</code></summary>
+<details><summary><code>revoke_identity_legacy(revocation_document)</code></summary>
-Taking 0.0113 % of a block.
+Taking 0.0392 % of a block.
```rust
-owner_key: T::AccountId
-inc: bool
+revocation_document: Vec<u8>
```
</details>
-Change sufficient reference count for a given key.
-This function allows a privileged root origin to increment or decrement the sufficient
-reference count associated with a specified owner key.
+Revoke an identity using a legacy (DUBP) revocation document
-- `origin` - The origin of the call. It must be root.
-- `owner_key` - The account whose sufficient reference count will be modified.
-- `inc` - A boolean indicating whether to increment (`true`) or decrement (`false`) the count.
+- `revocation document`: the full-length revocation document, signature included
+Any signed origin can execute this call.
-#### link_account - 8
+### link_account - 8
<details><summary><code>link_account(account_id, payload_sig)</code></summary>
@@ -946,6 +668,7 @@ payload_sig: T::Signature
</details>
+
Link an account to an identity.
This function links a specified account to an identity, requiring both the account and the
@@ -955,13 +678,13 @@ identity to sign the operation.
- `account_id` - The account ID to link, which must sign the payload.
- `payload_sig` - The signature with the linked identity.
-### Certification - 43
+## Certification - 43
-#### add_cert - 0
+### add_cert - 0
<details><summary><code>add_cert(receiver)</code></summary>
-Taking 0.0356 % of a block.
+Taking 0.0357 % of a block.
```rust
receiver: T::IdtyIndex
@@ -969,79 +692,49 @@ receiver: T::IdtyIndex
</details>
+
Add a new certification.
-#### renew_cert - 3
+### renew_cert - 3
<details><summary><code>renew_cert(receiver)</code></summary>
-Taking 0.0292 % of a block.
-
-```rust
-receiver: T::IdtyIndex
-```
-</details>
-
-
-Renew an existing certification.
-
-#### del_cert - 1
-
-<details><summary><code>del_cert(issuer, receiver)</code></summary>
-
-Taking 0.0257 % of a block.
+Taking 0.0295 % of a block.
```rust
-issuer: T::IdtyIndex
receiver: T::IdtyIndex
```
</details>
-Remove one certification given the issuer and the receiver.
-
-- `origin`: Must be `Root`.
-
-#### remove_all_certs_received_by - 2
-
-<details><summary><code>remove_all_certs_received_by(idty_index)</code></summary>
-
-Taking 6.846 % of a block.
-
-```rust
-idty_index: T::IdtyIndex
-```
-</details>
-
-
-Remove all certifications received by an identity.
-- `origin`: Must be `Root`.
+Renew an existing certification.
-### Distance - 44
+## Distance - 44
-#### request_distance_evaluation - 0
+### request_distance_evaluation - 0
<details><summary><code>request_distance_evaluation()</code></summary>
-Taking 0.0389 % of a block.
+Taking 0.0393 % of a block.
```rust
```
</details>
+
Request evaluation of the caller's identity distance.
This function allows the caller to request an evaluation of their distance.
A positive evaluation will lead to claiming or renewing membership, while a negative
evaluation will result in slashing for the caller.
-#### request_distance_evaluation_for - 4
+### request_distance_evaluation_for - 4
<details><summary><code>request_distance_evaluation_for(target)</code></summary>
-Taking 0.0399 % of a block.
+Taking 0.0404 % of a block.
```rust
target: T::IdtyIndex
@@ -1049,96 +742,44 @@ target: T::IdtyIndex
</details>
+
Request evaluation of a target identity's distance.
This function allows the caller to request an evaluation of a specific target identity's distance.
This action is only permitted for unvalidated identities.
-#### update_evaluation - 1
+## AtomicSwap - 50
-<details><summary><code>update_evaluation(computation_result)</code></summary>
+### create_swap - 0
-Taking 0.0341 % of a block.
+<details><summary><code>create_swap(target, hashed_proof, action, duration)</code></summary>
+
+No weight available.
```rust
-computation_result: ComputationResult
+target: T::AccountId
+hashed_proof: HashedProof
+action: T::SwapAction
+duration: BlockNumberFor<T>
```
</details>
-Push an evaluation result to the pool.
-This inherent function is called internally by validators to push an evaluation result
-to the evaluation pool.
+Register a new atomic swap, declaring an intention to send funds from origin to target
+on the current blockchain. The target can claim the fund using the revealed proof. If
+the fund is not claimed after `duration` blocks, then the sender can cancel the swap.
-#### force_update_evaluation - 2
+The dispatch origin for this call must be _Signed_.
-<details><summary><code>force_update_evaluation(evaluator, computation_result)</code></summary>
+- `target`: Receiver of the atomic swap.
+- `hashed_proof`: The blake2_256 hash of the secret proof.
+- `balance`: Funds to be sent from origin.
+- `duration`: Locked duration of the atomic swap. For safety reasons, it is recommended
+ that the revealer uses a shorter duration than the counterparty, to prevent the
+ situation where the revealer reveals the proof too late around the end block.
-Taking 0.0192 % of a block.
-
-```rust
-evaluator: <T as frame_system::Config>::AccountId
-computation_result: ComputationResult
-```
-</details>
-
-
-Force push an evaluation result to the pool.
-
-It is primarily used for testing purposes.
-
-- `origin`: Must be `Root`.
-
-#### force_valid_distance_status - 3
-
-<details><summary><code>force_valid_distance_status(identity)</code></summary>
-
-Taking 0.027 % of a block.
-
-```rust
-identity: <T as pallet_identity::Config>::IdtyIndex
-```
-</details>
-
-
-Force set the distance evaluation status of an identity.
-
-It is primarily used for testing purposes.
-
-- `origin`: Must be `Root`.
-
-### AtomicSwap - 50
-
-#### create_swap - 0
-
-<details><summary><code>create_swap(target, hashed_proof, action, duration)</code></summary>
-
-No weight available.
-
-```rust
-target: T::AccountId
-hashed_proof: HashedProof
-action: T::SwapAction
-duration: BlockNumberFor<T>
-```
-</details>
-
-
-Register a new atomic swap, declaring an intention to send funds from origin to target
-on the current blockchain. The target can claim the fund using the revealed proof. If
-the fund is not claimed after `duration` blocks, then the sender can cancel the swap.
-
-The dispatch origin for this call must be _Signed_.
-
-- `target`: Receiver of the atomic swap.
-- `hashed_proof`: The blake2_256 hash of the secret proof.
-- `balance`: Funds to be sent from origin.
-- `duration`: Locked duration of the atomic swap. For safety reasons, it is recommended
- that the revealer uses a shorter duration than the counterparty, to prevent the
- situation where the revealer reveals the proof too late around the end block.
-
-#### claim_swap - 1
+### claim_swap - 1
<details><summary><code>claim_swap(proof, action)</code></summary>
@@ -1151,6 +792,7 @@ action: T::SwapAction
</details>
+
Claim an atomic swap.
The dispatch origin for this call must be _Signed_.
@@ -1159,7 +801,7 @@ The dispatch origin for this call must be _Signed_.
- `action`: Action defined in the swap, it must match the entry in blockchain. Otherwise
the operation fails. This is used for weight calculation.
-#### cancel_swap - 2
+### cancel_swap - 2
<details><summary><code>cancel_swap(target, hashed_proof)</code></summary>
@@ -1172,6 +814,7 @@ hashed_proof: HashedProof
</details>
+
Cancel an atomic swap. Only possible after the originally set duration has passed.
The dispatch origin for this call must be _Signed_.
@@ -1179,13 +822,13 @@ The dispatch origin for this call must be _Signed_.
- `target`: Target of the original atomic swap.
- `hashed_proof`: Hashed proof of the original atomic swap.
-### Multisig - 51
+## Multisig - 51
-#### as_multi_threshold_1 - 0
+### as_multi_threshold_1 - 0
<details><summary><code>as_multi_threshold_1(other_signatories, call)</code></summary>
-Taking 0.005 % of a block.
+Taking 0.0048 % of a block.
```rust
other_signatories: Vec<T::AccountId>
@@ -1194,6 +837,7 @@ call: Box<<T as Config>::RuntimeCall>
</details>
+
Immediately dispatch a multi-signature call using a single approval from the caller.
The dispatch origin for this call must be _Signed_.
@@ -1204,10 +848,10 @@ multi-signature, but do not participate in the approval process.
Result is equivalent to the dispatched result.
-**Complexity**
+###### Complexity
O(Z + C) where Z is the length of the call and C its execution weight.
-#### as_multi - 1
+### as_multi - 1
<details><summary><code>as_multi(threshold, other_signatories, maybe_timepoint, call, max_weight)</code></summary>
@@ -1223,6 +867,7 @@ max_weight: Weight
</details>
+
Register approval for a dispatch to be made from a deterministic composite account if
approved by a total of `threshold - 1` of `other_signatories`.
@@ -1249,7 +894,7 @@ Result is equivalent to the dispatched result if `threshold` is exactly `1`. Oth
on success, result is `Ok` and the result from the interior call, if it was executed,
may be found in the deposited `MultisigExecuted` event.
-**Complexity**
+###### Complexity
- `O(S + Z + Call)`.
- Up to one balance-reserve or unreserve operation.
- One passthrough operation, one insert, both `O(S)` where `S` is the number of
@@ -1263,7 +908,7 @@ may be found in the deposited `MultisigExecuted` event.
- Storage: inserts one item, value size bounded by `MaxSignatories`, with a deposit
taken for its lifetime of `DepositBase + threshold * DepositFactor`.
-#### approve_as_multi - 2
+### approve_as_multi - 2
<details><summary><code>approve_as_multi(threshold, other_signatories, maybe_timepoint, call_hash, max_weight)</code></summary>
@@ -1279,6 +924,7 @@ max_weight: Weight
</details>
+
Register approval for a dispatch to be made from a deterministic composite account if
approved by a total of `threshold - 1` of `other_signatories`.
@@ -1298,7 +944,7 @@ transaction index) of the first approval transaction.
NOTE: If this is the final approval, you will want to use `as_multi` instead.
-**Complexity**
+###### Complexity
- `O(S)`.
- Up to one balance-reserve or unreserve operation.
- One passthrough operation, one insert, both `O(S)` where `S` is the number of
@@ -1310,11 +956,11 @@ NOTE: If this is the final approval, you will want to use `as_multi` instead.
- Storage: inserts one item, value size bounded by `MaxSignatories`, with a deposit
taken for its lifetime of `DepositBase + threshold * DepositFactor`.
-#### cancel_as_multi - 3
+### cancel_as_multi - 3
<details><summary><code>cancel_as_multi(threshold, other_signatories, timepoint, call_hash)</code></summary>
-Taking 0.0123 % of a block.
+Taking 0.0121 % of a block.
```rust
threshold: u16
@@ -1325,6 +971,7 @@ call_hash: [u8; 32]
</details>
+
Cancel a pre-existing, on-going multisig transaction. Any deposit reserved previously
for this operation will be unreserved on success.
@@ -1337,7 +984,7 @@ dispatch. May not be empty.
transaction for this dispatch.
- `call_hash`: The hash of the call to be executed.
-**Complexity**
+###### Complexity
- `O(S)`.
- Up to one balance-reserve or unreserve operation.
- One passthrough operation, one insert, both `O(S)` where `S` is the number of
@@ -1347,13 +994,13 @@ transaction for this dispatch.
- I/O: 1 read `O(S)`, one remove.
- Storage: removes one item.
-### ProvideRandomness - 52
+## ProvideRandomness - 52
-#### request - 0
+### request - 0
<details><summary><code>request(randomness_type, salt)</code></summary>
-Taking 0.0404 % of a block.
+Taking 0.0401 % of a block.
```rust
randomness_type: RandomnessType
@@ -1362,11 +1009,12 @@ salt: H256
</details>
+
Request randomness.
-### Proxy - 53
+## Proxy - 53
-#### proxy - 0
+### proxy - 0
<details><summary><code>proxy(real, force_proxy_type, call)</code></summary>
@@ -1380,6 +1028,7 @@ call: Box<<T as Config>::RuntimeCall>
</details>
+
Dispatch the given `call` from an account that the sender is authorised for through
`add_proxy`.
@@ -1390,11 +1039,11 @@ Parameters:
- `force_proxy_type`: Specify the exact proxy type to be used and checked for this call.
- `call`: The call to be made by the `real` account.
-#### add_proxy - 1
+### add_proxy - 1
<details><summary><code>add_proxy(delegate, proxy_type, delay)</code></summary>
-Taking 0.0121 % of a block.
+Taking 0.0118 % of a block.
```rust
delegate: AccountIdLookupOf<T>
@@ -1404,6 +1053,7 @@ delay: BlockNumberFor<T>
</details>
+
Register a proxy account for the sender that is able to make calls on its behalf.
The dispatch origin for this call must be _Signed_.
@@ -1414,11 +1064,11 @@ Parameters:
- `delay`: The announcement period required of the initial proxy. Will generally be
zero.
-#### remove_proxy - 2
+### remove_proxy - 2
<details><summary><code>remove_proxy(delegate, proxy_type, delay)</code></summary>
-Taking 0.0121 % of a block.
+Taking 0.0118 % of a block.
```rust
delegate: AccountIdLookupOf<T>
@@ -1428,6 +1078,7 @@ delay: BlockNumberFor<T>
</details>
+
Unregister a proxy account for the sender.
The dispatch origin for this call must be _Signed_.
@@ -1436,17 +1087,18 @@ Parameters:
- `proxy`: The account that the `caller` would like to remove as a proxy.
- `proxy_type`: The permissions currently enabled for the removed proxy account.
-#### remove_proxies - 3
+### remove_proxies - 3
<details><summary><code>remove_proxies()</code></summary>
-Taking 0.012 % of a block.
+Taking 0.0117 % of a block.
```rust
```
</details>
+
Unregister all proxy accounts for the sender.
The dispatch origin for this call must be _Signed_.
@@ -1454,11 +1106,11 @@ The dispatch origin for this call must be _Signed_.
WARNING: This may be called on accounts created by `pure`, however if done, then
the unreserved fees will be inaccessible. **All access to this account will be lost.**
-#### create_pure - 4
+### create_pure - 4
<details><summary><code>create_pure(proxy_type, delay, index)</code></summary>
-Taking 0.0121 % of a block.
+Taking 0.0118 % of a block.
```rust
proxy_type: T::ProxyType
@@ -1468,6 +1120,7 @@ index: u16
</details>
+
Spawn a fresh new account that is guaranteed to be otherwise inaccessible, and
initialize it with a proxy of `proxy_type` for `origin` sender.
@@ -1487,11 +1140,11 @@ same sender, with the same parameters.
Fails if there are insufficient funds to pay for deposit.
-#### kill_pure - 5
+### kill_pure - 5
<details><summary><code>kill_pure(spawner, proxy_type, index, height, ext_index)</code></summary>
-Taking 0.012 % of a block.
+Taking 0.0117 % of a block.
```rust
spawner: AccountIdLookupOf<T>
@@ -1503,6 +1156,7 @@ ext_index: u32
</details>
+
Removes a previously spawned pure proxy.
WARNING: **All access to this account will be lost.** Any funds held in it will be
@@ -1520,11 +1174,11 @@ Requires a `Signed` origin, and the sender account must have been created by a c
Fails with `NoPermission` in case the caller is not a previously created pure
account whose `pure` call has corresponding parameters.
-#### announce - 6
+### announce - 6
<details><summary><code>announce(real, call_hash)</code></summary>
-Taking 0.0199 % of a block.
+Taking 0.0197 % of a block.
```rust
real: AccountIdLookupOf<T>
@@ -1533,6 +1187,7 @@ call_hash: CallHashOf<T>
</details>
+
Publish the hash of a proxy-call that will be made in the future.
This must be called some number of blocks before the corresponding `proxy` is attempted
@@ -1549,11 +1204,11 @@ Parameters:
- `real`: The account that the proxy will make a call on behalf of.
- `call_hash`: The hash of the call to be made by the `real` account.
-#### remove_announcement - 7
+### remove_announcement - 7
<details><summary><code>remove_announcement(real, call_hash)</code></summary>
-Taking 0.0186 % of a block.
+Taking 0.0182 % of a block.
```rust
real: AccountIdLookupOf<T>
@@ -1562,6 +1217,7 @@ call_hash: CallHashOf<T>
</details>
+
Remove a given announcement.
May be called by a proxy account to remove a call they previously announced and return
@@ -1573,11 +1229,11 @@ Parameters:
- `real`: The account that the proxy will make a call on behalf of.
- `call_hash`: The hash of the call to be made by the `real` account.
-#### reject_announcement - 8
+### reject_announcement - 8
<details><summary><code>reject_announcement(delegate, call_hash)</code></summary>
-Taking 0.0186 % of a block.
+Taking 0.0182 % of a block.
```rust
delegate: AccountIdLookupOf<T>
@@ -1586,6 +1242,7 @@ call_hash: CallHashOf<T>
</details>
+
Remove the given announcement of a delegate.
May be called by a target (proxied) account to remove a call that one of their delegates
@@ -1597,11 +1254,11 @@ Parameters:
- `delegate`: The account that previously announced the call.
- `call_hash`: The hash of the call to be made.
-#### proxy_announced - 9
+### proxy_announced - 9
<details><summary><code>proxy_announced(delegate, real, force_proxy_type, call)</code></summary>
-Taking 0.02 % of a block.
+Taking 0.0198 % of a block.
```rust
delegate: AccountIdLookupOf<T>
@@ -1612,6 +1269,7 @@ call: Box<<T as Config>::RuntimeCall>
</details>
+
Dispatch the given `call` from an account that the sender is authorized for through
`add_proxy`.
@@ -1624,13 +1282,13 @@ Parameters:
- `force_proxy_type`: Specify the exact proxy type to be used and checked for this call.
- `call`: The call to be made by the `real` account.
-### Utility - 54
+## Utility - 54
-#### batch - 0
+### batch - 0
<details><summary><code>batch(calls)</code></summary>
-Taking 0.1149 % of a block.
+Taking 0.1076 % of a block.
```rust
calls: Vec<<T as Config>::RuntimeCall>
@@ -1638,6 +1296,7 @@ calls: Vec<<T as Config>::RuntimeCall>
</details>
+
Send a batch of dispatch calls.
May be called from any origin except `None`.
@@ -1648,7 +1307,7 @@ May be called from any origin except `None`.
If origin is root then the calls are dispatched without checking origin filter. (This
includes bypassing `frame_system::Config::BaseCallFilter`).
-**Complexity**
+###### Complexity
- O(C) where C is the number of calls to be batched.
This will return `Ok` in all circumstances. To determine the success of the batch, an
@@ -1657,11 +1316,11 @@ event is deposited. If a call failed and the batch was interrupted, then the
and the error of the failed call. If all were successful, then the `BatchCompleted`
event is deposited.
-#### as_derivative - 1
+### as_derivative - 1
<details><summary><code>as_derivative(index, call)</code></summary>
-Taking 0.0047 % of a block.
+Taking 0.0046 % of a block.
```rust
index: u16
@@ -1670,6 +1329,7 @@ call: Box<<T as Config>::RuntimeCall>
</details>
+
Send a call through an indexed pseudonym of the sender.
Filter from origin are passed along. The call will be dispatched with an origin which
@@ -1684,11 +1344,11 @@ NOTE: Prior to version *12, this was called `as_limited_sub`.
The dispatch origin for this call must be _Signed_.
-#### batch_all - 2
+### batch_all - 2
<details><summary><code>batch_all(calls)</code></summary>
-Taking 0.1241 % of a block.
+Taking 0.1148 % of a block.
```rust
calls: Vec<<T as Config>::RuntimeCall>
@@ -1696,6 +1356,7 @@ calls: Vec<<T as Config>::RuntimeCall>
</details>
+
Send a batch of dispatch calls and atomically execute them.
The whole transaction will rollback and fail if any of the calls failed.
@@ -1707,14 +1368,14 @@ May be called from any origin except `None`.
If origin is root then the calls are dispatched without checking origin filter. (This
includes bypassing `frame_system::Config::BaseCallFilter`).
-**Complexity**
+###### Complexity
- O(C) where C is the number of calls to be batched.
-#### force_batch - 4
+### force_batch - 4
<details><summary><code>force_batch(calls)</code></summary>
-Taking 0.1155 % of a block.
+Taking 0.1074 % of a block.
```rust
calls: Vec<<T as Config>::RuntimeCall>
@@ -1722,6 +1383,7 @@ calls: Vec<<T as Config>::RuntimeCall>
</details>
+
Send a batch of dispatch calls.
Unlike `batch`, it allows errors and won't interrupt.
@@ -1733,36 +1395,16 @@ May be called from any origin except `None`.
If origin is root then the calls are dispatch without checking origin filter. (This
includes bypassing `frame_system::Config::BaseCallFilter`).
-**Complexity**
+###### Complexity
- O(C) where C is the number of calls to be batched.
-#### with_weight - 5
-
-<details><summary><code>with_weight(call, weight)</code></summary>
-
-No weight available.
-
-```rust
-call: Box<<T as Config>::RuntimeCall>
-weight: Weight
-```
-</details>
-
+## Treasury - 55
-Dispatch a function call with a specified weight.
-
-This function does not check the weight of the call, and instead allows the
-Root origin to specify the weight of the call.
-
-The dispatch origin for this call must be _Root_.
-
-### Treasury - 55
-
-#### spend_local - 3
+### spend_local - 3
<details><summary><code>spend_local(amount, beneficiary)</code></summary>
-Taking 0.0045 % of a block.
+Taking 0.0044 % of a block.
```rust
amount: BalanceOf<T, I>
@@ -1771,25 +1413,26 @@ beneficiary: AccountIdLookupOf<T>
</details>
+
Propose and approve a spend of treasury funds.
-## Dispatch Origin
+###### Dispatch Origin
Must be [`Config::SpendOrigin`] with the `Success` value being at least `amount`.
-### Details
+###### Details
NOTE: For record-keeping purposes, the proposer is deemed to be equivalent to the
beneficiary.
-### Parameters
+###### Parameters
- `amount`: The amount to be transferred from the treasury to the `beneficiary`.
- `beneficiary`: The destination account for the transfer.
-## Events
+###### Events
Emits [`Event::SpendApproved`] if successful.
-#### remove_approval - 4
+### remove_approval - 4
<details><summary><code>remove_approval(proposal_id)</code></summary>
@@ -1801,33 +1444,34 @@ proposal_id: ProposalIndex
</details>
+
Force a previously approved proposal to be removed from the approval queue.
-## Dispatch Origin
+###### Dispatch Origin
Must be [`Config::RejectOrigin`].
-## Details
+###### Details
The original deposit will no longer be returned.
-### Parameters
+###### Parameters
- `proposal_id`: The index of a proposal
-#**Complexity**
+###### Complexity
- O(A) where `A` is the number of approvals
-### Errors
+###### Errors
- [`Error::ProposalNotApproved`]: The `proposal_id` supplied was not found in the
approval queue, i.e., the proposal has not been approved. This could also mean the
proposal does not exist altogether, thus there is no way it would have been approved
in the first place.
-#### spend - 5
+### spend - 5
<details><summary><code>spend(asset_kind, amount, beneficiary, valid_from)</code></summary>
-Taking 0.0045 % of a block.
+Taking 0.0044 % of a block.
```rust
asset_kind: Box<T::AssetKind>
@@ -1838,21 +1482,22 @@ valid_from: Option<BlockNumberFor<T>>
</details>
+
Propose and approve a spend of treasury funds.
-## Dispatch Origin
+###### Dispatch Origin
Must be [`Config::SpendOrigin`] with the `Success` value being at least
`amount` of `asset_kind` in the native asset. The amount of `asset_kind` is converted
for assertion using the [`Config::BalanceConverter`].
-## Details
+###### Details
Create an approved spend for transferring a specific `amount` of `asset_kind` to a
designated beneficiary. The spend must be claimed using the `payout` dispatchable within
the [`Config::PayoutPeriod`].
-### Parameters
+###### Parameters
- `asset_kind`: An indicator of the specific asset class to be spent.
- `amount`: The amount to be transferred from the treasury to the `beneficiary`.
- `beneficiary`: The beneficiary of the spend.
@@ -1861,11 +1506,11 @@ the [`Config::PayoutPeriod`].
[`Config::PayoutPeriod`]. If `None`, the spend can be claimed immediately after
approval.
-## Events
+###### Events
Emits [`Event::AssetSpendApproved`] if successful.
-#### payout - 6
+### payout - 6
<details><summary><code>payout(index)</code></summary>
@@ -1877,27 +1522,28 @@ index: SpendIndex
</details>
+
Claim a spend.
-## Dispatch Origin
+###### Dispatch Origin
Must be signed
-## Details
+###### Details
Spends must be claimed within some temporal bounds. A spend may be claimed within one
[`Config::PayoutPeriod`] from the `valid_from` block.
In case of a payout failure, the spend status must be updated with the `check_status`
dispatchable before retrying with the current function.
-### Parameters
+###### Parameters
- `index`: The spend index.
-## Events
+###### Events
Emits [`Event::Paid`] if successful.
-#### check_status - 7
+### check_status - 7
<details><summary><code>check_status(index)</code></summary>
@@ -1909,31 +1555,32 @@ index: SpendIndex
</details>
+
Check the status of the spend and remove it from the storage if processed.
-## Dispatch Origin
+###### Dispatch Origin
Must be signed.
-## Details
+###### Details
The status check is a prerequisite for retrying a failed payout.
If a spend has either succeeded or expired, it is removed from the storage by this
function. In such instances, transaction fees are refunded.
-### Parameters
+###### Parameters
- `index`: The spend index.
-## Events
+###### Events
Emits [`Event::PaymentFailed`] if the spend payout has failed.
Emits [`Event::SpendProcessed`] if the spend payout has succeed.
-#### void_spend - 8
+### void_spend - 8
<details><summary><code>void_spend(index)</code></summary>
-Taking 0.0057 % of a block.
+Taking 0.0056 % of a block.
```rust
index: SpendIndex
@@ -1941,476 +1588,22 @@ index: SpendIndex
</details>
+
Void previously approved spend.
-## Dispatch Origin
+###### Dispatch Origin
Must be [`Config::RejectOrigin`].
-## Details
+###### Details
A spend void is only possible if the payout has not been attempted yet.
-### Parameters
+###### Parameters
- `index`: The spend index.
-## Events
+###### Events
Emits [`Event::AssetSpendVoided`] if successful.
-
-## Root calls
-
-There are **18** root calls from **8** pallets.
-
-### System - 0
-
-#### set_heap_pages - 1
-
-<details><summary><code>set_heap_pages(pages)</code></summary>
-
-Taking 0.0165 % of a block.
-
-```rust
-pages: u64
-```
-</details>
-
-
-Set the number of pages in the WebAssembly environment's heap.
-
-#### set_code - 2
-
-<details><summary><code>set_code(code)</code></summary>
-
-Taking 3.9234 % of a block.
-
-```rust
-code: Vec<u8>
-```
-</details>
-
-
-Set the new runtime code.
-
-#### set_code_without_checks - 3
-
-<details><summary><code>set_code_without_checks(code)</code></summary>
-
-No weight available.
-
-```rust
-code: Vec<u8>
-```
-</details>
-
-
-Set the new runtime code without doing any checks of the given `code`.
-
-Note that runtime upgrades will not run if this is called with a not-increasing spec
-version!
-
-#### set_storage - 4
-
-<details><summary><code>set_storage(items)</code></summary>
-
-Taking 5.4867 % of a block.
-
-```rust
-items: Vec<KeyValue>
-```
-</details>
-
-
-Set some items of storage.
-
-#### kill_storage - 5
-
-<details><summary><code>kill_storage(keys)</code></summary>
-
-Taking 5.4797 % of a block.
-
-```rust
-keys: Vec<Key>
-```
-</details>
-
-
-Kill some items from storage.
-
-#### kill_prefix - 6
-
-<details><summary><code>kill_prefix(prefix, subkeys)</code></summary>
-
-Taking 6.4024 % of a block.
-
-```rust
-prefix: Key
-subkeys: u32
-```
-</details>
-
-
-Kill all storage items with a key that starts with the given prefix.
-
-**NOTE:** We rely on the Root origin to provide us the number of subkeys under
-the prefix we are removing to accurately calculate the weight of this function.
-
-#### authorize_upgrade - 9
-
-<details><summary><code>authorize_upgrade(code_hash)</code></summary>
-
-Taking 0.0105 % of a block.
-
-```rust
-code_hash: T::Hash
-```
-</details>
-
-
-Authorize an upgrade to a given `code_hash` for the runtime. The runtime can be supplied
-later.
-
-This call requires Root origin.
-
-#### authorize_upgrade_without_checks - 10
-
-<details><summary><code>authorize_upgrade_without_checks(code_hash)</code></summary>
-
-No weight available.
-
-```rust
-code_hash: T::Hash
-```
-</details>
-
-
-Authorize an upgrade to a given `code_hash` for the runtime. The runtime can be supplied
-later.
-
-WARNING: This authorizes an upgrade that will take place without any safety checks, for
-example that the spec name remains the same and that the version number increases. Not
-recommended for normal use. Use `authorize_upgrade` instead.
-
-This call requires Root origin.
-
-#### apply_authorized_upgrade - 11
-
-<details><summary><code>apply_authorized_upgrade(code)</code></summary>
-
-Taking 4.1629 % of a block.
-
-```rust
-code: Vec<u8>
-```
-</details>
-
-
-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.
-
-Depending on the runtime's `OnSetCode` configuration, this function may directly apply
-the new `code` in the same block or attempt to schedule the upgrade.
-
-All origins are allowed.
-
-### Babe - 3
-
-#### plan_config_change - 2
-
-<details><summary><code>plan_config_change(config)</code></summary>
-
-No weight available.
-
-```rust
-config: NextConfigDescriptor
-```
-</details>
-
-
-Plan an epoch config change. The epoch config change is recorded and will be enacted on
-the next call to `enact_epoch_change`. The config will be activated one epoch after.
-Multiple calls to this method will replace any existing planned config change that had
-not been enacted yet.
-
-### Balances - 6
-
-#### force_transfer - 2
-
-<details><summary><code>force_transfer(source, dest, value)</code></summary>
-
-Taking 0.0262 % of a block.
-
-```rust
-source: AccountIdLookupOf<T>
-dest: AccountIdLookupOf<T>
-value: T::Balance
-```
-</details>
-
-
-Exactly as `transfer_allow_death`, except the origin must be root and the source account
-may be specified.
-
-#### force_unreserve - 5
-
-<details><summary><code>force_unreserve(who, amount)</code></summary>
-
-Taking 0.0117 % of a block.
-
-```rust
-who: AccountIdLookupOf<T>
-amount: T::Balance
-```
-</details>
-
-
-Unreserve some balance from a user by force.
-
-Can only be called by ROOT.
-
-### AuthorityMembers - 11
-
-#### remove_member - 3
-
-<details><summary><code>remove_member(member_id)</code></summary>
-
-Taking 0.0665 % of a block.
-
-```rust
-member_id: T::MemberId
-```
-</details>
-
-
-Remove a member from the set of validators.
-
-### Grandpa - 16
-
-#### note_stalled - 2
-
-<details><summary><code>note_stalled(delay, best_finalized_block_number)</code></summary>
-
-No weight available.
-
-```rust
-delay: BlockNumberFor<T>
-best_finalized_block_number: BlockNumberFor<T>
-```
-</details>
-
-
-Note that the current authority set of the GRANDPA finality gadget has stalled.
-
-This will trigger a forced authority set change at the beginning of the next session, to
-be enacted `delay` blocks after that. The `delay` should be high enough to safely assume
-that the block signalling the forced change will not be re-orged e.g. 1000 blocks.
-The block production rate (which may be slowed down because of finality lagging) should
-be taken into account when choosing the `delay`. The GRANDPA voters based on the new
-authority will start voting on top of `best_finalized_block_number` for new finalized
-blocks. `best_finalized_block_number` should be the highest of the latest finalized
-block of all validators of the new authority set.
-
-Only callable by root.
-
-### TechnicalCommittee - 23
-
-#### set_members - 0
-
-<details><summary><code>set_members(new_members, prime, old_count)</code></summary>
-
-Taking 0.1558 % of a block.
-
-```rust
-new_members: Vec<T::AccountId>
-prime: Option<T::AccountId>
-old_count: MemberCount
-```
-</details>
-
-
-Set the collective's membership.
-
-- `new_members`: The new member list. Be nice to the chain and provide it sorted.
-- `prime`: The prime member whose vote sets the default.
-- `old_count`: The upper bound for the previous number of members in storage. Used for
- weight estimation.
-
-The dispatch of this call must be `SetMembersOrigin`.
-
-NOTE: Does not enforce the expected `MaxMembers` limit on the amount of members, but
- the weight estimations rely on it to estimate dispatchable weight.
-
-WARNING:
-
-The `pallet-collective` can also be managed by logic outside of the pallet through the
-implementation of the trait [`ChangeMembers`].
-Any call to `set_members` must be careful that the member set doesn't get out of sync
-with other logic managing the member set.
-
-**Complexity**:
-- `O(MP + N)` where:
- - `M` old-members-count (code- and governance-bounded)
- - `N` new-members-count (code- and governance-bounded)
- - `P` proposals-count (code-bounded)
-
-#### disapprove_proposal - 5
-
-<details><summary><code>disapprove_proposal(proposal_hash)</code></summary>
-
-Taking 0.0226 % of a block.
-
-```rust
-proposal_hash: T::Hash
-```
-</details>
-
-
-Disapprove a proposal, close, and remove it from the system, regardless of its current
-state.
-
-Must be called by the Root origin.
-
-Parameters:
-* `proposal_hash`: The hash of the proposal that should be disapproved.
-
-**Complexity**
-O(P) where P is the number of max proposals
-
-### Identity - 41
-
-#### prune_item_identities_names - 6
-
-<details><summary><code>prune_item_identities_names(names)</code></summary>
-
-Taking 5.524 % of a block.
-
-```rust
-names: Vec<IdtyName>
-```
-</details>
-
-
-Remove identity names from storage.
-
-This function allows a privileged root origin to remove multiple identity names from storage
-in bulk.
-
-- `origin` - The origin of the call. It must be root.
-- `names` - A vector containing the identity names to be removed from storage.
-
-### Utility - 54
-
-#### dispatch_as - 3
-
-<details><summary><code>dispatch_as(as_origin, call)</code></summary>
-
-Taking 0.0048 % of a block.
-
-```rust
-as_origin: Box<T::PalletsOrigin>
-call: Box<<T as Config>::RuntimeCall>
-```
-</details>
-
-
-Dispatches a function call with a provided origin.
-
-The dispatch origin for this call must be _Root_.
-
-**Complexity**
-- O(1).
-
-
-
-
-
-
-## Disabled calls
-
-There are **4** disabled calls from **2** pallets.
-
-### System - 0
-
-#### remark - 0
-
-<details><summary><code>remark(remark)</code></summary>
-
-Taking 0.0546 % of a block.
-
-```rust
-remark: Vec<u8>
-```
-</details>
-
-
-Make some on-chain remark.
-
-Can be executed by every `origin`.
-
-#### remark_with_event - 7
-
-<details><summary><code>remark_with_event(remark)</code></summary>
-
-Taking 0.2093 % of a block.
-
-```rust
-remark: Vec<u8>
-```
-</details>
-
-
-Make some on-chain remark and emit event.
-
-### Session - 15
-
-#### set_keys - 0
-
-<details><summary><code>set_keys(keys, proof)</code></summary>
-
-Taking 0.0378 % of a block.
-
-```rust
-keys: T::Keys
-proof: Vec<u8>
-```
-</details>
-
-
-Sets the session key(s) of the function caller to `keys`.
-Allows an account to set its session key prior to becoming a validator.
-This doesn't take effect until the next session.
-
-The dispatch origin of this function must be signed.
-
-**Complexity**
-- `O(1)`. Actual cost depends on the number of length of `T::Keys::key_ids()` which is
- fixed.
-
-#### purge_keys - 1
-
-<details><summary><code>purge_keys()</code></summary>
-
-Taking 0.0336 % of a block.
-
-```rust
-```
-</details>
-
-
-Removes any session key(s) of the function caller.
-
-This doesn't take effect until the next session.
-
-The dispatch origin of this function must be Signed and the account must be either be
-convertible to a validator ID using the chain's typical addressing system (this usually
-means being a controller account) or directly convertible into a validator ID (which
-usually means being a stash account).
-
-**Complexity**
-- `O(1)` in number of key types. Actual cost depends on the number of length of
- `T::Keys::key_ids()` which is fixed.
-
diff --git a/docs/api/runtime-errors.md b/docs/api/runtime-errors.md
index ac6528e906befc2b6d5b7f9068867f929903bfd3..ead935a5d35710a25df4d3e3b5acf6a9118d329e 100644
--- a/docs/api/runtime-errors.md
+++ b/docs/api/runtime-errors.md
@@ -1,6 +1,6 @@
# Runtime errors
-There are **190** errors from **35** pallets.
+There are **191** errors from **35** pallets.
<ul>
<li>System - 0
@@ -986,6 +986,13 @@ Insufficient balance to create an identity.
Owner key currently used as validator.
</details>
</li>
+<li>
+<details>
+<summary>
+<code>InvalidLegacyRevocationFormat</code> - 19</summary>
+Legacy revocation document format is invalid
+</details>
+</li>
</ul>
</li>
<li>Membership - 42
diff --git a/docs/api/runtime-errors.po b/docs/api/runtime-errors.po
index 6be74ca09b7c1987f058632f6fcac7f59162b97c..f16ca07c1442240f65e612a00423617d59309782 100644
--- a/docs/api/runtime-errors.po
+++ b/docs/api/runtime-errors.po
@@ -254,6 +254,8 @@ msgid "Identity.InsufficientBalance"
msgstr "Insufficient balance to create an identity."
msgid "Identity.OwnerKeyUsedAsValidator"
msgstr "Owner key currently used as validator."
+msgid "Identity.InvalidLegacyRevocationFormat"
+msgstr "Legacy revocation document format is invalid"
msgid "Membership.MembershipNotFound"
msgstr "Membership not found, can not renew."
msgid "Membership.AlreadyMember"
diff --git a/docs/test/replay-block.md b/docs/dev/replay-block.md
similarity index 95%
rename from docs/test/replay-block.md
rename to docs/dev/replay-block.md
index 1db20cd3cd0d22b3c74647aa7dab5e85fae5f437..429e0becb39440d8ee9721bae49552e086e57219 100644
--- a/docs/test/replay-block.md
+++ b/docs/dev/replay-block.md
@@ -1,5 +1,7 @@
# How to replay a block
+WARN: try-runtime is not properly implemented
+
You can use `try-runtime` subcommand to replay a block against a real state from a live network.
1. Checkout the git tag of the runtime version at the block you want to replay
diff --git a/docs/user/mirror.md b/docs/user/mirror.md
deleted file mode 100644
index 4777bfd8bdde4e31b5ba99950bbd9fa4cd301efd..0000000000000000000000000000000000000000
--- a/docs/user/mirror.md
+++ /dev/null
@@ -1,21 +0,0 @@
-# How to deploy a permanent rpc node on ÄžDev network
-
-## Publish a node
-
-### Duniter part
-
-See [docker documentation](../../docker/README.md) to install, configure, and start a node.
-
-### Reverse proxy part
-
-See [nginx reverse proxy](./nginx_reverse_proxy.md).
-
-To go further, read [How to become a (black)smith](./smith.md)
-
-## Upgrade your node with minimal interruption
-
-1. Modify docker image tag on your compose file
-2. Run `docker compose pull`, this will pull the new image.
-3. Run `docker compose up -d --remove-orphans`, this will recreate the container
-4. Verify that your node restarted well `docker compose logs duniter-rpc`
-5. Remove the old image `docker rmi duniter/duniter-v2s:OLD_TAG`
diff --git a/docs/user/nginx_reverse_proxy.md b/docs/user/nginx_reverse_proxy.md
deleted file mode 100644
index cd17455eb47b8e0588b29a8d774435aef1acd284..0000000000000000000000000000000000000000
--- a/docs/user/nginx_reverse_proxy.md
+++ /dev/null
@@ -1,54 +0,0 @@
-# Nginx reverse proxy example
-
-In `/etc/nginx/sites-enabled/gdev.YOUR_DOMAIN` put (you can probably do simpler):
-
-```nginx
-# see http://nginx.org/en/docs/http/websocket.html
-map $http_upgrade $connection_upgrade {
- default upgrade;
- '' close;
-}
-
-server {
- server_name gdev.YOUR_DOMAIN.fr;
-
- listen 443 ssl http2;
- listen [::]:443 ssl http2;
- ssl_certificate /etc/nginx/ssl/YOUR_DOMAIN.cert;
- ssl_certificate_key /etc/nginx/ssl/YOUR_DOMAIN.key;
-
- root /nowhere;
-
- add_header X-Frame-Options SAMEORIGIN;
- add_header X-XSS-Protection "1; mode=block";
- proxy_redirect off;
- proxy_buffering off;
- proxy_set_header Host $host;
- proxy_set_header X-Real-IP $remote_addr;
- proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
- proxy_set_header X-Forwarded-Proto $scheme;
- proxy_set_header X-Forwarded-Port $server_port;
- proxy_read_timeout 90;
-
-
- location / {
- proxy_pass http://localhost:9944;
-
- proxy_set_header Upgrade $http_upgrade;
- proxy_set_header Connection $connection_upgrade;
- proxy_http_version 1.1;
-
- proxy_read_timeout 1200s;
- proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
- proxy_set_header Host $host;
- }
-}
-```
-
-and replace `YOUR_DOMAIN` by your domain each time.
-
-- [generate your ssl certificates](https://github.com/acmesh-official/acme.sh) with let's encrypt
- if you don't already have a wildcard certificate.
-- `service nginx reload`
-
-Your node is now online as a rpc node. It's fully capable for wallet use.
diff --git a/docs/user/smith.md b/docs/user/smith.md
deleted file mode 100644
index 02411c2f0d59fa43409160019e8d9dc7a6f75911..0000000000000000000000000000000000000000
--- a/docs/user/smith.md
+++ /dev/null
@@ -1,51 +0,0 @@
-# How to become a (black)smith
-
-## Publish a node
-
-### Duniter part
-
-See [docker documentation](../../docker/README.md) to install, configure, and start a node. For a smith node, you want to set `DUNITER_VALIDATOR` to `true`.
-
-### Reverse proxy part
-
-See [nginx reverse proxy](./nginx_reverse_proxy.md).
-
-## Join the Smith WoT
-
-Only members of the smith WoT can author blocks. This WoT is a subset of the main WoT, hence before joining it you need to join the main WoT.
-
-1. Create an SSH bridge from your computer to your server: `ssh -L 9945:localhost:9945 SSH_USER@YOUR_SERVER`
-2. Install PolkadotJS browser extension. It will manage your private keys and known pubkeys safely.
-3. Go to [a PolkadotJS web UI](https://polkadot.js.org/apps/?rpc=ws://127.0.0.1/ws:9945). (it's not the same thing as the browser extension)
- - If using another port or address, change it accordingly in the left panel.
-4. In the UI: developer > RPC call > author > rotateKeys() and copy the result in clipboard
-5. In the UI: developer > extrinsics > YOUR_SMITH_ACCOUNT > smithMembership > requestMembership(metadata)
- - add your p2p endpoint (optional)
- - add your session keys
- - send the query
-6. Wait 48h to ensure your node keeps sync (**both** best **and** finalized block numbers must increase every 6s)
-7. Await at least 3 smith certifications. Members of the smith WoT can certify you with this extrinsic:
- - In the UI: developer > extrinsics > CERTIFIER_SMITH_ACCOUNT > smithCert > addCert(receiver)
- - This is not automatic, you can ask for certs on the forum or the Matrix chatroom.
-8. In the UI: developer > extrinsics > YOUR_SMITH_ACCOUNT > smithMembership > claimMembership(maybe_idty_id)
- - maybe_idty_id can be left empty since your identity id will be infered from your account address.
-
-All extrinsics can be sent while connected to any Duniter node, but the RPC calls need a direct connection to your server. As some RPC calls should not be publicly callable for security reasons, the only ways to call them is from the server localhost or using an SSH bridge or other kind of secure tunnel.
-
-rotateKeys can be called anytime you want. Then you have to call setSessionKeys with the new keys.
-
-## Validate blocks (blacksmith work)
-
-Once all the previous steps are completed, you can start to actually author blocks.
-
-In the UI: developer > extrinsics > YOUR_SMITH_ACCOUNT > authorityMembers > goOnline()
-
-If you're not able to monitor, reboot, act on your node, goOffline() to avoid penalty to the blockchain and to you. It will take effect after 2h, so please do it in advance if you plan to disconnect your server soon. goOnline can always be called after this, but after 100 days without authoring blocks you will loose your smith membership.
-
-## Upgrade your node with minimal interruption
-
-1. Modify docker image tag on your compose file
-2. Run `docker compose pull`, this will pull the new image.
-3. Run `docker compose up -d --remove-orphans`, this will recreate the container
-4. Verify that your node restarted well `docker compose logs duniter-validator`
-5. Remove the old image `docker rmi duniter/duniter-v2s:OLD_TAG`
diff --git a/xtask/res/templates/runtime-calls-category.md b/xtask/res/templates/runtime-calls-category.md
index 71c6a7bcec12c936d5ccf4dd912227954ab18b3b..823e9a6dd32ab180216e835c9c66642065c0cb4a 100644
--- a/xtask/res/templates/runtime-calls-category.md
+++ b/xtask/res/templates/runtime-calls-category.md
@@ -1,10 +1,12 @@
There are **{{ calls_counter }}** {{ category_name }} calls from **{{ pallets | length }}** pallets.
{% for pallet in pallets -%}
-### {{ pallet.name }} - {{ pallet.index }}
+
+## {{ pallet.name }} - {{ pallet.index }}
{% for call in pallet.calls -%}
-#### {{ call.name }} - {{ call.index }}
+
+### {{ call.name }} - {{ call.index }}
<details><summary><code>{{ call.name }}(
{%- for param in call.params -%}
@@ -23,8 +25,15 @@ Taking {{ call.weight }} % of a block.
```
</details>
-{# replace markdown sytax in documentation breaking the final result #}
-{{ call.documentation | replace(from="# WARNING:", to="WARNING:") | replace(from="## Complexity", to="**Complexity**") }}
+{# lower heading title to integrate into document hierarchy #}
+{# with a maximum to 6 #}
+{{ call.documentation
+| replace(from="# ", to="## ")
+| replace(from="# ", to="## ")
+| replace(from="# ", to="## ")
+| replace(from="# ", to="## ")
+| replace(from="####### ", to="###### ")
+}}
{% endfor -%}
{% endfor -%}
diff --git a/xtask/res/templates/runtime-calls.md b/xtask/res/templates/runtime-calls.md
index 4a6d063ade325810511310b7ec92ec455c703e56..17ecc718f6178507ab7d981736f4e25d0d4a7c23 100644
--- a/xtask/res/templates/runtime-calls.md
+++ b/xtask/res/templates/runtime-calls.md
@@ -3,32 +3,16 @@
Calls are categorized according to the dispatch origin they require:
1. **User calls**: the dispatch origin for this kind of call must be signed by
-the transactor. This is the only call category that can be submitted with an extrinsic.
+ the transactor. This is the only call category that can be submitted with an extrinsic.
1. **Root calls**: This kind of call requires a special origin that can only be invoked
-through on-chain governance mechanisms.
+ through on-chain governance mechanisms.
1. **Inherent calls**: This kind of call is invoked by the author of the block itself
-(usually automatically by the node).
+ (usually automatically by the node).
1. **Disabled calls**: These calls can not be called directly, they are reserved for internal use by other runtime calls.
+We only document user calls below.
{% set pallets = user_calls_pallets -%}
{% set calls_counter = user_calls_counter -%}
{% set category_name = "user" -%}
-## User calls
-
-{% include "runtime-calls-category.md" %}
-
-{% set pallets = root_calls_pallets -%}
-{% set calls_counter = root_calls_counter -%}
-{% set category_name = "root" -%}
-## Root calls
-
{% include "runtime-calls-category.md" %}
-
-{% set pallets = disabled_calls_pallets %}
-{% set calls_counter = disabled_calls_counter %}
-{% set category_name = "disabled" %}
-## Disabled calls
-
-{% include "runtime-calls-category.md" -%}
-
diff --git a/xtask/src/gen_doc.rs b/xtask/src/gen_doc.rs
index 91798167d7e54bad9fc8ff6c87548075977f063b..9fd9c9092c435587b6681dd797c6d9a23acdb40e 100644
--- a/xtask/src/gen_doc.rs
+++ b/xtask/src/gen_doc.rs
@@ -194,56 +194,68 @@ impl From<&scale_info::Variant<PortableForm>> for ErroR {
}
}
+// classify calls into categories depending on their origin
enum CallCategory {
+ // calls filtered by runtime
Disabled,
+ // inherents
Inherent,
- OtherOrigin,
+ // ensure_root
Root,
+ // sudo
Sudo,
+ // user calls
User,
+ // other (like a certain proportion of technical comittee)
+ OtherOrigin,
}
impl CallCategory {
fn is(pallet_name: &str, call_name: &str) -> Self {
match (pallet_name, call_name) {
- ("System", "remark" | "remark_with_event") => Self::Disabled,
+ // substrate "system"
("System", _) => Self::Root,
- ("Babe", "report_equivocation_unsigned") => Self::Inherent,
+ ("Scheduler", _) => Self::Root,
+ ("Babe", "report_equivocation" | "report_equivocation_unsigned") => Self::Inherent,
("Babe", "plan_config_change") => Self::Root,
- ("Timestamp", _) => Self::Inherent,
- ("Balances", "set_balance" | "force_transfer" | "force_unreserve") => Self::Root,
- ("AuthorityMembers", "prune_account_id_of" | "remove_member") => Self::Root,
("Authorship", _) => Self::Inherent,
("Session", _) => Self::Disabled,
- ("Grandpa", "report_equivocation_unsigned") => Self::Inherent,
+ ("Grandpa", "report_equivocation" | "report_equivocation_unsigned") => Self::Inherent,
("Grandpa", "note_stalled") => Self::Root,
- ("UpgradeOrigin", "dispatch_as_root") => Self::OtherOrigin,
+ ("Timestamp", _) => Self::Inherent,
("ImOnline", _) => Self::Inherent,
- ("Sudo", _) => Self::Sudo,
+ // substrate "common"
(
- "Identity",
- "remove_identity" | "prune_item_identities_names" | "prune_item_identity_index_of",
+ "Balances",
+ "force_set_balance"
+ | "force_transfer"
+ | "force_unreserve"
+ | "force_adjust_total_issuance",
) => Self::Root,
- ("Cert", "del_cert" | "remove_all_certs_received_by") => Self::Root,
- ("SmithCert", "del_cert" | "remove_all_certs_received_by") => Self::Root,
- ("TechnicalCommittee", "set_members" | "disapprove_proposal") => Self::Root,
- ("Utility", "dispatch_as") => Self::Root,
+ ("Sudo", _) => Self::Sudo,
("Treasury", "approve_proposal" | "reject_proposal") => Self::OtherOrigin,
+ ("Utility", "dispatch_as" | "with_weight") => Self::Root,
+ // duniter
+ ("Distance", "force_update_evaluation" | "force_valid_distance_status") => Self::Root,
+ ("Distance", "update_evaluation") => Self::Inherent,
+ ("AuthorityMembers", "remove_member_from_blacklist" | "remove_member") => Self::Root,
+ ("UpgradeOrigin", "dispatch_as_root" | "dispatch_as_root_unchecked_weight") => {
+ Self::OtherOrigin
+ }
+ ("Identity", "remove_identity" | "prune_item_identities_names" | "fix_sufficients") => {
+ Self::Root
+ }
+ ("Certification", "del_cert" | "remove_all_certs_received_by") => Self::Root,
+ ("TechnicalCommittee", "set_members" | "disapprove_proposal") => Self::Root,
+ // if not classified, consider it at a user call
_ => Self::User,
}
}
- fn is_root(pallet_name: &str, call_name: &str) -> bool {
- matches!(Self::is(pallet_name, call_name), Self::Root)
- }
-
+ // only user calls
fn is_user(pallet_name: &str, call_name: &str) -> bool {
matches!(Self::is(pallet_name, call_name), Self::User)
}
-
- fn is_disabled(pallet_name: &str, call_name: &str) -> bool {
- matches!(Self::is(pallet_name, call_name), Self::Disabled)
- }
}
/// generate runtime calls documentation
@@ -477,6 +489,7 @@ fn get_weights(max_weight: u128) -> Result<HashMap<String, HashMap<String, Weigh
/// use template to render markdown file with runtime calls documentation
fn print_runtime(pallets: RuntimePallets) -> (String, String, String, String) {
// init variables
+ // -- user calls
let mut user_calls_counter = 0;
let user_calls_pallets: RuntimePallets = pallets
.iter()
@@ -494,46 +507,14 @@ fn print_runtime(pallets: RuntimePallets) -> (String, String, String, String) {
}
})
.collect();
- let mut root_calls_counter = 0;
- let root_calls_pallets: RuntimePallets = pallets
- .iter()
- .cloned()
- .filter_map(|mut pallet| {
- let pallet_name = pallet.name.clone();
- pallet
- .calls
- .retain(|call| CallCategory::is_root(&pallet_name, &call.name));
- if pallet.calls.is_empty() {
- None
- } else {
- root_calls_counter += pallet.calls.len();
- Some(pallet)
- }
- })
- .collect();
- let mut disabled_calls_counter = 0;
- let disabled_calls_pallets: RuntimePallets = pallets
- .iter()
- .cloned()
- .filter_map(|mut pallet| {
- let pallet_name = pallet.name.clone();
- pallet
- .calls
- .retain(|call| CallCategory::is_disabled(&pallet_name, &call.name));
- if pallet.calls.is_empty() {
- None
- } else {
- disabled_calls_counter += pallet.calls.len();
- Some(pallet)
- }
- })
- .collect();
+ // event counter
let mut event_counter = 0;
pallets
.iter()
.for_each(|pallet| event_counter += pallet.events.len());
+ // error counter
let mut error_counter = 0;
pallets
.iter()
@@ -552,10 +533,6 @@ fn print_runtime(pallets: RuntimePallets) -> (String, String, String, String) {
let mut context = tera::Context::new();
context.insert("user_calls_counter", &user_calls_counter);
context.insert("user_calls_pallets", &user_calls_pallets);
- context.insert("root_calls_counter", &root_calls_counter);
- context.insert("root_calls_pallets", &root_calls_pallets);
- context.insert("disabled_calls_counter", &disabled_calls_counter);
- context.insert("disabled_calls_pallets", &disabled_calls_pallets);
let call_doc = tera
.render("runtime-calls.md", &context)