Building

1. Install rustc, cargo and rustfmt.

$ curl https://sh.rustup.rs -sSf | sh
$ source $HOME/.cargo/env
$ rustup component add rustfmt

Please sure you are always using the latest stable rust version by running:

$ rustup update

On Linux systems you may need to install libssl-dev, pkg-config, zlib1g-dev, etc. On Ubuntu:

$ sudo apt-get update
$ sudo apt-get install libssl-dev libudev-dev pkg-config zlib1g-dev llvm clang make cmake protobuf-compiler

On Mac M1s, make sure you set up your terminal & homebrew to use Rosetta. You can install it with:

$ softwareupdate --install-rosetta

2. Download the source code.

$ git clone https://github.com/Orbition-Network/orbition-network.git
$ cd orbition-network

3. Build.

$ cargo build --release

4. Run a minimal local cluster.

$ ./run.sh

Testing

Run the test suite:

$ cargo test --no-fail-fast

EVM integration

Info about EVM integration is at our docs.

Starting a local testnet

Start your own Development network locally, instructions are in the online docs.

Accessing the remote testnet and mainnet

• testnet - public accessible via bootstrap-testnet.orbition.network.
• mainnet - public accessible via bootstrap.orbition.network.

Benchmarking

First install the nightly build of rustc. cargo bench requires use of the unstable features only available in the nightly build.

$ rustup install nightly

Run the benchmarks:

$ cargo +nightly bench

Release Process

The release process for this project is described here.

Blockchain Audit Reports

The audit process and information regarding the Orbition Network blockchain can be found here.

Disclaimer

All claims, content, designs, algorithms, estimates, roadmaps, specifications, and performance measurements described in this project are based on good faith efforts by the Orbition Network development team. It is up to the reader to verify their accuracy and truthfulness. Nothing in this project constitutes a solicitation for investment.

Any content produced by the Orbition Network team or developer resources provided are for educational and inspirational purposes only. Orbition Network does not encourage, induce, or sanction the deployment, integration, or use of any such applications (including the code comprising the Orbition Network blockchain protocol) in violation of applicable laws or regulations and hereby prohibits any such deployment, integration, or use. This includes the use of any such applications by the reader (a) in violation of export control or sanctions laws of the United States or any other applicable jurisdiction, (b) if the reader is located in or ordinarily resident in a country or territory subject to comprehensive sanctions administered by the U.S. Office of Foreign Assets Control (OFAC), or (c) if the reader is or is working on behalf of a Specially Designated National (SDN) or a person subject to similar blocking or denied party prohibitions.

The reader should be aware that U.S. export control and sanctions laws prohibit U.S. persons (and other persons that are subject to such laws) from transacting with persons in certain countries and territories or those on the SDN list. Accordingly, there is a risk that individuals using any of the code contained in this repository, or a derivation thereof, may be sanctioned persons, and transactions with such persons would be a violation of U.S. export controls and sanctions law.

Orbition Network has drawn inspiration and incorporated source code implementations, logic, and architectural ideas from several prominent blockchain projects, including Solana, Polygon zkEVM, Cosmos WASM, and Velas. While these references have guided the development of Orbition Network, it is the responsibility of the reader to ensure that any usage complies with all applicable laws and regulations.