How-to quick reference guides

Substrate How-to quick reference guides provide instructions for achieving specific goals. Each guide explains how to perform a specific task with the assumption that you are already familiar with Substrate and programming in Rust.

Basics

See the following guides to learn common patterns in runtime development.

• Import a pallet
• Configure runtime constants
• Configure genesis state
• Customize a chain specification
• Use helper functions

Pallet design

See the following guides for best practices on building pallets using FRAME.

• Implement lockable currency
• Incorporate randomness
• Configure crowdfunding
• Create a storage structure (struct)
• Use tight pallet coupling
• Use loose pallet coupling

Weights

See the following guides for help with benchmarking and weight configurations.

• Calculate fees
• Add benchmarks

Testing

See the following guides for help with testing pallets and runtime logic.

• Set up basic tests
• Test a transfer function

Storage migration

See the following guides for help with a storage migration.

• Basic storage migration
• Trigger migration

Consensus models

See the following guides to implement consensus mechanisms in your runtimes.

• Create a hybrid node
• Add proof-of-work consensus

Parachains

See the following guides for help working with Substrate parachains.

• Convert a solo chain
• Connect to a relay chain
• Select collators
• Prepare to launch
• Upgrade a parachain
• Auctions and crowdloans
• Add HRMP channels

Tools

See the following guides for add-on tools that help you manage Substrate chains in production.

• Use try-runtime
• Create a txwrapper for a chain
• Use REST endpoints to get chain data
• Verify a Wasm binary

Offchain workers

See the following guides for help working with offchain data.

• Make offchain HTTP requests
• Offchain local storage
• Offchain indexing