substrate-doc

KO | EN

gitlite — search

#hacktoberfest #react #ai #go #android #machine-learning #deep-learning #macos #java #kubernetes #awesome-list #vue #openai #open-source

(★ 9)

Documentation for substrate

substrate-doc Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# substrate-doc
Some additional visual documentation for substrate complementing https://docs.substrate.dev/docs/

to edit these diagrams with draw.io go to https://www.draw.io/?mode=github
and open diagram. "save" commits back to github.

# Transaction lifetime 
What happens with a transaction when it is passed through RPC until it is included in a block?

![Diagram](https://raw.githubusercontent.com/brenzi/substrate-doc/master/transaction-sequence-diagram.svg)

* [x] reviewed by @shawntabrizi / @bkchr / @thomusdrw

## corresponding class diagram
![Diagram](https://raw.githubusercontent.com/brenzi/substrate-doc/master/BlockBuilderClasses.svg)

# Architecture

## Service
the following components will be instanciated by the substrate service

TODO: still a bit chaotic

![Diagram](https://raw.githubusercontent.com/brenzi/substrate-doc/master/ServiceInstance.svg)

to learn more, study [these lines](https://github.com/paritytech/substrate/blob/7c95fb0bfd0b204e1200bf7e270538ba5e61e063/core/service/src/lib.rs#L94)

## Full Client
Components of a full client
![Diagram](https://raw.githubusercontent.com/brenzi/substrate-doc/master/FullComponents.svg)

## Light Client
TODO: light client components diagram

study `core/client/src/light/fetcher.rs` 
https://substrate.dev/rustdocs/v1.0/substrate_client/light/fetcher/trait.FetchChecker.html#tymethod.check_read_proof

# Blockchain Data Model
![Diagram](https://raw.githubusercontent.com/brenzi/substrate-doc/master/BlockchainDataModel.svg)

# Consensus
## Aura
Aura takes fixed turns to propose a new block.

only the authority who's turn it is proposes a new block

slot duration is a fixed number of seconds, to be evaluated on the autorities machines' time.

the slot proposer broadcasts his block, the others validate and import it and gossip about what they do.

![Diagram](https://raw.githubusercontent.com/brenzi/substrate-doc/master/AuraConsensusClasses.svg)

TODO: compress diagram area

# SRML
All modules involved in Gav's coin flipping demo
![Diagram](https://raw.githubusercontent.com/brenzi/substrate-doc/master/SRMLmodules.svg)

TODO: simplify!

substrate-doc

substrate-doc Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

substrate-doc

substrate-doc Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README