Hyperledger Explorer is a simple, powerful, easy-to-use, highly maintainable, open source browser for viewing activity on the underlying blockchain network.
├── app fabric GRPC interface
├── db the mysql script and help class
├── explorer_client Web Ui
├── first-network Basic fabric network setup
├── listener websocket listener
├── metrics metrics about tx count per minute and block count per minute
├── service the service
├── socket push real time data to front end
├── timer Timer to post information periodically
└── utils Various utility scripts
Following are the software dependencies required to install and run hyperledger explorer
- nodejs 6.9.x (Note that v7.x is not yet supported)
- mysql 5.7 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 this repository to get the latest using the following command.
git clone https://github.com/hyperledger/blockchain-explorer.git
cd blockchain-explorer
Run the database setup scripts located under db/fabricexplorer.sql
mysql -u<username> -p < db/fabricexplorer.sql
This repository comes with a sample network configuration to start with
cd first-network
./bootstrap-1.0.2.sh
- This is going to download the necessary binaries and hyperledger docker images.mkdir -p ./channel-artifacts
./byfn.sh -m generate -c mychannel
./byfn.sh -m up -c mychannel
This brings up a 2 org network with channel name mychannel
.
Alternatively you can setup your own network using Build your network tutorial from Fabric. Once you setup the network, please modify the values in config.json
accordingly.
On another terminal,
cd blockchain-explorer
- Modify config.json to update one of the channel
- mysql host, username, password details
"channel": "mychannel",
"mysql":{
"host":"127.0.0.1",
"database":"fabricexplorer",
"username":"root",
"passwd":"123456"
}
If you are connecting to a non TLS fabric network, please modify the
protocol (grpcs->grpc
) and port (9051-> 9050
) in the peer url and remove the tls_cacerts
3. npm install
4. ./start.sh
Launch the URL http://localhost:8080 on a browser.
This is how the blockchain-explorer looks like,