Skip to content

setup-with-snapshot.md

Latest commit

 

History

History
132 lines (81 loc) · 3.3 KB

setup-with-snapshot.md

File metadata and controls

132 lines (81 loc) · 3.3 KB

Snapshot Guide

This guide explains how to use pre-synced snapshots to quickly set up Maestro Symphony and Bitcoin Core, avoiding the time-consuming initial chain synchronization.

Overview

Snapshots allow you to bootstrap your Symphony indexer with pre-synchronized data:

  • Bitcoin node snapshots: Pre-synced Bitcoin Core blockchain data
  • Symphony snapshots: Pre-indexed blockchain data and database state

Prerequisites

Available Snapshots

Networks supported:

  • mainnet
  • testnet4
  • regtest

Snapshots

Bitcoin

Symphony

Testnet setup example

1. Prepare Directories

The following are to be excuted within maestro-symphony repo directory.

mkdir -p ./tmp/{symphony-data,bitcoin-data}

2. Download Snapshots

Bitcoin node snapshot:

curl -L https://snapshots.gomaestro.org/bitcoin-node/testnet/snapshots/20250827.tar.lz4 | \
 lz4 -d | tar -xf - -C ./tmp/bitcoin-data

Symphony snapshot:

curl -L https://snapshots.gomaestro.org/symphony/testnet/snapshots/20250927.tar.lz4 | \
  lz4 -d | tar -xf - -C ./tmp/symphony-data

3. Start Services

make COMPOSE_FILE=docker-compose.yml compose-up

Verification

Once the services are started, verify the setup:

Check Symphony Status

curl http://localhost:8080/addresses/tb1qw508d6qejxtdg4y5r3zarvary0c5xw7kxpjzsx/utxos | jq '.indexer_info'

Stop Services

When you are finished interacting with Symphony, be sure to stop the services as well.

make compose-down

Troubleshooting

Disk Space

Ensure sufficient disk space:

  • Testnet: ~5GB for Symphony + ~50GB for Bitcoin node
  • Mainnet: ~100GB for Symphony + ~600GB for Bitcoin node

Snapshot Age

If snapshots are older than expected:

  • Symphony will automatically sync missing blocks
  • Bitcoin Core will resume from snapshot point
  • Initial startup may take longer for older snapshots

Updating Snapshots

Snapshots are updated regularly. To use a newer snapshot:

  1. Stop Docker services
  2. Backup any important data
  3. Remove old data directories
  4. Download and extract new snapshots
  5. Restart Docker services

Note: Ensure that no other bitcoin node containers are running as this may cause conflicts.

🎉 You’re Done!

You have now walked through a guide on how to load both a Symphony and Bitcoin snapshot.

Be sure to check out Maestro's additional services for further assisting your development of building on Bitcoin.

Support

For issues with snapshots: