Skip to content

Commit 7fca23f

Browse files
committed
update readme
1 parent 868986d commit 7fca23f

1 file changed

Lines changed: 14 additions & 10 deletions

File tree

contracts/README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,20 @@ The FeeVault uses CREATE2 for deterministic addresses across chains.
3333

3434
### Environment Variables
3535

36-
| Variable | Required | Description |
37-
|----------|----------|-------------|
38-
| `OWNER` | Yes | Owner address (can configure the vault) |
39-
| `SALT` | No | CREATE2 salt (default: `0x0`). Use any bytes32 value |
40-
| `DESTINATION_DOMAIN` | No | Hyperlane destination chain ID |
41-
| `RECIPIENT_ADDRESS` | No | Recipient on destination chain (bytes32, left-padded) |
42-
| `MINIMUM_AMOUNT` | No | Minimum wei to bridge |
43-
| `CALL_FEE` | No | Fee in wei for calling `sendToCelestia()` |
44-
| `BRIDGE_SHARE_BPS` | No | Basis points to bridge (default: 10000 = 100%) |
45-
| `OTHER_RECIPIENT` | No | Address to receive non-bridged portion |
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
48+
49+
**Note:** `HYP_NATIVE_MINTER` must be set via `setHypNativeMinter()` after deployment for the vault to be operational.
4650

4751
### Choosing a Salt
4852

0 commit comments

Comments
 (0)