cosmscan/cosmscan-rs

(WIP) Cosmscan is indexer for cosmos based blockchain.

⚠️ Caution ⚠️

Cosmscan is not ready to go in production.

This is very rapidly changed and under developement.

Cosmscan

Opensource indexer engine & explorer web for cosmos blockchain.

Motivation

In ethereum, Blockscout is best opensource blockchain explorer, as you can see here It seems super-duper enterprise level blockchain explorer, and the cool thing is that it's open source!

But, In cosmos ecosystem there is no fansy opensource explorer. So then many teams rely on validators who built un-opened blockchain explorer such as mintscan.

Therefore, I wished to build opensource blockchain explorer and anyone can install their own server. It would be very helpful for teams to only focus on developing appchain.

Setting up the Database.

Install diesel

# if you're on linux OS, must install prerequisite of postgresql dev tools,
$ sudo apt install libpq-dev

# install diesel
$ cargo install diesel_cli --no-default-features --features postgres

Create set of tables.

$ cd models && diesel migration run && cd ..

If you want to create tables to remote database, not local, Change the DSN in models/.env file before running the above command

Revoke migration

$ diesel migration redo

Run on localhost for test

# this command runs simple gaiad app & postgres database
# when you run services via this scripts, sample tx will be automatically sent every seconds.
$ docker-compose -f docker-compose.flood.yml up

# migrate schema
$ cd models && diesel migration run && cd ..

# this start to run explorer runtime application
$ RUST_LOG=info cargo run --bin indexer -- --filename config.toml

Contribution Guidelines

Feel free to open an issue or pull request.

cosmscan-rs's Issues

Use hyper uri parsing

url::Url::parse() func cannot parse uri string without base endpoint

Find a way to determine whether the transaction is succeeded or not

We could store the result of transaction which is categorized as succeded and failed.

Change concurrency package `tokio` -> `crossbeam`

e2e test environment

Provide a simpler way to test the services (engine and api-server) like below.

$ cd e2e
$ docker-compose up

Then it starts all the component we need to test.

Periodically fetch validator set

First Milestone API Server Implementation

Endpoints to be implemented.

• GET /api/chains

---

• GET /api/block/by_height/{height}
• GET /api/block/latest_height
• GET /api/block/list?skip=0&limit=50

---

• GET /api/transaction/{hash}
  • the response includes messages and events
• GET /api/transaction/list/by_height/{height}

Use `sqlx` instead of `diesel-rs`

After few days using diesel in our data store.

I feels that I cannot fully control what will happens to our database.

I decided to migrate from diesel-rs to sqlx

Tendermint에는 기록되었는데 Cosmos에는 아직 기록되지 않은 시차 발생

Tendermint에 블록이 생성되자마자 블록에 담긴 트랜잭션을 코스모스 gRPC로 질의하면 에러가 나는 경우가 있음
원칙적으로는 Tendermint는 블록체인의 하위 레이어에 해당하고 코스모스는 상위레이어이니 이 둘 사이에 동기화 되는 시차가 약간 있는듯

Rename engine -> indexer

Configure CORS policy to be accessed from the different host

Background

API server is inherently designed as standalone server
It wouldn't contains any frontend sources

So, if frontend website is needed to access to our server
We must allow different host to access to the api server

Details

• Add allowed_host to the config.toml
  • "*" means any website, if specific host is needed, then wite hostname like http://localhost:3000/
• Write response with header Access-Control-Allow-Origin for each api handlers.

Change server framework `hyper` to `actix-web`

we should change the hyper to actix-web for more productivity.

Periodically fetch summary info from the blockchain

• Total Supply
• Ratio of Bonded / Unbonded
• Inflation rate
• Community pool size
• Number of active validators

Serve REST API

• /block/{hash}
• /blocks?start=2&limit=50&sort=desc
• /blocks?top=50
• /txes_in_block/{hash}
• /tx/{hash}