hyperledger/blockchain-explorer

Name: blockchain-explorer

Owner: Hyperledger

Description: Read-only mirror of https://gerrit.hyperledger.org/r/#/admin/projects/blockchain-explorer

Created: 2016-09-11 18:27:20.0

Updated: 2018-05-24 01:12:02.0

Pushed: 2018-05-24 12:53:47.0

Homepage: https://hyperledger.org

Size: 139150

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Hyperledger Explorer

Hyperledger Explorer is a simple, powerful, easy-to-use, highly maintainable, open source browser for viewing activity on the underlying blockchain network.

Directory Structure

app            Application backend root
??? db             Postgres script and help class
??? listener       Websocket listener
??? metrics        Metrics
??? mock_server    Mock server used for development
??? service        The service
??? socket         Push real time data to front end
??? test           Endpoint tests
??? timer          Timer to post information periodically
??? utils          Various utility scripts
client          Web Ui

Requirements

Following are the software dependencies required to install and run hyperledger explorer

• nodejs 6.9.x (Note that v7.x is not yet supported)
• PostgreSQL 9.5 or greater

Hyperledger Explorer works with Hyperledger Fabric 1.0. Install the following software dependencies to manage fabric network.

• docker 17.06.2-ce [https://www.docker.com/community-edition]
• docker-compose 1.14.0 [https://docs.docker.com/compose/]

Clone Repository

Clone this repository to get the latest using the following command.

• git clone https://github.com/hyperledger/blockchain-explorer.git.
• cd blockchain-explorer.

Database setup

Connect to PostgreSQL database.

• sudo -u postgres psql

Run create database script.

• \i app/db/explorerpg.sql
• \i app/db/updatepg.sql

Run db status commands.

• \l view created fabricexplorer database
• \d view created tables

Fabric network setup

Setup your own network using Build your network tutorial from Fabric. Once you setup the network, please modify the values in config.json accordingly.

Running hyperledger-explorer

On another terminal.

• cd blockchain-explorer

• Modify config.json to update network-config.

  • Change “fabric-path” to your fabric network path, example: “/home/user1/workspace/fabric-samples” for the following keys: “tls_cacerts”, “key”, “cert”.
  • Final path for key “tls_cacerts” will be: “/home/user1/workspace/fabric-samples/first-network/crypto-config/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/tls/ca.crt”.

• Modify config.json to update one of the channel

  • pg host, username, password details.

    nnel": "mychannel",
    : {
    t": "127.0.0.1",
    t": "5432",
    abase": "fabricexplorer",
    rname": "hppoc",
    swd": "password"
    
    

If you are connecting to a non TLS fabric peer, please modify the protocol (grpcs->grpc) and port (9051-> 9050) in the peer url and remove the tls_cacerts. Depending on this key, the application decides whether to go TLS or non TLS route.

Build Hyperledger Explorer

On another terminal.

• cd blockchain-explorer/app/test
• npm install
• npm run test
• cd blockchain-explorer
• npm install
• cd client/
• npm install
• npm test -- -u --coverage
• npm run build

Run Hyperledger Explorer

From new terminal.

• cd blockchain-explorer/
• ./start.sh (it will have the backend up).
• tail -f log.log (view log)
• Launch the URL http://localhost:8080 on a browser.

License

Hyperledger Explorer Project source code is released under the Apache 2.0 license. The README.md, CONTRIBUTING.md files, and files in the “images”, “snapshots“, and “mockData” folders are licensed under the Creative Commons Attribution 4.0 International License. You may obtain a copy of the license, titled CC-BY-4.0, at http://creativecommons.org/licenses/by/4.0/.