Arch Node

Welcome Arch Node Validators! This repository is your go-to resource for downloading, setting up, and running an Arch validator node on Arch Network. Here you will find binaries for multiple platforms, docker images and detailed instructions on how to configure and run your node.

Supported Platforms

We provide pre-compiled binaries for the following platforms:

• aarch64-apple-darwin (MacOS ARM64)
• aarch64-unknown-linux-gnu (Linux ARM64)
• x86_64-apple-darwin (MacOS x86_64)
• x86_64-unknown-linux-gnu (Linux x86_64)
• Docker

Installation

1. Download the Binary: Navigate to the Releases section and download the binary suitable for your platform. URL: https://github.com/Arch-Network/arch-node/releases

2. Set Executable Permission: After downloading, change the permissions to make the binary executable:

   chmod +x path/to/arch-node

3. Additionally, you can use the pre-built docker images to run arch-node. Check docker for more details.

Usage

To start your node, run the binary with the following command. Replace the bitcoin RPC parameters according to your environment:

./path/to/arch-node --network-mode testnet --bitcoin-rpc-endpoint "192.168.1.100" --bitcoin-rpc-port 18332 --bitcoin-rpc-username "user" --bitcoin-rpc-password "pass" --bitcoin-rpc-wallet "mywallet"

To find details about all configuration parameters, run arch-node with --help:

./path/to/arch-node --help

Configuring Your Node

You can customize the behavior of your Arch node using the following command-line arguments:

• --network-mode: Network mode (options: mainnet, testnet, devnet; default: devnet).
• --boot-node-endpoint: Specify the bootnode endpoint URL. The bootnode coordinates network activities and helps in propagating information across the network, during Arch Node startup initial info about Arch Network is fetched from the bootnode. If you omit this parameter, the default bootnode for the current network (testnet, mainnet) will be used.
• --data-dir: Path to the data directory (default: ./arch_data).
• --prover-endpoint: URL of the ZKVM prover endpoint. ZKVM Prover is responsible for executing programs and generating ZKVM proofs that are validated by Arch Network Validators. If you omit this parameter, the default bootnode for the current network (testnet, mainnet) will be used.

Bitcoin Integration

The Arch node uses the Bitcoin network as a source of truth. A coordinator - elected among validators of the Arch Network - writes any state changes to the Bitcoin network by sending transactions to the Bitcoin node. All remaining nodes nodes integrate with the Bitcoin network to read and validate ownership of Bitcoin UTXOs.

• --bitcoin-rpc-endpoint: Bitcoin RPC server IP address (default: 127.0.0.1).
• --bitcoin-rpc-port: Port of the Bitcoin RPC server (default: 8332).
• --bitcoin-rpc-username: Username for Bitcoin RPC authentication.
• --bitcoin-rpc-password: Password for Bitcoin RPC authentication.
• --bitcoin-rpc-wallet: Bitcoin wallet name (default: testwallet).

RPC Server Configuration

• --rpc-bind-ip: IP address to bind the RPC server (default: 127.0.0.1).
• --rpc-bind-port: Port to bind the JSON-RPC HTTP server. (default: 9001).

testnet4

When running on --network-mode testnet, the Bitcoin node available through the configured endpoint must be running on the newest tesnet4 network. Currently, the changes introducing testnet4 are not yet merged to Bitcoin's mainstream.

For the time being, you must manually compile Bitcoin with testnet4 support:

git clone https://github.com/bitcoin/bitcoin.git
cd bitcoin
git fetch origin pull/29775/head:pr-29775
git checkout pr-29775

./autogen.sh
./configure --with-incompatible-bdb
make -j $(nproc)

Alternatively, you can run Bitcoin with testnet4 support in a Docker container. Information on how to set up a testnet4 container is available here.

Hardware Requirements

Combined Hardware Requirements for Running Both a Bitcoin Full Node and an Arch Node

For users intending to operate both a Bitcoin Full Node and an Arch Node on the same machine, the following specifications are recommended to handle the demands of both nodes efficiently:

• Operating System: Linux or MacOS. These systems are compatible with the software used by both nodes.

• Processor (CPU): Any modern CPU with a clock speed of around 2.5 GHz is sufficient for standard operations.

• Memory (RAM): At least 32 GB of RAM is recommended.

• Disk Space: A combined total of at least 2 TB of SSD storage is necessary. This space will accommodate the full Bitcoin blockchain and the additional data from the Arch Node.

• Bandwidth: Internet connection with at least 3 megabytes per second upload and download speed is advisable. This increased bandwidth supports the data transmission requirements of both nodes, especially important when the network traffic is high.

By adhering to these enhanced specifications, users can ensure that both their Bitcoin and Arch Nodes operate effectively, contributing to the stability and security of both networks.

Hardware Requirements for Running an Arch Node

To ensure optimal performance of an Arch Node the following hardware specifications are recommended:

• Operating System: Linux or MacOS.

• Processor (CPU): Any modern CPU with a clock speed of around 2.5 GHz is sufficient for standard operations.

• Memory (RAM): At least 16 GB of RAM is recommended to ensure smooth operation.

• Disk Space: A minimum of 1 TB of SSD storage is required to manage the blockchain data and logs. This allows for adequate storage of historical data and ensures quick data retrieval and processing.

• Bandwidth: A stable internet connection with a minimum of 2 megabytes per second upload and download speed is necessary to handle network communications and data transmission reliably.

Hardware Requirements for Running a Full Bitcoin Node

For the most up-to-date information on running a full Bitcoin Node, please visit Bitcoin.org.

Validator Mode

By default, the node runs in validator mode. On the initial run, the node automatically generates a public-private key pair, essential for node identification and secure communication within the network. This key is by default located in the file secret_key in the folder arch_data. To change the default folder pass --data-dir argument when running Arch Node.

Log Outputs

On successful startup of Arch Node you should see the following logs:

[2024-06-13T13:10:45Z WARN  rpc::node::key::exchange] Boot node key exchange is not done yet. Will try again.
[2024-06-13T13:10:50Z WARN  rpc::node::key::exchange] Boot node key exchange is not done yet. Will try again.
[2024-06-13T13:10:55Z WARN  rpc::node::key::exchange] Boot node key exchange is not done yet. Will try again.
[2024-06-13T13:11:00Z INFO  rpc::node::key::exchange] Nodes ready: 2/2
[2024-06-13T13:11:00Z INFO  arch_node] Waiting for boot node to become available...
[2024-06-13T13:11:00Z INFO  arch_node] Boot node is ready!
[2024-06-13T13:11:00Z INFO  arch_node] USING BITCOIN RPC ENDPOINT : https://bitcoin-node.dev.aws.archnetwork.xyz:18443
[2024-06-13T13:11:00Z INFO  arch_node] USING BITCOIN WALLET : testwallet
[2024-06-13T13:11:00Z INFO  arch_node] USING ZKVM ENDPOINT : http://127.0.0.1:8001
[2024-06-13T13:11:00Z INFO  arch_node] ARCH-NODE ID : 2
[2024-06-13T13:11:00Z INFO  arch_node] STARTING RPC SERVER...
[2024-06-13T13:11:00Z INFO  rpc] [Node 2] Syncing processed txs...
[2024-06-13T13:11:00Z INFO  rpc] [Node 2] Syncing UTXO Data...
[2024-06-13T13:11:00Z INFO  rpc] [Node 2] Syncing UTXO Auth...
[2024-06-13T13:11:00Z INFO  rpc] [Node 2] Syncing programs...
[2024-06-13T13:11:01Z INFO  arch_node] RPC SERVER STARTED! PUBLIC ADDRESS : http://127.0.0.1:9002