@matrix-privacy/wallet 0.0.1

package/dist/services/transactions/tx-proof-unshield.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tx-proof-unshield.js","sourceRoot":"","sources":["../../../src/services/transactions/tx-proof-unshield.ts"],"names":[],"mappings":";;;AAAA,iEAOuC;AACvC,iDAOwB;AACxB,uDAAkE;AAClE,+CAA2D;AAC3D,mDAGgC;AAChC,uEAA0F;AAC1F,6CAA2D;AAEpD,MAAM,qBAAqB,GAAG,KAAK,EACxC,WAAwB,EACxB,cAAsB,EACtB,aAAqB,EACrB,qBAAmD,EACnD,mBAA+C,EAC/C,kCAAwE,EACxE,oBAA6B,EAC7B,uBAAyC,EACzC,gBAAsD,EACvC,EAAE;IACjB,IAAI;QACF,IAAA,wCAA0B,EAAC,SAAS,CAAC,CAAC;QAEtC,MAAM,EAAE,kBAAkB,EAAE,GAC1B,MAAM,IAAA,wCAAyB,EAC7B,yBAAS,CAAC,QAAQ,EAClB,WAAW,EACX,cAAc,EACd,aAAa,EACb,KAAK,EAAE,+BAA+B;QACtC,SAAS,EAAE,WAAW;QACtB,qBAAqB,EACrB,mBAAmB,EACnB,kCAAkC,EAClC,oBAAoB,EACpB,KAAK,EAAE,gBAAgB;QACvB,uBAAuB,EACvB,gBAAgB,CACjB,CAAC;QACJ,MAAM,WAAW,GAAG,MAAM,IAAA,+BAAgB,EACxC,kBAAkB,EAClB,WAAW,CACZ,CAAC;QAEF,MAAM,UAAU,GAAG,IAAA,wCAAyB,EAAC,kBAAkB,CAAC,CAAC;QAEjE,IAAA,wCAA0B,EAAC;YACzB,SAAS,EAAE,yBAAS,CAAC,QAAQ;YAC7B,cAAc;YACd,4BAA4B,EAAE,KAAK;YACnC,QAAQ,EAAE,SAAS;YACnB,qBAAqB;YACrB,mBAAmB;YACnB,8BAA8B,EAAE,SAAS;YACzC,4BAA4B,EAAE,SAAS;YACvC,+BAA+B,EAAE,SAAS;YAC1C,6BAA6B,EAAE,SAAS;YACxC,kBAAkB,EAAE,SAAS;YAC7B,kCAAkC;YAClC,WAAW;YACX,oBAAoB;YACpB,uBAAuB;YACvB,UAAU;SACX,CAAC,CAAC;KACJ;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,6BAAqB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KAC/D;AACH,CAAC,CAAC;AA1DW,QAAA,qBAAqB,yBA0DhC;AAEK,MAAM,6BAA6B,GAAG,KAAK,EAChD,kBAA0B,EAC1B,WAAwB,EACxB,cAAsB,EACtB,aAAqB,EACrB,qBAAmD,EACnD,mBAA+C,EAC/C,gBAAsD,EACvC,EAAE;IACjB,IAAI;QACF,IAAA,wCAA0B,EAAC,SAAS,CAAC,CAAC;QAEtC,MAAM,EAAE,kBAAkB,EAAE,GAC1B,MAAM,IAAA,wCAAyB,EAC7B,yBAAS,CAAC,QAAQ,EAClB,WAAW,EACX,cAAc,EACd,aAAa,EACb,KAAK,EAAE,+BAA+B;QACtC,SAAS,EAAE,WAAW;QACtB,qBAAqB,EACrB,mBAAmB,EACnB,SAAS,EAAE,qCAAqC;QAChD,IAAI,EAAE,uBAAuB;QAC7B,KAAK,EAAE,gBAAgB;QACvB,SAAS,EAAE,0BAA0B;QACrC,gBAAgB,EAChB,kBAAkB,CACnB,CAAC;QACJ,MAAM,WAAW,GAAG,MAAM,IAAA,+BAAgB,EACxC,kBAAkB,EAClB,WAAW,CACZ,CAAC;QAEF,MAAM,UAAU,GAAG,IAAA,wCAAyB,EAAC,kBAAkB,CAAC,CAAC;QAEjE,IAAA,wCAA0B,EAAC;YACzB,SAAS,EAAE,yBAAS,CAAC,QAAQ;YAC7B,cAAc;YACd,4BAA4B,EAAE,KAAK;YACnC,QAAQ,EAAE,SAAS;YACnB,qBAAqB;YACrB,mBAAmB;YACnB,8BAA8B,EAAE,SAAS;YACzC,4BAA4B,EAAE,SAAS;YACvC,+BAA+B,EAAE,SAAS;YAC1C,6BAA6B,EAAE,SAAS;YACxC,kBAAkB,EAAE,SAAS;YAC7B,kCAAkC,EAAE,SAAS;YAC7C,WAAW;YACX,oBAAoB,EAAE,IAAI;YAC1B,uBAAuB,EAAE,SAAS;YAClC,UAAU;SACX,CAAC,CAAC;KACJ;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,6BAAqB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KAC/D;AACH,CAAC,CAAC;AAzDW,QAAA,6BAA6B,iCAyDxC;AAEK,MAAM,8BAA8B,GAAG,KAAK,EACjD,WAAwB,EACxB,mBAA2B,EAC3B,cAAsB,EACtB,aAAqB,EACrB,kBAAqC,EACrC,kCAAwE,EACxE,oBAA6B,EAC7B,uBAAyC,EACzC,gBAAsD,EACvC,EAAE;IACjB,IAAI;QACF,IAAA,+BAAqB,EAAC,mBAAmB,CAAC,CAAC;QAE3C,IAAA,wCAA0B,EAAC,SAAS,CAAC,CAAC;QAEtC,MAAM,qBAAqB,GAAiC;YAC1D;gBACE,GAAG,kBAAkB;gBACrB,gBAAgB,EAAE,mBAAmB;aACtC;SACF,CAAC;QAEF,MAAM,8BAA8B,GAAwB;YAC1D,kBAAkB;SACnB,CAAC;QAEF,MAAM,uCAAuC,GAC3C,IAAA,uEAA6C,EAAC,WAAW,EAAE;YACzD,kBAAkB;SACnB,CAAC,CAAC;QAEL,wBAAwB;QACxB,MAAM,mBAAmB,GAA+B,EAAE,CAAC;QAE3D,MAAM,4BAA4B,GAAG,KAAK,CAAC;QAC3C,MAAM,QAAQ,GAAqB,SAAS,CAAC;QAE7C,kCAAkC;QAClC,MAAM,EAAE,kBAAkB,EAAE,GAC1B,MAAM,IAAA,wCAAyB,EAC7B,yBAAS,CAAC,iBAAiB,EAC3B,WAAW,EACX,cAAc,EACd,aAAa,EACb,4BAA4B,EAC5B,QAAQ,EACR,uCAAuC,EACvC,EAAE,EAAE,sBAAsB;QAC1B,kCAAkC,EAClC,oBAAoB,EACpB,KAAK,EAAE,gBAAgB;QACvB,uBAAuB,EACvB,gBAAgB,CACjB,CAAC;QAEJ,MAAM,sBAAsB,GAAG,kBAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAEvD,MAAM,WAAW,GAAG,MAAM,IAAA,wCAAyB,EACjD,kBAAkB,EAClB,WAAW,EACX,mBAAmB,EACnB,sBAAsB,EACtB,KAAK,EAAE,gBAAgB;QACvB,oBAAoB,CACrB,CAAC;QAEF,MAAM,UAAU,GAAG,IAAA,wCAAyB,EAAC,kBAAkB,CAAC,CAAC;QAEjE,IAAA,wCAA0B,EAAC;YACzB,SAAS,EAAE,yBAAS,CAAC,iBAAiB;YACtC,cAAc;YACd,4BAA4B;YAC5B,QAAQ;YACR,qBAAqB;YACrB,mBAAmB;YACnB,8BAA8B;YAC9B,4BAA4B,EAAE,SAAS;YACvC,+BAA+B,EAAE,SAAS;YAC1C,6BAA6B,EAAE,SAAS;YACxC,kBAAkB,EAAE,SAAS;YAC7B,kCAAkC;YAClC,oBAAoB;YACpB,WAAW;YACX,uBAAuB;YACvB,UAAU;SACX,CAAC,CAAC;KACJ;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,sCAA8B,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KACxE;AACH,CAAC,CAAC;AA1FW,QAAA,8BAA8B,kCA0FzC","sourcesContent":["import {\n  MatrixERC20Amount,\n  NetworkName,\n  ProofType,\n  MatrixERC20AmountRecipient,\n  MatrixNFTAmountRecipient,\n  NETWORK_CONFIG,\n} from '@matrix-privacy/shared-models';\nimport {\n  GenerateTransactionsProgressCallback,\n  generateDummyProofTransactions,\n  generateProofTransactions,\n  generateTransact,\n  generateUnshieldBaseToken,\n  nullifiersForTransactions,\n} from './tx-generator';\nimport { assertValidEthAddress } from '../matrix/wallets/wallets';\nimport { setCachedProvedTransaction } from './proof-cache';\nimport {\n  ByteUtils,\n  MatrixContracts,\n} from '@matrix-privacy/engine';\nimport { createRelayAdaptUnshieldERC20AmountRecipients } from './tx-cross-contract-calls';\nimport { reportAndSanitizeError } from '../../utils/error';\n\nexport const generateUnshieldProof = async (\n  networkName: NetworkName,\n  matrixWalletID: string,\n  encryptionKey: string,\n  erc20AmountRecipients: MatrixERC20AmountRecipient[],\n  nftAmountRecipients: MatrixNFTAmountRecipient[],\n  broadcasterFeeERC20AmountRecipient: Optional<MatrixERC20AmountRecipient>,\n  sendWithPublicWallet: boolean,\n  overallBatchMinGasPrice: Optional<bigint>,\n  progressCallback: GenerateTransactionsProgressCallback,\n): Promise<void> => {\n  try {\n    setCachedProvedTransaction(undefined);\n\n    const { provedTransactions } =\n      await generateProofTransactions(\n        ProofType.Unshield,\n        networkName,\n        matrixWalletID,\n        encryptionKey,\n        false, // showSenderAddressToRecipient\n        undefined, // memoText\n        erc20AmountRecipients,\n        nftAmountRecipients,\n        broadcasterFeeERC20AmountRecipient,\n        sendWithPublicWallet,\n        false, // useDummyProof\n        overallBatchMinGasPrice,\n        progressCallback,\n      );\n    const transaction = await generateTransact(\n      provedTransactions,\n      networkName,\n    );\n\n    const nullifiers = nullifiersForTransactions(provedTransactions);\n\n    setCachedProvedTransaction({\n      proofType: ProofType.Unshield,\n      matrixWalletID,\n      showSenderAddressToRecipient: false,\n      memoText: undefined,\n      erc20AmountRecipients,\n      nftAmountRecipients,\n      relayAdaptUnshieldERC20Amounts: undefined,\n      relayAdaptUnshieldNFTAmounts: undefined,\n      relayAdaptShieldERC20Recipients: undefined,\n      relayAdaptShieldNFTRecipients: undefined,\n      crossContractCalls: undefined,\n      broadcasterFeeERC20AmountRecipient,\n      transaction,\n      sendWithPublicWallet,\n      overallBatchMinGasPrice,\n      nullifiers,\n    });\n  } catch (err) {\n    throw reportAndSanitizeError(generateUnshieldProof.name, err);\n  }\n};\n\nexport const generateUnshieldToOriginProof = async (\n  originalShieldTxid: string,\n  networkName: NetworkName,\n  matrixWalletID: string,\n  encryptionKey: string,\n  erc20AmountRecipients: MatrixERC20AmountRecipient[],\n  nftAmountRecipients: MatrixNFTAmountRecipient[],\n  progressCallback: GenerateTransactionsProgressCallback,\n): Promise<void> => {\n  try {\n    setCachedProvedTransaction(undefined);\n\n    const { provedTransactions } =\n      await generateProofTransactions(\n        ProofType.Unshield,\n        networkName,\n        matrixWalletID,\n        encryptionKey,\n        false, // showSenderAddressToRecipient\n        undefined, // memoText\n        erc20AmountRecipients,\n        nftAmountRecipients,\n        undefined, // broadcasterFeeERC20AmountRecipient\n        true, // sendWithPublicWallet\n        false, // useDummyProof\n        undefined, // overallBatchMinGasPrice\n        progressCallback,\n        originalShieldTxid,\n      );\n    const transaction = await generateTransact(\n      provedTransactions,\n      networkName,\n    );\n\n    const nullifiers = nullifiersForTransactions(provedTransactions);\n\n    setCachedProvedTransaction({\n      proofType: ProofType.Unshield,\n      matrixWalletID,\n      showSenderAddressToRecipient: false,\n      memoText: undefined,\n      erc20AmountRecipients,\n      nftAmountRecipients,\n      relayAdaptUnshieldERC20Amounts: undefined,\n      relayAdaptUnshieldNFTAmounts: undefined,\n      relayAdaptShieldERC20Recipients: undefined,\n      relayAdaptShieldNFTRecipients: undefined,\n      crossContractCalls: undefined,\n      broadcasterFeeERC20AmountRecipient: undefined,\n      transaction,\n      sendWithPublicWallet: true,\n      overallBatchMinGasPrice: undefined,\n      nullifiers,\n    });\n  } catch (err) {\n    throw reportAndSanitizeError(generateUnshieldProof.name, err);\n  }\n};\n\nexport const generateUnshieldBaseTokenProof = async (\n  networkName: NetworkName,\n  publicWalletAddress: string,\n  matrixWalletID: string,\n  encryptionKey: string,\n  wrappedERC20Amount: MatrixERC20Amount,\n  broadcasterFeeERC20AmountRecipient: Optional<MatrixERC20AmountRecipient>,\n  sendWithPublicWallet: boolean,\n  overallBatchMinGasPrice: Optional<bigint>,\n  progressCallback: GenerateTransactionsProgressCallback,\n): Promise<void> => {\n  try {\n    assertValidEthAddress(publicWalletAddress);\n\n    setCachedProvedTransaction(undefined);\n\n    const erc20AmountRecipients: MatrixERC20AmountRecipient[] = [\n      {\n        ...wrappedERC20Amount,\n        recipientAddress: publicWalletAddress,\n      },\n    ];\n\n    const relayAdaptUnshieldERC20Amounts: MatrixERC20Amount[] = [\n      wrappedERC20Amount,\n    ];\n\n    const relayAdaptUnshieldERC20AmountRecipients: MatrixERC20AmountRecipient[] =\n      createRelayAdaptUnshieldERC20AmountRecipients(networkName, [\n        wrappedERC20Amount,\n      ]);\n\n    // Empty NFT recipients.\n    const nftAmountRecipients: MatrixNFTAmountRecipient[] = [];\n\n    const showSenderAddressToRecipient = false;\n    const memoText: Optional<string> = undefined;\n\n    // Create transactions with proof.\n    const { provedTransactions } =\n      await generateProofTransactions(\n        ProofType.UnshieldBaseToken,\n        networkName,\n        matrixWalletID,\n        encryptionKey,\n        showSenderAddressToRecipient,\n        memoText,\n        relayAdaptUnshieldERC20AmountRecipients,\n        [], // nftAmountRecipients\n        broadcasterFeeERC20AmountRecipient,\n        sendWithPublicWallet,\n        false, // useDummyProof\n        overallBatchMinGasPrice,\n        progressCallback,\n      );\n\n    const relayAdaptParamsRandom = ByteUtils.randomHex(31);\n\n    const transaction = await generateUnshieldBaseToken(\n      provedTransactions,\n      networkName,\n      publicWalletAddress,\n      relayAdaptParamsRandom,\n      false, // useDummyProof\n      sendWithPublicWallet,\n    );\n\n    const nullifiers = nullifiersForTransactions(provedTransactions);\n\n    setCachedProvedTransaction({\n      proofType: ProofType.UnshieldBaseToken,\n      matrixWalletID,\n      showSenderAddressToRecipient,\n      memoText,\n      erc20AmountRecipients,\n      nftAmountRecipients,\n      relayAdaptUnshieldERC20Amounts,\n      relayAdaptUnshieldNFTAmounts: undefined,\n      relayAdaptShieldERC20Recipients: undefined,\n      relayAdaptShieldNFTRecipients: undefined,\n      crossContractCalls: undefined,\n      broadcasterFeeERC20AmountRecipient,\n      sendWithPublicWallet,\n      transaction,\n      overallBatchMinGasPrice,\n      nullifiers,\n    });\n  } catch (err) {\n    throw reportAndSanitizeError(generateUnshieldBaseTokenProof.name, err);\n  }\n};\n"]}

package/dist/services/transactions/tx-shield-base-token.d.ts

@@ -0,0 +1,3 @@
+import { MatrixPopulateTransactionResponse, MatrixTransactionGasEstimateResponse, MatrixERC20Amount, NetworkName, TransactionGasDetails } from '@matrix-privacy/shared-models';
+export declare const populateShieldBaseToken: (networkName: NetworkName, matrixAddress: string, shieldPrivateKey: string, wrappedERC20Amount: MatrixERC20Amount, gasDetails?: TransactionGasDetails) => Promise<MatrixPopulateTransactionResponse>;
+export declare const gasEstimateForShieldBaseToken: (networkName: NetworkName, matrixAddress: string, shieldPrivateKey: string, wrappedERC20Amount: MatrixERC20Amount, fromWalletAddress: string) => Promise<MatrixTransactionGasEstimateResponse>;

package/dist/services/transactions/tx-shield-base-token.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gasEstimateForShieldBaseToken = exports.populateShieldBaseToken = void 0;
+const shared_models_1 = require("@matrix-privacy/shared-models");
+const tx_gas_details_1 = require("./tx-gas-details");
+const engine_1 = require("@matrix-privacy/engine");
+const error_1 = require("../../utils/error");
+const wallets_1 = require("../matrix/wallets/wallets");
+const generateShieldBaseTokenTransaction = async (networkName, matrixAddress, shieldPrivateKey, wrappedERC20Amount) => {
+    try {
+        const { masterPublicKey, viewingPublicKey } = engine_1.MatrixEngine.decodeAddress(matrixAddress);
+        const random = engine_1.ByteUtils.randomHex(16);
+        const { amount, tokenAddress } = wrappedERC20Amount;
+        const shield = new engine_1.ShieldNoteERC20(masterPublicKey, random, amount, tokenAddress);
+        const shieldRequest = await shield.serialize(engine_1.ByteUtils.hexToBytes(shieldPrivateKey), viewingPublicKey);
+        const { chain } = shared_models_1.NETWORK_CONFIG[networkName];
+        const transaction = await engine_1.MatrixContracts.getRelayAdaptContract(chain).populateShieldBaseToken(shieldRequest);
+        return transaction;
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(generateShieldBaseTokenTransaction.name, err);
+    }
+};
+const populateShieldBaseToken = async (networkName, matrixAddress, shieldPrivateKey, wrappedERC20Amount, gasDetails) => {
+    try {
+        (0, wallets_1.assertValidMatrixAddress)(matrixAddress);
+        const transaction = await generateShieldBaseTokenTransaction(networkName, matrixAddress, shieldPrivateKey, wrappedERC20Amount);
+        if (gasDetails) {
+            const sendWithPublicWallet = true;
+            (0, tx_gas_details_1.setGasDetailsForTransaction)(networkName, transaction, gasDetails, sendWithPublicWallet);
+        }
+        return {
+            transaction,
+        };
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.populateShieldBaseToken.name, err);
+    }
+};
+exports.populateShieldBaseToken = populateShieldBaseToken;
+const gasEstimateForShieldBaseToken = async (networkName, matrixAddress, shieldPrivateKey, wrappedERC20Amount, fromWalletAddress) => {
+    try {
+        (0, wallets_1.assertValidMatrixAddress)(matrixAddress);
+        const transaction = await generateShieldBaseTokenTransaction(networkName, matrixAddress, shieldPrivateKey, wrappedERC20Amount);
+        const sendWithPublicWallet = true;
+        const isGasEstimateWithDummyProof = false;
+        return (0, tx_gas_details_1.gasEstimateResponse)(await (0, tx_gas_details_1.getGasEstimate)(networkName, transaction, fromWalletAddress, sendWithPublicWallet, false), undefined, // broadcasterFeeCommitment
+        isGasEstimateWithDummyProof);
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.gasEstimateForShieldBaseToken.name, err);
+    }
+};
+exports.gasEstimateForShieldBaseToken = gasEstimateForShieldBaseToken;
+//# sourceMappingURL=tx-shield-base-token.js.map

package/dist/services/transactions/tx-shield-base-token.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tx-shield-base-token.js","sourceRoot":"","sources":["../../../src/services/transactions/tx-shield-base-token.ts"],"names":[],"mappings":";;;AAAA,iEAOuC;AACvC,qDAI0B;AAC1B,mDAKgC;AAChC,6CAA2D;AAE3D,uDAAqE;AAErE,MAAM,kCAAkC,GAAG,KAAK,EAC9C,WAAwB,EACxB,aAAqB,EACrB,gBAAwB,EACxB,kBAAqC,EACP,EAAE;IAChC,IAAI;QACF,MAAM,EAAE,eAAe,EAAE,gBAAgB,EAAE,GACzC,qBAAY,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QAC5C,MAAM,MAAM,GAAG,kBAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAEvC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,kBAAkB,CAAC;QAEpD,MAAM,MAAM,GAAG,IAAI,wBAAe,CAChC,eAAe,EACf,MAAM,EACN,MAAM,EACN,YAAY,CACb,CAAC;QAEF,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,SAAS,CAC1C,kBAAS,CAAC,UAAU,CAAC,gBAAgB,CAAC,EACtC,gBAAgB,CACjB,CAAC;QAEF,MAAM,EAAE,KAAK,EAAE,GAAG,8BAAc,CAAC,WAAW,CAAC,CAAC;QAC9C,MAAM,WAAW,GACf,MAAM,wBAAe,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,uBAAuB,CACxE,aAAa,CACd,CAAC;QAEJ,OAAO,WAAW,CAAC;KACpB;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,kCAAkC,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KAC5E;AACH,CAAC,CAAC;AAEK,MAAM,uBAAuB,GAAG,KAAK,EAC1C,WAAwB,EACxB,aAAqB,EACrB,gBAAwB,EACxB,kBAAqC,EACrC,UAAkC,EACU,EAAE;IAC9C,IAAI;QACF,IAAA,kCAAwB,EAAC,aAAa,CAAC,CAAC;QAExC,MAAM,WAAW,GAAG,MAAM,kCAAkC,CAC1D,WAAW,EACX,aAAa,EACb,gBAAgB,EAChB,kBAAkB,CACnB,CAAC;QAEF,IAAI,UAAU,EAAE;YACd,MAAM,oBAAoB,GAAG,IAAI,CAAC;YAClC,IAAA,4CAA2B,EACzB,WAAW,EACX,WAAW,EACX,UAAU,EACV,oBAAoB,CACrB,CAAC;SACH;QAED,OAAO;YACL,WAAW;SACZ,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,+BAAuB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KACjE;AACH,CAAC,CAAC;AAjCW,QAAA,uBAAuB,2BAiClC;AAEK,MAAM,6BAA6B,GAAG,KAAK,EAChD,WAAwB,EACxB,aAAqB,EACrB,gBAAwB,EACxB,kBAAqC,EACrC,iBAAyB,EACsB,EAAE;IACjD,IAAI;QACF,IAAA,kCAAwB,EAAC,aAAa,CAAC,CAAC;QAExC,MAAM,WAAW,GAAG,MAAM,kCAAkC,CAC1D,WAAW,EACX,aAAa,EACb,gBAAgB,EAChB,kBAAkB,CACnB,CAAC;QAEF,MAAM,oBAAoB,GAAG,IAAI,CAAC;QAClC,MAAM,2BAA2B,GAAG,KAAK,CAAC;QAC1C,OAAO,IAAA,oCAAmB,EACxB,MAAM,IAAA,+BAAc,EAClB,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,oBAAoB,EACpB,KAAK,CACN,EACD,SAAS,EAAE,2BAA2B;QACtC,2BAA2B,CAC5B,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,qCAA6B,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KACvE;AACH,CAAC,CAAC;AAjCW,QAAA,6BAA6B,iCAiCxC","sourcesContent":["import {\n  MatrixPopulateTransactionResponse,\n  MatrixTransactionGasEstimateResponse,\n  MatrixERC20Amount,\n  NetworkName,\n  TransactionGasDetails,\n  NETWORK_CONFIG,\n} from '@matrix-privacy/shared-models';\nimport {\n  gasEstimateResponse,\n  getGasEstimate,\n  setGasDetailsForTransaction,\n} from './tx-gas-details';\nimport {\n  ShieldNoteERC20,\n  MatrixEngine,\n  ByteUtils,\n  MatrixContracts,\n} from '@matrix-privacy/engine';\nimport { reportAndSanitizeError } from '../../utils/error';\nimport { ContractTransaction } from 'ethers';\nimport { assertValidMatrixAddress } from '../matrix/wallets/wallets';\n\nconst generateShieldBaseTokenTransaction = async (\n  networkName: NetworkName,\n  matrixAddress: string,\n  shieldPrivateKey: string,\n  wrappedERC20Amount: MatrixERC20Amount,\n): Promise<ContractTransaction> => {\n  try {\n    const { masterPublicKey, viewingPublicKey } =\n      MatrixEngine.decodeAddress(matrixAddress);\n    const random = ByteUtils.randomHex(16);\n\n    const { amount, tokenAddress } = wrappedERC20Amount;\n\n    const shield = new ShieldNoteERC20(\n      masterPublicKey,\n      random,\n      amount,\n      tokenAddress,\n    );\n\n    const shieldRequest = await shield.serialize(\n      ByteUtils.hexToBytes(shieldPrivateKey),\n      viewingPublicKey,\n    );\n\n    const { chain } = NETWORK_CONFIG[networkName];\n    const transaction =\n      await MatrixContracts.getRelayAdaptContract(chain).populateShieldBaseToken(\n        shieldRequest,\n      );\n\n    return transaction;\n  } catch (err) {\n    throw reportAndSanitizeError(generateShieldBaseTokenTransaction.name, err);\n  }\n};\n\nexport const populateShieldBaseToken = async (\n  networkName: NetworkName,\n  matrixAddress: string,\n  shieldPrivateKey: string,\n  wrappedERC20Amount: MatrixERC20Amount,\n  gasDetails?: TransactionGasDetails,\n): Promise<MatrixPopulateTransactionResponse> => {\n  try {\n    assertValidMatrixAddress(matrixAddress);\n\n    const transaction = await generateShieldBaseTokenTransaction(\n      networkName,\n      matrixAddress,\n      shieldPrivateKey,\n      wrappedERC20Amount,\n    );\n\n    if (gasDetails) {\n      const sendWithPublicWallet = true;\n      setGasDetailsForTransaction(\n        networkName,\n        transaction,\n        gasDetails,\n        sendWithPublicWallet,\n      );\n    }\n\n    return {\n      transaction,\n    };\n  } catch (err) {\n    throw reportAndSanitizeError(populateShieldBaseToken.name, err);\n  }\n};\n\nexport const gasEstimateForShieldBaseToken = async (\n  networkName: NetworkName,\n  matrixAddress: string,\n  shieldPrivateKey: string,\n  wrappedERC20Amount: MatrixERC20Amount,\n  fromWalletAddress: string,\n): Promise<MatrixTransactionGasEstimateResponse> => {\n  try {\n    assertValidMatrixAddress(matrixAddress);\n\n    const transaction = await generateShieldBaseTokenTransaction(\n      networkName,\n      matrixAddress,\n      shieldPrivateKey,\n      wrappedERC20Amount,\n    );\n\n    const sendWithPublicWallet = true;\n    const isGasEstimateWithDummyProof = false;\n    return gasEstimateResponse(\n      await getGasEstimate(\n        networkName,\n        transaction,\n        fromWalletAddress,\n        sendWithPublicWallet,\n        false, // isCrossContractCall\n      ),\n      undefined, // broadcasterFeeCommitment\n      isGasEstimateWithDummyProof,\n    );\n  } catch (err) {\n    throw reportAndSanitizeError(gasEstimateForShieldBaseToken.name, err);\n  }\n};\n"]}

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

@@ -0,0 +1,6 @@
+import { MatrixPopulateTransactionResponse, MatrixTransactionGasEstimateResponse, NetworkName, MatrixERC20AmountRecipient, MatrixNFTAmountRecipient, TransactionGasDetails } from '@matrix-privacy/shared-models';
+import { ContractTransaction } from 'ethers';
+export declare const getShieldPrivateKeySignatureMessage: () => string;
+export declare const generateShieldTransaction: (networkName: NetworkName, shieldPrivateKey: string, erc20AmountRecipients: MatrixERC20AmountRecipient[], nftAmountRecipients: MatrixNFTAmountRecipient[]) => Promise<ContractTransaction>;
+export declare const populateShield: (networkName: NetworkName, shieldPrivateKey: string, erc20AmountRecipients: MatrixERC20AmountRecipient[], nftAmountRecipients: MatrixNFTAmountRecipient[], gasDetails?: TransactionGasDetails) => Promise<MatrixPopulateTransactionResponse>;
+export declare const gasEstimateForShield: (networkName: NetworkName, shieldPrivateKey: string, erc20AmountRecipients: MatrixERC20AmountRecipient[], nftAmountRecipients: MatrixNFTAmountRecipient[], fromWalletAddress: string) => Promise<MatrixTransactionGasEstimateResponse>;

package/dist/services/transactions/tx-shield.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gasEstimateForShield = exports.populateShield = exports.generateShieldTransaction = exports.getShieldPrivateKeySignatureMessage = void 0;
+const shared_models_1 = require("@matrix-privacy/shared-models");
+const engine_1 = require("@matrix-privacy/engine");
+const tx_gas_details_1 = require("./tx-gas-details");
+const tx_cross_contract_calls_1 = require("./tx-cross-contract-calls");
+const error_1 = require("../../utils/error");
+const wallets_1 = require("../matrix/wallets");
+const getShieldPrivateKeySignatureMessage = () => {
+    return engine_1.ShieldNote.getShieldPrivateKeySignatureMessage();
+};
+exports.getShieldPrivateKeySignatureMessage = getShieldPrivateKeySignatureMessage;
+const generateERC20ShieldRequests = async (erc20AmountRecipient, random, shieldPrivateKey) => {
+    const matrixAddress = erc20AmountRecipient.recipientAddress;
+    (0, wallets_1.assertValidMatrixAddress)(matrixAddress);
+    const { masterPublicKey, viewingPublicKey } = engine_1.MatrixEngine.decodeAddress(matrixAddress);
+    const shield = new engine_1.ShieldNoteERC20(masterPublicKey, random, erc20AmountRecipient.amount, erc20AmountRecipient.tokenAddress);
+    return shield.serialize(engine_1.ByteUtils.hexToBytes(shieldPrivateKey), viewingPublicKey);
+};
+const generateNFTShieldRequests = async (nftAmountRecipient, random, shieldPrivateKey) => {
+    const matrixAddress = nftAmountRecipient.recipientAddress;
+    (0, wallets_1.assertValidMatrixAddress)(matrixAddress);
+    const { masterPublicKey, viewingPublicKey } = engine_1.MatrixEngine.decodeAddress(matrixAddress);
+    const value = nftAmountRecipient.nftTokenType === shared_models_1.NFTTokenType.ERC721
+        ? engine_1.ERC721_NOTE_VALUE
+        : nftAmountRecipient.amount;
+    const nftTokenData = (0, tx_cross_contract_calls_1.createNFTTokenDataFromMatrixNFTAmount)(nftAmountRecipient);
+    const shield = new engine_1.ShieldNoteNFT(masterPublicKey, random, value, nftTokenData);
+    return shield.serialize(engine_1.ByteUtils.hexToBytes(shieldPrivateKey), viewingPublicKey);
+};
+const generateShieldTransaction = async (networkName, shieldPrivateKey, erc20AmountRecipients, nftAmountRecipients) => {
+    try {
+        const random = engine_1.ByteUtils.randomHex(16);
+        const shieldInputs = await Promise.all([
+            ...erc20AmountRecipients.map(erc20AmountRecipient => generateERC20ShieldRequests(erc20AmountRecipient, random, shieldPrivateKey)),
+            ...nftAmountRecipients.map(nftAmountRecipient => generateNFTShieldRequests(nftAmountRecipient, random, shieldPrivateKey)),
+        ]);
+        const chain = shared_models_1.NETWORK_CONFIG[networkName].chain;
+        const transaction = await engine_1.MatrixContracts.generateShield(chain, shieldInputs);
+        return transaction;
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.generateShieldTransaction.name, err);
+    }
+};
+exports.generateShieldTransaction = generateShieldTransaction;
+const populateShield = async (networkName, shieldPrivateKey, erc20AmountRecipients, nftAmountRecipients, gasDetails) => {
+    try {
+        const transaction = await (0, exports.generateShieldTransaction)(networkName, shieldPrivateKey, erc20AmountRecipients, nftAmountRecipients);
+        if (gasDetails) {
+            const sendWithPublicWallet = true;
+            (0, tx_gas_details_1.setGasDetailsForTransaction)(networkName, transaction, gasDetails, sendWithPublicWallet);
+        }
+        return {
+            transaction,
+        };
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.populateShield.name, err);
+    }
+};
+exports.populateShield = populateShield;
+const gasEstimateForShield = async (networkName, shieldPrivateKey, erc20AmountRecipients, nftAmountRecipients, fromWalletAddress) => {
+    try {
+        const transaction = await (0, exports.generateShieldTransaction)(networkName, shieldPrivateKey, erc20AmountRecipients, nftAmountRecipients);
+        const sendWithPublicWallet = true;
+        const isGasEstimateWithDummyProof = false;
+        return (0, tx_gas_details_1.gasEstimateResponse)(await (0, tx_gas_details_1.getGasEstimate)(networkName, transaction, fromWalletAddress, sendWithPublicWallet, false), undefined, // broadcasterFeeCommitment
+        isGasEstimateWithDummyProof);
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.gasEstimateForShield.name, err);
+    }
+};
+exports.gasEstimateForShield = gasEstimateForShield;
+//# sourceMappingURL=tx-shield.js.map

package/dist/services/transactions/tx-shield.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tx-shield.js","sourceRoot":"","sources":["../../../src/services/transactions/tx-shield.ts"],"names":[],"mappings":";;;AAAA,iEASuC;AACvC,mDASgC;AAChC,qDAI0B;AAC1B,uEAAkF;AAClF,6CAA2D;AAE3D,+CAA6D;AAEtD,MAAM,mCAAmC,GAAG,GAAG,EAAE;IACtD,OAAO,mBAAU,CAAC,mCAAmC,EAAE,CAAC;AAC1D,CAAC,CAAC;AAFW,QAAA,mCAAmC,uCAE9C;AAEF,MAAM,2BAA2B,GAAG,KAAK,EACvC,oBAAgD,EAChD,MAAc,EACd,gBAAwB,EACM,EAAE;IAChC,MAAM,aAAa,GAAG,oBAAoB,CAAC,gBAAgB,CAAC;IAE5D,IAAA,kCAAwB,EAAC,aAAa,CAAC,CAAC;IAExC,MAAM,EAAE,eAAe,EAAE,gBAAgB,EAAE,GACzC,qBAAY,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;IAE5C,MAAM,MAAM,GAAG,IAAI,wBAAe,CAChC,eAAe,EACf,MAAM,EACN,oBAAoB,CAAC,MAAM,EAC3B,oBAAoB,CAAC,YAAY,CAClC,CAAC;IACF,OAAO,MAAM,CAAC,SAAS,CACrB,kBAAS,CAAC,UAAU,CAAC,gBAAgB,CAAC,EACtC,gBAAgB,CACjB,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,yBAAyB,GAAG,KAAK,EACrC,kBAA4C,EAC5C,MAAc,EACd,gBAAwB,EACM,EAAE;IAChC,MAAM,aAAa,GAAG,kBAAkB,CAAC,gBAAgB,CAAC;IAE1D,IAAA,kCAAwB,EAAC,aAAa,CAAC,CAAC;IAExC,MAAM,EAAE,eAAe,EAAE,gBAAgB,EAAE,GACzC,qBAAY,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;IAE5C,MAAM,KAAK,GACT,kBAAkB,CAAC,YAAY,KAAK,4BAAY,CAAC,MAAM;QACrD,CAAC,CAAC,0BAAiB;QACnB,CAAC,CAAC,kBAAkB,CAAC,MAAM,CAAC;IAEhC,MAAM,YAAY,GAChB,IAAA,+DAAqC,EAAC,kBAAkB,CAAC,CAAC;IAE5D,MAAM,MAAM,GAAG,IAAI,sBAAa,CAC9B,eAAe,EACf,MAAM,EACN,KAAK,EACL,YAAY,CACb,CAAC;IACF,OAAO,MAAM,CAAC,SAAS,CACrB,kBAAS,CAAC,UAAU,CAAC,gBAAgB,CAAC,EACtC,gBAAgB,CACjB,CAAC;AACJ,CAAC,CAAC;AAEK,MAAM,yBAAyB,GAAG,KAAK,EAC5C,WAAwB,EACxB,gBAAwB,EACxB,qBAAmD,EACnD,mBAA+C,EACjB,EAAE;IAChC,IAAI;QACF,MAAM,MAAM,GAAG,kBAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAEvC,MAAM,YAAY,GAA0B,MAAM,OAAO,CAAC,GAAG,CAAC;YAC5D,GAAG,qBAAqB,CAAC,GAAG,CAAC,oBAAoB,CAAC,EAAE,CAClD,2BAA2B,CACzB,oBAAoB,EACpB,MAAM,EACN,gBAAgB,CACjB,CACF;YACD,GAAG,mBAAmB,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAAE,CAC9C,yBAAyB,CAAC,kBAAkB,EAAE,MAAM,EAAE,gBAAgB,CAAC,CACxE;SACF,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,8BAAc,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC;QAChD,MAAM,WAAW,GAAG,MAAM,wBAAe,CAAC,cAAc,CACtD,KAAK,EACL,YAAY,CACb,CAAC;QACF,OAAO,WAAW,CAAC;KACpB;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,iCAAyB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KACnE;AACH,CAAC,CAAC;AA/BW,QAAA,yBAAyB,6BA+BpC;AAEK,MAAM,cAAc,GAAG,KAAK,EACjC,WAAwB,EACxB,gBAAwB,EACxB,qBAAmD,EACnD,mBAA+C,EAC/C,UAAkC,EACU,EAAE;IAC9C,IAAI;QACF,MAAM,WAAW,GAAG,MAAM,IAAA,iCAAyB,EACjD,WAAW,EACX,gBAAgB,EAChB,qBAAqB,EACrB,mBAAmB,CACpB,CAAC;QAEF,IAAI,UAAU,EAAE;YACd,MAAM,oBAAoB,GAAG,IAAI,CAAC;YAClC,IAAA,4CAA2B,EACzB,WAAW,EACX,WAAW,EACX,UAAU,EACV,oBAAoB,CACrB,CAAC;SACH;QAED,OAAO;YACL,WAAW;SACZ,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,sBAAc,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KACxD;AACH,CAAC,CAAC;AA/BW,QAAA,cAAc,kBA+BzB;AAEK,MAAM,oBAAoB,GAAG,KAAK,EACvC,WAAwB,EACxB,gBAAwB,EACxB,qBAAmD,EACnD,mBAA+C,EAC/C,iBAAyB,EACsB,EAAE;IACjD,IAAI;QACF,MAAM,WAAW,GAAG,MAAM,IAAA,iCAAyB,EACjD,WAAW,EACX,gBAAgB,EAChB,qBAAqB,EACrB,mBAAmB,CACpB,CAAC;QAEF,MAAM,oBAAoB,GAAG,IAAI,CAAC;QAClC,MAAM,2BAA2B,GAAG,KAAK,CAAC;QAC1C,OAAO,IAAA,oCAAmB,EACxB,MAAM,IAAA,+BAAc,EAClB,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,oBAAoB,EACpB,KAAK,CACN,EACD,SAAS,EAAE,2BAA2B;QACtC,2BAA2B,CAC5B,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,4BAAoB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KAC9D;AACH,CAAC,CAAC;AA/BW,QAAA,oBAAoB,wBA+B/B","sourcesContent":["import {\n  MatrixPopulateTransactionResponse,\n  MatrixTransactionGasEstimateResponse,\n  NetworkName,\n  MatrixERC20AmountRecipient,\n  MatrixNFTAmountRecipient,\n  NFTTokenType,\n  TransactionGasDetails,\n  NETWORK_CONFIG,\n} from '@matrix-privacy/shared-models';\nimport {\n  ShieldNote,\n  MatrixEngine,\n  ShieldRequestStruct,\n  ByteUtils,\n  ShieldNoteERC20,\n  ShieldNoteNFT,\n  ERC721_NOTE_VALUE,\n  MatrixContracts,\n} from '@matrix-privacy/engine';\nimport {\n  gasEstimateResponse,\n  getGasEstimate,\n  setGasDetailsForTransaction,\n} from './tx-gas-details';\nimport { createNFTTokenDataFromMatrixNFTAmount } from './tx-cross-contract-calls';\nimport { reportAndSanitizeError } from '../../utils/error';\nimport { ContractTransaction } from 'ethers';\nimport { assertValidMatrixAddress } from '../matrix/wallets';\n\nexport const getShieldPrivateKeySignatureMessage = () => {\n  return ShieldNote.getShieldPrivateKeySignatureMessage();\n};\n\nconst generateERC20ShieldRequests = async (\n  erc20AmountRecipient: MatrixERC20AmountRecipient,\n  random: string,\n  shieldPrivateKey: string,\n): Promise<ShieldRequestStruct> => {\n  const matrixAddress = erc20AmountRecipient.recipientAddress;\n\n  assertValidMatrixAddress(matrixAddress);\n\n  const { masterPublicKey, viewingPublicKey } =\n    MatrixEngine.decodeAddress(matrixAddress);\n\n  const shield = new ShieldNoteERC20(\n    masterPublicKey,\n    random,\n    erc20AmountRecipient.amount,\n    erc20AmountRecipient.tokenAddress,\n  );\n  return shield.serialize(\n    ByteUtils.hexToBytes(shieldPrivateKey),\n    viewingPublicKey,\n  );\n};\n\nconst generateNFTShieldRequests = async (\n  nftAmountRecipient: MatrixNFTAmountRecipient,\n  random: string,\n  shieldPrivateKey: string,\n): Promise<ShieldRequestStruct> => {\n  const matrixAddress = nftAmountRecipient.recipientAddress;\n\n  assertValidMatrixAddress(matrixAddress);\n\n  const { masterPublicKey, viewingPublicKey } =\n    MatrixEngine.decodeAddress(matrixAddress);\n\n  const value =\n    nftAmountRecipient.nftTokenType === NFTTokenType.ERC721\n      ? ERC721_NOTE_VALUE\n      : nftAmountRecipient.amount;\n\n  const nftTokenData =\n    createNFTTokenDataFromMatrixNFTAmount(nftAmountRecipient);\n\n  const shield = new ShieldNoteNFT(\n    masterPublicKey,\n    random,\n    value,\n    nftTokenData,\n  );\n  return shield.serialize(\n    ByteUtils.hexToBytes(shieldPrivateKey),\n    viewingPublicKey,\n  );\n};\n\nexport const generateShieldTransaction = async (\n  networkName: NetworkName,\n  shieldPrivateKey: string,\n  erc20AmountRecipients: MatrixERC20AmountRecipient[],\n  nftAmountRecipients: MatrixNFTAmountRecipient[],\n): Promise<ContractTransaction> => {\n  try {\n    const random = ByteUtils.randomHex(16);\n\n    const shieldInputs: ShieldRequestStruct[] = await Promise.all([\n      ...erc20AmountRecipients.map(erc20AmountRecipient =>\n        generateERC20ShieldRequests(\n          erc20AmountRecipient,\n          random,\n          shieldPrivateKey,\n        ),\n      ),\n      ...nftAmountRecipients.map(nftAmountRecipient =>\n        generateNFTShieldRequests(nftAmountRecipient, random, shieldPrivateKey),\n      ),\n    ]);\n\n    const chain = NETWORK_CONFIG[networkName].chain;\n    const transaction = await MatrixContracts.generateShield(\n      chain,\n      shieldInputs,\n    );\n    return transaction;\n  } catch (err) {\n    throw reportAndSanitizeError(generateShieldTransaction.name, err);\n  }\n};\n\nexport const populateShield = async (\n  networkName: NetworkName,\n  shieldPrivateKey: string,\n  erc20AmountRecipients: MatrixERC20AmountRecipient[],\n  nftAmountRecipients: MatrixNFTAmountRecipient[],\n  gasDetails?: TransactionGasDetails,\n): Promise<MatrixPopulateTransactionResponse> => {\n  try {\n    const transaction = await generateShieldTransaction(\n      networkName,\n      shieldPrivateKey,\n      erc20AmountRecipients,\n      nftAmountRecipients,\n    );\n\n    if (gasDetails) {\n      const sendWithPublicWallet = true;\n      setGasDetailsForTransaction(\n        networkName,\n        transaction,\n        gasDetails,\n        sendWithPublicWallet,\n      );\n    }\n\n    return {\n      transaction,\n    };\n  } catch (err) {\n    throw reportAndSanitizeError(populateShield.name, err);\n  }\n};\n\nexport const gasEstimateForShield = async (\n  networkName: NetworkName,\n  shieldPrivateKey: string,\n  erc20AmountRecipients: MatrixERC20AmountRecipient[],\n  nftAmountRecipients: MatrixNFTAmountRecipient[],\n  fromWalletAddress: string,\n): Promise<MatrixTransactionGasEstimateResponse> => {\n  try {\n    const transaction = await generateShieldTransaction(\n      networkName,\n      shieldPrivateKey,\n      erc20AmountRecipients,\n      nftAmountRecipients,\n    );\n\n    const sendWithPublicWallet = true;\n    const isGasEstimateWithDummyProof = false;\n    return gasEstimateResponse(\n      await getGasEstimate(\n        networkName,\n        transaction,\n        fromWalletAddress,\n        sendWithPublicWallet,\n        false, // isCrossContractCall\n      ),\n      undefined, // broadcasterFeeCommitment\n      isGasEstimateWithDummyProof,\n    );\n  } catch (err) {\n    throw reportAndSanitizeError(gasEstimateForShield.name, err);\n  }\n};\n"]}

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

@@ -0,0 +1,3 @@
+import { MatrixPopulateTransactionResponse, MatrixTransactionGasEstimateResponse, NetworkName, FeeTokenDetails, MatrixERC20AmountRecipient, MatrixNFTAmountRecipient, TransactionGasDetails } from '@matrix-privacy/shared-models';
+export declare const populateProvedTransfer: (networkName: NetworkName, matrixWalletID: string, showSenderAddressToRecipient: boolean, memoText: Optional<string>, erc20AmountRecipients: MatrixERC20AmountRecipient[], nftAmountRecipients: MatrixNFTAmountRecipient[], broadcasterFeeERC20AmountRecipient: Optional<MatrixERC20AmountRecipient>, sendWithPublicWallet: boolean, overallBatchMinGasPrice: Optional<bigint>, gasDetails: TransactionGasDetails) => Promise<MatrixPopulateTransactionResponse>;
+export declare const gasEstimateForUnprovenTransfer: (networkName: NetworkName, matrixWalletID: string, encryptionKey: string, memoText: Optional<string>, erc20AmountRecipients: MatrixERC20AmountRecipient[], nftAmountRecipients: MatrixNFTAmountRecipient[], originalGasDetails: TransactionGasDetails, feeTokenDetails: Optional<FeeTokenDetails>, sendWithPublicWallet: boolean) => Promise<MatrixTransactionGasEstimateResponse>;

package/dist/services/transactions/tx-transfer.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gasEstimateForUnprovenTransfer = exports.populateProvedTransfer = 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 tx_gas_broadcaster_fee_estimator_1 = require("./tx-gas-broadcaster-fee-estimator");
+const error_1 = require("../../utils/error");
+const populateProvedTransfer = async (networkName, matrixWalletID, showSenderAddressToRecipient, memoText, erc20AmountRecipients, nftAmountRecipients, broadcasterFeeERC20AmountRecipient, sendWithPublicWallet, overallBatchMinGasPrice, gasDetails) => {
+    try {
+        const { transaction, nullifiers } = await (0, proof_cache_1.populateProvedTransaction)(networkName, shared_models_1.ProofType.Transfer, matrixWalletID, showSenderAddressToRecipient, memoText, erc20AmountRecipients, nftAmountRecipients, undefined, // relayAdaptUnshieldERC20AmountRecipients
+        undefined, // relayAdaptUnshieldNFTAmounts
+        undefined, // relayAdaptShieldERC20Recipients
+        undefined, // relayAdaptShieldNFTRecipients
+        undefined, // crossContractCalls
+        broadcasterFeeERC20AmountRecipient, sendWithPublicWallet, overallBatchMinGasPrice, gasDetails);
+        return {
+            nullifiers,
+            transaction,
+        };
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.populateProvedTransfer.name, err);
+    }
+};
+exports.populateProvedTransfer = populateProvedTransfer;
+const gasEstimateForUnprovenTransfer = async (networkName, matrixWalletID, encryptionKey, memoText, erc20AmountRecipients, nftAmountRecipients, originalGasDetails, feeTokenDetails, sendWithPublicWallet) => {
+    try {
+        const overallBatchMinGasPrice = 0n;
+        const response = await (0, tx_gas_broadcaster_fee_estimator_1.gasEstimateResponseDummyProofIterativeBroadcasterFee)((broadcasterFeeERC20Amount) => (0, tx_generator_1.generateDummyProofTransactions)(shared_models_1.ProofType.Transfer, networkName, matrixWalletID, encryptionKey, false, // showSenderAddressToRecipient - doesn't matter for gas estimate.
+        memoText, erc20AmountRecipients, nftAmountRecipients, broadcasterFeeERC20Amount, sendWithPublicWallet, overallBatchMinGasPrice), (txs) => (0, tx_generator_1.generateTransact)(txs, networkName, true), networkName, matrixWalletID, erc20AmountRecipients, originalGasDetails, feeTokenDetails, sendWithPublicWallet, false);
+        return response;
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.gasEstimateForUnprovenTransfer.name, err);
+    }
+};
+exports.gasEstimateForUnprovenTransfer = gasEstimateForUnprovenTransfer;
+//# sourceMappingURL=tx-transfer.js.map

package/dist/services/transactions/tx-transfer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tx-transfer.js","sourceRoot":"","sources":["../../../src/services/transactions/tx-transfer.ts"],"names":[],"mappings":";;;AAAA,iEAUuC;AACvC,iDAGwB;AACxB,+CAA0D;AAI1D,yFAA0G;AAC1G,6CAA2D;AAEpD,MAAM,sBAAsB,GAAG,KAAK,EACzC,WAAwB,EACxB,cAAsB,EACtB,4BAAqC,EACrC,QAA0B,EAC1B,qBAAmD,EACnD,mBAA+C,EAC/C,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,QAAQ,EAClB,cAAc,EACd,4BAA4B,EAC5B,QAAQ,EACR,qBAAqB,EACrB,mBAAmB,EACnB,SAAS,EAAE,0CAA0C;QACrD,SAAS,EAAE,+BAA+B;QAC1C,SAAS,EAAE,kCAAkC;QAC7C,SAAS,EAAE,gCAAgC;QAC3C,SAAS,EAAE,qBAAqB;QAChC,kCAAkC,EAClC,oBAAoB,EACpB,uBAAuB,EACvB,UAAU,CACX,CAAC;QACJ,OAAO;YACL,UAAU;YACV,WAAW;SACZ,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,8BAAsB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KAChE;AACH,CAAC,CAAC;AAvCW,QAAA,sBAAsB,0BAuCjC;AAEK,MAAM,8BAA8B,GAAG,KAAK,EACjD,WAAwB,EACxB,cAAsB,EACtB,aAAqB,EACrB,QAA0B,EAC1B,qBAAmD,EACnD,mBAA+C,EAC/C,kBAAyC,EACzC,eAA0C,EAC1C,oBAA6B,EACkB,EAAE;IACjD,IAAI;QACF,MAAM,uBAAuB,GAAG,EAAE,CAAC;QAEnC,MAAM,QAAQ,GAAG,MAAM,IAAA,uFAAoD,EACzE,CAAC,yBAAsD,EAAE,EAAE,CACzD,IAAA,6CAA8B,EAC5B,yBAAS,CAAC,QAAQ,EAClB,WAAW,EACX,cAAc,EACd,aAAa,EACb,KAAK,EAAE,kEAAkE;QACzE,QAAQ,EACR,qBAAqB,EACrB,mBAAmB,EACnB,yBAAyB,EACzB,oBAAoB,EACpB,uBAAuB,CACxB,EACH,CAAC,GAA0B,EAAE,EAAE,CAC7B,IAAA,+BAAgB,EACd,GAAG,EACH,WAAW,EACX,IAAI,CACL,EACH,WAAW,EACX,cAAc,EACd,qBAAqB,EACrB,kBAAkB,EAClB,eAAe,EACf,oBAAoB,EACpB,KAAK,CACN,CAAC;QACF,OAAO,QAAQ,CAAC;KACjB;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,sCAA8B,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KACxE;AACH,CAAC,CAAC;AA/CW,QAAA,8BAA8B,kCA+CzC","sourcesContent":["import {\n  MatrixPopulateTransactionResponse,\n  MatrixTransactionGasEstimateResponse,\n  MatrixERC20Amount,\n  NetworkName,\n  ProofType,\n  FeeTokenDetails,\n  MatrixERC20AmountRecipient,\n  MatrixNFTAmountRecipient,\n  TransactionGasDetails,\n} from '@matrix-privacy/shared-models';\nimport {\n  generateDummyProofTransactions,\n  generateTransact,\n} from './tx-generator';\nimport { populateProvedTransaction } from './proof-cache';\nimport {\n  TransactionStructV3,\n} from '@matrix-privacy/engine';\nimport { gasEstimateResponseDummyProofIterativeBroadcasterFee } from './tx-gas-broadcaster-fee-estimator';\nimport { reportAndSanitizeError } from '../../utils/error';\n\nexport const populateProvedTransfer = async (\n  networkName: NetworkName,\n  matrixWalletID: string,\n  showSenderAddressToRecipient: boolean,\n  memoText: Optional<string>,\n  erc20AmountRecipients: MatrixERC20AmountRecipient[],\n  nftAmountRecipients: MatrixNFTAmountRecipient[],\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.Transfer,\n        matrixWalletID,\n        showSenderAddressToRecipient,\n        memoText,\n        erc20AmountRecipients,\n        nftAmountRecipients,\n        undefined, // relayAdaptUnshieldERC20AmountRecipients\n        undefined, // relayAdaptUnshieldNFTAmounts\n        undefined, // relayAdaptShieldERC20Recipients\n        undefined, // relayAdaptShieldNFTRecipients\n        undefined, // crossContractCalls\n        broadcasterFeeERC20AmountRecipient,\n        sendWithPublicWallet,\n        overallBatchMinGasPrice,\n        gasDetails,\n      );\n    return {\n      nullifiers,\n      transaction,\n    };\n  } catch (err) {\n    throw reportAndSanitizeError(populateProvedTransfer.name, err);\n  }\n};\n\nexport const gasEstimateForUnprovenTransfer = async (\n  networkName: NetworkName,\n  matrixWalletID: string,\n  encryptionKey: string,\n  memoText: Optional<string>,\n  erc20AmountRecipients: MatrixERC20AmountRecipient[],\n  nftAmountRecipients: MatrixNFTAmountRecipient[],\n  originalGasDetails: TransactionGasDetails,\n  feeTokenDetails: Optional<FeeTokenDetails>,\n  sendWithPublicWallet: boolean,\n): Promise<MatrixTransactionGasEstimateResponse> => {\n  try {\n    const overallBatchMinGasPrice = 0n;\n\n    const response = await gasEstimateResponseDummyProofIterativeBroadcasterFee(\n      (broadcasterFeeERC20Amount: Optional<MatrixERC20Amount>) =>\n        generateDummyProofTransactions(\n          ProofType.Transfer,\n          networkName,\n          matrixWalletID,\n          encryptionKey,\n          false, // showSenderAddressToRecipient - doesn't matter for gas estimate.\n          memoText,\n          erc20AmountRecipients,\n          nftAmountRecipients,\n          broadcasterFeeERC20Amount,\n          sendWithPublicWallet,\n          overallBatchMinGasPrice,\n        ),\n      (txs: TransactionStructV3[]) =>\n        generateTransact(\n          txs,\n          networkName,\n          true, // useDummyProof\n        ),\n      networkName,\n      matrixWalletID,\n      erc20AmountRecipients,\n      originalGasDetails,\n      feeTokenDetails,\n      sendWithPublicWallet,\n      false, // isCrossContractCall\n    );\n    return response;\n  } catch (err) {\n    throw reportAndSanitizeError(gasEstimateForUnprovenTransfer.name, err);\n  }\n};\n"]}

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

@@ -0,0 +1,11 @@
+import { MatrixPopulateTransactionResponse, MatrixTransactionGasEstimateResponse, MatrixERC20Amount, NetworkName, FeeTokenDetails, MatrixERC20AmountRecipient, MatrixNFTAmountRecipient, TransactionGasDetails } from '@matrix-privacy/shared-models';
+export declare const populateProvedUnshield: (networkName: NetworkName, matrixWalletID: string, erc20AmountRecipients: MatrixERC20AmountRecipient[], nftAmountRecipients: MatrixNFTAmountRecipient[], broadcasterFeeERC20AmountRecipient: Optional<MatrixERC20AmountRecipient>, sendWithPublicWallet: boolean, overallBatchMinGasPrice: Optional<bigint>, gasDetails: TransactionGasDetails) => Promise<MatrixPopulateTransactionResponse>;
+export declare const populateProvedUnshieldBaseToken: (networkName: NetworkName, publicWalletAddress: string, matrixWalletID: string, wrappedERC20Amount: MatrixERC20Amount, broadcasterFeeERC20AmountRecipient: Optional<MatrixERC20AmountRecipient>, sendWithPublicWallet: boolean, overallBatchMinGasPrice: Optional<bigint>, gasDetails: TransactionGasDetails) => Promise<MatrixPopulateTransactionResponse>;
+export declare const gasEstimateForUnprovenUnshield: (networkName: NetworkName, matrixWalletID: string, encryptionKey: string, erc20AmountRecipients: MatrixERC20AmountRecipient[], nftAmountRecipients: MatrixNFTAmountRecipient[], originalGasDetails: TransactionGasDetails, feeTokenDetails: Optional<FeeTokenDetails>, sendWithPublicWallet: boolean) => Promise<MatrixTransactionGasEstimateResponse>;
+export declare const gasEstimateForUnprovenUnshieldBaseToken: (networkName: NetworkName, publicWalletAddress: string, matrixWalletID: string, encryptionKey: string, wrappedERC20Amount: MatrixERC20Amount, originalGasDetails: TransactionGasDetails, feeTokenDetails: Optional<FeeTokenDetails>, sendWithPublicWallet: boolean) => Promise<MatrixTransactionGasEstimateResponse>;
+export declare const getERC20AndNFTAmountRecipientsForUnshieldToOrigin: (networkName: NetworkName, matrixWalletID: string, originalShieldTxid: string) => Promise<{
+    erc20AmountRecipients: MatrixERC20AmountRecipient[];
+    nftAmountRecipients: MatrixNFTAmountRecipient[];
+}>;
+export declare const populateProvedUnshieldToOrigin: (networkName: NetworkName, matrixWalletID: string, erc20AmountRecipients: MatrixERC20AmountRecipient[], nftAmountRecipients: MatrixNFTAmountRecipient[], gasDetails: TransactionGasDetails) => Promise<MatrixPopulateTransactionResponse>;
+export declare const gasEstimateForUnprovenUnshieldToOrigin: (originalShieldTxid: string, networkName: NetworkName, matrixWalletID: string, encryptionKey: string, erc20AmountRecipients: MatrixERC20AmountRecipient[], nftAmountRecipients: MatrixNFTAmountRecipient[]) => Promise<MatrixTransactionGasEstimateResponse>;

package/dist/services/transactions/tx-unshield.js

@@ -0,0 +1,224 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gasEstimateForUnprovenUnshieldToOrigin = exports.populateProvedUnshieldToOrigin = exports.getERC20AndNFTAmountRecipientsForUnshieldToOrigin = exports.gasEstimateForUnprovenUnshieldBaseToken = exports.gasEstimateForUnprovenUnshield = exports.populateProvedUnshieldBaseToken = exports.populateProvedUnshield = 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 engine_1 = require("@matrix-privacy/engine");
+const tx_gas_broadcaster_fee_estimator_1 = require("./tx-gas-broadcaster-fee-estimator");
+const tx_cross_contract_calls_1 = require("./tx-cross-contract-calls");
+const error_1 = require("../../utils/error");
+const tx_gas_details_1 = require("./tx-gas-details");
+const matrix_1 = require("../matrix");
+const ERC20_TRANSFER_EVENT_SIGNATURE = '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef';
+const populateProvedUnshield = async (networkName, matrixWalletID, erc20AmountRecipients, nftAmountRecipients, broadcasterFeeERC20AmountRecipient, sendWithPublicWallet, overallBatchMinGasPrice, gasDetails) => {
+    try {
+        const { transaction, nullifiers } = await (0, proof_cache_1.populateProvedTransaction)(networkName, shared_models_1.ProofType.Unshield, matrixWalletID, false, // showSenderAddressToRecipient
+        undefined, // memoText
+        erc20AmountRecipients, nftAmountRecipients, undefined, // relayAdaptUnshieldERC20AmountRecipients
+        undefined, // relayAdaptUnshieldNFTAmounts
+        undefined, // relayAdaptShieldERC20Recipients
+        undefined, // relayAdaptShieldNFTRecipients
+        undefined, // crossContractCalls
+        broadcasterFeeERC20AmountRecipient, sendWithPublicWallet, overallBatchMinGasPrice, gasDetails);
+        return {
+            nullifiers,
+            transaction,
+        };
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.populateProvedUnshield.name, err);
+    }
+};
+exports.populateProvedUnshield = populateProvedUnshield;
+const populateProvedUnshieldBaseToken = async (networkName, publicWalletAddress, matrixWalletID, wrappedERC20Amount, broadcasterFeeERC20AmountRecipient, sendWithPublicWallet, overallBatchMinGasPrice, gasDetails) => {
+    try {
+        const erc20AmountRecipients = [
+            {
+                ...wrappedERC20Amount,
+                recipientAddress: publicWalletAddress,
+            },
+        ];
+        const relayAdaptUnshieldERC20Amounts = [
+            wrappedERC20Amount,
+        ];
+        // Empty NFT Recipients.
+        const nftAmountRecipients = [];
+        const { transaction, nullifiers } = await (0, proof_cache_1.populateProvedTransaction)(networkName, shared_models_1.ProofType.UnshieldBaseToken, matrixWalletID, false, // showSenderAddressToRecipient
+        undefined, // memoText
+        erc20AmountRecipients, nftAmountRecipients, relayAdaptUnshieldERC20Amounts, undefined, // relayAdaptUnshieldNFTAmounts
+        undefined, // relayAdaptShieldERC20Recipients
+        undefined, // relayAdaptShieldNFTRecipients
+        undefined, // crossContractCalls
+        broadcasterFeeERC20AmountRecipient, sendWithPublicWallet, overallBatchMinGasPrice, gasDetails);
+        return {
+            nullifiers,
+            transaction,
+        };
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.populateProvedUnshieldBaseToken.name, err);
+    }
+};
+exports.populateProvedUnshieldBaseToken = populateProvedUnshieldBaseToken;
+const gasEstimateForUnprovenUnshield = async (networkName, matrixWalletID, encryptionKey, erc20AmountRecipients, nftAmountRecipients, originalGasDetails, feeTokenDetails, sendWithPublicWallet) => {
+    try {
+        const overallBatchMinGasPrice = 0n;
+        const response = await (0, tx_gas_broadcaster_fee_estimator_1.gasEstimateResponseDummyProofIterativeBroadcasterFee)((broadcasterFeeERC20Amount) => (0, tx_generator_1.generateDummyProofTransactions)(shared_models_1.ProofType.Unshield, networkName, matrixWalletID, encryptionKey, false, // showSenderAddressToRecipient
+        undefined, // memoText
+        erc20AmountRecipients, nftAmountRecipients, broadcasterFeeERC20Amount, sendWithPublicWallet, overallBatchMinGasPrice), (txs) => (0, tx_generator_1.generateTransact)(txs, networkName, true), networkName, matrixWalletID, erc20AmountRecipients, originalGasDetails, feeTokenDetails, sendWithPublicWallet, false);
+        return response;
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.gasEstimateForUnprovenUnshield.name, err);
+    }
+};
+exports.gasEstimateForUnprovenUnshield = gasEstimateForUnprovenUnshield;
+const gasEstimateForUnprovenUnshieldBaseToken = async (networkName, publicWalletAddress, matrixWalletID, encryptionKey, wrappedERC20Amount, originalGasDetails, feeTokenDetails, sendWithPublicWallet) => {
+    try {
+        const relayAdaptUnshieldERC20AmountRecipients = (0, tx_cross_contract_calls_1.createRelayAdaptUnshieldERC20AmountRecipients)(networkName, [
+            wrappedERC20Amount,
+        ]);
+        // Empty NFT Recipients.
+        const nftAmountRecipients = [];
+        const overallBatchMinGasPrice = 0n;
+        const response = await (0, tx_gas_broadcaster_fee_estimator_1.gasEstimateResponseDummyProofIterativeBroadcasterFee)((broadcasterFeeERC20Amount) => (0, tx_generator_1.generateDummyProofTransactions)(shared_models_1.ProofType.UnshieldBaseToken, networkName, matrixWalletID, encryptionKey, false, // showSenderAddressToRecipient
+        undefined, // memoText
+        relayAdaptUnshieldERC20AmountRecipients, nftAmountRecipients, broadcasterFeeERC20Amount, sendWithPublicWallet, overallBatchMinGasPrice), (txs) => {
+            const relayAdaptParamsRandom = engine_1.ByteUtils.randomHex(31);
+            return (0, tx_generator_1.generateUnshieldBaseToken)(txs, networkName, publicWalletAddress, relayAdaptParamsRandom, true, // useDummyProof (for gas estimation)
+            sendWithPublicWallet);
+        }, networkName, matrixWalletID, relayAdaptUnshieldERC20AmountRecipients, originalGasDetails, feeTokenDetails, sendWithPublicWallet, false);
+        return response;
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.gasEstimateForUnprovenUnshieldBaseToken.name, err);
+    }
+};
+exports.gasEstimateForUnprovenUnshieldBaseToken = gasEstimateForUnprovenUnshieldBaseToken;
+async function extractTokenOwnerFromTransferEvents(receipt, matrixContractAddress) {
+    const matrixAddressLower = matrixContractAddress.toLowerCase();
+    const potentialOwners = new Set();
+    for (const log of receipt.logs) {
+        try {
+            if (log.topics.length < 3) {
+                continue;
+            }
+            if (log.topics[0] !== ERC20_TRANSFER_EVENT_SIGNATURE) {
+                continue;
+            }
+            // topics[0] = event signature hash
+            const toAddress = `0x${log.topics[2].slice(-40).toLowerCase()}`;
+            if (toAddress === matrixAddressLower) {
+                const fromAddress = `0x${log.topics[1].slice(-40)}`;
+                potentialOwners.add(fromAddress);
+            }
+        }
+        catch (error) {
+            console.warn('Error parsing log for token owner extraction:', error);
+            continue;
+        }
+    }
+    if (potentialOwners.size === 1) {
+        const [owner] = Array.from(potentialOwners);
+        return owner;
+    }
+    // this handles cases where there are multiple deposits in one transaction
+    if (potentialOwners.size > 1) {
+        const [firstOwner] = Array.from(potentialOwners);
+        return firstOwner;
+    }
+    throw new Error('Could not find token owner: No Transfer event to contract detected in transaction');
+}
+async function getTokenOwnerWithFallback(receipt, transaction, contractAddress) {
+    try {
+        const tokenOwner = await extractTokenOwnerFromTransferEvents(receipt, contractAddress);
+        return tokenOwner;
+    }
+    catch (error) {
+        return transaction.from;
+    }
+}
+const getERC20AndNFTAmountRecipientsForUnshieldToOrigin = async (networkName, matrixWalletID, originalShieldTxid) => {
+    const wallet = (0, matrix_1.walletForID)(matrixWalletID);
+    const chain = shared_models_1.NETWORK_CONFIG[networkName].chain;
+    const balances = await wallet.getTokenBalancesForUnshieldToOrigin(chain, originalShieldTxid);
+    const provider = (0, matrix_1.getFallbackProviderForNetwork)(networkName);
+    const [transaction, receipt] = await Promise.all([
+        provider.getTransaction(originalShieldTxid),
+        provider.getTransactionReceipt(originalShieldTxid),
+    ]);
+    if (!transaction) {
+        throw new Error('Could not find shield transaction from RPC');
+    }
+    if (!receipt) {
+        throw new Error('Could not find shield transaction receipt from RPC');
+    }
+    const network = shared_models_1.NETWORK_CONFIG[networkName];
+    const contractAddress = network.accumulatorContract;
+    if (!contractAddress) {
+        throw new Error(`Could not find contract for network: ${networkName}`);
+    }
+    const recipientAddress = await getTokenOwnerWithFallback(receipt, transaction, contractAddress);
+    const erc20Amounts = (0, matrix_1.getSerializedERC20Balances)(balances);
+    const nftAmounts = (0, matrix_1.getSerializedNFTBalances)(balances);
+    const erc20AmountRecipients = erc20Amounts
+        .filter(({ amount }) => amount > 0n)
+        .map(erc20Amount => ({
+        ...erc20Amount,
+        recipientAddress,
+    }));
+    const nftAmountRecipients = nftAmounts
+        .filter(({ amount }) => amount > 0n)
+        .map(nftAmount => ({
+        ...nftAmount,
+        recipientAddress,
+    }));
+    return { erc20AmountRecipients, nftAmountRecipients };
+};
+exports.getERC20AndNFTAmountRecipientsForUnshieldToOrigin = getERC20AndNFTAmountRecipientsForUnshieldToOrigin;
+const populateProvedUnshieldToOrigin = async (networkName, matrixWalletID, erc20AmountRecipients, nftAmountRecipients, gasDetails) => {
+    try {
+        const { transaction, nullifiers } = await (0, proof_cache_1.populateProvedTransaction)(networkName, shared_models_1.ProofType.Unshield, matrixWalletID, false, // showSenderAddressToRecipient
+        undefined, // memoText
+        erc20AmountRecipients, nftAmountRecipients, undefined, // relayAdaptUnshieldERC20AmountRecipients
+        undefined, // relayAdaptUnshieldNFTAmounts
+        undefined, // relayAdaptShieldERC20Recipients
+        undefined, // relayAdaptShieldNFTRecipients
+        undefined, // crossContractCalls
+        undefined, // broadcasterFeeERC20AmountRecipient
+        true, // sendWithPublicWallet
+        undefined, // overallBatchMinGasPrice
+        gasDetails);
+        return {
+            nullifiers,
+            transaction,
+        };
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.populateProvedUnshieldToOrigin.name, err);
+    }
+};
+exports.populateProvedUnshieldToOrigin = populateProvedUnshieldToOrigin;
+const gasEstimateForUnprovenUnshieldToOrigin = async (originalShieldTxid, networkName, matrixWalletID, encryptionKey, erc20AmountRecipients, nftAmountRecipients) => {
+    try {
+        // Use dead address for private transaction gas estimate
+        const fromWalletAddress = tx_generator_1.DUMMY_FROM_ADDRESS;
+        const overallBatchMinGasPrice = 0n;
+        const serializedTransactions = await (0, tx_generator_1.generateDummyProofTransactions)(shared_models_1.ProofType.Unshield, networkName, matrixWalletID, encryptionKey, false, // showSenderAddressToRecipient
+        undefined, // memoText
+        erc20AmountRecipients, nftAmountRecipients, undefined, // broadcasterFeeERC20Amount
+        true, // sendWithPublicWallet
+        overallBatchMinGasPrice, originalShieldTxid);
+        const transaction = await (0, tx_generator_1.generateTransact)(serializedTransactions, networkName, true);
+        const gasEstimate = await (0, tx_gas_details_1.getGasEstimate)(networkName, transaction, fromWalletAddress, true, // sendWithPublicWallet
+        false);
+        return (0, tx_gas_details_1.gasEstimateResponse)(gasEstimate, undefined, // broadcasterFeeCommitment
+        true);
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.gasEstimateForUnprovenUnshieldToOrigin.name, err);
+    }
+};
+exports.gasEstimateForUnprovenUnshieldToOrigin = gasEstimateForUnprovenUnshieldToOrigin;
+//# sourceMappingURL=tx-unshield.js.map

package/dist/services/transactions/tx-unshield.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tx-unshield.js","sourceRoot":"","sources":["../../../src/services/transactions/tx-unshield.ts"],"names":[],"mappings":";;;AAAA,iEAWuC;AACvC,iDAKwB;AACxB,+CAA0D;AAC1D,mDAGgC;AAChC,yFAA0G;AAC1G,uEAA0F;AAC1F,6CAA2D;AAC3D,qDAAuE;AACvE,sCAKmB;AAGnB,MAAM,8BAA8B,GAAG,oEAAoE,CAAC;AAErG,MAAM,sBAAsB,GAAG,KAAK,EACzC,WAAwB,EACxB,cAAsB,EACtB,qBAAmD,EACnD,mBAA+C,EAC/C,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,QAAQ,EAClB,cAAc,EACd,KAAK,EAAE,+BAA+B;QACtC,SAAS,EAAE,WAAW;QACtB,qBAAqB,EACrB,mBAAmB,EACnB,SAAS,EAAE,0CAA0C;QACrD,SAAS,EAAE,+BAA+B;QAC1C,SAAS,EAAE,kCAAkC;QAC7C,SAAS,EAAE,gCAAgC;QAC3C,SAAS,EAAE,qBAAqB;QAChC,kCAAkC,EAClC,oBAAoB,EACpB,uBAAuB,EACvB,UAAU,CACX,CAAC;QACJ,OAAO;YACL,UAAU;YACV,WAAW;SACZ,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,8BAAsB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KAChE;AACH,CAAC,CAAC;AArCW,QAAA,sBAAsB,0BAqCjC;AAEK,MAAM,+BAA+B,GAAG,KAAK,EAClD,WAAwB,EACxB,mBAA2B,EAC3B,cAAsB,EACtB,kBAAqC,EACrC,kCAAwE,EACxE,oBAA6B,EAC7B,uBAAyC,EACzC,UAAiC,EACW,EAAE;IAC9C,IAAI;QACF,MAAM,qBAAqB,GAAiC;YAC1D;gBACE,GAAG,kBAAkB;gBACrB,gBAAgB,EAAE,mBAAmB;aACtC;SACF,CAAC;QACF,MAAM,8BAA8B,GAAwB;YAC1D,kBAAkB;SACnB,CAAC;QAEF,wBAAwB;QACxB,MAAM,mBAAmB,GAA+B,EAAE,CAAC;QAE3D,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAC/B,MAAM,IAAA,uCAAyB,EAC7B,WAAW,EACX,yBAAS,CAAC,iBAAiB,EAC3B,cAAc,EACd,KAAK,EAAE,+BAA+B;QACtC,SAAS,EAAE,WAAW;QACtB,qBAAqB,EACrB,mBAAmB,EACnB,8BAA8B,EAC9B,SAAS,EAAE,+BAA+B;QAC1C,SAAS,EAAE,kCAAkC;QAC7C,SAAS,EAAE,gCAAgC;QAC3C,SAAS,EAAE,qBAAqB;QAChC,kCAAkC,EAClC,oBAAoB,EACpB,uBAAuB,EACvB,UAAU,CACX,CAAC;QACJ,OAAO;YACL,UAAU;YACV,WAAW;SACZ,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,uCAA+B,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KACzE;AACH,CAAC,CAAC;AAlDW,QAAA,+BAA+B,mCAkD1C;AAEK,MAAM,8BAA8B,GAAG,KAAK,EACjD,WAAwB,EACxB,cAAsB,EACtB,aAAqB,EACrB,qBAAmD,EACnD,mBAA+C,EAC/C,kBAAyC,EACzC,eAA0C,EAC1C,oBAA6B,EACkB,EAAE;IACjD,IAAI;QACF,MAAM,uBAAuB,GAAG,EAAE,CAAC;QAEnC,MAAM,QAAQ,GAAG,MAAM,IAAA,uFAAoD,EACzE,CAAC,yBAAsD,EAAE,EAAE,CACzD,IAAA,6CAA8B,EAC5B,yBAAS,CAAC,QAAQ,EAClB,WAAW,EACX,cAAc,EACd,aAAa,EACb,KAAK,EAAE,+BAA+B;QACtC,SAAS,EAAE,WAAW;QACtB,qBAAqB,EACrB,mBAAmB,EACnB,yBAAyB,EACzB,oBAAoB,EACpB,uBAAuB,CACxB,EACH,CAAC,GAA0B,EAAE,EAAE,CAC7B,IAAA,+BAAgB,EACd,GAAG,EACH,WAAW,EACX,IAAI,CACL,EACH,WAAW,EACX,cAAc,EACd,qBAAqB,EACrB,kBAAkB,EAClB,eAAe,EACf,oBAAoB,EACpB,KAAK,CACN,CAAC;QACF,OAAO,QAAQ,CAAC;KACjB;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,sCAA8B,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KACxE;AACH,CAAC,CAAC;AA9CW,QAAA,8BAA8B,kCA8CzC;AAEK,MAAM,uCAAuC,GAAG,KAAK,EAC1D,WAAwB,EACxB,mBAA2B,EAC3B,cAAsB,EACtB,aAAqB,EACrB,kBAAqC,EACrC,kBAAyC,EACzC,eAA0C,EAC1C,oBAA6B,EACkB,EAAE;IACjD,IAAI;QACF,MAAM,uCAAuC,GAC3C,IAAA,uEAA6C,EAAC,WAAW,EAAE;YACzD,kBAAkB;SACnB,CAAC,CAAC;QAEL,wBAAwB;QACxB,MAAM,mBAAmB,GAA+B,EAAE,CAAC;QAE3D,MAAM,uBAAuB,GAAG,EAAE,CAAC;QAEnC,MAAM,QAAQ,GAAG,MAAM,IAAA,uFAAoD,EACzE,CAAC,yBAAsD,EAAE,EAAE,CACzD,IAAA,6CAA8B,EAC5B,yBAAS,CAAC,iBAAiB,EAC3B,WAAW,EACX,cAAc,EACd,aAAa,EACb,KAAK,EAAE,+BAA+B;QACtC,SAAS,EAAE,WAAW;QACtB,uCAAuC,EACvC,mBAAmB,EACnB,yBAAyB,EACzB,oBAAoB,EACpB,uBAAuB,CACxB,EACH,CAAC,GAA0B,EAAE,EAAE;YAC7B,MAAM,sBAAsB,GAAG,kBAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YACvD,OAAO,IAAA,wCAAyB,EAC9B,GAAG,EACH,WAAW,EACX,mBAAmB,EACnB,sBAAsB,EACtB,IAAI,EAAE,qCAAqC;YAC3C,oBAAoB,CACrB,CAAC;QACJ,CAAC,EACD,WAAW,EACX,cAAc,EACd,uCAAuC,EACvC,kBAAkB,EAClB,eAAe,EACf,oBAAoB,EACpB,KAAK,CACN,CAAC;QACF,OAAO,QAAQ,CAAC;KACjB;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAC1B,+CAAuC,CAAC,IAAI,EAC5C,GAAG,CACJ,CAAC;KACH;AACH,CAAC,CAAC;AA9DW,QAAA,uCAAuC,2CA8DlD;AAEF,KAAK,UAAU,mCAAmC,CAChD,OAA2B,EAC3B,qBAA6B;IAE7B,MAAM,kBAAkB,GAAG,qBAAqB,CAAC,WAAW,EAAE,CAAC;IAE/D,MAAM,eAAe,GAAgB,IAAI,GAAG,EAAE,CAAC;IAE/C,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE;QAC9B,IAAI;YACF,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;gBACzB,SAAS;aACV;YAED,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,8BAA8B,EAAE;gBACpD,SAAS;aACV;YACD,mCAAmC;YACnC,MAAM,SAAS,GAAG,KAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;YAElE,IAAI,SAAS,KAAK,kBAAkB,EAAE;gBACpC,MAAM,WAAW,GAAG,KAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;gBACtD,eAAe,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;aAClC;SACF;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,CAAC,IAAI,CAAC,+CAA+C,EAAE,KAAK,CAAC,CAAC;YACrE,SAAS;SACV;KACF;IAED,IAAI,eAAe,CAAC,IAAI,KAAK,CAAC,EAAE;QAC9B,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC5C,OAAO,KAAK,CAAC;KACd;IACD,0EAA0E;IAC1E,IAAI,eAAe,CAAC,IAAI,GAAG,CAAC,EAAE;QAC5B,MAAM,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACjD,OAAO,UAAU,CAAC;KACnB;IAED,MAAM,IAAI,KAAK,CACb,mFAAmF,CACpF,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,yBAAyB,CACtC,OAA2B,EAC3B,WAAgC,EAChC,eAAuB;IAEvB,IAAI;QACF,MAAM,UAAU,GAAG,MAAM,mCAAmC,CAC1D,OAAO,EACP,eAAe,CAChB,CAAC;QACF,OAAO,UAAU,CAAC;KACnB;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,WAAW,CAAC,IAAI,CAAC;KACzB;AACH,CAAC;AAEM,MAAM,iDAAiD,GAAG,KAAK,EACpE,WAAwB,EACxB,cAAsB,EACtB,kBAA0B,EAIzB,EAAE;IACH,MAAM,MAAM,GAAG,IAAA,oBAAW,EAAC,cAAc,CAAC,CAAC;IAC3C,MAAM,KAAK,GAAG,8BAAc,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC;IAEhD,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,mCAAmC,CAC/D,KAAK,EACL,kBAAkB,CACnB,CAAC;IAEF,MAAM,QAAQ,GAAG,IAAA,sCAA6B,EAAC,WAAW,CAAC,CAAC;IAE5D,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAC/C,QAAQ,CAAC,cAAc,CAAC,kBAAkB,CAAC;QAC3C,QAAQ,CAAC,qBAAqB,CAAC,kBAAkB,CAAC;KACnD,CAAC,CAAC;IAEH,IAAI,CAAC,WAAW,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;KAC/D;IAED,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;KACvE;IAED,MAAM,OAAO,GAAG,8BAAc,CAAC,WAAW,CAAC,CAAC;IAC5C,MAAM,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAEpD,IAAI,CAAC,eAAe,EAAE;QACpB,MAAM,IAAI,KAAK,CAAC,wCAAwC,WAAW,EAAE,CAAC,CAAC;KACxE;IAED,MAAM,gBAAgB,GAAG,MAAM,yBAAyB,CACtD,OAAO,EACP,WAAW,EACX,eAAe,CAChB,CAAC;IACF,MAAM,YAAY,GAAG,IAAA,mCAA0B,EAAC,QAAQ,CAAC,CAAC;IAC1D,MAAM,UAAU,GAAG,IAAA,iCAAwB,EAAC,QAAQ,CAAC,CAAC;IACtD,MAAM,qBAAqB,GAAiC,YAAY;SACrE,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC;SACnC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACnB,GAAG,WAAW;QACd,gBAAgB;KACjB,CAAC,CAAC,CAAC;IACN,MAAM,mBAAmB,GAA+B,UAAU;SAC/D,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC;SACnC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACjB,GAAG,SAAS;QACZ,gBAAgB;KACjB,CAAC,CAAC,CAAC;IACN,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,CAAC;AACxD,CAAC,CAAC;AA1DW,QAAA,iDAAiD,qDA0D5D;AAEK,MAAM,8BAA8B,GAAG,KAAK,EACjD,WAAwB,EACxB,cAAsB,EACtB,qBAAmD,EACnD,mBAA+C,EAC/C,UAAiC,EACW,EAAE;IAC9C,IAAI;QACF,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAC/B,MAAM,IAAA,uCAAyB,EAC7B,WAAW,EACX,yBAAS,CAAC,QAAQ,EAClB,cAAc,EACd,KAAK,EAAE,+BAA+B;QACtC,SAAS,EAAE,WAAW;QACtB,qBAAqB,EACrB,mBAAmB,EACnB,SAAS,EAAE,0CAA0C;QACrD,SAAS,EAAE,+BAA+B;QAC1C,SAAS,EAAE,kCAAkC;QAC7C,SAAS,EAAE,gCAAgC;QAC3C,SAAS,EAAE,qBAAqB;QAChC,SAAS,EAAE,qCAAqC;QAChD,IAAI,EAAE,uBAAuB;QAC7B,SAAS,EAAE,0BAA0B;QACrC,UAAU,CACX,CAAC;QACJ,OAAO;YACL,UAAU;YACV,WAAW;SACZ,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,sCAA8B,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KACxE;AACH,CAAC,CAAC;AAlCW,QAAA,8BAA8B,kCAkCzC;AAEK,MAAM,sCAAsC,GAAG,KAAK,EACzD,kBAA0B,EAC1B,WAAwB,EACxB,cAAsB,EACtB,aAAqB,EACrB,qBAAmD,EACnD,mBAA+C,EACA,EAAE;IACjD,IAAI;QACF,wDAAwD;QACxD,MAAM,iBAAiB,GAAG,iCAAkB,CAAC;QAE7C,MAAM,uBAAuB,GAAG,EAAE,CAAC;QAEnC,MAAM,sBAAsB,GAAG,MAAM,IAAA,6CAA8B,EACjE,yBAAS,CAAC,QAAQ,EAClB,WAAW,EACX,cAAc,EACd,aAAa,EACb,KAAK,EAAE,+BAA+B;QACtC,SAAS,EAAE,WAAW;QACtB,qBAAqB,EACrB,mBAAmB,EACnB,SAAS,EAAE,4BAA4B;QACvC,IAAI,EAAE,uBAAuB;QAC7B,uBAAuB,EACvB,kBAAkB,CACnB,CAAC;QACF,MAAM,WAAW,GAAG,MAAM,IAAA,+BAAgB,EACxC,sBAAsB,EACtB,WAAW,EACX,IAAI,CACL,CAAC;QAEF,MAAM,WAAW,GAAG,MAAM,IAAA,+BAAc,EACtC,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,IAAI,EAAE,uBAAuB;QAC7B,KAAK,CACN,CAAC;QAEF,OAAO,IAAA,oCAAmB,EACxB,WAAW,EACX,SAAS,EAAE,2BAA2B;QACtC,IAAI,CACL,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAC1B,8CAAsC,CAAC,IAAI,EAC3C,GAAG,CACJ,CAAC;KACH;AACH,CAAC,CAAC;AArDW,QAAA,sCAAsC,0CAqDjD","sourcesContent":["import {\n  MatrixPopulateTransactionResponse,\n  MatrixTransactionGasEstimateResponse,\n  MatrixERC20Amount,\n  NetworkName,\n  ProofType,\n  FeeTokenDetails,\n  MatrixERC20AmountRecipient,\n  MatrixNFTAmountRecipient,\n  TransactionGasDetails,\n  NETWORK_CONFIG,\n} from '@matrix-privacy/shared-models';\nimport {\n  DUMMY_FROM_ADDRESS,\n  generateDummyProofTransactions,\n  generateTransact,\n  generateUnshieldBaseToken,\n} from './tx-generator';\nimport { populateProvedTransaction } from './proof-cache';\nimport {\n  ByteUtils,\n  TransactionStructV3,\n} from '@matrix-privacy/engine';\nimport { gasEstimateResponseDummyProofIterativeBroadcasterFee } from './tx-gas-broadcaster-fee-estimator';\nimport { createRelayAdaptUnshieldERC20AmountRecipients } from './tx-cross-contract-calls';\nimport { reportAndSanitizeError } from '../../utils/error';\nimport { gasEstimateResponse, getGasEstimate } from './tx-gas-details';\nimport {\n  walletForID,\n  getFallbackProviderForNetwork,\n  getSerializedERC20Balances,\n  getSerializedNFTBalances,\n} from '../matrix';\nimport { TransactionReceipt, TransactionResponse } from 'ethers';\n\nconst ERC20_TRANSFER_EVENT_SIGNATURE = '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef';\n\nexport const populateProvedUnshield = async (\n  networkName: NetworkName,\n  matrixWalletID: string,\n  erc20AmountRecipients: MatrixERC20AmountRecipient[],\n  nftAmountRecipients: MatrixNFTAmountRecipient[],\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.Unshield,\n        matrixWalletID,\n        false, // showSenderAddressToRecipient\n        undefined, // memoText\n        erc20AmountRecipients,\n        nftAmountRecipients,\n        undefined, // relayAdaptUnshieldERC20AmountRecipients\n        undefined, // relayAdaptUnshieldNFTAmounts\n        undefined, // relayAdaptShieldERC20Recipients\n        undefined, // relayAdaptShieldNFTRecipients\n        undefined, // crossContractCalls\n        broadcasterFeeERC20AmountRecipient,\n        sendWithPublicWallet,\n        overallBatchMinGasPrice,\n        gasDetails,\n      );\n    return {\n      nullifiers,\n      transaction,\n    };\n  } catch (err) {\n    throw reportAndSanitizeError(populateProvedUnshield.name, err);\n  }\n};\n\nexport const populateProvedUnshieldBaseToken = async (\n  networkName: NetworkName,\n  publicWalletAddress: string,\n  matrixWalletID: string,\n  wrappedERC20Amount: MatrixERC20Amount,\n  broadcasterFeeERC20AmountRecipient: Optional<MatrixERC20AmountRecipient>,\n  sendWithPublicWallet: boolean,\n  overallBatchMinGasPrice: Optional<bigint>,\n  gasDetails: TransactionGasDetails,\n): Promise<MatrixPopulateTransactionResponse> => {\n  try {\n    const erc20AmountRecipients: MatrixERC20AmountRecipient[] = [\n      {\n        ...wrappedERC20Amount,\n        recipientAddress: publicWalletAddress,\n      },\n    ];\n    const relayAdaptUnshieldERC20Amounts: MatrixERC20Amount[] = [\n      wrappedERC20Amount,\n    ];\n\n    // Empty NFT Recipients.\n    const nftAmountRecipients: MatrixNFTAmountRecipient[] = [];\n\n    const { transaction, nullifiers } =\n      await populateProvedTransaction(\n        networkName,\n        ProofType.UnshieldBaseToken,\n        matrixWalletID,\n        false, // showSenderAddressToRecipient\n        undefined, // memoText\n        erc20AmountRecipients,\n        nftAmountRecipients,\n        relayAdaptUnshieldERC20Amounts,\n        undefined, // relayAdaptUnshieldNFTAmounts\n        undefined, // relayAdaptShieldERC20Recipients\n        undefined, // relayAdaptShieldNFTRecipients\n        undefined, // crossContractCalls\n        broadcasterFeeERC20AmountRecipient,\n        sendWithPublicWallet,\n        overallBatchMinGasPrice,\n        gasDetails,\n      );\n    return {\n      nullifiers,\n      transaction,\n    };\n  } catch (err) {\n    throw reportAndSanitizeError(populateProvedUnshieldBaseToken.name, err);\n  }\n};\n\nexport const gasEstimateForUnprovenUnshield = async (\n  networkName: NetworkName,\n  matrixWalletID: string,\n  encryptionKey: string,\n  erc20AmountRecipients: MatrixERC20AmountRecipient[],\n  nftAmountRecipients: MatrixNFTAmountRecipient[],\n  originalGasDetails: TransactionGasDetails,\n  feeTokenDetails: Optional<FeeTokenDetails>,\n  sendWithPublicWallet: boolean,\n): Promise<MatrixTransactionGasEstimateResponse> => {\n  try {\n    const overallBatchMinGasPrice = 0n;\n\n    const response = await gasEstimateResponseDummyProofIterativeBroadcasterFee(\n      (broadcasterFeeERC20Amount: Optional<MatrixERC20Amount>) =>\n        generateDummyProofTransactions(\n          ProofType.Unshield,\n          networkName,\n          matrixWalletID,\n          encryptionKey,\n          false, // showSenderAddressToRecipient\n          undefined, // memoText\n          erc20AmountRecipients,\n          nftAmountRecipients,\n          broadcasterFeeERC20Amount,\n          sendWithPublicWallet,\n          overallBatchMinGasPrice,\n        ),\n      (txs: TransactionStructV3[]) =>\n        generateTransact(\n          txs,\n          networkName,\n          true, // useDummyProof\n        ),\n      networkName,\n      matrixWalletID,\n      erc20AmountRecipients,\n      originalGasDetails,\n      feeTokenDetails,\n      sendWithPublicWallet,\n      false, // isCrossContractCall\n    );\n    return response;\n  } catch (err) {\n    throw reportAndSanitizeError(gasEstimateForUnprovenUnshield.name, err);\n  }\n};\n\nexport const gasEstimateForUnprovenUnshieldBaseToken = async (\n  networkName: NetworkName,\n  publicWalletAddress: string,\n  matrixWalletID: string,\n  encryptionKey: string,\n  wrappedERC20Amount: MatrixERC20Amount,\n  originalGasDetails: TransactionGasDetails,\n  feeTokenDetails: Optional<FeeTokenDetails>,\n  sendWithPublicWallet: boolean,\n): Promise<MatrixTransactionGasEstimateResponse> => {\n  try {\n    const relayAdaptUnshieldERC20AmountRecipients: MatrixERC20AmountRecipient[] =\n      createRelayAdaptUnshieldERC20AmountRecipients(networkName, [\n        wrappedERC20Amount,\n      ]);\n\n    // Empty NFT Recipients.\n    const nftAmountRecipients: MatrixNFTAmountRecipient[] = [];\n\n    const overallBatchMinGasPrice = 0n;\n\n    const response = await gasEstimateResponseDummyProofIterativeBroadcasterFee(\n      (broadcasterFeeERC20Amount: Optional<MatrixERC20Amount>) =>\n        generateDummyProofTransactions(\n          ProofType.UnshieldBaseToken,\n          networkName,\n          matrixWalletID,\n          encryptionKey,\n          false, // showSenderAddressToRecipient\n          undefined, // memoText\n          relayAdaptUnshieldERC20AmountRecipients,\n          nftAmountRecipients,\n          broadcasterFeeERC20Amount,\n          sendWithPublicWallet,\n          overallBatchMinGasPrice,\n        ),\n      (txs: TransactionStructV3[]) => {\n        const relayAdaptParamsRandom = ByteUtils.randomHex(31);\n        return generateUnshieldBaseToken(\n          txs,\n          networkName,\n          publicWalletAddress,\n          relayAdaptParamsRandom,\n          true, // useDummyProof (for gas estimation)\n          sendWithPublicWallet,\n        );\n      },\n      networkName,\n      matrixWalletID,\n      relayAdaptUnshieldERC20AmountRecipients,\n      originalGasDetails,\n      feeTokenDetails,\n      sendWithPublicWallet,\n      false, // isCrossContractCall\n    );\n    return response;\n  } catch (err) {\n    throw reportAndSanitizeError(\n      gasEstimateForUnprovenUnshieldBaseToken.name,\n      err,\n    );\n  }\n};\n\nasync function extractTokenOwnerFromTransferEvents(\n  receipt: TransactionReceipt,\n  matrixContractAddress: string\n): Promise<string> {\n  const matrixAddressLower = matrixContractAddress.toLowerCase();\n\n  const potentialOwners: Set<string> = new Set();\n\n  for (const log of receipt.logs) {\n    try {\n      if (log.topics.length < 3) {\n        continue;\n      }\n\n      if (log.topics[0] !== ERC20_TRANSFER_EVENT_SIGNATURE) {\n        continue;\n      }\n      // topics[0] = event signature hash\n      const toAddress = `0x${  log.topics[2].slice(-40).toLowerCase()}`;\n\n      if (toAddress === matrixAddressLower) {\n        const fromAddress = `0x${  log.topics[1].slice(-40)}`;\n        potentialOwners.add(fromAddress);\n      }\n    } catch (error) {\n      console.warn('Error parsing log for token owner extraction:', error);\n      continue;\n    }\n  }\n\n  if (potentialOwners.size === 1) {\n    const [owner] = Array.from(potentialOwners);\n    return owner;\n  }\n  // this handles cases where there are multiple deposits in one transaction\n  if (potentialOwners.size > 1) {\n    const [firstOwner] = Array.from(potentialOwners);\n    return firstOwner;\n  }\n\n  throw new Error(\n    'Could not find token owner: No Transfer event to contract detected in transaction'\n  );\n}\n\nasync function getTokenOwnerWithFallback(\n  receipt: TransactionReceipt,\n  transaction: TransactionResponse,\n  contractAddress: string\n): Promise<string> {\n  try {\n    const tokenOwner = await extractTokenOwnerFromTransferEvents(\n      receipt,\n      contractAddress\n    );\n    return tokenOwner;\n  } catch (error) {\n    return transaction.from;\n  }\n}\n\nexport const getERC20AndNFTAmountRecipientsForUnshieldToOrigin = async (\n  networkName: NetworkName,\n  matrixWalletID: string,\n  originalShieldTxid: string,\n): Promise<{\n  erc20AmountRecipients: MatrixERC20AmountRecipient[];\n  nftAmountRecipients: MatrixNFTAmountRecipient[];\n}> => {\n  const wallet = walletForID(matrixWalletID);\n  const chain = NETWORK_CONFIG[networkName].chain;\n\n  const balances = await wallet.getTokenBalancesForUnshieldToOrigin(\n    chain,\n    originalShieldTxid,\n  );\n\n  const provider = getFallbackProviderForNetwork(networkName);\n\n  const [transaction, receipt] = await Promise.all([\n    provider.getTransaction(originalShieldTxid),\n    provider.getTransactionReceipt(originalShieldTxid),\n  ]);\n\n  if (!transaction) {\n    throw new Error('Could not find shield transaction from RPC');\n  }\n\n  if (!receipt) {\n    throw new Error('Could not find shield transaction receipt from RPC');\n  }\n\n  const network = NETWORK_CONFIG[networkName];\n  const contractAddress = network.accumulatorContract;\n\n  if (!contractAddress) {\n    throw new Error(`Could not find contract for network: ${networkName}`);\n  }\n\n  const recipientAddress = await getTokenOwnerWithFallback(\n    receipt,\n    transaction,\n    contractAddress\n  );\n  const erc20Amounts = getSerializedERC20Balances(balances);\n  const nftAmounts = getSerializedNFTBalances(balances);\n  const erc20AmountRecipients: MatrixERC20AmountRecipient[] = erc20Amounts\n    .filter(({ amount }) => amount > 0n)\n    .map(erc20Amount => ({\n      ...erc20Amount,\n      recipientAddress,\n    }));\n  const nftAmountRecipients: MatrixNFTAmountRecipient[] = nftAmounts\n    .filter(({ amount }) => amount > 0n)\n    .map(nftAmount => ({\n      ...nftAmount,\n      recipientAddress,\n    }));\n  return { erc20AmountRecipients, nftAmountRecipients };\n};\n\nexport const populateProvedUnshieldToOrigin = async (\n  networkName: NetworkName,\n  matrixWalletID: string,\n  erc20AmountRecipients: MatrixERC20AmountRecipient[],\n  nftAmountRecipients: MatrixNFTAmountRecipient[],\n  gasDetails: TransactionGasDetails,\n): Promise<MatrixPopulateTransactionResponse> => {\n  try {\n    const { transaction, nullifiers } =\n      await populateProvedTransaction(\n        networkName,\n        ProofType.Unshield,\n        matrixWalletID,\n        false, // showSenderAddressToRecipient\n        undefined, // memoText\n        erc20AmountRecipients,\n        nftAmountRecipients,\n        undefined, // relayAdaptUnshieldERC20AmountRecipients\n        undefined, // relayAdaptUnshieldNFTAmounts\n        undefined, // relayAdaptShieldERC20Recipients\n        undefined, // relayAdaptShieldNFTRecipients\n        undefined, // crossContractCalls\n        undefined, // broadcasterFeeERC20AmountRecipient\n        true, // sendWithPublicWallet\n        undefined, // overallBatchMinGasPrice\n        gasDetails,\n      );\n    return {\n      nullifiers,\n      transaction,\n    };\n  } catch (err) {\n    throw reportAndSanitizeError(populateProvedUnshieldToOrigin.name, err);\n  }\n};\n\nexport const gasEstimateForUnprovenUnshieldToOrigin = async (\n  originalShieldTxid: string,\n  networkName: NetworkName,\n  matrixWalletID: string,\n  encryptionKey: string,\n  erc20AmountRecipients: MatrixERC20AmountRecipient[],\n  nftAmountRecipients: MatrixNFTAmountRecipient[],\n): Promise<MatrixTransactionGasEstimateResponse> => {\n  try {\n    // Use dead address for private transaction gas estimate\n    const fromWalletAddress = DUMMY_FROM_ADDRESS;\n\n    const overallBatchMinGasPrice = 0n;\n\n    const serializedTransactions = await generateDummyProofTransactions(\n      ProofType.Unshield,\n      networkName,\n      matrixWalletID,\n      encryptionKey,\n      false, // showSenderAddressToRecipient\n      undefined, // memoText\n      erc20AmountRecipients,\n      nftAmountRecipients,\n      undefined, // broadcasterFeeERC20Amount\n      true, // sendWithPublicWallet\n      overallBatchMinGasPrice,\n      originalShieldTxid, // originShieldTxidForSpendabilityOverride\n    );\n    const transaction = await generateTransact(\n      serializedTransactions,\n      networkName,\n      true, // useDummyProof\n    );\n\n    const gasEstimate = await getGasEstimate(\n      networkName,\n      transaction,\n      fromWalletAddress,\n      true, // sendWithPublicWallet\n      false, // isCrossContractCall\n    );\n\n    return gasEstimateResponse(\n      gasEstimate,\n      undefined, // broadcasterFeeCommitment\n      true, // isGasEstimateWithDummyProof\n    );\n  } catch (err) {\n    throw reportAndSanitizeError(\n      gasEstimateForUnprovenUnshieldToOrigin.name,\n      err,\n    );\n  }\n};\n"]}

package/dist/tests/local-e2e.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Local E2E test for Matrix wallet against a local Ganache/Hardhat node.
+ *
+ * Prerequisites:
+ *   1. Start local node:  ./ganache.sh  (or: npx hardhat node)
+ *   2. Deploy contracts:  cd matrix-contracts && yarn hardhat deploy:full --network localhost
+ *   3. Fill in deployed addresses in wallet/local-deploy.json.example
+ *      (also set "mnemonic" and "userPrivateKey" matching your local node)
+ *
+ * Run:
+ *   cd wallet && npx ts-node -P tsconfig.test.json src/tests/local-e2e.ts
+ */
+export {};