@matrix-privacy/wallet 0.0.1

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

@@ -0,0 +1,210 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseRelayAdaptReturnValue = exports.getRelayAdaptTransactionError = exports.generateCrossContractCallsProof = exports.gasEstimateForUnprovenCrossContractCalls = exports.populateProvedCrossContractCalls = exports.createNFTTokenDataFromMatrixNFTAmount = exports.createRelayAdaptUnshieldNFTAmountRecipients = exports.createRelayAdaptUnshieldERC20AmountRecipients = void 0;
+const shared_models_1 = require("@matrix-privacy/shared-models");
+const tx_generator_1 = require("./tx-generator");
+const proof_cache_1 = require("./proof-cache");
+const logger_1 = require("../../utils/logger");
+const engine_1 = require("@matrix-privacy/engine");
+const tx_gas_broadcaster_fee_estimator_1 = require("./tx-gas-broadcaster-fee-estimator");
+const error_1 = require("../../utils/error");
+const utils_1 = require("../../utils");
+const shared_formatters_1 = require("../matrix/quick-sync/shared-formatters");
+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: engine_1.ByteUtils.hexlify(transactionRequest.data, true),
+            };
+            return transaction;
+        });
+    }
+    catch (cause) {
+        if (!(cause instanceof Error)) {
+            throw new Error('Non-error thrown from createValidCrossContractCalls', {
+                cause,
+            });
+        }
+        throw (0, error_1.reportAndSanitizeError)(createValidCrossContractCalls.name, cause);
+    }
+};
+const createRelayAdaptUnshieldERC20AmountRecipients = (networkName, unshieldERC20Amounts) => {
+    const chain = shared_models_1.NETWORK_CONFIG[networkName].chain;
+    const relayAdaptContract = engine_1.MatrixContracts.getRelayAdaptContract(chain);
+    const unshieldERC20AmountRecipients = unshieldERC20Amounts.map(unshieldERC20Amount => ({
+        ...unshieldERC20Amount,
+        recipientAddress: relayAdaptContract.address,
+    }));
+    return unshieldERC20AmountRecipients;
+};
+exports.createRelayAdaptUnshieldERC20AmountRecipients = createRelayAdaptUnshieldERC20AmountRecipients;
+const createRelayAdaptUnshieldNFTAmountRecipients = (networkName, unshieldNFTAmounts) => {
+    const chain = shared_models_1.NETWORK_CONFIG[networkName].chain;
+    const relayAdaptContract = engine_1.MatrixContracts.getRelayAdaptContract(chain);
+    const unshieldNFTAmountRecipients = unshieldNFTAmounts.map(unshieldNFTAmount => ({
+        ...unshieldNFTAmount,
+        recipientAddress: relayAdaptContract.address,
+    }));
+    return unshieldNFTAmountRecipients;
+};
+exports.createRelayAdaptUnshieldNFTAmountRecipients = createRelayAdaptUnshieldNFTAmountRecipients;
+const createNFTTokenDataFromMatrixNFTAmount = (nftAmount) => {
+    const tokenSubIDHex = (0, utils_1.isDecimalStr)(nftAmount.tokenSubID)
+        ? (0, shared_formatters_1.bigIntStringToHex)(nftAmount.tokenSubID)
+        : nftAmount.tokenSubID;
+    return {
+        tokenAddress: engine_1.ByteUtils.formatToByteLength(nftAmount.nftAddress, engine_1.ByteLength.Address, true),
+        tokenType: nftAmount.nftTokenType,
+        tokenSubID: engine_1.ByteUtils.formatToByteLength(tokenSubIDHex, engine_1.ByteLength.UINT_256, true),
+    };
+};
+exports.createNFTTokenDataFromMatrixNFTAmount = createNFTTokenDataFromMatrixNFTAmount;
+const createRelayAdaptShieldNFTRecipients = (relayAdaptShieldNFTRecipients) => {
+    return relayAdaptShieldNFTRecipients.map((nftRecipient) => ({
+        nftTokenData: (0, exports.createNFTTokenDataFromMatrixNFTAmount)(nftRecipient),
+        recipientAddress: nftRecipient.recipientAddress,
+    }));
+};
+const populateProvedCrossContractCalls = async (networkName, matrixWalletID, relayAdaptUnshieldERC20Amounts, relayAdaptUnshieldNFTAmounts, relayAdaptShieldERC20Recipients, relayAdaptShieldNFTRecipients, crossContractCalls, broadcasterFeeERC20AmountRecipient, sendWithPublicWallet, overallBatchMinGasPrice, gasDetails) => {
+    try {
+        const { transaction, nullifiers } = await (0, proof_cache_1.populateProvedTransaction)(networkName, shared_models_1.ProofType.CrossContractCalls, matrixWalletID, false, // showSenderAddressToRecipient
+        undefined, // memoText
+        [], // erc20AmountRecipients
+        [], // nftAmountRecipients
+        relayAdaptUnshieldERC20Amounts, relayAdaptUnshieldNFTAmounts, relayAdaptShieldERC20Recipients, relayAdaptShieldNFTRecipients, crossContractCalls, broadcasterFeeERC20AmountRecipient, sendWithPublicWallet, overallBatchMinGasPrice, gasDetails);
+        delete transaction.from;
+        return {
+            nullifiers,
+            transaction,
+        };
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.populateProvedCrossContractCalls.name, err);
+    }
+};
+exports.populateProvedCrossContractCalls = populateProvedCrossContractCalls;
+const gasEstimateForUnprovenCrossContractCalls = async (networkName, matrixWalletID, encryptionKey, relayAdaptUnshieldERC20Amounts, relayAdaptUnshieldNFTAmounts, relayAdaptShieldERC20Recipients, relayAdaptShieldNFTRecipients, crossContractCalls, originalGasDetails, feeTokenDetails, sendWithPublicWallet, minGasLimit) => {
+    try {
+        (0, proof_cache_1.setCachedProvedTransaction)(undefined);
+        const overallBatchMinGasPrice = 0n;
+        const validCrossContractCalls = createValidCrossContractCalls(crossContractCalls);
+        const chain = shared_models_1.NETWORK_CONFIG[networkName].chain;
+        const relayAdaptUnshieldERC20AmountRecipients = (0, exports.createRelayAdaptUnshieldERC20AmountRecipients)(networkName, relayAdaptUnshieldERC20Amounts);
+        const relayAdaptUnshieldNFTAmountRecipients = (0, exports.createRelayAdaptUnshieldNFTAmountRecipients)(networkName, relayAdaptUnshieldNFTAmounts);
+        const shieldRandom = engine_1.ByteUtils.randomHex(16);
+        const relayShieldRequests = await engine_1.RelayAdaptHelper.generateRelayShieldRequests(shieldRandom, relayAdaptShieldERC20Recipients, createRelayAdaptShieldNFTRecipients(relayAdaptShieldNFTRecipients));
+        const minimumGasLimit = minGasLimit ?? engine_1.MINIMUM_RELAY_ADAPT_CROSS_CONTRACT_CALLS_GAS_LIMIT_V2;
+        const relayAdaptContract = engine_1.MatrixContracts.getRelayAdaptContract(chain);
+        const response = await (0, tx_gas_broadcaster_fee_estimator_1.gasEstimateResponseDummyProofIterativeBroadcasterFee)((broadcasterFeeERC20Amount) => (0, tx_generator_1.generateDummyProofTransactions)(shared_models_1.ProofType.CrossContractCalls, networkName, matrixWalletID, encryptionKey, false, // showSenderAddressToRecipient
+        undefined, // memoText
+        relayAdaptUnshieldERC20AmountRecipients, relayAdaptUnshieldNFTAmountRecipients, broadcasterFeeERC20Amount, sendWithPublicWallet, overallBatchMinGasPrice), async (txs) => {
+            const relayAdaptParamsRandom = engine_1.ByteUtils.randomHex(31);
+            const transaction = await relayAdaptContract.populateCrossContractCalls(txs, validCrossContractCalls, relayShieldRequests, relayAdaptParamsRandom, true, // isGasEstimate
+            !sendWithPublicWallet, // isBroadcasterTransaction
+            minimumGasLimit);
+            // Remove gasLimit, we'll set to the minimum below.
+            delete transaction.gasLimit;
+            return transaction;
+        }, networkName, matrixWalletID, relayAdaptUnshieldERC20AmountRecipients, originalGasDetails, feeTokenDetails, sendWithPublicWallet, true);
+        // 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 (0, error_1.reportAndSanitizeError)(exports.gasEstimateForUnprovenCrossContractCalls.name, err);
+    }
+};
+exports.gasEstimateForUnprovenCrossContractCalls = gasEstimateForUnprovenCrossContractCalls;
+const generateCrossContractCallsProof = async (networkName, matrixWalletID, encryptionKey, relayAdaptUnshieldERC20Amounts, relayAdaptUnshieldNFTAmounts, relayAdaptShieldERC20Recipients, relayAdaptShieldNFTRecipients, crossContractCalls, broadcasterFeeERC20AmountRecipient, sendWithPublicWallet, overallBatchMinGasPrice, minGasLimit, progressCallback) => {
+    try {
+        (0, proof_cache_1.setCachedProvedTransaction)(undefined);
+        const validCrossContractCalls = createValidCrossContractCalls(crossContractCalls);
+        const relayAdaptUnshieldERC20AmountRecipients = (0, exports.createRelayAdaptUnshieldERC20AmountRecipients)(networkName, relayAdaptUnshieldERC20Amounts);
+        const relayAdaptUnshieldNFTAmountRecipients = (0, exports.createRelayAdaptUnshieldNFTAmountRecipients)(networkName, relayAdaptUnshieldNFTAmounts);
+        // Generate dummy txs for relay adapt params.
+        const dummyUnshieldTxs = await (0, tx_generator_1.generateDummyProofTransactions)(shared_models_1.ProofType.CrossContractCalls, networkName, matrixWalletID, encryptionKey, false, // showSenderAddressToRecipient
+        undefined, // memoText
+        relayAdaptUnshieldERC20AmountRecipients, relayAdaptUnshieldNFTAmountRecipients, broadcasterFeeERC20AmountRecipient, sendWithPublicWallet, overallBatchMinGasPrice);
+        // Generate relay adapt params from dummy transactions.
+        const shieldRandom = engine_1.ByteUtils.randomHex(16);
+        const relayShieldRequests = await engine_1.RelayAdaptHelper.generateRelayShieldRequests(shieldRandom, relayAdaptShieldERC20Recipients, createRelayAdaptShieldNFTRecipients(relayAdaptShieldNFTRecipients));
+        const minimumGasLimit = minGasLimit ?? engine_1.MINIMUM_RELAY_ADAPT_CROSS_CONTRACT_CALLS_GAS_LIMIT_V2;
+        const { chain } = shared_models_1.NETWORK_CONFIG[networkName];
+        const isBroadcasterTransaction = !sendWithPublicWallet;
+        const relayAdaptParamsRandom = engine_1.ByteUtils.randomHex(31);
+        const relayAdaptContract = engine_1.MatrixContracts.getRelayAdaptContract(chain);
+        const relayAdaptParams = await relayAdaptContract.getRelayAdaptParamsCrossContractCalls(dummyUnshieldTxs, validCrossContractCalls, relayShieldRequests, relayAdaptParamsRandom, isBroadcasterTransaction, minimumGasLimit);
+        // Create real transactions with relay adapt params.
+        const { provedTransactions } = await (0, tx_generator_1.generateProofTransactions)(shared_models_1.ProofType.CrossContractCalls, networkName, matrixWalletID, encryptionKey, false, // showSenderAddressToRecipient
+        undefined, // memoText
+        relayAdaptUnshieldERC20AmountRecipients, relayAdaptUnshieldNFTAmountRecipients, broadcasterFeeERC20AmountRecipient, sendWithPublicWallet, false, // useDummyProof
+        overallBatchMinGasPrice, progressCallback);
+        const nullifiers = (0, tx_generator_1.nullifiersForTransactions)(provedTransactions);
+        const transaction = await relayAdaptContract.populateCrossContractCalls(provedTransactions, validCrossContractCalls, relayShieldRequests, relayAdaptParamsRandom, false, // isGasEstimate
+        isBroadcasterTransaction, minimumGasLimit);
+        delete transaction.from;
+        (0, proof_cache_1.setCachedProvedTransaction)({
+            proofType: shared_models_1.ProofType.CrossContractCalls,
+            matrixWalletID,
+            showSenderAddressToRecipient: false,
+            memoText: undefined,
+            erc20AmountRecipients: [],
+            nftAmountRecipients: [],
+            relayAdaptUnshieldERC20Amounts,
+            relayAdaptUnshieldNFTAmounts,
+            relayAdaptShieldERC20Recipients,
+            relayAdaptShieldNFTRecipients,
+            crossContractCalls: validCrossContractCalls,
+            broadcasterFeeERC20AmountRecipient,
+            sendWithPublicWallet,
+            transaction,
+            overallBatchMinGasPrice,
+            nullifiers,
+        });
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.generateCrossContractCallsProof.name, err);
+    }
+};
+exports.generateCrossContractCallsProof = generateCrossContractCallsProof;
+const getRelayAdaptTransactionError = (networkName, receiptLogs) => {
+    try {
+        const relayAdaptError = engine_1.RelayAdaptV3Contract.getRelayAdaptCallError(receiptLogs);
+        if ((0, shared_models_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 = (networkName, data) => {
+    try {
+        const relayAdaptErrorParsed = engine_1.RelayAdaptV3Contract.parseRelayAdaptReturnValue(data);
+        if ((0, shared_models_1.isDefined)(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,iEAeuC;AACvC,iDAKwB;AACxB,+CAGuB;AACvB,+CAAsD;AACtD,mDAUgC;AAChC,yFAA0G;AAC1G,6CAA2D;AAE3D,uCAA2C;AAC3C,8EAA2E;AAE3E,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,kBAAS,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC;aACvD,CAAC;YACF,OAAO,WAAW,CAAC;QACrB,CAAC,CAAC,CAAC;KACJ;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,qDAAqD,EAAE;gBACrE,KAAK;aACN,CAAC,CAAC;SACJ;QACD,MAAM,IAAA,8BAAsB,EAAC,6BAA6B,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;KACzE;AACH,CAAC,CAAC;AAEK,MAAM,6CAA6C,GAAG,CAC3D,WAAwB,EACxB,oBAAyC,EACX,EAAE;IAChC,MAAM,KAAK,GAAG,8BAAc,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC;IAChD,MAAM,kBAAkB,GACtB,wBAAe,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;IAC/C,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;AAbW,QAAA,6CAA6C,iDAaxD;AAEK,MAAM,2CAA2C,GAAG,CACzD,WAAwB,EACxB,kBAAqC,EACT,EAAE;IAC9B,MAAM,KAAK,GAAG,8BAAc,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC;IAChD,MAAM,kBAAkB,GACtB,wBAAe,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;IAC/C,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;AAbW,QAAA,2CAA2C,+CAatD;AAEK,MAAM,qCAAqC,GAAG,CACnD,SAA0B,EACZ,EAAE;IAChB,MAAM,aAAa,GAAG,IAAA,oBAAY,EAAC,SAAS,CAAC,UAAU,CAAC;QACtD,CAAC,CAAC,IAAA,qCAAiB,EAAC,SAAS,CAAC,UAAU,CAAC;QACzC,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC;IAEzB,OAAO;QACL,YAAY,EAAE,kBAAS,CAAC,kBAAkB,CACxC,SAAS,CAAC,UAAU,EACpB,mBAAU,CAAC,OAAO,EAClB,IAAI,CACL;QACD,SAAS,EAAE,SAAS,CAAC,YAAqB;QAC1C,UAAU,EAAE,kBAAS,CAAC,kBAAkB,CACtC,aAAa,EACb,mBAAU,CAAC,QAAQ,EACnB,IAAI,CACL;KACF,CAAC;AACJ,CAAC,CAAC;AApBW,QAAA,qCAAqC,yCAoBhD;AAEF,MAAM,mCAAmC,GAAG,CAC1C,6BAAyD,EACzB,EAAE;IAClC,OAAO,6BAA6B,CAAC,GAAG,CACtC,CAAC,YAAsC,EAAE,EAAE,CAAC,CAAC;QAC3C,YAAY,EAAE,IAAA,6CAAqC,EAAC,YAAY,CAAC;QACjE,gBAAgB,EAAE,YAAY,CAAC,gBAAgB;KAChD,CAAC,CACH,CAAC;AACJ,CAAC,CAAC;AAEK,MAAM,gCAAgC,GAAG,KAAK,EACnD,WAAwB,EACxB,cAAsB,EACtB,8BAAmD,EACnD,4BAA+C,EAC/C,+BAAuD,EACvD,6BAAyD,EACzD,kBAAyC,EACzC,kCAAwE,EACxE,oBAA6B,EAC7B,uBAAyC,EACzC,UAAiC,EACW,EAAE;IAC9C,IAAI;QACF,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAC/B,MAAM,IAAA,uCAAyB,EAC7B,WAAW,EACX,yBAAS,CAAC,kBAAkB,EAC5B,cAAc,EACd,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,kCAAkC,EAClC,oBAAoB,EACpB,uBAAuB,EACvB,UAAU,CACX,CAAC;QACJ,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;AA1CW,QAAA,gCAAgC,oCA0C3C;AAEK,MAAM,wCAAwC,GAAG,KAAK,EAC3D,WAAwB,EACxB,cAAsB,EACtB,aAAqB,EACrB,8BAAmD,EACnD,4BAA+C,EAC/C,+BAAuD,EACvD,6BAAyD,EACzD,kBAAyC,EACzC,kBAAyC,EACzC,eAA0C,EAC1C,oBAA6B,EAC7B,WAA6B,EACkB,EAAE;IACjD,IAAI;QACF,IAAA,wCAA0B,EAAC,SAAS,CAAC,CAAC;QAEtC,MAAM,uBAAuB,GAAG,EAAE,CAAC;QAEnC,MAAM,uBAAuB,GAC3B,6BAA6B,CAAC,kBAAkB,CAAC,CAAC;QAEpD,MAAM,KAAK,GAAG,8BAAc,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC;QAEhD,MAAM,uCAAuC,GAC3C,IAAA,qDAA6C,EAC3C,WAAW,EACX,8BAA8B,CAC/B,CAAC;QACJ,MAAM,qCAAqC,GACzC,IAAA,mDAA2C,EACzC,WAAW,EACX,4BAA4B,CAC7B,CAAC;QAEJ,MAAM,YAAY,GAAG,kBAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAC7C,MAAM,mBAAmB,GACvB,MAAM,yBAAgB,CAAC,2BAA2B,CAChD,YAAY,EACZ,+BAA+B,EAC/B,mCAAmC,CAAC,6BAA6B,CAAC,CACnE,CAAC;QAEJ,MAAM,eAAe,GACnB,WAAW,IAAI,8DAAqD,CAAC;QAEvE,MAAM,kBAAkB,GAAG,wBAAe,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAExE,MAAM,QAAQ,GAAG,MAAM,IAAA,uFAAoD,EACzE,CAAC,yBAAsD,EAAE,EAAE,CACzD,IAAA,6CAA8B,EAC5B,yBAAS,CAAC,kBAAkB,EAC5B,WAAW,EACX,cAAc,EACd,aAAa,EACb,KAAK,EAAE,+BAA+B;QACtC,SAAS,EAAE,WAAW;QACtB,uCAAuC,EACvC,qCAAqC,EACrC,yBAAyB,EACzB,oBAAoB,EACpB,uBAAuB,CACxB,EACH,KAAK,EAAE,GAA0B,EAAE,EAAE;YACnC,MAAM,sBAAsB,GAAG,kBAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YAEvD,MAAM,WAAW,GACf,MAAM,kBAAkB,CAAC,0BAA0B,CACjD,GAAG,EACH,uBAAuB,EACvB,mBAAmB,EACnB,sBAAsB,EACtB,IAAI,EAAE,gBAAgB;YACtB,CAAC,oBAAoB,EAAE,2BAA2B;YAClD,eAAe,CAChB,CAAC;YACJ,mDAAmD;YACnD,OAAO,WAAW,CAAC,QAAQ,CAAC;YAC5B,OAAO,WAAW,CAAC;QACrB,CAAC,EACD,WAAW,EACX,cAAc,EACd,uCAAuC,EACvC,kBAAkB,EAClB,eAAe,EACf,oBAAoB,EACpB,IAAI,CACL,CAAC;QAEF,oFAAoF;QACpF,IAAI,QAAQ,CAAC,WAAW,EAAE;YACxB,IAAI,QAAQ,CAAC,WAAW,GAAG,eAAe,EAAE;gBAC1C,QAAQ,CAAC,WAAW,GAAG,eAAe,CAAC;aACxC;SACF;QAED,OAAO,QAAQ,CAAC;KACjB;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAC1B,gDAAwC,CAAC,IAAI,EAC7C,GAAG,CACJ,CAAC;KACH;AACH,CAAC,CAAC;AAvGW,QAAA,wCAAwC,4CAuGnD;AAEK,MAAM,+BAA+B,GAAG,KAAK,EAClD,WAAwB,EACxB,cAAsB,EACtB,aAAqB,EACrB,8BAAmD,EACnD,4BAA+C,EAC/C,+BAAuD,EACvD,6BAAyD,EACzD,kBAAyC,EACzC,kCAAwE,EACxE,oBAA6B,EAC7B,uBAAyC,EACzC,WAA6B,EAC7B,gBAAsD,EACvC,EAAE;IACjB,IAAI;QACF,IAAA,wCAA0B,EAAC,SAAS,CAAC,CAAC;QAEtC,MAAM,uBAAuB,GAC3B,6BAA6B,CAAC,kBAAkB,CAAC,CAAC;QAEpD,MAAM,uCAAuC,GAC3C,IAAA,qDAA6C,EAC3C,WAAW,EACX,8BAA8B,CAC/B,CAAC;QACJ,MAAM,qCAAqC,GACzC,IAAA,mDAA2C,EACzC,WAAW,EACX,4BAA4B,CAC7B,CAAC;QAEJ,6CAA6C;QAC7C,MAAM,gBAAgB,GAAG,MAAM,IAAA,6CAA8B,EAC3D,yBAAS,CAAC,kBAAkB,EAC5B,WAAW,EACX,cAAc,EACd,aAAa,EACb,KAAK,EAAE,+BAA+B;QACtC,SAAS,EAAE,WAAW;QACtB,uCAAuC,EACvC,qCAAqC,EACrC,kCAAkC,EAClC,oBAAoB,EACpB,uBAAuB,CACxB,CAAC;QAEF,uDAAuD;QACvD,MAAM,YAAY,GAAG,kBAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAE7C,MAAM,mBAAmB,GACvB,MAAM,yBAAgB,CAAC,2BAA2B,CAChD,YAAY,EACZ,+BAA+B,EAC/B,mCAAmC,CAAC,6BAA6B,CAAC,CACnE,CAAC;QAEJ,MAAM,eAAe,GACnB,WAAW,IAAI,8DAAqD,CAAC;QAEvE,MAAM,EAAE,KAAK,EAAE,GAAG,8BAAc,CAAC,WAAW,CAAC,CAAC;QAE9C,MAAM,wBAAwB,GAAG,CAAC,oBAAoB,CAAC;QACvD,MAAM,sBAAsB,GAAG,kBAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACvD,MAAM,kBAAkB,GAAG,wBAAe,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACxE,MAAM,gBAAgB,GACpB,MAAM,kBAAkB,CAAC,qCAAqC,CAC5D,gBAAgB,EAChB,uBAAuB,EACvB,mBAAmB,EACnB,sBAAsB,EACtB,wBAAwB,EACxB,eAAe,CAChB,CAAC;QAEJ,oDAAoD;QACpD,MAAM,EAAE,kBAAkB,EAAE,GAC1B,MAAM,IAAA,wCAAyB,EAC7B,yBAAS,CAAC,kBAAkB,EAC5B,WAAW,EACX,cAAc,EACd,aAAa,EACb,KAAK,EAAE,+BAA+B;QACtC,SAAS,EAAE,WAAW;QACtB,uCAAuC,EACvC,qCAAqC,EACrC,kCAAkC,EAClC,oBAAoB,EACpB,KAAK,EAAE,gBAAgB;QACvB,uBAAuB,EACvB,gBAAgB,CACjB,CAAC;QAEJ,MAAM,UAAU,GAAG,IAAA,wCAAyB,EAAC,kBAAkB,CAAC,CAAC;QAEjE,MAAM,WAAW,GACf,MAAM,kBAAkB,CAAC,0BAA0B,CACjD,kBAAkB,EAClB,uBAAuB,EACvB,mBAAmB,EACnB,sBAAsB,EACtB,KAAK,EAAE,gBAAgB;QACvB,wBAAwB,EACxB,eAAe,CAChB,CAAC;QACJ,OAAO,WAAW,CAAC,IAAI,CAAC;QAExB,IAAA,wCAA0B,EAAC;YACzB,SAAS,EAAE,yBAAS,CAAC,kBAAkB;YACvC,cAAc;YACd,4BAA4B,EAAE,KAAK;YACnC,QAAQ,EAAE,SAAS;YACnB,qBAAqB,EAAE,EAAE;YACzB,mBAAmB,EAAE,EAAE;YACvB,8BAA8B;YAC9B,4BAA4B;YAC5B,+BAA+B;YAC/B,6BAA6B;YAC7B,kBAAkB,EAAE,uBAAuB;YAC3C,kCAAkC;YAClC,oBAAoB;YACpB,WAAW;YACX,uBAAuB;YACvB,UAAU;SACX,CAAC,CAAC;KACJ;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,uCAA+B,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KACzE;AACH,CAAC,CAAC;AAhIW,QAAA,+BAA+B,mCAgI1C;AAEK,MAAM,6BAA6B,GAAG,CAC3C,WAAwB,EACxB,WAAoC,EAClB,EAAE;IACpB,IAAI;QACF,MAAM,eAAe,GAAG,6BAAoB,CAAC,sBAAsB,CACjE,WAAW,CACZ,CAAC;QACF,IAAI,IAAA,yBAAS,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;AAhBW,QAAA,6BAA6B,iCAgBxC;AAEK,MAAM,0BAA0B,GAAG,CACxC,WAAwB,EACxB,IAAY,EACM,EAAE;IACpB,IAAI;QACF,MAAM,qBAAqB,GAAG,6BAAoB,CAAC,0BAA0B,CAC3E,IAAI,CACL,CAAC;QACF,IAAI,IAAA,yBAAS,EAAC,qBAAqB,CAAC,EAAE;YACpC,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;AAhBW,QAAA,0BAA0B,8BAgBrC","sourcesContent":["import {\n  MatrixPopulateTransactionResponse,\n  MatrixTransactionGasEstimateResponse,\n  MatrixERC20Amount,\n  NetworkName,\n  ProofType,\n  TransactionReceiptLog,\n  FeeTokenDetails,\n  MatrixERC20AmountRecipient,\n  MatrixNFTAmountRecipient,\n  MatrixNFTAmount,\n  TransactionGasDetails,\n  isDefined,\n  MatrixERC20Recipient,\n  NETWORK_CONFIG,\n} from '@matrix-privacy/shared-models';\nimport {\n  GenerateTransactionsProgressCallback,\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  NFTTokenData,\n  ByteUtils,\n  ByteLength,\n  MINIMUM_RELAY_ADAPT_CROSS_CONTRACT_CALLS_GAS_LIMIT_V2,\n  RelayAdaptShieldNFTRecipient,\n  TransactionStructV3,\n  MatrixContracts,\n  RelayAdaptV3Contract,\n} from '@matrix-privacy/engine';\nimport { gasEstimateResponseDummyProofIterativeBroadcasterFee } from './tx-gas-broadcaster-fee-estimator';\nimport { reportAndSanitizeError } from '../../utils/error';\nimport { ContractTransaction } from 'ethers';\nimport { isDecimalStr } from '../../utils';\nimport { bigIntStringToHex } from '../matrix/quick-sync/shared-formatters';\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: ByteUtils.hexlify(transactionRequest.data, true),\n      };\n      return transaction;\n    });\n  } catch (cause) {\n    if (!(cause instanceof Error)) {\n      throw new Error('Non-error thrown from createValidCrossContractCalls', {\n        cause,\n      });\n    }\n    throw reportAndSanitizeError(createValidCrossContractCalls.name, cause);\n  }\n};\n\nexport const createRelayAdaptUnshieldERC20AmountRecipients = (\n  networkName: NetworkName,\n  unshieldERC20Amounts: MatrixERC20Amount[],\n): MatrixERC20AmountRecipient[] => {\n  const chain = NETWORK_CONFIG[networkName].chain;\n  const relayAdaptContract =\n    MatrixContracts.getRelayAdaptContract(chain);\n  const unshieldERC20AmountRecipients: MatrixERC20AmountRecipient[] =\n    unshieldERC20Amounts.map(unshieldERC20Amount => ({\n      ...unshieldERC20Amount,\n      recipientAddress: relayAdaptContract.address,\n    }));\n  return unshieldERC20AmountRecipients;\n};\n\nexport const createRelayAdaptUnshieldNFTAmountRecipients = (\n  networkName: NetworkName,\n  unshieldNFTAmounts: MatrixNFTAmount[],\n): MatrixNFTAmountRecipient[] => {\n  const chain = NETWORK_CONFIG[networkName].chain;\n  const relayAdaptContract =\n    MatrixContracts.getRelayAdaptContract(chain);\n  const unshieldNFTAmountRecipients: MatrixNFTAmountRecipient[] =\n    unshieldNFTAmounts.map(unshieldNFTAmount => ({\n      ...unshieldNFTAmount,\n      recipientAddress: relayAdaptContract.address,\n    }));\n  return unshieldNFTAmountRecipients;\n};\n\nexport const createNFTTokenDataFromMatrixNFTAmount = (\n  nftAmount: MatrixNFTAmount,\n): NFTTokenData => {\n  const tokenSubIDHex = isDecimalStr(nftAmount.tokenSubID)\n    ? bigIntStringToHex(nftAmount.tokenSubID)\n    : nftAmount.tokenSubID;\n\n  return {\n    tokenAddress: ByteUtils.formatToByteLength(\n      nftAmount.nftAddress,\n      ByteLength.Address,\n      true,\n    ),\n    tokenType: nftAmount.nftTokenType as 1 | 2,\n    tokenSubID: ByteUtils.formatToByteLength(\n      tokenSubIDHex,\n      ByteLength.UINT_256,\n      true,\n    ),\n  };\n};\n\nconst createRelayAdaptShieldNFTRecipients = (\n  relayAdaptShieldNFTRecipients: MatrixNFTAmountRecipient[],\n): RelayAdaptShieldNFTRecipient[] => {\n  return relayAdaptShieldNFTRecipients.map(\n    (nftRecipient: MatrixNFTAmountRecipient) => ({\n      nftTokenData: createNFTTokenDataFromMatrixNFTAmount(nftRecipient),\n      recipientAddress: nftRecipient.recipientAddress,\n    }),\n  );\n};\n\nexport const populateProvedCrossContractCalls = async (\n  networkName: NetworkName,\n  matrixWalletID: string,\n  relayAdaptUnshieldERC20Amounts: MatrixERC20Amount[],\n  relayAdaptUnshieldNFTAmounts: MatrixNFTAmount[],\n  relayAdaptShieldERC20Recipients: MatrixERC20Recipient[],\n  relayAdaptShieldNFTRecipients: MatrixNFTAmountRecipient[],\n  crossContractCalls: ContractTransaction[],\n  broadcasterFeeERC20AmountRecipient: Optional<MatrixERC20AmountRecipient>,\n  sendWithPublicWallet: boolean,\n  overallBatchMinGasPrice: Optional<bigint>,\n  gasDetails: TransactionGasDetails,\n): Promise<MatrixPopulateTransactionResponse> => {\n  try {\n    const { transaction, nullifiers } =\n      await populateProvedTransaction(\n        networkName,\n        ProofType.CrossContractCalls,\n        matrixWalletID,\n        false, // showSenderAddressToRecipient\n        undefined, // memoText\n        [], // erc20AmountRecipients\n        [], // nftAmountRecipients\n        relayAdaptUnshieldERC20Amounts,\n        relayAdaptUnshieldNFTAmounts,\n        relayAdaptShieldERC20Recipients,\n        relayAdaptShieldNFTRecipients,\n        crossContractCalls,\n        broadcasterFeeERC20AmountRecipient,\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  matrixWalletID: string,\n  encryptionKey: string,\n  relayAdaptUnshieldERC20Amounts: MatrixERC20Amount[],\n  relayAdaptUnshieldNFTAmounts: MatrixNFTAmount[],\n  relayAdaptShieldERC20Recipients: MatrixERC20Recipient[],\n  relayAdaptShieldNFTRecipients: MatrixNFTAmountRecipient[],\n  crossContractCalls: ContractTransaction[],\n  originalGasDetails: TransactionGasDetails,\n  feeTokenDetails: Optional<FeeTokenDetails>,\n  sendWithPublicWallet: boolean,\n  minGasLimit: Optional<bigint>,\n): Promise<MatrixTransactionGasEstimateResponse> => {\n  try {\n    setCachedProvedTransaction(undefined);\n\n    const overallBatchMinGasPrice = 0n;\n\n    const validCrossContractCalls =\n      createValidCrossContractCalls(crossContractCalls);\n\n    const chain = NETWORK_CONFIG[networkName].chain;\n\n    const relayAdaptUnshieldERC20AmountRecipients: MatrixERC20AmountRecipient[] =\n      createRelayAdaptUnshieldERC20AmountRecipients(\n        networkName,\n        relayAdaptUnshieldERC20Amounts,\n      );\n    const relayAdaptUnshieldNFTAmountRecipients: MatrixNFTAmountRecipient[] =\n      createRelayAdaptUnshieldNFTAmountRecipients(\n        networkName,\n        relayAdaptUnshieldNFTAmounts,\n      );\n\n    const shieldRandom = ByteUtils.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_V2;\n\n    const relayAdaptContract = MatrixContracts.getRelayAdaptContract(chain);\n\n    const response = await gasEstimateResponseDummyProofIterativeBroadcasterFee(\n      (broadcasterFeeERC20Amount: Optional<MatrixERC20Amount>) =>\n        generateDummyProofTransactions(\n          ProofType.CrossContractCalls,\n          networkName,\n          matrixWalletID,\n          encryptionKey,\n          false, // showSenderAddressToRecipient\n          undefined, // memoText\n          relayAdaptUnshieldERC20AmountRecipients,\n          relayAdaptUnshieldNFTAmountRecipients,\n          broadcasterFeeERC20Amount,\n          sendWithPublicWallet,\n          overallBatchMinGasPrice,\n        ),\n      async (txs: TransactionStructV3[]) => {\n        const relayAdaptParamsRandom = ByteUtils.randomHex(31);\n\n        const transaction =\n          await relayAdaptContract.populateCrossContractCalls(\n            txs,\n            validCrossContractCalls,\n            relayShieldRequests,\n            relayAdaptParamsRandom,\n            true, // isGasEstimate\n            !sendWithPublicWallet, // isBroadcasterTransaction\n            minimumGasLimit,\n          );\n        // Remove gasLimit, we'll set to the minimum below.\n        delete transaction.gasLimit;\n        return transaction;\n      },\n      networkName,\n      matrixWalletID,\n      relayAdaptUnshieldERC20AmountRecipients,\n      originalGasDetails,\n      feeTokenDetails,\n      sendWithPublicWallet,\n      true, // isCrossContractCall\n    );\n\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\nexport const generateCrossContractCallsProof = async (\n  networkName: NetworkName,\n  matrixWalletID: string,\n  encryptionKey: string,\n  relayAdaptUnshieldERC20Amounts: MatrixERC20Amount[],\n  relayAdaptUnshieldNFTAmounts: MatrixNFTAmount[],\n  relayAdaptShieldERC20Recipients: MatrixERC20Recipient[],\n  relayAdaptShieldNFTRecipients: MatrixNFTAmountRecipient[],\n  crossContractCalls: ContractTransaction[],\n  broadcasterFeeERC20AmountRecipient: Optional<MatrixERC20AmountRecipient>,\n  sendWithPublicWallet: boolean,\n  overallBatchMinGasPrice: Optional<bigint>,\n  minGasLimit: Optional<bigint>,\n  progressCallback: GenerateTransactionsProgressCallback,\n): Promise<void> => {\n  try {\n    setCachedProvedTransaction(undefined);\n\n    const validCrossContractCalls =\n      createValidCrossContractCalls(crossContractCalls);\n\n    const relayAdaptUnshieldERC20AmountRecipients: MatrixERC20AmountRecipient[] =\n      createRelayAdaptUnshieldERC20AmountRecipients(\n        networkName,\n        relayAdaptUnshieldERC20Amounts,\n      );\n    const relayAdaptUnshieldNFTAmountRecipients: MatrixNFTAmountRecipient[] =\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      matrixWalletID,\n      encryptionKey,\n      false, // showSenderAddressToRecipient\n      undefined, // memoText\n      relayAdaptUnshieldERC20AmountRecipients,\n      relayAdaptUnshieldNFTAmountRecipients,\n      broadcasterFeeERC20AmountRecipient,\n      sendWithPublicWallet,\n      overallBatchMinGasPrice,\n    );\n\n    // Generate relay adapt params from dummy transactions.\n    const shieldRandom = ByteUtils.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_V2;\n\n    const { chain } = NETWORK_CONFIG[networkName];\n\n    const isBroadcasterTransaction = !sendWithPublicWallet;\n    const relayAdaptParamsRandom = ByteUtils.randomHex(31);\n    const relayAdaptContract = MatrixContracts.getRelayAdaptContract(chain);\n    const relayAdaptParams =\n      await relayAdaptContract.getRelayAdaptParamsCrossContractCalls(\n        dummyUnshieldTxs,\n        validCrossContractCalls,\n        relayShieldRequests,\n        relayAdaptParamsRandom,\n        isBroadcasterTransaction,\n        minimumGasLimit,\n      );\n\n    // Create real transactions with relay adapt params.\n    const { provedTransactions } =\n      await generateProofTransactions(\n        ProofType.CrossContractCalls,\n        networkName,\n        matrixWalletID,\n        encryptionKey,\n        false, // showSenderAddressToRecipient\n        undefined, // memoText\n        relayAdaptUnshieldERC20AmountRecipients,\n        relayAdaptUnshieldNFTAmountRecipients,\n        broadcasterFeeERC20AmountRecipient,\n        sendWithPublicWallet,\n        false, // useDummyProof\n        overallBatchMinGasPrice,\n        progressCallback,\n      );\n\n    const nullifiers = nullifiersForTransactions(provedTransactions);\n\n    const transaction =\n      await relayAdaptContract.populateCrossContractCalls(\n        provedTransactions,\n        validCrossContractCalls,\n        relayShieldRequests,\n        relayAdaptParamsRandom,\n        false, // isGasEstimate\n        isBroadcasterTransaction,\n        minimumGasLimit,\n      );\n    delete transaction.from;\n\n    setCachedProvedTransaction({\n      proofType: ProofType.CrossContractCalls,\n      matrixWalletID,\n      showSenderAddressToRecipient: false,\n      memoText: undefined,\n      erc20AmountRecipients: [],\n      nftAmountRecipients: [],\n      relayAdaptUnshieldERC20Amounts,\n      relayAdaptUnshieldNFTAmounts,\n      relayAdaptShieldERC20Recipients,\n      relayAdaptShieldNFTRecipients,\n      crossContractCalls: validCrossContractCalls,\n      broadcasterFeeERC20AmountRecipient,\n      sendWithPublicWallet,\n      transaction,\n      overallBatchMinGasPrice,\n      nullifiers,\n    });\n  } catch (err) {\n    throw reportAndSanitizeError(generateCrossContractCallsProof.name, err);\n  }\n};\n\nexport const getRelayAdaptTransactionError = (\n  networkName: NetworkName,\n  receiptLogs: TransactionReceiptLog[],\n): Optional<string> => {\n  try {\n    const relayAdaptError = RelayAdaptV3Contract.getRelayAdaptCallError(\n      receiptLogs,\n    );\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 = (\n  networkName: NetworkName,\n  data: string,\n): Optional<string> => {\n  try {\n    const relayAdaptErrorParsed = RelayAdaptV3Contract.parseRelayAdaptReturnValue(\n      data,\n    );\n    if (isDefined(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-broadcaster-fee-estimator.d.ts

@@ -0,0 +1,5 @@
+import { TransactionStructV3 } from '@matrix-privacy/engine';
+import { NetworkName, TransactionGasDetails, MatrixERC20Amount, MatrixTransactionGasEstimateResponse, FeeTokenDetails, MatrixERC20AmountRecipient } from '@matrix-privacy/shared-models';
+import { ContractTransaction } from 'ethers';
+export declare const calculateBroadcasterFeeERC20Amount: (feeTokenDetails: FeeTokenDetails, gasDetails: TransactionGasDetails) => MatrixERC20Amount;
+export declare const gasEstimateResponseDummyProofIterativeBroadcasterFee: (generateDummyTransactionStructsWithBroadcasterFee: (broadcasterFeeERC20Amount: Optional<MatrixERC20Amount>) => Promise<TransactionStructV3[]>, generateTransaction: (serializedTransactions: TransactionStructV3[]) => Promise<ContractTransaction>, networkName: NetworkName, matrixWalletID: string, erc20AmountRecipients: MatrixERC20AmountRecipient[], originalGasDetails: TransactionGasDetails, feeTokenDetails: Optional<FeeTokenDetails>, sendWithPublicWallet: boolean, isCrossContractCall: boolean) => Promise<MatrixTransactionGasEstimateResponse>;

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

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gasEstimateResponseDummyProofIterativeBroadcasterFee = exports.calculateBroadcasterFeeERC20Amount = void 0;
+const engine_1 = require("@matrix-privacy/engine");
+const shared_models_1 = require("@matrix-privacy/shared-models");
+const tx_generator_1 = require("./tx-generator");
+const tx_gas_details_1 = require("./tx-gas-details");
+const balance_update_1 = require("../matrix/wallets/balance-update");
+const wallets_1 = require("../matrix/wallets/wallets");
+const MAX_ITERATIONS_BROADCASTER_FEE_REESTIMATION = 5;
+const calculateBroadcasterFeeERC20Amount = (feeTokenDetails, gasDetails) => {
+    const tokenFeePerUnitGas = BigInt(feeTokenDetails.feePerUnitGas);
+    const oneUnitGas = 10n ** 18n;
+    const maximumGas = (0, shared_models_1.calculateMaximumGas)(gasDetails);
+    const tokenFee = (tokenFeePerUnitGas * maximumGas) / oneUnitGas;
+    return {
+        tokenAddress: feeTokenDetails.tokenAddress,
+        amount: tokenFee,
+    };
+};
+exports.calculateBroadcasterFeeERC20Amount = calculateBroadcasterFeeERC20Amount;
+const getBroadcasterFeeCommitment = (transactionStructs) => {
+    const transactionIndex = 0;
+    const broadcasterFeeCommitment = transactionStructs[transactionIndex];
+    const broadcasterFeeCommitmentIndex = 0;
+    return (0, engine_1.convertTransactionStructToCommitmentSummary)(broadcasterFeeCommitment, broadcasterFeeCommitmentIndex);
+};
+const gasEstimateResponseDummyProofIterativeBroadcasterFee = async (generateDummyTransactionStructsWithBroadcasterFee, generateTransaction, networkName, matrixWalletID, erc20AmountRecipients, originalGasDetails, feeTokenDetails, sendWithPublicWallet, isCrossContractCall) => {
+    const wallet = (0, wallets_1.walletForID)(matrixWalletID);
+    // Use dead address for private transaction gas estimate
+    const fromWalletAddress = tx_generator_1.DUMMY_FROM_ADDRESS;
+    const isGasEstimateWithDummyProof = true;
+    const dummyBroadcasterFee = feeTokenDetails
+        ? (0, tx_generator_1.createDummyBroadcasterFeeERC20Amount)(feeTokenDetails.tokenAddress)
+        : undefined;
+    let serializedTransactions = await generateDummyTransactionStructsWithBroadcasterFee(dummyBroadcasterFee);
+    let transaction = await generateTransaction(serializedTransactions);
+    let gasEstimate = await (0, tx_gas_details_1.getGasEstimate)(networkName, transaction, fromWalletAddress, sendWithPublicWallet, isCrossContractCall);
+    if (sendWithPublicWallet) {
+        return (0, tx_gas_details_1.gasEstimateResponse)(gasEstimate, undefined, // broadcasterFeeCommitment
+        isGasEstimateWithDummyProof);
+    }
+    if (!feeTokenDetails) {
+        throw new Error('Must have Broadcaster Fee details or sendWithPublicWallet field.');
+    }
+    // Find any erc20Amount in transfer that matches token of broadcaster fee, if exists.
+    const broadcasterFeeMatchingSendingERC20Amount = erc20AmountRecipients.find(erc20AmountRecipient => erc20AmountRecipient.tokenAddress.toLowerCase() ===
+        feeTokenDetails.tokenAddress.toLowerCase());
+    // Get private balance of matching token.
+    const balanceForBroadcasterFeeERC20 = await (0, balance_update_1.balanceForERC20Token)(wallet, networkName, feeTokenDetails.tokenAddress, true);
+    let broadcasterFeeCommitment = getBroadcasterFeeCommitment(serializedTransactions);
+    // Iteratively calculate new broadcaster fee and estimate new gas amount.
+    // This change if the number of circuits changes because of the additional Broadcaster Fees.
+    for (let i = 0; i < MAX_ITERATIONS_BROADCASTER_FEE_REESTIMATION; i += 1) {
+        const updatedGasDetails = {
+            ...originalGasDetails,
+            gasEstimate,
+        };
+        const updatedBroadcasterFee = (0, exports.calculateBroadcasterFeeERC20Amount)(feeTokenDetails, updatedGasDetails);
+        // If Broadcaster fee causes overflow with the token balance,
+        // then use the MAX amount for Broadcaster Fee, which is BALANCE - SENDING AMOUNT.
+        if (balanceForBroadcasterFeeERC20 > 0n &&
+            broadcasterFeeMatchingSendingERC20Amount &&
+            // eslint-disable-next-line no-await-in-loop
+            (await broadcasterFeeWillOverflowBalance(balanceForBroadcasterFeeERC20, broadcasterFeeMatchingSendingERC20Amount, updatedBroadcasterFee))) {
+            updatedBroadcasterFee.amount =
+                balanceForBroadcasterFeeERC20 -
+                    broadcasterFeeMatchingSendingERC20Amount.amount;
+        }
+        const newSerializedTransactions = 
+        // eslint-disable-next-line no-await-in-loop
+        await generateDummyTransactionStructsWithBroadcasterFee(updatedBroadcasterFee);
+        broadcasterFeeCommitment = getBroadcasterFeeCommitment(newSerializedTransactions);
+        if (compareCircuitSizesTransactionStructs(newSerializedTransactions, serializedTransactions)) {
+            // Same circuit sizes, no need to run further gas estimates.
+            return (0, tx_gas_details_1.gasEstimateResponse)(gasEstimate, broadcasterFeeCommitment, 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, broadcasterFeeCommitment, isGasEstimateWithDummyProof);
+        }
+        gasEstimate = newGasEstimate;
+    }
+    return (0, tx_gas_details_1.gasEstimateResponse)(gasEstimate, broadcasterFeeCommitment, isGasEstimateWithDummyProof);
+};
+exports.gasEstimateResponseDummyProofIterativeBroadcasterFee = gasEstimateResponseDummyProofIterativeBroadcasterFee;
+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;
+};
+const broadcasterFeeWillOverflowBalance = async (tokenBalance, sendingERC20Amount, broadcasterFeeERC20Amount) => {
+    const sendingAmount = sendingERC20Amount.amount;
+    const broadcasterFeeAmount = broadcasterFeeERC20Amount.amount;
+    return sendingAmount + broadcasterFeeAmount > tokenBalance;
+};
+//# sourceMappingURL=tx-gas-broadcaster-fee-estimator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tx-gas-broadcaster-fee-estimator.js","sourceRoot":"","sources":["../../../src/services/transactions/tx-gas-broadcaster-fee-estimator.ts"],"names":[],"mappings":";;;AAAA,mDAGgC;AAChC,iEASuC;AACvC,iDAGwB;AACxB,qDAAuE;AACvE,qEAAwE;AAExE,uDAAwD;AAExD,MAAM,2CAA2C,GAAG,CAAC,CAAC;AAE/C,MAAM,kCAAkC,GAAG,CAChD,eAAgC,EAChC,UAAiC,EACd,EAAE;IACrB,MAAM,kBAAkB,GAAG,MAAM,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,UAAU,GAAG,GAAG,IAAI,GAAG,CAAC;IAC9B,MAAM,UAAU,GAAG,IAAA,mCAAmB,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,kCAAkC,sCAY7C;AAEF,MAAM,2BAA2B,GAAG,CAClC,kBAAyC,EACtB,EAAE;IACrB,MAAM,gBAAgB,GAAG,CAAC,CAAC;IAC3B,MAAM,wBAAwB,GAAG,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;IACtE,MAAM,6BAA6B,GAAG,CAAC,CAAC;IACxC,OAAO,IAAA,oDAA2C,EAChD,wBAAwB,EACxB,6BAA6B,CAC9B,CAAC;AACJ,CAAC,CAAC;AAEK,MAAM,oDAAoD,GAAG,KAAK,EACvE,iDAEmC,EACnC,mBAEiC,EACjC,WAAwB,EACxB,cAAsB,EACtB,qBAAmD,EACnD,kBAAyC,EACzC,eAA0C,EAC1C,oBAA6B,EAC7B,mBAA4B,EACmB,EAAE;IACjD,MAAM,MAAM,GAAG,IAAA,qBAAW,EAAC,cAAc,CAAC,CAAC;IAE3C,wDAAwD;IACxD,MAAM,iBAAiB,GAAG,iCAAkB,CAAC;IAE7C,MAAM,2BAA2B,GAAG,IAAI,CAAC;IAEzC,MAAM,mBAAmB,GAAG,eAAe;QACzC,CAAC,CAAC,IAAA,mDAAoC,EAAC,eAAe,CAAC,YAAY,CAAC;QACpE,CAAC,CAAC,SAAS,CAAC;IAEd,IAAI,sBAAsB,GACxB,MAAM,iDAAiD,CACrD,mBAAmB,CACpB,CAAC;IACJ,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;IAEF,IAAI,oBAAoB,EAAE;QACxB,OAAO,IAAA,oCAAmB,EACxB,WAAW,EACX,SAAS,EAAE,2BAA2B;QACtC,2BAA2B,CAC5B,CAAC;KACH;IAED,IAAI,CAAC,eAAe,EAAE;QACpB,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAC;KACH;IAED,qFAAqF;IACrF,MAAM,wCAAwC,GAAG,qBAAqB,CAAC,IAAI,CACzE,oBAAoB,CAAC,EAAE,CACrB,oBAAoB,CAAC,YAAY,CAAC,WAAW,EAAE;QAC/C,eAAe,CAAC,YAAY,CAAC,WAAW,EAAE,CAC7C,CAAC;IAEF,yCAAyC;IACzC,MAAM,6BAA6B,GAAG,MAAM,IAAA,qCAAoB,EAC9D,MAAM,EACN,WAAW,EACX,eAAe,CAAC,YAAY,EAC5B,IAAI,CACL,CAAC;IAEF,IAAI,wBAAwB,GAAG,2BAA2B,CACxD,sBAAsB,CACvB,CAAC;IAEF,yEAAyE;IACzE,4FAA4F;IAC5F,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,2CAA2C,EAAE,CAAC,IAAI,CAAC,EAAE;QACvE,MAAM,iBAAiB,GAA0B;YAC/C,GAAG,kBAAkB;YACrB,WAAW;SACZ,CAAC;QACF,MAAM,qBAAqB,GACzB,IAAA,0CAAkC,EAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC;QAEzE,6DAA6D;QAC7D,kFAAkF;QAClF,IACE,6BAA6B,GAAG,EAAE;YAClC,wCAAwC;YACxC,4CAA4C;YAC5C,CAAC,MAAM,iCAAiC,CACtC,6BAA6B,EAC7B,wCAAwC,EACxC,qBAAqB,CACtB,CAAC,EACF;YACA,qBAAqB,CAAC,MAAM;gBAC1B,6BAA6B;oBAC7B,wCAAwC,CAAC,MAAM,CAAC;SACnD;QAED,MAAM,yBAAyB;QAC7B,4CAA4C;QAC5C,MAAM,iDAAiD,CACrD,qBAAqB,CACtB,CAAC;QAEJ,wBAAwB,GAAG,2BAA2B,CACpD,yBAAyB,CAC1B,CAAC;QAEF,IACE,qCAAqC,CACnC,yBAAyB,EACzB,sBAAsB,CACvB,EACD;YACA,4DAA4D;YAC5D,OAAO,IAAA,oCAAmB,EACxB,WAAW,EACX,wBAAwB,EACxB,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,wBAAwB,EACxB,2BAA2B,CAC5B,CAAC;SACH;QACD,WAAW,GAAG,cAAc,CAAC;KAC9B;IAED,OAAO,IAAA,oCAAmB,EACxB,WAAW,EACX,wBAAwB,EACxB,2BAA2B,CAC5B,CAAC;AACJ,CAAC,CAAC;AAzJW,QAAA,oDAAoD,wDAyJ/D;AAEF,MAAM,qCAAqC,GAAG,CAC5C,WAAkC,EAClC,WAAkC,EAClC,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,iCAAiC,GAAG,KAAK,EAC7C,YAAoB,EACpB,kBAAqC,EACrC,yBAA4C,EAC5C,EAAE;IACF,MAAM,aAAa,GAAG,kBAAkB,CAAC,MAAM,CAAC;IAChD,MAAM,oBAAoB,GAAG,yBAAyB,CAAC,MAAM,CAAC;IAE9D,OAAO,aAAa,GAAG,oBAAoB,GAAG,YAAY,CAAC;AAC7D,CAAC,CAAC","sourcesContent":["import {\n  TransactionStructV3,\n  convertTransactionStructToCommitmentSummary,\n} from '@matrix-privacy/engine';\nimport {\n  NetworkName,\n  TransactionGasDetails,\n  MatrixERC20Amount,\n  MatrixTransactionGasEstimateResponse,\n  FeeTokenDetails,\n  calculateMaximumGas,\n  MatrixERC20AmountRecipient,\n  CommitmentSummary,\n} from '@matrix-privacy/shared-models';\nimport {\n  DUMMY_FROM_ADDRESS,\n  createDummyBroadcasterFeeERC20Amount,\n} from './tx-generator';\nimport { getGasEstimate, gasEstimateResponse } from './tx-gas-details';\nimport { balanceForERC20Token } from '../matrix/wallets/balance-update';\nimport { ContractTransaction } from 'ethers';\nimport { walletForID } from '../matrix/wallets/wallets';\n\nconst MAX_ITERATIONS_BROADCASTER_FEE_REESTIMATION = 5;\n\nexport const calculateBroadcasterFeeERC20Amount = (\n  feeTokenDetails: FeeTokenDetails,\n  gasDetails: TransactionGasDetails,\n): MatrixERC20Amount => {\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 getBroadcasterFeeCommitment = (\n  transactionStructs: TransactionStructV3[],\n): CommitmentSummary => {\n  const transactionIndex = 0;\n  const broadcasterFeeCommitment = transactionStructs[transactionIndex];\n  const broadcasterFeeCommitmentIndex = 0;\n  return convertTransactionStructToCommitmentSummary(\n    broadcasterFeeCommitment,\n    broadcasterFeeCommitmentIndex,\n  );\n};\n\nexport const gasEstimateResponseDummyProofIterativeBroadcasterFee = async (\n  generateDummyTransactionStructsWithBroadcasterFee: (\n    broadcasterFeeERC20Amount: Optional<MatrixERC20Amount>,\n  ) => Promise<TransactionStructV3[]>,\n  generateTransaction: (\n    serializedTransactions: TransactionStructV3[],\n  ) => Promise<ContractTransaction>,\n  networkName: NetworkName,\n  matrixWalletID: string,\n  erc20AmountRecipients: MatrixERC20AmountRecipient[],\n  originalGasDetails: TransactionGasDetails,\n  feeTokenDetails: Optional<FeeTokenDetails>,\n  sendWithPublicWallet: boolean,\n  isCrossContractCall: boolean,\n): Promise<MatrixTransactionGasEstimateResponse> => {\n  const wallet = walletForID(matrixWalletID);\n\n  // Use dead address for private transaction gas estimate\n  const fromWalletAddress = DUMMY_FROM_ADDRESS;\n\n  const isGasEstimateWithDummyProof = true;\n\n  const dummyBroadcasterFee = feeTokenDetails\n    ? createDummyBroadcasterFeeERC20Amount(feeTokenDetails.tokenAddress)\n    : undefined;\n\n  let serializedTransactions =\n    await generateDummyTransactionStructsWithBroadcasterFee(\n      dummyBroadcasterFee,\n    );\n  let transaction = await generateTransaction(serializedTransactions);\n\n  let gasEstimate = await getGasEstimate(\n    networkName,\n    transaction,\n    fromWalletAddress,\n    sendWithPublicWallet,\n    isCrossContractCall,\n  );\n\n  if (sendWithPublicWallet) {\n    return gasEstimateResponse(\n      gasEstimate,\n      undefined, // broadcasterFeeCommitment\n      isGasEstimateWithDummyProof,\n    );\n  }\n\n  if (!feeTokenDetails) {\n    throw new Error(\n      'Must have Broadcaster Fee details or sendWithPublicWallet field.',\n    );\n  }\n\n  // Find any erc20Amount in transfer that matches token of broadcaster fee, if exists.\n  const broadcasterFeeMatchingSendingERC20Amount = erc20AmountRecipients.find(\n    erc20AmountRecipient =>\n      erc20AmountRecipient.tokenAddress.toLowerCase() ===\n      feeTokenDetails.tokenAddress.toLowerCase(),\n  );\n\n  // Get private balance of matching token.\n  const balanceForBroadcasterFeeERC20 = await balanceForERC20Token(\n    wallet,\n    networkName,\n    feeTokenDetails.tokenAddress,\n    true,\n  );\n\n  let broadcasterFeeCommitment = getBroadcasterFeeCommitment(\n    serializedTransactions,\n  );\n\n  // Iteratively calculate new broadcaster fee and estimate new gas amount.\n  // This change if the number of circuits changes because of the additional Broadcaster Fees.\n  for (let i = 0; i < MAX_ITERATIONS_BROADCASTER_FEE_REESTIMATION; i += 1) {\n    const updatedGasDetails: TransactionGasDetails = {\n      ...originalGasDetails,\n      gasEstimate,\n    };\n    const updatedBroadcasterFee: MatrixERC20Amount =\n      calculateBroadcasterFeeERC20Amount(feeTokenDetails, updatedGasDetails);\n\n    // If Broadcaster fee causes overflow with the token balance,\n    // then use the MAX amount for Broadcaster Fee, which is BALANCE - SENDING AMOUNT.\n    if (\n      balanceForBroadcasterFeeERC20 > 0n &&\n      broadcasterFeeMatchingSendingERC20Amount &&\n      // eslint-disable-next-line no-await-in-loop\n      (await broadcasterFeeWillOverflowBalance(\n        balanceForBroadcasterFeeERC20,\n        broadcasterFeeMatchingSendingERC20Amount,\n        updatedBroadcasterFee,\n      ))\n    ) {\n      updatedBroadcasterFee.amount =\n        balanceForBroadcasterFeeERC20 -\n        broadcasterFeeMatchingSendingERC20Amount.amount;\n    }\n\n    const newSerializedTransactions =\n      // eslint-disable-next-line no-await-in-loop\n      await generateDummyTransactionStructsWithBroadcasterFee(\n        updatedBroadcasterFee,\n      );\n\n    broadcasterFeeCommitment = getBroadcasterFeeCommitment(\n      newSerializedTransactions,\n    );\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        broadcasterFeeCommitment,\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        broadcasterFeeCommitment,\n        isGasEstimateWithDummyProof,\n      );\n    }\n    gasEstimate = newGasEstimate;\n  }\n\n  return gasEstimateResponse(\n    gasEstimate,\n    broadcasterFeeCommitment,\n    isGasEstimateWithDummyProof,\n  );\n};\n\nconst compareCircuitSizesTransactionStructs = (\n  serializedA: TransactionStructV3[],\n  serializedB: TransactionStructV3[],\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 broadcasterFeeWillOverflowBalance = async (\n  tokenBalance: bigint,\n  sendingERC20Amount: MatrixERC20Amount,\n  broadcasterFeeERC20Amount: MatrixERC20Amount,\n) => {\n  const sendingAmount = sendingERC20Amount.amount;\n  const broadcasterFeeAmount = broadcasterFeeERC20Amount.amount;\n\n  return sendingAmount + broadcasterFeeAmount > tokenBalance;\n};\n"]}

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

@@ -0,0 +1,5 @@
+import { MatrixTransactionGasEstimateResponse, NetworkName, TransactionGasDetails } from '@matrix-privacy/shared-models';
+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, _broadcasterFeeCommitment: unknown, isGasEstimateWithDummyProof: boolean) => MatrixTransactionGasEstimateResponse;
+export declare const setGasDetailsForTransaction: (networkName: NetworkName, transaction: ContractTransaction, gasDetails: TransactionGasDetails, sendWithPublicWallet: boolean) => void;

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

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setGasDetailsForTransaction = exports.gasEstimateResponse = exports.getGasEstimate = void 0;
+const shared_models_1 = require("@matrix-privacy/shared-models");
+const matrix_1 = require("../matrix");
+const error_1 = require("../../utils/error");
+const engine_1 = require("@matrix-privacy/engine");
+const getGasEstimate = async (networkName, transaction, fromWalletAddress, sendWithPublicWallet, isCrossContractCall) => {
+    const evmGasType = (0, shared_models_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,
+    };
+    if (shouldRemoveGasLimitForL2GasEstimate(networkName)) {
+        delete estimateGasTransactionRequest.gasLimit;
+    }
+    try {
+        return estimateGas(networkName, estimateGasTransactionRequest, isCrossContractCall);
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.getGasEstimate.name, err);
+    }
+};
+exports.getGasEstimate = getGasEstimate;
+const estimateGas = (networkName, transaction, isCrossContractCall) => {
+    const provider = (0, matrix_1.getFallbackProviderForNetwork)(networkName);
+    if (isCrossContractCall) {
+        // Includes custom error handler for relay-adapt transactions.
+        return engine_1.RelayAdaptV3Contract.estimateGasWithErrorHandler(provider, transaction);
+    }
+    return provider.estimateGas(transaction);
+};
+/**
+ * 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 Matrix Engine.
+ */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const shouldRemoveGasLimitForL2GasEstimate = (_networkName) => {
+    // Matrix currently only supports Hardhat; add L2 logic here as networks are added.
+    return false;
+};
+const gasEstimateResponse = (gasEstimate, _broadcasterFeeCommitment, 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(engine_1.GAS_ESTIMATE_VARIANCE_DUMMY_TO_ACTUAL_TRANSACTION)
+        : gasEstimate;
+    const response = {
+        gasEstimate: gasEstimateWithDummyProofVariance,
+    };
+    return response;
+};
+exports.gasEstimateResponse = gasEstimateResponse;
+const setGasDetailsForTransaction = (networkName, transaction, gasDetails, sendWithPublicWallet) => {
+    const { gasEstimate } = gasDetails;
+    // eslint-disable-next-line no-param-reassign
+    transaction.gasLimit = (0, shared_models_1.calculateGasLimit)(gasEstimate);
+    const evmGasType = (0, shared_models_1.getEVMGasTypeForTransaction)(networkName, sendWithPublicWallet);
+    if (gasDetails.evmGasType !== evmGasType) {
+        const transactionType = sendWithPublicWallet
+            ? 'self-signed'
+            : 'Broadcaster';
+        throw new Error(`Invalid evmGasType for ${networkName} (${transactionType}): expected Type${evmGasType}, received Type${gasDetails.evmGasType} in gasDetails. Retrieve appropriate gas type with getEVMGasTypeForTransaction (@matrix-privacy/shared-models).`);
+    }
+    // eslint-disable-next-line no-param-reassign
+    transaction.type = gasDetails.evmGasType;
+    switch (gasDetails.evmGasType) {
+        case shared_models_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 shared_models_1.EVMGasType.Type1: {
+            // eslint-disable-next-line no-param-reassign
+            transaction.gasPrice = gasDetails.gasPrice;
+            break;
+        }
+        case shared_models_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;
+        }
+        case shared_models_1.EVMGasType.Type4: {
+            // EIP-7702 transaction type — handle like Type2 for gas purposes.
+            // 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,iEAQuC;AACvC,sCAA0D;AAC1D,6CAA2D;AAC3D,mDAGgC;AAGzB,MAAM,cAAc,GAAG,KAAK,EACjC,WAAwB,EACxB,WAAgC,EAChC,iBAAyB,EACzB,oBAA6B,EAC7B,mBAA4B,EACX,EAAE;IACnB,MAAM,UAAU,GAAG,IAAA,2CAA2B,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,IAAI,oCAAoC,CAAC,WAAW,CAAC,EAAE;QACrD,OAAO,6BAA6B,CAAC,QAAQ,CAAC;KAC/C;IAED,IAAI;QACF,OAAO,WAAW,CAChB,WAAW,EACX,6BAA6B,EAC7B,mBAAmB,CACpB,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,sBAAc,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KACxD;AACH,CAAC,CAAC;AAhCW,QAAA,cAAc,kBAgCzB;AAEF,MAAM,WAAW,GAAG,CAClB,WAAwB,EACxB,WAAgC,EAChC,mBAA4B,EACX,EAAE;IACnB,MAAM,QAAQ,GAAG,IAAA,sCAA6B,EAAC,WAAW,CAAC,CAAC;IAC5D,IAAI,mBAAmB,EAAE;QACvB,8DAA8D;QAC9D,OAAO,6BAAoB,CAAC,2BAA2B,CACrD,QAAQ,EACR,WAAW,CACZ,CAAC;KACH;IACD,OAAO,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF;;;GAGG;AACH,6DAA6D;AAC7D,MAAM,oCAAoC,GAAG,CAAC,YAAyB,EAAE,EAAE;IACzE,mFAAmF;IACnF,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEK,MAAM,mBAAmB,GAAG,CACjC,WAAmB,EACnB,yBAAkC,EAClC,2BAAoC,EACE,EAAE;IACxC,gDAAgD;IAChD,iEAAiE;IACjE,MAAM,iCAAiC,GAAG,2BAA2B;QACnE,CAAC,CAAC,WAAW,GAAG,MAAM,CAAC,0DAAiD,CAAC;QACzE,CAAC,CAAC,WAAW,CAAC;IAEhB,MAAM,QAAQ,GAAyC;QACrD,WAAW,EAAE,iCAAiC;KAC/C,CAAC;IACF,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAfW,QAAA,mBAAmB,uBAe9B;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,iCAAiB,EAAC,WAAW,CAAC,CAAC;IAEtD,MAAM,UAAU,GAAG,IAAA,2CAA2B,EAC5C,WAAW,EACX,oBAAoB,CACrB,CAAC;IAEF,IAAI,UAAU,CAAC,UAAU,KAAK,UAAU,EAAE;QACxC,MAAM,eAAe,GAAG,oBAAoB;YAC1C,CAAC,CAAC,aAAa;YACf,CAAC,CAAC,aAAa,CAAC;QAClB,MAAM,IAAI,KAAK,CACb,0BAA0B,WAAW,KAAK,eAAe,mBAAmB,UAAU,kBAAkB,UAAU,CAAC,UAAU,iHAAiH,CAC/O,CAAC;KACH;IAED,6CAA6C;IAC7C,WAAW,CAAC,IAAI,GAAG,UAAU,CAAC,UAAU,CAAC;IAEzC,QAAQ,UAAU,CAAC,UAAU,EAAE;QAC7B,KAAK,0BAAU,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,0BAAU,CAAC,KAAK,CAAC,CAAC;YACrB,6CAA6C;YAC7C,WAAW,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;YAC3C,MAAM;SACP;QACD,KAAK,0BAAU,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;QACD,KAAK,0BAAU,CAAC,KAAK,CAAC,CAAC;YACrB,kEAAkE;YAClE,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;AAzDW,QAAA,2BAA2B,+BAyDtC","sourcesContent":["import {\n  MatrixTransactionGasEstimateResponse,\n  EVMGasType,\n  calculateGasLimit,\n  NetworkName,\n  getEVMGasTypeForTransaction,\n  TransactionGasDetails,\n  NETWORK_CONFIG,\n} from '@matrix-privacy/shared-models';\nimport { getFallbackProviderForNetwork } from '../matrix';\nimport { reportAndSanitizeError } from '../../utils/error';\nimport {\n  GAS_ESTIMATE_VARIANCE_DUMMY_TO_ACTUAL_TRANSACTION,\n  RelayAdaptV3Contract,\n} from '@matrix-privacy/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  if (shouldRemoveGasLimitForL2GasEstimate(networkName)) {\n    delete estimateGasTransactionRequest.gasLimit;\n  }\n\n  try {\n    return estimateGas(\n      networkName,\n      estimateGasTransactionRequest,\n      isCrossContractCall,\n    );\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  if (isCrossContractCall) {\n    // Includes custom error handler for relay-adapt transactions.\n    return RelayAdaptV3Contract.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 Matrix Engine.\n */\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nconst shouldRemoveGasLimitForL2GasEstimate = (_networkName: NetworkName) => {\n  // Matrix currently only supports Hardhat; add L2 logic here as networks are added.\n  return false;\n};\n\nexport const gasEstimateResponse = (\n  gasEstimate: bigint,\n  _broadcasterFeeCommitment: unknown,\n  isGasEstimateWithDummyProof: boolean,\n): MatrixTransactionGasEstimateResponse => {\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  const response: MatrixTransactionGasEstimateResponse = {\n    gasEstimate: gasEstimateWithDummyProofVariance,\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\n      ? 'self-signed'\n      : 'Broadcaster';\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 (@matrix-privacy/shared-models).`,\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    case EVMGasType.Type4: {\n      // EIP-7702 transaction type — handle like Type2 for gas purposes.\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-generator.d.ts

@@ -0,0 +1,13 @@
+import { TransactionStructV3 } from '@matrix-privacy/engine';
+import { MatrixERC20Amount, MatrixERC20AmountRecipient, NetworkName, ProofType, MatrixNFTAmountRecipient } from '@matrix-privacy/shared-models';
+import { ContractTransaction } from 'ethers';
+export declare const DUMMY_FROM_ADDRESS = "0x000000000000000000000000000000000000dEaD";
+export type GenerateTransactionsProgressCallback = (progress: number, status: string) => void;
+export declare const generateProofTransactions: (proofType: ProofType, networkName: NetworkName, matrixWalletID: string, encryptionKey: string, showSenderAddressToRecipient: boolean, memoText: Optional<string>, erc20AmountRecipients: MatrixERC20AmountRecipient[], nftAmountRecipients: MatrixNFTAmountRecipient[], broadcasterFeeERC20AmountRecipient: Optional<MatrixERC20AmountRecipient>, sendWithPublicWallet: boolean, useDummyProof: boolean, overallBatchMinGasPrice: Optional<bigint>, progressCallback: GenerateTransactionsProgressCallback, originShieldTxidForSpendabilityOverride?: string) => Promise<{
+    provedTransactions: TransactionStructV3[];
+}>;
+export declare const nullifiersForTransactions: (transactions: TransactionStructV3[]) => string[];
+export declare const createDummyBroadcasterFeeERC20Amount: (feeTokenAddress: string) => MatrixERC20Amount;
+export declare const generateDummyProofTransactions: (proofType: ProofType, networkName: NetworkName, matrixWalletID: string, encryptionKey: string, showSenderAddressToRecipient: boolean, memoText: Optional<string>, erc20AmountRecipients: MatrixERC20AmountRecipient[], nftAmountRecipients: MatrixNFTAmountRecipient[], broadcasterFeeERC20Amount: Optional<MatrixERC20Amount>, sendWithPublicWallet: boolean, overallBatchMinGasPrice: Optional<bigint>, originShieldTxidForSpendabilityOverride?: string) => Promise<TransactionStructV3[]>;
+export declare const generateTransact: (txs: TransactionStructV3[], networkName: NetworkName, useDummyProof?: boolean) => Promise<ContractTransaction>;
+export declare const generateUnshieldBaseToken: (txs: TransactionStructV3[], networkName: NetworkName, toWalletAddress: string, relayAdaptParamsRandom: string, useDummyProof: boolean | undefined, sendWithPublicWallet: boolean) => Promise<ContractTransaction>;