docs: update readme & env.example

defi-wonderland · Sep 10, 2024 · 19c10f0 · 19c10f0
1 parent 9a13844
commit 19c10f0
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 11 deletions.
diff --git a/apps/api/.env.example b/apps/api/.env.example
@@ -2,12 +2,12 @@ PORT=3000 # Port to run the API server on
 
 ENVIRONMENT="" # Environment: 'mainnet' | 'testnet' | 'local'
 
-BRIDGE_HUB_ADDRESS="" 
-SHARED_BRIDGE_ADDRESS="" 
-STATE_MANAGER_ADDRESSES="" #CSV list of State managers addresses
+BRIDGE_HUB_ADDRESS="" # L1 Bridge hub address. Example: 0x303a465B659cBB0ab36eE643eA362c509EEb5213 for mainnet
+SHARED_BRIDGE_ADDRESS="" # L1 Shared bridge address. Example: 0xD7f9f54194C633F36CCD5F3da84ad4a1c38cB2cB for mainnet
+STATE_MANAGER_ADDRESSES="" # CSV list of State managers addresses. Example: 0xc2eE6b6af7d616f6e27ce7F4A451Aedc2b0F5f5C for mainnet
 
-L1_RPC_URLS=[] # array of L1 RPC URLs
-# map from chain id to array of L2 RPC URLs
+L1_RPC_URLS=[] # Array of L1 RPC URLs. Example: ["https://eth.llamarpc.com","https://rpc.flashbots.net/fast"]
+# Map from chain id to array of L2 RPC URLs. Example: {"324":"https://mainnet.era.zksync.io,https://zksync.drpc.org"}
 L2_RPC_URLS_MAP={}
 
 PRICING_SOURCE="dummy" # Pricing source: 'dummy' | 'coingecko'
@@ -23,7 +23,7 @@ CACHE_TTL=60 # Cache TTL in seconds for Providers and Services
 
 ## Metadata Vars
 METADATA_SOURCE='' # Metadata source: 'github' | 'local' | 'static'
-METADATA_TOKEN_URL='' # Metadata token URL (required if METADATA_SOURCE is 'github')
-METADATA_CHAIN_URL='' # Metadata chain URL (required if METADATA_SOURCE is 'github')
-METADATA_TOKEN_JSON_PATH='' # Metadata token JSON file path (required if METADATA_SOURCE is 'local')
-METADATA_CHAIN_JSON_PATH='' # Metadata chain JSON file path (required if METADATA_SOURCE is 'local')
+METADATA_TOKEN_URL='' # Metadata token URL (required if METADATA_SOURCE is 'github'). Example: https://raw.githubusercontent.com/defi-wonderland/ZKchainHub-metadata/main/tokens_mainnet.json
+METADATA_CHAIN_URL='' # Metadata chain URL (required if METADATA_SOURCE is 'github'). Example: https://raw.githubusercontent.com/defi-wonderland/ZKchainHub-metadata/main/chains_mainnet.json
+METADATA_TOKEN_JSON_PATH='' # Metadata token JSON file path (required if METADATA_SOURCE is 'local'). Example: /path/to/tokens_mainnet.json
+METADATA_CHAIN_JSON_PATH='' # Metadata chain JSON file path (required if METADATA_SOURCE is 'local'). Example: /path/to/chains_mainnet.json
diff --git a/apps/api/README.md b/apps/api/README.md
@@ -38,8 +38,8 @@ Available options:
 | `BRIDGE_HUB_ADDRESS` | Bridge Hub address | N/A | Yes | |
 | `SHARED_BRIDGE_ADDRESS` | Shared Bridge address | N/A | Yes | |
 | `STATE_MANAGER_ADDRESSES` | CSV list of State manager addresses | N/A | Yes | |
-| `L1_RPC_URLS` | JSON array of RPC URLs. For example, ["https://eth.llamarpc.com","https://rpc.flashbots.net/fast"] | N/A | Yes | You can check [Chainlist](https://chainlist.org/) for a list of public RPCs |
-| `L2_RPC_URLS_MAP` | JSON from chain id to CSV list of L2 RPC URLs. For example, {"324":"https://mainnet.era.zksync.io,https://zksync.drpc.org"} | N/A | No | You can check [Chainlist](https://chainlist.org/) for a list of public RPCs |
+| `L1_RPC_URLS` | JSON array of RPC URLs. For example, `["https://eth.llamarpc.com","https://rpc.flashbots.net/fast"]` | N/A | Yes | You can check [Chainlist](https://chainlist.org/) for a list of public RPCs |
+| `L2_RPC_URLS_MAP` | JSON from chain id to CSV list of L2 RPC URLs. For example, `{"324":"https://mainnet.era.zksync.io,https://zksync.drpc.org"}` | N/A | No | You can check [Chainlist](https://chainlist.org/) for a list of public RPCs |
 | `PRICING_SOURCE` | Pricing source to use (`'dummy'`, `'coingecko'`) | 'dummy' | No | |
 | `DUMMY_PRICE` | Price for dummy pricing source | undefined | No | Only applicable if `PRICING_SOURCE` is `'dummy'` |
 | `COINGECKO_API_KEY` | API key for CoinGecko | N/A | If `'coingecko'` is selected | You can get an API key by creating an account on [CoinGecko's site](https://www.coingecko.com/en/api) |