About CKB

CKB is the layer 1 of Nervos Network, a public/permissionless blockchain. CKB uses Proof of Work and improved Nakamoto concensus to achieve maximized performance on average hardware and internet condition, without sacrificing decentralization and security which are the core value of blockchain.

CKB Explorer

CKB Explorer is a Nervos CKB blockchain explorer built with React and Ruby on Rails.

It supports searching block, transaction, address and includes two parts: frontend and backend server.

CKB Explorer Server

A blockchain explorer cache server of Nervos CKB.

Prerequisites

PostgreSQL 9.4 and above
Redis 4.0.9 and above
libsodium
secp256k1

  $ git clone https://github.com/bitcoin-core/secp256k1.git && cd secp256k1 && ./autogen.sh && ./configure --enable-module-recovery --enable-experimental --enable-module-ecdh && make && sudo make install && cd ..

Optional prerequisites

If you want to contribute to the API documentation you need to install raml2html to generate HTML documentation.

Initial Project

$ cd ckb-explorer/
$ touch .env.local (overwrite `.env` config if you need in `.env.local`, such as DB_USERNAME, DB_PASSWORD...)
$ touch config/settings.local.yml (overwrite `config/settings.yml` to config available hosts)
$ bin/setup

Running Test

$ bundle exec rails test

Run Project

$ bundle exec rails s

# start sync process
$ ruby lib/ckb_block_node_processor.rb

Deploy

You can deploy this via mina

$ mina setup
$ mina staging deploy

How to Contribute

CKB Explorer Server is an open source project and your contribution is very much appreciated. Please check out CONTRIBUTING.md for guidelines about how to proceed.

Build API Documentation

$ cd ckb-explorer
$ raml2html doc/api.raml > public/api_doc.html

API Documentation

Please see this Documentation.

License

CKB Explorer is released under the terms of the MIT license. See COPYING for more information or see https://opensource.org/licenses/MIT.

consenlabs / ckb-explorer