FRAME Pallets

Provides an overview of the most commonly-used predefined FRAME pallets.

The FRAME development environment provides modules—called pallets—and support libraries that you can use, modify, and extend to build the runtime logic to suit the needs of your blockchain.

This section provides an overview of the predefined pallets and links to the Rust API reference documentation, where you can find details about each pallet's interfaces.

System pallets

The FRAME system pallets are integral to the Substrate runtime and provide core functionality that all other pallets depend on.

System pallet nameWhat it's for

Contains common runtime patterns for benchmarking and testing purposes.

Orchestrates incoming function calls by sending them to the appropriate pallets in the runtime.

Provides Rust macros, types, traits, and modules that generate boilerplate code for the pallet structure when compiled.

Defines low-level types for Substrate primitives, storage items, and core functions for the blockchain. All other pallets depend on the frame_system crate.

Functional pallets

The Substrate development framework includes many functional pallets that provide features you might find generally useful as composable components of your blockchain. These functional pallets are prebuilt and freely available to enable the community to share, reuse, and improve the interfaces to address common use cases.

The following table highlights some of the most commonly used pallets available. However, the number of pallets that provide specialized functionality and how they provide that functionality changes frequently. You should check the Rust documentation for the most up-to-date listing of pallets and for details about using them.

Prebuilt pallet nameWhat it's for

Initializes a collective for community members to join in an effort to establish rules against bad behavior and to provide recognition and influence for teams that contribute to the ecosystem.

Provides simple and secure methods for dealing with fungible assets.

Enables sending funds from an origin to a target. A proof is used to allow the target to claim the swap. If the swap is not claimed within a specified duration of time, the sender may cancel it.

Extends the authority round (Aura) consensus model by managing offline reporting.

Retrieves the current set of authorities, learns its own authority ID, and signs and verifies messages to and from other authorities.

Tracks the current author of the block and recent uncles.

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

Provides functionality for handling accounts and balances.

Manages rewards for performing specified work or for achieving a specified set of objectives.

Allows a set of account IDs to make their collective feelings known through dispatched calls from specialized origins.

Provides functionality for the runtime to deploy and execute WebAssembly smart contracts.

Provides common definitions that are used by the pallet_contracts crate for smart contracts.

Provides a democratic system that handles administration of general stakeholder voting.

Enables an election provider to conduct an election consisting of signed and unsigned phases.

Provides an election module based on sequential Phragmén.

Demonstrates concepts, APIs, and structures that are applicable for most pallets.

Demonstrates concepts, APIs, and structures that are applicable for most offchain workers.

Extends the GRANDPA consensus by managing the GRANDPA authority set ready for the native code.

Enables a federated naming system that allows multiple registrars to be added from a specified origin. Registrars can set a fee to provide identity-verification service.

Allows validators to gossip a heartbeat transaction with each new session to signal that the node is online.

Allocates indices for newly created accounts. An index is a short form of an address.

Configures a lottery that enables network participants to purchase tickets.

Allows control of membership of a set of AccountIds, useful for managing the membership of a collective.

Enables multi-signature dispatches.

Demonstrates simplified account naming on-chain. It makes no effort to create a name hierarchy, be a DNS replacement, or provide reverse lookups.

Tracks reported offences.

Allows accounts to give permission to other accounts to dispatch types of calls from their signed origin.

Provides a random function that can be used in tests and generates low-influence random values based on the block hashes from the previous 81 blocks. This pallet is not intended for use in production.

Provides a social recovery tool for users to gain access to their accounts if their private key or other authentication mechanism is lost. This pallet enables an account owner to identify trusted parties who can act on the owner's behalf to recover access to an account.

Exposes capabilities for scheduling dispatches to occur at a specified block number or at a specified period. These scheduled dispatches can be named or anonymous and can be canceled.

Maintains a scored membership pool where the highest scoring entities are made members.

Allows validators to manage their session keys, provides a function for changing the session length, and handles session rotation.

Provides economic incentives for users to participate and maintain a membership society.

Manages funds that have been staked by network maintainers.

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.

Provides functionality to get and set the on-chain time.

Provides the basic logic to compute pre-dispatch transaction fees.

Provides a reserve of funds that can be managed by stakeholders in the system and a structure for making spending proposals from this reserve.

Provides methods for managing non-fungible collections and items.

Provides a stateless helper module for managing dispatches.

Places a linear curve on an account's locked balance. This module ensures that there is a lock in place to prevent the balance to drop below the unvested amount for any reason other than transaction fee payment.

Parachain pallets

In addition to the functional pallets that are generally useful for any blockchain, there are prebuilt pallets that provide features specifically for blockchains that are intended to connect to a relay chain. The following pallets provide features for parachain development.

Prebuilt pallet nameWhat it's for

Provides AURA consensus for parachains.

Manages collators in a parachain.

Implements a message queue for receiving messages from the relay chain.

Provides basic functionality for cumulus-based parachains.

Enables migration from a solo chain to a parachain.

Adds support for cross-chain message passing (XCMP) to a parachain.

Enables the XCMP transport layer to handle both incoming and outgoing message sending and dispatch, queuing, signalling, and backpressure.

Additional information

For detailed information about any pallet, refer to the Rust-generated API documentation or the source code for the individual pallet.

Last updated