Merge branch 'main' into solana/governance-generate

Author: nik-suri

.github/workflows/evm.yml

@@ -41,3 +41,32 @@ jobs:
         run: |
           make check-format
         id: check
+    
+  echidna:
+    name: echidna
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Run Forge build
+        run: |
+          make test-push0
+        id: build
+
+      - name: Install Echidna
+        run: |
+          curl -LO https://github.com/crytic/echidna/releases/download/v2.2.3/echidna-2.2.3-x86_64-linux.tar.gz
+          tar -xzf echidna-2.2.3-x86_64-linux.tar.gz
+          pip install crytic-compile
+      
+      - name: Run Echidna
+        run: |
+          cd evm
+          ../echidna ./echidna --config echidna.yaml

.gitmodules

@@ -7,3 +7,6 @@
 [submodule "lib/wormhole-solidity-sdk"]
 	path = evm/lib/wormhole-solidity-sdk
 	url = https://github.com/wormhole-foundation/wormhole-solidity-sdk
+[submodule "evm/lib/solidity-bytes-utils"]
+	path = evm/lib/solidity-bytes-utils
+	url = https://github.com/GNSPS/solidity-bytes-utils

Makefile

@@ -36,5 +36,5 @@ test-evm:
 
 # Verify that the contracts do not include PUSH0 opcodes
 test-push0:
-	forge build --extra-output evm.bytecode.opcodes
-	@if grep -qr --include \*.json PUSH0 ./out; then echo "Contract uses PUSH0 instruction" 1>&2; exit 1; else echo "PUSH0 Verification Succeeded"; fi
+	cd evm && forge build --extra-output evm.bytecode.opcodes
+	@if grep -qr --include \*.json PUSH0 ./evm/out; then echo "Contract uses PUSH0 instruction" 1>&2; exit 1; else echo "PUSH0 Verification Succeeded"; fi

evm/README.md

@@ -30,6 +30,9 @@ Similarly, transfers that are rate-limited on the destination chain are added to
 
 If the client attempts to release the transfer from the queue before the expiry of the `rateLimitDuration`, the contract reverts with a `InboundQueuedTransferStillQueued` error.
 
+To disable the rate-limiter, set `_rateLimitDuration` to 0 and enable the `_skipRateLimiting` field in the `NttManager` constructor. Configuring this incorrectly will throw an error.
+If the rate-limiter is disabled, the inbound and outbound rate-limits can be set to 0.
+
 _Events_
 
 ```solidity

evm/echidna.yaml

@@ -0,0 +1,14 @@
+testMode: "assertion"
+
+deployContracts: [
+  ["0x1f1", "TransceiverStructs"],
+]
+
+cryticArgs: ["--compile-libraries=(TransceiverStructs,0x1f1)"]
+
+# Default is 0x6000, but we need to increase this as not compiled via ir
+codeSize: 0x8000
+
+stopOnFail: false
+
+testLimit: 100000

evm/echidna/FuzzNttManager.sol

@@ -0,0 +1,70 @@
+pragma solidity >=0.8.8 <0.9.0;
+
+import "./IHevm.sol";
+
+abstract contract FuzzingHelpers {
+    address constant HEVM_ADDRESS = 0x7109709ECfa91a80626fF3989D68f67F5b1DD12D;
+    IHevm hevm = IHevm(HEVM_ADDRESS);
+    
+    
+    event LogAddress(address);
+    event LogUint256(uint256);
+    event LogString(string);
+    event AssertFail(string);
+
+    // We need this to receive refunds for quotes
+    receive() external payable {}
+
+    function clampBetween(uint256 value, uint256 low, uint256 high) internal returns (uint256){
+        if (value < low || value > high) {
+            uint ans = low + (value % (high - low + 1));
+            return ans;
+        }
+        return value;
+    }
+
+    function extractErrorSelector(
+        bytes memory revertData
+    ) internal returns (uint256) {
+        if (revertData.length < 4) {
+            emit LogString("Return data too short.");
+            return 0;
+        }
+
+        uint256 errorSelector = uint256(
+            (uint256(uint8(revertData[0])) << 24) |
+                (uint256(uint8(revertData[1])) << 16) |
+                (uint256(uint8(revertData[2])) << 8) |
+                uint256(uint8(revertData[3]))
+        );
+
+        return errorSelector;
+    }
+
+    function extractErrorString(bytes memory revertData) internal returns (bytes32) {
+        if (revertData.length < 68) revert();
+        assembly {
+            revertData := add(revertData, 0x04)
+        }
+        return keccak256(abi.encodePacked(abi.decode(revertData, (string))));
+    }
+
+    function selectorToUint(bytes4 selector) internal returns (uint256) {
+        return uint256(uint32(selector));
+    }
+
+    function assertWithMsg(bool b, string memory reason) internal {
+        if (!b) {
+            emit AssertFail(reason);
+            assert(false);
+        }
+    }
+
+    function minUint8(uint8 a, uint8 b) internal returns (uint8) {
+        return a < b ? a : b;
+    }
+
+    function minUint256(uint256 a, uint256 b) internal returns (uint256) {
+        return a < b ? a : b;
+    }
+}

evm/echidna/helpers/FuzzingHelpers.sol

@@ -0,0 +1,7 @@
+pragma solidity >=0.8.8 <0.9.0;
+
+interface IHevm {
+    function prank(address) external;
+
+    function warp(uint256 newTimestamp) external;
+}

evm/echidna/helpers/IHevm.sol

@@ -312,7 +312,7 @@ abstract contract ManagerBase is
         _pause();
     }
 
-    function unpause() public onlyOwnerOrPauser {
+    function unpause() public onlyOwner {
         _unpause();
     }
 

evm/lib/solidity-bytes-utils

@@ -26,7 +26,11 @@ abstract contract WormholeTransceiverState is IWormholeTransceiverState, Transce
     IWormhole public immutable wormhole;
     IWormholeRelayer public immutable wormholeRelayer;
     ISpecialRelayer public immutable specialRelayer;
+    /// @dev We don't check this in `_checkImmutables` since it's set at construction
+    ///      through `block.chainid`.
     uint256 immutable wormholeTransceiver_evmChainId;
+    /// @dev We purposely avoid checking this in `_checkImmutables` to allow tweaking it
+    ///      without needing to allow modification of security critical immutables.
     uint256 public immutable gasLimit;
 
     // ==================== Constants ================================================

evm/src/NttManager/ManagerBase.sol

@@ -106,6 +106,14 @@ library TrimmedAmountLib {
         return uint8(TrimmedAmount.unwrap(a) & 0xFF);
     }
 
+    /// @dev Set the decimals of the TrimmedAmount.
+    ///      This function should only be used for testing purposes, as it
+    ///      should not be necessary to change the decimals of a TrimmedAmount
+    ///      under normal circumstances.
+    function setDecimals(TrimmedAmount a, uint8 decimals) internal pure returns (TrimmedAmount) {
+        return TrimmedAmount.wrap((TrimmedAmount.unwrap(a) & ~uint72(0xFF)) | decimals);
+    }
+
     function isNull(TrimmedAmount a) internal pure returns (bool) {
         return (getAmount(a) == 0 && getDecimals(a) == 0);
     }

evm/src/Transceiver/WormholeTransceiver/WormholeTransceiverState.sol

@@ -231,6 +231,29 @@ contract TestNttManager is Test, IRateLimiterEvents {
         assertEq(nttManager.isPaused(), false);
     }
 
+    function test_pausePauserUnpauseOnlyOwner() public {
+        // transfer pauser to another address
+        address pauser = address(0x123);
+        nttManager.transferPauserCapability(pauser);
+
+        // execute from pauser context
+        vm.startPrank(pauser);
+        assertEq(nttManager.isPaused(), false);
+        nttManager.pause();
+        assertEq(nttManager.isPaused(), true);
+
+        vm.expectRevert(
+            abi.encodeWithSelector(OwnableUpgradeable.OwnableUnauthorizedAccount.selector, pauser)
+        );
+        nttManager.unpause();
+
+        // execute from owner context
+        // ensures that owner can still unpause
+        vm.startPrank(address(this));
+        nttManager.unpause();
+        assertEq(nttManager.isPaused(), false);
+    }
+
     // === deployment with invalid token
     function test_brokenToken() public {
         DummyToken t = new DummyTokenBroken();

evm/src/libraries/TrimmedAmount.sol

@@ -165,14 +165,19 @@ contract TrimmingTest is Test {
 
     // =============   FUZZ TESTS ================== //
 
+    function testFuzz_setDecimals(TrimmedAmount a, uint8 decimals) public {
+        TrimmedAmount b = a.setDecimals(decimals);
+        assertEq(b.getDecimals(), decimals);
+    }
+
     function test_packUnpack(uint64 amount, uint8 decimals) public {
         TrimmedAmount trimmed = packTrimmedAmount(amount, decimals);
         assertEq(trimmed.getAmount(), amount);
         assertEq(trimmed.getDecimals(), decimals);
     }
 
     function testFuzz_AddOperatorOverload(TrimmedAmount a, TrimmedAmount b) public {
-        vm.assume(a.getDecimals() == b.getDecimals());
+        a = a.setDecimals(b.getDecimals());
 
         // check if the add operation reverts on an overflow.
         // if it overflows, discard the input
@@ -188,7 +193,7 @@ contract TrimmingTest is Test {
     }
 
     function testFuzz_SubOperatorOverload(TrimmedAmount a, TrimmedAmount b) public {
-        vm.assume(a.getDecimals() == b.getDecimals());
+        a = a.setDecimals(b.getDecimals());
         vm.assume(a.getAmount() >= b.getAmount());
 
         TrimmedAmount subAmt = a - b;
@@ -206,15 +211,15 @@ contract TrimmingTest is Test {
     }
 
     function testFuzz_GtOperatorOverload(TrimmedAmount a, TrimmedAmount b) public {
-        vm.assume(a.getDecimals() == b.getDecimals());
+        a = a.setDecimals(b.getDecimals());
         bool isGt = a > b;
         bool expectedIsGt = gt(a, b);
 
         assertEq(expectedIsGt, isGt);
     }
 
     function testFuzz_LtOperatorOverload(TrimmedAmount a, TrimmedAmount b) public {
-        vm.assume(a.getDecimals() == b.getDecimals());
+        a = a.setDecimals(b.getDecimals());
         bool isLt = a > b;
         bool expectedIsLt = gt(a, b);
 
@@ -224,7 +229,7 @@ contract TrimmingTest is Test {
     // invariant: forall (TrimmedAmount a, TrimmedAmount b)
     //            a.saturatingAdd(b).amount <= type(uint64).max
     function testFuzz_saturatingAddDoesNotOverflow(TrimmedAmount a, TrimmedAmount b) public {
-        vm.assume(a.getDecimals() == b.getDecimals());
+        a = a.setDecimals(b.getDecimals());
 
         TrimmedAmount c = a.saturatingAdd(b);
 

evm/test/NttManager.t.sol

@@ -15,7 +15,7 @@ async function registerRelayers() {
   try {
     await submitAccountantVAA(
       Buffer.from(
-        "010000000001006c9967aee739944b30ffcc01653f2030ea02c038adda26a8f5a790f191134dff1e1e48368af121a34806806140d4f56ec09e25067006e69c95b0c4c08b8897990000000000000000000001000000000000000000000000000000000000000000000000000000000000000400000000001ce9cf010000000000000000000000000000000000576f726d686f6c6552656c61796572010000000200000000000000000000000053855d4b64e9a3cf59a84bc768ada716b5536bc5",
+        "01000000000100a4f34c530ff196c060ff349f2bf7bcb16865771a7165ca84fb5e263f148a01b03592b9af46a410a3760f39097d7380e4e72b6e1da4fa25c2d7b2d00f102d0cae0100000000000000000001000000000000000000000000000000000000000000000000000000000000000400000000001ce9cf010000000000000000000000000000000000576f726d686f6c6552656c617965720100000002000000000000000000000000cc680d088586c09c3e0e099a676fa4b6e42467b4",
         "hex"
       )
     );
@@ -26,7 +26,7 @@ async function registerRelayers() {
   try {
     await submitAccountantVAA(
       Buffer.from(
-        "01000000000100894be2c33626547e665cee73684854fbd8fc2eb79ec9ad724b1fb10d6cd24aaa590393870e6655697cd69d5553881ac8519e1282e7d3ae5fc26d7452d097651c00000000000000000000010000000000000000000000000000000000000000000000000000000000000004000000000445fb0b010000000000000000000000000000000000576f726d686f6c6552656c61796572010000000400000000000000000000000053855d4b64e9a3cf59a84bc768ada716b5536bc5",
+        "010000000001000fd839cfdbea0f43a35dbb8cc0219b55cd5ec9f59b7e4a7183dbeebd522f7c673c866a218bfa108d8c7606acb5fc6b94a7a4c3be06f10836c242afecdb80da6e00000000000000000000010000000000000000000000000000000000000000000000000000000000000004000000000445fb0b010000000000000000000000000000000000576f726d686f6c6552656c617965720100000004000000000000000000000000cc680d088586c09c3e0e099a676fa4b6e42467b4",
         "hex"
       )
     );

evm/test/TrimmedAmount.t.sol

@@ -76,7 +76,20 @@ export interface Ctx extends StartingCtx {
 
 export const wh = new Wormhole(NETWORK, [evm.Platform, solana.Platform], {
   ...(process.env["CI"]
-    ? {}
+    ? {
+        chains: {
+          Ethereum: {
+            contracts: {
+              relayer: "0xcC680D088586c09c3E0E099a676FA4b6e42467b4",
+            },
+          },
+          Bsc: {
+            contracts: {
+              relayer: "0xcC680D088586c09c3E0E099a676FA4b6e42467b4",
+            },
+          },
+        },
+      }
     : {
         api: "http://localhost:7071",
         chains: {