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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion v3/docs/02-concepts/f-transaction-weight/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ when to use them.

### Learn more

- [Example](https://github.com/paritytech/substrate/blob/master/frame/example/src/lib.rs)
- [Example](https://github.com/paritytech/substrate/tree/master/frame/examples/basic)
pallet.
- [Transaction Payment pallet](https://github.com/paritytech/substrate/blob/master/frame/transaction-payment/src/lib.rs)
- [Weights](https://github.com/paritytech/substrate/blob/master/frame/support/src/weights.rs)
2 changes: 1 addition & 1 deletion v3/docs/02-concepts/h-off-chain-features/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ exactly the same for every node with indexing enabled.
To look at concrete examples of off-chain workers and how to use them in runtime development,
refer to the following sections in Substrate Recipes:

- [Substrate's inclded `example-offchain-worker`](https://github.com/paritytech/substrate/tree/master/frame/example-offchain-worker)
- [Substrate's inclded `example-offchain-worker`](https://github.com/paritytech/substrate/tree/master/frame/examples/offchain-worker)
- [Recipe to Submit signed and unsigned transactions from off-chain workers back on-chain](https://github.com/substrate-developer-hub/recipes/blob/master/text/off-chain-workers/transactions.html)
- [Recipe to fetch external data using HTTP requests and parse JSON responses](https://github.com/substrate-developer-hub/recipes/blob/master/text/off-chain-workers/http-json.html)
- [Recipe to store result in off-chain worker local storage](https://github.com/substrate-developer-hub/recipes/blob/master/text/off-chain-workers/storage.html)
Expand Down
78 changes: 39 additions & 39 deletions v3/docs/03-runtime/a-FRAME/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ features and functionality for a runtime.
/>

FRAME not only provides a library of commonly used Substrate pallets but also a framework to build custom domain-specific
pallets, giving runtime engineers the flexibility to define their runtime's behaviour according to their
pallets, giving runtime engineers the flexibility to define their runtime's behavior according to their
target use case. The result is each pallet has its own discrete logic which can modify the features and
functionality of your blockchain's state transition functions.

Expand Down Expand Up @@ -182,7 +182,7 @@ Let's explore them.
The Assets pallet is a simple, secure module for dealing with fungible assets.

- [Docs](/rustdocs/latest/pallet_assets/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/assets/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/assets/src/lib.rs)

### Atomic Swap

Expand All @@ -191,14 +191,14 @@ target to approve (claim) the swap. If the swap is not claimed within a specifie
the sender may cancel it.

- [Docs](/rustdocs/latest/pallet_atomic_swap/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/atomic-swap/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/atomic-swap/src/lib.rs)

### Aura

The Aura pallet extends Aura consensus by managing offline reporting.

- [Docs](/rustdocs/latest/pallet_aura/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/aura/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/aura/src/lib.rs)

### Authority Discovery

Expand All @@ -207,165 +207,165 @@ authorities, learn its own authority ID, as well as to sign and verify messages
authorities.

- [Docs](/rustdocs/latest/pallet_authority_discovery/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/authority-discovery/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/authority-discovery/src/lib.rs)

### Authorship

The Authorship pallet tracks the current author of the block and recent uncles.

- [Docs](/rustdocs/latest/pallet_authorship/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/authorship/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/authorship/src/lib.rs)

### BABE

The BABE pallet extends BABE consensus by collecting on-chain randomness from VRF outputs and
managing epoch transitions.

- [Docs](/rustdocs/latest/pallet_babe/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/babe/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/babe/src/lib.rs)

### Balances

The Balances pallet provides functionality for handling accounts and balances.

- [Docs](/rustdocs/latest/pallet_balances/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/balances/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/balances/src/lib.rs)

### Benchmark

A pallet that contains common runtime patterns in an isolated manner. This pallet is not meant to be
used in a production blockchain, just for benchmarking and testing purposes.

- [Docs](/rustdocs/latest/frame_benchmarking/trait.Benchmark.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/benchmarking/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/benchmarking/src/lib.rs)

### Collective

The Collective pallet allows a set of account IDs to make their collective feelings known through
dispatched calls from specialized origins.

- [Docs](/rustdocs/latest/pallet_collective/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/collective/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/collective/src/lib.rs)

### Contracts

The Contracts pallet provides functionality for the runtime to deploy and execute WebAssembly
smart-contracts.

- [Docs](/rustdocs/latest/pallet_contracts/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/contracts/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/contracts/src/lib.rs)

### Democracy

The Democracy pallet provides a democratic system that handles administration of general stakeholder
voting.

- [Docs](/rustdocs/latest/pallet_democracy/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/democracy/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/democracy/src/lib.rs)

### Elections Phragmén

The Phragmén Elections pallet is an election module based on
[sequential Phragmén](https://wiki.polkadot.network/docs/en/learn-phragmen).

- [Docs](/rustdocs/latest/pallet_elections_phragmen/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/elections-phragmen/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/elections-phragmen/src/lib.rs)

### Elections

> WARNING: NOT ACTIVELY MAINTAINED
> The Elections pallet is an election module for stake-weighted membership selection of a collective.

- [Docs](/rustdocs/latest/pallet_elections/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/elections/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/elections/src/lib.rs)

### Example Offchain Worker

The Offchain Worker Example: A simple pallet demonstrating concepts, APIs and structures common to
most offchain workers.

- [Docs](/rustdocs/latest/pallet_example_offchain_worker/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/example-offchain-worker/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/examples/offchain-worker/src/lib.rs)

### Example

The Example pallet is a simple example of a pallet demonstrating concepts, APIs, and structures
common to most pallets.

- [Docs](/rustdocs/latest/pallet_example/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/example/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/examples/basic)

### GRANDPA

The GRANDPA pallet extends GRANDPA consensus by managing the GRANDPA authority set ready for the
native code.

- [Docs](/rustdocs/latest/pallet_grandpa/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/grandpa/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/grandpa/src/lib.rs)

### Identity

A federated naming system, allowing for multiple registrars to be added from a specified origin.
Registrars can set a fee to provide identity-verification service. Anyone can put forth a proposed
identity for a fixed deposit and ask for review by any number of registrars (paying each of their
fees). Registrar judgements are given as an enum, allowing for sophisticated, multi-tier opinions.
fees). Registrar judgments are given as an enum, allowing for sophisticated, multi-tier opinions.

- [Docs](/rustdocs/latest/pallet_identity/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/identity/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/identity/src/lib.rs)

### I'm Online

The I'm Online pallet allows validators to gossip a heartbeat transaction with each new session to
signal that the node is online.

- [Docs](/rustdocs/latest/pallet_im_online/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/im-online/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/im-online/src/lib.rs)

### Indices

The Indices pallet allocates indices for newly created accounts. An index is a short form of an
address.

- [Docs](/rustdocs/latest/pallet_indices/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/indices/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/indices/src/lib.rs)

### Membership

The Membership pallet allows control of membership of a set of `AccountId`s, useful for managing
membership of a collective.

- [Docs](/rustdocs/latest/pallet_membership/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/membership/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/membership/src/lib.rs)

### Multisig

A module for doing multi-signature dispatches.

- [Docs](/rustdocs/latest/pallet_multisig/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/multisig/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/multisig/src/lib.rs)

### Nicks

Nicks is a trivial module for keeping track of account names on-chain. It makes no effort to create
a name hierarchy, be a DNS replacement, or provide reverse lookups.

- [Docs](/rustdocs/latest/pallet_nicks/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/nicks/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/nicks/src/lib.rs)

### Offences

The Offences pallet tracks reported offences.

- [Docs](/rustdocs/latest/pallet_offences/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/offences/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/offences/src/lib.rs)

### Proxy

A module allowing accounts to give permission to other accounts to dispatch types of calls from
their signed origin.

- [Docs](/rustdocs/latest/pallet_proxy/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/proxy/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/proxy/src/lib.rs)

### Randomness Collective Flip

Expand All @@ -374,7 +374,7 @@ generates low-influence random values based on the block hashes from the previou
pallet is not intended for use in production.

- [Docs](/rustdocs/latest/pallet_randomness_collective_flip/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/randomness-collective-flip/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/randomness-collective-flip/src/lib.rs)

### Recovery

Expand All @@ -385,83 +385,83 @@ by trusted "friends" whom the original account owner chooses. A threshold (M) ou
needed to give another account access to the recoverable account.

- [Docs](/rustdocs/latest/pallet_recovery/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/recovery/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/recovery/src/lib.rs)

### Scheduler

This module exposes capabilities for scheduling dispatches to occur at a specified block number or
at a specified period. These scheduled dispatches may be named or anonymous and may be canceled.

- [Docs](/rustdocs/latest/pallet_scheduler/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/scheduler/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/scheduler/src/lib.rs)

### Scored Pool

The Scored Pool pallet maintains a scored membership pool where the highest scoring entities are
made members.

- [Docs](/rustdocs/latest/pallet_scored_pool/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/scored-pool/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/scored-pool/src/lib.rs)

### Session

The Session pallet allows validators to manage their session keys, provides a function for changing
the session length, and handles session rotation.

- [Docs](/rustdocs/latest/pallet_session/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/session/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/session/src/lib.rs)

### Society

The Society module is an economic game which incentivizes users to participate and maintain a
membership society.

- [Docs](/rustdocs/latest/pallet_society/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/society/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/society/src/lib.rs)

### Staking

The Staking pallet is used to manage funds at stake by network maintainers.

- [Docs](/rustdocs/latest/pallet_staking/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/staking/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/staking/src/lib.rs)

### Sudo

The Sudo pallet allows for a single account (called the "sudo key") to execute dispatchable
functions that require a `Root` origin or designate a new account to replace them as the sudo key.

- [Docs](/rustdocs/latest/pallet_sudo/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/sudo/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/sudo/src/lib.rs)

### Timestamp

The Timestamp pallet provides functionality to get and set the on-chain time.

- [Docs](/rustdocs/latest/pallet_timestamp/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/timestamp/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/timestamp/src/lib.rs)

### Transaction Payment

The Transaction Payment pallet provides the basic logic to compute pre-dispatch transaction fees.

- [Docs](/rustdocs/latest/pallet_transaction_payment/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/transaction-payment/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/transaction-payment/src/lib.rs)

### Treasury

The Treasury pallet provides a "pot" of funds that can be managed by stakeholders in the system and
a structure for making spending proposals from this pot.

- [Docs](/rustdocs/latest/pallet_treasury/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/treasury/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/treasury/src/lib.rs)

### Utility

A stateless module with helpers for dispatch management.

- [Docs](/rustdocs/latest/pallet_utility/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/utility/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/utility/src/lib.rs)

### Vesting

Expand All @@ -470,7 +470,7 @@ module ensures that there is a lock in place preventing the balance to drop belo
amount for any reason other than transaction fee payment.

- [Docs](/rustdocs/latest/pallet_vesting/index.html)
- [Source](https://github.com/paritytech/substrate/tree/master/frame/vesting/src/lib.rs)
- [Source](https://github.com/paritytech/substrate/blob/master/frame/vesting/src/lib.rs)

## Next steps

Expand Down
4 changes: 2 additions & 2 deletions v3/docs/03-runtime/h-weights-and-fees/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -413,14 +413,14 @@ That is what **Substrate benchmarking** is for. By writing benchmarking function
the weight functions for dispatchables in their worst case scenarios, within a certain limit. For more information, see [Benchmarking](/v3/runtime/benchmarking).

- Dedicated [weight documentation](/v3/concepts/weight)
- [Example pallet](https://github.com/paritytech/substrate/blob/master/frame/example/src/lib.rs)
- [Example pallet](https://github.com/paritytech/substrate/tree/master/frame/examples/basic)
- [SignedExtension](/rustdocs/latest/sp_runtime/traits/trait.SignedExtension.html)

### Examples

You can find examples of custom weights and fees in the following repositories:

- [Custom weights for the Example pallet](https://github.com/paritytech/substrate/blob/master/frame/example/src/weights.rs)
- [Custom weights for the Example pallet](https://github.com/paritytech/substrate/blob/master/frame/examples/basic/src/weights.rs)
- [Custom WeightToFee how-to guide](/how-to-guides/v3/weights/calculate-fees)

### References
Expand Down
2 changes: 1 addition & 1 deletion v3/docs/03-runtime/i-benchmarking/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ The template is in [rust handlebars](https://docs.rs/handlebars/) format.

## Example

Let's take `accumulate_dummy` benchmark case from the [example pallet](https://github.com/paritytech/substrate/blob/4b6635cf136a9fe2226f3152b4633afc6269912c/frame/example/src/lib.rs#L501-L530)
Let's take `accumulate_dummy` benchmark case from the [example pallet](https://github.com/paritytech/substrate/blob/master/frame/examples/basic/src/lib.rs)
as an example.

```rust
Expand Down
2 changes: 1 addition & 1 deletion v3/how-to-guides/01-basics/e-helper-functions/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ impl<T: Config> Pallet<T> {

## Examples

- [example-offchain-worker](https://github.com/paritytech/substrate/blob/master/frame/example-offchain-worker/src/lib.rs): the `add_price` helper function used in this pallet's dispatchable.
- [example-offchain-worker](https://github.com/paritytech/substrate/blob/master/frame/examples/offchain-worker/src/lib.rs): the `add_price` helper function used in this pallet's dispatchable.

## Resources

Expand Down
Loading