orbitersdk

Sparq subnet source code. See the docs for a more thorough look at the project.

If you are a developer, fill this form out for free support and additional incentives: https://forms.gle/m83ceG3XoJY3fpwU9

Developing on Docker

The project has a Dockerfile at the root of the repository that will build the project and deploy the network. It will also install tmux and vim for convenience. To develop on Docker, follow these steps:

• Install Docker on your machine:
  • Docker for Windows
  • Docker for Mac
  • Docker for Linux
• Build the image locally with docker build -t bdk-cpp-dev:latest (if using Linux or Mac, run as sudo)
  • This will build the image and tag it as bdk-cpp-dev:latest - you can change the tag to whatever you want, but remember to change it on the next step
• Run the container (you will be logged in as root):
  • For Linux/Mac: sudo docker run -it -v $(pwd):/orbitersdk-volume -p 8080-8099:8080-8099 -p 8110-8111:8110-8111 orbitersdk-cpp-dev:latest
  • For Windows: docker run -it -v %cd%:/orbitersdk-volume -p 8080-8099:8080-8099 -p 8110-8111:8110-8111 orbitersdk-cpp-dev:latest

Remember that we are using our local SDK repo as a volume, so every change in the local folder will be reflected to the container in real time, and vice-versa.

Also, you can integrate the container with your favorite IDE or editor, e.g. VSCode + Docker extension.

Developing manually

Install the following dependencies on your system:

• GCC with support for C++23 or higher
• CMake 3.19.0 or higher
• Boost 1.74 or higher (components: chrono, filesystem, program-options, system, thread, nowide)
• OpenSSL 1.1.1
• CryptoPP 8.2.0 or higher
• libscrypt
• zlib
• libsnappy for database compression
• (optional) clang-tidy for linting

If building with AvalancheGo support, you'll also need:

• Abseil (absl)
• libc-ares
• Protobuf 3.12 or higher
• gRPC

One-liners

For Debian 12 Bookworm or newer:

• sudo apt install build-essential cmake tmux clang-tidy autoconf libtool pkg-config libabsl-dev libboost-all-dev libc-ares-dev libcrypto++-dev libgrpc-dev libgrpc++-dev libscrypt-dev libssl-dev zlib1g-dev openssl protobuf-compiler protobuf-compiler-grpc

Documentation

We use Doxygen to generate documentation over the current source code. Run doxygen inside the project's root folder. Docs should be inside docs/html.

You should do this after running cmake .. in the build directory, as some header files need to be generated first.

For a more detailed explanation of the project's structure, check the docs repository.

Compiling

• Clone the project: `git clone https://github.com/SparqNet/orbitersdk-cpp
• Go to the project's root folder, create a "build" folder and change to it:
  • cd orbitersdk-cpp && mkdir build && cd build
• Run cmake inside the build folder: cmake ..
  • Use -DCMAKE_BUILD_TYPE={Debug,RelWithDebInfo,Release} to set the respective debug/release builds (Debug by default)
  • Use -DDEBUG=OFF to build without debug flags (ON by default)
  • Use -DUSE_LINT=ON to run clang-tidy along the build (OFF by default, WILL TAKE SIGNIFICANTLY LONGER TO COMPILE)
• Build the executable: cmake --build . -- -j$(nproc)
  • If using the linter, pipe stderr to a file (e.g. cmake --build . -- -j$(nproc) 2> log.txt)

Deploying

Go back to the project's root directory and run ./scripts/AIO-setup.sh. The script will deploy a local testnet with 5 Validator nodes, 6 normal nodes and 1 discovery node. All of them will be rdPoS. Run the script again to re-deploy, or call tmux kill-server to stop it entirely.

You can use the following flags on the script to customize deployment:

Example: ./scripts/AIO-setup.sh --clean --no-deploy --debug=false --cores=4 will clean the build folder, only build the project, build in release mode and use 4 cores for building. Remember that GCC uses around 1.5GB of RAM per core, so, for stability, it is recommended to adjust the number of cores to the available RAM on your system.

Once deployed, you can connect any Web3 client to it (we recommend Metamask). See below for details.

Note that, when re-deploying, if your wallet or RPC client keeps track of account nonce data, you must reset it as a network reset would set back their nonces to 0. Here's how to do it in MetaMask, for example.

Testnet defaults

The deployed chain will have the following information by default:

• ChainID: 808080
• Chain Owner: 0x00dead00665771855a34155f5e7405489df2c3c6
• Chain Owner Private Key: 0xe89ef6409c467285bcae9f80ab1cfeb3487cfe61ab28fb7d36443e1daa0c2867
• Chain Owner Initial Balance: 1000000000000000000000 wei
• Genesis Private Key: 0x4d48bdf34d65ef2bed2e4ee9020a7d3162b494ac31d3088153425f286f3d3c8c
• Genesis Address: 0x00dead001ae76ac3d3f282ffb8481becdee17357
• Genesis Timestamp: 1656356646000000
• ContractManager Address: 0x0001cb47ea6d8b55fe44fdd6b1bdb579efb43e61
• rdPoS Address: 0xb23aa52dbeda59277ab8a962c69f5971f22904cf
• Default RPC URL: http://127.0.0.1:8090

Nodes are all deployed on the same machine, under the following ports and tmux sessions: