Skip to content

Commit 179056b

Browse files
author
corey
committed
fix tpo readme
1 parent e5e3122 commit 179056b

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

token-price-oracle/README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ Token Price Oracle service monitors token prices and updates the price ratio bet
1414

1515
## Quick Start
1616

17-
### Environment Variables
17+
### Environment Variables (Local Signing Mode)
1818

1919
```bash
2020
# Required
2121
export TOKEN_PRICE_ORACLE_L2_ETH_RPC="https://rpc.morphl2.io"
22-
export TOKEN_PRICE_ORACLE_PRIVATE_KEY="0x..."
22+
export TOKEN_PRICE_ORACLE_PRIVATE_KEY="0x..." # Required for local signing only
2323
export TOKEN_PRICE_ORACLE_BITGET_API_BASE_URL="https://api.bitget.com"
2424
export TOKEN_PRICE_ORACLE_TOKEN_MAPPING_BITGET="1:BTCUSDT,2:ETHUSDT"
2525

@@ -31,6 +31,8 @@ export TOKEN_PRICE_ORACLE_METRICS_PORT="6060"
3131
export TOKEN_PRICE_ORACLE_LOG_LEVEL="info"
3232
```
3333

34+
> **Note**: `PRIVATE_KEY` is only required when using local signing mode. For production, use [External Signing](#external-signing-recommended-for-production) instead.
35+
3436
### Build and Run
3537

3638
```bash
@@ -52,15 +54,20 @@ docker run -d \
5254

5355
## Configuration
5456

55-
### Required
57+
### Required (All Modes)
5658

5759
| Environment Variable | Description |
5860
|---------------------|-------------|
5961
| `TOKEN_PRICE_ORACLE_L2_ETH_RPC` | L2 node RPC endpoint |
60-
| `TOKEN_PRICE_ORACLE_PRIVATE_KEY` | Signing private key (local signing mode) |
6162
| `TOKEN_PRICE_ORACLE_BITGET_API_BASE_URL` | Bitget API base URL |
6263
| `TOKEN_PRICE_ORACLE_TOKEN_MAPPING_BITGET` | TokenID to trading pair mapping |
6364

65+
### Required (Local Signing Mode Only)
66+
67+
| Environment Variable | Description |
68+
|---------------------|-------------|
69+
| `TOKEN_PRICE_ORACLE_PRIVATE_KEY` | Signing private key (not needed if using external signing) |
70+
6471
### Optional
6572

6673
| Environment Variable | Default | Description |

0 commit comments

Comments
 (0)