Skip to content

Commit a3e56e7

Browse files
alvrsalvrs
authored
docs: add missing indexer flags (#3522)
1 parent 5a9e238 commit a3e56e7

File tree

3 files changed

+35
-26
lines changed

3 files changed

+35
-26
lines changed

‎docs/pages/indexer/postgres-decoded.mdx

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,17 @@ import { CollapseCode } from "../../components/CollapseCode";
99

1010
These environment variables need to be provided to the indexer to work:
1111

12-
| Type | Variable | Meaning | Sample value (using `anvil` running on the host) |
13-
| -------- | ------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
14-
| Required | RPC_HTTP_URL | The URL to access the blockchain using HTTP | http://host.docker.internal:8545 (when running in Docker) |
15-
| Optional | RPC_WS_URL | The URL to access the blockchain using WebSocket |
16-
| Optional | START_BLOCK | The block to start indexing from. The block in which the `World` contract was deployed is a good choice. | 1 |
17-
| Optional | DEBUG=mud:\* | Turn on debugging | |
18-
| Optional | STORE_ADDRESS | Only index tables from this `World` |
19-
| Required | DATABASE_URL | URL for the database, of the form `postgres://<host>/<database>` |
12+
| Type | Variable | Meaning | Sample value (using `anvil` running on the host) |
13+
| -------- | ---------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
14+
| Required | RPC_HTTP_URL | The URL to access the blockchain using HTTP. Optional if RPC_WS_URL is provided. | http://host.docker.internal:8545 (when running in Docker) |
15+
| Optional | RPC_WS_URL | The URL to access the blockchain using WebSocket. Optional if RPC_HTTP_URL is provided. |
16+
| Optional | START_BLOCK | The block to start indexing from. The block in which the `World` contract was deployed is a good choice. | 1 |
17+
| Optional | DEBUG=mud:\* | Turn on debugging | |
18+
| Optional | STORE_ADDRESS | Only index tables from this `World` |
19+
| Required | DATABASE_URL | URL for the database, of the form `postgres://<host>/<database>` |
20+
| Optional | FOLLOW_BLOCK_TAG | The block tag to index. Options: `latest`, `safe`, `finalized`. Defaults to `safe`. | safe |
21+
| Optional | MAX_BLOCK_RANGE | The maximum number of blocks to index in a single batch. Defaults to 1000. | 1000 |
22+
| Optional | POLL_INTERVAL | The interval in milliseconds to poll for new blocks. Defaults to 1000. | 1000 |
2023

2124
### Using npx
2225

‎docs/pages/indexer/postgres-event-only.mdx

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,18 @@ import { CollapseCode } from "../../components/CollapseCode";
99

1010
These environment variables need to be provided to the indexer to work:
1111

12-
| Type | Variable | Meaning | Sample value (using `anvil` running on the host) |
13-
| -------- | ------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
14-
| Required | RPC_HTTP_URL | The URL to access the blockchain using HTTP | http://host.docker.internal:8545 (when running in Docker) |
15-
| Optional | RPC_WS_URL | The URL to access the blockchain using WebSocket |
16-
| Optional | START_BLOCK | The block to start indexing from. The block in which the `World` contract was deployed is a good choice. | 1 |
17-
| Optional | DEBUG=mud:\* | Turn on debugging | |
18-
| Optional | STORE_ADDRESS | Only index tables from this `World` |
19-
| Required | DATABASE_URL | URL for the database, of the form `postgres://<host>/<database>` |
20-
| Optional | PORT | The port on which the indexer listens | `3001` (the default) |
12+
| Type | Variable | Meaning | Sample value (using `anvil` running on the host) |
13+
| -------- | ---------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
14+
| Required | RPC_HTTP_URL | The URL to access the blockchain using HTTP | http://host.docker.internal:8545 (when running in Docker) |
15+
| Optional | RPC_WS_URL | The URL to access the blockchain using WebSocket |
16+
| Optional | START_BLOCK | The block to start indexing from. The block in which the `World` contract was deployed is a good choice. | 1 |
17+
| Optional | DEBUG=mud:\* | Turn on debugging | |
18+
| Optional | STORE_ADDRESS | Only index tables from this `World` |
19+
| Required | DATABASE_URL | URL for the database, of the form `postgres://<host>/<database>` |
20+
| Optional | PORT | The port on which the indexer listens | `3001` (the default) |
21+
| Optional | FOLLOW_BLOCK_TAG | The block tag to index. Options: `latest`, `safe`, `finalized`. Defaults to `safe`. | safe |
22+
| Optional | MAX_BLOCK_RANGE | The maximum number of blocks to index in a single batch. Defaults to 1000. | 1000 |
23+
| Optional | POLL_INTERVAL | The interval in milliseconds to poll for new blocks. Defaults to 1000. | 1000 |
2124

2225
### Using npx
2326

‎docs/pages/indexer/sqlite.mdx

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,18 @@ import { CollapseCode } from "../../components/CollapseCode";
99

1010
These environment variables need to be provided to the indexer to work:
1111

12-
| Type | Variable | Meaning | Sample value (using `anvil` running on the host) |
13-
| -------- | --------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
14-
| Required | RPC_HTTP_URL | The URL to access the blockchain using HTTP | http://host.docker.internal:8545 (when running in Docker) |
15-
| Optional | RPC_WS_URL | The URL to access the blockchain using WebSocket |
16-
| Optional | START_BLOCK | The block to start indexing from. The block in which the `World` contract was deployed is a good choice. | 1 |
17-
| Optional | DEBUG=mud:\* | Turn on debugging | |
18-
| Optional | STORE_ADDRESS | Only index tables from this `World` |
19-
| Optional | SQLITE_FILENAME | Name of database | `indexer.db` |
20-
| Optional | PORT | The port on which the indexer listens | `3001` (the default) |
12+
| Type | Variable | Meaning | Sample value (using `anvil` running on the host) |
13+
| -------- | ---------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
14+
| Required | RPC_HTTP_URL | The URL to access the blockchain using HTTP | http://host.docker.internal:8545 (when running in Docker) |
15+
| Optional | RPC_WS_URL | The URL to access the blockchain using WebSocket |
16+
| Optional | START_BLOCK | The block to start indexing from. The block in which the `World` contract was deployed is a good choice. | 1 |
17+
| Optional | DEBUG=mud:\* | Turn on debugging | |
18+
| Optional | STORE_ADDRESS | Only index tables from this `World` |
19+
| Optional | SQLITE_FILENAME | Name of database | `indexer.db` |
20+
| Optional | PORT | The port on which the indexer listens | `3001` (the default) |
21+
| Optional | FOLLOW_BLOCK_TAG | The block tag to index. Options: `latest`, `safe`, `finalized`. Defaults to `safe`. | safe |
22+
| Optional | MAX_BLOCK_RANGE | The maximum number of blocks to index in a single batch. Defaults to 1000. | 1000 |
23+
| Optional | POLL_INTERVAL | The interval in milliseconds to poll for new blocks. Defaults to 1000. | 1000 |
2124

2225
### Using npx
2326

0 commit comments

Comments
 (0)