Federated Node Overview
This document describes how one can set up their own Counterparty Classic “Federated Node” system on Linux.
A Federated Node is a self-contained system that runs the some or all of the Counterparty Classic software stack, via Docker. Each system operates as a Bitcoin and Counterparty “full node”. Using this toolset, one can generally get started running the Counterparty software much quicker and more easily than a manual installation of the various components.
The document is primarily intended for power users and developers.
If you would like to run a federated node on Windows or OS X, or would like a bit more details on the fednode and additional components beyond the base install that you can configure, you can find the full installation guide on our github.
Hardware / OS requirements
- Memory: 4GB RAM (base), 8GB+ RAM (full stack)
- Disk space: ~881GB (mainnet), ~205GB (testnet)
- Bitcoin: ~720GB (mainnet), ~163GB (testnet)
- Addrindexrs: ~152GB (mainnet), ~40GB (testnet)
- Counterparty: ~9GB (mainnet), ~2GB (testnet)
- OS: Please note that Ubuntu Linux is the recommended OS at this time, as most of our testing is performed on it. Windows and OS X support is considered in BETA.
- Linux: We recommend Ubuntu 22.04 LTS 64-bit, but other, modern versions of Linux should work, as long as they support the newest released version of Docker
Installation
On Linux and OS X, install as a non-root sudo-er from home directory.
Update system and install dependencies
sudo apt-get update && sudo apt-get upgrade
sudo apt-get -y install git curl coreutils docker.io docker-compose
Clone and checkout the code
git clone https://github.com/Counterparty-Classic/counterparty-classic-fednode.git
cd counterparty-classic-fednode
sudo ln -sf `pwd`/fednode.py /usr/local/bin/fednode
Build and link the docker containers
fednode install base master
Wait for initial sync
After installation, the services will be automatically started.
To check the docker container status:
fednode ps
To check the service statuses you can :
fednode tail bitcoin
fednode tail counterparty-classic-addrindexrs
fednode tail counterparty-classic