Merge pull request #31 from catalystdao/polymer-ibc

Deliver messages directly to Polymer Dispatcher

script/Deploy.sol

@@ -9,7 +9,7 @@ import { BaseMultiChainDeployer} from "./BaseMultiChainDeployer.s.sol";
 // Import all the Apps for deployment here.
 import { IncentivizedMockEscrow } from "../src/apps/mock/IncentivizedMockEscrow.sol";
 import { IncentivizedWormholeEscrow } from "../src/apps/wormhole/IncentivizedWormholeEscrow.sol";
-import { IncentivizedPolymerEscrow } from "../src/apps/polymer/IncentivizedPolymerEscrow.sol";
+import { UniversalPolymerEscrow } from "../src/apps/polymer/UniversalPolymerEscrow.sol";
 
 contract DeployGeneralisedIncentives is BaseMultiChainDeployer {
     using stdJson for string;
@@ -81,7 +81,7 @@ contract DeployGeneralisedIncentives is BaseMultiChainDeployer {
 
             address expectedAddress = _getAddress(
                 abi.encodePacked(
-                    type(IncentivizedPolymerEscrow).creationCode,
+                    type(UniversalPolymerEscrow).creationCode,
                     abi.encode(vm.envAddress("SEND_LOST_GAS_TO"), polymerBridgeContract)
                 ),
                 salt
@@ -90,7 +90,7 @@ contract DeployGeneralisedIncentives is BaseMultiChainDeployer {
             // Check if it is already deployed. If it is, we skip.
             if (expectedAddress.codehash != bytes32(0)) return expectedAddress;
 
-            IncentivizedPolymerEscrow polymerEscrow = new IncentivizedPolymerEscrow{salt: salt}(vm.envAddress("SEND_LOST_GAS_TO"), polymerBridgeContract);
+            UniversalPolymerEscrow polymerEscrow = new UniversalPolymerEscrow{salt: salt}(vm.envAddress("SEND_LOST_GAS_TO"), polymerBridgeContract);
 
             incentive = address(polymerEscrow);
         } else {

script/bridge_contracts.json

@@ -23,12 +23,12 @@
   },
   "Polymer": {
     "basesepolia": {
-      "bridge": "0x50E32e236bfE4d514f786C9bC80061637dd5AF98",
-      "escrow": "0x147d414F1964c94c4Ac7422aC148aBddb4BEdC82"
+      "bridge": "0x9fcd52449261F732d017F8BD1CaCDc3dFbcD0361",
+      "escrow": "0x0000000000000000000010000000000000000000"
     },
     "optimismsepolia": {
-      "bridge": "0x34a0e37cCCEdaC70EC1807e5a1f6A4a91D4AE0Ce",
-      "escrow": "0x62e27C0bD89D7AC599Df8765cDEe0183A34A9929"
+      "bridge": "0xE2029629f51ab994210d671Dc08b7Ec94899b278",
+      "escrow": "0x0000000000000000000010000000000000000000"
     }
   }
 }

src/apps/polymer/APolymerEscrow.sol

@@ -0,0 +1,79 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.13;
+
+import {IncentivizedMessageEscrow} from "../../IncentivizedMessageEscrow.sol";
+import "../../MessagePayload.sol";
+
+/// @notice Scaffolding for Polymer Escrows
+abstract contract APolymerEscrow is IncentivizedMessageEscrow {
+    error NonVerifiableMessage();
+    error NotImplemented();
+
+    struct VerifiedMessageHashContext {
+        bytes32 chainIdentifier;
+        bytes implementationIdentifier;
+    }
+
+    mapping(bytes32 => VerifiedMessageHashContext) public isVerifiedMessageHash;
+
+    constructor(address sendLostGasTo)
+        IncentivizedMessageEscrow(sendLostGasTo)
+    {}
+
+    function estimateAdditionalCost() external pure returns (address asset, uint256 amount) {
+        asset = address(0);
+        amount = 0;
+    }
+
+    function _uniqueSourceIdentifier() internal view override returns (bytes32 sourceIdentifier) {
+        return sourceIdentifier = bytes32(block.chainid);
+    }
+
+    function _proofValidPeriod(bytes32 /* destinationIdentifier */ ) internal pure override returns (uint64) {
+        return 0;
+    }
+
+    /** @dev Disable processPacket */
+    function processPacket(
+        bytes calldata, /* messagingProtocolContext */
+        bytes calldata, /* rawMessage */
+        bytes32 /* feeRecipitent */
+    ) external payable override {
+        revert NotImplemented();
+    }
+
+    /** @dev Disable reemitAckMessage. Polymer manages the entire flow, so we don't need to worry about expired proofs. */
+    function reemitAckMessage(
+        bytes32 /* sourceIdentifier */,
+        bytes calldata /* implementationIdentifier */,
+        bytes calldata /* receiveAckWithContext */
+    ) external payable override {
+        revert NotImplemented();
+    }
+
+    /** @dev Disable timeoutMessage */
+    function timeoutMessage(
+        bytes32 /* sourceIdentifier */,
+        bytes calldata /* implementationIdentifier */,
+        uint256 /* originBlockNumber */,
+        bytes calldata /* message */
+    ) external payable override {
+        revert NotImplemented();
+    }
+
+    /// @notice This function is used to allow acks to be executed twice (if the first one ran out of gas)
+    /// This is not intended to allow processPacket to work.
+    function _verifyPacket(bytes calldata, /* messagingProtocolContext */ bytes calldata _message)
+        internal
+        view
+        override
+        returns (bytes32 sourceIdentifier, bytes memory implementationIdentifier, bytes calldata message_)
+    {
+        sourceIdentifier = isVerifiedMessageHash[keccak256(_message)].chainIdentifier;
+        implementationIdentifier = isVerifiedMessageHash[keccak256(_message)].implementationIdentifier;
+
+        if (sourceIdentifier == bytes32(0)) revert NonVerifiableMessage();
+
+        message_ = _message;
+    }
+}

src/apps/polymer/IncentivizedPolymerEscrow.sol → src/apps/polymer/UniversalPolymerEscrow.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.13;
 
-import {IncentivizedMessageEscrow} from "../../IncentivizedMessageEscrow.sol";
+import {APolymerEscrow} from "./APolymerEscrow.sol";
 import "../../MessagePayload.sol";
 
 import {AckPacket} from "vibc-core-smart-contracts/libs/Ibc.sol";
@@ -13,83 +13,14 @@ import {
 } from "vibc-core-smart-contracts/interfaces/IbcMiddleware.sol";
 
 /// @notice Polymer implementation of the Generalised Incentives based on vIBC.
-contract IncentivizedPolymerEscrow is IncentivizedMessageEscrow, IbcMwUser, IbcUniversalPacketReceiver {
-    error NotEnoughGasProvidedForVerification();
-    error NonVerifiableMessage();
-    error NotImplemented();
-
-    struct VerifiedMessageHashContext {
-        bytes32 chainIdentifier;
-        bytes implementationIdentifier;
-    }
-
-    mapping(bytes32 => VerifiedMessageHashContext) public isVerifiedMessageHash;
-    // packet will timeout if it's delivered on the destination chain after (this block time + _TIMEOUT_AFTER_BLOCK).
-    uint64 constant _TIMEOUT_AFTER_BLOCK = 1 days;
+contract UniversalPolymerEscrow is APolymerEscrow, IbcMwUser, IbcUniversalPacketReceiver {
 
     constructor(address sendLostGasTo, address messagingProtocol)
-        IncentivizedMessageEscrow(sendLostGasTo)
+        APolymerEscrow(sendLostGasTo)
         IbcMwUser(messagingProtocol)
     {}
 
-    function estimateAdditionalCost() external pure returns (address asset, uint256 amount) {
-        asset = address(0);
-        amount = 0;
-    }
-
-    function _uniqueSourceIdentifier() internal view override returns (bytes32 sourceIdentifier) {
-        return sourceIdentifier = bytes32(block.chainid);
-    }
-
-    function _proofValidPeriod(bytes32 /* destinationIdentifier */ ) internal pure override returns (uint64) {
-        return 0;
-    }
-
-    /** @dev Disable processPacket */
-    function processPacket(
-        bytes calldata, /* messagingProtocolContext */
-        bytes calldata, /* rawMessage */
-        bytes32 /* feeRecipitent */
-    ) external payable override {
-        revert NotImplemented();
-    }
-
-    /** @dev Disable reemitAckMessage. Polymer manages the entire flow, so we don't need to worry about expired proofs. */
-    function reemitAckMessage(
-        bytes32 /* sourceIdentifier */,
-        bytes calldata /* implementationIdentifier */,
-        bytes calldata /* receiveAckWithContext */
-    ) external payable override {
-        revert NotImplemented();
-    }
-
-    /** @dev Disable timeoutMessage */
-    function timeoutMessage(
-        bytes32 /* sourceIdentifier */,
-        bytes calldata /* implementationIdentifier */,
-        uint256 /* originBlockNumber */,
-        bytes calldata /* message */
-    ) external payable override {
-        revert NotImplemented();
-    }
-
-    /// @notice This function is used to allow acks to be executed twice (if the first one ran out of gas)
-    /// This is not intended to allow processPacket to work.
-    function _verifyPacket(bytes calldata, /* messagingProtocolContext */ bytes calldata _message)
-        internal
-        view
-        override
-        returns (bytes32 sourceIdentifier, bytes memory implementationIdentifier, bytes calldata message_)
-    {
-        sourceIdentifier = isVerifiedMessageHash[keccak256(_message)].chainIdentifier;
-        implementationIdentifier = isVerifiedMessageHash[keccak256(_message)].implementationIdentifier;
-
-        if (sourceIdentifier == bytes32(0)) revert NonVerifiableMessage();
-
-        message_ = _message;
-    }
-
-    // packet.srcPortAddr is the IncentivizedPolymerEscrow address on the source chain.
+    // packet.srcPortAddr is the UniversalPolymerEscrow address on the source chain.
     // packet.destPortAddr is the address of this contract.
     // channelId: the universal channel id from the running chain's perspective, which can be used to identify the counterparty chain.
     function onRecvUniversalPacket(bytes32 channelId, UniversalPacket calldata packet)
@@ -145,7 +76,7 @@ contract IncentivizedPolymerEscrow is IncentivizedMessageEscrow, IbcMwUser, IbcU
      * Each universal channel/channelId represents a directional path from the running chain to a destination chain.
      * Universal ChannelIds should _destChainIdToChannelIdd from the Polymer registry.
      * Although everyone is free to establish their own channels, they're not "officially" vetted until they're in the Polymer registry.
-     * @param destinationImplementation IncentivizedPolymerEscrow address on the counterparty chain.
+     * @param destinationImplementation UniversalPolymerEscrow address on the counterparty chain.
      * @param message packet payload
      * @param deadline Packet will timeout after the dest chain's block time in nanoseconds since the epoch passes timeoutTimestamp.
      */