---------
----------------
Getting Started
Install Guide
Follow Setup to guide you install the CESS development.
Build Node
The cargo run command will perform an initial build. Use the following command to build the node without launching it:
# Fetch the code
git clone https://github.com/Cumulus2021/cess.git
cd cess
# Build the node (The first build will be long (~30min))
cargo build --release
Run The CESS Node
After the node has finished compiling, you can follow these steps below to run it.
Generate Keys
If you already have keys for Substrate using the SS58 address encoding format, please see the next section.
Begin by compiling and installing the utility (instructions and more info here).
Generate a mnemonic (Secret phrase) and see the sr25519 key and address associated with it.
# subkey command
subkey generate --scheme sr25519
Now see the ed25519 key and address associated with the same mnemonic (Secret phrase).
# subkey command
subkey inspect --scheme ed25519 "SECRET PHRASE YOU JUST GENERATED"
We recommend that you record the above outputs and keep mnemonic in safe.
Run Testnet C-ALPHA
Launch node on the C-ALPHA with:
# start
./target/release/cess-node --base-path /tmp/cess --chain C-ALPHA
Then you can add an account with:
# create key file
vim secretKey.txt
# add secret phrase for the node in the file
YOUR ACCOUNT'S SECRET PHRASE
# add key to node
./target/release/cess-node key insert --base-path /tmp/cess --chain C-ALPHA --scheme Sr25519 --key-type aura --suri /root/secretKey.txt
./target/release/cess-node key insert --base-path /tmp/cess --chain C-ALPHA --scheme Ed25519 --key-type gran --suri /root/secretKey.txt
Now you can launch node again:
# start
./target/release/cess-node --base-path /tmp/cess --chain C-ALPHA
Run in Docker
Install Docker first, and run the following command to start a node on the C-ALPHA:
docker pull cesstech/c-alpha:v0.0.1
docker run --network host cesstech/c-alpha:v0.0.1 ./CESS-v0.0.1/target/release/cess-node --base-path /tmp/cess --chain C-ALPHA
Run Tests
CESS has Rust unit tests, and can be run locally.
# Run all the Rust unit tests
cargo test --release
Module Documentation
Contribute
Please follow the contributions guidelines as outlined in docs/CONTRIBUTING.adoc. In all communications and contributions, this project follows the Contributor Covenant Code of Conduct.
4 May 7, 2023
58 Dec 15, 2022
61 Dec 9, 2022
115 Dec 15, 2022
4.1k Dec 29, 2022
16 Dec 11, 2022
43 Dec 13, 2022
18 Oct 31, 2022
145 Dec 19, 2022
2 Mar 25, 2022
4 May 12, 2022
230 Jan 2, 2023
629 Jan 4, 2023
0 Nov 14, 2021
5 Nov 8, 2022
58 Nov 15, 2022
101 Dec 19, 2022
10 Sep 30, 2022