How to Run an sBTC Signer
This documentation provides guidelines, best-practices and recommendations for running an sBTC Signer. Review it and adapt it to your infrastructure policy before deploying it.
Minimum System Requirements
Below are the minimum required specs to be able to run a sBTC signer.
2 CPU
4GB memory
50GB storage
Note that these are in addition to the hardware requirements for running a Stacks node and Bitcoin node outlined in the How to Run a Signer doc.
1. Configure your Bitcoin node
Minimum version
You will need bitcoind
version 25 or higher.
Settings
Your Bitcoin node must include these settings for sBTC signer operation:
txindex=1
: Transaction indexing must be enabledserver=1
: RPC server must be enabledzmqpubhashblock=tcp://*:28332
: ZMQ block hash notificationszmqpubrawblock=tcp://*:28332
: ZMQ raw block notifications
ZeroMQ (ZMQ) Configuration
The ZeroMQ configuration specified above enables real-time blockchain event notifications from Bitcoin Core to the sBTC signer.
The two required ZMQ endpoints serve distinct purposes:
zmqpubhashblock
: Broadcasts only block hashes for lightweight block detectionzmqpubrawblock
: Broadcasts complete block data for transaction processing
This notification system creates a direct event stream when:
Bitcoin Core validates a new block
Block data publishes via ZMQ
Signer processes relevant sBTC transactions
Example
2. Configure your Stacks node
Minimum version
Please ensure your Stacks version is up-to-date (using the latest release).
Event observer
You will need to add a new event observer that relays information from the sBTC smart contracts to the sBTC signer:
Reference configuration
See here.
3. Configure your sBTC Signer
The signer configuration file (signer-config.toml
) defines the signer's operation parameters. The configuration sections include:
Blocklist Client Settings
Bitcoin Connection Settings
Defines how the signer connects to Bitcoin Core:
Core Signer Parameters
Defines the signer's identity and network participation:
P2P Network Configuration
Controls how the signer communicates with other network participants:
The signer operates on port 4122 by default and supports both TCP and QUIC protocols for peer communication. The signer will attempt QUIC connections first for improved performance, automatically falling back to TCP if QUIC is unavailable or blocked on the network.
Reference configuration
See here.
4. Set up your containers
See here for a Docker Compose including all the required components.
Monitoring
Monitoring Details TBD
Troubleshooting
Troubleshooting Guide TBD
Last updated