README.md

Nervos CKB - The Common Knowledge Base

About Nervos CKB

Nervos CKB is the layer 1 of Nervos Network, a public blockchain with PoW and cell model.

Nervos project defines a suite of scalable and interoperable blockchain protocols. Nervos CKB uses those protocols to create a self-evolving distributed network with a novel economic model, data model and more.

License

Nervos CKB is released under the terms of the MIT license. See COPYING for more information or see https://opensource.org/licenses/MIT.

Development Process

This project is still in development, and it's NOT in production-ready status. The wiki also lists some known issues that we are currently working on.

The master branch is regularly built and tested, however, it is not guaranteed to be completely stable; The develop branch is the work branch to merge new features, and it's not stable.

The contribution workflow is described in CONTRIBUTING.md, and security policy is described in SECURITY.md. To propose new protocol or standard for Nervos, see Nervos RFC.

Build dependencies

CKB is currently tested mainly with stable-1.29.2 on Linux and Mac OSX.

We recommend installing Rust through rustup

# Get rustup from rustup.rs, then in your `ckb` folder:
rustup override set 1.29.2
rustup component add rustfmt-preview
rustup component add clippy-preview

Report new breakage is welcome.

You also need to get the following packages：

• Ubuntu and Debian:

sudo apt-get install git autoconf flex bison texinfo libtool pkg-config libssl-dev libclang-dev

If you are on Ubuntu 18.04, you might run into 'stdarg.h' file not found error, this is because librocksdb-sys fails to find the correct include path. A temporary fix until librocksdb-sys fixes this problem is as follows:

sudo ln -s /usr/lib/gcc/x86_64-linux-gnu/7/include/stdarg.h /usr/include/stdarg.h
sudo ln -s /usr/lib/gcc/x86_64-linux-gnu/7/include/stddef.h /usr/include/stddef.h

• Archlinux

sudo pacman -Sy git autoconf flex bison texinfo libtool pkg-config openssl-1.0 clang

If you get openssl related errors in compiling, try the following environment variables to specify openssl-1.0:

OPENSSL_INCLUDE_DIR=/usr/include/openssl-1.0 OPENSSL_LIB_DIR=/usr/lib/openssl-1.0 cargo build --release

• OSX:

brew install autoconf libtool

Build from source & testing

# get ckb source code
git clone https://github.com/nervosnetwork/ckb.git
cd ckb

# build in release mode
cargo build --release

You can run the full test suite, or just run a specific package test:

# Run the full suite
cargo test --all
# Run a specific package test
cargo test -p ckb-chain

Quick Start

Start Node

Create the default runtime directory:

cp -r nodes_template/ nodes

Use the config file to start the node

target/release/ckb run

It searches config file ckb.json, nodes/default.json in the shell working directory in that order. Alternatively, the argument -c can specify the config file used to start the node.

The default config file saves data in nodes/default/.

Send Transaction via RPC

Find RPC port in the log output, the following command assumes 8114 is used:

curl -d '{"id": 2, "jsonrpc": "2.0", "method":"send_transaction","params": [{"version":2, "inputs":[], "outputs":[], "deps":[]}]}' \
  -H 'content-type:application/json' 'http://localhost:8114'

Advanced

Run multiple nodes in different data directories.

Create the config file for new nodes, for example:

cp nodes/default.json nodes/node2.json

Update data_dir configuration in config file to a different directory.

"data_dir": "node2"

Then start the new node using the new config file

target/release/ckb -c nodes/node2.json run

The option ckb.chain configures the chain spec. It accepts a path to the spec JSON file. The directory nodes_template/spec has all the pre-defined specs. Please note that nodes with different chain specs may fail to connect with each other.

The chain spec can switch between different PoW engines. Wiki has the instructions about how to configure it.