xiaods / conflux-rust

The Rust implementation of Conflux protocol.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Conflux-Rust

Travis

Conflux-rust is a rust-based implementation of Conflux protocol, it is fast and reliable.

Build Instruction

  1. Install rust.
  2. rustup update.
  3. Make sure you are using the stable branch.
  4. Install clang for compiling rocksdb.
  5. Install other dependencies for rocksdb. Instruction can be found in https://github.com/facebook/rocksdb/blob/master/INSTALL.md

Run Instruction

  1. Build the project.
  2. Enter directory run.
  3. Edit default.toml:
    • Set public_address according to your public IP.
    • Set mining_author to the account address to receive mining reward.
  4. Execute the command ./../target/release/conflux --config default.toml

Test Instruction

  1. Install solc to compile solidity.
  2. Run dev-support/dep_pip3.sh to install extra python3 packages for running test.
  3. Run the python scripts in test directory.

Note that there is another sha3 package which does not contain necessary function. Do not install that package! Install pysha3 instead.

Contribution

Thank you for considering helping out with our source code. We appreciate any contributions, even the smallest fixes.

Here are some guidelines before you start:

  • Please fork the project to contribute your pull requests.
  • If you wish to submit complex changes, please fire an issue to communicate with the core devs first.
  • Pull requests need to be based on and opened against the master branch.
  • Code must be formatted using cargo_fmt.sh.
  • We use reviewable.io as our code review tool for any pull request.

Resources

License

GNU General Public License v3.0

About

The Rust implementation of Conflux protocol.

License:GNU General Public License v3.0


Languages

Language:Rust 85.4%Language:Python 13.7%Language:Shell 0.7%Language:Dockerfile 0.2%