Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test: added acceptance test to validate the e2e flow of the ERC Registry project #1073

14 changes: 8 additions & 6 deletions tools/erc-repository-indexer/erc-contract-indexer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,14 @@ The ERC Contract Indexer is a tool designed to facilitate the indexing and manag

3. Create a `.env` file in the root directory and configure your environment variables:

| Variable | Description | Accepted Values |
| ---------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `HEDERA_NETWORK` | The network to connect to. | `localnet`, `previewnet`, `testnet`, or `mainnet` |
| `MIRROR_NODE_URL` | The URL for the Hedera mirror node API. | A valid URL pointing to the Hedera mirror node (e.g., `https://{previewnet\|testnet\|mainnet}.mirrornode.hedera.com`) |
| `MIRROR_NODE_URL_WEB3` | The URL for the Hedera Mirror Node Web3Module API, required only when `HEDERA_NETWORK` is set to `localnet`. | Any value |
| `STARTING_POINT` | The starting point for contract indexing. | A Hedera contract ID (e.g., `0.0.369`), an EVM 20-byte address (e.g., `0x0000000000000000000000000000000000000369`), or a get contract list next pointer (e.g., `/api/v1/contracts?limit=100&order=asc&contract.id=gt:0.0.369`) |
| Variable | Description | Accepted Values |
| ---------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `HEDERA_NETWORK` | The network to connect to. | `local-node`, `previewnet`, `testnet`, or `mainnet` |
| `MIRROR_NODE_URL` | The URL for the Hedera mirror node API. | A valid URL pointing to the Hedera mirror node (e.g., `https://{previewnet\|testnet\|mainnet}.mirrornode.hedera.com`) |
| `MIRROR_NODE_URL_WEB3` | The URL for the Hedera Mirror Node Web3Module API, required only when `HEDERA_NETWORK` is set to `local-node`. | Any value |
| `STARTING_POINT` | The starting point for contract indexing. | A Hedera contract ID (e.g., `0.0.369`), an EVM 20-byte address (e.g., `0x0000000000000000000000000000000000000369`), or a get contract list next pointer (e.g., `/api/v1/contracts?limit=100&order=asc&contract.id=gt:0.0.369`) |
| `SDK_OPERATOR_ID` | The operator ID used to initialize a Hashgraph SDK, applicable only for testing. | Hedera Account IDs |
quiet-node marked this conversation as resolved.
Show resolved Hide resolved
| `SDK_OPERATOR_KEY` | The operator Key used to initialize a Hashgraph SDK, applicable only for testing. | Hedera Account DER Private Key |

Example configuration:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
HEDERA_NETWORK=
MIRROR_NODE_URL=
STARTING_POINT=
MIRROR_NODE_URL_WEB3= # only necessary for local-node
SDK_OPERATOR_ID= # only necessary for acceptance test
SDK_OPERATOR_KEY= # only necessary for acceptance test
Loading