mintscan-binance-dex-backend

mintscan-binance-dex-backend copied to clipboard

Mintscan Explorer's Backend for Binance Chain

:star: Developed / Developing by Cosmostation

Overview

This project is sponsored by Binance X Fellowship Program. The program supports talented developers and researchers in creating free and open-source software that would enable new innovations and businesses in the crypto community.

This repository provides backend code for Mintscan Block Explorer for Binance Chain, and you can find frontend code in this repository.

Note that this repository has just transitioned from the actively developing phase to the maintaining phase starting from the first official version v1.0.0. All intended functionality is implemented; however, it can always go back when there is a reason to go back.

Prerequisite

• Requires Go 1.14+

• Prepare endpoints for Binance Chain Node RPC and API Server

• Prepare PostgreSQL Database

Folder Structure

/
|- chain-exporter
|- mintscan
|- stats-exporter

Chain Exporter

chain-exporter watches a full node of Binance Chain and export chain data into PostgreSQL database.

Mintscan

mintscan provides any necesarry custom APIs.

Stats Exporter

stats-exporter creates cron jobs to export market data to build chart history API.

Configuration

For configuration, it uses human readable data-serialization configuration file format called YAML.

To configure chain-exporter | mintscan | stats-exporter, you need to configure config.yaml file in each folder. Reference example.yaml.

Note that the configuration needs to be passed in via config.yaml file, so make sure to change the name to config.yaml.

Install

Git clone this repo

git clone https://github.com/cosmostation/mintscan-binance-dex-backend.git

Build by Makefile

cd mintscan-binance-dex-backend/chain-exporter
make build

cd mintscan-binance-dex-backend/mintscan
make build

cd mintscan-binance-dex-backend/stats-exporter
make build

Database

This project uses Golang ORM with focus on PostgreSQL features and performance. Once chain-exporter begins to run, it creates the following database tables if not exist already.

• Block
• PreCommit
• Transaction
• Validator

Contributing

We encourage and support an active, healthy community of contributors — any contribution, improvements, and suggestions are always welcome! Details are in the contribution guide

Contributors ✨

Thanks goes to these wonderful people (emoji key):

JayB 💻 📖 📆 ⚠️ 🚧

fl-y 💻 🤔

hyeryeong-lim 🎨

This project follows the all-contributors specification. Contributions of any kind welcome!

Our Services and Community

• Official Website
• Mintscan Explorer
• Web Wallet
• Android Wallet
• iOS Wallet
• Telegram - International

License

Released under the Apache 2.0 License.