Skip to content

Latest commit

 

History

History
141 lines (100 loc) · 6.97 KB

README.md

File metadata and controls

141 lines (100 loc) · 6.97 KB
Raw

Quorum Explorer

Table of Contents

Description

This is a lightweight explorer that is designed to get you up and running really quickly to give you an overview of yout chain. It has not been designed for production use yet!

Prerequisites

Local Usage

  1. Start your existing network using something like the Quorum Dev Quickstart or equivalent

  2. Create a config file with the nodes you wish to monitor

    1. Set the consensus algorithm of your network by the variable: algorithm. Values allowed include: qbft, ibft, clique, raft
    2. For each node in your network append the following format to the list: 
         {
      "name": "NODE_NAME", // this can be anything as long as it does not overlap with other nodes
      "client": "goquorum", // 'goquorum' or 'besu'
      "rpcUrl": "http://127.0.0.1:8545", // 'rpcUrl that the explorer can use to contact the nodes'
      "privateTxUrl": "" // if this is a besu-tessera or goquorum-tessera pairing, set the Url to Tessera here with the port e.g. http://127.0.0.1:9081; otherwise leave it as empty
   }
    3. If your node is a tessera pairing and you would like to make private transactions through the explorer, you will need to add two more settings along with the privateTxUrl: 
         "privateKey": "0x8f2a55949038a9610f50fb23b5883af3b4ecb3c3bb792cbcefbd1542c692be63",
   "accountAddress": "0xfe3b557e8fb62b89f4916b721be55ceb828dbd73"
      The defaults given above and seen in the config.json provided are test accounts from the quorum-dev-quickstart. Given the sensitive nature of putting these keys in config, it is not recommended to use this feature in production. Due to some limitations, private transactions cannot be made through browser wallets such as MetaMask (although these features may yet come), so there is no alternative method of specifying private keys except in the config.
    4. Ensure that your final config is valid JSON by using this validator or your own tool.

  3. Create a .env.local in the root directory of this project

QE_BASEPATH="/explorer"
QE_CONFIG_PATH="src/config/config.json"
NODE_ENV=development
DISABLE_AUTH=true
NEXTAUTH_URL=http://localhost:25000
NEXTAUTH_URL_INTERNAL=http://localhost:25000
  1. Start the application
npm i
npm run dev
  1. For a production build refer to Going into Production

Going into Production

If you would like to use this application in a production environment, it is highly recommended that you enable authentication.

You must generate a secret for NEXTAUTH_SECRET in .env.production. This is necessary for NextAuth to function in a production environment. You can generate NEXTAUTH_SECRET by either running openssl rand -hex 32 or go to https://generate-secret.now.sh/32.

If you set DISABLE_AUTH to false, to enable authentication, then you must provide at least one authentication entry in .env.production. For a 'testing' production environment, you can use local_username and local_password if you do not want to use OAuth just yet.

Take a look at the .env.production file for values that you can change.

Options

QE_BASEPATH: set this to your preferred base URL path (defaults to : '/explorer')

QE_CONFIG_PATH: this is the path for the backend API to read off disk to get the node configuration information on the network. You should not change this if you are using the docker container as the config will be mounted to /app/config.json internally within the container.

NODE_ENV: leave this set to production in a prod environment

DISABLE_AUTH: setting this to false will enable authentication. (by default left on false for the best security practices)

NEXTAUTH_URL: set this to your domain without base path. Defaults to http://localhost:25000 for local use.

NEXTAUTH_URL_INTERNAL: set this to an internally accessible URL for next auth to use. Defaults to http://localhost:25000.

local_username & local_password: If you want to use authentication but do not want to use OAuth, you can set the username and password here. Please note, although this is convenient, it is not recommended in a production environment.

The variables for the remainder can be left empty if not in use. Set the variables for any of the authentication options you would like to use.

Docker-Compose

services:
   explorer:
      image: consensys/quorum-explorer:latest
      volumes:
      - ./config.json:/app/config.json
      - ./.env.production:/app/.env.production
      ports:
      - 25000:25000/tcp

The above you can find a bare-minimum docker-compose.yaml. You should edit the locations of the config.json and .env.production depending on where they are located. Both of those files must be provided for the application to function. Please take a look at .env.production and /config/config.json in this repo for how to format.

Building your own Docker container

  1. cd to root of this repo
  2. docker build . -f Dockerfile -t YOUR_IMAGE:TAG
  3. Use the above docker-compose and substitute the image with your own as specified in your command.

Additional Features

We welcome PRs for bugs or added functionality :) Please sign the CLA and submit a PR with your work for us to review.

If you raise an issue, please include steps for us to reproduce your issue so we can solve it faster.

Troubleshooting

MetaMask Transaction is Stuck

Sometimes you may run into an issue where sending a transaction through the Wallets page on the app becomes stuck indefinitely. This issue occurs if you import an account into MetaMask and then you subsequently restart/recreate your private network.

ENSURE THAT YOUR PRIVATE KEYS OR SEEDS ARE BACKED UP PRIOR TO DOING THIS

To resolve this problem:

  1. Select the account in MetaMask
  2. Go to Advanced Settings in MetaMask and click "Reset Account"
  3. Do steps 1-2 for each account that was used or will be used to transact on the private network
  4. Attempt transaction again on Wallets page

You should not need to do this if the network is persisting for a long period of time like in production. However, may be necessary in development where the network is periodically reset.