Skip to content
SteakFisherPublic

About

A Double Entry ledger with readable accounts that keeps TigerBeetle's speed

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Torment

A ledger service on top of TigerBeetle. Callers name accounts with readable addresses such as rider:123:wallet and accounting types such as liability. Torment maps them to TigerBeetle accounts, so a write path that needs only TigerBeetle keeps TigerBeetle's speed.

  • TigerBeetle holds balances and transfers.
  • Postgres holds currencies, kinds, accounts and the mapping from each wallet to its TigerBeetle account.

Docs: run make docs and open localhost:4321, or read the Markdown in docs/src/content/docs. Start with the introduction, which also compares Torment with Formance, and the quickstart.

Running locally

You need Go 1.26 and Docker.

make up      # Postgres 17, TigerBeetle 0.17.9 (dev and test clusters), RabbitMQ and TigerBeetle's CDC job
make run     # migrates the database, then serves on :8080 with the API key dev-key
make test    # unit and integration tests; integration tests use the torment_test database, the tigerbeetle-test cluster and RabbitMQ's *-test vhosts
make bench   # ledger benchmarks into bench/new.txt; trust queries/op and allocs/op, ns/op only before/after on one laptop
make cdc     # runs the event exporter (torment cdc)
make e2e     # runs the curl flow in scripts/e2e.sh against the running server and exporter
make docs    # the docs site at localhost:4321 (needs Bun)
make down

Without the containers, run only the unit tests: TEST_DATABASE_URL= go test ./....

Configuration

Variable
DATABASE_URL Postgres connection string. Required
TB_ADDRESS TigerBeetle address, such as 3000 or 10.0.0.1:3000. Required
API_KEYS comma-separated API keys. Required. Several keys let you rotate one without downtime
ADDR listen address. Default :8080
CDC_SOURCE_URL, CDC_EVENTS_URL RabbitMQ vhosts the exporter reads from and publishes to. Required by torment cdc only

The Makefile sets all of these for development. The Dockerfile builds a production image.

Layout

cmd/torment        wiring: config, Postgres, TigerBeetle clients, HTTP server
internal/ledger    the domain: accounts, wallets, transfers, queries
internal/db        Postgres store, migrations, sqlc queries
internal/httpapi   routes, JSON and the mapping from error codes to statuses
internal/apijson   the transfer JSON shared by the API and the event export
internal/cdc       the event exporter: TigerBeetle CDC messages in, named events out
rabbitmq           RabbitMQ vhosts, users, exchanges and queues
scripts            e2e flow, test database setup
docs               the docs site (Astro Starlight)

About

A Double Entry ledger with readable accounts that keeps TigerBeetle's speed

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages