hub / github.com/JoshOrndorff/substrate-recipes

github.com/JoshOrndorff/substrate-recipes @v3.0.0

Chat with this repo

repository ↗ · DeepWiki ↗ · release v3.0.0 ↗ · + Follow

354 symbols 550 edges 102 files 87 documented · 25%

What it actually does AI analysis from the code graph — generated when you open this

loading…

README

Substrate Recipes 🍴😋🍴

Lines of Code

A Hands-On Cookbook for Aspiring Blockchain Chefs

Get Started

Ready to roll up your sleeves and cook some blockchain? Read the book online at substrate.dev/recipes 😋

Repository Structure

There are five primary directories in this repository:

Text: Source of the book written in markdown. This text describes the code in the other three directories.
Pallets: Pallets for use in FRAME-based runtimes.
Runtimes: Runtimes for use in Substrate nodes.
Consensus: Consensus engines for use in Substrate nodes.
Nodes: Complete Substrate nodes ready to run.

The book is built with mdbook and deployed via github pages.

Building This Book Locally

Building the book requires mdBook, ideally the same version that rust-lang/rust uses in this file. To get it:

$ cargo install mdbook --vers [version-num]

To build the book, type:

$ mdbook build

The output will be in the book subdirectory. To check it out, open up book/index.html in a web browser, or to serve the book locally, type:

$ mdbook serve

The default address to view the book will be located at http://localhost:3000 .

License

The Substrate Recipes are GPL 3.0 Licensed It is open source and open for contributions.

Using Recipes in External Projects

The pallets and runtimes provided here are tested and ready to be used in other Substrate-based blockchains. The big caveat is that you must use the same upstream Substrate version throughout the project.

Extension points exported contracts — how you extend this code

Config (Interface)

(no doc) [55 implementers]

pallets/map-set/src/lib.rs

Config (Interface)

The pallet's configuration trait Notice the loose coupling: any pallet that implements the `AccountSet` behavior works h [3 …

pallets/check-membership/src/loose/mod.rs

Config (Interface)

The pallet's configuration trait [3 implementers]

pallets/simple-crowdfund/src/lib.rs

AccountSet (Interface)

Types that implement the AccountSet trait are able to supply a set of accounts The trait is generic over the notion of A [2 …

traits/account-set/src/lib.rs

Config (Interface)

The pallet's configuration trait. [2 implementers]

pallets/randomness/src/lib.rs

Config (Interface)

The module's configuration trait. [2 implementers]

pallets/sum-storage/src/lib.rs

Config (Interface)

This is the pallet's configuration trait [2 implementers]

pallets/ocw-demo/src/lib.rs

Config (Interface)

(no doc) [3 implementers]

pallets/struct-storage/src/lib.rs

Core symbols most depended-on inside this repo

clone

called by 134

consensus/sha3pow/src/lib.rs

new_partial

called by 6

nodes/rpc-node/src/service.rs

new_partial

called by 6

nodes/kitchen-node/src/service.rs

new_partial

called by 6

nodes/basic-pow/src/service.rs

new_partial

called by 6

nodes/hybrid-consensus/src/service.rs

commit

called by 6

pallets/ringbuffer-queue/src/ringbuffer.rs

testnet_genesis

called by 5

runtimes/ocw-runtime/src/genesis.rs

push

called by 5

pallets/ringbuffer-queue/src/ringbuffer.rs

Shape

Function 165

Method 105

Class 47

Interface 33

Enum 4

Languages

Rust100%

TypeScript1%

Modules by API surface

pallets/ringbuffer-queue/src/ringbuffer.rs20 symbols

pallets/ocw-demo/src/lib.rs18 symbols

pallets/simple-crowdfund/src/tests.rs13 symbols

consensus/sha3pow/src/lib.rs10 symbols

nodes/rpc-node/src/command.rs9 symbols

nodes/kitchen-node/src/command.rs9 symbols

nodes/hybrid-consensus/src/command.rs9 symbols

nodes/basic-pow/src/command.rs9 symbols

pallets/simple-map/src/tests.rs8 symbols

pallets/simple-crowdfund/src/lib.rs8 symbols

pallets/fixed-point/src/tests.rs8 symbols

pallets/charity/src/tests.rs8 symbols

For agents

$ claude mcp add substrate-recipes \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact