Skip to content

Commit a2bd508

Browse files
author
Amine Afia
authored
change name (#75)
1 parent 23f9e4e commit a2bd508

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# indexer
1+
# Insight
22

3-
The Indexer is a blockchain data processing tool designed to fetch, process, and store on-chain data. It provides a solution for indexing blockchain data, facilitating efficient querying of transactions, logs through a simple API.
3+
Insight is a blockchain data processing tool designed to fetch, process, and store on-chain data. It provides a solution for indexing blockchain data, facilitating efficient querying of transactions, logs through a simple API.
44

5-
The Indexer's architecture consists of five main components:
5+
Insight's architecture consists of five main components:
66
<img width="728" alt="architecture-diagram" src="https://github.com/user-attachments/assets/8ad19477-c18f-442e-a899-0f502a00bae6">
77

88
1. **Poller**: The Poller is responsible for continuously fetching new blocks from the configured RPC and processing them. It uses multiple worker goroutines to concurrently retrieve block data, handles successful and failed results, and stores the processed block data and any failures.
@@ -15,7 +15,7 @@ The Indexer's architecture consists of five main components:
1515

1616
5. **Orchestrator**: The Orchestrator is responsible for coordinating and managing the poller, failure recoverer, and committer. It initializes these components based on configuration settings and starts them concurrently, ensuring they run independently while waiting for all of them to complete their tasks.
1717

18-
The Indexer's modular architecture and configuration options allow for adaptation to various evm chains and use cases.
18+
Insight's modular architecture and configuration options allow for adaptation to various evm chains and use cases.
1919

2020

2121
## Getting started
@@ -26,10 +26,10 @@ The Indexer's modular architecture and configuration options allow for adaptatio
2626
3. Create a clickhouse instance
2727

2828
### Usage
29-
To run the indexer and the associated API, follow these steps:
29+
To run insight and the associated API, follow these steps:
3030
1. Clone the repo
3131
```
32-
git clone https://github.com/thirdweb-dev/indexer.git
32+
git clone https://github.com/thirdweb-dev/insight.git
3333
```
3434
2. Run the migration scripts here
3535
3. Create `config.yml` from `config.example.yml` and set the values by following the [config guide](#supported-configurations)
@@ -38,19 +38,19 @@ git clone https://github.com/thirdweb-dev/indexer.git
3838
```
3939
go build -o main
4040
```
41-
5. Run the indexer
41+
6. Run insight
4242
```
4343
./main orchestrator
4444
```
45-
6. Run the Data API
45+
7. Run the Data API
4646
```
4747
./main api
4848
```
49-
7. API is available at `http://localhost:3000`
49+
8. API is available at `http://localhost:3000`
5050

5151
## Metrics
5252

53-
The indexer node exposes Prometheus metrics at `http://localhost:2112/metrics`. Here the exposed metrics [metrics.go](https://github.com/thirdweb-dev/indexer/blob/main/internal/metrics/metrics.go)
53+
Insight node exposes Prometheus metrics at `http://localhost:2112/metrics`. Here the exposed metrics [metrics.go](https://github.com/thirdweb-dev/insight/blob/main/internal/metrics/metrics.go)
5454

5555
## Configuration
5656

0 commit comments

Comments
 (0)