feat: Simplify CCIPLocalSimulator.sol using MockRouter

smartcontractkit · Apr 16, 2024 · b8e5d15 · b8e5d15
1 parent 0fdd6b0
commit b8e5d15
Show file tree

Hide file tree

Showing 16 changed files with 2,931 additions and 712 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -28,6 +28,6 @@
     "hardhat": "^2.20.1"
   },
   "dependencies": {
-    "@chainlink/contracts-ccip": "^1.2.1"
+    "@chainlink/contracts-ccip": "^1.4.0"
   }
 }
diff --git a/src/ccip/CCIPLocalSimulator.sol b/src/ccip/CCIPLocalSimulator.sol
diff --git a/src/ccip/CCIPLocalSimulatorFork.sol b/src/ccip/CCIPLocalSimulatorFork.sol
@@ -3,10 +3,11 @@ pragma solidity 0.8.19;
 
 import {Test, Vm} from "forge-std/Test.sol";
 import {Register} from "./Register.sol";
-import {Internal, Router} from "./CCIPLocalSimulator.sol";
+import {Router} from "@chainlink/contracts-ccip/src/v0.8/ccip/Router.sol";
+import {Internal} from "@chainlink/contracts-ccip/src/v0.8/ccip/onRamp/EVM2EVMOnRamp.sol";
 import {EVM2EVMOffRamp} from "@chainlink/contracts-ccip/src/v0.8/ccip/offRamp/EVM2EVMOffRamp.sol";
 import {IERC20} from
-    "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.0/contracts/token/ERC20/IERC20.sol";
+    "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.3/contracts/token/ERC20/IERC20.sol";
 
 // @notice Works with Foundry only
 contract CCIPLocalSimulatorFork is Test {

diff --git a/src/ccip/CCIPLocalSimulatorV0.sol b/src/ccip/CCIPLocalSimulatorV0.sol
diff --git a/src/ccip/MockEvm2EvmOffRamp.sol b/src/ccip/MockEvm2EvmOffRamp.sol
@@ -12,9 +12,9 @@ import {EnumerableMapAddresses} from "@chainlink/contracts-ccip/src/v0.8/shared/
 import {RateLimiter} from "@chainlink/contracts-ccip/src/v0.8/ccip/libraries/RateLimiter.sol";
 import {USDPriceWith18Decimals} from "@chainlink/contracts-ccip/src/v0.8/ccip/libraries/USDPriceWith18Decimals.sol";
 import {AggregateRateLimiter} from "@chainlink/contracts-ccip/src/v0.8/ccip/AggregateRateLimiter.sol";
-import {IERC20} from "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.0/contracts/token/ERC20/IERC20.sol";
-import {Address} from "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.0/contracts/utils/Address.sol";
-import {ERC165Checker} from "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.0/contracts/utils/introspection/ERC165Checker.sol";
+import {IERC20} from "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.3/contracts/token/ERC20/IERC20.sol";
+import {Address} from "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.3/contracts/utils/Address.sol";
+import {ERC165Checker} from "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.3/contracts/utils/introspection/ERC165Checker.sol";
 
 contract MockEvm2EvmOffRamp is AggregateRateLimiter {
     using EnumerableMapAddresses for EnumerableMapAddresses.AddressToAddressMap;

diff --git a/src/test/ccip/BasicTokenSender.sol b/src/test/ccip/BasicTokenSender.sol
@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.19;
 
-import {IERC20} from "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.0/contracts/token/ERC20/IERC20.sol";
-import {SafeERC20} from "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.0/contracts/token/ERC20/utils/SafeERC20.sol";
+import {IERC20} from "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.3/contracts/token/ERC20/IERC20.sol";
+import {SafeERC20} from "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.3/contracts/token/ERC20/utils/SafeERC20.sol";
 import {IRouterClient} from "@chainlink/contracts-ccip/src/v0.8/ccip/interfaces/IRouterClient.sol";
 import {Client} from "@chainlink/contracts-ccip/src/v0.8/ccip/libraries/Client.sol";
 

diff --git a/src/test/ccip/CCIPSender_Unsafe.sol b/src/test/ccip/CCIPSender_Unsafe.sol
@@ -3,7 +3,7 @@ pragma solidity ^0.8.19;
 
 import {Client} from "@chainlink/contracts-ccip/src/v0.8/ccip/libraries/Client.sol";
 import {IRouterClient} from "@chainlink/contracts-ccip/src/v0.8/ccip/interfaces/IRouterClient.sol";
-import {IERC20} from "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.0/contracts/token/ERC20/IERC20.sol";
+import {IERC20} from "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.3/contracts/token/ERC20/IERC20.sol";
 
 contract CCIPSender_Unsafe {
     address link;

diff --git a/src/test/ccip/Ping.sol b/src/test/ccip/Ping.sol
@@ -3,7 +3,7 @@ pragma solidity ^0.8.19;
 
 import {Client} from "@chainlink/contracts-ccip/src/v0.8/ccip/libraries/Client.sol";
 import {IRouterClient} from "@chainlink/contracts-ccip/src/v0.8/ccip/interfaces/IRouterClient.sol";
-import {IERC20} from "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.0/contracts/token/ERC20/IERC20.sol";
+import {IERC20} from "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.3/contracts/token/ERC20/IERC20.sol";
 import {CCIPReceiver} from "@chainlink/contracts-ccip/src/v0.8/ccip/applications/CCIPReceiver.sol";
 
 contract Ping is CCIPReceiver {
@@ -27,7 +27,7 @@ contract Ping is CCIPReceiver {
             tokenAmounts: new Client.EVMTokenAmount[](0),
             extraArgs: Client._argsToBytes(
                 // Additional arguments, setting gas limit
-                Client.EVMExtraArgsV1({gasLimit: 2_500_000})
+                Client.EVMExtraArgsV1({gasLimit: 500_000})
             ),
             feeToken: link
         });

diff --git a/src/test/ccip/Pong.sol b/src/test/ccip/Pong.sol
@@ -3,7 +3,7 @@ pragma solidity ^0.8.19;
 
 import {Client} from "@chainlink/contracts-ccip/src/v0.8/ccip/libraries/Client.sol";
 import {IRouterClient} from "@chainlink/contracts-ccip/src/v0.8/ccip/interfaces/IRouterClient.sol";
-import {IERC20} from "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.0/contracts/token/ERC20/IERC20.sol";
+import {IERC20} from "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.3/contracts/token/ERC20/IERC20.sol";
 import {CCIPReceiver} from "@chainlink/contracts-ccip/src/v0.8/ccip/applications/CCIPReceiver.sol";
 
 contract Pong is CCIPReceiver {

diff --git a/src/test/ccip/ProgrammableDefensiveTokenTransfers.sol b/src/test/ccip/ProgrammableDefensiveTokenTransfers.sol
@@ -6,11 +6,11 @@ import {OwnerIsCreator} from "@chainlink/contracts-ccip/src/v0.8/shared/access/O
 import {Client} from "@chainlink/contracts-ccip/src/v0.8/ccip/libraries/Client.sol";
 import {CCIPReceiver} from "@chainlink/contracts-ccip/src/v0.8/ccip/applications/CCIPReceiver.sol";
 import {IERC20} from
-    "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.0/contracts/token/ERC20/IERC20.sol";
+    "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.3/contracts/token/ERC20/IERC20.sol";
 import {SafeERC20} from
-    "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.0/contracts/token/ERC20/utils/SafeERC20.sol";
+    "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.3/contracts/token/ERC20/utils/SafeERC20.sol";
 import {EnumerableMap} from
-    "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.0/contracts/utils/structs/EnumerableMap.sol";
+    "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.3/contracts/utils/structs/EnumerableMap.sol";
 
 /**
  * THIS IS AN EXAMPLE CONTRACT THAT USES HARDCODED VALUES FOR CLARITY.
@@ -37,9 +37,8 @@ contract ProgrammableDefensiveTokenTransfers is CCIPReceiver, OwnerIsCreator {
     error MessageNotFailed(bytes32 messageId);
 
     // Example error code, could have many different error codes.
-    enum ErrorCode
-    // RESOLVED is first so that the default value is resolved.
-    {
+    enum ErrorCode {
+        // RESOLVED is first so that the default value is resolved.
         RESOLVED,
         // Could have any number of error codes here.
         FAILED
@@ -58,7 +57,8 @@ contract ProgrammableDefensiveTokenTransfers is CCIPReceiver, OwnerIsCreator {
     // The token amount that was transferred.
     // the token address used to pay CCIP fees.
     // The fees paid for sending the message.
-    event MessageSent( // The unique ID of the CCIP message.
+    // The unique ID of the CCIP message.
+    event MessageSent(
         bytes32 indexed messageId,
         uint64 indexed destinationChainSelector,
         address receiver,
@@ -75,7 +75,8 @@ contract ProgrammableDefensiveTokenTransfers is CCIPReceiver, OwnerIsCreator {
     // The text that was received.
     // The token address that was transferred.
     // The token amount that was transferred.
-    event MessageReceived( // The unique ID of the CCIP message.
+    // The unique ID of the CCIP message.
+    event MessageReceived(
         bytes32 indexed messageId,
         uint64 indexed sourceChainSelector,
         address sender,
@@ -309,9 +310,7 @@ contract ProgrammableDefensiveTokenTransfers is CCIPReceiver, OwnerIsCreator {
 
         // Calculate the actual number of items to return (can't exceed total length or requested limit)
         uint256 returnLength = (offset + limit > length) ? length - offset : limit;
-        FailedMessage[] memory failedMessages = new FailedMessage[](
-            returnLength
-        );
+        FailedMessage[] memory failedMessages = new FailedMessage[](returnLength);
 
         // Adjust loop to respect pagination (start at offset, end at offset + limit or total length)
         for (uint256 i = 0; i < returnLength; i++) {

diff --git a/src/test/ccip/ProgrammableTokenTransfers.sol b/src/test/ccip/ProgrammableTokenTransfers.sol
@@ -5,7 +5,7 @@ import {IRouterClient} from "@chainlink/contracts-ccip/src/v0.8/ccip/interfaces/
 import {OwnerIsCreator} from "@chainlink/contracts-ccip/src/v0.8/shared/access/OwnerIsCreator.sol";
 import {Client} from "@chainlink/contracts-ccip/src/v0.8/ccip/libraries/Client.sol";
 import {CCIPReceiver} from "@chainlink/contracts-ccip/src/v0.8/ccip/applications/CCIPReceiver.sol";
-import {IERC20} from "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.0/contracts/token/ERC20/IERC20.sol";
+import {IERC20} from "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.3/contracts/token/ERC20/IERC20.sol";
 
 /**
  * THIS IS AN EXAMPLE CONTRACT THAT USES HARDCODED VALUES FOR CLARITY.

diff --git a/src/test/ccip/TokenTransferor.sol b/src/test/ccip/TokenTransferor.sol
@@ -4,7 +4,7 @@ pragma solidity 0.8.19;
 import {IRouterClient} from "@chainlink/contracts-ccip/src/v0.8/ccip/interfaces/IRouterClient.sol";
 import {OwnerIsCreator} from "@chainlink/contracts-ccip/src/v0.8/shared/access/OwnerIsCreator.sol";
 import {Client} from "@chainlink/contracts-ccip/src/v0.8/ccip/libraries/Client.sol";
-import {IERC20} from "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.0/contracts/token/ERC20/IERC20.sol";
+import {IERC20} from "@chainlink/contracts-ccip/src/v0.8/vendor/openzeppelin-solidity/v4.8.3/contracts/token/ERC20/IERC20.sol";
 
 /**
  * THIS IS AN EXAMPLE CONTRACT THAT USES HARDCODED VALUES FOR CLARITY.

diff --git a/test/smoke/ccip/PayWithNative.t.sol b/test/smoke/ccip/PayWithNative.t.sol
@@ -3,7 +3,8 @@ pragma solidity ^0.8.19;
 
 import {Test, console2} from "forge-std/Test.sol";
 import {BasicTokenSender} from "../../../src/test/ccip/BasicTokenSender.sol";
-import {CCIPLocalSimulator, Router, BurnMintERC677Helper, Client} from "@chainlink/local/src/ccip/CCIPLocalSimulator.sol";
+import {CCIPLocalSimulator, Router, BurnMintERC677Helper} from "@chainlink/local/src/ccip/CCIPLocalSimulator.sol";
+import {Client} from "@chainlink/contracts-ccip/src/v0.8/ccip/libraries/Client.sol";
 
 contract PayWithNativeTest is Test {
     CCIPLocalSimulator public ccipLocalSimulator;

diff --git a/test/smoke/ccip/ProgrammableTokenTransfers.t.sol b/test/smoke/ccip/ProgrammableTokenTransfers.t.sol
@@ -39,7 +39,7 @@ contract ProgrammableTokenTransfersTest is Test {
         ccipBnM = ccipBnM_;
     }
 
-    function testSmoke() public {
+    function testProgrammableTokenTransfer() public {
         uint256 amountToSend = 0.001 ether;
         uint256 amountForFees = 1 ether;
         string memory textToSend = "Hello World";

diff --git a/test/smoke/ccip/TokenTransferor.t.sol b/test/smoke/ccip/TokenTransferor.t.sol
@@ -33,7 +33,7 @@ contract TokenTransferorTest is Test {
         ccipBnM = ccipBnM_;
     }
 
-    function testSmoke() public {
+    function testTokenTransfer() public {
         uint256 amountToSend = 0.001 ether;
         uint256 amountForFees = 1 ether;
         address receiver = msg.sender;