Skip to content

Commit 688323a

Browse files
committed
updates
1 parent cfbd87e commit 688323a

1 file changed

Lines changed: 15 additions & 12 deletions

File tree

contracts/README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,18 +33,21 @@ The FeeVault uses CREATE2 for deterministic addresses across chains.
3333

3434
### Environment Variables
3535

36-
| Variable | Deploy | Operational | Description |
37-
|----------|--------|-------------|-------------|
38-
| `OWNER` | Required | - | Owner address (can configure the vault) |
39-
| `SALT` | Optional | - | CREATE2 salt (default: `0x0`). Use any bytes32 value |
40-
| `DESTINATION_DOMAIN` | Optional | Required | Hyperlane destination chain ID |
41-
| `RECIPIENT_ADDRESS` | Optional | Required | Recipient on destination chain (bytes32, left-padded) |
42-
| `MINIMUM_AMOUNT` | Optional | Optional | Minimum wei to bridge |
43-
| `CALL_FEE` | Optional | Optional | Fee in wei for calling `sendToCelestia()` |
44-
| `BRIDGE_SHARE_BPS` | Optional | Optional | Basis points to bridge (default: 10000 = 100%) |
45-
| `OTHER_RECIPIENT` | Optional | Required* | Address to receive non-bridged portion |
46-
47-
*`OTHER_RECIPIENT` is required only if `BRIDGE_SHARE_BPS` < 10000
36+
All configuration is set via constructor arguments at deploy time:
37+
38+
| Variable | Required | Description |
39+
|----------|----------|-------------|
40+
| `OWNER` | Yes | Owner address (can configure the vault post-deployment) |
41+
| `SALT` | No | CREATE2 salt (default: `0x0`). Use any bytes32 value |
42+
| `DESTINATION_DOMAIN` | Yes* | Hyperlane destination chain ID |
43+
| `RECIPIENT_ADDRESS` | Yes* | Recipient on destination chain (bytes32, left-padded) |
44+
| `MINIMUM_AMOUNT` | No | Minimum wei to bridge (default: 0) |
45+
| `CALL_FEE` | No | Fee in wei for calling `sendToCelestia()` (default: 0) |
46+
| `BRIDGE_SHARE_BPS` | No | Basis points to bridge (default: 10000 = 100%) |
47+
| `OTHER_RECIPIENT` | No** | Address to receive non-bridged portion |
48+
49+
*Required for the vault to be operational (can be set to 0 at deploy and configured later via setters)
50+
**Required if `BRIDGE_SHARE_BPS` < 10000
4851

4952
**Note:** `HYP_NATIVE_MINTER` must be set via `setHypNativeMinter()` after deployment for the vault to be operational.
5053

0 commit comments

Comments
 (0)