centrifuge-chain

Centrifuge Chain is Centrifuge's substrate based chain.

Getting started

A quick way to land and develop on Centrifuge chain is by means of a containerized environment with Docker (NixOS is also supported as a bundling tool), that we use to call the Centrifuge sandbox. For doing so, you should first enter the following command:

$ make setup    # Build the Centrifuge' sandbox Docker image

Then to build or check the Centrifuge chain's code in the sandbox, you can enter

$ make check    # Compile the Centrifuge chain's code (no executable is generated)

or

$ make build    # Compile and build Centrifuge executable

For more information, simply type make or make help in your terminal.

Build

Install Rust:

curl https://sh.rustup.rs -sSf | sh

Initialize your Wasm Build environment:

RUST_TOOLCHAIN=nightly-2020-08-16 ./scripts/init.sh

Build Wasm and native code:

cargo build --release

Building with Nix: Binary & Docker Container

Learn more and install Nix

You can build the binary using nix flakes by running:

nix-build -L

To build the docker container and load it into the docker client use the following two commands:

nix-build -L .#dockerContainer
docker load -i result

centrifuge-chain bi

Cachix Binary Cache

You can use the cachix binary cache to speed up build times:

cachix use centrifuge-chain

Run

Tests

cargo test --release

Testnets

Centrifuge has multiple testnets online.

1. Fulvous is an ephemeral testnet for internal dev purposes, and testing internal integrations with all the centrifuge components. Not recommended for external usage due to its nature and purpose.
2. Flint is for breaking changes and testing the integration with other parts of the Centrifuge ecosystem. Think of Flint as a way to test previews, alpha releases.
3. Amber is for audits and testing of the stability of release candidates. Think of Amber as a way to test beta releases.

1. Fulvous

To run a node:

./target/release/centrifuge-chain \
  --chain=fulvous \
  --name "My node name" \
  --bootnodes /ip4/35.246.140.178/tcp/30333/p2p/QmRg2bEPTHCt8u3a1LeZA8dJTd8mgMccsAcoHXTjQUpcZj \
  --bootnodes /ip4/35.198.166.26/tcp/30333/p2p/QmNpeu3bJhESzriWMLRcxRgSCYDGQ6GdBHnJAf8bJexAd5

2. Flint

To run a node:

./target/release/centrifuge-chain \
  --chain=flint \
  --name "My node name" \
  --bootnodes=/ip4/34.89.190.227/tcp/30333/p2p/QmdMJoLc6yduqfrJtMAB6xHegydr3YXzfDCZWEYsaCJaRZ \
  --bootnodes=/ip4/35.234.68.18/tcp/30333/p2p/Qma5M7P5qym3Gfgp1wu6yk1QyMv2RzFV9GztP9AxHoK8PK \
  --bootnodes=/ip4/35.246.244.114/tcp/30333/p2p/QmdjEGZ9ZNVv4aTGGV46AkBqgCdWTHrh9wr9itYhs61gJA \
  --bootnodes=/ip4/34.89.148.219/tcp/30333/p2p/QmNd8inSbEvFuwbRToj5VQBNReqtb414oWGyDjF7tQ1qfX

To receive tokens, use our faucet: https://faucets.blockxlabs.com/

To run a validator go to our docs

3. Amber

See our docs

Single node development chain

Purge any existing developer chain state:

cargo run --release -- purge-chain --dev

Start a development chain with:

cargo run --release -- --dev

Detailed logs may be shown by running the node with the following environment variables set: RUST_LOG=debug RUST_BACKTRACE=1 cargo run --release -- --dev.

Multi-node local testnet

If you want to see the multi-node consensus algorithm in action locally, then you can create a local testnet with two validator nodes for Alice and Bob, who are the initial authorities that have been endowed with testnet tokens.

You'll need two terminal windows open.

We'll start Alice's node first on default TCP port 30333 with her chain database stored locally at /tmp/alice. The identity of her node is QmPf2cdiE6Sp2Njxzy6cz8vHA7ii86mMFF61e6NMGRtFbr:

./target/release/centrifuge-chain \
  --base-path /tmp/alice \
  --chain=local \
  --alice

In the second terminal, we'll start Bob's node on TCP port 30334, and with his chain database stored locally at /tmp/bob. We'll specify a value for the --bootnodes option that will connect his node to Alice's bootnode ID on TCP port 30333:

./target/release/centrifuge-chain \
  --base-path /tmp/bob \
  --bootnodes /ip4/127.0.0.1/tcp/30333/p2p/QmPf2cdiE6Sp2Njxzy6cz8vHA7ii86mMFF61e6NMGRtFbr \
  --chain=local \
  --bob \
  --port 30334

Additional CLI usage options are available and may be shown by running ./target/release/centrifuge-chain --help.

Generating a new genesis file

1. Be sure to change the id and protocol_id in src/chain_spec.rs
2. Run cargo run --release build-spec --disable-default-bootnode --chain fulvous > res/[name]-spec.json to export the chain spec
3. Commit

Linting

Lint the project with cargo +nightly fmt. This excludes certain paths (defined in rustfmt.toml) that we want to stay as close as possible to paritytech/substrate to simplify upgrading to new releases.

Verifying Runtime

1. Check out the commit at which the runtime was built.
2. Run TARGET=build-runtime RUST_TOOLCHAIN=nightly-2020-08-16 ./ci/script.sh
3. A similar output is generated

✨ Your Substrate WASM Runtime is ready! ✨
Summary:
  Generator  : srtool v0.9.5
  GIT commit : 27326e69481f08313d6048da1500befe209bdf71
  GIT tag    : v0.0.3
  GIT branch : master
  Time       : 2020-03-20T11:00:24Z
  Rustc      : rustc 1.43.0-nightly (5e7af4669 2020-02-16)
  Size       : 928 KB (950464 bytes)
  Content    : 0x0061736d0100000001c2022f60037f7f...3436363920323032302d30322d313629
  Package    : centrifuge-chain-runtime
  Proposal   : 0x5c3d2cd41d70c514566c9b512743ad229fa96518061fe21c8178ba43cfcf16dc
  SHA256     : 3f0d2e98e2351144027826f26277bda90e5fabc13f0945fc8fec13d116602e2a
  Wasm       : ./target/srtool/release/wbuild/centrifuge-chain-runtime/centrifuge_chain_runtime.compact.wasm

4. Proposal hash should match the runtime upgrade proposal