Merge branch 'master' into fix/fix-zksync-tests

.gas-snapshot

@@ -1,76 +1,77 @@
-EscrowFactoryTest:test_MultipleFillsInvalidKey() (gas: 474076)
-EscrowFactoryTest:test_MultipleFillsInvalidSecretsAmount() (gas: 473718)
-EscrowFactoryTest:test_NoDeploymentForNotResolver() (gas: 190767)
+EscrowFactoryTest:test_MultipleFillsInvalidKey() (gas: 474157)
+EscrowFactoryTest:test_MultipleFillsInvalidSecretsAmount() (gas: 473799)
+EscrowFactoryTest:test_NoDeploymentForNotResolver() (gas: 195258)
 EscrowFactoryTest:test_NoInsufficientBalanceDeploymentForMaker() (gas: 128468)
 EscrowFactoryTest:test_NoInsufficientBalanceDeploymentForTaker() (gas: 27118)
 EscrowFactoryTest:test_NoInsufficientBalanceNativeDeploymentForMaker() (gas: 121693)
 EscrowFactoryTest:test_NoInsufficientBalanceNativeDeploymentForTaker() (gas: 27377)
 EscrowFactoryTest:test_NoUnsafeDeploymentForTaker() (gas: 34495)
-EscrowTest:test_CancelDst() (gas: 116126)
-EscrowTest:test_CancelDstDifferentTarget() (gas: 143384)
-EscrowTest:test_CancelDstWithNativeToken() (gas: 93710)
-EscrowTest:test_CancelPublicSrc() (gas: 165464)
-EscrowTest:test_CancelResolverSrc() (gas: 168624)
+EscrowTest:test_CancelDst() (gas: 116076)
+EscrowTest:test_CancelDstDifferentTarget() (gas: 143334)
+EscrowTest:test_CancelDstWithNativeToken() (gas: 93670)
+EscrowTest:test_CancelPublicSrc() (gas: 170900)
+EscrowTest:test_CancelResolverSrc() (gas: 168607)
 EscrowTest:test_CancelResolverSrcReceiver() (gas: 179361)
-EscrowTest:test_NoAnyoneCancelDuringResolverCancelSrc() (gas: 163836)
-EscrowTest:test_NoCallsWithInvalidImmutables() (gas: 286516)
+EscrowTest:test_NoAnyoneCancelDuringResolverCancelSrc() (gas: 163856)
+EscrowTest:test_NoCallsWithInvalidImmutables() (gas: 286518)
 EscrowTest:test_NoCancelByAnyoneDst() (gas: 121726)
 EscrowTest:test_NoCancelDuringWithdrawalDst() (gas: 121486)
-EscrowTest:test_NoCancelDuringWithdrawalSrc() (gas: 163959)
-EscrowTest:test_NoFailedNativeTokenTransferCancelSrc() (gas: 179302)
-EscrowTest:test_NoFailedNativeTokenTransferWithdrawalDst() (gas: 154544)
-EscrowTest:test_NoFailedNativeTokenTransferWithdrawalSrc() (gas: 312369)
-EscrowTest:test_NoPublicCancelDuringPrivateCancellationSrc() (gas: 163146)
-EscrowTest:test_NoPublicWithdrawOutsideOfAllowedPeriodDst() (gas: 126910)
-EscrowTest:test_NoPublicWithdrawalOutsideOfAllowedPeriodSrc() (gas: 169083)
-EscrowTest:test_NoRescueFundsByAnyoneDst() (gas: 176370)
-EscrowTest:test_NoRescueFundsByAnyoneSrc() (gas: 209064)
-EscrowTest:test_NoRescueFundsEarlierDst() (gas: 175780)
-EscrowTest:test_NoRescueFundsEarlierSrc() (gas: 208981)
-EscrowTest:test_NoRevertFailedNativeTokenTransferWithdrawalDstNative() (gas: 91111)
+EscrowTest:test_NoCancelDuringWithdrawalSrc() (gas: 164001)
+EscrowTest:test_NoFailedNativeTokenTransferCancelSrc() (gas: 216919)
+EscrowTest:test_NoFailedNativeTokenTransferWithdrawalDst() (gas: 192056)
+EscrowTest:test_NoFailedNativeTokenTransferWithdrawalDstNative() (gas: 84157)
+EscrowTest:test_NoFailedNativeTokenTransferWithdrawalSrc() (gas: 349820)
+EscrowTest:test_NoPublicCallsByAnyone() (gas: 287575)
+EscrowTest:test_NoPublicCancelDuringPrivateCancellationSrc() (gas: 168572)
+EscrowTest:test_NoPublicWithdrawOutsideOfAllowedPeriodDst() (gas: 137737)
+EscrowTest:test_NoPublicWithdrawalOutsideOfAllowedPeriodSrc() (gas: 179920)
+EscrowTest:test_NoRescueFundsByAnyoneDst() (gas: 176333)
+EscrowTest:test_NoRescueFundsByAnyoneSrc() (gas: 209079)
+EscrowTest:test_NoRescueFundsEarlierDst() (gas: 175721)
+EscrowTest:test_NoRescueFundsEarlierSrc() (gas: 208959)
 EscrowTest:test_NoWithdrawalByAnyoneSrc() (gas: 160853)
 EscrowTest:test_NoWithdrawalByNonResolverDst() (gas: 121439)
 EscrowTest:test_NoWithdrawalOutsideOfAllowedPeriodDst() (gas: 126326)
-EscrowTest:test_NoWithdrawalOutsideOfAllowedPeriodSrc() (gas: 169636)
-EscrowTest:test_NoWithdrawalWithWrongSecretDst() (gas: 122776)
+EscrowTest:test_NoWithdrawalOutsideOfAllowedPeriodSrc() (gas: 169627)
+EscrowTest:test_NoWithdrawalWithWrongSecretDst() (gas: 122798)
 EscrowTest:test_NoWithdrawalWithWrongSecretSrc() (gas: 164448)
-EscrowTest:test_PublicWithdrawSrc() (gas: 181761)
-EscrowTest:test_RescueFundsDst() (gas: 158304)
-EscrowTest:test_RescueFundsDstNative() (gas: 186735)
-EscrowTest:test_RescueFundsSrc() (gas: 195453)
+EscrowTest:test_PublicWithdrawSrc() (gas: 187154)
+EscrowTest:test_RescueFundsDst() (gas: 158237)
+EscrowTest:test_RescueFundsDstNative() (gas: 186700)
+EscrowTest:test_RescueFundsSrc() (gas: 195445)
 EscrowTest:test_RescueFundsSrcNative() (gas: 197742)
-EscrowTest:test_WithdrawByAnyoneDst() (gas: 141326)
-EscrowTest:test_WithdrawByResolverDst() (gas: 142389)
-EscrowTest:test_WithdrawByResolverDstNative() (gas: 97831)
-EscrowTest:test_WithdrawByResolverPublicDst() (gas: 141757)
+EscrowTest:test_WithdrawByAnyoneDst() (gas: 146701)
+EscrowTest:test_WithdrawByResolverDst() (gas: 142374)
+EscrowTest:test_WithdrawByResolverDstNative() (gas: 97859)
+EscrowTest:test_WithdrawByResolverPublicDst() (gas: 141720)
 EscrowTest:test_WithdrawSrc() (gas: 186522)
 EscrowTest:test_WithdrawSrcTo() (gas: 191335)
-IntegrationEscrowFactoryTest:test_DeployCloneForMakerNonWhitelistedResolverInt() (gas: 473542)
-IntegrationEscrowFactoryTest:test_NoInsufficientBalanceDeploymentForMakerInt() (gas: 341264)
-IntegrationEscrowFactoryTest:test_NoResolverReentrancy() (gas: 2065184)
-IntegrationResolverMockTest:test_MockCancelDst() (gas: 157184)
-IntegrationResolverMockTest:test_MockCancelSrc() (gas: 353957)
+IntegrationEscrowFactoryTest:test_DeployCloneForMakerNonWhitelistedResolverInt() (gas: 510255)
+IntegrationEscrowFactoryTest:test_NoInsufficientBalanceDeploymentForMakerInt() (gas: 341345)
+IntegrationEscrowFactoryTest:test_NoResolverReentrancy() (gas: 2065268)
+IntegrationResolverMockTest:test_MockCancelDst() (gas: 157134)
+IntegrationResolverMockTest:test_MockCancelSrc() (gas: 354038)
 IntegrationResolverMockTest:test_MockDeployDst() (gas: 151470)
-IntegrationResolverMockTest:test_MockDeploySrc() (gas: 365054)
-IntegrationResolverMockTest:test_MockPublicCancelSrc() (gas: 392471)
-IntegrationResolverMockTest:test_MockPublicWithdrawDst() (gas: 164841)
-IntegrationResolverMockTest:test_MockRescueFundsDst() (gas: 161103)
-IntegrationResolverMockTest:test_MockRescueFundsSrc() (gas: 382622)
-IntegrationResolverMockTest:test_MockWithdrawDst() (gas: 182912)
-IntegrationResolverMockTest:test_MockWithdrawToSrc() (gas: 354839)
-MerkleStorageInvalidatorIntTest:test_MultipleFillsFillAllExtra() (gas: 923554)
-MerkleStorageInvalidatorIntTest:test_MultipleFillsFillAllFromLast() (gas: 922336)
-MerkleStorageInvalidatorIntTest:test_MultipleFillsFillAllTwoFills() (gas: 922158)
-MerkleStorageInvalidatorIntTest:test_MultipleFillsFillFirst() (gas: 707638)
-MerkleStorageInvalidatorIntTest:test_MultipleFillsFillFirstTwoFills() (gas: 932982)
-MerkleStorageInvalidatorIntTest:test_MultipleFillsFillLast() (gas: 707218)
-MerkleStorageInvalidatorIntTest:test_MultipleFillsNoDeploymentWithoutValidation() (gas: 301343)
-MerkleStorageInvalidatorIntTest:test_MultipleFillsNoReuseOfSecrets() (gas: 1068017)
-MerkleStorageInvalidatorIntTest:test_MultipleFillsNoSecondDeploymentWithTheSameIndex() (gas: 786011)
-MerkleStorageInvalidatorIntTest:test_MultipleFillsOddDivision() (gas: 444783)
-MerkleStorageInvalidatorIntTest:test_MultipleFillsOneFill() (gas: 707615)
-MerkleStorageInvalidatorIntTest:test_MultipleFillsTwoFills() (gas: 921433)
-MerkleStorageInvalidatorTest:test_ShortenedProofIsNotValid() (gas: 230552)
-TimelocksLibTest:test_NoTimelocksOverflow() (gas: 156200)
+IntegrationResolverMockTest:test_MockDeploySrc() (gas: 364984)
+IntegrationResolverMockTest:test_MockPublicCancelSrc() (gas: 397961)
+IntegrationResolverMockTest:test_MockPublicWithdrawDst() (gas: 170216)
+IntegrationResolverMockTest:test_MockRescueFundsDst() (gas: 161053)
+IntegrationResolverMockTest:test_MockRescueFundsSrc() (gas: 382664)
+IntegrationResolverMockTest:test_MockWithdrawDst() (gas: 182875)
+IntegrationResolverMockTest:test_MockWithdrawToSrc() (gas: 354920)
+MerkleStorageInvalidatorIntTest:test_MultipleFillsFillAllExtra() (gas: 923635)
+MerkleStorageInvalidatorIntTest:test_MultipleFillsFillAllFromLast() (gas: 922417)
+MerkleStorageInvalidatorIntTest:test_MultipleFillsFillAllTwoFills() (gas: 922239)
+MerkleStorageInvalidatorIntTest:test_MultipleFillsFillFirst() (gas: 707710)
+MerkleStorageInvalidatorIntTest:test_MultipleFillsFillFirstTwoFills() (gas: 933041)
+MerkleStorageInvalidatorIntTest:test_MultipleFillsFillLast() (gas: 707378)
+MerkleStorageInvalidatorIntTest:test_MultipleFillsNoDeploymentWithoutValidation() (gas: 301424)
+MerkleStorageInvalidatorIntTest:test_MultipleFillsNoReuseOfSecrets() (gas: 1068098)
+MerkleStorageInvalidatorIntTest:test_MultipleFillsNoSecondDeploymentWithTheSameIndex() (gas: 786092)
+MerkleStorageInvalidatorIntTest:test_MultipleFillsOddDivision() (gas: 444873)
+MerkleStorageInvalidatorIntTest:test_MultipleFillsOneFill() (gas: 707726)
+MerkleStorageInvalidatorIntTest:test_MultipleFillsTwoFills() (gas: 921505)
+MerkleStorageInvalidatorTest:test_ShortenedProofIsNotValid() (gas: 230686)
+TimelocksLibTest:test_NoTimelocksOverflow() (gas: 193707)
 TimelocksLibTest:test_getStartTimestamps() (gas: 16207)
 TimelocksLibTest:test_setDeployedAt() (gas: 5741)

.github/workflows/test.yml

@@ -37,7 +37,7 @@ jobs:
         uses: foundry-rs/foundry-toolchain@v1
       - name: Run tests
         run: FOUNDRY_PROFILE=default forge test -vvv --gas-report
-  
+
   test-zksync:
     runs-on: ubuntu-latest
     steps:
@@ -52,7 +52,7 @@ jobs:
 
       - name: Install Foundry for zksync
         run: cd foundry-zksync && ./install-foundry-zksync
-  
+
       - name: Run tests
         run: FOUNDRY_PROFILE=zksync forge test -vvv --zksync
 

.gitignore

@@ -8,11 +8,13 @@ build
 .coverage_artifacts
 .idea
 .env
+.env.deployment
 .DS_Store
 
 # foundry
 cache_forge
 out
+broadcast
 
 # zkSync
 zkout

codecov.yml

@@ -1,3 +1,4 @@
 ignore:
   - "test"
   - "contracts/mocks"
+  - "script"

contracts/BaseEscrow.sol

@@ -22,13 +22,17 @@ abstract contract BaseEscrow is IBaseEscrow {
     using TimelocksLib for Timelocks;
     using ImmutablesLib for Immutables;
 
+    // Token that is used to access public withdraw or cancel functions.
+    IERC20 private immutable _ACCESS_TOKEN;
+
     /// @notice See {IBaseEscrow-RESCUE_DELAY}.
     uint256 public immutable RESCUE_DELAY;
     /// @notice See {IBaseEscrow-FACTORY}.
     address public immutable FACTORY = msg.sender;
 
-    constructor(uint32 rescueDelay) {
+    constructor(uint32 rescueDelay, IERC20 accessToken) {
         RESCUE_DELAY = rescueDelay;
+        _ACCESS_TOKEN = accessToken;
     }
 
     modifier onlyTaker(Immutables calldata immutables) {
@@ -56,6 +60,11 @@ abstract contract BaseEscrow is IBaseEscrow {
         _;
     }
 
+    modifier onlyAccessTokenHolder() {
+        if (_ACCESS_TOKEN.balanceOf(msg.sender) == 0) revert InvalidCaller();
+        _;
+    }
+
     /**
      * @notice See {IBaseEscrow-rescueFunds}.
      */

contracts/BaseEscrowFactory.sol

@@ -175,7 +175,8 @@ abstract contract BaseEscrowFactory is IEscrowFactory, ResolverValidationExtensi
         uint256 calculatedIndex = (orderMakingAmount - remainingMakingAmount + makingAmount - 1) * partsAmount / orderMakingAmount;
 
         if (remainingMakingAmount == makingAmount) {
-            // The last secret must be used for the last fill.
+            // If the order is filled to completion, a secret with index i + 1 must be used
+            // where i is the index of the secret for the last part.
             return (calculatedIndex + 2 == validatedIndex);
         } else if (orderMakingAmount != remainingMakingAmount) {
             // Calculate the previous fill index only if this is not the first fill.

contracts/EscrowDst.sol

@@ -24,7 +24,7 @@ contract EscrowDst is Escrow, IEscrowDst {
     using AddressLib for Address;
     using TimelocksLib for Timelocks;
 
-    constructor(uint32 rescueDelay) BaseEscrow(rescueDelay) {}
+    constructor(uint32 rescueDelay, IERC20 accessToken) BaseEscrow(rescueDelay, accessToken) {}
 
     /**
      * @notice See {IBaseEscrow-withdraw}.
@@ -47,6 +47,7 @@ contract EscrowDst is Escrow, IEscrowDst {
      */
     function publicWithdraw(bytes32 secret, Immutables calldata immutables)
         external
+        onlyAccessTokenHolder()
         onlyAfter(immutables.timelocks.get(TimelocksLib.Stage.DstPublicWithdrawal))
         onlyBefore(immutables.timelocks.get(TimelocksLib.Stage.DstCancellation))
     {
@@ -78,19 +79,8 @@ contract EscrowDst is Escrow, IEscrowDst {
         onlyValidImmutables(immutables)
         onlyValidSecret(secret, immutables)
     {
-        address token = immutables.token.get();
-        address to = immutables.maker.get();
-        if (token == address(0)) {
-            /**
-             * @dev The result of the call is not checked intentionally. This is done to ensure that
-             * even in case of malicious receiver the withdrawal flow can not be blocked and takers
-             * will be able to get their safety deposit back.
-             **/
-            to.call{ value: immutables.amount }("");
-        } else {
-            IERC20(token).safeTransfer(to, immutables.amount);
-        }
+        _uniTransfer(immutables.token.get(), immutables.maker.get(), immutables.amount);
         _ethTransfer(msg.sender, immutables.safetyDeposit);
-        emit Withdrawal(secret);
+        emit EscrowWithdrawal(secret);
     }
 }

contracts/EscrowFactory.sol

@@ -32,8 +32,8 @@ contract EscrowFactory is BaseEscrowFactory {
     BaseExtension(limitOrderProtocol)
     ResolverValidationExtension(feeToken, accessToken, owner)
     MerkleStorageInvalidator(limitOrderProtocol) {
-        ESCROW_SRC_IMPLEMENTATION = address(new EscrowSrc(rescueDelaySrc));
-        ESCROW_DST_IMPLEMENTATION = address(new EscrowDst(rescueDelayDst));
+        ESCROW_SRC_IMPLEMENTATION = address(new EscrowSrc(rescueDelaySrc, accessToken));
+        ESCROW_DST_IMPLEMENTATION = address(new EscrowDst(rescueDelayDst, accessToken));
         _PROXY_SRC_BYTECODE_HASH = ProxyHashLib.computeProxyBytecodeHash(ESCROW_SRC_IMPLEMENTATION);
         _PROXY_DST_BYTECODE_HASH = ProxyHashLib.computeProxyBytecodeHash(ESCROW_DST_IMPLEMENTATION);
     }

contracts/EscrowSrc.sol

@@ -27,7 +27,7 @@ contract EscrowSrc is Escrow, IEscrowSrc {
     using SafeERC20 for IERC20;
     using TimelocksLib for Timelocks;
 
-    constructor(uint32 rescueDelay) BaseEscrow(rescueDelay) {}
+    constructor(uint32 rescueDelay, IERC20 accessToken) BaseEscrow(rescueDelay, accessToken) {}
 
     /**
      * @notice See {IBaseEscrow-withdraw}.
@@ -67,6 +67,7 @@ contract EscrowSrc is Escrow, IEscrowSrc {
      */
     function publicWithdraw(bytes32 secret, Immutables calldata immutables)
         external
+        onlyAccessTokenHolder()
         onlyAfter(immutables.timelocks.get(TimelocksLib.Stage.SrcPublicWithdrawal))
         onlyBefore(immutables.timelocks.get(TimelocksLib.Stage.SrcCancellation))
     {
@@ -95,6 +96,7 @@ contract EscrowSrc is Escrow, IEscrowSrc {
      */
     function publicCancel(Immutables calldata immutables)
         external
+        onlyAccessTokenHolder()
         onlyAfter(immutables.timelocks.get(TimelocksLib.Stage.SrcPublicCancellation))
     {
         _cancel(immutables);
@@ -113,7 +115,7 @@ contract EscrowSrc is Escrow, IEscrowSrc {
     {
         IERC20(immutables.token.get()).safeTransfer(target, immutables.amount);
         _ethTransfer(msg.sender, immutables.safetyDeposit);
-        emit Withdrawal(secret);
+        emit EscrowWithdrawal(secret);
     }
 
     /**

contracts/interfaces/IBaseEscrow.sol

@@ -39,7 +39,7 @@ interface IBaseEscrow {
      * @notice Emitted on successful withdrawal.
      * @param secret The secret that unlocks the escrow.
      */
-    event Withdrawal(bytes32 secret);
+    event EscrowWithdrawal(bytes32 secret);
 
     error InvalidCaller();
     error InvalidImmutables();

contracts/zkSync/EscrowDstZkSync.sol

@@ -2,12 +2,14 @@
 
 pragma solidity 0.8.23;
 
+import { IERC20 } from "openzeppelin-contracts/contracts/token/ERC20/IERC20.sol";
+
 import { Escrow, EscrowDst } from "../EscrowDst.sol";
 import { EscrowZkSync } from "./EscrowZkSync.sol";
 
 /// @custom:security-contact [email protected]
 contract EscrowDstZkSync is EscrowDst, EscrowZkSync {
-    constructor(uint32 rescueDelay) EscrowDst(rescueDelay) EscrowZkSync() {}
+    constructor(uint32 rescueDelay, IERC20 accessToken) EscrowDst(rescueDelay, accessToken) EscrowZkSync() {}
 
     function _validateImmutables(Immutables calldata immutables) internal view override(Escrow, EscrowZkSync) {
         EscrowZkSync._validateImmutables(immutables);

contracts/zkSync/EscrowFactoryZkSync.sol

@@ -38,8 +38,8 @@ contract EscrowFactoryZkSync is BaseEscrowFactory {
     BaseExtension(limitOrderProtocol)
     ResolverValidationExtension(feeToken, accessToken, owner)
     MerkleStorageInvalidator(limitOrderProtocol) {
-        ESCROW_SRC_IMPLEMENTATION = address(new EscrowSrcZkSync(rescueDelaySrc));
-        ESCROW_DST_IMPLEMENTATION = address(new EscrowDstZkSync(rescueDelayDst));
+        ESCROW_SRC_IMPLEMENTATION = address(new EscrowSrcZkSync(rescueDelaySrc, accessToken));
+        ESCROW_DST_IMPLEMENTATION = address(new EscrowDstZkSync(rescueDelayDst, accessToken));
         ESCROW_SRC_INPUT_HASH = keccak256(abi.encode(ESCROW_SRC_IMPLEMENTATION));
         ESCROW_DST_INPUT_HASH = keccak256(abi.encode(ESCROW_DST_IMPLEMENTATION));
         MinimalProxyZkSync proxySrc = new MinimalProxyZkSync(ESCROW_SRC_IMPLEMENTATION);

contracts/zkSync/EscrowSrcZkSync.sol

@@ -2,12 +2,14 @@
 
 pragma solidity 0.8.23;
 
+import { IERC20 } from "openzeppelin-contracts/contracts/token/ERC20/IERC20.sol";
+
 import { Escrow, EscrowSrc } from "../EscrowSrc.sol";
 import { EscrowZkSync } from "./EscrowZkSync.sol";
 
 /// @custom:security-contact [email protected]
 contract EscrowSrcZkSync is EscrowSrc, EscrowZkSync {
-    constructor(uint32 rescueDelay) EscrowSrc(rescueDelay) EscrowZkSync() {}
+    constructor(uint32 rescueDelay, IERC20 accessToken) EscrowSrc(rescueDelay, accessToken) EscrowZkSync() {}
 
     function _validateImmutables(Immutables calldata immutables) internal view override(Escrow, EscrowZkSync) {
         EscrowZkSync._validateImmutables(immutables);