Skip to content

Conflux-Chain/conflux-rust

Repository files navigation

Conflux-Rust

Conflux-rust is a Rust-based implementation of the Conflux protocol. It is fast and reliable.

For Users

Please follow the Conflux Documentation to build and run Conflux.

For Developers

For a general overview of the crates, see Project Layout.

Contribution

Thank you for considering helping out with our source code. We appreciate any contributions, even the smallest fixes. Please read the guidelines on how to submit issues and pull requests. Note that if you want to propose significant changes to the Conflux protocol, please submit a CIP.

Unit Tests and Integration Tests

Unit tests come together with the Rust code. They can be invoked via cargo test --release --all. See the Getting Started page for more information.

Integration tests are Python test scripts with the _test.py suffix in the tests directory. To run these tests, first compile Conflux in release mode using cargo build --release and fetch all submodule using git submodule update --remote --recursive --init. Then, you can run all integration tests using the script tests/test_all.py.

Resources

License

GNU General Public License v3.0