Nubit
Nubit
  • Overview
    • Introduction
  • BitVM
    • BitVM IDE
    • Learn More
  • Modular Indexer
    • Introduction
    • Developer Guide
      • API Documentation
        • Modular Indexer API
        • Light Client API
      • Wallet Integration Guide
    • Learn More
  • External resources
    • Github
    • Linktree
    • X (Twitter)
    • Telegram
    • Discord
Powered by GitBook
On this page
  • Set up the Full/Light Node
  • Set up the Environment
  • Set up the Environment
  • Synchronize with the Latest Block
  • Start the Full/Light Node
  1. Nubit DA
  2. Developer Guide
  3. Run a Node
  4. Advanced Configuration

Run a Full/Light Node

Last updated 5 months ago

The codebase is currently not public. We will be sharing more details about the node's role and functionality soon. We appreciate your patience and interest. Thank you for your understanding and continued support.

Note: Thanks to your contributions, cycle I of our TestNet Phase 3 journey has officially wrapped up! Now we're one step closer to onboarding the world to Bitcoin. Stay tuned for the next steps!


By following these steps, you should be able to successfully set up and start a Nubit Full/Light Node. If you encounter any issues, please provide detailed information, and further assistance will be provided.

Set up the Full/Light Node

Set up the Environment

Download the Necessary Repositories

Clone the nubit-node repository.

git clone -b nubit-alphatestnet-1 [email protected]:RiemaLabs/nubit-node.git
cd nubit-node

Note: The git clone command above already specifies the nubit-alphatestnet-1 branch of the nubit-node repository, which includes the latest version of the code.

When using git clone, you may need to temporarily comment out the UseKeychain fields in your ~/.ssh/config file. Specifically, comment out # IgnoreUnknown UseKeychain and # UseKeychain yes .

Make Build and Install

In the cloned repository directory, run the following command to install the CLI:

sudo make build install

Set up the Environment

Set Network and Custom Variables

Set up your environment by running the following commands:

Note: Set NODE_TYPE to light if you prefer to start a light node.

export VALIDATOR_IP=validator.nubit-alphatestnet-1.com
export NODE_TYPE=full
export NETWORK=nubit-alphatestnet-1
export FLAGS=" --p2p.network ${NETWORK} --core.ip ${VALIDATOR_IP} --metrics --metrics.endpoint otel.nubit-alphatestnet-1.com:4318"
export NUBIT_DATA_HOME="$HOME/.nubit-${NODE_TYPE}-${NETWORK}"

Clear Previous Data

Remove any existing data to ensure a clean setup:

rm -rf $NUBIT_DATA_HOME

Initialize the Node

To initialize the node, run the following command. This will automatically generate a nubit address along with its MNEMONIC. Please make sure to securely save the MNEMONIC as it will only appear once.

nubit $NODE_TYPE init --p2p.network $NETWORK

Synchronize with the Latest Block

To quickly sync to the latest block, a snapshot is provided and updated every 12 hours. Follow these steps:

Remove Old Data Directory

rm -rf $NUBIT_DATA_HOME/blocks $NUBIT_DATA_HOME/data $NUBIT_DATA_HOME/index $NUBIT_DATA_HOME/inverted_index $NUBIT_DATA_HOME/transients

Download the Snapshot

Download the snapshot using wget. The snapshot file for a full node is approximately 14.1GB and for a light node is 904MB, so ensure you have sufficient disk space available.

wget https://nubit-cdn.com/nubit-data/${NODE_TYPE}node_data.tgz

Extract the Snapshot

Extract the downloaded snapshot to update your node's data:

tar -zxf ${NODE_TYPE}node_data.tgz -C $NUBIT_DATA_HOME && rm -rf ${NODE_TYPE}node_data.tgz

Start the Full/Light Node

Finally, start the node with the command below:

Note: We request user to submit node metrics to our OTEL every 6 minutes. No private information would be leaked in this process.

nubit $NODE_TYPE start $FLAGS

The following message indicates a successfully running node.

/_____/  /_____/  /_____/  /_____/  /_____/ 

Started nubit DA node 
node version:   v0.1.0-rc.2-107-g3b1d506
node type:      full
network:        nubit-alphatestnet-1

/_____/  /_____/  /_____/  /_____/  /_____/

This will update your node to a recent state. Keep it running to ensure it syncs to the latest block. For the most current block information, please visit the chain explorer at .

explorer.nubit.org
Save your Nubit Address and Mnemonic Carefully!
https://github.com/RiemaLabs/nubit-node/tree/nubit-alphatestnet-1github.com
Please Contact Nubit Team to Get Access to the Repository
LogoNubit Explorer
Visit Nubit Alpha Testnet Explorer to Check the Latest Block