chore: more env variables to README.md

defi-wonderland · Oct 28, 2024 · 71210dc · 71210dc
1 parent aee3609
commit 71210dc
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 8 deletions.
diff --git a/apps/agent/.env.example b/apps/agent/.env.example
@@ -1,5 +1,23 @@
+# Private key for the Protocol Provider
 PROTOCOL_PROVIDER_PRIVATE_KEY=afdfd9c3d2095ef696594f6cedcae59e72dcd697e2a7521b1578140422a4f890
+
+# URLs for RPC endpoints for Layer 1 networks, comma-separated
+PROTOCOL_PROVIDER_L1_RPC_URLS=url1,url2,url3
+
+# URLs for RPC endpoints for Layer 2 networks, comma-separated
+PROTOCOL_PROVIDER_L2_RPC_URLS=url4,url5,url6
+
+# JSON map of chain IDs to their respective RPC URLs
+BLOCK_NUMBER_RPC_URLS_MAP='{"chain:id":["url7"]}'
+
+# Blockmeta BlockNumberService bearer token
 BLOCK_NUMBER_BLOCKMETA_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuaWNlIjoidHJ5Iiwibm90aGluZyI6InRvIiwic2VlIjoiaGVyZSJ9.gsWpvMzpzd5_7IN_GU0PhNLH7wuKHl29FHkL5-i18b4
+
+# Path to the agent YAML configuration file
 EBO_AGENT_CONFIG_FILE_PATH="./config.example.yml"
+
+# Discord bot token for notifications
 DISCORD_BOT_TOKEN=YOUR_DISCORD_BOT_TOKEN
-DISCORD_CHANNEL_ID=YOUR_DISCORD_CHANNEL_ID
+
+# Discord channel ID for notifications
+DISCORD_CHANNEL_ID=YOUR_DISCORD_CHANNEL_ID
diff --git a/apps/agent/README.md b/apps/agent/README.md
@@ -29,13 +29,16 @@ cp .env.example .env
 
 **Environment Variables**:
 
-| Variable                        | Description                               | Required |
-| ------------------------------- | ----------------------------------------- | -------- |
-| `PROTOCOL_PROVIDER_PRIVATE_KEY` | Private key for the Protocol Provider     | Yes      |
-| `BLOCK_NUMBER_BLOCKMETA_TOKEN`  | BlockmetaBlockNumberService bearer token  | Yes      |
-| `EBO_AGENT_CONFIG_FILE_PATH`    | Path to the agent YAML configuration file | Yes      |
-| `DISCORD_BOT_TOKEN`             | Your Discord bot's token                  | Yes      |
-| `DISCORD_CHANNEL_ID`            | Discord channel ID for notifications      | Yes      |
+| Variable                        | Description                                                               | Required |
+| ------------------------------- | ------------------------------------------------------------------------- | -------- |
+| `PROTOCOL_PROVIDER_PRIVATE_KEY` | Private key for the Protocol Provider                                     | Yes      |
+| `PROTOCOL_PROVIDER_L1_RPC_URLS` | Comma-separated URLs for Layer 1 RPC endpoints                            | Yes      |
+| `PROTOCOL_PROVIDER_L2_RPC_URLS` | Comma-separated URLs for Layer 2 RPC endpoints                            | Yes      |
+| `BLOCK_NUMBER_RPC_URLS_MAP`     | JSON map of chain IDs to arrays of RPC URLs for Block Number calculations | Yes      |
+| `BLOCK_NUMBER_BLOCKMETA_TOKEN`  | Bearer token for the Blockmeta service (see notes below on how to obtain) | Yes      |
+| `EBO_AGENT_CONFIG_FILE_PATH`    | Path to the agent YAML configuration file                                 | Yes      |
+| `DISCORD_BOT_TOKEN`             | Your Discord bot’s token                                                  | Yes      |
+| `DISCORD_CHANNEL_ID`            | Discord channel ID for notifications                                      | Yes      |
 
 **Notes:**