TEO Explorer1

Live Version of This Explorer #1: explorer.tao.foundation
Alternate Explorer #2 lightexp : explorer2.tao.foundation

Local installation

Clone the repo

git clone https://github.com/tao-foundation/explorer1

Download Nodejs and npm if you don't have them

Install dependencies:

npm install

Install mongodb:

MacOS: brew install mongodb

Ubuntu: sudo apt-get install -y mongodb-org

Install mongodb-org refer here : https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/

Populate the DB

This will fetch and parse the entire blockchain.

Setup your configuration file: cp config.example.json config.json

Edit config.json as you wish

Basic settings:

{
    "nodeAddr":     "localhost",
    "gethPort":     8545,
    "startBlock":   0,
    "endBlock":     "latest",
    "quiet":        true,
    "syncAll":      true,
    "patch":        true,
    "patchBlocks":  100,
    "settings": {
        "symbol": "TEO",
        "name": "TEO (TrustEthreOrigin)",
        "title": "TEO Block Explorer",
        "author": "trustfarm, Elaine, Cody, Hackmod, Bakon",
        "contact": "mailto:admin@tao.foundation",
    }
}

nodeAddr Your node API RPC address.

gethPort Your node API RPC port.

startBlock This is the start block of the blockchain, should always be 0 if you want to sync the whole ETC blockchain.

endBlock This is usually the 'latest'/'newest' block in the blockchain, this value gets updated automatically, and will be used to patch missing blocks if the whole app goes down.

quiet Suppress some messages. (admittedly still not quiet)

syncAll If this is set to true at the start of the app, the sync will start syncing all blocks from lastSync, and if lastSync is 0 it will start from whatever the endBlock or latest block in the blockchain is.

patch If set to true and below value is set, sync will iterated through the # of blocks specified.

patchBlocks If patch is set to true, the amount of block specified will be check from the latest one.

Mongodb Auth setting.

Configure MongoDB

In view of system security, most of mongoDB Admin has setup security options, So, You need to setup mongodb auth informations.

Switch to the built-in admin database:

$ mongo
> use admin

1. Create an administrative user (if you have already admin or root of mongodb account, then skip it)

# make admin auth and role setup
> db.createUser( { user: "admin", pwd: "<Enter a secure password>", roles: [ { role: "readWriteAnyDatabase", db: "admin" }, { role: "userAdminAnyDatabase", db: "admin" } ] } )

And, You can make Explorer's "blockDB" database with db user accounts "explorer" and password "some_pass_code".

> use blockDB
> db.createUser( { user: "explorer", pwd: "<Enter a secure password>", roles: [ { role: "readWrite", db: "blockDB" }, { role: "clusterMonitor", db: "admin" } ] } )
> quit()

Above dbuser explorer will full access blockDB and clustor setting will be well used on monitoring the multiple sharding and replication of multiple mongodb instances.

Enable database authorization in the MongoDB configuration file /etc/mongod.conf by appending the following lines:

security:
  authorization: enabled

Restart MongoDB and verify the administrative user created earlier can connect:

$ sudo systemctl restart mongod
$ mongo -u admin -p your_password --authenticationDatabase=admin

If everything is configured correctly the Mongo Shell will connect and

> show dbs

will show db informations.

and You can add modified from ./db.js:69 lines, add auth information and mongodb connect options.

var connectOptions = {
  db: { native_parser: true },
//  server: { poolSize: 5 },
//  replset: { rs_name: 'myReplicaSetName' },
  user: 'explorer',
  pass: 'passkey',
  promiseLibrary: global.Promise
}

And explore it.

Run:

The below will start both the web-gui and sync.js (which populates MongoDV with blocks/transactions). npm start

You can leave sync.js running without app.js and it will sync and grab blocks based on config.json parameters node ./tools/sync.js

Enabling stats requires running a separate process: node ./tools/stats.js

You can configure intervals (how often a new data point is pulled) and range (how many blocks to go back) with the following: RESCAN=1000:100000 node tools/stats.js (New data point every 1,000 blocks. Go back 100,000 blocks).