@evergonlabs/tmi-protocol-indexer 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,34 @@
1
+ # Overview
2
+
3
+ This EVM-networks indexer is built on top of [ponder.sh](https://github.com/ponder-sh/ponder)
4
+
5
+ ## Scripts
6
+
7
+ - `start` — run indexer for production
8
+ - `start:dev` — run indexer for dev environment
9
+
10
+ ## Networks mode
11
+
12
+ The network selection is determined by the networks mode:
13
+
14
+ - `dev` — anvil
15
+ - `prod` — sepolia (mainnet will be added soon)
16
+
17
+ # Production
18
+
19
+ ## Database
20
+
21
+ In production you must specify which database schema it should use. This can be done through:
22
+
23
+ - as `DATABASE_SCHEMA` env variable
24
+ - as `--schema` CLI option with the start script
25
+
26
+ To pass the postgres URI you should use env variables:
27
+
28
+ - `POSTGRES_URI` — connection uri to postgres instance
29
+
30
+ ## RPC nodes
31
+
32
+ Indexer requires RPC node of a network you will need to index. To provide it you should pass following env variables per network:
33
+
34
+ - `SEPOLIA_RPC` — Sepolia