@wormhole-foundation/wormhole-solidity-sdk 1.0.1 → 1.1.0

package/contracts/Executor/Integration.sol

@@ -1,18 +1,32 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {ICoreBridge}               from "../interfaces/ICoreBridge.sol";
-import {IExecutor, IVaaV1Receiver} from "../interfaces/IExecutor.sol";
-import {CoreBridgeLib}             from "../libraries/CoreBridge.sol";
-import {RequestLib}                from "./Request.sol";
-import {RelayInstructionLib}       from "./RelayInstruction.sol";
-import {toUniversalAddress}        from "../Utils.sol";
+import {ICoreBridge}            from "../interfaces/ICoreBridge.sol";
+import {IExecutor,
+        IExecutorQuoterRouter,
+        IVaaV1Receiver}         from "../interfaces/IExecutor.sol";
+import {CoreBridgeLib}          from "../libraries/CoreBridge.sol";
+import {RequestLib}             from "./Request.sol";
+import {RelayInstructionLib}    from "./RelayInstruction.sol";
+import {toUniversalAddress}     from "../Utils.sol";
 
 //abstract base contracts for typical Executor integrations
-//integrators should inherit from exactly one of:
-// * ExecutorSend
+//
+//executor supports off-chain and on-chain quoting so there are two flavors of send contracts.
+//
+//send-only contracts should inherit from exactly one of:
+// * ExecutorSendQuoteOffChain
+// * ExecutorSendQuoteOnChain
+// * ExecutorSendQuoteBoth
+//
+//receive-only contracts should inherit from:
 // * ExecutorReceive
-// * ExecutorSendReceive
+//
+//send-and-receive contracts should inherit from exactly one of:
+// * ExecutorSendReceiveQuoteOffChain
+// * ExecutorSendReceiveQuoteOnChain
+// * ExecutorSendReceiveQuoteBoth
+//
 //note: The Impl contracts are a nuisance to deal with the diamond inheritance pattern and
 //      the "Base constructor arguments given twice" error that comes with it.
 
@@ -51,7 +65,40 @@ abstract contract ExecutorSharedBase {
   }
 }
 
-abstract contract ExecutorSendImpl is ExecutorSharedBase {
+abstract contract ExecutorSendBase is ExecutorSharedBase {
+  function _publishAndCompose(
+    bytes memory payload,
+    uint8        consistencyLevel,
+    uint256      totalCost, //must equal execution cost + Wormhole message fee for publishing!
+    uint16       peerChain,
+    uint128      gasLimit,
+    uint128      msgVal,
+    bytes memory extraRelayInstructions
+  ) internal returns (
+    uint64       sequence,
+    bytes32      peerAddress,
+    bytes memory relayInstructions,
+    bytes memory requestBytes,
+    uint256      executorFee
+  ) {
+    uint messageFee = _coreBridge.messageFee();
+    uint32 nonce = 0; //unused
+    sequence = _coreBridge.publishMessage{value: messageFee}(nonce, payload, consistencyLevel);
+
+    relayInstructions = RelayInstructionLib.encodeGas(gasLimit, msgVal);
+    if (extraRelayInstructions.length > 0)
+      relayInstructions = abi.encodePacked(relayInstructions, extraRelayInstructions);
+
+    peerAddress = _getExistingPeer(peerChain);
+    requestBytes =
+      RequestLib.encodeVaaMultiSigRequest(_chainId, toUniversalAddress(address(this)), sequence);
+
+    //value calculation is unchecked because executor call will fail on underflow anyway
+    unchecked { executorFee = totalCost - messageFee; }
+  }
+}
+
+abstract contract ExecutorSendQuoteOffChainImpl is ExecutorSendBase {
   IExecutor internal immutable _executor;
 
   constructor(address executor) {
@@ -69,31 +116,81 @@ abstract contract ExecutorSendImpl is ExecutorSharedBase {
     uint128        msgVal,
     bytes memory   extraRelayInstructions
   ) internal returns (uint64 sequence) { unchecked {
-    uint messageFee = _coreBridge.messageFee();
-    uint32 nonce = 0; //unused
-    sequence = _coreBridge.publishMessage{value: messageFee}(nonce, payload, consistencyLevel);
+    ( uint64 sequence_,
+      bytes32 peerAddress,
+      bytes memory relayInstructions,
+      bytes memory requestBytes,
+      uint256 executorFee
+    ) = _publishAndCompose(
+      payload,
+      consistencyLevel,
+      totalCost,
+      peerChain,
+      gasLimit,
+      msgVal,
+      extraRelayInstructions
+    );
 
-    bytes memory relayInstructions = RelayInstructionLib.encodeGas(gasLimit, msgVal);
-    if (extraRelayInstructions.length > 0)
-      relayInstructions = abi.encodePacked(relayInstructions, extraRelayInstructions);
+    _executor.requestExecution{value: executorFee}(
+      peerChain,
+      peerAddress,
+      refundAddress,
+      signedQuote,
+      requestBytes,
+      relayInstructions
+    );
 
-    bytes32 peerAddress = _getExistingPeer(peerChain);
+    sequence = sequence_;
+  }}
+}
+
+abstract contract ExecutorSendQuoteOnChainImpl is ExecutorSendBase {
+  IExecutorQuoterRouter internal immutable _executorQuoterRouter;
+
+  constructor(address executorQuoterRouter) {
+    _executorQuoterRouter = IExecutorQuoterRouter(executorQuoterRouter);
+  }
 
-    //value calculation is unchecked because call will fail on underflow anyway
-    _executor.requestExecution{value: totalCost - messageFee}(
+  function _publishAndRelay(
+    bytes memory payload,
+    uint8        consistencyLevel,
+    uint256      totalCost, //must equal execution cost + Wormhole message fee for publishing!
+    uint16       peerChain,
+    address      refundAddress,
+    address      quoterAddress,
+    uint128      gasLimit,
+    uint128      msgVal,
+    bytes memory extraRelayInstructions
+  ) internal returns (uint64 sequence) { unchecked {
+    ( uint64 sequence_,
+      bytes32 peerAddress,
+      bytes memory relayInstructions,
+      bytes memory requestBytes,
+      uint256 executorFee
+    ) = _publishAndCompose(
+      payload,
+      consistencyLevel,
+      totalCost,
+      peerChain,
+      gasLimit,
+      msgVal,
+      extraRelayInstructions
+    );
+
+    _executorQuoterRouter.requestExecution{value: executorFee}(
       peerChain,
       peerAddress,
       refundAddress,
-      signedQuote,
-      RequestLib.encodeVaaMultiSigRequest(_chainId, toUniversalAddress(address(this)), sequence),
+      quoterAddress,
+      requestBytes,
       relayInstructions
     );
+
+    sequence = sequence_;
   }}
 }
 
 abstract contract ExecutorReceiveImpl is ExecutorSharedBase, IVaaV1Receiver {
-  constructor(address coreBridge) {}
-
   //default impl as safeguard - integrators should override this with an empty impl and perform
   //  appropriate check in their impl of _executeVaa instead, if they allow for non-zero msg.value
   function _executeVaaDefaultMsgValueCheck() internal virtual {
@@ -158,23 +255,46 @@ abstract contract ExecutorReceiveImpl is ExecutorSharedBase, IVaaV1Receiver {
   }
 }
 
-abstract contract ExecutorSend is ExecutorSharedBase, ExecutorSendImpl {
+abstract contract ExecutorSendQuoteOffChain is ExecutorSharedBase, ExecutorSendQuoteOffChainImpl {
   constructor(address coreBridge, address executor)
     ExecutorSharedBase(coreBridge)
-    ExecutorSendImpl(executor)
-  {}
+    ExecutorSendQuoteOffChainImpl(executor) {}
+}
+
+abstract contract ExecutorSendQuoteOnChain is ExecutorSharedBase, ExecutorSendQuoteOnChainImpl {
+  constructor(address coreBridge, address executorQuoterRouter)
+    ExecutorSharedBase(coreBridge)
+    ExecutorSendQuoteOnChainImpl(executorQuoterRouter) {}
+}
+
+abstract contract ExecutorSendQuoteBoth is
+  ExecutorSharedBase, ExecutorSendQuoteOffChainImpl, ExecutorSendQuoteOnChainImpl {
+  constructor(address coreBridge, address executor, address executorQuoterRouter)
+    ExecutorSharedBase(coreBridge)
+    ExecutorSendQuoteOffChainImpl(executor)
+    ExecutorSendQuoteOnChainImpl(executorQuoterRouter) {}
 }
 
 abstract contract ExecutorReceive is ExecutorSharedBase, ExecutorReceiveImpl {
   constructor(address coreBridge)
-    ExecutorSharedBase(coreBridge)
-    ExecutorReceiveImpl(coreBridge)
-  {}
+    ExecutorSharedBase(coreBridge) {}
 }
 
-abstract contract ExecutorSendReceive is ExecutorSharedBase, ExecutorSendImpl, ExecutorReceiveImpl {
+abstract contract ExecutorSendReceiveQuoteOffChain is
+    ExecutorSharedBase, ExecutorSendQuoteOffChainImpl, ExecutorReceiveImpl {
   constructor(address coreBridge, address executor)
-    ExecutorSendImpl(executor)
-    ExecutorReceiveImpl(coreBridge)
-    ExecutorSharedBase(coreBridge) {}
+    ExecutorSharedBase(coreBridge)
+    ExecutorSendQuoteOffChainImpl(executor) {}
+}
+
+abstract contract ExecutorSendReceiveQuoteOnChain is
+    ExecutorSharedBase, ExecutorSendQuoteOnChainImpl, ExecutorReceiveImpl {
+  constructor(address coreBridge, address executorQuoterRouter)
+    ExecutorSharedBase(coreBridge)
+    ExecutorSendQuoteOnChainImpl(executorQuoterRouter) {}
+}
+
+abstract contract ExecutorSendReceiveQuoteBoth is ExecutorReceiveImpl, ExecutorSendQuoteBoth {
+  constructor(address coreBridge, address executor, address executorQuoterRouter)
+    ExecutorSendQuoteBoth(coreBridge, executor, executorQuoterRouter) {}
 }

package/contracts/Executor/RelayInstruction.sol

@@ -49,7 +49,7 @@ library RelayInstructionLib {
            gasDropOffInstructionCount * GAS_DROP_OFF_INSTRUCTION_SIZE;
   }}
 
-  function encodeGasDropOffInstructionUnchecked(
+  function encodeGasInstructionUnchecked(
     uint128 gasLimit,
     uint128 msgVal,
     bytes memory buffer,

package/contracts/constants/Chains.sol

@@ -46,6 +46,8 @@ uint16 constant CHAIN_ID_XRPLEVM = 57;
 uint16 constant CHAIN_ID_PLASMA = 58;
 uint16 constant CHAIN_ID_CREDIT_COIN = 59;
 uint16 constant CHAIN_ID_STACKS = 60;
+uint16 constant CHAIN_ID_MOCA = 63;
+uint16 constant CHAIN_ID_MEGA_ETH = 64;
 uint16 constant CHAIN_ID_WORMCHAIN = 3104;
 uint16 constant CHAIN_ID_COSMOSHUB = 4000;
 uint16 constant CHAIN_ID_EVMOS = 4001;
@@ -63,4 +65,5 @@ uint16 constant CHAIN_ID_BASE_SEPOLIA = 10004;
 uint16 constant CHAIN_ID_OPTIMISM_SEPOLIA = 10005;
 uint16 constant CHAIN_ID_HOLESKY = 10006;
 uint16 constant CHAIN_ID_POLYGON_SEPOLIA = 10007;
+uint16 constant CHAIN_ID_MONAD_TESTNET = 10009;
 uint16 constant CHAIN_ID_HYPER_CORE = 65000;

package/contracts/interfaces/IExecutor.sol

@@ -27,6 +27,59 @@ interface IExecutor {
 
 //from https://github.com/wormholelabs-xyz/example-messaging-executor/blob/ec5daea3c03f8860a62c23e28db5c6dc8771a9ce/evm/src/interfaces/IVaaV1Receiver.sol
 //required interface for receiving MultiSig (=V1) VAAs from the executor
+
 interface IVaaV1Receiver {
   function executeVAAv1(bytes memory multiSigVaa) external payable;
 }
+
+// ---- On-chain Quoting ----
+
+//see https://github.com/wormholelabs-xyz/example-messaging-executor/blob/main/design/02_On_Chain_Quotes.md
+
+//from https://github.com/wormholelabs-xyz/example-messaging-executor/blob/main/evm/src/interfaces/IExecutorQuoter.sol
+
+interface IExecutorQuoter {
+  function requestQuote(
+    uint16 dstChain,
+    bytes32 dstAddr,
+    address refundAddr,
+    bytes calldata requestBytes,
+    bytes calldata relayInstructions
+  ) external view returns (uint256 requiredMsgValue);
+
+  function requestExecutionQuote(
+    uint16 dstChain,
+    bytes32 dstAddr,
+    address refundAddr,
+    bytes calldata requestBytes,
+    bytes calldata relayInstructions
+  ) external returns (
+    uint256 requiredMsgValue,
+    bytes32 payee,
+    bytes32 quoteBody //= packed(baseFee, dstGasPrice, srcPrice, dstPrice)
+  );
+}
+
+//from https://github.com/wormholelabs-xyz/example-messaging-executor/blob/main/evm/src/interfaces/IExecutorQuoterRouter.sol
+
+event OnChainQuote(address quoterContract); //emitted by IExecutorQuoterRouter.requestExecution()
+
+interface IExecutorQuoterRouter {
+  function quoteExecution(
+    uint16 dstChain,
+    bytes32 dstAddr,
+    address refundAddr,
+    address quoterAddr,
+    bytes calldata requestBytes,
+    bytes calldata relayInstructions
+  ) external view returns (uint256);
+
+  function requestExecution(
+    uint16 dstChain,
+    bytes32 dstAddr,
+    address refundAddr,
+    address quoterAddr,
+    bytes calldata requestBytes,
+    bytes calldata relayInstructions
+  ) external payable;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wormhole-foundation/wormhole-solidity-sdk",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Wormhole Solidity SDK",
   "license": "Apache-2.0",
   "repository": {