@layerzerolabs/lz-evm-v1-0.7 2.1.19 → 2.1.21

package/contracts/RelayerV2.sol

@@ -13,6 +13,7 @@ import "hardhat-deploy/solc_0.7/proxy/Proxied.sol";
 import "./interfaces/ILayerZeroRelayerV2.sol";
 import "./interfaces/ILayerZeroUltraLightNodeV2.sol";
 import "./interfaces/ILayerZeroPriceFeedV2.sol";
+import "./libs/RateLimiter.sol";
 
 interface IStargateComposer {
     function isSending() external view returns (bool);
@@ -23,6 +24,7 @@ contract RelayerV2 is ReentrancyGuard, OwnableUpgradeable, Proxied, ILayerZeroRe
     using SafeMath for uint;
     using SafeMath for uint128;
     using SafeMath for uint64;
+    using RateLimiter for RateLimiter.Info;
 
     ILayerZeroUltraLightNodeV2 public uln;
     address public stargateBridgeAddress;
@@ -95,6 +97,10 @@ contract RelayerV2 is ReentrancyGuard, OwnableUpgradeable, Proxied, ILayerZeroRe
 
     uint256 public nativeDecimalsRate;
 
+    RateLimiter.Info public limiter;
+
+    event RateLimiterSet(uint64 capacity, uint64 rate);
+
     // owner is always approved
     modifier onlyApproved() {
         if (owner() != msg.sender) {
@@ -186,6 +192,11 @@ contract RelayerV2 is ReentrancyGuard, OwnableUpgradeable, Proxied, ILayerZeroRe
 
     //----------------------------------------------------------------------------------
     // onlyOwner
+    function configRateLimiter(uint64 _capacity, uint64 _rate) external onlyOwner {
+        limiter.setCapacity(_capacity);
+        limiter.setRate(_rate);
+        emit RateLimiterSet(_capacity, _rate);
+    }
 
     function setApprovedAddress(address _relayerAddress, bool _approve) public onlyOwner {
         approvedAddresses[_relayerAddress] = _approve;
@@ -302,6 +313,11 @@ contract RelayerV2 is ReentrancyGuard, OwnableUpgradeable, Proxied, ILayerZeroRe
         uint _payloadSize,
         bytes calldata _adapterParams
     ) external override returns (uint fee) {
+        if (_dstChainId >= 10000 && limiter.capacity > 0) {
+            // sandbox or testnet
+            limiter.tryConsume(10000);
+        }
+
         require(msg.sender == address(uln), "Relayer: invalid uln");
         require(_payloadSize <= 10000, "Relayer: _payloadSize > 10000");
 

package/contracts/libs/RateLimiter.sol

@@ -0,0 +1,58 @@
+// SPDX-License-Identifier: BUSL-1.1
+// Copyright 2023 LayerZero Labs Ltd.
+// You may obtain a copy of the License at
+// https://github.com/LayerZero-Labs/license/blob/main/LICENSE-LZBL-1.1
+
+pragma solidity ^0.7.6;
+
+library RateLimiter {
+    struct Info {
+        // capacity of the token bucket. This is the maximum number of tokens that the bucket can hold at any given time
+        uint64 capacity;
+        // current number of tokens in the bucket
+        uint64 tokens;
+        // number of tokens refilled per second
+        uint64 rate;
+        // timestamp of last refill
+        uint64 lastRefillTime;
+    }
+
+    function setCapacity(Info storage _self, uint64 _capacity) internal {
+        _self.capacity = _capacity;
+        _self.tokens = _capacity;
+        _self.lastRefillTime = uint64(block.timestamp);
+    }
+
+    function setRate(Info storage _self, uint64 _rate) internal {
+        refill(_self, 0);
+        _self.rate = _rate;
+    }
+
+    function tryConsume(Info storage _self, uint64 _amount) internal returns (uint64) {
+        refill(_self, 0);
+
+        uint64 tokens = _self.tokens;
+        require(tokens >= _amount, "RelayerV2: out of counters - try again later!");
+
+        uint64 newTokens = tokens - _amount;
+        _self.tokens = newTokens;
+        return newTokens;
+    }
+
+    function refill(Info storage _self, uint64 _extraTokens) internal {
+        uint newTokens = _extraTokens;
+
+        uint64 currentTime = uint64(block.timestamp);
+        if (currentTime > _self.lastRefillTime) {
+            uint timeElapsedInSeconds = currentTime - _self.lastRefillTime;
+            newTokens += timeElapsedInSeconds * _self.rate;
+        }
+
+        if (newTokens > 0) {
+            newTokens += _self.tokens;
+            _self.tokens = newTokens > _self.capacity ? _self.capacity : uint64(newTokens);
+        }
+
+        _self.lastRefillTime = currentTime;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@layerzerolabs/lz-evm-v1-0.7",
-  "version": "2.1.19",
+  "version": "2.1.21",
   "license": "BUSL-1.1",
   "files": [
     "contracts/**/*"