@matrix-privacy/shared-models 0.0.1

package/dist/utils/fallback-provider.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createFallbackProviderFromJsonConfig = void 0;
+const ethers_1 = require("ethers");
+const configured_json_rpc_provider_1 = require("./configured-json-rpc-provider");
+const createFallbackProviderFromJsonConfig = (config) => {
+    try {
+        const totalWeight = config.providers.reduce((acc, { weight }) => acc + weight, 0);
+        if (totalWeight < 2) {
+            throw new Error('Total weight across providers must be >= 2 for fallback quorum.');
+        }
+        const network = ethers_1.Network.from(Number(config.chainId));
+        const providers = config.providers.map(({ provider: providerURL, priority, weight, stallTimeout, maxLogsPerBatch, }) => {
+            const isWebsocket = providerURL.startsWith('wss');
+            const provider = isWebsocket
+                ? new ethers_1.WebSocketProvider(providerURL, network)
+                : new configured_json_rpc_provider_1.ConfiguredJsonRpcProvider(providerURL, network, maxLogsPerBatch);
+            const fallbackProviderConfig = {
+                provider,
+                priority,
+                weight,
+                stallTimeout,
+            };
+            return fallbackProviderConfig;
+        });
+        return new ethers_1.FallbackProvider(providers, network);
+    }
+    catch (cause) {
+        if (!(cause instanceof Error)) {
+            throw new Error('Non-error thrown from createFallbackProviderFromJsonConfig', { cause });
+        }
+        throw new Error(`Invalid fallback provider config for chain ${config.chainId}`, { cause });
+    }
+};
+exports.createFallbackProviderFromJsonConfig = createFallbackProviderFromJsonConfig;
+//# sourceMappingURL=fallback-provider.js.map

package/dist/utils/fallback-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fallback-provider.js","sourceRoot":"","sources":["../../src/utils/fallback-provider.ts"],"names":[],"mappings":";;;AAAA,mCAAsE;AACtE,iFAA2E;AAgBpE,MAAM,oCAAoC,GAAG,CAClD,MAAkC,EAChB,EAAE;IACpB,IAAI;QACF,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CACzC,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,GAAG,GAAG,MAAM,EACjC,CAAC,CACF,CAAC;QACF,IAAI,WAAW,GAAG,CAAC,EAAE;YACnB,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAC;SACH;QAED,MAAM,OAAO,GAAG,gBAAO,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QAErD,MAAM,SAAS,GAA6B,MAAM,CAAC,SAAS,CAAC,GAAG,CAC9D,CAAC,EACC,QAAQ,EAAE,WAAW,EACrB,QAAQ,EACR,MAAM,EACN,YAAY,EACZ,eAAe,GAChB,EAAE,EAAE;YACH,MAAM,WAAW,GAAG,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAClD,MAAM,QAAQ,GAAG,WAAW;gBAC1B,CAAC,CAAC,IAAI,0BAAiB,CAAC,WAAW,EAAE,OAAO,CAAC;gBAC7C,CAAC,CAAC,IAAI,wDAAyB,CAC3B,WAAW,EACX,OAAO,EACP,eAAe,CAChB,CAAC;YAEN,MAAM,sBAAsB,GAA2B;gBACrD,QAAQ;gBACR,QAAQ;gBACR,MAAM;gBACN,YAAY;aACb,CAAC;YACF,OAAO,sBAAsB,CAAC;QAChC,CAAC,CACF,CAAC;QAEF,OAAO,IAAI,yBAAgB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;KACjD;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CACb,4DAA4D,EAC5D,EAAE,KAAK,EAAE,CACV,CAAC;SACH;QACD,MAAM,IAAI,KAAK,CACb,8CAA8C,MAAM,CAAC,OAAO,EAAE,EAC9D,EAAE,KAAK,EAAE,CACV,CAAC;KACH;AACH,CAAC,CAAC;AAxDW,QAAA,oCAAoC,wCAwD/C","sourcesContent":["import { FallbackProvider, Network, WebSocketProvider } from 'ethers';\nimport { ConfiguredJsonRpcProvider } from './configured-json-rpc-provider';\nimport { FallbackProviderConfig } from 'ethers/lib.commonjs/providers/provider-fallback';\n\nexport type FallbackProviderJsonConfig = {\n  chainId: number;\n  providers: ProviderJson[];\n};\n\nexport type ProviderJson = {\n  priority: number;\n  weight: number;\n  provider: string;\n  stallTimeout?: number;\n  maxLogsPerBatch?: number;\n};\n\nexport const createFallbackProviderFromJsonConfig = (\n  config: FallbackProviderJsonConfig,\n): FallbackProvider => {\n  try {\n    const totalWeight = config.providers.reduce(\n      (acc, { weight }) => acc + weight,\n      0,\n    );\n    if (totalWeight < 2) {\n      throw new Error(\n        'Total weight across providers must be >= 2 for fallback quorum.',\n      );\n    }\n\n    const network = Network.from(Number(config.chainId));\n\n    const providers: FallbackProviderConfig[] = config.providers.map(\n      ({\n        provider: providerURL,\n        priority,\n        weight,\n        stallTimeout,\n        maxLogsPerBatch,\n      }) => {\n        const isWebsocket = providerURL.startsWith('wss');\n        const provider = isWebsocket\n          ? new WebSocketProvider(providerURL, network)\n          : new ConfiguredJsonRpcProvider(\n              providerURL,\n              network,\n              maxLogsPerBatch,\n            );\n\n        const fallbackProviderConfig: FallbackProviderConfig = {\n          provider,\n          priority,\n          weight,\n          stallTimeout,\n        };\n        return fallbackProviderConfig;\n      },\n    );\n\n    return new FallbackProvider(providers, network);\n  } catch (cause) {\n    if (!(cause instanceof Error)) {\n      throw new Error(\n        'Non-error thrown from createFallbackProviderFromJsonConfig',\n        { cause },\n      );\n    }\n    throw new Error(\n      `Invalid fallback provider config for chain ${config.chainId}`,\n      { cause },\n    );\n  }\n};\n"]}

package/dist/utils/format.d.ts

@@ -0,0 +1 @@
+export declare const decimalToHexString: (dec: string | number) => string;

package/dist/utils/format.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decimalToHexString = void 0;
+const decimalToHexString = (dec) => {
+    return BigInt(dec).toString(16);
+};
+exports.decimalToHexString = decimalToHexString;
+//# sourceMappingURL=format.js.map

package/dist/utils/format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.js","sourceRoot":"","sources":["../../src/utils/format.ts"],"names":[],"mappings":";;;AAAO,MAAM,kBAAkB,GAAG,CAAC,GAAoB,EAAE,EAAE;IACzD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;AAClC,CAAC,CAAC;AAFW,QAAA,kBAAkB,sBAE7B","sourcesContent":["export const decimalToHexString = (dec: string | number) => {\n  return BigInt(dec).toString(16);\n};\n"]}

package/dist/utils/gas.d.ts

@@ -0,0 +1,7 @@
+import { NetworkName } from '../models/network-config';
+import { EVMGasType, TransactionGasDetails } from '../models/response-types';
+export declare const getEVMGasTypeForTransaction: (networkName: NetworkName, sendWithPublicWallet: boolean) => EVMGasType;
+export declare const calculateGasLimit: (gasEstimate: bigint) => bigint;
+export declare const calculateGasPrice: (gasDetails: TransactionGasDetails) => bigint;
+export declare const calculateTotalGas: (transactionGasDetails: TransactionGasDetails) => bigint;
+export declare const calculateMaximumGas: (transactionGasDetails: TransactionGasDetails) => bigint;

package/dist/utils/gas.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculateMaximumGas = exports.calculateTotalGas = exports.calculateGasPrice = exports.calculateGasLimit = exports.getEVMGasTypeForTransaction = void 0;
+const network_config_1 = require("../models/network-config");
+const response_types_1 = require("../models/response-types");
+const getEVMGasTypeForTransaction = (networkName, sendWithPublicWallet) => {
+    const { defaultEVMGasType } = network_config_1.NETWORK_CONFIG[networkName];
+    if (defaultEVMGasType === response_types_1.EVMGasType.Type2 && !sendWithPublicWallet) {
+        // Relayed transactions require overallBatchMinGasPrice.
+        // This is only supported by type 1 transactions.
+        return response_types_1.EVMGasType.Type1;
+    }
+    return defaultEVMGasType;
+};
+exports.getEVMGasTypeForTransaction = getEVMGasTypeForTransaction;
+const calculateGasLimit = (gasEstimate) => {
+    // Gas Limit: Add 20% to gas estimate.
+    return (gasEstimate * 12000n) / 10000n;
+};
+exports.calculateGasLimit = calculateGasLimit;
+const calculateGasPrice = (gasDetails) => {
+    switch (gasDetails.evmGasType) {
+        case response_types_1.EVMGasType.Type0:
+        case response_types_1.EVMGasType.Type1: {
+            return gasDetails.gasPrice;
+        }
+        case response_types_1.EVMGasType.Type2:
+        case response_types_1.EVMGasType.Type4: {
+            return gasDetails.maxFeePerGas;
+        }
+    }
+};
+exports.calculateGasPrice = calculateGasPrice;
+const calculateTotalGas = (transactionGasDetails) => {
+    const gasPrice = (0, exports.calculateGasPrice)(transactionGasDetails);
+    const { gasEstimate } = transactionGasDetails;
+    return gasEstimate * gasPrice;
+};
+exports.calculateTotalGas = calculateTotalGas;
+const calculateMaximumGas = (transactionGasDetails) => {
+    const gasPrice = (0, exports.calculateGasPrice)(transactionGasDetails);
+    const { gasEstimate } = transactionGasDetails;
+    return (0, exports.calculateGasLimit)(gasEstimate) * gasPrice;
+};
+exports.calculateMaximumGas = calculateMaximumGas;
+//# sourceMappingURL=gas.js.map

package/dist/utils/gas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gas.js","sourceRoot":"","sources":["../../src/utils/gas.ts"],"names":[],"mappings":";;;AAAA,6DAAuE;AACvE,6DAA6E;AAEtE,MAAM,2BAA2B,GAAG,CACzC,WAAwB,EACxB,oBAA6B,EACjB,EAAE;IACd,MAAM,EAAE,iBAAiB,EAAE,GAAG,+BAAc,CAAC,WAAW,CAAC,CAAC;IAE1D,IAAI,iBAAiB,KAAK,2BAAU,CAAC,KAAK,IAAI,CAAC,oBAAoB,EAAE;QACnE,wDAAwD;QACxD,iDAAiD;QACjD,OAAO,2BAAU,CAAC,KAAK,CAAC;KACzB;IAED,OAAO,iBAAiB,CAAC;AAC3B,CAAC,CAAC;AAbW,QAAA,2BAA2B,+BAatC;AAEK,MAAM,iBAAiB,GAAG,CAAC,WAAmB,EAAU,EAAE;IAC/D,sCAAsC;IACtC,OAAO,CAAC,WAAW,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC;AACzC,CAAC,CAAC;AAHW,QAAA,iBAAiB,qBAG5B;AAEK,MAAM,iBAAiB,GAAG,CAAC,UAAiC,EAAE,EAAE;IACrE,QAAQ,UAAU,CAAC,UAAU,EAAE;QAC7B,KAAK,2BAAU,CAAC,KAAK,CAAC;QACtB,KAAK,2BAAU,CAAC,KAAK,CAAC,CAAC;YACrB,OAAO,UAAU,CAAC,QAAQ,CAAC;SAC5B;QACD,KAAK,2BAAU,CAAC,KAAK,CAAC;QACtB,KAAK,2BAAU,CAAC,KAAK,CAAC,CAAC;YACrB,OAAO,UAAU,CAAC,YAAY,CAAC;SAChC;KACF;AACH,CAAC,CAAC;AAXW,QAAA,iBAAiB,qBAW5B;AAEK,MAAM,iBAAiB,GAAG,CAC/B,qBAA4C,EAC5C,EAAE;IACF,MAAM,QAAQ,GAAG,IAAA,yBAAiB,EAAC,qBAAqB,CAAC,CAAC;IAC1D,MAAM,EAAE,WAAW,EAAE,GAAG,qBAAqB,CAAC;IAC9C,OAAO,WAAW,GAAG,QAAQ,CAAC;AAChC,CAAC,CAAC;AANW,QAAA,iBAAiB,qBAM5B;AAEK,MAAM,mBAAmB,GAAG,CACjC,qBAA4C,EACpC,EAAE;IACV,MAAM,QAAQ,GAAG,IAAA,yBAAiB,EAAC,qBAAqB,CAAC,CAAC;IAC1D,MAAM,EAAE,WAAW,EAAE,GAAG,qBAAqB,CAAC;IAC9C,OAAO,IAAA,yBAAiB,EAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;AACnD,CAAC,CAAC;AANW,QAAA,mBAAmB,uBAM9B","sourcesContent":["import { NetworkName, NETWORK_CONFIG } from '../models/network-config';\nimport { EVMGasType, TransactionGasDetails } from '../models/response-types';\n\nexport const getEVMGasTypeForTransaction = (\n  networkName: NetworkName,\n  sendWithPublicWallet: boolean,\n): EVMGasType => {\n  const { defaultEVMGasType } = NETWORK_CONFIG[networkName];\n\n  if (defaultEVMGasType === EVMGasType.Type2 && !sendWithPublicWallet) {\n    // Relayed transactions require overallBatchMinGasPrice.\n    // This is only supported by type 1 transactions.\n    return EVMGasType.Type1;\n  }\n\n  return defaultEVMGasType;\n};\n\nexport const calculateGasLimit = (gasEstimate: bigint): bigint => {\n  // Gas Limit: Add 20% to gas estimate.\n  return (gasEstimate * 12000n) / 10000n;\n};\n\nexport const calculateGasPrice = (gasDetails: TransactionGasDetails) => {\n  switch (gasDetails.evmGasType) {\n    case EVMGasType.Type0:\n    case EVMGasType.Type1: {\n      return gasDetails.gasPrice;\n    }\n    case EVMGasType.Type2:\n    case EVMGasType.Type4: {\n      return gasDetails.maxFeePerGas;\n    }\n  }\n};\n\nexport const calculateTotalGas = (\n  transactionGasDetails: TransactionGasDetails,\n) => {\n  const gasPrice = calculateGasPrice(transactionGasDetails);\n  const { gasEstimate } = transactionGasDetails;\n  return gasEstimate * gasPrice;\n};\n\nexport const calculateMaximumGas = (\n  transactionGasDetails: TransactionGasDetails,\n): bigint => {\n  const gasPrice = calculateGasPrice(transactionGasDetails);\n  const { gasEstimate } = transactionGasDetails;\n  return calculateGasLimit(gasEstimate) * gasPrice;\n};\n"]}

package/dist/utils/index.d.ts

@@ -0,0 +1,11 @@
+export * from './artifact-v2';
+export * from './available-rpc';
+export * from './compare';
+export * from './fallback-provider';
+export * from './error';
+export * from './format';
+export * from './gas';
+export * from './network';
+export * from './promises';
+export * from './util';
+export * from './versions';

package/dist/utils/index.js

@@ -0,0 +1,28 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./artifact-v2"), exports);
+__exportStar(require("./available-rpc"), exports);
+__exportStar(require("./compare"), exports);
+__exportStar(require("./fallback-provider"), exports);
+__exportStar(require("./error"), exports);
+__exportStar(require("./format"), exports);
+__exportStar(require("./gas"), exports);
+__exportStar(require("./network"), exports);
+__exportStar(require("./promises"), exports);
+__exportStar(require("./util"), exports);
+__exportStar(require("./versions"), exports);
+//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,kDAAgC;AAChC,4CAA0B;AAC1B,sDAAoC;AACpC,0CAAwB;AACxB,2CAAyB;AACzB,wCAAsB;AACtB,4CAA0B;AAC1B,6CAA2B;AAC3B,yCAAuB;AACvB,6CAA2B","sourcesContent":["export * from './artifact-v2';\nexport * from './available-rpc';\nexport * from './compare';\nexport * from './fallback-provider';\nexport * from './error';\nexport * from './format';\nexport * from './gas';\nexport * from './network';\nexport * from './promises';\nexport * from './util';\nexport * from './versions';\n"]}

package/dist/utils/median.d.ts

@@ -0,0 +1 @@
+export declare const getUpperBoundMedian: (numbers: number[]) => number;

package/dist/utils/median.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUpperBoundMedian = void 0;
+const getUpperBoundMedian = (numbers) => {
+    if (!numbers.length) {
+        return 0;
+    }
+    const index = Math.floor(numbers.length / 2);
+    const sorted = numbers.sort();
+    return sorted[index];
+};
+exports.getUpperBoundMedian = getUpperBoundMedian;
+//# sourceMappingURL=median.js.map

package/dist/utils/median.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"median.js","sourceRoot":"","sources":["../../src/utils/median.ts"],"names":[],"mappings":";;;AAAO,MAAM,mBAAmB,GAAG,CAAC,OAAiB,EAAE,EAAE;IACvD,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;QACnB,OAAO,CAAC,CAAC;KACV;IACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAC9B,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC,CAAC;AAPW,QAAA,mBAAmB,uBAO9B","sourcesContent":["export const getUpperBoundMedian = (numbers: number[]) => {\n  if (!numbers.length) {\n    return 0;\n  }\n  const index = Math.floor(numbers.length / 2);\n  const sorted = numbers.sort();\n  return sorted[index];\n};\n"]}

package/dist/utils/network.d.ts

@@ -0,0 +1,5 @@
+import { MatrixNetwork, NetworkName } from '../models/network-config';
+import { Chain } from '../models/response-types';
+import type { Optional } from '../types/global';
+export declare const networkForChain: (chain: Chain) => Optional<MatrixNetwork>;
+export declare const isHistoricalRelayAdaptContractAddress: (networkName: NetworkName, address: string) => boolean;

package/dist/utils/network.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isHistoricalRelayAdaptContractAddress = exports.networkForChain = void 0;
+const network_config_1 = require("../models/network-config");
+const networkForChain = (chain) => {
+    return Object.values(network_config_1.NETWORK_CONFIG).find(network => network.chain.type === chain.type && network.chain.id === chain.id);
+};
+exports.networkForChain = networkForChain;
+const isHistoricalRelayAdaptContractAddress = (networkName, address) => {
+    const network = network_config_1.NETWORK_CONFIG[networkName];
+    return (network.relayAdaptHistory.find(historicalAddress => {
+        return historicalAddress.toLowerCase() === address.toLowerCase();
+    }) != null);
+};
+exports.isHistoricalRelayAdaptContractAddress = isHistoricalRelayAdaptContractAddress;
+//# sourceMappingURL=network.js.map

package/dist/utils/network.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"network.js","sourceRoot":"","sources":["../../src/utils/network.ts"],"names":[],"mappings":";;;AAAA,6DAAsF;AAI/E,MAAM,eAAe,GAAG,CAAC,KAAY,EAA2B,EAAE;IACvE,OAAO,MAAM,CAAC,MAAM,CAAC,+BAAc,CAAC,CAAC,IAAI,CACvC,OAAO,CAAC,EAAE,CACR,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,KAAK,CAAC,EAAE,CACrE,CAAC;AACJ,CAAC,CAAC;AALW,QAAA,eAAe,mBAK1B;AAEK,MAAM,qCAAqC,GAAG,CACnD,WAAwB,EACxB,OAAe,EACf,EAAE;IACF,MAAM,OAAO,GAAG,+BAAc,CAAC,WAAW,CAAC,CAAC;IAC5C,OAAO,CACL,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE;QACjD,OAAO,iBAAiB,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAAC;IACnE,CAAC,CAAC,IAAI,IAAI,CACX,CAAC;AACJ,CAAC,CAAC;AAVW,QAAA,qCAAqC,yCAUhD","sourcesContent":["import { MatrixNetwork, NETWORK_CONFIG, NetworkName } from '../models/network-config';\nimport { Chain } from '../models/response-types';\nimport type { Optional } from '../types/global';\n\nexport const networkForChain = (chain: Chain): Optional<MatrixNetwork> => {\n  return Object.values(NETWORK_CONFIG).find(\n    network =>\n      network.chain.type === chain.type && network.chain.id === chain.id,\n  );\n};\n\nexport const isHistoricalRelayAdaptContractAddress = (\n  networkName: NetworkName,\n  address: string,\n) => {\n  const network = NETWORK_CONFIG[networkName];\n  return (\n    network.relayAdaptHistory.find(historicalAddress => {\n      return historicalAddress.toLowerCase() === address.toLowerCase();\n    }) != null\n  );\n};\n"]}

package/dist/utils/promises.d.ts

@@ -0,0 +1,4 @@
+import type { Optional } from '../types/global';
+export declare const delay: (delayInMS: number) => Promise<void>;
+export declare function promiseTimeout<T>(promise: Promise<T>, ms: number, customTimeoutError?: Error): Promise<T>;
+export declare function poll<T>(fn: () => Promise<T>, passCondition: (result: T) => boolean, delayInMS: number, allowedAttempts?: number): Promise<Optional<T>>;

package/dist/utils/promises.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.poll = exports.promiseTimeout = exports.delay = void 0;
+const delay = (delayInMS) => {
+    return new Promise(resolve => setTimeout(resolve, delayInMS));
+};
+exports.delay = delay;
+function promiseTimeout(promise, ms, customTimeoutError) {
+    // Create a promise that rejects in <ms> milliseconds
+    const timeout = new Promise((_resolve, reject) => {
+        const id = setTimeout(() => {
+            clearTimeout(id);
+            reject(new Error(`Timed out in ${ms} ms.`));
+        }, ms);
+    });
+    // Returns a race between our timeout and the passed in promise
+    return Promise.race([promise, timeout])
+        .then(result => result)
+        .catch(err => {
+        if (!(err instanceof Error)) {
+            throw err;
+        }
+        if (err.message.startsWith('Timed out')) {
+            throw customTimeoutError ?? err;
+        }
+        throw err;
+    });
+}
+exports.promiseTimeout = promiseTimeout;
+async function poll(fn, passCondition, delayInMS, allowedAttempts = 1) {
+    let result = await fn();
+    let attempts = 1;
+    while (attempts <= allowedAttempts) {
+        if (passCondition(result)) {
+            return result;
+        }
+        await (0, exports.delay)(delayInMS);
+        result = await fn();
+        attempts++;
+    }
+    return undefined;
+}
+exports.poll = poll;
+//# sourceMappingURL=promises.js.map

package/dist/utils/promises.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"promises.js","sourceRoot":"","sources":["../../src/utils/promises.ts"],"names":[],"mappings":";;;AAEO,MAAM,KAAK,GAAG,CAAC,SAAiB,EAAiB,EAAE;IACxD,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;AAChE,CAAC,CAAC;AAFW,QAAA,KAAK,SAEhB;AAEF,SAAgB,cAAc,CAC5B,OAAmB,EACnB,EAAU,EACV,kBAA0B;IAE1B,qDAAqD;IACrD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE;QAC/C,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE;YACzB,YAAY,CAAC,EAAE,CAAC,CAAC;YACjB,MAAM,CAAC,IAAI,KAAK,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC,CAAC;QAC9C,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC,CAAC,CAAC;IAEH,+DAA+D;IAC/D,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;SACpC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAW,CAAC;SAC3B,KAAK,CAAC,GAAG,CAAC,EAAE;QACX,IAAI,CAAC,CAAC,GAAG,YAAY,KAAK,CAAC,EAAE;YAC3B,MAAM,GAAG,CAAC;SACX;QACD,IAAI,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE;YACvC,MAAM,kBAAkB,IAAI,GAAG,CAAC;SACjC;QACD,MAAM,GAAG,CAAC;IACZ,CAAC,CAAC,CAAC;AACP,CAAC;AAzBD,wCAyBC;AAEM,KAAK,UAAU,IAAI,CACxB,EAAoB,EACpB,aAAqC,EACrC,SAAiB,EACjB,eAAe,GAAG,CAAC;IAEnB,IAAI,MAAM,GAAG,MAAM,EAAE,EAAE,CAAC;IACxB,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,OAAO,QAAQ,IAAI,eAAe,EAAE;QAClC,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE;YACzB,OAAO,MAAM,CAAC;SACf;QACD,MAAM,IAAA,aAAK,EAAC,SAAS,CAAC,CAAC;QACvB,MAAM,GAAG,MAAM,EAAE,EAAE,CAAC;QACpB,QAAQ,EAAE,CAAC;KACZ;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAjBD,oBAiBC","sourcesContent":["import type { Optional } from '../types/global';\n\nexport const delay = (delayInMS: number): Promise<void> => {\n  return new Promise(resolve => setTimeout(resolve, delayInMS));\n};\n\nexport function promiseTimeout<T>(\n  promise: Promise<T>,\n  ms: number,\n  customTimeoutError?: Error,\n): Promise<T> {\n  // Create a promise that rejects in <ms> milliseconds\n  const timeout = new Promise((_resolve, reject) => {\n    const id = setTimeout(() => {\n      clearTimeout(id);\n      reject(new Error(`Timed out in ${ms} ms.`));\n    }, ms);\n  });\n\n  // Returns a race between our timeout and the passed in promise\n  return Promise.race([promise, timeout])\n    .then(result => result as T)\n    .catch(err => {\n      if (!(err instanceof Error)) {\n        throw err;\n      }\n      if (err.message.startsWith('Timed out')) {\n        throw customTimeoutError ?? err;\n      }\n      throw err;\n    });\n}\n\nexport async function poll<T>(\n  fn: () => Promise<T>,\n  passCondition: (result: T) => boolean,\n  delayInMS: number,\n  allowedAttempts = 1,\n): Promise<Optional<T>> {\n  let result = await fn();\n  let attempts = 1;\n  while (attempts <= allowedAttempts) {\n    if (passCondition(result)) {\n      return result;\n    }\n    await delay(delayInMS);\n    result = await fn();\n    attempts++;\n  }\n  return undefined;\n}\n"]}

package/dist/utils/util.d.ts

@@ -0,0 +1,3 @@
+import type { Optional } from '../types/global';
+export declare const isDefined: <T>(a: T | null | undefined) => a is T;
+export declare const removeUndefineds: <T>(a: Optional<T>[]) => T[];

package/dist/utils/util.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeUndefineds = exports.isDefined = void 0;
+const isDefined = (a) => {
+    return typeof a !== 'undefined' && a !== null;
+};
+exports.isDefined = isDefined;
+const removeUndefineds = (a) => {
+    const newArray = [];
+    a.forEach(item => {
+        if ((0, exports.isDefined)(item)) {
+            newArray.push(item);
+        }
+    });
+    return newArray;
+};
+exports.removeUndefineds = removeUndefineds;
+//# sourceMappingURL=util.js.map

package/dist/utils/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/utils/util.ts"],"names":[],"mappings":";;;AAEO,MAAM,SAAS,GAAG,CAAI,CAAuB,EAAU,EAAE;IAC9D,OAAO,OAAO,CAAC,KAAK,WAAW,IAAI,CAAC,KAAK,IAAI,CAAC;AAChD,CAAC,CAAC;AAFW,QAAA,SAAS,aAEpB;AAEK,MAAM,gBAAgB,GAAG,CAAI,CAAgB,EAAO,EAAE;IAC3D,MAAM,QAAQ,GAAQ,EAAE,CAAC;IACzB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACf,IAAI,IAAA,iBAAS,EAAC,IAAI,CAAC,EAAE;YACnB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACrB;IACH,CAAC,CAAC,CAAC;IACH,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AARW,QAAA,gBAAgB,oBAQ3B","sourcesContent":["import type { Optional } from '../types/global';\n\nexport const isDefined = <T>(a: T | undefined | null): a is T => {\n  return typeof a !== 'undefined' && a !== null;\n};\n\nexport const removeUndefineds = <T>(a: Optional<T>[]): T[] => {\n  const newArray: T[] = [];\n  a.forEach(item => {\n    if (isDefined(item)) {\n      newArray.push(item);\n    }\n  });\n  return newArray;\n};\n"]}

package/dist/utils/versions.d.ts

@@ -0,0 +1 @@
+export declare const versionCompare: (appVersion?: string, minVersion?: string) => number;

package/dist/utils/versions.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.versionCompare = void 0;
+const util_1 = require("./util");
+const versionCompare = (appVersion, minVersion) => {
+    if (!(0, util_1.isDefined)(appVersion) || !(0, util_1.isDefined)(minVersion)) {
+        throw new Error('Requires two version numbers to compare.');
+    }
+    // Adapted from https://stackoverflow.com/a/6832721
+    const zeroExtend = true, v1parts = appVersion.split('.'), v2parts = minVersion.split('.');
+    function isValidPart(x) {
+        return /^\d+$/.test(x);
+    }
+    if (!v1parts.every(isValidPart) || !v2parts.every(isValidPart)) {
+        return NaN;
+    }
+    if (zeroExtend) {
+        while (v1parts.length < v2parts.length) {
+            v1parts.push('0');
+        }
+        while (v2parts.length < v1parts.length) {
+            v2parts.push('0');
+        }
+    }
+    const v1parts_number = v1parts.map(Number);
+    const v2parts_number = v2parts.map(Number);
+    for (let i = 0; i < v1parts_number.length; ++i) {
+        if (v2parts_number.length === i) {
+            return 1;
+        }
+        if (v1parts_number[i] === v2parts_number[i]) {
+            continue;
+        }
+        else if (v1parts_number[i] > v2parts_number[i]) {
+            return 1;
+        }
+        else {
+            return -1;
+        }
+    }
+    if (v1parts_number.length !== v2parts_number.length) {
+        return -1;
+    }
+    return 0;
+};
+exports.versionCompare = versionCompare;
+//# sourceMappingURL=versions.js.map

package/dist/utils/versions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"versions.js","sourceRoot":"","sources":["../../src/utils/versions.ts"],"names":[],"mappings":";;;AAAA,iCAAmC;AAE5B,MAAM,cAAc,GAAG,CAC5B,UAAmB,EACnB,UAAmB,EACX,EAAE;IACV,IAAI,CAAC,IAAA,gBAAS,EAAC,UAAU,CAAC,IAAI,CAAC,IAAA,gBAAS,EAAC,UAAU,CAAC,EAAE;QACpD,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;KAC7D;IAED,mDAAmD;IACnD,MAAM,UAAU,GAAG,IAAI,EACrB,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,EAC/B,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAElC,SAAS,WAAW,CAAC,CAAS;QAC5B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACzB,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE;QAC9D,OAAO,GAAG,CAAC;KACZ;IACD,IAAI,UAAU,EAAE;QACd,OAAO,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE;YACtC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACnB;QACD,OAAO,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE;YACtC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACnB;KACF;IAED,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC3C,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAE3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;QAC9C,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE;YAC/B,OAAO,CAAC,CAAC;SACV;QACD,IAAI,cAAc,CAAC,CAAC,CAAC,KAAK,cAAc,CAAC,CAAC,CAAC,EAAE;YAC3C,SAAS;SACV;aAAM,IAAI,cAAc,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,EAAE;YAChD,OAAO,CAAC,CAAC;SACV;aAAM;YACL,OAAO,CAAC,CAAC,CAAC;SACX;KACF;IACD,IAAI,cAAc,CAAC,MAAM,KAAK,cAAc,CAAC,MAAM,EAAE;QACnD,OAAO,CAAC,CAAC,CAAC;KACX;IACD,OAAO,CAAC,CAAC;AACX,CAAC,CAAC;AAhDW,QAAA,cAAc,kBAgDzB","sourcesContent":["import { isDefined } from './util';\n\nexport const versionCompare = (\n  appVersion?: string,\n  minVersion?: string,\n): number => {\n  if (!isDefined(appVersion) || !isDefined(minVersion)) {\n    throw new Error('Requires two version numbers to compare.');\n  }\n\n  // Adapted from https://stackoverflow.com/a/6832721\n  const zeroExtend = true,\n    v1parts = appVersion.split('.'),\n    v2parts = minVersion.split('.');\n\n  function isValidPart(x: string) {\n    return /^\\d+$/.test(x);\n  }\n\n  if (!v1parts.every(isValidPart) || !v2parts.every(isValidPart)) {\n    return NaN;\n  }\n  if (zeroExtend) {\n    while (v1parts.length < v2parts.length) {\n      v1parts.push('0');\n    }\n    while (v2parts.length < v1parts.length) {\n      v2parts.push('0');\n    }\n  }\n\n  const v1parts_number = v1parts.map(Number);\n  const v2parts_number = v2parts.map(Number);\n\n  for (let i = 0; i < v1parts_number.length; ++i) {\n    if (v2parts_number.length === i) {\n      return 1;\n    }\n    if (v1parts_number[i] === v2parts_number[i]) {\n      continue;\n    } else if (v1parts_number[i] > v2parts_number[i]) {\n      return 1;\n    } else {\n      return -1;\n    }\n  }\n  if (v1parts_number.length !== v2parts_number.length) {\n    return -1;\n  }\n  return 0;\n};\n"]}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@matrix-privacy/shared-models",
+  "version": "0.0.1",
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "main": "dist/index.js",
+  "files": [
+    "dist/**/*"
+  ],
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "npm run clean && tsc",
+    "prepare": "npm run build",
+    "check-circular-deps": "madge --circular .",
+    "eslint": "eslint src --ext .ts,.tsx --fix",
+    "lint": "npm run check-circular-deps && npm run eslint",
+    "tsc-test": "tsc -p tsconfig.test.json && tsc-alias -p tsconfig.test.json",
+    "compile-test": "npm run clean && npm run tsc-test",
+    "test-coverage": "npm run compile-test && nyc mocha 'src/**/__tests__/*.test.ts'",
+    "test": "npm run compile-test && mocha 'src/**/__tests__/*.test.ts'"
+  },
+  "peerDependencies": {
+    "ethers": "6.14.3"
+  },
+  "devDependencies": {
+    "@types/chai": "4.3.5",
+    "@types/chai-as-promised": "^7.1.5",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "20.3.1",
+    "@typescript-eslint/eslint-plugin": "5.60.0",
+    "@typescript-eslint/parser": "5.60.0",
+    "chai": "^4.3.7",
+    "chai-as-promised": "^7.1.1",
+    "eslint": "8.43.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-flowtype": "^8.0.3",
+    "eslint-plugin-import": "^2.26.0",
+    "ethers": "6.14.3",
+    "madge": "6.1.0",
+    "mocha": "^10.2.0",
+    "ts-node": "^10.9.1",
+    "tsc-alias": "^1.8.2",
+    "typescript": "5.1.3"
+  },
+  "packageManager": "yarn@1.22.22"
+}