An implementation of a full Bitcoin Block Explorer (Parser/API/Sockets) with full Colored-Coins capabilities
JavaScript CSS HTML
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.ebextensions
app
bin
config
routes
test
.gitignore
.travis.yml
README.md
app.js
contributors.txt
nodemon.json
package.json
startup.js

README.md

Colored Coins Block-Explorer

Build Status Coverage percentage NPM version Dependency Status Slack Channel

js-standard-style

The ColoredCoins Block Explorer server

System Requirements

  1. Bitcoind that runs as an RPC server with txindex=1
  2. Mongodb
  3. At least a 1.5TB hard-drive (The current size of the data is around 1TB, as of November 2016)

Installation

$ npm i -g cc-block-explorer

Run

You can run the Block Explorer with the following options:

  cc-explorer [options]

  Options:

    -h, --help                                         output usage information
    -V, --version                                      output the version number
    -p, --port <port>                                  Port to listen on [$PORT or 8080/8081]
    -s, --ssl <key-file-path> <certificate-file-path>  Enable ssl
    -c, --conf <config-file-path>                      Load a custom configuration file

Or just run it with the defaults using:

$ cc-explorer

Properties

The propeties to provide:

  • Empty uncommented properites are MANDATORY
  • Commented properties are OPTIONAL
  • Non empty uncommented properties are the DEFAULT values but can be changed if wanted
[ENV]
type=production (you can switch between development/QA/production)

#The most basic HTTP server settings, must at least contain the port value
[server]
https_port=8081
http_port=8080
cookies_secret=1234
sockets=true
favicon=app/public/favicon.ico
name=blockexplorer
cluster=0

#SSL settings. Decomment the next lines to use SSL
[ssl]
#key=
#crt=

#mongoDB settings. Decomment the next lines to use it
[db]
host=localhost
port=27000
name=explorer
dir=db/
#user=
#pass=

#Your Bitcoind server settings
[bitcoin_rpc]
ssl=false
url=localhost
path=
username=rpcuser
password=rpcpassword
port=8332
timeout=30000

#Continue scanning and parsing new transaction or just be in API mode
[scanner]
scan=true
mempool=true
mempool_only=false

#Basic HTTP authentication to lock website
[basic]
#admin_users=
#realm=

#Logger properties
[log]
#logentries_api_key=
#level=

Developmenet

  1. Fork this repo
  2. npm install
  3. use the Standard coding style when hacking the code - https://github.com/feross/standard
  4. Send us a pull request

License

Apache-2.0