dop-wallet-v6 1.1.5

package/dist/services/transactions/tx-cross-contract-calls.js

@@ -0,0 +1,386 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseRelayAdaptReturnValue = exports.getRelayAdaptTransactionError = exports.populateProvedCrossContractCalls = exports.createNFTTokenDataFromDopNFTAmount = exports.createRelayAdaptUnshieldNFTAmountRecipients = exports.createRelayAdaptUnshieldERC20AmountRecipients = void 0;
+const dop_sharedmodel_v5_1 = require("dop-sharedmodel-v5");
+const providers_1 = require("../dop/core/providers");
+const proof_cache_1 = require("./proof-cache");
+const logger_1 = require("../../utils/logger");
+const dop_engine_v5_1 = require("dop-engine-v5");
+const blocked_address_1 = require("../../utils/blocked-address");
+// import { gasEstimateResponseDummyProofIterativeRelayerFee } from './tx-gas-relayer-fee-estimator';
+const error_1 = require("../../utils/error");
+const createValidCrossContractCalls = (crossContractCalls) => {
+    if (!crossContractCalls.length) {
+        throw new Error('No cross contract calls in transaction.');
+    }
+    try {
+        return crossContractCalls.map(transactionRequest => {
+            if (!transactionRequest.to || !transactionRequest.data) {
+                throw new Error(`Cross-contract calls require 'to' and 'data' fields.`);
+            }
+            const transaction = {
+                to: transactionRequest.to,
+                value: transactionRequest.value,
+                data: (0, dop_engine_v5_1.hexlify)(transactionRequest.data, true),
+            };
+            (0, blocked_address_1.assertNotBlockedAddress)(transaction.to);
+            return transaction;
+        });
+    }
+    catch (err) {
+        if (!(err instanceof Error)) {
+            throw err;
+        }
+        throw (0, error_1.reportAndSanitizeError)(createValidCrossContractCalls.name, err);
+    }
+};
+const createRelayAdaptUnshieldERC20AmountRecipients = (networkName, unshieldERC20Amounts) => {
+    const relayAdaptContract = (0, providers_1.getRelayAdaptContractForNetwork)(networkName);
+    const unshieldERC20AmountRecipients = unshieldERC20Amounts.map(unshieldERC20Amount => ({
+        ...unshieldERC20Amount,
+        recipientAddress: relayAdaptContract.address,
+    }));
+    return unshieldERC20AmountRecipients;
+};
+exports.createRelayAdaptUnshieldERC20AmountRecipients = createRelayAdaptUnshieldERC20AmountRecipients;
+const createRelayAdaptUnshieldNFTAmountRecipients = (networkName, unshieldNFTAmounts) => {
+    const relayAdaptContract = (0, providers_1.getRelayAdaptContractForNetwork)(networkName);
+    const unshieldNFTAmountRecipients = unshieldNFTAmounts.map(unshieldNFTAmount => ({
+        ...unshieldNFTAmount,
+        recipientAddress: relayAdaptContract.address,
+    }));
+    return unshieldNFTAmountRecipients;
+};
+exports.createRelayAdaptUnshieldNFTAmountRecipients = createRelayAdaptUnshieldNFTAmountRecipients;
+const isDecimalStr = (str) => {
+    const decimalPattern = /^[-+]?(\d+(\.\d*)?|\.\d+)$/;
+    return decimalPattern.test(str);
+};
+const bigIntStringToHex = (bigintString) => {
+    return `0x${BigInt(bigintString).toString(16)}`;
+};
+const createNFTTokenDataFromDopNFTAmount = (nftAmount) => {
+    // const tokenSubIDHex = isDecimalStr(nftAmount.tokenSubID)
+    //   ? bigIntStringToHex(nftAmount.tokenSubID)
+    //   : nftAmount.tokenSubID;
+    return {
+        tokenAddress: (0, dop_engine_v5_1.formatToByteLength)(nftAmount.nftAddress, dop_engine_v5_1.ByteLength.Address, true),
+        tokenType: nftAmount.nftTokenType,
+        tokenSubID: (0, dop_engine_v5_1.formatToByteLength)(nftAmount.tokenSubID, dop_engine_v5_1.ByteLength.UINT_256, true),
+    };
+};
+exports.createNFTTokenDataFromDopNFTAmount = createNFTTokenDataFromDopNFTAmount;
+const createRelayAdaptShieldNFTRecipients = (relayAdaptShieldNFTRecipients) => {
+    return relayAdaptShieldNFTRecipients.map((nftRecipient) => ({
+        nftTokenData: (0, exports.createNFTTokenDataFromDopNFTAmount)(nftRecipient),
+        recipientAddress: nftRecipient.recipientAddress,
+    }));
+};
+const populateProvedCrossContractCalls = async (networkName, dopWalletID, relayAdaptUnshieldERC20Amounts, relayAdaptUnshieldNFTAmounts, relayAdaptShieldERC20Recipients, relayAdaptShieldNFTRecipients, crossContractCalls, relayerFeeERC20AmountRecipient, sendWithPublicWallet, overallBatchMinGasPrice, gasDetails) => {
+    try {
+        const { transaction, nullifiers } = await (0, proof_cache_1.populateProvedTransaction)(networkName, dop_sharedmodel_v5_1.ProofType.CrossContractCalls, dopWalletID, false, // showSenderAddressToRecipient
+        undefined, // memoText
+        [], // erc20AmountRecipients
+        [], // nftAmountRecipients
+        relayAdaptUnshieldERC20Amounts, relayAdaptUnshieldNFTAmounts, relayAdaptShieldERC20Recipients, relayAdaptShieldNFTRecipients, crossContractCalls, relayerFeeERC20AmountRecipient, sendWithPublicWallet, overallBatchMinGasPrice, gasDetails);
+        delete transaction.from;
+        return {
+            nullifiers,
+            transaction,
+        };
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.populateProvedCrossContractCalls.name, err);
+    }
+};
+exports.populateProvedCrossContractCalls = populateProvedCrossContractCalls;
+/*
+export const gasEstimateForUnprovenCrossContractCalls = async (
+  networkName: NetworkName,
+  dopWalletID: string,
+  encryptionKey: string,
+  relayAdaptUnshieldERC20Amounts: DopERC20Amount[],
+  relayAdaptUnshieldNFTAmounts: DopNFTAmount[],
+  relayAdaptShieldERC20Recipients: DopERC20Recipient[],
+  relayAdaptShieldNFTRecipients: DopNFTAmountRecipient[],
+  crossContractCalls: ContractTransaction[],
+  originalGasDetails: TransactionGasDetails,
+  feeTokenDetails: Optional<FeeTokenDetails>,
+  sendWithPublicWallet: boolean,
+  minGasLimit: Optional<bigint>,
+  valueCheck: bigint
+): Promise<DopTransactionGasEstimateResponse> => {
+  try {
+    setCachedProvedTransaction(undefined);
+
+    const overallBatchMinGasPrice = 0n;
+
+    const validCrossContractCalls =
+      createValidCrossContractCalls(crossContractCalls);
+
+    const relayAdaptContract = getRelayAdaptContractForNetwork(networkName);
+
+    const relayAdaptUnshieldERC20AmountRecipients: DopERC20AmountRecipient[] =
+      createRelayAdaptUnshieldERC20AmountRecipients(
+        networkName,
+        relayAdaptUnshieldERC20Amounts,
+      );
+    const relayAdaptUnshieldNFTAmountRecipients: DopNFTAmountRecipient[] =
+      createRelayAdaptUnshieldNFTAmountRecipients(
+        networkName,
+        relayAdaptUnshieldNFTAmounts,
+      );
+
+    const shieldRandom = randomHex(16);
+    const relayShieldRequests =
+      await RelayAdaptHelper.generateRelayShieldRequests(
+        shieldRandom,
+        relayAdaptShieldERC20Recipients,
+        createRelayAdaptShieldNFTRecipients(relayAdaptShieldNFTRecipients),
+      );
+
+    const minimumGasLimit =
+      minGasLimit ?? MINIMUM_RELAY_ADAPT_CROSS_CONTRACT_CALLS_GAS_LIMIT;
+
+    const response = await gasEstimateResponseDummyProofIterativeRelayerFee(
+      (relayerFeeERC20Amount: Optional<DopERC20Amount>) =>
+        generateDummyProofTransactions(
+          ProofType.CrossContractCalls,
+          networkName,
+          dopWalletID,
+          encryptionKey,
+          false, // showSenderAddressToRecipient
+          undefined, // memoText
+          relayAdaptUnshieldERC20AmountRecipients,
+          relayAdaptUnshieldNFTAmountRecipients,
+          relayerFeeERC20Amount,
+          sendWithPublicWallet,
+          overallBatchMinGasPrice,
+          valueCheck
+        ),
+      async (txs: TransactionStruct[]) => {
+        const relayAdaptParamsRandom = randomHex(31);
+
+        // TODO: We should add the relay adapt contract gas limit here.
+        const transaction = await relayAdaptContract.populateCrossContractCalls(
+          txs,
+          validCrossContractCalls,
+          relayShieldRequests,
+          relayAdaptParamsRandom,
+          true, // isGasEstimate
+          !sendWithPublicWallet, // isRelayerTransaction
+          minimumGasLimit,
+        );
+        // Remove gasLimit, we'll set to the minimum below.
+        // TODO: Remove after callbacks upgrade.
+        delete transaction.gasLimit;
+        return transaction;
+      },
+      networkName,
+      dopWalletID,
+      relayAdaptUnshieldERC20AmountRecipients,
+      originalGasDetails,
+      feeTokenDetails,
+      sendWithPublicWallet,
+      true, // isCrossContractCall
+    );
+
+    // TODO: Remove this after callbacks upgrade.
+    // If gas estimate is under the cross-contract-minimum, replace it with the minimum.
+    if (response.gasEstimate) {
+      if (response.gasEstimate < minimumGasLimit) {
+        response.gasEstimate = minimumGasLimit;
+      }
+    }
+
+    return response;
+  } catch (err) {
+    throw reportAndSanitizeError(
+      gasEstimateForUnprovenCrossContractCalls.name,
+      err,
+    );
+  }
+};
+*/
+/*
+export const generateCrossContractCallsProof = async (
+  networkName: NetworkName,
+  dopWalletID: string,
+  encryptionKey: string,
+  relayAdaptUnshieldERC20Amounts: DopERC20Amount[],
+  relayAdaptUnshieldNFTAmounts: DopNFTAmount[],
+  relayAdaptShieldERC20Recipients: DopERC20Recipient[],
+  relayAdaptShieldNFTRecipients: DopNFTAmountRecipient[],
+  crossContractCalls: ContractTransaction[],
+  relayerFeeERC20AmountRecipient: Optional<DopERC20AmountRecipient>,
+  sendWithPublicWallet: boolean,
+  overallBatchMinGasPrice: Optional<bigint>,
+  minGasLimit: Optional<bigint>,
+  progressCallback: ProverProgressCallback,
+  valueCheck: bigint
+): Promise<void> => {
+  try {
+    setCachedProvedTransaction(undefined);
+
+    const validCrossContractCalls =
+      createValidCrossContractCalls(crossContractCalls);
+
+    const relayAdaptContract = getRelayAdaptContractForNetwork(networkName);
+
+    const relayAdaptUnshieldERC20AmountRecipients: DopERC20AmountRecipient[] =
+      createRelayAdaptUnshieldERC20AmountRecipients(
+        networkName,
+        relayAdaptUnshieldERC20Amounts,
+      );
+    const relayAdaptUnshieldNFTAmountRecipients: DopNFTAmountRecipient[] =
+      createRelayAdaptUnshieldNFTAmountRecipients(
+        networkName,
+        relayAdaptUnshieldNFTAmounts,
+      );
+
+    // Generate dummy txs for relay adapt params.
+    const dummyUnshieldTxs = await generateDummyProofTransactions(
+      ProofType.CrossContractCalls,
+      networkName,
+      dopWalletID,
+      encryptionKey,
+      false, // showSenderAddressToRecipient
+      undefined, // memoText
+      relayAdaptUnshieldERC20AmountRecipients,
+      relayAdaptUnshieldNFTAmountRecipients,
+      relayerFeeERC20AmountRecipient,
+      sendWithPublicWallet,
+      overallBatchMinGasPrice,
+      valueCheck
+    );
+
+    // Generate relay adapt params from dummy transactions.
+    const shieldRandom = randomHex(16);
+
+    const relayShieldRequests =
+      await RelayAdaptHelper.generateRelayShieldRequests(
+        shieldRandom,
+        relayAdaptShieldERC20Recipients,
+        createRelayAdaptShieldNFTRecipients(relayAdaptShieldNFTRecipients),
+      );
+
+    const minimumGasLimit =
+      minGasLimit ?? MINIMUM_RELAY_ADAPT_CROSS_CONTRACT_CALLS_GAS_LIMIT;
+
+    const isRelayerTransaction = !sendWithPublicWallet;
+    const relayAdaptParamsRandom = randomHex(31);
+    const relayAdaptParams =
+      await relayAdaptContract.getRelayAdaptParamsCrossContractCalls(
+        dummyUnshieldTxs,
+        validCrossContractCalls,
+        relayShieldRequests,
+        relayAdaptParamsRandom,
+        isRelayerTransaction,
+        minimumGasLimit,
+      );
+    const relayAdaptID: AdaptID = {
+      contract: relayAdaptContract.address,
+      parameters: relayAdaptParams,
+    };
+
+
+    // console.log("====== 4",
+    //   ProofType.CrossContractCalls,
+    //   networkName,
+    //   dopWalletID,
+    //   encryptionKey,
+    //   false, // showSenderAddressToRecipient
+    //   undefined, // memoText
+    //   relayAdaptUnshieldERC20AmountRecipients,
+    //   relayAdaptUnshieldNFTAmountRecipients,
+    //   relayerFeeERC20AmountRecipient,
+    //   sendWithPublicWallet,
+    //   relayAdaptID,
+    //   false, // useDummyProof
+    //   overallBatchMinGasPrice,
+    //   progressCallback);
+
+    // Create real transactions with relay adapt params.
+    const transactions = await generateProofTransactions(
+      ProofType.CrossContractCalls,
+      networkName,
+      dopWalletID,
+      encryptionKey,
+      false, // showSenderAddressToRecipient
+      undefined, // memoText
+      relayAdaptUnshieldERC20AmountRecipients,
+      relayAdaptUnshieldNFTAmountRecipients,
+      relayerFeeERC20AmountRecipient,
+      sendWithPublicWallet,
+      relayAdaptID,
+      false, // useDummyProof
+      overallBatchMinGasPrice,
+      progressCallback,
+      valueCheck
+    );
+
+    const nullifiers = nullifiersForTransactions(transactions);
+
+    const transaction = await relayAdaptContract.populateCrossContractCalls(
+      transactions,
+      validCrossContractCalls,
+      relayShieldRequests,
+      relayAdaptParamsRandom,
+      false, // isGasEstimate
+      isRelayerTransaction,
+      minimumGasLimit,
+    );
+    delete transaction.from;
+
+    setCachedProvedTransaction({
+      proofType: ProofType.CrossContractCalls,
+      dopWalletID,
+      showSenderAddressToRecipient: false,
+      memoText: undefined,
+      erc20AmountRecipients: [],
+      nftAmountRecipients: [],
+      relayAdaptUnshieldERC20Amounts,
+      relayAdaptUnshieldNFTAmounts,
+      relayAdaptShieldERC20Recipients,
+      relayAdaptShieldNFTRecipients,
+      crossContractCalls: validCrossContractCalls,
+      relayerFeeERC20AmountRecipient,
+      sendWithPublicWallet,
+      transaction,
+      overallBatchMinGasPrice,
+      nullifiers,
+    });
+  } catch (err) {
+    throw reportAndSanitizeError(generateCrossContractCallsProof.name, err);
+  }
+};
+*/
+const getRelayAdaptTransactionError = (receiptLogs) => {
+    try {
+        const relayAdaptError = dop_engine_v5_1.RelayAdaptContract.getRelayAdaptCallError(receiptLogs);
+        if ((0, dop_sharedmodel_v5_1.isDefined)(relayAdaptError)) {
+            (0, logger_1.sendErrorMessage)(relayAdaptError);
+            return relayAdaptError;
+        }
+        return undefined;
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.getRelayAdaptTransactionError.name, err);
+    }
+};
+exports.getRelayAdaptTransactionError = getRelayAdaptTransactionError;
+const parseRelayAdaptReturnValue = (data) => {
+    try {
+        const relayAdaptErrorParsed = dop_engine_v5_1.RelayAdaptContract.parseRelayAdaptReturnValue(data);
+        if (relayAdaptErrorParsed) {
+            (0, logger_1.sendErrorMessage)(relayAdaptErrorParsed.error);
+            return relayAdaptErrorParsed.error;
+        }
+        return undefined;
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.getRelayAdaptTransactionError.name, err);
+    }
+};
+exports.parseRelayAdaptReturnValue = parseRelayAdaptReturnValue;
+//# sourceMappingURL=tx-cross-contract-calls.js.map

package/dist/services/transactions/tx-cross-contract-calls.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tx-cross-contract-calls.js","sourceRoot":"","sources":["../../../src/services/transactions/tx-cross-contract-calls.ts"],"names":[],"mappings":";;;AAAA,2DAc4B;AAC5B,qDAAwE;AAMxE,+CAGuB;AACvB,+CAAsD;AACtD,iDAauB;AACvB,iEAAsE;AACtE,qGAAqG;AACrG,6CAA2D;AAG3D,MAAM,6BAA6B,GAAG,CACpC,kBAAyC,EAClB,EAAE;IACzB,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE;QAC9B,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;KAC5D;IACD,IAAI;QACF,OAAO,kBAAkB,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAAE;YACjD,IAAI,CAAC,kBAAkB,CAAC,EAAE,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE;gBACtD,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;aACzE;YACD,MAAM,WAAW,GAAwB;gBACvC,EAAE,EAAE,kBAAkB,CAAC,EAAE;gBACzB,KAAK,EAAE,kBAAkB,CAAC,KAAK;gBAC/B,IAAI,EAAE,IAAA,uBAAO,EAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC;aAC7C,CAAC;YACF,IAAA,yCAAuB,EAAC,WAAW,CAAC,EAAE,CAAC,CAAC;YACxC,OAAO,WAAW,CAAC;QACrB,CAAC,CAAC,CAAC;KACJ;IAAC,OAAO,GAAG,EAAE;QACZ,IAAI,CAAC,CAAC,GAAG,YAAY,KAAK,CAAC,EAAE;YAC3B,MAAM,GAAG,CAAC;SACX;QACD,MAAM,IAAA,8BAAsB,EAAC,6BAA6B,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KACvE;AACH,CAAC,CAAC;AAEK,MAAM,6CAA6C,GAAG,CAC3D,WAAwB,EACxB,oBAAsC,EACX,EAAE;IAC7B,MAAM,kBAAkB,GAAG,IAAA,2CAA+B,EAAC,WAAW,CAAC,CAAC;IACxE,MAAM,6BAA6B,GACjC,oBAAoB,CAAC,GAAG,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC;QAC/C,GAAG,mBAAmB;QACtB,gBAAgB,EAAE,kBAAkB,CAAC,OAAO;KAC7C,CAAC,CAAC,CAAC;IACN,OAAO,6BAA6B,CAAC;AACvC,CAAC,CAAC;AAXW,QAAA,6CAA6C,iDAWxD;AAEK,MAAM,2CAA2C,GAAG,CACzD,WAAwB,EACxB,kBAAkC,EACT,EAAE;IAC3B,MAAM,kBAAkB,GAAG,IAAA,2CAA+B,EAAC,WAAW,CAAC,CAAC;IACxE,MAAM,2BAA2B,GAC/B,kBAAkB,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;QAC3C,GAAG,iBAAiB;QACpB,gBAAgB,EAAE,kBAAkB,CAAC,OAAO;KAC7C,CAAC,CAAC,CAAC;IACN,OAAO,2BAA2B,CAAC;AACrC,CAAC,CAAC;AAXW,QAAA,2CAA2C,+CAWtD;AAEF,MAAM,YAAY,GAAG,CAAC,GAAW,EAAW,EAAE;IAC5C,MAAM,cAAc,GAAG,4BAA4B,CAAC;IACpD,OAAO,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClC,CAAC,CAAA;AAED,MAAM,iBAAiB,GAAG,CAAC,YAAoB,EAAU,EAAE;IACzD,OAAO,KAAK,MAAM,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;AAClD,CAAC,CAAC;AAEK,MAAM,kCAAkC,GAAG,CAChD,SAAuB,EACT,EAAE;IAEhB,2DAA2D;IAC3D,8CAA8C;IAC9C,4BAA4B;IAE5B,OAAO;QACL,YAAY,EAAE,IAAA,kCAAkB,EAC9B,SAAS,CAAC,UAAU,EACpB,0BAAU,CAAC,OAAO,EAClB,IAAI,CACL;QACD,SAAS,EAAE,SAAS,CAAC,YAAqB;QAC1C,UAAU,EAAE,IAAA,kCAAkB,EAC5B,SAAS,CAAC,UAAU,EACpB,0BAAU,CAAC,QAAQ,EACnB,IAAI,CACL;KACF,CAAC;AACJ,CAAC,CAAC;AArBW,QAAA,kCAAkC,sCAqB7C;AAEF,MAAM,mCAAmC,GAAG,CAC1C,6BAAsD,EACtB,EAAE;IAClC,OAAO,6BAA6B,CAAC,GAAG,CACtC,CAAC,YAAmC,EAAE,EAAE,CAAC,CAAC;QACxC,YAAY,EAAE,IAAA,0CAAkC,EAAC,YAAY,CAAC;QAC9D,gBAAgB,EAAE,YAAY,CAAC,gBAAgB;KAChD,CAAC,CACH,CAAC;AACJ,CAAC,CAAC;AAEK,MAAM,gCAAgC,GAAG,KAAK,EACnD,WAAwB,EACxB,WAAmB,EACnB,8BAAgD,EAChD,4BAA4C,EAC5C,+BAAoD,EACpD,6BAAsD,EACtD,kBAAyC,EACzC,8BAAiE,EACjE,oBAA6B,EAC7B,uBAAyC,EACzC,UAAiC,EACQ,EAAE;IAC3C,IAAI;QACF,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,MAAM,IAAA,uCAAyB,EACjE,WAAW,EACX,8BAAS,CAAC,kBAAkB,EAC5B,WAAW,EACX,KAAK,EAAE,+BAA+B;QACtC,SAAS,EAAE,WAAW;QACtB,EAAE,EAAE,wBAAwB;QAC5B,EAAE,EAAE,sBAAsB;QAC1B,8BAA8B,EAC9B,4BAA4B,EAC5B,+BAA+B,EAC/B,6BAA6B,EAC7B,kBAAkB,EAClB,8BAA8B,EAC9B,oBAAoB,EACpB,uBAAuB,EACvB,UAAU,CACX,CAAC;QACF,OAAO,WAAW,CAAC,IAAI,CAAC;QAExB,OAAO;YACL,UAAU;YACV,WAAW;SACZ,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,wCAAgC,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KAC1E;AACH,CAAC,CAAC;AAzCW,QAAA,gCAAgC,oCAyC3C;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA2GE;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwJE;AAEK,MAAM,6BAA6B,GAAG,CAC3C,WAAqD,EACnC,EAAE;IACpB,IAAI;QACF,MAAM,eAAe,GACnB,kCAAkB,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;QACzD,IAAI,IAAA,8BAAS,EAAC,eAAe,CAAC,EAAE;YAC9B,IAAA,yBAAgB,EAAC,eAAe,CAAC,CAAC;YAClC,OAAO,eAAe,CAAC;SACxB;QACD,OAAO,SAAS,CAAC;KAClB;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,qCAA6B,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KACvE;AACH,CAAC,CAAC;AAdW,QAAA,6BAA6B,iCAcxC;AAEK,MAAM,0BAA0B,GAAG,CAAC,IAAY,EAAoB,EAAE;IAC3E,IAAI;QACF,MAAM,qBAAqB,GACzB,kCAAkB,CAAC,0BAA0B,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,qBAAqB,EAAE;YACzB,IAAA,yBAAgB,EAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;YAC9C,OAAO,qBAAqB,CAAC,KAAK,CAAC;SACpC;QACD,OAAO,SAAS,CAAC;KAClB;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,qCAA6B,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KACvE;AACH,CAAC,CAAC;AAZW,QAAA,0BAA0B,8BAYrC","sourcesContent":["import {\n  DopPopulateTransactionResponse,\n  DopTransactionGasEstimateResponse,\n  DopERC20Amount,\n  NetworkName,\n  ProofType,\n  TransactionReceiptLog,\n  FeeTokenDetails,\n  DopERC20AmountRecipient,\n  DopNFTAmountRecipient,\n  DopNFTAmount,\n  TransactionGasDetails,\n  isDefined,\n  DopERC20Recipient,\n} from 'dop-sharedmodel-v5';\nimport { getRelayAdaptContractForNetwork } from '../dop/core/providers';\nimport {\n  generateDummyProofTransactions,\n  generateProofTransactions,\n  nullifiersForTransactions,\n} from './tx-generator';\nimport {\n  populateProvedTransaction,\n  setCachedProvedTransaction,\n} from './proof-cache';\nimport { sendErrorMessage } from '../../utils/logger';\nimport {\n  RelayAdaptHelper,\n  AdaptID,\n  TransactionStruct,\n  hexlify,\n  randomHex,\n  RelayAdaptContract,\n  ProverProgressCallback,\n  NFTTokenData,\n  formatToByteLength,\n  ByteLength,\n  MINIMUM_RELAY_ADAPT_CROSS_CONTRACT_CALLS_GAS_LIMIT,\n  RelayAdaptShieldNFTRecipient,\n} from 'dop-engine-v5';\nimport { assertNotBlockedAddress } from '../../utils/blocked-address';\n// import { gasEstimateResponseDummyProofIterativeRelayerFee } from './tx-gas-relayer-fee-estimator';\nimport { reportAndSanitizeError } from '../../utils/error';\nimport { ContractTransaction, Log } from 'ethers';\n\nconst createValidCrossContractCalls = (\n  crossContractCalls: ContractTransaction[],\n): ContractTransaction[] => {\n  if (!crossContractCalls.length) {\n    throw new Error('No cross contract calls in transaction.');\n  }\n  try {\n    return crossContractCalls.map(transactionRequest => {\n      if (!transactionRequest.to || !transactionRequest.data) {\n        throw new Error(`Cross-contract calls require 'to' and 'data' fields.`);\n      }\n      const transaction: ContractTransaction = {\n        to: transactionRequest.to,\n        value: transactionRequest.value,\n        data: hexlify(transactionRequest.data, true),\n      };\n      assertNotBlockedAddress(transaction.to);\n      return transaction;\n    });\n  } catch (err) {\n    if (!(err instanceof Error)) {\n      throw err;\n    }\n    throw reportAndSanitizeError(createValidCrossContractCalls.name, err);\n  }\n};\n\nexport const createRelayAdaptUnshieldERC20AmountRecipients = (\n  networkName: NetworkName,\n  unshieldERC20Amounts: DopERC20Amount[],\n): DopERC20AmountRecipient[] => {\n  const relayAdaptContract = getRelayAdaptContractForNetwork(networkName);\n  const unshieldERC20AmountRecipients: DopERC20AmountRecipient[] =\n    unshieldERC20Amounts.map(unshieldERC20Amount => ({\n      ...unshieldERC20Amount,\n      recipientAddress: relayAdaptContract.address,\n    }));\n  return unshieldERC20AmountRecipients;\n};\n\nexport const createRelayAdaptUnshieldNFTAmountRecipients = (\n  networkName: NetworkName,\n  unshieldNFTAmounts: DopNFTAmount[],\n): DopNFTAmountRecipient[] => {\n  const relayAdaptContract = getRelayAdaptContractForNetwork(networkName);\n  const unshieldNFTAmountRecipients: DopNFTAmountRecipient[] =\n    unshieldNFTAmounts.map(unshieldNFTAmount => ({\n      ...unshieldNFTAmount,\n      recipientAddress: relayAdaptContract.address,\n    }));\n  return unshieldNFTAmountRecipients;\n};\n\nconst isDecimalStr = (str: string): boolean => {\n  const decimalPattern = /^[-+]?(\\d+(\\.\\d*)?|\\.\\d+)$/;\n  return decimalPattern.test(str);\n}\n\nconst bigIntStringToHex = (bigintString: string): string => {\n  return `0x${BigInt(bigintString).toString(16)}`;\n};\n\nexport const createNFTTokenDataFromDopNFTAmount = (\n  nftAmount: DopNFTAmount,\n): NFTTokenData => {\n\n  // const tokenSubIDHex = isDecimalStr(nftAmount.tokenSubID)\n  //   ? bigIntStringToHex(nftAmount.tokenSubID)\n  //   : nftAmount.tokenSubID;\n\n  return {\n    tokenAddress: formatToByteLength(\n      nftAmount.nftAddress,\n      ByteLength.Address,\n      true,\n    ),\n    tokenType: nftAmount.nftTokenType as 1 | 2,\n    tokenSubID: formatToByteLength(\n      nftAmount.tokenSubID,\n      ByteLength.UINT_256,\n      true,\n    ),\n  };\n};\n\nconst createRelayAdaptShieldNFTRecipients = (\n  relayAdaptShieldNFTRecipients: DopNFTAmountRecipient[],\n): RelayAdaptShieldNFTRecipient[] => {\n  return relayAdaptShieldNFTRecipients.map(\n    (nftRecipient: DopNFTAmountRecipient) => ({\n      nftTokenData: createNFTTokenDataFromDopNFTAmount(nftRecipient),\n      recipientAddress: nftRecipient.recipientAddress,\n    }),\n  );\n};\n\nexport const populateProvedCrossContractCalls = async (\n  networkName: NetworkName,\n  dopWalletID: string,\n  relayAdaptUnshieldERC20Amounts: DopERC20Amount[],\n  relayAdaptUnshieldNFTAmounts: DopNFTAmount[],\n  relayAdaptShieldERC20Recipients: DopERC20Recipient[],\n  relayAdaptShieldNFTRecipients: DopNFTAmountRecipient[],\n  crossContractCalls: ContractTransaction[],\n  relayerFeeERC20AmountRecipient: Optional<DopERC20AmountRecipient>,\n  sendWithPublicWallet: boolean,\n  overallBatchMinGasPrice: Optional<bigint>,\n  gasDetails: TransactionGasDetails,\n): Promise<DopPopulateTransactionResponse> => {\n  try {\n    const { transaction, nullifiers } = await populateProvedTransaction(\n      networkName,\n      ProofType.CrossContractCalls,\n      dopWalletID,\n      false, // showSenderAddressToRecipient\n      undefined, // memoText\n      [], // erc20AmountRecipients\n      [], // nftAmountRecipients\n      relayAdaptUnshieldERC20Amounts,\n      relayAdaptUnshieldNFTAmounts,\n      relayAdaptShieldERC20Recipients,\n      relayAdaptShieldNFTRecipients,\n      crossContractCalls,\n      relayerFeeERC20AmountRecipient,\n      sendWithPublicWallet,\n      overallBatchMinGasPrice,\n      gasDetails,\n    );\n    delete transaction.from;\n\n    return {\n      nullifiers,\n      transaction,\n    };\n  } catch (err) {\n    throw reportAndSanitizeError(populateProvedCrossContractCalls.name, err);\n  }\n};\n/*\nexport const gasEstimateForUnprovenCrossContractCalls = async (\n  networkName: NetworkName,\n  dopWalletID: string,\n  encryptionKey: string,\n  relayAdaptUnshieldERC20Amounts: DopERC20Amount[],\n  relayAdaptUnshieldNFTAmounts: DopNFTAmount[],\n  relayAdaptShieldERC20Recipients: DopERC20Recipient[],\n  relayAdaptShieldNFTRecipients: DopNFTAmountRecipient[],\n  crossContractCalls: ContractTransaction[],\n  originalGasDetails: TransactionGasDetails,\n  feeTokenDetails: Optional<FeeTokenDetails>,\n  sendWithPublicWallet: boolean,\n  minGasLimit: Optional<bigint>,\n  valueCheck: bigint\n): Promise<DopTransactionGasEstimateResponse> => {\n  try {\n    setCachedProvedTransaction(undefined);\n\n    const overallBatchMinGasPrice = 0n;\n\n    const validCrossContractCalls =\n      createValidCrossContractCalls(crossContractCalls);\n\n    const relayAdaptContract = getRelayAdaptContractForNetwork(networkName);\n\n    const relayAdaptUnshieldERC20AmountRecipients: DopERC20AmountRecipient[] =\n      createRelayAdaptUnshieldERC20AmountRecipients(\n        networkName,\n        relayAdaptUnshieldERC20Amounts,\n      );\n    const relayAdaptUnshieldNFTAmountRecipients: DopNFTAmountRecipient[] =\n      createRelayAdaptUnshieldNFTAmountRecipients(\n        networkName,\n        relayAdaptUnshieldNFTAmounts,\n      );\n\n    const shieldRandom = randomHex(16);\n    const relayShieldRequests =\n      await RelayAdaptHelper.generateRelayShieldRequests(\n        shieldRandom,\n        relayAdaptShieldERC20Recipients,\n        createRelayAdaptShieldNFTRecipients(relayAdaptShieldNFTRecipients),\n      );\n\n    const minimumGasLimit =\n      minGasLimit ?? MINIMUM_RELAY_ADAPT_CROSS_CONTRACT_CALLS_GAS_LIMIT;\n\n    const response = await gasEstimateResponseDummyProofIterativeRelayerFee(\n      (relayerFeeERC20Amount: Optional<DopERC20Amount>) =>\n        generateDummyProofTransactions(\n          ProofType.CrossContractCalls,\n          networkName,\n          dopWalletID,\n          encryptionKey,\n          false, // showSenderAddressToRecipient\n          undefined, // memoText\n          relayAdaptUnshieldERC20AmountRecipients,\n          relayAdaptUnshieldNFTAmountRecipients,\n          relayerFeeERC20Amount,\n          sendWithPublicWallet,\n          overallBatchMinGasPrice,\n          valueCheck\n        ),\n      async (txs: TransactionStruct[]) => {\n        const relayAdaptParamsRandom = randomHex(31);\n\n        // TODO: We should add the relay adapt contract gas limit here.\n        const transaction = await relayAdaptContract.populateCrossContractCalls(\n          txs,\n          validCrossContractCalls,\n          relayShieldRequests,\n          relayAdaptParamsRandom,\n          true, // isGasEstimate\n          !sendWithPublicWallet, // isRelayerTransaction\n          minimumGasLimit,\n        );\n        // Remove gasLimit, we'll set to the minimum below.\n        // TODO: Remove after callbacks upgrade.\n        delete transaction.gasLimit;\n        return transaction;\n      },\n      networkName,\n      dopWalletID,\n      relayAdaptUnshieldERC20AmountRecipients,\n      originalGasDetails,\n      feeTokenDetails,\n      sendWithPublicWallet,\n      true, // isCrossContractCall\n    );\n\n    // TODO: Remove this after callbacks upgrade.\n    // If gas estimate is under the cross-contract-minimum, replace it with the minimum.\n    if (response.gasEstimate) {\n      if (response.gasEstimate < minimumGasLimit) {\n        response.gasEstimate = minimumGasLimit;\n      }\n    }\n\n    return response;\n  } catch (err) {\n    throw reportAndSanitizeError(\n      gasEstimateForUnprovenCrossContractCalls.name,\n      err,\n    );\n  }\n};\n*/\n/*\nexport const generateCrossContractCallsProof = async (\n  networkName: NetworkName,\n  dopWalletID: string,\n  encryptionKey: string,\n  relayAdaptUnshieldERC20Amounts: DopERC20Amount[],\n  relayAdaptUnshieldNFTAmounts: DopNFTAmount[],\n  relayAdaptShieldERC20Recipients: DopERC20Recipient[],\n  relayAdaptShieldNFTRecipients: DopNFTAmountRecipient[],\n  crossContractCalls: ContractTransaction[],\n  relayerFeeERC20AmountRecipient: Optional<DopERC20AmountRecipient>,\n  sendWithPublicWallet: boolean,\n  overallBatchMinGasPrice: Optional<bigint>,\n  minGasLimit: Optional<bigint>,\n  progressCallback: ProverProgressCallback,\n  valueCheck: bigint\n): Promise<void> => {\n  try {\n    setCachedProvedTransaction(undefined);\n\n    const validCrossContractCalls =\n      createValidCrossContractCalls(crossContractCalls);\n\n    const relayAdaptContract = getRelayAdaptContractForNetwork(networkName);\n\n    const relayAdaptUnshieldERC20AmountRecipients: DopERC20AmountRecipient[] =\n      createRelayAdaptUnshieldERC20AmountRecipients(\n        networkName,\n        relayAdaptUnshieldERC20Amounts,\n      );\n    const relayAdaptUnshieldNFTAmountRecipients: DopNFTAmountRecipient[] =\n      createRelayAdaptUnshieldNFTAmountRecipients(\n        networkName,\n        relayAdaptUnshieldNFTAmounts,\n      );\n\n    // Generate dummy txs for relay adapt params.\n    const dummyUnshieldTxs = await generateDummyProofTransactions(\n      ProofType.CrossContractCalls,\n      networkName,\n      dopWalletID,\n      encryptionKey,\n      false, // showSenderAddressToRecipient\n      undefined, // memoText\n      relayAdaptUnshieldERC20AmountRecipients,\n      relayAdaptUnshieldNFTAmountRecipients,\n      relayerFeeERC20AmountRecipient,\n      sendWithPublicWallet,\n      overallBatchMinGasPrice,\n      valueCheck\n    );\n\n    // Generate relay adapt params from dummy transactions.\n    const shieldRandom = randomHex(16);\n\n    const relayShieldRequests =\n      await RelayAdaptHelper.generateRelayShieldRequests(\n        shieldRandom,\n        relayAdaptShieldERC20Recipients,\n        createRelayAdaptShieldNFTRecipients(relayAdaptShieldNFTRecipients),\n      );\n\n    const minimumGasLimit =\n      minGasLimit ?? MINIMUM_RELAY_ADAPT_CROSS_CONTRACT_CALLS_GAS_LIMIT;\n\n    const isRelayerTransaction = !sendWithPublicWallet;\n    const relayAdaptParamsRandom = randomHex(31);\n    const relayAdaptParams =\n      await relayAdaptContract.getRelayAdaptParamsCrossContractCalls(\n        dummyUnshieldTxs,\n        validCrossContractCalls,\n        relayShieldRequests,\n        relayAdaptParamsRandom,\n        isRelayerTransaction,\n        minimumGasLimit,\n      );\n    const relayAdaptID: AdaptID = {\n      contract: relayAdaptContract.address,\n      parameters: relayAdaptParams,\n    };\n\n\n    // console.log(\"====== 4\",\n    //   ProofType.CrossContractCalls,\n    //   networkName,\n    //   dopWalletID,\n    //   encryptionKey,\n    //   false, // showSenderAddressToRecipient\n    //   undefined, // memoText\n    //   relayAdaptUnshieldERC20AmountRecipients,\n    //   relayAdaptUnshieldNFTAmountRecipients,\n    //   relayerFeeERC20AmountRecipient,\n    //   sendWithPublicWallet,\n    //   relayAdaptID,\n    //   false, // useDummyProof\n    //   overallBatchMinGasPrice,\n    //   progressCallback);\n\n    // Create real transactions with relay adapt params.\n    const transactions = await generateProofTransactions(\n      ProofType.CrossContractCalls,\n      networkName,\n      dopWalletID,\n      encryptionKey,\n      false, // showSenderAddressToRecipient\n      undefined, // memoText\n      relayAdaptUnshieldERC20AmountRecipients,\n      relayAdaptUnshieldNFTAmountRecipients,\n      relayerFeeERC20AmountRecipient,\n      sendWithPublicWallet,\n      relayAdaptID,\n      false, // useDummyProof\n      overallBatchMinGasPrice,\n      progressCallback,\n      valueCheck\n    );\n\n    const nullifiers = nullifiersForTransactions(transactions);\n\n    const transaction = await relayAdaptContract.populateCrossContractCalls(\n      transactions,\n      validCrossContractCalls,\n      relayShieldRequests,\n      relayAdaptParamsRandom,\n      false, // isGasEstimate\n      isRelayerTransaction,\n      minimumGasLimit,\n    );\n    delete transaction.from;\n\n    setCachedProvedTransaction({\n      proofType: ProofType.CrossContractCalls,\n      dopWalletID,\n      showSenderAddressToRecipient: false,\n      memoText: undefined,\n      erc20AmountRecipients: [],\n      nftAmountRecipients: [],\n      relayAdaptUnshieldERC20Amounts,\n      relayAdaptUnshieldNFTAmounts,\n      relayAdaptShieldERC20Recipients,\n      relayAdaptShieldNFTRecipients,\n      crossContractCalls: validCrossContractCalls,\n      relayerFeeERC20AmountRecipient,\n      sendWithPublicWallet,\n      transaction,\n      overallBatchMinGasPrice,\n      nullifiers,\n    });\n  } catch (err) {\n    throw reportAndSanitizeError(generateCrossContractCallsProof.name, err);\n  }\n};\n*/\n\nexport const getRelayAdaptTransactionError = (\n  receiptLogs: TransactionReceiptLog[] | readonly Log[],\n): Optional<string> => {\n  try {\n    const relayAdaptError =\n      RelayAdaptContract.getRelayAdaptCallError(receiptLogs);\n    if (isDefined(relayAdaptError)) {\n      sendErrorMessage(relayAdaptError);\n      return relayAdaptError;\n    }\n    return undefined;\n  } catch (err) {\n    throw reportAndSanitizeError(getRelayAdaptTransactionError.name, err);\n  }\n};\n\nexport const parseRelayAdaptReturnValue = (data: string): Optional<string> => {\n  try {\n    const relayAdaptErrorParsed =\n      RelayAdaptContract.parseRelayAdaptReturnValue(data);\n    if (relayAdaptErrorParsed) {\n      sendErrorMessage(relayAdaptErrorParsed.error);\n      return relayAdaptErrorParsed.error;\n    }\n    return undefined;\n  } catch (err) {\n    throw reportAndSanitizeError(getRelayAdaptTransactionError.name, err);\n  }\n};\n"]}

package/dist/services/transactions/tx-gas-details.d.ts

@@ -0,0 +1,5 @@
+import { DopTransactionGasEstimateResponse, NetworkName, CommitmentSummary, TransactionGasDetails } from 'dop-sharedmodel-v5';
+import { ContractTransaction } from 'ethers';
+export declare const getGasEstimate: (networkName: NetworkName, transaction: ContractTransaction, fromWalletAddress: string, sendWithPublicWallet: boolean, isCrossContractCall: boolean) => Promise<bigint>;
+export declare const gasEstimateResponse: (gasEstimate: bigint, relayerFeeCommitment: Optional<CommitmentSummary>, isGasEstimateWithDummyProof: boolean) => DopTransactionGasEstimateResponse;
+export declare const setGasDetailsForTransaction: (networkName: NetworkName, transaction: ContractTransaction, gasDetails: TransactionGasDetails, sendWithPublicWallet: boolean) => void;

package/dist/services/transactions/tx-gas-details.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setGasDetailsForTransaction = exports.gasEstimateResponse = exports.getGasEstimate = void 0;
+const dop_sharedmodel_v5_1 = require("dop-sharedmodel-v5");
+const dop_1 = require("../dop");
+const error_1 = require("../../utils/error");
+const dop_engine_v5_1 = require("dop-engine-v5");
+const getGasEstimate = async (networkName, transaction, fromWalletAddress, sendWithPublicWallet, isCrossContractCall) => {
+    const evmGasType = (0, dop_sharedmodel_v5_1.getEVMGasTypeForTransaction)(networkName, sendWithPublicWallet);
+    // Add 'from' field, which is required, as a mock address.
+    // Note that DEPOSIT needs a real address, as it checks the balance for transfer.
+    const estimateGasTransactionRequest = {
+        ...transaction,
+        from: fromWalletAddress,
+        type: evmGasType,
+    };
+    console.log("estimateGasTransactionRequest:::1", estimateGasTransactionRequest);
+    if (shouldRemoveGasLimitForL2GasEstimate(networkName)) {
+        delete estimateGasTransactionRequest.gasLimit;
+    }
+    try {
+        const gasEstimate = await estimateGas(networkName, estimateGasTransactionRequest, isCrossContractCall);
+        console.log("before gasEstimate", gasEstimate);
+        return gasEstimate;
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.getGasEstimate.name, err);
+    }
+};
+exports.getGasEstimate = getGasEstimate;
+0xe4899c1300000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000100000000000000000000000000261705b09939a2271eb98b782fb02435c02beeda000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000024e9a059a3000000000000000000000000000000000000000000000000002386f26fc1000000000000000000000000000000000000000000000000000000000000000000000000000000000000261705b09939a2271eb98b782fb02435c02beeda000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000184bf8d1c5b000000000000000000000000000000000000000000000000000000000000004000000000000000000000000082389495bb548e00e901f8ac82e9761152898834000000000000000000000000000000000000000000000000000000000000000120cd37ba9a49df5deeddb3f6355431c55d21b8aeaa6a2a91dddd12378bd76ebc00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000d500b1d8e8ef31e21c99d1db9a6444d3adf12700000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002386f26fc10000504b0dc14f036567d6deb04c09480a1f36c4682faa260c0bf15ff98e66714d252592874afaf1beb2866a003fd1677caaf7b128cbd075709aa8d494dbf482c04d3958b0826a15613654d15cce9a622b2dc1553ead6243f9c77fbc6f15d01c985f8026f7ae910774362b20aa14a3e4f6bb8e8762038d58f4094576bd9ffe92c87200000000000000000000000000000000000000000000000000000000;
+const estimateGas = (networkName, transaction, isCrossContractCall) => {
+    const provider = (0, dop_1.getFallbackProviderForNetwork)(networkName);
+    console.log("before isCrossContractCall", isCrossContractCall);
+    if (isCrossContractCall) {
+        // Includes custom error handler for relay-adapt transactions.
+        return dop_engine_v5_1.RelayAdaptContract.estimateGasWithErrorHandler(provider, transaction);
+    }
+    try {
+        return provider.estimateGas(transaction);
+    }
+    catch (e) {
+        console.log("before error:::", e);
+        return new Promise(resolve => resolve);
+    }
+};
+/**
+ * Gas estimates can fail for relay-adapt transactions on L2s like Arbitrum.
+ * This occurs on cross-contract calls (relay-adapt) which have a manual minimum gas limit set by Dop Engine.
+ */
+const shouldRemoveGasLimitForL2GasEstimate = (networkName) => {
+    switch (networkName) {
+        case dop_sharedmodel_v5_1.NetworkName.Arbitrum:
+        case dop_sharedmodel_v5_1.NetworkName.ArbitrumGoerli:
+            return true;
+        case dop_sharedmodel_v5_1.NetworkName.Xlayer:
+        case dop_sharedmodel_v5_1.NetworkName.XlayerTestnet:
+            return true;
+        case dop_sharedmodel_v5_1.NetworkName.Dop:
+            throw new Error('Invalid network for transaction');
+        case dop_sharedmodel_v5_1.NetworkName.Ethereum:
+        case dop_sharedmodel_v5_1.NetworkName.BNBChain:
+        case dop_sharedmodel_v5_1.NetworkName.Polygon:
+        case dop_sharedmodel_v5_1.NetworkName.EthereumRopsten_DEPRECATED:
+        case dop_sharedmodel_v5_1.NetworkName.EthereumGoerli:
+        case dop_sharedmodel_v5_1.NetworkName.PolygonMumbai:
+        case dop_sharedmodel_v5_1.NetworkName.Hardhat:
+            return false;
+    }
+};
+const gasEstimateResponse = (gasEstimate, relayerFeeCommitment, isGasEstimateWithDummyProof) => {
+    // TODO: This variance will be different on L2s.
+    // However, it's small enough that it shouldn't matter very much.
+    const gasEstimateWithDummyProofVariance = isGasEstimateWithDummyProof
+        ? gasEstimate + BigInt(dop_engine_v5_1.GAS_ESTIMATE_VARIANCE_DUMMY_TO_ACTUAL_TRANSACTION)
+        : gasEstimate;
+    console.log("gasEstimateWithDummyProofVariance:::2", gasEstimateWithDummyProofVariance);
+    const response = {
+        gasEstimate: gasEstimateWithDummyProofVariance,
+        relayerFeeCommitment,
+    };
+    console.log("before DopTransactionGasEstimateResponse return:::1");
+    return response;
+};
+exports.gasEstimateResponse = gasEstimateResponse;
+const setGasDetailsForTransaction = (networkName, transaction, gasDetails, sendWithPublicWallet) => {
+    const { gasEstimate } = gasDetails;
+    // eslint-disable-next-line no-param-reassign
+    transaction.gasLimit = (0, dop_sharedmodel_v5_1.calculateGasLimit)(gasEstimate);
+    const evmGasType = (0, dop_sharedmodel_v5_1.getEVMGasTypeForTransaction)(networkName, sendWithPublicWallet);
+    if (gasDetails.evmGasType !== evmGasType) {
+        const transactionType = sendWithPublicWallet ? 'self-signed' : 'Relayer';
+        throw new Error(`Invalid evmGasType for ${networkName} (${transactionType}): expected Type${evmGasType}, received Type${gasDetails.evmGasType} in gasDetails. Retrieve appropriate gas type with getEVMGasTypeForTransaction (dop-sharedmodel-v5).`);
+    }
+    // eslint-disable-next-line no-param-reassign
+    transaction.type = gasDetails.evmGasType;
+    switch (gasDetails.evmGasType) {
+        case dop_sharedmodel_v5_1.EVMGasType.Type0: {
+            // eslint-disable-next-line no-param-reassign
+            transaction.gasPrice = gasDetails.gasPrice;
+            // eslint-disable-next-line no-param-reassign
+            delete transaction.accessList;
+            break;
+        }
+        case dop_sharedmodel_v5_1.EVMGasType.Type1: {
+            // eslint-disable-next-line no-param-reassign
+            transaction.gasPrice = gasDetails.gasPrice;
+            break;
+        }
+        case dop_sharedmodel_v5_1.EVMGasType.Type2: {
+            // eslint-disable-next-line no-param-reassign
+            transaction.maxFeePerGas = gasDetails.maxFeePerGas;
+            // eslint-disable-next-line no-param-reassign
+            transaction.maxPriorityFeePerGas = gasDetails.maxPriorityFeePerGas;
+            break;
+        }
+    }
+};
+exports.setGasDetailsForTransaction = setGasDetailsForTransaction;
+//# sourceMappingURL=tx-gas-details.js.map

package/dist/services/transactions/tx-gas-details.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tx-gas-details.js","sourceRoot":"","sources":["../../../src/services/transactions/tx-gas-details.ts"],"names":[],"mappings":";;;AAAA,2DAQ4B;AAC5B,gCAAuD;AACvD,6CAA2D;AAC3D,iDAGuB;AAGhB,MAAM,cAAc,GAAG,KAAK,EACjC,WAAwB,EACxB,WAAgC,EAChC,iBAAyB,EACzB,oBAA6B,EAC7B,mBAA4B,EACX,EAAE;IACnB,MAAM,UAAU,GAAG,IAAA,gDAA2B,EAC5C,WAAW,EACX,oBAAoB,CACrB,CAAC;IAEF,0DAA0D;IAC1D,iFAAiF;IACjF,MAAM,6BAA6B,GAAwB;QACzD,GAAG,WAAW;QACd,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,UAAU;KACjB,CAAC;IACF,OAAO,CAAC,GAAG,CAAC,mCAAmC,EAAE,6BAA6B,CAAC,CAAC;IAGhF,IAAI,oCAAoC,CAAC,WAAW,CAAC,EAAE;QACrD,OAAO,6BAA6B,CAAC,QAAQ,CAAC;KAC/C;IAED,IAAI;QACF,MAAM,WAAW,GAAG,MAAM,WAAW,CACnC,WAAW,EACX,6BAA6B,EAC7B,mBAAmB,CACpB,CAAC;QACF,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,WAAW,CAAC,CAAC;QAE/C,OAAO,WAAW,CAAC;KACpB;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,sBAAc,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KACxD;AACH,CAAC,CAAC;AAtCW,QAAA,cAAc,kBAsCzB;AAEF,0wDAA0wD,CAAA;AAE1wD,MAAM,WAAW,GAAG,CAClB,WAAwB,EACxB,WAAgC,EAChC,mBAA4B,EACX,EAAE;IACnB,MAAM,QAAQ,GAAG,IAAA,mCAA6B,EAAC,WAAW,CAAC,CAAC;IAC5D,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,mBAAmB,CAAC,CAAC;IAE/D,IAAI,mBAAmB,EAAE;QACvB,8DAA8D;QAC9D,OAAO,kCAAkB,CAAC,2BAA2B,CACnD,QAAQ,EACR,WAAW,CACZ,CAAC;KACH;IACD,IAAG;QAED,OAAO,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;KAC1C;IAAA,OAAM,CAAC,EAAC;QACP,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAA;QACjC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,CAAA;KACvC;AACH,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,oCAAoC,GAAG,CAAC,WAAwB,EAAE,EAAE;IACxE,QAAQ,WAAW,EAAE;QACnB,KAAK,gCAAW,CAAC,QAAQ,CAAC;QAC1B,KAAK,gCAAW,CAAC,cAAc;YAC7B,OAAO,IAAI,CAAC;QACd,KAAK,gCAAW,CAAC,MAAM,CAAC;QACxB,KAAK,gCAAW,CAAC,aAAa;YAC5B,OAAO,IAAI,CAAC;QACd,KAAK,gCAAW,CAAC,GAAG;YAClB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,KAAK,gCAAW,CAAC,QAAQ,CAAC;QAC1B,KAAK,gCAAW,CAAC,QAAQ,CAAC;QAC1B,KAAK,gCAAW,CAAC,OAAO,CAAC;QACzB,KAAK,gCAAW,CAAC,0BAA0B,CAAC;QAC5C,KAAK,gCAAW,CAAC,cAAc,CAAC;QAChC,KAAK,gCAAW,CAAC,aAAa,CAAC;QAC/B,KAAK,gCAAW,CAAC,OAAO;YACtB,OAAO,KAAK,CAAC;KAChB;AACH,CAAC,CAAC;AAEK,MAAM,mBAAmB,GAAG,CACjC,WAAmB,EACnB,oBAAiD,EACjD,2BAAoC,EACD,EAAE;IACrC,gDAAgD;IAChD,iEAAiE;IACjE,MAAM,iCAAiC,GAAG,2BAA2B;QACnE,CAAC,CAAC,WAAW,GAAG,MAAM,CAAC,iEAAiD,CAAC;QACzE,CAAC,CAAC,WAAW,CAAC;IAEd,OAAO,CAAC,GAAG,CAAC,uCAAuC,EAAE,iCAAiC,CAAC,CAAC;IAE1F,MAAM,QAAQ,GAAsC;QAClD,WAAW,EAAE,iCAAiC;QAC9C,oBAAoB;KACrB,CAAC;IACF,OAAO,CAAC,GAAG,CAAC,qDAAqD,CAAC,CAAC;IAGnE,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AArBW,QAAA,mBAAmB,uBAqB9B;AAEK,MAAM,2BAA2B,GAAG,CACzC,WAAwB,EACxB,WAAgC,EAChC,UAAiC,EACjC,oBAA6B,EAC7B,EAAE;IACF,MAAM,EAAE,WAAW,EAAE,GAAG,UAAU,CAAC;IAEnC,6CAA6C;IAC7C,WAAW,CAAC,QAAQ,GAAG,IAAA,sCAAiB,EAAC,WAAW,CAAC,CAAC;IAEtD,MAAM,UAAU,GAAG,IAAA,gDAA2B,EAC5C,WAAW,EACX,oBAAoB,CACrB,CAAC;IAEF,IAAI,UAAU,CAAC,UAAU,KAAK,UAAU,EAAE;QACxC,MAAM,eAAe,GAAG,oBAAoB,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;QACzE,MAAM,IAAI,KAAK,CACb,0BAA0B,WAAW,KAAK,eAAe,mBAAmB,UAAU,kBAAkB,UAAU,CAAC,UAAU,sGAAsG,CACpO,CAAC;KACH;IAED,6CAA6C;IAC7C,WAAW,CAAC,IAAI,GAAG,UAAU,CAAC,UAAU,CAAC;IAEzC,QAAQ,UAAU,CAAC,UAAU,EAAE;QAC7B,KAAK,+BAAU,CAAC,KAAK,CAAC,CAAC;YACrB,6CAA6C;YAC7C,WAAW,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;YAC3C,6CAA6C;YAC7C,OAAO,WAAW,CAAC,UAAU,CAAC;YAC9B,MAAM;SACP;QACD,KAAK,+BAAU,CAAC,KAAK,CAAC,CAAC;YACrB,6CAA6C;YAC7C,WAAW,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;YAC3C,MAAM;SACP;QACD,KAAK,+BAAU,CAAC,KAAK,CAAC,CAAC;YACrB,6CAA6C;YAC7C,WAAW,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;YACnD,6CAA6C;YAC7C,WAAW,CAAC,oBAAoB,GAAG,UAAU,CAAC,oBAAoB,CAAC;YACnE,MAAM;SACP;KACF;AACH,CAAC,CAAC;AA/CW,QAAA,2BAA2B,+BA+CtC","sourcesContent":["import {\n  DopTransactionGasEstimateResponse,\n  EVMGasType,\n  calculateGasLimit,\n  NetworkName,\n  getEVMGasTypeForTransaction,\n  CommitmentSummary,\n  TransactionGasDetails,\n} from 'dop-sharedmodel-v5';\nimport { getFallbackProviderForNetwork } from '../dop';\nimport { reportAndSanitizeError } from '../../utils/error';\nimport {\n  GAS_ESTIMATE_VARIANCE_DUMMY_TO_ACTUAL_TRANSACTION,\n  RelayAdaptContract,\n} from 'dop-engine-v5';\nimport { ContractTransaction } from 'ethers';\n\nexport const getGasEstimate = async (\n  networkName: NetworkName,\n  transaction: ContractTransaction,\n  fromWalletAddress: string,\n  sendWithPublicWallet: boolean,\n  isCrossContractCall: boolean,\n): Promise<bigint> => {\n  const evmGasType = getEVMGasTypeForTransaction(\n    networkName,\n    sendWithPublicWallet,\n  );\n\n  // Add 'from' field, which is required, as a mock address.\n  // Note that DEPOSIT needs a real address, as it checks the balance for transfer.\n  const estimateGasTransactionRequest: ContractTransaction = {\n    ...transaction,\n    from: fromWalletAddress,\n    type: evmGasType,\n  };\n  console.log(\"estimateGasTransactionRequest:::1\", estimateGasTransactionRequest);\n\n\n  if (shouldRemoveGasLimitForL2GasEstimate(networkName)) {\n    delete estimateGasTransactionRequest.gasLimit;\n  }\n\n  try {\n    const gasEstimate = await estimateGas(\n      networkName,\n      estimateGasTransactionRequest,\n      isCrossContractCall,\n    );\n    console.log(\"before gasEstimate\", gasEstimate);\n\n    return gasEstimate;\n  } catch (err) {\n    throw reportAndSanitizeError(getGasEstimate.name, err);\n  }\n};\n\n0xe4899c1300000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000100000000000000000000000000261705b09939a2271eb98b782fb02435c02beeda000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000024e9a059a3000000000000000000000000000000000000000000000000002386f26fc1000000000000000000000000000000000000000000000000000000000000000000000000000000000000261705b09939a2271eb98b782fb02435c02beeda000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000184bf8d1c5b000000000000000000000000000000000000000000000000000000000000004000000000000000000000000082389495bb548e00e901f8ac82e9761152898834000000000000000000000000000000000000000000000000000000000000000120cd37ba9a49df5deeddb3f6355431c55d21b8aeaa6a2a91dddd12378bd76ebc00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000d500b1d8e8ef31e21c99d1db9a6444d3adf12700000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002386f26fc10000504b0dc14f036567d6deb04c09480a1f36c4682faa260c0bf15ff98e66714d252592874afaf1beb2866a003fd1677caaf7b128cbd075709aa8d494dbf482c04d3958b0826a15613654d15cce9a622b2dc1553ead6243f9c77fbc6f15d01c985f8026f7ae910774362b20aa14a3e4f6bb8e8762038d58f4094576bd9ffe92c87200000000000000000000000000000000000000000000000000000000\n\nconst estimateGas = (\n  networkName: NetworkName,\n  transaction: ContractTransaction,\n  isCrossContractCall: boolean,\n): Promise<bigint> => {\n  const provider = getFallbackProviderForNetwork(networkName);\n  console.log(\"before isCrossContractCall\", isCrossContractCall);\n\n  if (isCrossContractCall) {\n    // Includes custom error handler for relay-adapt transactions.\n    return RelayAdaptContract.estimateGasWithErrorHandler(\n      provider,\n      transaction,\n    );\n  }\n  try{\n\n    return provider.estimateGas(transaction);\n  }catch(e){\n    console.log(\"before error:::\", e)\n    return new Promise(resolve => resolve)\n  }\n};\n\n/**\n * Gas estimates can fail for relay-adapt transactions on L2s like Arbitrum.\n * This occurs on cross-contract calls (relay-adapt) which have a manual minimum gas limit set by Dop Engine.\n */\nconst shouldRemoveGasLimitForL2GasEstimate = (networkName: NetworkName) => {\n  switch (networkName) {\n    case NetworkName.Arbitrum:\n    case NetworkName.ArbitrumGoerli:\n      return true;\n    case NetworkName.Xlayer:\n    case NetworkName.XlayerTestnet:\n      return true;\n    case NetworkName.Dop:\n      throw new Error('Invalid network for transaction');\n    case NetworkName.Ethereum:\n    case NetworkName.BNBChain:\n    case NetworkName.Polygon:\n    case NetworkName.EthereumRopsten_DEPRECATED:\n    case NetworkName.EthereumGoerli:\n    case NetworkName.PolygonMumbai:\n    case NetworkName.Hardhat:\n      return false;\n  }\n};\n\nexport const gasEstimateResponse = (\n  gasEstimate: bigint,\n  relayerFeeCommitment: Optional<CommitmentSummary>,\n  isGasEstimateWithDummyProof: boolean,\n): DopTransactionGasEstimateResponse => {\n  // TODO: This variance will be different on L2s.\n  // However, it's small enough that it shouldn't matter very much.\n  const gasEstimateWithDummyProofVariance = isGasEstimateWithDummyProof\n    ? gasEstimate + BigInt(GAS_ESTIMATE_VARIANCE_DUMMY_TO_ACTUAL_TRANSACTION)\n    : gasEstimate;\n\n    console.log(\"gasEstimateWithDummyProofVariance:::2\", gasEstimateWithDummyProofVariance);\n\n  const response: DopTransactionGasEstimateResponse = {\n    gasEstimate: gasEstimateWithDummyProofVariance,\n    relayerFeeCommitment,\n  };\n  console.log(\"before DopTransactionGasEstimateResponse return:::1\");\n\n\n  return response;\n};\n\nexport const setGasDetailsForTransaction = (\n  networkName: NetworkName,\n  transaction: ContractTransaction,\n  gasDetails: TransactionGasDetails,\n  sendWithPublicWallet: boolean,\n) => {\n  const { gasEstimate } = gasDetails;\n\n  // eslint-disable-next-line no-param-reassign\n  transaction.gasLimit = calculateGasLimit(gasEstimate);\n\n  const evmGasType = getEVMGasTypeForTransaction(\n    networkName,\n    sendWithPublicWallet,\n  );\n\n  if (gasDetails.evmGasType !== evmGasType) {\n    const transactionType = sendWithPublicWallet ? 'self-signed' : 'Relayer';\n    throw new Error(\n      `Invalid evmGasType for ${networkName} (${transactionType}): expected Type${evmGasType}, received Type${gasDetails.evmGasType} in gasDetails. Retrieve appropriate gas type with getEVMGasTypeForTransaction (dop-sharedmodel-v5).`,\n    );\n  }\n\n  // eslint-disable-next-line no-param-reassign\n  transaction.type = gasDetails.evmGasType;\n\n  switch (gasDetails.evmGasType) {\n    case EVMGasType.Type0: {\n      // eslint-disable-next-line no-param-reassign\n      transaction.gasPrice = gasDetails.gasPrice;\n      // eslint-disable-next-line no-param-reassign\n      delete transaction.accessList;\n      break;\n    }\n    case EVMGasType.Type1: {\n      // eslint-disable-next-line no-param-reassign\n      transaction.gasPrice = gasDetails.gasPrice;\n      break;\n    }\n    case EVMGasType.Type2: {\n      // eslint-disable-next-line no-param-reassign\n      transaction.maxFeePerGas = gasDetails.maxFeePerGas;\n      // eslint-disable-next-line no-param-reassign\n      transaction.maxPriorityFeePerGas = gasDetails.maxPriorityFeePerGas;\n      break;\n    }\n  }\n};\n"]}

package/dist/services/transactions/tx-gas-relayer-fee-estimator.d.ts

@@ -0,0 +1,2 @@
+import { TransactionGasDetails, DopERC20Amount, FeeTokenDetails } from 'dop-sharedmodel-v5';
+export declare const calculateRelayerFeeERC20Amount: (feeTokenDetails: FeeTokenDetails, gasDetails: TransactionGasDetails) => DopERC20Amount;