README.md

Relay

A lightweight transaction relay service for BSV development that funds fees and broadcasts transactions.

Improvements

• regular fee handling without queue for quick testing
• docker compose have some issue (with key being duplicated)
• make a file upload endpoint so that anyone can just upload file
• make a text upload endpoint so that anyone can just upload file (optional)

Goal

Reduce repetitive tasks like fee handling and broadcasting, so you can get started in under a minute.

Keys Info

• Keys live under the .key directory: .key/wif.txt
• Automatically generated files:
  • .key/wif.txt
  • .key/mnemonic.txt
  • .key/address.txt
  • .key/pubkey.txt

To use an existing key, just place wif.txt in the .key directory. Only WIF is required.

---

How to Start

Minimal setup (3 necessary + 1 optional):

1. Add your key wif.txt in the .key directory (optional; the server will generate one if not present).

2. Add arc.token in config.yaml according to the network (mainnet or test).

3. Rename the example config:

   mv config.example.yaml config.yaml

4. Start the services using Docker or Podman:

   docker-compose up --build
   # or
   podman-compose up --build

---

Configuration

• Port: 8080 (default)
• Database: SQLite (default database.db), persisted via Docker volume
• Fee rate: fee.sat_per_byte = 100 (as of Nov 15) — change only if policy changes
• Taal ARC token: required, set in config.yaml

For current fee rates:

curl --location 'https://arc.taal.com/v1/policy' | jq

---

Notes on Volumes

• .key directory is mounted to persist keys:

  volumes:
    - ./key:/app/.key

• SQLite database is persisted via volume:

  volumes:
    - sqlite_data:/app/database.db

• RabbitMQ data is persisted via volume:

  volumes:
    - rabbitmq_data:/var/lib/rabbitmq

With these volumes, your keys, database, and RabbitMQ state survive container restarts.

---

happy hacking <3