Explorer
Overview of Explorer capabilities
The Blockchain Explorer is a UI displaying blockchain information without having to know how to query the blockchain.
The testnet Explorer can be reached here.
The mainnet Explorer can be reached here.

Prerequisites

Installation

  1. 1.
    For a no-mess installation to get Explorer up and running, copy the following code into an accessible file docker-compose.yml:
1
version: '3.9'
2
services:
3
explorer-postgres:
4
image: provenanceio/explorer-database:latest
5
container_name: explorer-postgres
6
environment:
7
- POSTGRES_USER=postgres
8
- POSTGRES_PASSWORD=password1
9
ports:
10
- 5432:5432
11
12
explorer-service:
13
image: provenanceio/explorer-service:latest
14
container_name: explorer-service
15
ports:
16
- 8612:8612
17
environment:
18
- SPRING_PROFILES_ACTIVE=container
19
- DB_USER=postgres
20
- DB_PASS=password1
21
- DB_HOST=postgres
22
- SPRING_DATASOURCE_URL=jdbc:postgresql://explorer-postgres:5432/explorer
23
- DB_PORT=5432
24
- DB_NAME=explorer
25
- DB_SCHEMA=explorer
26
- DB_CONNECTION_POOL_SIZE=40
27
- SPOTLIGHT_TTL_MS=5000
28
- INITIAL_HIST_DAY_COUNT=14
29
- EXPLORER_MAINNET=false
30
# Hits the locally running node
31
- EXPLORER_PB_URL=http://host.docker.internal:9090
32
- EXPLORER_FIGMENT_APIKEY=45af964c1cc7292d06db51b5d9a523a4
33
- EXPLORER_FIGMENT_URL=https://pio-testnet-1--lcd.datahub.figment.io
34
depends_on:
35
- explorer-postgres
36
links:
37
- "explorer-postgres"
38
39
explorer-frontend:
40
image: provenanceio/explorer-frontend-generic:latest
41
container_name: explorer-frontend
42
ports:
43
- 3000:3000
44
environment:
45
- REACT_APP_ENV=local
46
depends_on:
47
- explorer-service
48
links:
49
- "explorer-service"
Copied!
  1. 1.
    a. For the most up-to-date compose file, head here.
  2. 2.
    From the location of the above saved file, run `docker-compose pull. This pulls the latest versions of the dockers defined in the file.
  3. 3.
    Once the pull is complete, run docker-compose up. This starts up the dockers as a single unit.
Once it's up and running, you should be able to access the UI from http://localhost:3000/dashboard.

Using Github/IDE

Additional prerequisites:
  1. 2.
    From within your favorite IDE (or CLI, you brute), you'll need to get everything to build. This project uses Gradle as the build tool. Run the following series of commands from the root directory to get everything built:
    1. 1.
      sh ./gradlew
    2. 2.
      ./gradlew clean proto:generateProto
    3. 3.
      ./gradlew build
  2. 3.
    Start up the database
    1. 1.
      Run docker-compose -f docker/docker-compose-db.yml up -d . This starts the database in a docker environment.
    2. 2.
      By running the database separately, you can keep it running in the background while starting and stopping the frontend separately.
  3. 4.
    Run ./gradlew bootRun -Dspring.profiles.active=development to run in a development environment.
  4. 5.
    Start up the frontend
    1. 1.
      Open docker/docker-compose.yml
    2. 2.
      Make the following changes
1
version: '3.9'
2
services:
3
# explorer-postgres:
4
# image: provenanceio/explorer-database:latest
5
# container_name: explorer-postgres
6
# environment:
7
# - POSTGRES_USER=postgres
8
# - POSTGRES_PASSWORD=password1
9
# ports:
10
# - 5432:5432
11
12
# explorer-service:
13
# image: provenanceio/explorer-service:latest
14
# container_name: explorer-service
15
# ports:
16
# - 8612:8612
17
# environment:
18
# - SPRING_PROFILES_ACTIVE=container
19
# - DB_USER=postgres
20
# - DB_PASS=password1
21
# - DB_HOST=postgres
22
# - SPRING_DATASOURCE_URL=jdbc:postgresql://explorer-postgres:5432/explorer
23
# - DB_PORT=5432
24
# - DB_NAME=explorer
25
# - DB_SCHEMA=explorer
26
# - DB_CONNECTION_POOL_SIZE=40
27
# - SPOTLIGHT_TTL_MS=5000
28
# - INITIAL_HIST_DAY_COUNT=14
29
# - EXPLORER_MAINNET=false
30
# # Hits the locally running node
31
# - EXPLORER_PB_URL=http://host.docker.internal:9090
32
# depends_on:
33
# - explorer-postgres
34
# links:
35
# - "explorer-postgres"
36
#
37
explorer-frontend:
38
image: provenanceio/explorer-frontend-generic:latest
39
container_name: explorer-frontend
40
ports:
41
- 3000:3000
42
environment:
43
- REACT_APP_ENV=local
44
# depends_on:
45
# - explorer-service
46
# links:
47
# - "explorer-service"
Copied!
  1. 1.
    Run docker-compose -f docker/docker-compose.yml up -d
Once it's up and running, you should be able to access the UI from http://localhost:3000/dashboard.