cess.cloud is to provide the capabilities of a new global decentralized cloud data storage network by building with the infrastructure of decentralized cloud data network of the substrate while maintaining the data security and reliability guarantees inherent to blockchain technology. Learn more at white-paper.
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/CESSProject/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
Launch node on the cess-testnet with:
# start
./target/release/cess-node --base-path /tmp/cess --chain cess-testnet
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 cess-testnet --scheme Sr25519 --key-type babe --suri /root/secretKey.txt
./target/release/cess-node key insert --base-path /tmp/cess --chain cess-testnet --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 cess-testnet
Run in Docker
Install Docker first, and run the following command to start a node on the cess-testnet:
docker pull cesslab/cess-testnet:0.3.0
docker run -itd --name=cess --network=host cesslab/cess_testnet:0.3.0 && docker logs -f cess
Storage Mining
CESS supports to obtain incentives by contributing idle storage with storage mining tool, and click here to learn more.
Run Tests
CESS has Rust unit tests, and can be run locally.
# Run all the Rust unit tests
cargo test --release
Run Tests with Benchmarks
CESS has Rust unit tests with benckmarks also. Currently, testing this feature in docker is not supported. Please execute belows after clone this repo.
# Run unit tests with benchmarks
cargo test -p pallet-sminer --features runtime-benchmarks
cargo test -p pallet-segment-book --features runtime-benchmarks
cargo test -p pallet-file-bank --features runtime-benchmarks
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.