@layerzerolabs/utils-evm-contracts 1.2.19 → 1.2.20

package/.turbo/turbo-lint.log

@@ -13,6 +13,9 @@ contracts/interfaces/IBurnableMintable.sol
   5:1  warning  Missing @author tag in contract 'IBurnableMintable'  use-natspec
   5:1  warning  Missing @notice tag in contract 'IBurnableMintable'  use-natspec
 
+contracts/interfaces/ICreditRedirect.sol
+  38:5  warning  GC: [amountLD] on Event [CreditRedirected] could be Indexed  gas-indexed-events
+
 contracts/interfaces/IFeeConfig.sol
   27:5  warning  GC: [id] on Event [FeeBpsSet] could be Indexed             gas-indexed-events
   27:5  warning  GC: [feeBps] on Event [FeeBpsSet] could be Indexed         gas-indexed-events
@@ -31,7 +34,7 @@ contracts/interfaces/IPauseByID.sol
 contracts/interfaces/IRateLimiter.sol
   134:5  warning  GC: [isExempt] on Event [RateLimitAddressExemptionUpdated] could be Indexed  gas-indexed-events
 
-✖ 14 problems (0 errors, 14 warnings)
+✖ 15 problems (0 errors, 15 warnings)
 
  -------------------------------------------------------------------------- 
  ===> Join SOLHINT Community at: https://discord.com/invite/4TYGq3zpjs <=== 

package/contracts/interfaces/ICreditRedirect.sol

@@ -0,0 +1,52 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.22;
+
+/**
+ * @title ICreditRedirect
+ * @author LayerZero Labs (tinom.eth)
+ * @custom:version 1.0.0
+ * @notice Interface for the `CreditRedirect` contract.
+ */
+interface ICreditRedirect {
+    /**
+     * @notice Credit redirect configuration.
+     * @param allowlist Allowlist address implementing `ICreditRedirectAllowlist`
+     * @param escrow Escrow address that will receive credits originally sent to a non-allowlisted user
+     */
+    struct CreditRedirectConfig {
+        address allowlist;
+        address escrow;
+    }
+
+    /**
+     * @notice Thrown when the credit redirect config has exactly one of `allowlist` or `escrow` unset.
+     */
+    error InvalidCreditRedirectConfig();
+
+    /**
+     * @notice Emitted when the credit redirect configuration is set.
+     * @param config Updated credit redirect configuration
+     */
+    event CreditRedirectConfigSet(CreditRedirectConfig config);
+
+    /**
+     * @notice Emitted when a credit to a non-allowlisted recipient is redirected to the escrow.
+     * @param from Original intended recipient
+     * @param to Escrow address that received the credit
+     * @param amountLD Redirected amount in local decimals
+     */
+    event CreditRedirected(address indexed from, address indexed to, uint256 amountLD);
+
+    /**
+     * @notice Returns the credit redirect configuration.
+     * @return config Credit redirect configuration
+     */
+    function creditRedirectConfig() external view returns (CreditRedirectConfig memory config);
+
+    /**
+     * @notice Sets the credit redirect configuration.
+     * @dev `allowlist` and `escrow` must both be set or both be `address(0)` (disabled).
+     * @param _config New credit redirect configuration
+     */
+    function setCreditRedirectConfig(CreditRedirectConfig calldata _config) external;
+}

package/contracts/interfaces/ICreditRedirectAllowlist.sol

@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.22;
+
+/**
+ * @title ICreditRedirectAllowlist
+ * @author LayerZero Labs (tinom.eth)
+ * @custom:version 1.0.0
+ * @notice Interface used by the `CreditRedirect` contract to query the allowlist status of a user.
+ */
+interface ICreditRedirectAllowlist {
+    /**
+     * @notice Checks if a user is allowlisted.
+     * @param _user User address
+     * @return isUserAllowlisted Whether the user is allowlisted
+     */
+    function isAllowlisted(address _user) external view returns (bool isUserAllowlisted);
+}

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@layerzerolabs/utils-evm-contracts",
-  "version": "1.2.19",
+  "version": "1.2.20",
   "private": false,
   "description": "LayerZero Labs reference EVM utility implementations",
   "license": "MIT",
   "devDependencies": {
     "@layerzerolabs/test-devtools-evm-foundry": "8.0.1",
     "@layerzerolabs/toolbox-foundry": "^0.1.13",
-    "@openzeppelin/contracts": ">=5.0.2 <5.5.0",
+    "@openzeppelin/contracts": "^5.0.2",
     "solhint": "^6.0.1",
-    "@layerzerolabs/solhint-configuration": "1.2.19",
-    "@layerzerolabs/vm-tooling-evm": "1.2.19"
+    "@layerzerolabs/solhint-configuration": "1.2.20",
+    "@layerzerolabs/vm-tooling-evm": "1.2.20"
   },
   "publishConfig": {
     "access": "public",