Skip to content

Commit c06b5ea

Browse files
Fix eth-balance README (#4022)
* Fix eth-balance README * changeset --------- Co-authored-by: app-token-issuer-data-feeds[bot] <134377064+app-token-issuer-data-feeds[bot]@users.noreply.github.com>
1 parent 3581a3e commit c06b5ea

File tree

4 files changed

+36
-5
lines changed

4 files changed

+36
-5
lines changed

.changeset/chatty-news-complain.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@chainlink/eth-balance-adapter': patch
3+
---
4+
5+
Fix documentation

packages/sources/eth-balance/README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,29 @@ This document was generated automatically. Please see [README Generator](../../s
88

99
## Known Issues
1010

11+
### Per-network configuration
12+
13+
In addition to the `ETHEREUM_RPC_URL` and `ETHEREUM_CHAIN_ID` variable
14+
described below, the adapter requires `<network>_RPC_URL` and
15+
`<network>_RPC_CHAIN_ID` (where `<network>` is the upper case name of the
16+
network) to be set for each supported network.
17+
18+
For example, to support Arbitrum, you would need to set the `ARBITRUM_RPC_URL`
19+
and `ARBITRUM_RPC_CHAIN_ID` environment variables.
20+
21+
Note that this also means that `ETHEREUM_RPC_CHAIN_ID` needs to be set (to `1`)
22+
even if `ETHEREUM_CHAIN_ID` (without `_RPC`) is already set.
23+
1124
### MAX_PAYLOAD_SIZE_LIMIT configuration
1225

1326
The `MAX_PAYLOAD_SIZE_LIMIT` environment variable is used for controlling the maximum size of the incoming request body that the EA can handle. If you decide to customize this value it's essential to ensure that any reverse proxy or web server in front of the EA, such as Nginx, is also configured with a corresponding limit. This alignment prevents scenarios where Nginx rejects a request for exceeding its payload size limit before it reaches the EA.
1427

1528
## Environment Variables
1629

17-
| Required? | Name | Description | Type | Options | Default |
18-
| :-------: | :-------------------: | :-------------------------: | :----: | :-----: | :-----: |
19-
|| ETHEREUM_RPC_URL | RPC URL of an Ethereum node | string | | |
20-
| | ETHEREUM_RPC_CHAIN_ID | The chain id to connect to | string | | `1` |
30+
| Required? | Name | Description | Type | Options | Default |
31+
| :-------: | :---------------: | :-------------------------: | :----: | :-----: | :-----: |
32+
|| ETHEREUM_RPC_URL | RPC URL of an Ethereum node | string | | |
33+
| | ETHEREUM_CHAIN_ID | The chain id to connect to | string | | `1` |
2134

2235
---
2336

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
## Known Issues
22

3+
### Per-network configuration
4+
5+
In addition to the `ETHEREUM_RPC_URL` and `ETHEREUM_CHAIN_ID` variable
6+
described below, the adapter requires `<network>_RPC_URL` and
7+
`<network>_RPC_CHAIN_ID` (where `<network>` is the upper case name of the
8+
network) to be set for each supported network.
9+
10+
For example, to support Arbitrum, you would need to set the `ARBITRUM_RPC_URL`
11+
and `ARBITRUM_RPC_CHAIN_ID` environment variables.
12+
13+
Note that this also means that `ETHEREUM_RPC_CHAIN_ID` needs to be set (to `1`)
14+
even if `ETHEREUM_CHAIN_ID` (without `_RPC`) is already set.
15+
316
### MAX_PAYLOAD_SIZE_LIMIT configuration
417

518
The `MAX_PAYLOAD_SIZE_LIMIT` environment variable is used for controlling the maximum size of the incoming request body that the EA can handle. If you decide to customize this value it's essential to ensure that any reverse proxy or web server in front of the EA, such as Nginx, is also configured with a corresponding limit. This alignment prevents scenarios where Nginx rejects a request for exceeding its payload size limit before it reaches the EA.

packages/sources/eth-balance/schemas/env.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"type": "string",
1010
"description": "RPC URL of an Ethereum node"
1111
},
12-
"ETHEREUM_RPC_CHAIN_ID": {
12+
"ETHEREUM_CHAIN_ID": {
1313
"required": false,
1414
"description": "The chain id to connect to",
1515
"type": "string",

0 commit comments

Comments
 (0)