Skip to main content

Quickstart

Get a BTX node running in five minutes.

Updated: 2026-03-30 Edit on GitHub View as Markdown

This page walks you from zero to a running BTX mainnet node in the fewest steps possible. See Installation for full dependency and build-option details.

1. Build

Install dependencies for your platform (see Installation), then:

git clone https://github.com/AizelNetwork/btx-node.git && cd btx-node
cmake -B build-btx
cmake --build build-btx -j$(nproc)

On macOS, replace $(nproc) with $(sysctl -n hw.ncpu).

2. Start the Node

Launch btxd in daemon mode on mainnet:

./build-btx/bin/btxd -daemon -server

The node begins syncing the blockchain immediately. Data is stored in:

  • Linux: ~/.btx/
  • macOS: ~/Library/Application Support/BTX/

Default network ports:

PortPurpose
19335P2P (peer connections)
19334JSON-RPC

3. Check Sync Status

Use btx-cli to query the running node:

./build-btx/bin/btx-cli getblockchaininfo

Key fields to watch:

  • blocks — current chain height your node has validated
  • headers — highest header seen from peers
  • verificationprogress — approaches 1.0 when fully synced

For just the block count:

./build-btx/bin/btx-cli getblockcount

4. Create a Wallet

Create a new descriptor wallet:

./build-btx/bin/btx-cli createwallet "mywallet"

5. Get a Receiving Address

./build-btx/bin/btx-cli getnewaddress

This returns a new BTX address you can share to receive funds.

6. Check Mining Info

View current mining and difficulty state:

./build-btx/bin/btx-cli getmininginfo

Key fields:

  • blocks — current chain height
  • difficulty — current MatMul PoW difficulty
  • networkhashps — estimated network hash rate

7. Stopping the Node

Gracefully shut down the daemon:

./build-btx/bin/btx-cli stop

Next Steps