A new FABRIC-based Tetcore Node for Windows, ready for hacking :rocket:
Follow these steps to prepare a local Tetcore development environment :hammerandwrench:
Find manual setup instructions at the Tetcore Developer Hub.
Once the development environment is set up, build the node template. This command will build the Wasm and native code:
bash
cargo build --release
Purge any existing dev chain state:
bash
./target/release/node-template purge-chain --dev
Start a dev chain:
bash
./target/release/node-template --dev
Or, start a dev chain with detailed logging:
bash
RUST_LOG=debug RUST_BACKTRACE=1 ./target/release/node-template -lruntime=debug --dev
To see the multi-node consensus algorithm in action, run a local testnet with two validator nodes,
Alice and Bob, that have been configured as the initial
authorities of the local testnet chain and endowed with testnet units.
Note: this will require two terminal sessions (one for each node).
Start Alice's node first. The command below uses the default TCP port (30333) and specifies
/tmp/alice as the chain database location. Alice's node ID will be
12D3KooWEyoppNCUx8Yx66oV9fJnriXwCcXwDDUA2kj6vnc6iDEp (legacy representation:
QmRpheLN4JWdAnY7HGJfWFNbfkQCb6tFf4vvA6hgjMZKrR); this is determined by the node-key.
bash
cargo run -- \
--base-path /tmp/alice \
--chain=local \
--alice \
--node-key 0000000000000000000000000000000000000000000000000000000000000001 \
--telemetry-url 'ws://telemetry.polkadot.io:1024 0' \
--validator
In another terminal, use the following command to start Bob's node on a different TCP port (30334)
and with a chain database location of /tmp/bob. The --bootnodes option will connect his node to
Alice's on TCP port 30333:
bash
cargo run -- \
--base-path /tmp/bob \
--bootnodes /ip4/127.0.0.1/tcp/30333/p2p/12D3KooWEyoppNCUx8Yx66oV9fJnriXwCcXwDDUA2kj6vnc6iDEp \
--chain=local \
--bob \
--port 30334 \
--ws-port 9945 \
--telemetry-url 'ws://telemetry.polkadot.io:1024 0' \
--validator
Execute cargo run -- --help to learn more about the template node's CLI options.
A Tetcore project such as this consists of a number of components that are spread across a few directories.
A blockchain node is an application that allows users to participate in a blockchain network. Tetcore-based blockchain nodes expose a number of capabilities:
libp2p networking stack to allow the
nodes in the network to communicate with one another.There are several files in the node directory - take special note of the following:
chain_spec.rs: A
chain specification is a
source code file that defines a Tetcore 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, which
are used to define the genesis state for the local development chain configuration. These
functions identify some
well-known accounts
and use them to configure the blockchain's initial state.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
longest chain rule,
the Aura block authoring
mechanism and the
GRANDPA finality
gadget.After the node has been built, refer to the embedded documentation to learn more about the capabilities and configuration parameters that it exposes:
shell
./target/release/node-template --help
In Tetcore, the terms "runtime" and "state transition function" are analogous - they refer to the core logic of the blockchain that is responsible for validating blocks and executing the state changes they define. The Tetcore project in this repository uses the FABRIC framework to construct a blockchain runtime. FABRIC allows runtime developers to declare domain-specific logic in modules called "nobles". At the heart of FABRIC is a helpful macro language that makes it easy to create nobles and flexibly compose them to create blockchains that can address a variety of needs.
Review the FABRIC runtime implementation included in this template and note the following:
impl $NOBLE_NAME::Config for Runtime.construct_runtime!
macro, which is part of the core
FABRIC Support
library.The runtime in this project is constructed using many FABRIC nobles that ship with the
core Tetcore repository and a
template noble that is defined in the nobles directory.
A FABRIC noble is compromised of a number of blockchain primitives:
Config configuration interface is used to define the types and parameters upon
which a FABRIC noble depends.Generate a Tetcore node template based on a particular commit by running the following commands:
```bash
git clone https://github.com/tetcoin/tetcore.git cd tetcore
git checkout
.maintain/node-template-release.sh ../node-template.tar.gz ```
Custom node templates are not supported. Please use a recently tagged version of the Tetcore Developer Node Template in order to receive support.