fix: pr comments

apps/agent/README.md

@@ -17,13 +17,16 @@ pnpm install
 
 2. **Configure Environment Variables**:
 
--   Create a `.env` file in the root of the `agent` package. Refer to `.env.example` for the required environment variables.
--   Populate the file with your environment-specific settings:
+You can configure environment variables in one of two ways:
+
+-   **Using a `.env` file**: Create a `.env` file in the root of the `agent` package. Refer to `.env.example` for the required environment variables, and copy it to `.env`:
 
 ```bash
 cp .env.example .env
 ```
 
+-   **Setting environment variables directly**: Alternatively, you may set the environment variables directly in your shell or deployment environment without using a `.env` file.
+
 **Environment Variables**:
 
 | Variable                        | Description                               | Required |
@@ -36,14 +39,14 @@ cp .env.example .env
 
 3. **Configuration File**:
 
--   The agent also requires a YAML configuration file. The path to this file must be specified in the `.env` file via `EBO_AGENT_CONFIG_FILE_PATH`.
+-   The agent requires a YAML configuration file. The path to this file must be specified in the `.env` file via `EBO_AGENT_CONFIG_FILE_PATH`.
 -   To set up the configuration, copy `config.example.yml` to `config.yml`:
 
 ```bash
 cp config.example.yml config.yml
 ```
 
--   Update the `config.yml` file with your specific settings.
+-   Update the `config.yml` file with your specific settings. Comments have been added in `config.example.yml` to explain each property.
 
 ## Available Scripts
 

apps/agent/config.example.yml

@@ -1,33 +1,33 @@
 protocolProvider:
     rpcsConfig:
         l1:
-            chainId: eip155:11155111
-            transactionReceiptConfirmations: 1
-            timeout: 10000
-            retryInterval: 150
+            chainId: eip155:11155111 # Chain ID for Layer 1 network
+            transactionReceiptConfirmations: 1 # Confirmations needed for transactions on L1
+            timeout: 10000 # Timeout for RPC calls (ms)
+            retryInterval: 150 # Retry interval for RPC calls (ms)
         l2:
-            chainId: eip155:42161
+            chainId: eip155:42161 # Chain ID for Layer 2 network
             transactionReceiptConfirmations: 1
             timeout: 10000
             retryInterval: 150
     contracts:
-        oracle: "0x1234567890123456789012345678901234567890"
-        epochManager: "0x1234567890123456789012345678901234567890"
-        eboRequestCreator: "0x1234567890123456789012345678901234567890"
-        bondEscalationModule: "0x1234567890123456789012345678901234567890"
-        horizonAccountingExtension: "0x1234567890123456789012345678901234567890"
+        oracle: "0x1234567890123456789012345678901234567890" # Oracle contract address
+        epochManager: "0x1234567890123456789012345678901234567890" # Epoch Manager contract address
+        eboRequestCreator: "0x1234567890123456789012345678901234567890" # EBO Request Creator contract
+        bondEscalationModule: "0x1234567890123456789012345678901234567890" # Bond Escalation Module contract
+        horizonAccountingExtension: "0x1234567890123456789012345678901234567890" # Accounting extension contract
 
 blockNumberService:
     blockmetaConfig:
-        baseUrl: "localhost:443"
+        baseUrl: "localhost:443" # Base URL for Blockmeta service
         servicePaths:
-            blockByTime: /sf.blockmeta.v2.BlockByTime
-            block: /sf.blockmeta.v2.Block
-        bearerTokenExpirationWindow: 31536000000
+            blockByTime: /sf.blockmeta.v2.BlockByTime # Endpoint for block by time service
+            block: /sf.blockmeta.v2.Block # Endpoint for block service
+        bearerTokenExpirationWindow: 31536000000 # Expiration window for bearer token (ms)
 
 processor:
-    msBetweenChecks: 1000
+    msBetweenChecks: 1000 # Interval between periodic checks (ms)
     accountingModules:
-        requestModule: "0x1234567890123456789012345678901234567890"
-        responseModule: "0x1234567890123456789012345678901234567890"
-        escalationModule: "0x1234567890123456789012345678901234567890"
+        requestModule: "0x1234567890123456789012345678901234567890" # Address of the Request module
+        responseModule: "0x1234567890123456789012345678901234567890" # Address of the Response module
+        escalationModule: "0x1234567890123456789012345678901234567890" # Address of the Escalation module