dop-wallet-v6 1.1.5 → 1.1.7

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

@@ -1,12 +1,12 @@
 "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_sharedmodel_1 = require("dop-sharedmodel");
 const dop_1 = require("../dop");
 const error_1 = require("../../utils/error");
-const dop_engine_v5_1 = require("dop-engine-v5");
+const dop_engine_1 = require("dop-engine");
 const getGasEstimate = async (networkName, transaction, fromWalletAddress, sendWithPublicWallet, isCrossContractCall) => {
-    const evmGasType = (0, dop_sharedmodel_v5_1.getEVMGasTypeForTransaction)(networkName, sendWithPublicWallet);
+    const evmGasType = (0, dop_sharedmodel_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 = {
@@ -14,13 +14,11 @@ const getGasEstimate = async (networkName, transaction, fromWalletAddress, sendW
         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) {
@@ -28,21 +26,13 @@ const getGasEstimate = async (networkName, transaction, fromWalletAddress, sendW
     }
 };
 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);
+        return dop_engine_1.RelayAdaptContract.estimateGasWithErrorHandler(provider, transaction);
     }
+    return provider.estimateGas(transaction);
 };
 /**
  * Gas estimates can fail for relay-adapt transactions on L2s like Arbitrum.
@@ -50,21 +40,21 @@ const estimateGas = (networkName, transaction, isCrossContractCall) => {
  */
 const shouldRemoveGasLimitForL2GasEstimate = (networkName) => {
     switch (networkName) {
-        case dop_sharedmodel_v5_1.NetworkName.Arbitrum:
-        case dop_sharedmodel_v5_1.NetworkName.ArbitrumGoerli:
+        case dop_sharedmodel_1.NetworkName.Arbitrum:
+        case dop_sharedmodel_1.NetworkName.ArbitrumGoerli:
             return true;
-        case dop_sharedmodel_v5_1.NetworkName.Xlayer:
-        case dop_sharedmodel_v5_1.NetworkName.XlayerTestnet:
+        case dop_sharedmodel_1.NetworkName.Xlayer:
+        case dop_sharedmodel_1.NetworkName.XlayerTestnet:
             return true;
-        case dop_sharedmodel_v5_1.NetworkName.Dop:
+        case dop_sharedmodel_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:
+        case dop_sharedmodel_1.NetworkName.Ethereum:
+        case dop_sharedmodel_1.NetworkName.BNBChain:
+        case dop_sharedmodel_1.NetworkName.Polygon:
+        case dop_sharedmodel_1.NetworkName.EthereumRopsten_DEPRECATED:
+        case dop_sharedmodel_1.NetworkName.EthereumGoerli:
+        case dop_sharedmodel_1.NetworkName.PolygonMumbai:
+        case dop_sharedmodel_1.NetworkName.Hardhat:
             return false;
     }
 };
@@ -72,42 +62,40 @@ const gasEstimateResponse = (gasEstimate, relayerFeeCommitment, isGasEstimateWit
     // 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 + BigInt(dop_engine_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);
+    transaction.gasLimit = (0, dop_sharedmodel_1.calculateGasLimit)(gasEstimate);
+    const evmGasType = (0, dop_sharedmodel_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).`);
+        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).`);
     }
     // eslint-disable-next-line no-param-reassign
     transaction.type = gasDetails.evmGasType;
     switch (gasDetails.evmGasType) {
-        case dop_sharedmodel_v5_1.EVMGasType.Type0: {
+        case dop_sharedmodel_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: {
+        case dop_sharedmodel_1.EVMGasType.Type1: {
             // eslint-disable-next-line no-param-reassign
             transaction.gasPrice = gasDetails.gasPrice;
             break;
         }
-        case dop_sharedmodel_v5_1.EVMGasType.Type2: {
+        case dop_sharedmodel_1.EVMGasType.Type2: {
             // eslint-disable-next-line no-param-reassign
             transaction.maxFeePerGas = gasDetails.maxFeePerGas;
             // eslint-disable-next-line no-param-reassign

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

@@ -1 +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"]}
+{"version":3,"file":"tx-gas-details.js","sourceRoot":"","sources":["../../../src/services/transactions/tx-gas-details.ts"],"names":[],"mappings":";;;AAAA,qDAQyB;AACzB,gCAAuD;AACvD,6CAA2D;AAC3D,2CAGoB;AAGb,MAAM,cAAc,GAAG,KAAK,EACjC,WAAwB,EACxB,WAAgC,EAChC,iBAAyB,EACzB,oBAA6B,EAC7B,mBAA4B,EACX,EAAE;IACnB,MAAM,UAAU,GAAG,IAAA,6CAA2B,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;IAEF,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;QAEF,OAAO,WAAW,CAAC;KACpB;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,sBAAc,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KACxD;AACH,CAAC,CAAC;AAnCW,QAAA,cAAc,kBAmCzB;AAEF,MAAM,WAAW,GAAG,CAClB,WAAwB,EACxB,WAAgC,EAChC,mBAA4B,EACX,EAAE;IACnB,MAAM,QAAQ,GAAG,IAAA,mCAA6B,EAAC,WAAW,CAAC,CAAC;IAE5D,IAAI,mBAAmB,EAAE;QACvB,8DAA8D;QAC9D,OAAO,+BAAkB,CAAC,2BAA2B,CACnD,QAAQ,EACR,WAAW,CACZ,CAAC;KACH;IACD,OAAO,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,oCAAoC,GAAG,CAAC,WAAwB,EAAE,EAAE;IACxE,QAAQ,WAAW,EAAE;QACnB,KAAK,6BAAW,CAAC,QAAQ,CAAC;QAC1B,KAAK,6BAAW,CAAC,cAAc;YAC7B,OAAO,IAAI,CAAC;QACd,KAAK,6BAAW,CAAC,MAAM,CAAC;QACxB,KAAK,6BAAW,CAAC,aAAa;YAC5B,OAAO,IAAI,CAAC;QACd,KAAK,6BAAW,CAAC,GAAG;YAClB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,KAAK,6BAAW,CAAC,QAAQ,CAAC;QAC1B,KAAK,6BAAW,CAAC,QAAQ,CAAC;QAC1B,KAAK,6BAAW,CAAC,OAAO,CAAC;QACzB,KAAK,6BAAW,CAAC,0BAA0B,CAAC;QAC5C,KAAK,6BAAW,CAAC,cAAc,CAAC;QAChC,KAAK,6BAAW,CAAC,aAAa,CAAC;QAC/B,KAAK,6BAAW,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,8DAAiD,CAAC;QACzE,CAAC,CAAC,WAAW,CAAC;IAIhB,MAAM,QAAQ,GAAsC;QAClD,WAAW,EAAE,iCAAiC;QAC9C,oBAAoB;KACrB,CAAC;IAEF,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAnBW,QAAA,mBAAmB,uBAmB9B;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,mCAAiB,EAAC,WAAW,CAAC,CAAC;IAEtD,MAAM,UAAU,GAAG,IAAA,6CAA2B,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,mGAAmG,CACjO,CAAC;KACH;IAED,6CAA6C;IAC7C,WAAW,CAAC,IAAI,GAAG,UAAU,CAAC,UAAU,CAAC;IAEzC,QAAQ,UAAU,CAAC,UAAU,EAAE;QAC7B,KAAK,4BAAU,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,4BAAU,CAAC,KAAK,CAAC,CAAC;YACrB,6CAA6C;YAC7C,WAAW,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;YAC3C,MAAM;SACP;QACD,KAAK,4BAAU,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';\nimport { getFallbackProviderForNetwork } from '../dop';\nimport { reportAndSanitizeError } from '../../utils/error';\nimport {\n  GAS_ESTIMATE_VARIANCE_DUMMY_TO_ACTUAL_TRANSACTION,\n  RelayAdaptContract,\n} from 'dop-engine';\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\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\n    return gasEstimate;\n  } catch (err) {\n    throw reportAndSanitizeError(getGasEstimate.name, err);\n  }\n};\n\nconst estimateGas = (\n  networkName: NetworkName,\n  transaction: ContractTransaction,\n  isCrossContractCall: boolean,\n): Promise<bigint> => {\n  const provider = getFallbackProviderForNetwork(networkName);\n\n  if (isCrossContractCall) {\n    // Includes custom error handler for relay-adapt transactions.\n    return RelayAdaptContract.estimateGasWithErrorHandler(\n      provider,\n      transaction,\n    );\n  }\n  return provider.estimateGas(transaction);\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\n\n  const response: DopTransactionGasEstimateResponse = {\n    gasEstimate: gasEstimateWithDummyProofVariance,\n    relayerFeeCommitment,\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).`,\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

@@ -1,2 +1,5 @@
-import { TransactionGasDetails, DopERC20Amount, FeeTokenDetails } from 'dop-sharedmodel-v5';
+import { TransactionStruct } from 'dop-engine';
+import { NetworkName, TransactionGasDetails, DopERC20Amount, DopTransactionGasEstimateResponse, FeeTokenDetails, DopERC20AmountRecipient } from 'dop-sharedmodel';
+import { ContractTransaction } from 'ethers';
 export declare const calculateRelayerFeeERC20Amount: (feeTokenDetails: FeeTokenDetails, gasDetails: TransactionGasDetails) => DopERC20Amount;
+export declare const gasEstimateResponseDummyProofIterativeRelayerFee: (generateDummyTransactionStructsWithRelayerFee: (relayerFeeERC20Amount: Optional<DopERC20Amount>) => Promise<TransactionStruct[]>, generateTransaction: (serializedTransactions: TransactionStruct[]) => Promise<ContractTransaction>, networkName: NetworkName, dopWalletID: string, erc20AmountRecipients: DopERC20AmountRecipient[], originalGasDetails: TransactionGasDetails, feeTokenDetails: Optional<FeeTokenDetails>, sendWithPublicWallet: boolean, isCrossContractCall: boolean) => Promise<DopTransactionGasEstimateResponse>;

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

@@ -1,12 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.calculateRelayerFeeERC20Amount = void 0;
-const dop_sharedmodel_v5_1 = require("dop-sharedmodel-v5");
+exports.gasEstimateResponseDummyProofIterativeRelayerFee = exports.calculateRelayerFeeERC20Amount = void 0;
+const dop_sharedmodel_1 = require("dop-sharedmodel");
+const tx_generator_1 = require("./tx-generator");
+const tx_gas_details_1 = require("./tx-gas-details");
+const balance_update_1 = require("../dop/wallets/balance-update");
+const dop_1 = require("../dop");
+const commitment_1 = require("../dop/util/commitment");
 const MAX_ITERATIONS_RELAYER_FEE_REESTIMATION = 5;
 const calculateRelayerFeeERC20Amount = (feeTokenDetails, gasDetails) => {
     const tokenFeePerUnitGas = BigInt(feeTokenDetails.feePerUnitGas);
     const oneUnitGas = 10n ** 18n;
-    const maximumGas = (0, dop_sharedmodel_v5_1.calculateMaximumGas)(gasDetails);
+    const maximumGas = (0, dop_sharedmodel_1.calculateMaximumGas)(gasDetails);
     const tokenFee = (tokenFeePerUnitGas * maximumGas) / oneUnitGas;
     return {
         tokenAddress: feeTokenDetails.tokenAddress,
@@ -14,196 +19,92 @@ const calculateRelayerFeeERC20Amount = (feeTokenDetails, gasDetails) => {
     };
 };
 exports.calculateRelayerFeeERC20Amount = calculateRelayerFeeERC20Amount;
-/*
-const getRelayerFeeCommitment = (
-  transactionStructs: TransactionStruct[],
-): CommitmentSummary => {
-  const transactionIndex = 0;
-  const relayerFeeCommitment = transactionStructs[transactionIndex];
-  const relayerFeeCommitmentIndex = 0;
-  return convertTransactionStructToCommitmentSummary(
-    relayerFeeCommitment,
-    relayerFeeCommitmentIndex,
-  );
+const getRelayerFeeCommitment = (transactionStructs) => {
+    const transactionIndex = 0;
+    const relayerFeeCommitment = transactionStructs[transactionIndex];
+    const relayerFeeCommitmentIndex = 0;
+    return (0, commitment_1.convertTransactionStructToCommitmentSummary)(relayerFeeCommitment, relayerFeeCommitmentIndex);
 };
-
-export const gasEstimateResponseDummyProofIterativeRelayerFee = async (
-  generateDummyTransactionStructsWithRelayerFee: (
-    relayerFeeERC20Amount: Optional<DopERC20Amount>,
-  ) => Promise<TransactionStruct[]>,
-  generateTransaction: (
-    serializedTransactions: TransactionStruct[],
-  ) => Promise<ContractTransaction>,
-  networkName: NetworkName,
-  dopWalletID: string,
-  erc20AmountRecipients: DopERC20AmountRecipient[],
-  originalGasDetails: TransactionGasDetails,
-  feeTokenDetails: Optional<FeeTokenDetails>,
-  sendWithPublicWallet: boolean,
-  isCrossContractCall: boolean,
-): Promise<DopTransactionGasEstimateResponse> => {
-  const wallet = walletForID(dopWalletID);
-
-  // Use dead address for private transaction gas estimate
-  const fromWalletAddress = DUMMY_FROM_ADDRESS;
-
-  const isGasEstimateWithDummyProof = true;
-
-  const dummyRelayerFee = feeTokenDetails
-    ? createDummyRelayerFeeERC20Amount(feeTokenDetails.tokenAddress)
-    : undefined;
-
-  let serializedTransactions =
-    await generateDummyTransactionStructsWithRelayerFee(dummyRelayerFee);
-  let transaction = await generateTransaction(serializedTransactions);
-
-  let gasEstimate = await getGasEstimate(
-    networkName,
-    transaction,
-    fromWalletAddress,
-    sendWithPublicWallet,
-    isCrossContractCall,
-  );
-  console.log("gasEstimateForUnprovenTransfer gasEstimate::", gasEstimate)
-
-
-  if (sendWithPublicWallet) {
-    return gasEstimateResponse(
-      gasEstimate,
-      undefined, // relayerFeeCommitment
-      isGasEstimateWithDummyProof,
-    );
-  }
-
-  if (!feeTokenDetails) {
-    throw new Error(
-      'Must have Relayer Fee details or sendWithPublicWallet field.',
-    );
-  }
-
-  // Find any erc20Amount in transfer that matches token of relayer fee, if exists.
-  const relayerFeeMatchingSendingERC20Amount = erc20AmountRecipients.find(
-    erc20AmountRecipient =>
-      erc20AmountRecipient.tokenAddress.toLowerCase() ===
-      feeTokenDetails.tokenAddress.toLowerCase(),
-  );
-
-  // Get private balance of matching token.
-  const balanceForRelayerFeeERC20 = await balanceForERC20Token(
-    wallet,
-    networkName,
-    feeTokenDetails.tokenAddress,
-  );
-
-  let relayerFeeCommitment = getRelayerFeeCommitment(serializedTransactions);
-
-  // Iteratively calculate new relayer fee and estimate new gas amount.
-  // This change if the number of circuits changes because of the additional Relayer Fees.
-  for (let i = 0; i < MAX_ITERATIONS_RELAYER_FEE_REESTIMATION; i += 1) {
-    const updatedGasDetails: TransactionGasDetails = {
-      ...originalGasDetails,
-      gasEstimate,
-    };
-    const updatedRelayerFee: DopERC20Amount =
-      calculateRelayerFeeERC20Amount(feeTokenDetails, updatedGasDetails);
-
-    // If Relayer fee causes overflow with the token balance,
-    // then use the MAX amount for Relayer Fee, which is BALANCE - SENDING AMOUNT.
-    if (
-      balanceForRelayerFeeERC20 > 0n &&
-      relayerFeeMatchingSendingERC20Amount &&
-      // eslint-disable-next-line no-await-in-loop
-      (await relayerFeeWillOverflowBalance(
-        balanceForRelayerFeeERC20,
-        relayerFeeMatchingSendingERC20Amount,
-        updatedRelayerFee,
-      ))
-    ) {
-      updatedRelayerFee.amount =
-        balanceForRelayerFeeERC20 - relayerFeeMatchingSendingERC20Amount.amount;
+const gasEstimateResponseDummyProofIterativeRelayerFee = async (generateDummyTransactionStructsWithRelayerFee, generateTransaction, networkName, dopWalletID, erc20AmountRecipients, originalGasDetails, feeTokenDetails, sendWithPublicWallet, isCrossContractCall) => {
+    const wallet = (0, dop_1.walletForID)(dopWalletID);
+    // Use dead address for private transaction gas estimate
+    const fromWalletAddress = tx_generator_1.DUMMY_FROM_ADDRESS;
+    const isGasEstimateWithDummyProof = true;
+    const dummyRelayerFee = feeTokenDetails
+        ? (0, tx_generator_1.createDummyRelayerFeeERC20Amount)(feeTokenDetails.tokenAddress)
+        : undefined;
+    let serializedTransactions = await generateDummyTransactionStructsWithRelayerFee(dummyRelayerFee);
+    let transaction = await generateTransaction(serializedTransactions);
+    let gasEstimate = await (0, tx_gas_details_1.getGasEstimate)(networkName, transaction, fromWalletAddress, sendWithPublicWallet, isCrossContractCall);
+    console.log("gasEstimateForUnprovenTransfer gasEstimate::", gasEstimate);
+    if (sendWithPublicWallet) {
+        return (0, tx_gas_details_1.gasEstimateResponse)(gasEstimate, undefined, // relayerFeeCommitment
+        isGasEstimateWithDummyProof);
     }
-
-    const newSerializedTransactions =
-      // eslint-disable-next-line no-await-in-loop
-      await generateDummyTransactionStructsWithRelayerFee(updatedRelayerFee);
-
-    relayerFeeCommitment = getRelayerFeeCommitment(newSerializedTransactions);
-
-    if (
-      compareCircuitSizesTransactionStructs(
-        newSerializedTransactions,
-        serializedTransactions,
-      )
-    ) {
-      // Same circuit sizes, no need to run further gas estimates.
-      return gasEstimateResponse(
-        gasEstimate,
-        relayerFeeCommitment,
-        isGasEstimateWithDummyProof,
-      );
+    if (!feeTokenDetails) {
+        throw new Error('Must have Relayer Fee details or sendWithPublicWallet field.');
     }
-
-    serializedTransactions = newSerializedTransactions;
-
-    // eslint-disable-next-line no-await-in-loop
-    transaction = await generateTransaction(serializedTransactions);
-
-    // eslint-disable-next-line no-await-in-loop
-    const newGasEstimate = await getGasEstimate(
-      networkName,
-      transaction,
-      fromWalletAddress,
-      sendWithPublicWallet,
-      isCrossContractCall,
-    );
-
-    if (newGasEstimate === gasEstimate) {
-      return gasEstimateResponse(
-        newGasEstimate,
-        relayerFeeCommitment,
-        isGasEstimateWithDummyProof,
-      );
+    // Find any erc20Amount in transfer that matches token of relayer fee, if exists.
+    const relayerFeeMatchingSendingERC20Amount = erc20AmountRecipients.find(erc20AmountRecipient => erc20AmountRecipient.tokenAddress.toLowerCase() ===
+        feeTokenDetails.tokenAddress.toLowerCase());
+    // Get private balance of matching token.
+    const balanceForRelayerFeeERC20 = await (0, balance_update_1.balanceForERC20Token)(wallet, networkName, feeTokenDetails.tokenAddress);
+    let relayerFeeCommitment = getRelayerFeeCommitment(serializedTransactions);
+    // Iteratively calculate new relayer fee and estimate new gas amount.
+    // This change if the number of circuits changes because of the additional Relayer Fees.
+    for (let i = 0; i < MAX_ITERATIONS_RELAYER_FEE_REESTIMATION; i += 1) {
+        const updatedGasDetails = {
+            ...originalGasDetails,
+            gasEstimate,
+        };
+        const updatedRelayerFee = (0, exports.calculateRelayerFeeERC20Amount)(feeTokenDetails, updatedGasDetails);
+        // If Relayer fee causes overflow with the token balance,
+        // then use the MAX amount for Relayer Fee, which is BALANCE - SENDING AMOUNT.
+        if (balanceForRelayerFeeERC20 > 0n &&
+            relayerFeeMatchingSendingERC20Amount &&
+            // eslint-disable-next-line no-await-in-loop
+            (await relayerFeeWillOverflowBalance(balanceForRelayerFeeERC20, relayerFeeMatchingSendingERC20Amount, updatedRelayerFee))) {
+            updatedRelayerFee.amount =
+                balanceForRelayerFeeERC20 - relayerFeeMatchingSendingERC20Amount.amount;
+        }
+        const newSerializedTransactions = 
+        // eslint-disable-next-line no-await-in-loop
+        await generateDummyTransactionStructsWithRelayerFee(updatedRelayerFee);
+        relayerFeeCommitment = getRelayerFeeCommitment(newSerializedTransactions);
+        if (compareCircuitSizesTransactionStructs(newSerializedTransactions, serializedTransactions)) {
+            // Same circuit sizes, no need to run further gas estimates.
+            return (0, tx_gas_details_1.gasEstimateResponse)(gasEstimate, relayerFeeCommitment, isGasEstimateWithDummyProof);
+        }
+        serializedTransactions = newSerializedTransactions;
+        // eslint-disable-next-line no-await-in-loop
+        transaction = await generateTransaction(serializedTransactions);
+        // eslint-disable-next-line no-await-in-loop
+        const newGasEstimate = await (0, tx_gas_details_1.getGasEstimate)(networkName, transaction, fromWalletAddress, sendWithPublicWallet, isCrossContractCall);
+        if (newGasEstimate === gasEstimate) {
+            return (0, tx_gas_details_1.gasEstimateResponse)(newGasEstimate, relayerFeeCommitment, isGasEstimateWithDummyProof);
+        }
+        gasEstimate = newGasEstimate;
     }
-    gasEstimate = newGasEstimate;
-  }
-
-  return gasEstimateResponse(
-    gasEstimate,
-    relayerFeeCommitment,
-    isGasEstimateWithDummyProof,
-  );
+    return (0, tx_gas_details_1.gasEstimateResponse)(gasEstimate, relayerFeeCommitment, isGasEstimateWithDummyProof);
 };
-
-const compareCircuitSizesTransactionStructs = (
-  serializedA: TransactionStruct[],
-  serializedB: TransactionStruct[],
-) => {
-  if (serializedA.length !== serializedB.length) {
-    return false;
-  }
-  for (let i = 0; i < serializedA.length; i += 1) {
-    // if (
-    //   serializedA[i].commitments.length !== serializedB[i].commitments.length
-    // ) {
-    //   return false;
-    // }
-    if (serializedA[i].nullifiers.length !== serializedB[i].nullifiers.length) {
-      return false;
+exports.gasEstimateResponseDummyProofIterativeRelayerFee = gasEstimateResponseDummyProofIterativeRelayerFee;
+const compareCircuitSizesTransactionStructs = (serializedA, serializedB) => {
+    if (serializedA.length !== serializedB.length) {
+        return false;
+    }
+    for (let i = 0; i < serializedA.length; i += 1) {
+        if (serializedA[i].commitments.length !== serializedB[i].commitments.length) {
+            return false;
+        }
+        if (serializedA[i].nullifiers.length !== serializedB[i].nullifiers.length) {
+            return false;
+        }
     }
-  }
-  return true;
+    return true;
 };
-
-const relayerFeeWillOverflowBalance = async (
-  tokenBalance: bigint,
-  sendingERC20Amount: DopERC20Amount,
-  relayerFeeERC20Amount: DopERC20Amount,
-) => {
-  const sendingAmount = sendingERC20Amount.amount;
-  const relayerFeeAmount = relayerFeeERC20Amount.amount;
-
-  return sendingAmount + relayerFeeAmount > tokenBalance;
+const relayerFeeWillOverflowBalance = async (tokenBalance, sendingERC20Amount, relayerFeeERC20Amount) => {
+    const sendingAmount = sendingERC20Amount.amount;
+    const relayerFeeAmount = relayerFeeERC20Amount.amount;
+    return sendingAmount + relayerFeeAmount > tokenBalance;
 };
-
-*/ 
 //# sourceMappingURL=tx-gas-relayer-fee-estimator.js.map

package/dist/services/transactions/tx-gas-relayer-fee-estimator.js.map

@@ -1 +1 @@
-{"version":3,"file":"tx-gas-relayer-fee-estimator.js","sourceRoot":"","sources":["../../../src/services/transactions/tx-gas-relayer-fee-estimator.ts"],"names":[],"mappings":";;;AACA,2DAS4B;AAW5B,MAAM,uCAAuC,GAAG,CAAC,CAAC;AAE3C,MAAM,8BAA8B,GAAG,CAC5C,eAAgC,EAChC,UAAiC,EACjB,EAAE;IAClB,MAAM,kBAAkB,GAAG,MAAM,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,UAAU,GAAG,GAAG,IAAI,GAAG,CAAC;IAC9B,MAAM,UAAU,GAAG,IAAA,wCAAmB,EAAC,UAAU,CAAC,CAAC;IACnD,MAAM,QAAQ,GAAG,CAAC,kBAAkB,GAAG,UAAU,CAAC,GAAG,UAAU,CAAC;IAChE,OAAO;QACL,YAAY,EAAE,eAAe,CAAC,YAAY;QAC1C,MAAM,EAAE,QAAQ;KACjB,CAAC;AACJ,CAAC,CAAC;AAZW,QAAA,8BAA8B,kCAYzC;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+LE","sourcesContent":["import { TransactionStruct } from 'dop-engine-v5';\nimport {\n  NetworkName,\n  TransactionGasDetails,\n  DopERC20Amount,\n  DopTransactionGasEstimateResponse,\n  FeeTokenDetails,\n  calculateMaximumGas,\n  DopERC20AmountRecipient,\n  CommitmentSummary,\n} from 'dop-sharedmodel-v5';\nimport {\n  DUMMY_FROM_ADDRESS,\n  createDummyRelayerFeeERC20Amount,\n} from './tx-generator';\nimport { getGasEstimate, gasEstimateResponse } from './tx-gas-details';\nimport { balanceForERC20Token } from '../dop/wallets/balance-update';\nimport { walletForID } from '../dop';\nimport { convertTransactionStructToCommitmentSummary } from '../dop/util/commitment';\nimport { ContractTransaction } from 'ethers';\n\nconst MAX_ITERATIONS_RELAYER_FEE_REESTIMATION = 5;\n\nexport const calculateRelayerFeeERC20Amount = (\n  feeTokenDetails: FeeTokenDetails,\n  gasDetails: TransactionGasDetails,\n): DopERC20Amount => {\n  const tokenFeePerUnitGas = BigInt(feeTokenDetails.feePerUnitGas);\n  const oneUnitGas = 10n ** 18n;\n  const maximumGas = calculateMaximumGas(gasDetails);\n  const tokenFee = (tokenFeePerUnitGas * maximumGas) / oneUnitGas;\n  return {\n    tokenAddress: feeTokenDetails.tokenAddress,\n    amount: tokenFee,\n  };\n};\n/*\nconst getRelayerFeeCommitment = (\n  transactionStructs: TransactionStruct[],\n): CommitmentSummary => {\n  const transactionIndex = 0;\n  const relayerFeeCommitment = transactionStructs[transactionIndex];\n  const relayerFeeCommitmentIndex = 0;\n  return convertTransactionStructToCommitmentSummary(\n    relayerFeeCommitment,\n    relayerFeeCommitmentIndex,\n  );\n};\n\nexport const gasEstimateResponseDummyProofIterativeRelayerFee = async (\n  generateDummyTransactionStructsWithRelayerFee: (\n    relayerFeeERC20Amount: Optional<DopERC20Amount>,\n  ) => Promise<TransactionStruct[]>,\n  generateTransaction: (\n    serializedTransactions: TransactionStruct[],\n  ) => Promise<ContractTransaction>,\n  networkName: NetworkName,\n  dopWalletID: string,\n  erc20AmountRecipients: DopERC20AmountRecipient[],\n  originalGasDetails: TransactionGasDetails,\n  feeTokenDetails: Optional<FeeTokenDetails>,\n  sendWithPublicWallet: boolean,\n  isCrossContractCall: boolean,\n): Promise<DopTransactionGasEstimateResponse> => {\n  const wallet = walletForID(dopWalletID);\n\n  // Use dead address for private transaction gas estimate\n  const fromWalletAddress = DUMMY_FROM_ADDRESS;\n\n  const isGasEstimateWithDummyProof = true;\n\n  const dummyRelayerFee = feeTokenDetails\n    ? createDummyRelayerFeeERC20Amount(feeTokenDetails.tokenAddress)\n    : undefined;\n\n  let serializedTransactions =\n    await generateDummyTransactionStructsWithRelayerFee(dummyRelayerFee);\n  let transaction = await generateTransaction(serializedTransactions);\n\n  let gasEstimate = await getGasEstimate(\n    networkName,\n    transaction,\n    fromWalletAddress,\n    sendWithPublicWallet,\n    isCrossContractCall,\n  );\n  console.log(\"gasEstimateForUnprovenTransfer gasEstimate::\", gasEstimate)\n\n\n  if (sendWithPublicWallet) {\n    return gasEstimateResponse(\n      gasEstimate,\n      undefined, // relayerFeeCommitment\n      isGasEstimateWithDummyProof,\n    );\n  }\n\n  if (!feeTokenDetails) {\n    throw new Error(\n      'Must have Relayer Fee details or sendWithPublicWallet field.',\n    );\n  }\n\n  // Find any erc20Amount in transfer that matches token of relayer fee, if exists.\n  const relayerFeeMatchingSendingERC20Amount = erc20AmountRecipients.find(\n    erc20AmountRecipient =>\n      erc20AmountRecipient.tokenAddress.toLowerCase() ===\n      feeTokenDetails.tokenAddress.toLowerCase(),\n  );\n\n  // Get private balance of matching token.\n  const balanceForRelayerFeeERC20 = await balanceForERC20Token(\n    wallet,\n    networkName,\n    feeTokenDetails.tokenAddress,\n  );\n\n  let relayerFeeCommitment = getRelayerFeeCommitment(serializedTransactions);\n\n  // Iteratively calculate new relayer fee and estimate new gas amount.\n  // This change if the number of circuits changes because of the additional Relayer Fees.\n  for (let i = 0; i < MAX_ITERATIONS_RELAYER_FEE_REESTIMATION; i += 1) {\n    const updatedGasDetails: TransactionGasDetails = {\n      ...originalGasDetails,\n      gasEstimate,\n    };\n    const updatedRelayerFee: DopERC20Amount =\n      calculateRelayerFeeERC20Amount(feeTokenDetails, updatedGasDetails);\n\n    // If Relayer fee causes overflow with the token balance,\n    // then use the MAX amount for Relayer Fee, which is BALANCE - SENDING AMOUNT.\n    if (\n      balanceForRelayerFeeERC20 > 0n &&\n      relayerFeeMatchingSendingERC20Amount &&\n      // eslint-disable-next-line no-await-in-loop\n      (await relayerFeeWillOverflowBalance(\n        balanceForRelayerFeeERC20,\n        relayerFeeMatchingSendingERC20Amount,\n        updatedRelayerFee,\n      ))\n    ) {\n      updatedRelayerFee.amount =\n        balanceForRelayerFeeERC20 - relayerFeeMatchingSendingERC20Amount.amount;\n    }\n\n    const newSerializedTransactions =\n      // eslint-disable-next-line no-await-in-loop\n      await generateDummyTransactionStructsWithRelayerFee(updatedRelayerFee);\n\n    relayerFeeCommitment = getRelayerFeeCommitment(newSerializedTransactions);\n\n    if (\n      compareCircuitSizesTransactionStructs(\n        newSerializedTransactions,\n        serializedTransactions,\n      )\n    ) {\n      // Same circuit sizes, no need to run further gas estimates.\n      return gasEstimateResponse(\n        gasEstimate,\n        relayerFeeCommitment,\n        isGasEstimateWithDummyProof,\n      );\n    }\n\n    serializedTransactions = newSerializedTransactions;\n\n    // eslint-disable-next-line no-await-in-loop\n    transaction = await generateTransaction(serializedTransactions);\n\n    // eslint-disable-next-line no-await-in-loop\n    const newGasEstimate = await getGasEstimate(\n      networkName,\n      transaction,\n      fromWalletAddress,\n      sendWithPublicWallet,\n      isCrossContractCall,\n    );\n\n    if (newGasEstimate === gasEstimate) {\n      return gasEstimateResponse(\n        newGasEstimate,\n        relayerFeeCommitment,\n        isGasEstimateWithDummyProof,\n      );\n    }\n    gasEstimate = newGasEstimate;\n  }\n\n  return gasEstimateResponse(\n    gasEstimate,\n    relayerFeeCommitment,\n    isGasEstimateWithDummyProof,\n  );\n};\n\nconst compareCircuitSizesTransactionStructs = (\n  serializedA: TransactionStruct[],\n  serializedB: TransactionStruct[],\n) => {\n  if (serializedA.length !== serializedB.length) {\n    return false;\n  }\n  for (let i = 0; i < serializedA.length; i += 1) {\n    // if (\n    //   serializedA[i].commitments.length !== serializedB[i].commitments.length\n    // ) {\n    //   return false;\n    // }\n    if (serializedA[i].nullifiers.length !== serializedB[i].nullifiers.length) {\n      return false;\n    }\n  }\n  return true;\n};\n\nconst relayerFeeWillOverflowBalance = async (\n  tokenBalance: bigint,\n  sendingERC20Amount: DopERC20Amount,\n  relayerFeeERC20Amount: DopERC20Amount,\n) => {\n  const sendingAmount = sendingERC20Amount.amount;\n  const relayerFeeAmount = relayerFeeERC20Amount.amount;\n\n  return sendingAmount + relayerFeeAmount > tokenBalance;\n};\n\n*/"]}
+{"version":3,"file":"tx-gas-relayer-fee-estimator.js","sourceRoot":"","sources":["../../../src/services/transactions/tx-gas-relayer-fee-estimator.ts"],"names":[],"mappings":";;;AACA,qDASyB;AACzB,iDAGwB;AACxB,qDAAuE;AACvE,kEAAqE;AACrE,gCAAqC;AACrC,uDAAqF;AAGrF,MAAM,uCAAuC,GAAG,CAAC,CAAC;AAE3C,MAAM,8BAA8B,GAAG,CAC5C,eAAgC,EAChC,UAAiC,EACjB,EAAE;IAClB,MAAM,kBAAkB,GAAG,MAAM,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,UAAU,GAAG,GAAG,IAAI,GAAG,CAAC;IAC9B,MAAM,UAAU,GAAG,IAAA,qCAAmB,EAAC,UAAU,CAAC,CAAC;IACnD,MAAM,QAAQ,GAAG,CAAC,kBAAkB,GAAG,UAAU,CAAC,GAAG,UAAU,CAAC;IAChE,OAAO;QACL,YAAY,EAAE,eAAe,CAAC,YAAY;QAC1C,MAAM,EAAE,QAAQ;KACjB,CAAC;AACJ,CAAC,CAAC;AAZW,QAAA,8BAA8B,kCAYzC;AAEF,MAAM,uBAAuB,GAAG,CAC9B,kBAAuC,EACpB,EAAE;IACrB,MAAM,gBAAgB,GAAG,CAAC,CAAC;IAC3B,MAAM,oBAAoB,GAAG,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;IAClE,MAAM,yBAAyB,GAAG,CAAC,CAAC;IACpC,OAAO,IAAA,wDAA2C,EAChD,oBAAoB,EACpB,yBAAyB,CAC1B,CAAC;AACJ,CAAC,CAAC;AAEK,MAAM,gDAAgD,GAAG,KAAK,EACnE,6CAEiC,EACjC,mBAEiC,EACjC,WAAwB,EACxB,WAAmB,EACnB,qBAAgD,EAChD,kBAAyC,EACzC,eAA0C,EAC1C,oBAA6B,EAC7B,mBAA4B,EACgB,EAAE;IAC9C,MAAM,MAAM,GAAG,IAAA,iBAAW,EAAC,WAAW,CAAC,CAAC;IAExC,wDAAwD;IACxD,MAAM,iBAAiB,GAAG,iCAAkB,CAAC;IAE7C,MAAM,2BAA2B,GAAG,IAAI,CAAC;IAEzC,MAAM,eAAe,GAAG,eAAe;QACrC,CAAC,CAAC,IAAA,+CAAgC,EAAC,eAAe,CAAC,YAAY,CAAC;QAChE,CAAC,CAAC,SAAS,CAAC;IAEd,IAAI,sBAAsB,GACxB,MAAM,6CAA6C,CAAC,eAAe,CAAC,CAAC;IACvE,IAAI,WAAW,GAAG,MAAM,mBAAmB,CAAC,sBAAsB,CAAC,CAAC;IAEpE,IAAI,WAAW,GAAG,MAAM,IAAA,+BAAc,EACpC,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,oBAAoB,EACpB,mBAAmB,CACpB,CAAC;IACJ,OAAO,CAAC,GAAG,CAAC,8CAA8C,EAAE,WAAW,CAAC,CAAA;IAGtE,IAAI,oBAAoB,EAAE;QACxB,OAAO,IAAA,oCAAmB,EACxB,WAAW,EACX,SAAS,EAAE,uBAAuB;QAClC,2BAA2B,CAC5B,CAAC;KACH;IAED,IAAI,CAAC,eAAe,EAAE;QACpB,MAAM,IAAI,KAAK,CACb,8DAA8D,CAC/D,CAAC;KACH;IAED,iFAAiF;IACjF,MAAM,oCAAoC,GAAG,qBAAqB,CAAC,IAAI,CACrE,oBAAoB,CAAC,EAAE,CACrB,oBAAoB,CAAC,YAAY,CAAC,WAAW,EAAE;QAC/C,eAAe,CAAC,YAAY,CAAC,WAAW,EAAE,CAC7C,CAAC;IAEF,yCAAyC;IACzC,MAAM,yBAAyB,GAAG,MAAM,IAAA,qCAAoB,EAC1D,MAAM,EACN,WAAW,EACX,eAAe,CAAC,YAAY,CAC7B,CAAC;IAEF,IAAI,oBAAoB,GAAG,uBAAuB,CAAC,sBAAsB,CAAC,CAAC;IAE3E,qEAAqE;IACrE,wFAAwF;IACxF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,uCAAuC,EAAE,CAAC,IAAI,CAAC,EAAE;QACnE,MAAM,iBAAiB,GAA0B;YAC/C,GAAG,kBAAkB;YACrB,WAAW;SACZ,CAAC;QACF,MAAM,iBAAiB,GACrB,IAAA,sCAA8B,EAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC;QAErE,yDAAyD;QACzD,8EAA8E;QAC9E,IACE,yBAAyB,GAAG,EAAE;YAC9B,oCAAoC;YACpC,4CAA4C;YAC5C,CAAC,MAAM,6BAA6B,CAClC,yBAAyB,EACzB,oCAAoC,EACpC,iBAAiB,CAClB,CAAC,EACF;YACA,iBAAiB,CAAC,MAAM;gBACtB,yBAAyB,GAAG,oCAAoC,CAAC,MAAM,CAAC;SAC3E;QAED,MAAM,yBAAyB;QAC7B,4CAA4C;QAC5C,MAAM,6CAA6C,CAAC,iBAAiB,CAAC,CAAC;QAEzE,oBAAoB,GAAG,uBAAuB,CAAC,yBAAyB,CAAC,CAAC;QAE1E,IACE,qCAAqC,CACnC,yBAAyB,EACzB,sBAAsB,CACvB,EACD;YACA,4DAA4D;YAC5D,OAAO,IAAA,oCAAmB,EACxB,WAAW,EACX,oBAAoB,EACpB,2BAA2B,CAC5B,CAAC;SACH;QAED,sBAAsB,GAAG,yBAAyB,CAAC;QAEnD,4CAA4C;QAC5C,WAAW,GAAG,MAAM,mBAAmB,CAAC,sBAAsB,CAAC,CAAC;QAEhE,4CAA4C;QAC5C,MAAM,cAAc,GAAG,MAAM,IAAA,+BAAc,EACzC,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,oBAAoB,EACpB,mBAAmB,CACpB,CAAC;QAEF,IAAI,cAAc,KAAK,WAAW,EAAE;YAClC,OAAO,IAAA,oCAAmB,EACxB,cAAc,EACd,oBAAoB,EACpB,2BAA2B,CAC5B,CAAC;SACH;QACD,WAAW,GAAG,cAAc,CAAC;KAC9B;IAED,OAAO,IAAA,oCAAmB,EACxB,WAAW,EACX,oBAAoB,EACpB,2BAA2B,CAC5B,CAAC;AACJ,CAAC,CAAC;AAjJW,QAAA,gDAAgD,oDAiJ3D;AAEF,MAAM,qCAAqC,GAAG,CAC5C,WAAgC,EAChC,WAAgC,EAChC,EAAE;IACF,IAAI,WAAW,CAAC,MAAM,KAAK,WAAW,CAAC,MAAM,EAAE;QAC7C,OAAO,KAAK,CAAC;KACd;IACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;QAC9C,IACE,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,EACvE;YACA,OAAO,KAAK,CAAC;SACd;QACD,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,EAAE;YACzE,OAAO,KAAK,CAAC;SACd;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,6BAA6B,GAAG,KAAK,EACzC,YAAoB,EACpB,kBAAkC,EAClC,qBAAqC,EACrC,EAAE;IACF,MAAM,aAAa,GAAG,kBAAkB,CAAC,MAAM,CAAC;IAChD,MAAM,gBAAgB,GAAG,qBAAqB,CAAC,MAAM,CAAC;IAEtD,OAAO,aAAa,GAAG,gBAAgB,GAAG,YAAY,CAAC;AACzD,CAAC,CAAC","sourcesContent":["import { TransactionStruct } from 'dop-engine';\nimport {\n  NetworkName,\n  TransactionGasDetails,\n  DopERC20Amount,\n  DopTransactionGasEstimateResponse,\n  FeeTokenDetails,\n  calculateMaximumGas,\n  DopERC20AmountRecipient,\n  CommitmentSummary,\n} from 'dop-sharedmodel';\nimport {\n  DUMMY_FROM_ADDRESS,\n  createDummyRelayerFeeERC20Amount,\n} from './tx-generator';\nimport { getGasEstimate, gasEstimateResponse } from './tx-gas-details';\nimport { balanceForERC20Token } from '../dop/wallets/balance-update';\nimport { walletForID } from '../dop';\nimport { convertTransactionStructToCommitmentSummary } from '../dop/util/commitment';\nimport { ContractTransaction } from 'ethers';\n\nconst MAX_ITERATIONS_RELAYER_FEE_REESTIMATION = 5;\n\nexport const calculateRelayerFeeERC20Amount = (\n  feeTokenDetails: FeeTokenDetails,\n  gasDetails: TransactionGasDetails,\n): DopERC20Amount => {\n  const tokenFeePerUnitGas = BigInt(feeTokenDetails.feePerUnitGas);\n  const oneUnitGas = 10n ** 18n;\n  const maximumGas = calculateMaximumGas(gasDetails);\n  const tokenFee = (tokenFeePerUnitGas * maximumGas) / oneUnitGas;\n  return {\n    tokenAddress: feeTokenDetails.tokenAddress,\n    amount: tokenFee,\n  };\n};\n\nconst getRelayerFeeCommitment = (\n  transactionStructs: TransactionStruct[],\n): CommitmentSummary => {\n  const transactionIndex = 0;\n  const relayerFeeCommitment = transactionStructs[transactionIndex];\n  const relayerFeeCommitmentIndex = 0;\n  return convertTransactionStructToCommitmentSummary(\n    relayerFeeCommitment,\n    relayerFeeCommitmentIndex,\n  );\n};\n\nexport const gasEstimateResponseDummyProofIterativeRelayerFee = async (\n  generateDummyTransactionStructsWithRelayerFee: (\n    relayerFeeERC20Amount: Optional<DopERC20Amount>,\n  ) => Promise<TransactionStruct[]>,\n  generateTransaction: (\n    serializedTransactions: TransactionStruct[],\n  ) => Promise<ContractTransaction>,\n  networkName: NetworkName,\n  dopWalletID: string,\n  erc20AmountRecipients: DopERC20AmountRecipient[],\n  originalGasDetails: TransactionGasDetails,\n  feeTokenDetails: Optional<FeeTokenDetails>,\n  sendWithPublicWallet: boolean,\n  isCrossContractCall: boolean,\n): Promise<DopTransactionGasEstimateResponse> => {\n  const wallet = walletForID(dopWalletID);\n\n  // Use dead address for private transaction gas estimate\n  const fromWalletAddress = DUMMY_FROM_ADDRESS;\n\n  const isGasEstimateWithDummyProof = true;\n\n  const dummyRelayerFee = feeTokenDetails\n    ? createDummyRelayerFeeERC20Amount(feeTokenDetails.tokenAddress)\n    : undefined;\n\n  let serializedTransactions =\n    await generateDummyTransactionStructsWithRelayerFee(dummyRelayerFee);\n  let transaction = await generateTransaction(serializedTransactions);\n\n  let gasEstimate = await getGasEstimate(\n    networkName,\n    transaction,\n    fromWalletAddress,\n    sendWithPublicWallet,\n    isCrossContractCall,\n  );\nconsole.log(\"gasEstimateForUnprovenTransfer gasEstimate::\", gasEstimate)\n\n\n  if (sendWithPublicWallet) {\n    return gasEstimateResponse(\n      gasEstimate,\n      undefined, // relayerFeeCommitment\n      isGasEstimateWithDummyProof,\n    );\n  }\n\n  if (!feeTokenDetails) {\n    throw new Error(\n      'Must have Relayer Fee details or sendWithPublicWallet field.',\n    );\n  }\n\n  // Find any erc20Amount in transfer that matches token of relayer fee, if exists.\n  const relayerFeeMatchingSendingERC20Amount = erc20AmountRecipients.find(\n    erc20AmountRecipient =>\n      erc20AmountRecipient.tokenAddress.toLowerCase() ===\n      feeTokenDetails.tokenAddress.toLowerCase(),\n  );\n\n  // Get private balance of matching token.\n  const balanceForRelayerFeeERC20 = await balanceForERC20Token(\n    wallet,\n    networkName,\n    feeTokenDetails.tokenAddress,\n  );\n\n  let relayerFeeCommitment = getRelayerFeeCommitment(serializedTransactions);\n\n  // Iteratively calculate new relayer fee and estimate new gas amount.\n  // This change if the number of circuits changes because of the additional Relayer Fees.\n  for (let i = 0; i < MAX_ITERATIONS_RELAYER_FEE_REESTIMATION; i += 1) {\n    const updatedGasDetails: TransactionGasDetails = {\n      ...originalGasDetails,\n      gasEstimate,\n    };\n    const updatedRelayerFee: DopERC20Amount =\n      calculateRelayerFeeERC20Amount(feeTokenDetails, updatedGasDetails);\n\n    // If Relayer fee causes overflow with the token balance,\n    // then use the MAX amount for Relayer Fee, which is BALANCE - SENDING AMOUNT.\n    if (\n      balanceForRelayerFeeERC20 > 0n &&\n      relayerFeeMatchingSendingERC20Amount &&\n      // eslint-disable-next-line no-await-in-loop\n      (await relayerFeeWillOverflowBalance(\n        balanceForRelayerFeeERC20,\n        relayerFeeMatchingSendingERC20Amount,\n        updatedRelayerFee,\n      ))\n    ) {\n      updatedRelayerFee.amount =\n        balanceForRelayerFeeERC20 - relayerFeeMatchingSendingERC20Amount.amount;\n    }\n\n    const newSerializedTransactions =\n      // eslint-disable-next-line no-await-in-loop\n      await generateDummyTransactionStructsWithRelayerFee(updatedRelayerFee);\n\n    relayerFeeCommitment = getRelayerFeeCommitment(newSerializedTransactions);\n\n    if (\n      compareCircuitSizesTransactionStructs(\n        newSerializedTransactions,\n        serializedTransactions,\n      )\n    ) {\n      // Same circuit sizes, no need to run further gas estimates.\n      return gasEstimateResponse(\n        gasEstimate,\n        relayerFeeCommitment,\n        isGasEstimateWithDummyProof,\n      );\n    }\n\n    serializedTransactions = newSerializedTransactions;\n\n    // eslint-disable-next-line no-await-in-loop\n    transaction = await generateTransaction(serializedTransactions);\n\n    // eslint-disable-next-line no-await-in-loop\n    const newGasEstimate = await getGasEstimate(\n      networkName,\n      transaction,\n      fromWalletAddress,\n      sendWithPublicWallet,\n      isCrossContractCall,\n    );\n\n    if (newGasEstimate === gasEstimate) {\n      return gasEstimateResponse(\n        newGasEstimate,\n        relayerFeeCommitment,\n        isGasEstimateWithDummyProof,\n      );\n    }\n    gasEstimate = newGasEstimate;\n  }\n\n  return gasEstimateResponse(\n    gasEstimate,\n    relayerFeeCommitment,\n    isGasEstimateWithDummyProof,\n  );\n};\n\nconst compareCircuitSizesTransactionStructs = (\n  serializedA: TransactionStruct[],\n  serializedB: TransactionStruct[],\n) => {\n  if (serializedA.length !== serializedB.length) {\n    return false;\n  }\n  for (let i = 0; i < serializedA.length; i += 1) {\n    if (\n      serializedA[i].commitments.length !== serializedB[i].commitments.length\n    ) {\n      return false;\n    }\n    if (serializedA[i].nullifiers.length !== serializedB[i].nullifiers.length) {\n      return false;\n    }\n  }\n  return true;\n};\n\nconst relayerFeeWillOverflowBalance = async (\n  tokenBalance: bigint,\n  sendingERC20Amount: DopERC20Amount,\n  relayerFeeERC20Amount: DopERC20Amount,\n) => {\n  const sendingAmount = sendingERC20Amount.amount;\n  const relayerFeeAmount = relayerFeeERC20Amount.amount;\n\n  return sendingAmount + relayerFeeAmount > tokenBalance;\n};\n"]}

package/dist/services/transactions/tx-generator.d.ts

@@ -1,9 +1,10 @@
-import { AdaptID, TransactionStruct, ProverProgressCallback } from 'dop-engine-v5';
-import { DopERC20Amount, DopERC20AmountRecipient, NetworkName, ProofType, DopNFTAmountRecipient } from 'dop-sharedmodel-v5';
+import { AdaptID, TransactionStruct, ProverProgressCallback } from 'dop-engine';
+import { DopERC20Amount, DopERC20AmountRecipient, NetworkName, ProofType, DopNFTAmountRecipient } from 'dop-sharedmodel';
 import { ContractTransaction } from 'ethers';
 export declare const DUMMY_FROM_ADDRESS = "0x000000000000000000000000000000000000dEaD";
-export declare const generateProofTransactions: (proofType: ProofType, networkName: NetworkName, dopWalletID: string, encryptionKey: string, showSenderAddressToRecipient: boolean, memoText: Optional<string>, erc20AmountRecipients: DopERC20AmountRecipient[], nftAmountRecipients: DopNFTAmountRecipient[], relayerFeeERC20AmountRecipient: Optional<DopERC20AmountRecipient>, sendWithPublicWallet: boolean, relayAdaptID: Optional<AdaptID>, useDummyProof: boolean, overallBatchMinGasPrice: Optional<bigint>, progressCallback: ProverProgressCallback, valueCheck: bigint) => Promise<TransactionStruct[]>;
+export declare const generateProofTransactions: (proofType: ProofType, networkName: NetworkName, dopWalletID: string, encryptionKey: string, showSenderAddressToRecipient: boolean, memoText: Optional<string>, erc20AmountRecipients: DopERC20AmountRecipient[], nftAmountRecipients: DopNFTAmountRecipient[], relayerFeeERC20AmountRecipient: Optional<DopERC20AmountRecipient>, sendWithPublicWallet: boolean, relayAdaptID: Optional<AdaptID>, useDummyProof: boolean, overallBatchMinGasPrice: Optional<bigint>, progressCallback: ProverProgressCallback) => Promise<TransactionStruct[]>;
 export declare const nullifiersForTransactions: (transactions: TransactionStruct[]) => string[];
 export declare const createDummyRelayerFeeERC20Amount: (feeTokenAddress: string) => DopERC20Amount;
-export declare const generateDummyProofTransactions: (proofType: ProofType, networkName: NetworkName, dopWalletID: string, encryptionKey: string, showSenderAddressToRecipient: boolean, memoText: Optional<string>, erc20AmountRecipients: DopERC20AmountRecipient[], nftAmountRecipients: DopNFTAmountRecipient[], relayerFeeERC20Amount: Optional<DopERC20Amount>, sendWithPublicWallet: boolean, overallBatchMinGasPrice: Optional<bigint>, valueCheck: bigint) => Promise<TransactionStruct[]>;
+export declare const generateDummyProofTransactions: (proofType: ProofType, networkName: NetworkName, dopWalletID: string, encryptionKey: string, showSenderAddressToRecipient: boolean, memoText: Optional<string>, erc20AmountRecipients: DopERC20AmountRecipient[], nftAmountRecipients: DopNFTAmountRecipient[], relayerFeeERC20Amount: Optional<DopERC20Amount>, sendWithPublicWallet: boolean, overallBatchMinGasPrice: Optional<bigint>) => Promise<TransactionStruct[]>;
 export declare const generateTransact: (txs: TransactionStruct[], networkName: NetworkName, useDummyProof?: boolean) => Promise<ContractTransaction>;
+export declare const generateUnshieldBaseToken: (txs: TransactionStruct[], networkName: NetworkName, toWalletAddress: string, relayAdaptParamsRandom: string, useDummyProof?: boolean) => Promise<ContractTransaction>;