https://github.com/Conflux-Chain/conflux-rust

The official Rust implementation of Conflux protocol. https://doc.confluxnetwork.org
https://github.com/Conflux-Chain/conflux-rust

blockchain conflux cryptocurrency p2p rust

Last synced: about 1 month ago
JSON representation

The official Rust implementation of Conflux protocol. https://doc.confluxnetwork.org

• Host: GitHub
• URL: https://github.com/Conflux-Chain/conflux-rust
• Owner: Conflux-Chain
• License: gpl-3.0
• Created: 2019-03-24T10:30:06.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T12:18:46.000Z (7 months ago)
• Last Synced: 2024-05-22T12:32:22.373Z (7 months ago)
• Topics: blockchain, conflux, cryptocurrency, p2p, rust
• Language: Rust
• Homepage: https://doc.confluxnetwork.org
• Size: 151 MB
• Stars: 640
• Watchers: 45
• Forks: 194
• Open Issues: 95
• Metadata Files:
  • Readme: README.md
  • Changelog: changelogs/CHANGELOG-0.6.x.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

• awesome-blockchain-rust - Conflux
• best-of-crypto - GitHub - 15% open · ⏱️ 04.06.2024): (Metaverse, NFTs & Gaming)

README

        
# 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](https://doc.confluxnetwork.org/) to

[build](https://doc.confluxnetwork.org/docs/general/run-a-node/advanced-topics/compiling-conflux-client)

and

[run](https://doc.confluxnetwork.org/docs/general/run-a-node/)

Conflux.

## For Developers

For a general overview of the crates, see [Project Layout](./docs/repo/layout.md).

### Contribution

Thank you for considering helping out with our source code. We appreciate any

contributions, even the smallest fixes. Please read the

[guidelines](https://github.com/Conflux-Chain/conflux-rust/blob/master/CONTRIBUTING.md)

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](https://github.com/Conflux-Chain/CIPs).

### 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](https://doc.confluxnetwork.org/docs/general/run-a-node/)

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

- [Conflux Website](https://www.confluxnetwork.org/)

- [Conflux Scan](https://www.confluxscan.io/)

- [Conflux Paper](https://arxiv.org/abs/1805.03870)

- [Medium](https://medium.com/@ConfluxNetwork)

## License

[GNU General Public License v3.0](https://github.com/Conflux-Chain/conflux-rust/blob/master/LICENSE)