astrix node
v0.14.1
Astrix full-node and its ancillary libraries.
We invite developers and blockchain enthusiasts to collaborate, test, and optimize our Rust implementation. Each line of code here is an opportunity to contribute to the open-source blockchain movement, shaping a platform designed for scalability and speed without compromising on decentralization.
Your feedback, contributions, and issue reports will be integral to evolving this codebase and continuing its maturity as a reliable node in the Astrix network.
Install general prerequisites
sudo apt install curl git build-essential libssl-dev pkg-config Install Protobuf (required for gRPC)
sudo apt install protobuf-compiler libprotobuf-dev #Required for gRPCInstall the clang toolchain (required for RocksDB and WASM secp256k1 builds)
sudo apt-get install clang-format clang-tidy
clang-tools clang clangd libc++-dev
libc++1 libc++abi-dev libc++abi1
libclang-dev libclang1 liblldb-dev
libllvm-ocaml-dev libomp-dev libomp5
lld lldb llvm-dev llvm-runtime
llvm python3-clangInstall the rust toolchain
If you already have rust installed, update it by running: rustup update
Install wasm-pack
cargo install wasm-packInstall wasm32 target
rustup target add wasm32-unknown-unknownClone the repo
git clone https://github.com/astrix-network/astrix-node
cd astrix-nodeInstall Git for Windows or an alternative Git distribution.
Install Protocol Buffers and add the bin directory to your Path
Install LLVM-15.0.6-win64.exe
Add the bin directory of the LLVM installation (C:Program FilesLLVMbin) to PATH
set LIBCLANG_PATH environment variable to point to the bin directory as well
IMPORTANT: Due to C++ dependency configuration issues, LLVM AR installation on Windows may not function correctly when switching between WASM and native C++ code compilation (native RocksDB+secp256k1 vs WASM32 builds of secp256k1). Unfortunately, manually setting AR environment variable also confuses C++ build toolchain (it should not be set for native but should be set for WASM32 targets). Currently, the best way to address this, is as follows: after installing LLVM on Windows, go to the target bin installation directory and copy or rename LLVM_AR.exe to AR.exe.
Install the rust toolchain
If you already have rust installed, update it by running: rustup update
Install wasm-pack
cargo install wasm-packInstall wasm32 target
rustup target add wasm32-unknown-unknownClone the repo
git clone https://github.com/astrix-network/astrix-node
cd astrix-nodeInstall Protobuf (required for gRPC)
brew install protobufInstall llvm.
The default XCode installation of llvm does not support WASM build targets.
To build WASM on MacOS you need to install llvm from homebrew (at the time of writing, the llvm version for MacOS is 16.0.1).
brew install llvmNOTE: Homebrew can use different keg installation locations depending on your configuration. For example:
/opt/homebrew/opt/llvm -> /opt/homebrew/Cellar/llvm/16.0.1/usr/local/Cellar/llvm/16.0.1To determine the installation location you can use brew list llvm command and then modify the paths below accordingly:
% brew list llvm
/usr/local/Cellar/llvm/16.0.1/bin/FileCheck
/usr/local/Cellar/llvm/16.0.1/bin/UnicodeNameMappingGenerator
...If you have /opt/homebrew/Cellar, then you should be able to use /opt/homebrew/opt/llvm.
Add the following to your ~/.zshrc file:
export PATH="/opt/homebrew/opt/llvm/bin:$PATH"
export LDFLAGS="-L/opt/homebrew/opt/llvm/lib"
export CPPFLAGS="-I/opt/homebrew/opt/llvm/include"
export AR=/opt/homebrew/opt/llvm/bin/llvm-arReload the ~/.zshrc file
source ~/.zshrcInstall the rust toolchain
If you already have rust installed, update it by running: rustup update
Install wasm-pack
cargo install wasm-packInstall wasm32 target
rustup target add wasm32-unknown-unknownClone the repo
git clone https://github.com/astrix-network/astrix-node
cd astrix-nodeRust WebAssembly (WASM) refers to the use of the Rust programming language to write code that can be compiled into WebAssembly, a binary instruction format that runs in web browsers and NodeJs. This allows for easy development using JavaScript and TypeScript programming languages while retaining the benefits of Rust.
WASM SDK components can be built from sources by running:
- ./build-release - build a full release package (includes both release and debug builds for web and nodejs targets)
- ./build-docs - build TypeScript documentation
- ./build-web - release web build
- ./build-web-dev - development web build
- ./build-nodejs - release nodejs build
- ./build-nodejs-dev - development nodejs build
IMPORTANT: do not use dev builds in production. They are significantly larger, slower and include debug symbols.
cd cli
cargo run --releaseRun an http server inside of wallet/wasm/web folder. If you don't have once, you can use the following:
cd wallet/wasm/web
cargo install basic-http-server
basic-http-serverThe basic-http-server will serve on port 4000 by default, so open your web browser and load http://localhost:4000
The framework is compatible with all major desktop and mobile browsers.
Start a mainnet node
cargo run --release --bin astrixd
# or with UTXO-index enabled (needed when using wallets)
cargo run --release --bin astrixd -- --utxoindexcargo run --release --bin astrixd -- --configfile /path/to/configfile.toml
# or
cargo run --release --bin astrixd -- -C /path/to/configfile.toml= is fine, arg=value and arg = value are both parsed correctly.. or = will require quoting the value i.e addpeer = ["10.0.0.1", "1.2.3.4"].For example:
utxoindex = false
disable-upnp = true
perf-metrics = true
appdir = "some-dir"
netsuffix = 11
addpeer = ["10.0.0.1", "1.2.3.4"]
Pass the --help flag to view all possible arguments
cargo run --release --bin astrixd -- --helpwRPC subsystem is disabled by default in astrixd and can be enabled via:
JSON protocol:
--rpclisten-json = <interface:port>
# or use the defaults for current network
--rpclisten-json = defaultBorsh protocol:
--rpclisten-borsh = <interface:port>
# or use the defaults for current network
--rpclisten-borsh = defaultSidenote:
Astrix Node integrates an optional wRPC subsystem. wRPC is a high-performance, platform-neutral, Rust-centric, WebSocket-framed RPC implementation that can use Borsh and JSON protocol encoding.
JSON protocol messaging is similar to JSON-RPC 1.0, but differs from the specification due to server-side notifications.
Borsh encoding is meant for inter-process communication. When using Borsh both client and server should be built from the same codebase.
JSON protocol is based on Astrix data structures and is data-structure-version agnostic. You can connect to the JSON endpoint using any WebSocket library. Built-in RPC clients for JavaScript and TypeScript capable of running in web browsers and Node.js are available as a part of the Astrix WASM framework.
Logging in astrixd and simpa can be filtered by either:
The current codebase supports a full in-process network simulation, building an actual DAG over virtual time with virtual delay and benchmarking validation time (following the simulation generation).
To see the available commands
cargo run --release --bin simpa -- --helpThe following command will run a simulation to produce 1000 blocks with communication delay of 2 seconds and 8 BPS (blocks per second) while attempting to fill each block with up to 200 transactions.
cargo run --release --bin simpa -- -t=200 -d=2 -b=8 -n=1000Heap-profiling in astrixd and simpa can be done by enabling heap feature and profile using the --features argument
cargo run --bin astrixd --profile heap --features=heapIt will produce {bin-name}-heap.json file in the root of the workdir, that can be inspected by the dhat-viewer
Run unit and most integration tests
cd astrix-node
cargo test --release
// or install nextest and runUsing nextest
cd astrix-node
cargo nextest run --releasecd astrix-node
cargo benchLogging in astrixd and simpa can be filtered by either:
Defining the environment variable RUST_LOG
Adding the --loglevel argument like in the following example:
(cargo run --bin astrixd -- --loglevel info,astrix_rpc_core=trace,astrix_grpc_core=trace,consensus=trace,astrix_core=trace) 2>&1 | tee ~/astrix-node.log
In this command we set the loglevel to INFO.
