From 0ddd070fcbaeaec765ddbc8de909f8c4b7814ba7 Mon Sep 17 00:00:00 2001 From: Ilaria <43253244+ilariae@users.noreply.github.com> Date: Fri, 6 Dec 2024 16:05:57 +0100 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Erin Shaben --- .../native-token-transfers/configuration/rate-limiting.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/build/contract-integrations/native-token-transfers/configuration/rate-limiting.md b/build/contract-integrations/native-token-transfers/configuration/rate-limiting.md index 810dbc82..76c72b66 100644 --- a/build/contract-integrations/native-token-transfers/configuration/rate-limiting.md +++ b/build/contract-integrations/native-token-transfers/configuration/rate-limiting.md @@ -12,7 +12,7 @@ If a transfer is rate-limited on the source chain and queueing is enabled via `s You can configure the following limits on every chain where NTT is deployed directly using the manager: - **Sending limit** - a single outbound limit for sending tokens from the chain -- **Per-chain receiving limits** - the maximum receiving limit, which can be configured on a per-chain basis. For example, allowing `100` tokens to be received from Ethereum but only 50 tokens to be received from Arbitrum +- **Per-chain receiving limits** - the maximum receiving limit, which can be configured on a per-chain basis. For example, allowing 100 tokens to be received from Ethereum but only 50 tokens to be received from Arbitrum Rate limits are replenished every second over a fixed duration. While the default duration is 24 hours, the value is configurable at contract creation. Rate-limited transfers on the destination chain are added to an inbound queue with a similar release delay. @@ -34,8 +34,8 @@ To configure or update the sending and receiving rate limits, follow these steps } ``` - - `outbound` - sets the maximum tokens allowed to leave the chain - - `inbound` - configure per-chain receiving limits for tokens arriving from specific chains + - **`outbound`** - sets the maximum tokens allowed to leave the chain + - **`inbound`** - configures per-chain receiving limits for tokens arriving from specific chains 3. **Push the configuration** - use the NTT CLI to synchronize the updated configuration with the blockchain @@ -87,7 +87,7 @@ When a transfer exceeds the rate limit, it is held in a queue and can be release - **Sending** - if an outbound transfer violates rate limits, users can either revert and try again later or queue their transfer. Users must return after the queue duration has expired to complete sending their transfer - **Receiving** - if an inbound transfer violates rate limits, it is in a queue. Users or relayers must return after the queue duration has expired to complete receiving their transfer on the destination chain -Queuing is configured dynamically during each transfer by passing the `shouldQueue` parameter to the [transfer function](https://github.com/wormhole-foundation/native-token-transfers/blob/5e7ceaef9a5e7eaa13e823a67c611dc684cc0c1d/evm/src/NttManager/NttManager.sol#L171-L182){target=\_blank} in the `NttManager` contract. +Queuing is configured dynamically during each transfer by passing the `shouldQueue` parameter to the [`transfer` function](https://github.com/wormhole-foundation/native-token-transfers/blob/5e7ceaef9a5e7eaa13e823a67c611dc684cc0c1d/evm/src/NttManager/NttManager.sol#L171-L182){target=\_blank} in the `NttManager` contract. ## Cancel Flows