Run a Glittr Node

This guide is written for running a Glittr node on testnet4, on a linux-based system.

Make sure you have access to testnet bitcoin, read the following guide on running bitcoin node

Run a Bitcoin Node

Requirements

Install system dependencies (Ubuntu/Debian):

sudo apt install clang build-essential

Install Rust toolchain (https://doc.rust-lang.org/cargo/getting-started/installation.html):

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source $HOME/.cargo/env  # Load Rust into current shell

Installation

1. Clone the repository

git clone https://github.com/Glittrfi/glittr-core-public
cd glittr-core
git checkout testnet

1. Build the project

cargo build --release --features helper-api

The compiled binary will be available at ./target/release/glittr

Configuration

Create a settings.yaml file in your project directory:

btc_rpc_url: http://127.0.0.1:48332
btc_rpc_username: root
btc_rpc_password: root
rocks_db_path: db_data
api_url: 127.0.0.1:3001

Configuration Options

Option	Description	Default
btc_rpc_url	Bitcoin RPC endpoint URL	http://127.0.0.1:48332
btc_rpc_username	Bitcoin RPC authentication username	-
btc_rpc_password	Bitcoin RPC authentication password	-
rocks_db_path	Local storage path for the node database	db_data
api_url	Glittr node API listening address	127.0.0.1:3001

Running the Node

Start the Glittr node:

$ ./target/release/glittr

[2025-01-07T07:45:59Z INFO  glittr::indexer] Indexer start
[2025-01-07T07:45:59Z INFO  glittr::indexer] Indexing start
[2025-01-07T07:45:59Z INFO  glittr::api] API is listening on 127.0.0.1:3001
[2025-01-07T07:45:59Z INFO  glittr::indexer] Indexing block 0: 00000000da84f2bafbbc53dee25a72ae507ff4914b867>
[2025-01-07T07:45:59Z INFO  glittr::indexer] Indexing block 1: 0000000012982b6d5f621229286b880e909984df669c2>
[2025-01-07T07:45:59Z INFO  glittr::indexer] Indexing block 2: 000000001fed1a914651afc36574003c5300cac5df738>
[2025-01-07T07:45:59Z INFO  glittr::indexer] Indexing block 3: 000000008ddb4258595f9d8079a0b83fdc2816c9e3511>
[2025-01-07T07:45:59Z INFO  glittr::indexer] Indexing block 4: 000000008f5794caa45c418a0184303e848e9d6756e4d>
[2025-01-07T07:45:59Z INFO  glittr::indexer] Indexing block 5: 00000000ccefd2182ad4bb311c866233d32aae0a85f95>

If you can see "Indexing block ..." then you have successfully run the Glittr node.