Skip to content

Commit 3fe1c55

Browse files
Rahul MagantiRahulMaganti47
Rahul Maganti
authored andcommitted
evm: add warning to README
1 parent 28be41b commit 3fe1c55

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,7 @@ NTT supports rate-limiting both on the sending and destination chains. If a tran
3838

3939
## Cancel-Flows
4040

41-
If users bridge frequently between a given source chain and destination chain, the capacity could be exhausted quickly. This can leave other users rate-limited, potentially delaying their transfers. To mitigate this issue, the outbound transfer cancels the inbound rate-limit on the source chain (refills the inbound rate-limit by an amount equal to that of the outbound transfer amount) and vice-versa, the inbound transfer cancels the outbound rate-limit on the destination chain (refills the outbound raste-limit by an amount equal to the inbound transfer amount).
41+
If users bridge frequently between a given source chain and destination chain, the capacity could be exhausted quickly. This can leave other users rate-limited, potentially delaying their transfers. To mitigate this issue, the outbound transfer cancels the inbound rate-limit on the source chain (refills the inbound rate-limit by an amount equal to that of the outbound transfer amount) and vice-versa, the inbound transfer cancels the outbound rate-limit on the destination chain (refills the outbound rate-limit by an amount equal to the inbound transfer amount).
42+
43+
___
44+
⚠️ **WARNING:** Ensure that if the `NttManager` on the source chain is configured to be in `LOCKING` mode, the corresponding `NttManager`s on the target chains are configured to be in `BURNING` mode. If not, transfers will NOT go through and user funds may be lost! Proceed with caution!

evm/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,10 @@ cp WormholeNttConfig.json.sample WormholeNttConfig.json
223223

224224
Configure each network to your liking (including adding/removing networks). We will eventually add the addresses of the deployed contracts to this file. Navigate back to the `evm` directory.
225225

226+
___
227+
⚠️ **WARNING:** Ensure that if the `NttManager` on the source chain is configured to be in `LOCKING` mode, the corresponding `NttManager`s on the target chains are configured to be in `BURNING` mode. If not, transfers will NOT go through and user funds may be lost! Proceed with caution!
228+
___
229+
226230
Currently the per-chain `inBoundLimit` is set to zero by default. This means all inbound transfers will be queued by the rate limiter. Set this value accordingly.
227231

228232
#### Deploy

0 commit comments

Comments
 (0)