@matrix-privacy/shared-models 0.0.1

package/dist/models/response-types.d.ts

@@ -0,0 +1,200 @@
+import { ContractTransaction } from 'ethers';
+import { MerkletreeScanStatus } from './merkletree-scan';
+import { FeesSerialized } from './network-config';
+import { MatrixWalletBalanceBucket } from './balance';
+import type { Optional } from '../types/global';
+/**
+ * Type0 / Type1 = non-EIP-1559 (gasPrice).
+ * Type2 = EIP-1559 (maxFeePerGas and maxPriorityFeePerGas).
+ */
+export declare enum EVMGasType {
+    Type0 = 0,
+    Type1 = 1,
+    Type2 = 2,
+    Type4 = 4
+}
+export type TransactionGasDetails = TransactionGasDetailsType0 | TransactionGasDetailsType1 | TransactionGasDetailsType2 | TransactionGasDetailsType4;
+export type TransactionGasDetailsType0 = {
+    evmGasType: EVMGasType.Type0;
+    gasEstimate: bigint;
+    gasPrice: bigint;
+};
+export type TransactionGasDetailsType1 = {
+    evmGasType: EVMGasType.Type1;
+    gasEstimate: bigint;
+    gasPrice: bigint;
+};
+export type TransactionGasDetailsType2 = {
+    evmGasType: EVMGasType.Type2;
+    gasEstimate: bigint;
+    maxFeePerGas: bigint;
+    maxPriorityFeePerGas: bigint;
+};
+export type TransactionGasDetailsType4 = {
+    evmGasType: EVMGasType.Type4;
+    gasEstimate: bigint;
+    maxFeePerGas: bigint;
+    maxPriorityFeePerGas: bigint;
+};
+export type FeeTokenDetails = {
+    tokenAddress: string;
+    feePerUnitGas: bigint;
+};
+export declare enum ChainType {
+    EVM = 0
+}
+export type Chain = {
+    type: ChainType;
+    id: number;
+};
+export type MatrixBalancesEvent = {
+    chain: Chain;
+    matrixWalletID: string;
+    balanceBucket: MatrixWalletBalanceBucket;
+    erc20Amounts: MatrixERC20Amount[];
+    nftAmounts: MatrixNFTAmount[];
+};
+export type ProofProgressEvent = {
+    progress: number;
+    status: string;
+};
+export type MerkletreeScanUpdateEvent = {
+    chain: Chain;
+    scanStatus: MerkletreeScanStatus;
+    progress: number;
+};
+export type LoadProviderResponse = {
+    feesSerialized: FeesSerialized;
+};
+export type MatrixWalletInfo = {
+    id: string;
+    matrixAddress: string;
+};
+export type MatrixWalletAddressData = {
+    masterPublicKey: bigint;
+    viewingPublicKey: bigint;
+};
+export type MatrixTxidFromNullifiersResponse = {
+    txid?: string;
+};
+export type Proof = {
+    pi_a: [string, string];
+    pi_b: [[string, string], [string, string]];
+    pi_c: [string, string];
+};
+export type MatrixPopulateTransactionResponse = {
+    transaction: ContractTransaction;
+    nullifiers?: string[];
+};
+export type MatrixTransactionGasEstimateResponse = {
+    gasEstimate: bigint;
+};
+export type MatrixERC20Recipient = {
+    tokenAddress: string;
+    recipientAddress: string;
+};
+export type MatrixERC20Amount = {
+    tokenAddress: string;
+    amount: bigint;
+};
+export type MatrixERC20AmountRecipient = MatrixERC20Amount & {
+    recipientAddress: string;
+};
+/**
+ * Synced NFT types from TokenType (@matrix/engine).
+ */
+export declare enum NFTTokenType {
+    ERC721 = 1,
+    ERC1155 = 2
+}
+export type NFTAmount = {
+    nftAddress: string;
+    nftTokenType: NFTTokenType;
+    tokenSubID: string;
+    amountString: string;
+};
+export type NFTAmountRecipient = NFTAmount & {
+    recipientAddress: string;
+};
+export type MatrixNFTAmount = {
+    nftAddress: string;
+    nftTokenType: NFTTokenType;
+    tokenSubID: string;
+    amount: bigint;
+};
+export type MatrixNFTAmountRecipient = MatrixNFTAmount & {
+    recipientAddress: string;
+};
+export type EncryptDataWithSharedKeyResponse = {
+    encryptedData: [string, string];
+    randomPubKey: string;
+    sharedKey: Uint8Array;
+};
+export type EncryptDataWithSharedKeySerialized = {
+    encryptedData: [string, string];
+    randomPubKey: string;
+    sharedKey: string;
+};
+export type Pbkdf2Response = string;
+type SendAdditionalData = {
+    recipientAddress: Optional<string>;
+    walletSource: Optional<string>;
+    memoText: Optional<string>;
+};
+export type MatrixHistoryERC20Amount = MatrixERC20Amount;
+export type MatrixHistoryNFTAmount = MatrixNFTAmount;
+export type MatrixHistorySendERC20Amount = MatrixHistoryERC20Amount & SendAdditionalData;
+export type MatrixHistorySendNFTAmount = MatrixHistoryNFTAmount & SendAdditionalData;
+type UnshieldAdditionalData = {
+    unshieldFee: Optional<string>;
+};
+export type MatrixHistoryUnshieldERC20Amount = MatrixHistorySendERC20Amount & UnshieldAdditionalData;
+export type MatrixHistoryUnshieldNFTAmount = MatrixHistorySendNFTAmount & UnshieldAdditionalData;
+type ReceiveAdditionalData = {
+    senderAddress: Optional<string>;
+    memoText: Optional<string>;
+    shieldFee: Optional<string>;
+    balanceBucket: MatrixWalletBalanceBucket;
+};
+export type MatrixHistoryReceiveERC20Amount = MatrixHistoryERC20Amount & ReceiveAdditionalData;
+export type MatrixHistoryReceiveNFTAmount = MatrixHistoryNFTAmount & ReceiveAdditionalData;
+export declare enum TransactionHistoryItemCategory {
+    ShieldERC20s = "ShieldERC20s",
+    UnshieldERC20s = "UnshieldERC20s",
+    TransferSendERC20s = "TransferSendERC20s",
+    TransferReceiveERC20s = "TransferReceiveERC20s",
+    Unknown = "Unknown"
+}
+export type TransactionHistoryItem = {
+    txid: string;
+    version: number;
+    timestamp: Optional<number>;
+    blockNumber: Optional<number>;
+    receiveERC20Amounts: MatrixHistoryReceiveERC20Amount[];
+    transferERC20Amounts: MatrixHistorySendERC20Amount[];
+    changeERC20Amounts: MatrixHistoryERC20Amount[];
+    unshieldERC20Amounts: MatrixHistoryUnshieldERC20Amount[];
+    receiveNFTAmounts: MatrixHistoryReceiveNFTAmount[];
+    transferNFTAmounts: MatrixHistorySendNFTAmount[];
+    unshieldNFTAmounts: MatrixHistoryUnshieldNFTAmount[];
+    category: TransactionHistoryItemCategory;
+};
+export declare enum XChaChaEncryptionAlgorithm {
+    XChaCha = "XChaCha",
+    XChaChaPoly1305 = "XChaChaPoly1305"
+}
+export type CiphertextXChaCha = {
+    algorithm: XChaChaEncryptionAlgorithm;
+    nonce: string;
+    bundle: string;
+};
+export type CommitmentCiphertextV3 = {
+    ciphertext: CiphertextXChaCha;
+    blindedSenderViewingKey: string;
+    blindedReceiverViewingKey: string;
+};
+export type CommitmentSummary = {
+    commitmentCiphertext: CommitmentCiphertextV3;
+    commitmentHash: string;
+};
+export {};

package/dist/models/response-types.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XChaChaEncryptionAlgorithm = exports.TransactionHistoryItemCategory = exports.NFTTokenType = exports.ChainType = exports.EVMGasType = void 0;
+/**
+ * Type0 / Type1 = non-EIP-1559 (gasPrice).
+ * Type2 = EIP-1559 (maxFeePerGas and maxPriorityFeePerGas).
+ */
+var EVMGasType;
+(function (EVMGasType) {
+    EVMGasType[EVMGasType["Type0"] = 0] = "Type0";
+    EVMGasType[EVMGasType["Type1"] = 1] = "Type1";
+    EVMGasType[EVMGasType["Type2"] = 2] = "Type2";
+    EVMGasType[EVMGasType["Type4"] = 4] = "Type4";
+})(EVMGasType || (exports.EVMGasType = EVMGasType = {}));
+var ChainType;
+(function (ChainType) {
+    ChainType[ChainType["EVM"] = 0] = "EVM";
+})(ChainType || (exports.ChainType = ChainType = {}));
+/**
+ * Synced NFT types from TokenType (@matrix/engine).
+ */
+var NFTTokenType;
+(function (NFTTokenType) {
+    NFTTokenType[NFTTokenType["ERC721"] = 1] = "ERC721";
+    NFTTokenType[NFTTokenType["ERC1155"] = 2] = "ERC1155";
+})(NFTTokenType || (exports.NFTTokenType = NFTTokenType = {}));
+var TransactionHistoryItemCategory;
+(function (TransactionHistoryItemCategory) {
+    TransactionHistoryItemCategory["ShieldERC20s"] = "ShieldERC20s";
+    TransactionHistoryItemCategory["UnshieldERC20s"] = "UnshieldERC20s";
+    TransactionHistoryItemCategory["TransferSendERC20s"] = "TransferSendERC20s";
+    TransactionHistoryItemCategory["TransferReceiveERC20s"] = "TransferReceiveERC20s";
+    TransactionHistoryItemCategory["Unknown"] = "Unknown";
+})(TransactionHistoryItemCategory || (exports.TransactionHistoryItemCategory = TransactionHistoryItemCategory = {}));
+var XChaChaEncryptionAlgorithm;
+(function (XChaChaEncryptionAlgorithm) {
+    XChaChaEncryptionAlgorithm["XChaCha"] = "XChaCha";
+    XChaChaEncryptionAlgorithm["XChaChaPoly1305"] = "XChaChaPoly1305";
+})(XChaChaEncryptionAlgorithm || (exports.XChaChaEncryptionAlgorithm = XChaChaEncryptionAlgorithm = {}));
+//# sourceMappingURL=response-types.js.map

package/dist/models/response-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-types.js","sourceRoot":"","sources":["../../src/models/response-types.ts"],"names":[],"mappings":";;;AAMA;;;GAGG;AACH,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,6CAAS,CAAA;IACT,6CAAS,CAAA;IACT,6CAAS,CAAA;IACT,6CAAS,CAAA;AACX,CAAC,EALW,UAAU,0BAAV,UAAU,QAKrB;AAuCD,IAAY,SAEX;AAFD,WAAY,SAAS;IACnB,uCAAO,CAAA;AACT,CAAC,EAFW,SAAS,yBAAT,SAAS,QAEpB;AAyED;;GAEG;AACH,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,mDAAU,CAAA;IACV,qDAAW,CAAA;AACb,CAAC,EAHW,YAAY,4BAAZ,YAAY,QAGvB;AA6ED,IAAY,8BAMX;AAND,WAAY,8BAA8B;IACxC,+DAA6B,CAAA;IAC7B,mEAAiC,CAAA;IACjC,2EAAyC,CAAA;IACzC,iFAA+C,CAAA;IAC/C,qDAAmB,CAAA;AACrB,CAAC,EANW,8BAA8B,8CAA9B,8BAA8B,QAMzC;AAiBD,IAAY,0BAGX;AAHD,WAAY,0BAA0B;IACpC,iDAAmB,CAAA;IACnB,iEAAmC,CAAA;AACrC,CAAC,EAHW,0BAA0B,0CAA1B,0BAA0B,QAGrC","sourcesContent":["import { ContractTransaction } from 'ethers';\nimport { MerkletreeScanStatus } from './merkletree-scan';\nimport { FeesSerialized } from './network-config';\nimport { MatrixWalletBalanceBucket } from './balance';\nimport type { Optional } from '../types/global';\n\n/**\n * Type0 / Type1 = non-EIP-1559 (gasPrice).\n * Type2 = EIP-1559 (maxFeePerGas and maxPriorityFeePerGas).\n */\nexport enum EVMGasType {\n  Type0 = 0,\n  Type1 = 1,\n  Type2 = 2,\n  Type4 = 4,\n}\n\nexport type TransactionGasDetails =\n  | TransactionGasDetailsType0\n  | TransactionGasDetailsType1\n  | TransactionGasDetailsType2\n  | TransactionGasDetailsType4;\n\nexport type TransactionGasDetailsType0 = {\n  evmGasType: EVMGasType.Type0;\n  gasEstimate: bigint;\n  gasPrice: bigint;\n};\n\nexport type TransactionGasDetailsType1 = {\n  evmGasType: EVMGasType.Type1;\n  gasEstimate: bigint;\n  gasPrice: bigint;\n};\n\nexport type TransactionGasDetailsType2 = {\n  evmGasType: EVMGasType.Type2;\n  gasEstimate: bigint;\n  maxFeePerGas: bigint;\n  maxPriorityFeePerGas: bigint;\n};\n\nexport type TransactionGasDetailsType4 = {\n  evmGasType: EVMGasType.Type4;\n  gasEstimate: bigint;\n  maxFeePerGas: bigint;\n  maxPriorityFeePerGas: bigint;\n};\n\nexport type FeeTokenDetails = {\n  tokenAddress: string;\n  feePerUnitGas: bigint;\n};\n\nexport enum ChainType {\n  EVM = 0,\n}\n\nexport type Chain = {\n  type: ChainType;\n  id: number;\n};\n\nexport type MatrixBalancesEvent = {\n  chain: Chain;\n  matrixWalletID: string;\n  balanceBucket: MatrixWalletBalanceBucket;\n  erc20Amounts: MatrixERC20Amount[];\n  nftAmounts: MatrixNFTAmount[];\n};\n\nexport type ProofProgressEvent = {\n  progress: number;\n  status: string;\n};\n\nexport type MerkletreeScanUpdateEvent = {\n  chain: Chain;\n  scanStatus: MerkletreeScanStatus;\n  progress: number;\n};\n\nexport type LoadProviderResponse = {\n  feesSerialized: FeesSerialized;\n};\n\nexport type MatrixWalletInfo = {\n  id: string;\n  matrixAddress: string;\n};\n\nexport type MatrixWalletAddressData = {\n  masterPublicKey: bigint;\n  viewingPublicKey: bigint;\n};\n\nexport type MatrixTxidFromNullifiersResponse = {\n  txid?: string;\n};\n\nexport type Proof = {\n  pi_a: [string, string];\n  pi_b: [[string, string], [string, string]];\n  pi_c: [string, string];\n};\n\nexport type MatrixPopulateTransactionResponse = {\n  transaction: ContractTransaction;\n  nullifiers?: string[];\n};\n\nexport type MatrixTransactionGasEstimateResponse = {\n  gasEstimate: bigint;\n};\n\nexport type MatrixERC20Recipient = {\n  tokenAddress: string;\n  recipientAddress: string;\n};\n\nexport type MatrixERC20Amount = {\n  tokenAddress: string;\n  amount: bigint;\n};\n\nexport type MatrixERC20AmountRecipient = MatrixERC20Amount & {\n  recipientAddress: string;\n};\n\n/**\n * Synced NFT types from TokenType (@matrix/engine).\n */\nexport enum NFTTokenType {\n  ERC721 = 1,\n  ERC1155 = 2,\n}\n\nexport type NFTAmount = {\n  nftAddress: string;\n  nftTokenType: NFTTokenType;\n  tokenSubID: string;\n  amountString: string;\n};\n\nexport type NFTAmountRecipient = NFTAmount & {\n  recipientAddress: string;\n};\n\nexport type MatrixNFTAmount = {\n  nftAddress: string;\n  nftTokenType: NFTTokenType;\n  tokenSubID: string;\n  amount: bigint;\n};\n\nexport type MatrixNFTAmountRecipient = MatrixNFTAmount & {\n  recipientAddress: string;\n};\n\nexport type EncryptDataWithSharedKeyResponse = {\n  encryptedData: [string, string];\n  randomPubKey: string;\n  sharedKey: Uint8Array;\n};\n\nexport type EncryptDataWithSharedKeySerialized = {\n  encryptedData: [string, string];\n  randomPubKey: string;\n  sharedKey: string;\n};\n\nexport type Pbkdf2Response = string;\n\ntype SendAdditionalData = {\n  recipientAddress: Optional<string>;\n  walletSource: Optional<string>;\n  memoText: Optional<string>;\n};\n\nexport type MatrixHistoryERC20Amount = MatrixERC20Amount;\n\nexport type MatrixHistoryNFTAmount = MatrixNFTAmount;\n\nexport type MatrixHistorySendERC20Amount = MatrixHistoryERC20Amount &\n  SendAdditionalData;\n\nexport type MatrixHistorySendNFTAmount = MatrixHistoryNFTAmount &\n  SendAdditionalData;\n\ntype UnshieldAdditionalData = {\n  unshieldFee: Optional<string>;\n};\n\nexport type MatrixHistoryUnshieldERC20Amount = MatrixHistorySendERC20Amount &\n  UnshieldAdditionalData;\n\nexport type MatrixHistoryUnshieldNFTAmount = MatrixHistorySendNFTAmount &\n  UnshieldAdditionalData;\n\ntype ReceiveAdditionalData = {\n  senderAddress: Optional<string>;\n  memoText: Optional<string>;\n  shieldFee: Optional<string>;\n  balanceBucket: MatrixWalletBalanceBucket;\n};\n\nexport type MatrixHistoryReceiveERC20Amount = MatrixHistoryERC20Amount &\n  ReceiveAdditionalData;\n\nexport type MatrixHistoryReceiveNFTAmount = MatrixHistoryNFTAmount &\n  ReceiveAdditionalData;\n\nexport enum TransactionHistoryItemCategory {\n  ShieldERC20s = 'ShieldERC20s',\n  UnshieldERC20s = 'UnshieldERC20s',\n  TransferSendERC20s = 'TransferSendERC20s',\n  TransferReceiveERC20s = 'TransferReceiveERC20s',\n  Unknown = 'Unknown',\n}\n\nexport type TransactionHistoryItem = {\n  txid: string;\n  version: number;\n  timestamp: Optional<number>;\n  blockNumber: Optional<number>;\n  receiveERC20Amounts: MatrixHistoryReceiveERC20Amount[];\n  transferERC20Amounts: MatrixHistorySendERC20Amount[];\n  changeERC20Amounts: MatrixHistoryERC20Amount[];\n  unshieldERC20Amounts: MatrixHistoryUnshieldERC20Amount[];\n  receiveNFTAmounts: MatrixHistoryReceiveNFTAmount[];\n  transferNFTAmounts: MatrixHistorySendNFTAmount[];\n  unshieldNFTAmounts: MatrixHistoryUnshieldNFTAmount[];\n  category: TransactionHistoryItemCategory;\n};\n\nexport enum XChaChaEncryptionAlgorithm {\n  XChaCha = 'XChaCha',\n  XChaChaPoly1305 = 'XChaChaPoly1305',\n}\n\nexport type CiphertextXChaCha = {\n  algorithm: XChaChaEncryptionAlgorithm;\n  nonce: string;\n  bundle: string;\n};\n\nexport type CommitmentCiphertextV3 = {\n  ciphertext: CiphertextXChaCha;\n  blindedSenderViewingKey: string;\n  blindedReceiverViewingKey: string;\n};\n\nexport type CommitmentSummary = {\n  commitmentCiphertext: CommitmentCiphertextV3;\n  commitmentHash: string;\n};\n"]}

package/dist/models/transaction.d.ts

@@ -0,0 +1,4 @@
+export type TransactionReceiptLog = {
+    topics: string[];
+    data: string;
+};

package/dist/models/transaction.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=transaction.js.map

package/dist/models/transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.js","sourceRoot":"","sources":["../../src/models/transaction.ts"],"names":[],"mappings":"","sourcesContent":["export type TransactionReceiptLog = {\n  topics: string[];\n  data: string;\n};\n"]}

package/dist/models/wallet.d.ts

@@ -0,0 +1,6 @@
+export declare enum WalletCreationType {
+    Import = "Import",
+    Create = "Create",
+    AddViewOnly = "AddViewOnly",
+    ImportFromBackup = "ImportFromBackup"
+}

package/dist/models/wallet.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WalletCreationType = void 0;
+var WalletCreationType;
+(function (WalletCreationType) {
+    WalletCreationType["Import"] = "Import";
+    WalletCreationType["Create"] = "Create";
+    WalletCreationType["AddViewOnly"] = "AddViewOnly";
+    WalletCreationType["ImportFromBackup"] = "ImportFromBackup";
+})(WalletCreationType || (exports.WalletCreationType = WalletCreationType = {}));
+//# sourceMappingURL=wallet.js.map

package/dist/models/wallet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wallet.js","sourceRoot":"","sources":["../../src/models/wallet.ts"],"names":[],"mappings":";;;AAAA,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,iDAA2B,CAAA;IAC3B,2DAAqC,CAAA;AACvC,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B","sourcesContent":["export enum WalletCreationType {\n  Import = 'Import',\n  Create = 'Create',\n  AddViewOnly = 'AddViewOnly',\n  ImportFromBackup = 'ImportFromBackup',\n}\n"]}

package/dist/types/global.d.ts

@@ -0,0 +1,2 @@
+export type Optional<T> = T | undefined;
+export type MapType<T> = Partial<Record<string, T>>;

package/dist/types/global.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=global.js.map

package/dist/types/global.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"global.js","sourceRoot":"","sources":["../../src/types/global.ts"],"names":[],"mappings":"","sourcesContent":["export type Optional<T> = T | undefined;\nexport type MapType<T> = Partial<Record<string, T>>;\n"]}

package/dist/utils/artifact-v2.d.ts

@@ -0,0 +1,2 @@
+export declare const artifactExists: (nullifiers: number, commitments: number) => boolean;
+export declare const assertArtifactExists: (nullifiers: number, commitments: number) => void;

package/dist/utils/artifact-v2.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertArtifactExists = exports.artifactExists = void 0;
+const artifacts_json_1 = __importDefault(require("../json/artifacts.json"));
+const artifactExists = (nullifiers, commitments) => {
+    const found = artifacts_json_1.default.find(artifact => artifact.nullifiers === nullifiers &&
+        artifact.commitments === commitments);
+    return found != null;
+};
+exports.artifactExists = artifactExists;
+const artifactError = (nullifiers, commitments) => {
+    return new Error(`No artifacts for inputs: ${nullifiers}-${commitments}`);
+};
+const assertArtifactExists = (nullifiers, commitments) => {
+    if ((0, exports.artifactExists)(nullifiers, commitments)) {
+        return;
+    }
+    throw artifactError(nullifiers, commitments);
+};
+exports.assertArtifactExists = assertArtifactExists;
+//# sourceMappingURL=artifact-v2.js.map

package/dist/utils/artifact-v2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"artifact-v2.js","sourceRoot":"","sources":["../../src/utils/artifact-v2.ts"],"names":[],"mappings":";;;;;;AAAA,4EAAuD;AAEhD,MAAM,cAAc,GAAG,CAC5B,UAAkB,EAClB,WAAmB,EACV,EAAE;IACX,MAAM,KAAK,GAAG,wBAAiB,CAAC,IAAI,CAClC,QAAQ,CAAC,EAAE,CACT,QAAQ,CAAC,UAAU,KAAK,UAAU;QAClC,QAAQ,CAAC,WAAW,KAAK,WAAW,CACvC,CAAC;IACF,OAAO,KAAK,IAAI,IAAI,CAAC;AACvB,CAAC,CAAC;AAVW,QAAA,cAAc,kBAUzB;AAEF,MAAM,aAAa,GAAG,CAAC,UAAkB,EAAE,WAAmB,EAAE,EAAE;IAChE,OAAO,IAAI,KAAK,CAAC,4BAA4B,UAAU,IAAI,WAAW,EAAE,CAAC,CAAC;AAC5E,CAAC,CAAC;AAEK,MAAM,oBAAoB,GAAG,CAClC,UAAkB,EAClB,WAAmB,EACnB,EAAE;IACF,IAAI,IAAA,sBAAc,EAAC,UAAU,EAAE,WAAW,CAAC,EAAE;QAC3C,OAAO;KACR;IACD,MAAM,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;AAC/C,CAAC,CAAC;AARW,QAAA,oBAAoB,wBAQ/B","sourcesContent":["import ArtifactsMetadata from '../json/artifacts.json';\n\nexport const artifactExists = (\n  nullifiers: number,\n  commitments: number,\n): boolean => {\n  const found = ArtifactsMetadata.find(\n    artifact =>\n      artifact.nullifiers === nullifiers &&\n      artifact.commitments === commitments,\n  );\n  return found != null;\n};\n\nconst artifactError = (nullifiers: number, commitments: number) => {\n  return new Error(`No artifacts for inputs: ${nullifiers}-${commitments}`);\n};\n\nexport const assertArtifactExists = (\n  nullifiers: number,\n  commitments: number,\n) => {\n  if (artifactExists(nullifiers, commitments)) {\n    return;\n  }\n  throw artifactError(nullifiers, commitments);\n};\n"]}

package/dist/utils/available-rpc.d.ts

@@ -0,0 +1,8 @@
+import { ProviderJson } from './fallback-provider';
+type LogError = (err: string) => void;
+/**
+ * Health checks ProviderJson inputs, and returns an array of available RPC providers.
+ * Available means that they respond to getBlockNumber(), and they are +/- 100 blocks from the median.
+ */
+export declare const getAvailableProviderJSONs: (chainId: number, providerJsons: ProviderJson[], logError: LogError) => Promise<ProviderJson[]>;
+export {};

package/dist/utils/available-rpc.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAvailableProviderJSONs = void 0;
+const ethers_1 = require("ethers");
+const median_1 = require("./median");
+const promises_1 = require("./promises");
+const BLOCK_NUMBER_TIMEOUT_MS = 5000;
+/**
+ * Health checks ProviderJson inputs, and returns an array of available RPC providers.
+ * Available means that they respond to getBlockNumber(), and they are +/- 100 blocks from the median.
+ */
+const getAvailableProviderJSONs = async (chainId, providerJsons, logError) => {
+    const blockNumbers = await Promise.all(providerJsons.map(async (providerJson) => await getBlockNumber(chainId, providerJson.provider, logError)));
+    const nonZeroBlockNumbers = blockNumbers.filter(blockNumber => blockNumber != null && blockNumber > 0);
+    const medianBlockNumber = (0, median_1.getUpperBoundMedian)(nonZeroBlockNumbers);
+    const lowerBoundRange = medianBlockNumber - 100;
+    const upperBoundRange = medianBlockNumber + 100;
+    return providerJsons.filter((providerJson, index) => {
+        const blockNumber = blockNumbers[index];
+        if (blockNumber == null) {
+            logError(`RPC Health Check failed for ${providerJson.provider}: No Block Number`);
+            return false;
+        }
+        if (blockNumber < lowerBoundRange) {
+            logError(`RPC Health Check failed for ${providerJson.provider}: Block Number -${medianBlockNumber - blockNumber} from median`);
+            return false;
+        }
+        if (blockNumber > upperBoundRange) {
+            logError(`RPC Health Check failed for ${providerJson.provider}: Block Number +${blockNumber - medianBlockNumber} from median`);
+            return false;
+        }
+        return true;
+    });
+};
+exports.getAvailableProviderJSONs = getAvailableProviderJSONs;
+const getBlockNumber = async (chainId, provider, logError) => {
+    const network = ethers_1.Network.from(chainId);
+    // Conditionally handle what type of provider is being passed
+    let rpcProvider;
+    // If URL starts with wss, use WebSocketProvider
+    if (provider.startsWith('wss')) {
+        rpcProvider = new ethers_1.WebSocketProvider(provider, network);
+    }
+    else {
+        rpcProvider = new ethers_1.JsonRpcProvider(provider, network, {
+            staticNetwork: network,
+        });
+    }
+    try {
+        const block = await (0, promises_1.promiseTimeout)(rpcProvider.getBlock('latest'), BLOCK_NUMBER_TIMEOUT_MS);
+        if (block == null) {
+            throw new Error('Block is null');
+        }
+        return block.number;
+    }
+    catch (cause) {
+        if (!(cause instanceof Error)) {
+            throw new Error('Non-error thrown from getBlockNumber', { cause });
+        }
+        rpcProvider.destroy();
+        logError(cause.message);
+        return undefined;
+    }
+};
+//# sourceMappingURL=available-rpc.js.map

package/dist/utils/available-rpc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"available-rpc.js","sourceRoot":"","sources":["../../src/utils/available-rpc.ts"],"names":[],"mappings":";;;AAAA,mCAKgB;AAEhB,qCAA+C;AAC/C,yCAA4C;AAK5C,MAAM,uBAAuB,GAAG,IAAI,CAAC;AAErC;;;GAGG;AACI,MAAM,yBAAyB,GAAG,KAAK,EAC5C,OAAe,EACf,aAA6B,EAC7B,QAAkB,EACO,EAAE;IAC3B,MAAM,YAAY,GAAuB,MAAM,OAAO,CAAC,GAAG,CACxD,aAAa,CAAC,GAAG,CACf,KAAK,EAAC,YAAY,EAAC,EAAE,CACnB,MAAM,cAAc,CAAC,OAAO,EAAE,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,CACjE,CACF,CAAC;IAEF,MAAM,mBAAmB,GAAG,YAAY,CAAC,MAAM,CAC7C,WAAW,CAAC,EAAE,CAAC,WAAW,IAAI,IAAI,IAAI,WAAW,GAAG,CAAC,CAC1C,CAAC;IACd,MAAM,iBAAiB,GAAG,IAAA,4BAAmB,EAAC,mBAAmB,CAAC,CAAC;IACnE,MAAM,eAAe,GAAG,iBAAiB,GAAG,GAAG,CAAC;IAChD,MAAM,eAAe,GAAG,iBAAiB,GAAG,GAAG,CAAC;IAEhD,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,EAAE;QAClD,MAAM,WAAW,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QACxC,IAAI,WAAW,IAAI,IAAI,EAAE;YACvB,QAAQ,CACN,+BAA+B,YAAY,CAAC,QAAQ,mBAAmB,CACxE,CAAC;YACF,OAAO,KAAK,CAAC;SACd;QACD,IAAI,WAAW,GAAG,eAAe,EAAE;YACjC,QAAQ,CACN,+BAA+B,YAAY,CAAC,QAAQ,mBAClD,iBAAiB,GAAG,WACtB,cAAc,CACf,CAAC;YACF,OAAO,KAAK,CAAC;SACd;QACD,IAAI,WAAW,GAAG,eAAe,EAAE;YACjC,QAAQ,CACN,+BAA+B,YAAY,CAAC,QAAQ,mBAClD,WAAW,GAAG,iBAChB,cAAc,CACf,CAAC;YACF,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AA7CW,QAAA,yBAAyB,6BA6CpC;AAEF,MAAM,cAAc,GAAG,KAAK,EAC1B,OAAe,EACf,QAAgB,EAChB,QAAkB,EACS,EAAE;IAC7B,MAAM,OAAO,GAAG,gBAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAEtC,6DAA6D;IAC7D,IAAI,WAAqB,CAAC;IAE1B,gDAAgD;IAChD,IAAI,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;QAC9B,WAAW,GAAG,IAAI,0BAAiB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;KACxD;SAAM;QACL,WAAW,GAAG,IAAI,wBAAe,CAAC,QAAQ,EAAE,OAAO,EAAE;YACnD,aAAa,EAAE,OAAO;SACvB,CAAC,CAAC;KACJ;IAED,IAAI;QACF,MAAM,KAAK,GAAG,MAAM,IAAA,yBAAc,EAChC,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAC9B,uBAAuB,CACxB,CAAC;QACF,IAAI,KAAK,IAAI,IAAI,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;SAClC;QACD,OAAO,KAAK,CAAC,MAAM,CAAC;KACrB;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,sCAAsC,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;SACpE;QACD,WAAW,CAAC,OAAO,EAAE,CAAC;QACtB,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACxB,OAAO,SAAS,CAAC;KAClB;AACH,CAAC,CAAC","sourcesContent":["import {\n  JsonRpcProvider,\n  Network,\n  type Provider,\n  WebSocketProvider,\n} from 'ethers';\nimport { ProviderJson } from './fallback-provider';\nimport { getUpperBoundMedian } from './median';\nimport { promiseTimeout } from './promises';\nimport type { Optional } from '../types/global';\n\ntype LogError = (err: string) => void;\n\nconst BLOCK_NUMBER_TIMEOUT_MS = 5000;\n\n/**\n * Health checks ProviderJson inputs, and returns an array of available RPC providers.\n * Available means that they respond to getBlockNumber(), and they are +/- 100 blocks from the median.\n */\nexport const getAvailableProviderJSONs = async (\n  chainId: number,\n  providerJsons: ProviderJson[],\n  logError: LogError,\n): Promise<ProviderJson[]> => {\n  const blockNumbers: Optional<number>[] = await Promise.all(\n    providerJsons.map(\n      async providerJson =>\n        await getBlockNumber(chainId, providerJson.provider, logError),\n    ),\n  );\n\n  const nonZeroBlockNumbers = blockNumbers.filter(\n    blockNumber => blockNumber != null && blockNumber > 0,\n  ) as number[];\n  const medianBlockNumber = getUpperBoundMedian(nonZeroBlockNumbers);\n  const lowerBoundRange = medianBlockNumber - 100;\n  const upperBoundRange = medianBlockNumber + 100;\n\n  return providerJsons.filter((providerJson, index) => {\n    const blockNumber = blockNumbers[index];\n    if (blockNumber == null) {\n      logError(\n        `RPC Health Check failed for ${providerJson.provider}: No Block Number`,\n      );\n      return false;\n    }\n    if (blockNumber < lowerBoundRange) {\n      logError(\n        `RPC Health Check failed for ${providerJson.provider}: Block Number -${\n          medianBlockNumber - blockNumber\n        } from median`,\n      );\n      return false;\n    }\n    if (blockNumber > upperBoundRange) {\n      logError(\n        `RPC Health Check failed for ${providerJson.provider}: Block Number +${\n          blockNumber - medianBlockNumber\n        } from median`,\n      );\n      return false;\n    }\n    return true;\n  });\n};\n\nconst getBlockNumber = async (\n  chainId: number,\n  provider: string,\n  logError: LogError,\n): Promise<Optional<number>> => {\n  const network = Network.from(chainId);\n\n  // Conditionally handle what type of provider is being passed\n  let rpcProvider: Provider;\n\n  // If URL starts with wss, use WebSocketProvider\n  if (provider.startsWith('wss')) {\n    rpcProvider = new WebSocketProvider(provider, network);\n  } else {\n    rpcProvider = new JsonRpcProvider(provider, network, {\n      staticNetwork: network,\n    });\n  }\n\n  try {\n    const block = await promiseTimeout(\n      rpcProvider.getBlock('latest'),\n      BLOCK_NUMBER_TIMEOUT_MS,\n    );\n    if (block == null) {\n      throw new Error('Block is null');\n    }\n    return block.number;\n  } catch (cause) {\n    if (!(cause instanceof Error)) {\n      throw new Error('Non-error thrown from getBlockNumber', { cause });\n    }\n    rpcProvider.destroy();\n    logError(cause.message);\n    return undefined;\n  }\n};\n"]}

package/dist/utils/compare.d.ts

@@ -0,0 +1,2 @@
+import { Chain } from '../models/response-types';
+export declare const compareChains: (chainA: Chain, chainB: Chain) => boolean;

package/dist/utils/compare.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compareChains = void 0;
+const compareChains = (chainA, chainB) => {
+    return chainA.type === chainB.type && chainA.id === chainB.id;
+};
+exports.compareChains = compareChains;
+//# sourceMappingURL=compare.js.map

package/dist/utils/compare.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compare.js","sourceRoot":"","sources":["../../src/utils/compare.ts"],"names":[],"mappings":";;;AAEO,MAAM,aAAa,GAAG,CAAC,MAAa,EAAE,MAAa,EAAE,EAAE;IAC5D,OAAO,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,EAAE,KAAK,MAAM,CAAC,EAAE,CAAC;AAChE,CAAC,CAAC;AAFW,QAAA,aAAa,iBAExB","sourcesContent":["import { Chain } from '../models/response-types';\n\nexport const compareChains = (chainA: Chain, chainB: Chain) => {\n  return chainA.type === chainB.type && chainA.id === chainB.id;\n};\n"]}

package/dist/utils/configured-json-rpc-provider.d.ts

@@ -0,0 +1,4 @@
+import { JsonRpcProvider, Network } from 'ethers';
+export declare class ConfiguredJsonRpcProvider extends JsonRpcProvider {
+    constructor(url: string, network: Network, maxLogsPerBatch?: number);
+}

package/dist/utils/configured-json-rpc-provider.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfiguredJsonRpcProvider = void 0;
+const ethers_1 = require("ethers");
+class ConfiguredJsonRpcProvider extends ethers_1.JsonRpcProvider {
+    constructor(url, network, maxLogsPerBatch = 100) {
+        const options = {
+            staticNetwork: network,
+            batchMaxCount: maxLogsPerBatch,
+        };
+        super(url, network, options);
+    }
+}
+exports.ConfiguredJsonRpcProvider = ConfiguredJsonRpcProvider;
+//# sourceMappingURL=configured-json-rpc-provider.js.map

package/dist/utils/configured-json-rpc-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configured-json-rpc-provider.js","sourceRoot":"","sources":["../../src/utils/configured-json-rpc-provider.ts"],"names":[],"mappings":";;;AAAA,mCAA6E;AAE7E,MAAa,yBAA0B,SAAQ,wBAAe;IAC5D,YAAY,GAAW,EAAE,OAAgB,EAAE,eAAe,GAAG,GAAG;QAC9D,MAAM,OAAO,GAA8B;YACzC,aAAa,EAAE,OAAO;YACtB,aAAa,EAAE,eAAe;SAC/B,CAAC;QACF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;CACF;AARD,8DAQC","sourcesContent":["import { JsonRpcProvider, JsonRpcApiProviderOptions, Network } from 'ethers';\n\nexport class ConfiguredJsonRpcProvider extends JsonRpcProvider {\n  constructor(url: string, network: Network, maxLogsPerBatch = 100) {\n    const options: JsonRpcApiProviderOptions = {\n      staticNetwork: network,\n      batchMaxCount: maxLogsPerBatch,\n    };\n    super(url, network, options);\n  }\n}\n"]}

package/dist/utils/error.d.ts

@@ -0,0 +1 @@
+export declare const sanitizeError: (cause: Error) => Error;

package/dist/utils/error.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sanitizeError = void 0;
+const util_1 = require("./util");
+const STRING_PREFIX_AFTER_UNICODE_REPLACEMENT = 'y %';
+const validAscii = (str) => {
+    return str.replace(
+    // eslint-disable-next-line no-useless-escape
+    /[^A-Za-z 0-9 \.,\?""!@#\$%\^&\*\(\)-_=\+;:<>\/\\\|\}\{\[\]`~]*/g, '');
+};
+const sanitizeError = (cause) => {
+    if ((0, util_1.isDefined)(cause) && cause.message) {
+        const lowercaseMsg = cause.message.toLowerCase();
+        if (lowercaseMsg.includes('quorum') ||
+            lowercaseMsg.includes('could not connect to')) {
+            return new Error('Could not connect.', { cause });
+        }
+        if (lowercaseMsg.includes('call revert exception')) {
+            return new Error('Failed to connect to RPC.', { cause });
+        }
+        if (lowercaseMsg.includes('already known')) {
+            return new Error('Transaction successful but ethers request for TXID failed.', { cause });
+        }
+        if (lowercaseMsg.includes('missing revert data')) {
+            return new Error('RPC connection error.', { cause });
+        }
+        if (lowercaseMsg.includes('transaction may fail or may require manual gas limit')) {
+            return new Error('Unknown error. Transaction failed.', { cause });
+        }
+        if (lowercaseMsg.includes('replacement fee too low')) {
+            return new Error('Nonce is used in a pending transaction, and replacement fee is too low. Please increase your network fee to replace the pending transaction.', { cause });
+        }
+        if (lowercaseMsg.includes('intrinsic gas too low')) {
+            return new Error('Gas price rejected. Please select a higher gas price or resubmit.', { cause });
+        }
+        if (lowercaseMsg.includes('transaction underpriced')) {
+            return new Error('Gas fee too low. Please select a higher gas price and resubmit.', { cause });
+        }
+        if (lowercaseMsg.includes('insufficient funds for intrinsic')) {
+            return new Error('Insufficient gas to process transaction.', { cause });
+        }
+        if (lowercaseMsg.includes('nonce has already been used')) {
+            return new Error(
+            // Do not change 'Nonce already used' string of Error message.
+            'Nonce already used: the transaction was already completed.', { cause });
+        }
+        if (lowercaseMsg.includes('error while dialing dial tcp')) {
+            return new Error('Error while connecting to RPC provider. Please try again.', { cause });
+        }
+        if (lowercaseMsg.includes('spendable private balance too low') &&
+            lowercaseMsg.includes('relayer fee')) {
+            return new Error('Private balance too low to pay relayer fee.', {
+                cause,
+            });
+        }
+        // Custom Matrix contract error messages
+        if (lowercaseMsg.includes('matrix')) {
+            if (lowercaseMsg.includes('invalid nft note value')) {
+                return new Error('Matrix: Invalid NFT Note Value.', {
+                    cause,
+                });
+            }
+            if (lowercaseMsg.includes('unsupported token')) {
+                return new Error('Matrix: Unsupported Token. This token cannot interact with the Matrix contract.', { cause });
+            }
+            if (lowercaseMsg.includes('invalid note value')) {
+                return new Error('Matrix: Invalid Note Value. Please submit transaction with a corrected amount.', { cause });
+            }
+            if (lowercaseMsg.includes('invalid adapt contract as sender')) {
+                return new Error('Matrix: Invalid Adapt Contract as Sender. Please update your frontend to current Adapt module versions.', { cause });
+            }
+            if (lowercaseMsg.includes('invalid merkle root')) {
+                return new Error('Matrix: Invalid Merkle Root. Please sync your balances and try again.', { cause });
+            }
+            if (lowercaseMsg.includes('note already spent')) {
+                return new Error('Matrix: Note Already Spent. Please sync your balances and try again.', { cause });
+            }
+            if (lowercaseMsg.includes('invalid ciphertext array length')) {
+                return new Error('Matrix: Invalid Ciphertext Array Length. Please sync balances and re-prove your transaction.', { cause });
+            }
+            if (lowercaseMsg.includes('invalid unshield commitment')) {
+                return new Error('Matrix: Invalid Unshield Commitment. Please sync balances and re-prove your transaction.', { cause });
+            }
+            if (lowercaseMsg.includes('invalid snark proof')) {
+                return new Error('Matrix: Invalid Snark Proof. Please re-prove your transaction.', { cause });
+            }
+        }
+        return new Error(validAscii(cause.message).replace(`:${STRING_PREFIX_AFTER_UNICODE_REPLACEMENT}`, ': '));
+    }
+    return new Error('Unknown error. Please try again.', { cause });
+};
+exports.sanitizeError = sanitizeError;
+//# sourceMappingURL=error.js.map

package/dist/utils/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../src/utils/error.ts"],"names":[],"mappings":";;;AAAA,iCAAmC;AAEnC,MAAM,uCAAuC,GAAG,KAAK,CAAC;AAEtD,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,EAAE;IACjC,OAAO,GAAG,CAAC,OAAO;IAChB,6CAA6C;IAC7C,iEAAiE,EACjE,EAAE,CACH,CAAC;AACJ,CAAC,CAAC;AAEK,MAAM,aAAa,GAAG,CAAC,KAAY,EAAS,EAAE;IACnD,IAAI,IAAA,gBAAS,EAAC,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE;QACrC,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QACjD,IACE,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAC/B,YAAY,CAAC,QAAQ,CAAC,sBAAsB,CAAC,EAC7C;YACA,OAAO,IAAI,KAAK,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;SACnD;QACD,IAAI,YAAY,CAAC,QAAQ,CAAC,uBAAuB,CAAC,EAAE;YAClD,OAAO,IAAI,KAAK,CAAC,2BAA2B,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;SAC1D;QACD,IAAI,YAAY,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE;YAC1C,OAAO,IAAI,KAAK,CACd,4DAA4D,EAC5D,EAAE,KAAK,EAAE,CACV,CAAC;SACH;QACD,IAAI,YAAY,CAAC,QAAQ,CAAC,qBAAqB,CAAC,EAAE;YAChD,OAAO,IAAI,KAAK,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;SACtD;QACD,IACE,YAAY,CAAC,QAAQ,CACnB,sDAAsD,CACvD,EACD;YACA,OAAO,IAAI,KAAK,CAAC,oCAAoC,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;SACnE;QACD,IAAI,YAAY,CAAC,QAAQ,CAAC,yBAAyB,CAAC,EAAE;YACpD,OAAO,IAAI,KAAK,CACd,8IAA8I,EAC9I,EAAE,KAAK,EAAE,CACV,CAAC;SACH;QACD,IAAI,YAAY,CAAC,QAAQ,CAAC,uBAAuB,CAAC,EAAE;YAClD,OAAO,IAAI,KAAK,CACd,mEAAmE,EACnE,EAAE,KAAK,EAAE,CACV,CAAC;SACH;QACD,IAAI,YAAY,CAAC,QAAQ,CAAC,yBAAyB,CAAC,EAAE;YACpD,OAAO,IAAI,KAAK,CACd,iEAAiE,EACjE,EAAE,KAAK,EAAE,CACV,CAAC;SACH;QACD,IAAI,YAAY,CAAC,QAAQ,CAAC,kCAAkC,CAAC,EAAE;YAC7D,OAAO,IAAI,KAAK,CAAC,0CAA0C,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;SACzE;QACD,IAAI,YAAY,CAAC,QAAQ,CAAC,6BAA6B,CAAC,EAAE;YACxD,OAAO,IAAI,KAAK;YACd,8DAA8D;YAC9D,4DAA4D,EAC5D,EAAE,KAAK,EAAE,CACV,CAAC;SACH;QACD,IAAI,YAAY,CAAC,QAAQ,CAAC,8BAA8B,CAAC,EAAE;YACzD,OAAO,IAAI,KAAK,CACd,2DAA2D,EAC3D,EAAE,KAAK,EAAE,CACV,CAAC;SACH;QACD,IACE,YAAY,CAAC,QAAQ,CAAC,mCAAmC,CAAC;YAC1D,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,EACpC;YACA,OAAO,IAAI,KAAK,CAAC,6CAA6C,EAAE;gBAC9D,KAAK;aACN,CAAC,CAAC;SACJ;QAED,wCAAwC;QACxC,IAAI,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;YACnC,IAAI,YAAY,CAAC,QAAQ,CAAC,wBAAwB,CAAC,EAAE;gBACnD,OAAO,IAAI,KAAK,CAAC,iCAAiC,EAAE;oBAClD,KAAK;iBACN,CAAC,CAAC;aACJ;YACD,IAAI,YAAY,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE;gBAC9C,OAAO,IAAI,KAAK,CACd,iFAAiF,EACjF,EAAE,KAAK,EAAE,CACV,CAAC;aACH;YACD,IAAI,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAAE;gBAC/C,OAAO,IAAI,KAAK,CACd,gFAAgF,EAChF,EAAE,KAAK,EAAE,CACV,CAAC;aACH;YACD,IAAI,YAAY,CAAC,QAAQ,CAAC,kCAAkC,CAAC,EAAE;gBAC7D,OAAO,IAAI,KAAK,CACd,yGAAyG,EACzG,EAAE,KAAK,EAAE,CACV,CAAC;aACH;YACD,IAAI,YAAY,CAAC,QAAQ,CAAC,qBAAqB,CAAC,EAAE;gBAChD,OAAO,IAAI,KAAK,CACd,uEAAuE,EACvE,EAAE,KAAK,EAAE,CACV,CAAC;aACH;YACD,IAAI,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAAE;gBAC/C,OAAO,IAAI,KAAK,CACd,sEAAsE,EACtE,EAAE,KAAK,EAAE,CACV,CAAC;aACH;YACD,IAAI,YAAY,CAAC,QAAQ,CAAC,iCAAiC,CAAC,EAAE;gBAC5D,OAAO,IAAI,KAAK,CACd,8FAA8F,EAC9F,EAAE,KAAK,EAAE,CACV,CAAC;aACH;YACD,IAAI,YAAY,CAAC,QAAQ,CAAC,6BAA6B,CAAC,EAAE;gBACxD,OAAO,IAAI,KAAK,CACd,0FAA0F,EAC1F,EAAE,KAAK,EAAE,CACV,CAAC;aACH;YACD,IAAI,YAAY,CAAC,QAAQ,CAAC,qBAAqB,CAAC,EAAE;gBAChD,OAAO,IAAI,KAAK,CACd,gEAAgE,EAChE,EAAE,KAAK,EAAE,CACV,CAAC;aACH;SACF;QAED,OAAO,IAAI,KAAK,CACd,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,CAC/B,IAAI,uCAAuC,EAAE,EAC7C,IAAI,CACL,CACF,CAAC;KACH;IAED,OAAO,IAAI,KAAK,CAAC,kCAAkC,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;AAClE,CAAC,CAAC;AAzIW,QAAA,aAAa,iBAyIxB","sourcesContent":["import { isDefined } from './util';\n\nconst STRING_PREFIX_AFTER_UNICODE_REPLACEMENT = 'y %';\n\nconst validAscii = (str: string) => {\n  return str.replace(\n    // eslint-disable-next-line no-useless-escape\n    /[^A-Za-z 0-9 \\.,\\?\"\"!@#\\$%\\^&\\*\\(\\)-_=\\+;:<>\\/\\\\\\|\\}\\{\\[\\]`~]*/g,\n    '',\n  );\n};\n\nexport const sanitizeError = (cause: Error): Error => {\n  if (isDefined(cause) && cause.message) {\n    const lowercaseMsg = cause.message.toLowerCase();\n    if (\n      lowercaseMsg.includes('quorum') ||\n      lowercaseMsg.includes('could not connect to')\n    ) {\n      return new Error('Could not connect.', { cause });\n    }\n    if (lowercaseMsg.includes('call revert exception')) {\n      return new Error('Failed to connect to RPC.', { cause });\n    }\n    if (lowercaseMsg.includes('already known')) {\n      return new Error(\n        'Transaction successful but ethers request for TXID failed.',\n        { cause },\n      );\n    }\n    if (lowercaseMsg.includes('missing revert data')) {\n      return new Error('RPC connection error.', { cause });\n    }\n    if (\n      lowercaseMsg.includes(\n        'transaction may fail or may require manual gas limit',\n      )\n    ) {\n      return new Error('Unknown error. Transaction failed.', { cause });\n    }\n    if (lowercaseMsg.includes('replacement fee too low')) {\n      return new Error(\n        'Nonce is used in a pending transaction, and replacement fee is too low. Please increase your network fee to replace the pending transaction.',\n        { cause },\n      );\n    }\n    if (lowercaseMsg.includes('intrinsic gas too low')) {\n      return new Error(\n        'Gas price rejected. Please select a higher gas price or resubmit.',\n        { cause },\n      );\n    }\n    if (lowercaseMsg.includes('transaction underpriced')) {\n      return new Error(\n        'Gas fee too low. Please select a higher gas price and resubmit.',\n        { cause },\n      );\n    }\n    if (lowercaseMsg.includes('insufficient funds for intrinsic')) {\n      return new Error('Insufficient gas to process transaction.', { cause });\n    }\n    if (lowercaseMsg.includes('nonce has already been used')) {\n      return new Error(\n        // Do not change 'Nonce already used' string of Error message.\n        'Nonce already used: the transaction was already completed.',\n        { cause },\n      );\n    }\n    if (lowercaseMsg.includes('error while dialing dial tcp')) {\n      return new Error(\n        'Error while connecting to RPC provider. Please try again.',\n        { cause },\n      );\n    }\n    if (\n      lowercaseMsg.includes('spendable private balance too low') &&\n      lowercaseMsg.includes('relayer fee')\n    ) {\n      return new Error('Private balance too low to pay relayer fee.', {\n        cause,\n      });\n    }\n\n    // Custom Matrix contract error messages\n    if (lowercaseMsg.includes('matrix')) {\n      if (lowercaseMsg.includes('invalid nft note value')) {\n        return new Error('Matrix: Invalid NFT Note Value.', {\n          cause,\n        });\n      }\n      if (lowercaseMsg.includes('unsupported token')) {\n        return new Error(\n          'Matrix: Unsupported Token. This token cannot interact with the Matrix contract.',\n          { cause },\n        );\n      }\n      if (lowercaseMsg.includes('invalid note value')) {\n        return new Error(\n          'Matrix: Invalid Note Value. Please submit transaction with a corrected amount.',\n          { cause },\n        );\n      }\n      if (lowercaseMsg.includes('invalid adapt contract as sender')) {\n        return new Error(\n          'Matrix: Invalid Adapt Contract as Sender. Please update your frontend to current Adapt module versions.',\n          { cause },\n        );\n      }\n      if (lowercaseMsg.includes('invalid merkle root')) {\n        return new Error(\n          'Matrix: Invalid Merkle Root. Please sync your balances and try again.',\n          { cause },\n        );\n      }\n      if (lowercaseMsg.includes('note already spent')) {\n        return new Error(\n          'Matrix: Note Already Spent. Please sync your balances and try again.',\n          { cause },\n        );\n      }\n      if (lowercaseMsg.includes('invalid ciphertext array length')) {\n        return new Error(\n          'Matrix: Invalid Ciphertext Array Length. Please sync balances and re-prove your transaction.',\n          { cause },\n        );\n      }\n      if (lowercaseMsg.includes('invalid unshield commitment')) {\n        return new Error(\n          'Matrix: Invalid Unshield Commitment. Please sync balances and re-prove your transaction.',\n          { cause },\n        );\n      }\n      if (lowercaseMsg.includes('invalid snark proof')) {\n        return new Error(\n          'Matrix: Invalid Snark Proof. Please re-prove your transaction.',\n          { cause },\n        );\n      }\n    }\n\n    return new Error(\n      validAscii(cause.message).replace(\n        `:${STRING_PREFIX_AFTER_UNICODE_REPLACEMENT}`,\n        ': ',\n      ),\n    );\n  }\n\n  return new Error('Unknown error. Please try again.', { cause });\n};\n"]}

package/dist/utils/fallback-provider.d.ts

@@ -0,0 +1,13 @@
+import { FallbackProvider } from 'ethers';
+export type FallbackProviderJsonConfig = {
+    chainId: number;
+    providers: ProviderJson[];
+};
+export type ProviderJson = {
+    priority: number;
+    weight: number;
+    provider: string;
+    stallTimeout?: number;
+    maxLogsPerBatch?: number;
+};
+export declare const createFallbackProviderFromJsonConfig: (config: FallbackProviderJsonConfig) => FallbackProvider;