-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Revamp the Readme of the minimal template #4649
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
5ed8670
Update minimal template readme
rzadp 099d5ac
img
rzadp 5d3a023
broken link
rzadp 99344c3
mv
rzadp f919b60
pjs
rzadp 55bfc70
link fix
rzadp c0a64c7
links were not working on github render
rzadp 48cf537
typo?
rzadp df1a1c2
zing and pep
rzadp 357de65
seems more natural
rzadp 0349e1e
simplify
rzadp dd06a8a
simplify
rzadp 32d79b5
Remove substrate.io links
rzadp 94327e2
rewrite and shorten pallets readme
rzadp 89e622e
rewrite / shorten runtime readme
rzadp 48bf863
revamp node readme
rzadp c45f7d7
link
rzadp 5e57bb3
main readme, and last substrate.io link
rzadp 02d0879
link
rzadp d99f819
restructure and info
rzadp 89f00b0
shorten sentence
rzadp bc2cbac
no validators in this template
rzadp bb98cff
Update templates/minimal/node/README.md
rzadp File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
revamp node readme
- Loading branch information
commit 48bf863f514fb0ba6fad3d7537a6af532a8c7e88
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,12 @@ | ||
| # Node | ||
|
|
||
| A blockchain node is an application that allows users to participate in a | ||
| blockchain network. Substrate-based blockchain nodes expose a number of | ||
| capabilities: | ||
| ℹ️ A node - in the Polkadot SDK nomenclature - is a normal binary executable, whose primary purpose is to execute the given [runtime](../runtime/README.md). | ||
|
|
||
| - Networking: Substrate nodes use the [`libp2p`](https://libp2p.io/) networking | ||
| stack to allow the nodes in the network to communicate with one another. | ||
| - Consensus: Blockchains must have a way to come to | ||
| [consensus](https://docs.substrate.io/fundamentals/consensus/) on the state of | ||
| the network. Substrate makes it possible to supply custom consensus engines | ||
| and also ships with several consensus mechanisms that have been built on top | ||
| of [Web3 Foundation | ||
| research](https://research.web3.foundation/Polkadot/protocols/NPoS). | ||
| - RPC Server: A remote procedure call (RPC) server is used to interact with | ||
| Substrate nodes. | ||
| 🔗 It communicated with other nodes in the network, and aims for [consensus](https://wiki.polkadot.network/docs/learn-consensus) among them. | ||
|
|
||
| There are several files in the `node` directory. Take special note of the | ||
| following: | ||
| ⚙️ It acts as a remote procedure call (RPC) server, allowing interaction with the blockchain. | ||
|
|
||
| - [`chain_spec.rs`](./src/chain_spec.rs): A [chain | ||
| specification](https://docs.substrate.io/build/chain-spec/) is a source code | ||
| file that defines a Substrate chain's initial (genesis) state. Chain | ||
| specifications are useful for development and testing, and critical when | ||
| architecting the launch of a production chain. Take note of the | ||
| `development_config` and `testnet_genesis` functions. These functions are | ||
| used to define the genesis state for the local development chain | ||
| configuration. These functions identify some [well-known | ||
| accounts](https://docs.substrate.io/reference/command-line-tools/subkey/) and | ||
| use them to configure the blockchain's initial state. | ||
| - [`service.rs`](./src/service.rs): This file defines the node | ||
| implementation. Take note of the libraries that this file imports and the | ||
| names of the functions it invokes. In particular, there are references to | ||
| consensus-related topics, such as the [block finalization and | ||
| forks](https://docs.substrate.io/fundamentals/consensus/#finalization-and-forks) | ||
| and other [consensus | ||
| mechanisms](https://docs.substrate.io/fundamentals/consensus/#default-consensus-models) | ||
| such as Aura for block authoring and GRANDPA for finality. | ||
| 👇 Here are the most important files in this node template: | ||
|
|
||
| - [`chain_spec.rs`](./src/chain_spec.rs): A chain specification is a source code file that defines the chain's initial (genesis) state. | ||
| - [`service.rs`](./src/service.rs): This file defines the node implementation. It's a place to configure consensus-related topics. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.