Skip to content

Commit a6ea6cc

Browse files
author
kalm
committed
explorer: update README with clearer prerequisites and guidance for confirming successful start
This update improves documentation usability by providing more context in the prerequisites section and adding step-by-step guidance for verifying a successful Explorer environment startup. Summary of Updates: - Refactored the prerequisites section for better clarity and organization - Introduced a new "Confirming Successful Start" section with guidance on environment initialization - Updated the Quick Start Guide overview paragraph - Adjusted the Table of Contents to reflect the prerequisites refactor
1 parent 2cce6d4 commit a6ea6cc

1 file changed

Lines changed: 53 additions & 17 deletions

File tree

bin/explorer/README.md

Lines changed: 53 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,17 @@ The DarkFi Blockchain Explorer facilitates the exploration of chain data and int
55
## Table of Contents
66
1. [Key Features](#key-features)
77
2. [Network Status](#network-status)
8-
3. [Prerequisites](#prerequisites)
9-
4. [Quick Start Guide](#quick-start-guide)
8+
3. [Quick Start Guide](#quick-start-guide)
109

11-
5. [Explorer Components](#explorer-components)
10+
4. [Explorer Components](#explorer-components)
1211
- [Explorer Nodes](#explorer-nodes)
1312
- [Explorer Site](#explorer-site)
1413

15-
6. [Configuration](#configuration)
14+
5. [Configuration](#configuration)
1615
- [Configuration Files](#configuration-files)
1716
- [Supported Networks](#supported-networks)
1817

19-
7. [Feature Details](#feature-details)
18+
6. [Feature Details](#feature-details)
2019
- [Home Page Overview](#home-page-overview)
2120
- [Block and Transaction Exploration](#block-and-transaction-exploration)
2221
- [Gas Analytics](#gas-analytics)
@@ -37,18 +36,19 @@ The testnet and mainnet configurations serve as placeholders in preparation for
3736

3837
In addition, testnet and mainnet configurations are currently using development servers for the site and work is ongoing for production-like setups.
3938

40-
## Prerequisites
41-
Before you begin, ensure you have the following installed and configured:
42-
- **Rust 1.86 or later**: For building and running the explorer daemon (`explorerd`).
43-
- **Make**: To start and stop explorer environments using make
44-
- **Python 3.12**: Required for running the Explorer Site (`site`).
45-
- **Darkfi Project Dependencies**: Dependencies required to compile the Darkfi code. For more details, see [Darkfi Build Dependencies](../../README.md#build).
46-
- **Darkfid**: Required for running DarkFi blockchain nodes on respective networks. The make commands build the binary from source code in `../darkfid` (if not already built in project root) and apply the appropriate network configuration.
47-
- **Minerd**: Needed for setups where Darkfid is configured with a miner JSON-RPC endpoint, but the configured miner is not running on the desired network. The make commands build the binary from source code in `../minerd` (if not already built in project root) and apply the appropriate network configuration.
48-
4939
## Quick Start Guide
5040

51-
Run the following to get explorer environments running, including explorer nodes and site to view blocks on the respective Darkfid configured networks. These commands will automatically install dependencies, configure your environment, and start all necessary components.
41+
The DarkFi Explorer provides a visual interface to explore blockchains on DarkFi networks. Follow the steps below to launch explorer environments for your desired Darkfi blockchain network.
42+
43+
### Prerequisites
44+
Before you begin, ensure you have the following installed and configured:
45+
- **Rust 1.86 or later**: Required for building components written in Rust (like `darkfid`, `minerd`, `explorerd`)
46+
- **Python 3.12**: Required for building and running the Explorer Site (`site`).
47+
- **Darkfi Project Dependencies**: System dependencies required to compile Darkfi code. For details, see [Darkfi Build Dependencies](../../README.md#build).
48+
- **Darkfid**: Runs DarkFi blockchain nodes on respective networks.
49+
- **Minerd**: Mines blocks and is required if Darkfid is configured with a miner JSON-RPC endpoint and the associated miner isn’t running.
50+
51+
> **Note** When using the `make` commands in the [Quick Start Guide](#quick-start-guide), Darkfid and Minerd are automatically built when needed.
5252
5353
### Start Localnet Explorer Environment
5454

@@ -71,7 +71,43 @@ make start-testnet
7171
make start-mainnet
7272
```
7373

74-
> Once started, navigate to http://127.0.0.1:5000 in your browser to access the explorer interface.
74+
> **Note** Once started, navigate to http://127.0.0.1:5000 in your browser to access the explorer interface.
75+
76+
### Confirming Successful Start
77+
78+
Upon successful initialization of the Explorer environment, confirmation messages will appear in the startup logs. If these logs are not visible, the Explorer environment is still initializing. Allow sufficient time for the initialization process to complete before accessing the block explorer.
79+
80+
```
81+
07:09:22 [INFO] ========================================================================================
82+
07:09:22 [INFO] Started DarkFi Explorer Node
83+
07:09:22 [INFO] ========================================================================================
84+
07:09:22 [INFO] - Network: localnet
85+
07:09:22 [INFO] - JSON-RPC Endpoint: tcp://127.0.0.1:14567
86+
07:09:22 [INFO] - Database: ~/.local/share/darkfi/explorerd/localnet
87+
07:09:22 [INFO] - Configuration: ./explorerd_config.toml
88+
07:09:22 [INFO] - Reset Blocks: No
89+
07:09:22 [INFO] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
90+
07:09:22 [INFO] - Synced Blocks: 9
91+
07:09:22 [INFO] - Synced Transactions: 9
92+
07:09:22 [INFO] - Connected Darkfi Node: tcp://127.0.0.1:8240
93+
07:09:22 [INFO] ========================================================================================
94+
07:09:22 [INFO] All is good. Waiting for block notifications...
95+
Started explorer site on localnet network (PID=31911)
96+
Started localnet environment. Press Ctrl-C to stop.
97+
```
98+
99+
> **Note** Localnet explorer site logs appear directly in the console, while testnet and mainnet logs are written to `~/.local/share/darkfi/explorer_site/{network}/app.log`. For non-localnet environments, the console displays: `See site logfile /home/user/.local/share/darkfi/explorer_site/{network}/app.log for server startup details`.
100+
101+
The explorer site log contains the following statup details.
102+
```
103+
============================================================
104+
Started Explorer Site
105+
============================================================
106+
Network: localnet
107+
Explorer Node Endpoint: 127.0.0.1:14567
108+
Log Path: ~/.local/share/darkfi/explorer_site/localnet
109+
============================================================
110+
```
75111

76112
### Stopping the Explorer Environment
77113

@@ -125,7 +161,7 @@ The Explorer is configured to support the following pre-configured DarkFi blockc
125161
| **`testnet`** | Used for testing the explorer with `darkfid`'s testnet network (pending availability). |
126162
| **`mainnet`** | The production environment for running the explorer on DarkFi's canonical chain (pending availability). |
127163

128-
> **Note**: Once the testnet and mainnet are fully available, the explorer will sync more than just the genesis blocks for these networks.
164+
> **Note** Once the testnet and mainnet are fully available, the explorer will sync more than just the genesis blocks for these networks.
129165
130166
## Feature Details
131167

0 commit comments

Comments
 (0)