chetlahet001 / blockatlas

Clean and lightweight cross-chain transaction API

Home Page:https://trustwallet.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Block Atlas by Trust Wallet

Build Status Codacy Badge Go Report Card

Clean explorer API for crypto currencies.

Supported Coins

Setup

Quick start

Deploy it in less than 30 seconds!

From Source (Go Toolchain required)

go get -u github.com/trustwallet/blockatlas
cd blockatlas
go build -o blockatlas ./cmd && ./blockatlas api --config=config.yml

With Docker

docker run -it -p 8420:8420 trustwallet/blockatlas

Tools

  • Setup Redis
brew install redis // Install Redis using Homebrew
ln -sfv /usr/local/opt/redis/*.plist ~/Library/LaunchAgents  // Enable Redis autostart
  • Running in the IDE ( GoLand )
  1. Run
  2. Edit configuration
  3. New Go build configuration
  4. Select directory as configuration type
  5. Set api as program argument and -i as Go tools argument

Deploy

Supported platforms

Deploy

Docker

Block Atlas can run just fine without configuration.

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 File

By default, config.yml is loaded from the working directory.

Example (config.yml):

nimiq:
  api: http://localhost:8648
#...

Environment

The rest gets loaded from the environment variables. Every config option is available under the ATLAS_ prefix.

Example:

ATLAS_NIMIQ_API=http://localhost:8648 \
blockatlas

Authors

Contributing

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.

About

Clean and lightweight cross-chain transaction API

https://trustwallet.com

License:MIT License


Languages

Language:Go 98.5%Language:Makefile 1.3%Language:Dockerfile 0.2%