Mirror

This repo mirrors from THORChain Gitlab to Github. To contribute, please contact the team and commit to the Gitlab repo:

https://gitlab.com/thorchain/midgard

Midgard is a layer 2 REST API that provides front-end consumers with semi real-time rolled up data and analytics of the THORChain network. Most requests to the network will come through Midgard. This daemon is here to keep the chain itself from fielding large quantities of requests. You can think of it as a “read-only slave” to the chain. This keeps the resources of the network focused on processing transactions.

The daemon needs PostgreSQL with the TimeScale extension.

docker-compose up --build -d pg

If you don't have a THOR node to connect to use the mock.

docker-compose up -d thormock

Now you can launch a local instance directly from the sources.

go run ./cmd/midgard cmd/midgard/config.json

Midgard populates the database with content from the blockchain. Progress is traceable with the Prometheus Metrics propagated on http://localhost:8080/metrics, specifically the measurements midgard_chain_cursor_height v.s. midgard_chain_height.

Open http://localhost:8080/v2 in your browser for the GraphQL UI. ✨

docker-compose up -d thormock
go test ./...

Alternatively, you may omit the database tests with go test -short ./....

Implement the event.Listener callback to read the THORChain in a structural way. See ./cmd/midgard/main.go for a configuration example.

The chain package reads the blockchain in choronological order. Blocks are parsed with events and persisted with internal/timeseries. The RDBM is almost a one-to-one mapping of the key-value entries from the THORChain. Aggregated values and tables are created separately in aggregate.go.

Package internal/api defines the HTTP interface. See internal/graphql for the query facilities (provided by internal/timeseries/stat).

Blocks are “committed” with an entry in the block_log table, including a block_timestamp. Queries give consistent [cachable] results when executed with a (time) stat.Window within timeseries.LastBlock.