feat: 4538 wormhole connector

packages/agents/lighthouse/src/tasks/propagate/helpers/bnb.ts

@@ -1,4 +1,4 @@
-import { ContractInterface } from "ethers";
+import { ContractInterface, utils } from "ethers";
 import { createLoggingContext, RequestContext } from "@connext/nxtp-utils";
 
 import { NoHubConnector, NoProviderForDomain, NoSpokeConnector } from "../errors";
@@ -15,7 +15,7 @@ export const getPropagateParams = async (
   const {
     config,
     logger,
-    adapters: { deployments, ambs },
+    adapters: { deployments },
   } = getContext();
   const { methodContext, requestContext } = createLoggingContext(getPropagateParams.name, _requestContext);
   logger.info("Getting propagate params for BNB", requestContext, methodContext, { l2domain });
@@ -51,8 +51,12 @@ export const getPropagateParams = async (
   );
   const ambAddress = await l1HubConnectorContract.AMB();
 
-  const ambContract = getContract(ambAddress as string, ambs.bnb as ContractInterface, l1Provider);
-  const fee = await ambContract.calcSrcFees("", l2ChainId, 32);
+  // gasLimit on spoke side = 200_000
+  // actually it required about 60_000 gas on bnb chain to call `receiveWormholeMessages`
+  // remain gas will be refunded on bnb chain to refund address (default: deployer address)
+  const gasLimit = "200000";
+  const fee = await l1HubConnectorContract.quoteEVMDeliveryPrice(gasLimit, ambAddress);
+  const encodedData = utils.defaultAbiCoder.encode(["uint256"], [gasLimit]);
 
-  return { _connector: "", _fee: fee, _encodedData: "0x" };
+  return { _connector: "", _fee: fee, _encodedData: encodedData };
 };

packages/agents/lighthouse/src/tasks/sendOutboundRoot/helpers/bnb.ts

@@ -1,14 +1,15 @@
 import { createLoggingContext, domainToChainId } from "@connext/nxtp-utils";
+import { ContractInterface, utils } from "ethers";
 
 import { getContext } from "../sendOutboundRoot";
 import { ExtraSendOutboundRootParam } from "../operations/sendOutboundRoot";
 import { NoProviderForDomain, NoSpokeConnector } from "../../propagate/errors";
-import { getInterface, getBestProvider } from "../../../mockable";
+import { getBestProvider, getJsonRpcProvider, getContract } from "../../../mockable";
 
 export const getSendOutboundRootParams = async (l2domain: string): Promise<ExtraSendOutboundRootParam> => {
   const {
     config,
-    adapters: { deployments, contracts, chainreader, ambs },
+    adapters: { deployments },
   } = getContext();
   const { requestContext, methodContext } = createLoggingContext(getSendOutboundRootParams.name);
   const l2RpcUrl = await getBestProvider(config.chains[l2domain]?.providers ?? []);
@@ -22,7 +23,6 @@ export const getSendOutboundRootParams = async (l2domain: string): Promise<Extra
   }
 
   const l2ChainId = domainToChainId(+l2domain);
-  const hubChainId = domainToChainId(+config.hubDomain);
 
   const l2SpokeConnector = deployments.spokeConnector(
     l2ChainId,
@@ -33,14 +33,20 @@ export const getSendOutboundRootParams = async (l2domain: string): Promise<Extra
     throw new NoSpokeConnector(l2ChainId, requestContext, methodContext);
   }
 
-  let encodedData = contracts.spokeConnector.encodeFunctionData("AMB");
-  let encoded = await chainreader.readTx({ data: encodedData, domain: Number(l2domain), to: l2SpokeConnector.address });
-  const [ambAddress] = contracts.spokeConnector.decodeFunctionResult("AMB", encoded);
+  const l2Provider = getJsonRpcProvider(l2RpcUrl);
+  const l2SpokeConnectorContract = getContract(
+    l2SpokeConnector.address,
+    l2SpokeConnector.abi as ContractInterface,
+    l2Provider,
+  );
+  const ambAddress = await l2SpokeConnectorContract.AMB();
 
-  const ambInterface = getInterface(ambs.bnb);
-  encodedData = ambInterface.encodeFunctionData("calcSrcFees", ["", hubChainId, 32]);
-  encoded = await chainreader.readTx({ data: encodedData, domain: Number(l2domain), to: ambAddress });
-  const [_fee] = ambInterface.decodeFunctionResult("calcSrcFees", encoded);
+  // gasLimit on hub side = 200_000
+  // actually it required about 100_000 gas on mainnet to call `receiveWormholeMessages`
+  // remain gas will be refunded on mainnetto refund address (default: deployer address)
+  const gasLimit = "200000";
+  const fee = await l2SpokeConnectorContract.quoteEVMDeliveryPrice(gasLimit, ambAddress);
+  const encodedData = utils.defaultAbiCoder.encode(["uint256"], [gasLimit]);
 
-  return { _fee: _fee.toString(), _encodedData: "0x" };
+  return { _fee: fee.toString(), _encodedData: encodedData };
 };

packages/agents/lighthouse/test/tasks/propagate/helpers/bnb.spec.ts

@@ -6,7 +6,7 @@ import { getPropagateParams } from "../../../../src/tasks/propagate/helpers/bnb"
 import * as Mockable from "../../../../src/mockable";
 import { getBestProviderMock, propagateCtxMock } from "../../../globalTestHook";
 import { mock } from "../../../mock";
-import { constants, Contract } from "ethers";
+import { constants, Contract, utils } from "ethers";
 
 const requestContext = createRequestContext("test");
 
@@ -15,7 +15,7 @@ describe("Helpers: Bnb", () => {
     beforeEach(() => {
       stub(Mockable, "getContract").returns({
         AMB: stub().resolves(mkAddress("0x123")),
-        calcSrcFees: stub().resolves(constants.One),
+        quoteEVMDeliveryPrice: stub().resolves(constants.One),
       } as any);
     });
 
@@ -54,7 +54,7 @@ describe("Helpers: Bnb", () => {
       expect(data).to.deep.eq({
         _connector: "",
         _fee: constants.One,
-        _encodedData: "0x",
+        _encodedData: utils.defaultAbiCoder.encode(["uint256"], [200000]),
       });
     });
   });

packages/agents/lighthouse/test/tasks/sendOutboundRoot/helpers/bnb.spec.ts

@@ -1,15 +1,24 @@
-import { expect, mock } from "@connext/nxtp-utils";
-import { BigNumber } from "ethers";
+import { SinonStub, stub, createStubInstance } from "sinon";
+import { expect, mkAddress, mock } from "@connext/nxtp-utils";
+import { BigNumber, constants, utils } from "ethers";
 
+import * as Mockable from "../../../../src/mockable";
 import { getSendOutboundRootParams } from "../../../../src/tasks/sendOutboundRoot/helpers/bnb";
 
 describe("Helpers: BNB", () => {
   describe("#getSendOutboundRootParams", () => {
+    beforeEach(() => {
+      stub(Mockable, "getContract").returns({
+        AMB: stub().resolves(mkAddress("0x123")),
+        quoteEVMDeliveryPrice: stub().resolves(constants.One),
+      } as any);
+    });
+
     it("should get params", async () => {
       const res = await getSendOutboundRootParams(mock.domain.A);
       expect(res).to.deep.eq({
-        _fee: "42",
-        _encodedData: "0x",
+        _fee: constants.One.toString(),
+        _encodedData: utils.defaultAbiCoder.encode(["uint256"], [200000]),
       });
     });
   });

packages/deployments/contracts/abi/contracts/messaging/connectors/wormhole/BaseWormhole.sol/BaseWormhole.json

@@ -0,0 +1,27 @@
+[
+  "error ProposedOwnable__onlyOwner_notOwner()",
+  "error ProposedOwnable__onlyProposed_notProposedOwner()",
+  "error ProposedOwnable__ownershipDelayElapsed_delayNotElapsed()",
+  "error ProposedOwnable__proposeNewOwner_invalidProposal()",
+  "error ProposedOwnable__proposeNewOwner_noOwnershipChange()",
+  "error ProposedOwnable__renounceOwnership_invalidProposal()",
+  "error ProposedOwnable__renounceOwnership_noProposal()",
+  "event GasCapUpdated(uint256 _previous, uint256 _updated)",
+  "event OwnershipProposed(address indexed proposedOwner)",
+  "event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)",
+  "event RefundAddressUpdated(address indexed previous, address indexed updated)",
+  "function MIRROR_WORMHOLE_ID() view returns (uint16)",
+  "function acceptProposedOwner()",
+  "function delay() view returns (uint256)",
+  "function owner() view returns (address)",
+  "function processedWhMessages(bytes32) view returns (bool)",
+  "function proposeNewOwner(address newlyProposed)",
+  "function proposed() view returns (address)",
+  "function proposedTimestamp() view returns (uint256)",
+  "function quoteEVMDeliveryPrice(uint256 _gasLimit, address _amb) view returns (uint256 _cost)",
+  "function refundAddress() view returns (address)",
+  "function renounceOwnership()",
+  "function renounced() view returns (bool)",
+  "function setGasCap(uint256 _gasCap)",
+  "function setRefundAddress(address _updated)"
+]

packages/deployments/contracts/abi/contracts/messaging/connectors/wormhole/WormholeHubConnector.sol/WormholeHubConnector.json

@@ -0,0 +1,43 @@
+[
+  "constructor(uint32 _domain, uint32 _mirrorDomain, address _amb, address _rootManager, address _mirrorConnector, uint256 _gasCap, uint16 _mirrorWormholeChainId)",
+  "error Connector__processMessage_notUsed()",
+  "error ProposedOwnable__onlyOwner_notOwner()",
+  "error ProposedOwnable__onlyProposed_notProposedOwner()",
+  "error ProposedOwnable__ownershipDelayElapsed_delayNotElapsed()",
+  "error ProposedOwnable__proposeNewOwner_invalidProposal()",
+  "error ProposedOwnable__proposeNewOwner_noOwnershipChange()",
+  "error ProposedOwnable__renounceOwnership_invalidProposal()",
+  "error ProposedOwnable__renounceOwnership_noProposal()",
+  "event GasCapUpdated(uint256 _previous, uint256 _updated)",
+  "event MessageProcessed(bytes data, address caller)",
+  "event MessageSent(bytes data, bytes encodedData, address caller)",
+  "event MirrorConnectorUpdated(address previous, address current)",
+  "event NewConnector(uint32 indexed domain, uint32 indexed mirrorDomain, address amb, address rootManager, address mirrorConnector)",
+  "event OwnershipProposed(address indexed proposedOwner)",
+  "event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)",
+  "event RefundAddressUpdated(address indexed previous, address indexed updated)",
+  "function AMB() view returns (address)",
+  "function DOMAIN() view returns (uint32)",
+  "function MIRROR_DOMAIN() view returns (uint32)",
+  "function MIRROR_WORMHOLE_ID() view returns (uint16)",
+  "function ROOT_MANAGER() view returns (address)",
+  "function acceptProposedOwner()",
+  "function delay() view returns (uint256)",
+  "function mirrorConnector() view returns (address)",
+  "function owner() view returns (address)",
+  "function processMessage(bytes _data)",
+  "function processedWhMessages(bytes32) view returns (bool)",
+  "function proposeNewOwner(address newlyProposed)",
+  "function proposed() view returns (address)",
+  "function proposedTimestamp() view returns (uint256)",
+  "function quoteEVMDeliveryPrice(uint256 _gasLimit, address _amb) view returns (uint256 _cost)",
+  "function receiveWormholeMessages(bytes _payload, bytes[], bytes32 _sourceAddress, uint16 _sourceChain, bytes32 _deliveryHash) payable",
+  "function refundAddress() view returns (address)",
+  "function renounceOwnership()",
+  "function renounced() view returns (bool)",
+  "function sendMessage(bytes _data, bytes _encodedData) payable",
+  "function setGasCap(uint256 _gasCap)",
+  "function setMirrorConnector(address _mirrorConnector)",
+  "function setRefundAddress(address _updated)",
+  "function verifySender(address _expected) returns (bool)"
+]

packages/deployments/contracts/abi/contracts/messaging/connectors/wormhole/WormholeSpokeConnector.sol/WormholeSpokeConnector.json

@@ -0,0 +1,93 @@
+[
+  "constructor(uint32 _domain, uint32 _mirrorDomain, address _amb, address _rootManager, address _mirrorConnector, uint256 _processGas, uint256 _reserveGas, uint256 _delayBlocks, address _merkle, address _watcherManager, uint256 _gasCap, uint16 _mirrorWormholeChainId)",
+  "error Connector__processMessage_notUsed()",
+  "error ProposedOwnable__onlyOwner_notOwner()",
+  "error ProposedOwnable__onlyProposed_notProposedOwner()",
+  "error ProposedOwnable__ownershipDelayElapsed_delayNotElapsed()",
+  "error ProposedOwnable__proposeNewOwner_invalidProposal()",
+  "error ProposedOwnable__proposeNewOwner_noOwnershipChange()",
+  "error ProposedOwnable__renounceOwnership_invalidProposal()",
+  "error ProposedOwnable__renounceOwnership_noProposal()",
+  "error RateLimited__rateLimited_messageSendRateExceeded()",
+  "error TypedMemView__index_indexMoreThan32Bytes()",
+  "error TypedMemView__index_overrun(uint256 loc, uint256 len, uint256 index, uint256 slice)",
+  "error TypedMemView__unsafeCopyTo_identityOOG()",
+  "error TypedMemView__unsafeCopyTo_invalidPointer()",
+  "error TypedMemView__unsafeCopyTo_nullPointer()",
+  "event AggregateRootReceived(bytes32 root)",
+  "event AggregateRootRemoved(bytes32 root)",
+  "event AggregateRootVerified(bytes32 indexed root)",
+  "event DelayBlocksUpdated(uint256 indexed updated, address caller)",
+  "event Dispatch(bytes32 leaf, uint256 index, bytes32 root, bytes message)",
+  "event FundsWithdrawn(address indexed to, uint256 amount)",
+  "event GasCapUpdated(uint256 _previous, uint256 _updated)",
+  "event MessageProcessed(bytes data, address caller)",
+  "event MessageProven(bytes32 indexed leaf, bytes32 indexed aggregateRoot, uint256 aggregateIndex)",
+  "event MessageSent(bytes data, bytes encodedData, address caller)",
+  "event MirrorConnectorUpdated(address previous, address current)",
+  "event NewConnector(uint32 indexed domain, uint32 indexed mirrorDomain, address amb, address rootManager, address mirrorConnector)",
+  "event OwnershipProposed(address indexed proposedOwner)",
+  "event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)",
+  "event Paused(address account)",
+  "event Process(bytes32 leaf, bool success, bytes returnData)",
+  "event RefundAddressUpdated(address indexed previous, address indexed updated)",
+  "event SendRateLimitUpdated(address updater, uint256 newRateLimit)",
+  "event SenderAdded(address sender)",
+  "event SenderRemoved(address sender)",
+  "event Unpaused(address account)",
+  "event WatcherManagerChanged(address watcherManager)",
+  "function AMB() view returns (address)",
+  "function DOMAIN() view returns (uint32)",
+  "function MERKLE() view returns (address)",
+  "function MIRROR_DOMAIN() view returns (uint32)",
+  "function MIRROR_WORMHOLE_ID() view returns (uint16)",
+  "function PROCESS_GAS() view returns (uint256)",
+  "function RESERVE_GAS() view returns (uint256)",
+  "function ROOT_MANAGER() view returns (address)",
+  "function acceptProposedOwner()",
+  "function addSender(address _sender)",
+  "function allowlistedSenders(address) view returns (bool)",
+  "function delay() view returns (uint256)",
+  "function delayBlocks() view returns (uint256)",
+  "function dispatch(uint32 _destinationDomain, bytes32 _recipientAddress, bytes _messageBody) returns (bytes32, bytes)",
+  "function home() view returns (address)",
+  "function isReplica(address _potentialReplica) view returns (bool)",
+  "function lastSentBlock() view returns (uint256)",
+  "function localDomain() view returns (uint32)",
+  "function messages(bytes32) view returns (uint8)",
+  "function mirrorConnector() view returns (address)",
+  "function nonces(uint32) view returns (uint32)",
+  "function outboundRoot() view returns (bytes32)",
+  "function owner() view returns (address)",
+  "function pause()",
+  "function paused() view returns (bool)",
+  "function pendingAggregateRoots(bytes32) view returns (uint256)",
+  "function processMessage(bytes _data)",
+  "function processedWhMessages(bytes32) view returns (bool)",
+  "function proposeNewOwner(address newlyProposed)",
+  "function proposed() view returns (address)",
+  "function proposedTimestamp() view returns (uint256)",
+  "function proveAndProcess(tuple(bytes message, bytes32[32] path, uint256 index)[] _proofs, bytes32 _aggregateRoot, bytes32[32] _aggregatePath, uint256 _aggregateIndex)",
+  "function provenAggregateRoots(bytes32) view returns (bool)",
+  "function provenMessageRoots(bytes32) view returns (bool)",
+  "function quoteEVMDeliveryPrice(uint256 _gasLimit, address _amb) view returns (uint256 _cost)",
+  "function rateLimitBlocks() view returns (uint256)",
+  "function receiveWormholeMessages(bytes _payload, bytes[], bytes32 _sourceAddress, uint16 _sourceChain, bytes32 _deliveryHash) payable",
+  "function refundAddress() view returns (address)",
+  "function removePendingAggregateRoot(bytes32 _fraudulentRoot)",
+  "function removeSender(address _sender)",
+  "function renounceOwnership()",
+  "function renounced() view returns (bool)",
+  "function send(bytes _encodedData) payable",
+  "function sentMessageRoots(bytes32) view returns (bool)",
+  "function setDelayBlocks(uint256 _delayBlocks)",
+  "function setGasCap(uint256 _gasCap)",
+  "function setMirrorConnector(address _mirrorConnector)",
+  "function setRateLimitBlocks(uint256 _rateLimit)",
+  "function setRefundAddress(address _updated)",
+  "function setWatcherManager(address _watcherManager)",
+  "function unpause()",
+  "function verifySender(address _expected) returns (bool)",
+  "function watcherManager() view returns (address)",
+  "function withdrawFunds(address _to)"
+]

packages/deployments/contracts/abi/contracts/messaging/interfaces/ambs/wormhole/IWormholeReceiver.sol/IWormholeReceiver.json

@@ -0,0 +1,3 @@
+[
+  "function receiveWormholeMessages(bytes payload, bytes[] additionalVaas, bytes32 sourceAddress, uint16 sourceChain, bytes32 deliveryHash) payable"
+]