BlockAtlas is a clean explorer API and transaction observer for cryptocurrencies.
BlockAtlas connects to nodes or explorer APIs of the supported coins and maps transaction data, account transaction history and market data into a generic, easy to work with JSON format. It is in production use at the Trust Wallet app, the official cryptocurrency wallet of Binance. Also is in production at the BUTTON Wallet, Telegram based non-custodial wallet. The observer API watches the chain for new transactions and generates notifications by webhooks.
# Download source to $GOPATHgo get -u github.com/trustwallet/blockatlascd $(go env GOPATH)/src/github.com/trustwallet/blockatlas# Start Observer with the path to the config.yml ./go build -o observer-bin cmd/observer/main.go && ./observer-bin -c config.yml# Start API server at port 8422 with the path to the config.yml ./go build -o api-bin cmd/api/main.go && ./api-bin -p 8422 -c config.yml# Start sync worker for market prices and rates with the path to the config.yml ./go build -o syncmarkets-bin cmd/syncmarkets/main.go && ./syncmarkets-bin -c config.yml
Build and run from local Dockerfile:
You should change
For run api, observer and syncmarkets:
If you need to start one service:
docker-compose start api redisdocker-compose start observer redisdocker-compose start syncmarkets redis
Block Atlas can run just fine without configuration. By default, all coins offering public RPC/explorer APIs are enabled.
If you want to use custom RPC endpoints, or enable coins without public RPC (like Nimiq), you can configure Block Atlas over
config.yml or environment variables.
Config is loaded from
config.yml if it exists in the working directory. The repository includes a default config for reference with all available config options.
The rest gets loaded from environment variables. Every config option is available under the
ATLAS_ prefix. Nested keys are joined via
Swagger API docs provided at path
After creating a new route, add comments to your API source code, See Declarative Comments Format.
Download Swag for Go by using:
$ go get -u github.com/swaggo/swag/cmd/swag
Run the Swag in your Go project root folder.
$ swag init -g ./cmd/api/main.go -o ./docs
The Blockatlas can collect and expose by
expvar's, metrics about the application healthy and clients and server requests. Prometheus or another service can collect metrics provided from the
To protect the route, you can set the environment variables
METRICS_API_TOKEN, and this route starts to require the auth bearer token.
If you'd like to add support for a new blockchain, feel free to file a pull request. Note that most tokens that run on top of other chains are already supported and don't require code changes (e.g. ERC-20).
The best way to submit feedback and report bugs is to open a GitHub issue. Please be sure to include your operating system, version number, and steps to reproduce reported bugs.
More resources for developers are in CONTRIBUTING.md.