dop-wallet-v6 1.1.5

package/dist/services/dop/core/providers.d.ts

@@ -0,0 +1,18 @@
+import { FallbackProviderJsonConfig, NetworkName, LoadProviderResponse } from 'dop-sharedmodel-v5';
+import { DopSmartWalletContract, RelayAdaptContract, PollingJsonRpcProvider } from 'dop-engine-v5';
+import { FallbackProvider } from 'ethers';
+export declare const getFallbackProviderForNetwork: (networkName: NetworkName) => FallbackProvider;
+export declare const getPollingProviderForNetwork: (networkName: NetworkName) => PollingJsonRpcProvider;
+export declare const setFallbackProviderForNetwork: (networkName: NetworkName, provider: FallbackProvider) => void;
+export declare const setPollingProviderForNetwork: (networkName: NetworkName, provider: PollingJsonRpcProvider) => void;
+export declare const getMerkleTreeForNetwork: (networkName: NetworkName) => import("dop-engine-v5/dist/merkletree/merkletree").MerkleTree;
+export declare const getDopSmartWalletContractForNetwork: (networkName: NetworkName) => DopSmartWalletContract;
+export declare const getRelayAdaptContractForNetwork: (networkName: NetworkName) => RelayAdaptContract;
+/**
+ * Note: The first provider listed in your fallback provider config is used as a polling provider
+ * for new DOP events (balance updates).
+ */
+export declare const loadProvider: (fallbackProviderJsonConfig: FallbackProviderJsonConfig, networkName: NetworkName, pollingInterval?: number) => Promise<LoadProviderResponse>;
+export declare const unloadProvider: (networkName: NetworkName) => Promise<void>;
+export declare const pauseAllPollingProviders: (excludeNetworkName?: NetworkName) => void;
+export declare const resumeIsolatedPollingProviderForNetwork: (networkName: NetworkName) => void;

package/dist/services/dop/core/providers.js

@@ -0,0 +1,162 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resumeIsolatedPollingProviderForNetwork = exports.pauseAllPollingProviders = exports.unloadProvider = exports.loadProvider = exports.getRelayAdaptContractForNetwork = exports.getDopSmartWalletContractForNetwork = exports.getMerkleTreeForNetwork = exports.setPollingProviderForNetwork = exports.setFallbackProviderForNetwork = exports.getPollingProviderForNetwork = exports.getFallbackProviderForNetwork = void 0;
+const dop_sharedmodel_v5_1 = require("dop-sharedmodel-v5");
+const logger_1 = require("../../../utils/logger");
+const engine_1 = require("./engine");
+const dop_engine_v5_1 = require("dop-engine-v5");
+const error_1 = require("../../../utils/error");
+const fallbackProviderMap = {};
+const pollingProviderMap = {};
+const getFallbackProviderForNetwork = (networkName) => {
+    const provider = fallbackProviderMap[networkName];
+    if (!(0, dop_sharedmodel_v5_1.isDefined)(provider)) {
+        throw new Error(`Provider not yet loaded for network ${networkName}`);
+    }
+    return provider;
+};
+exports.getFallbackProviderForNetwork = getFallbackProviderForNetwork;
+const getPollingProviderForNetwork = (networkName) => {
+    const provider = pollingProviderMap[networkName];
+    if (!(0, dop_sharedmodel_v5_1.isDefined)(provider)) {
+        throw new Error(`Polling provider not yet loaded for network ${networkName}`);
+    }
+    return provider;
+};
+exports.getPollingProviderForNetwork = getPollingProviderForNetwork;
+const setFallbackProviderForNetwork = (networkName, provider) => {
+    fallbackProviderMap[networkName] = provider;
+};
+exports.setFallbackProviderForNetwork = setFallbackProviderForNetwork;
+const setPollingProviderForNetwork = (networkName, provider) => {
+    pollingProviderMap[networkName] = provider;
+};
+exports.setPollingProviderForNetwork = setPollingProviderForNetwork;
+const getMerkleTreeForNetwork = (networkName) => {
+    const network = dop_sharedmodel_v5_1.NETWORK_CONFIG[networkName];
+    const { chain } = network;
+    const merkleTree = (0, engine_1.getEngine)().merkletrees[chain.type][chain.id];
+    if (!(0, dop_sharedmodel_v5_1.isDefined)(merkleTree)) {
+        throw new Error(`MerkleTree not yet loaded for network ${network.publicName}`);
+    }
+    return merkleTree;
+};
+exports.getMerkleTreeForNetwork = getMerkleTreeForNetwork;
+const getDopSmartWalletContractForNetwork = (networkName) => {
+    const network = dop_sharedmodel_v5_1.NETWORK_CONFIG[networkName];
+    const { chain } = network;
+    const dopSmartWalletContract = (0, engine_1.getEngine)().dopSmartWalletContracts[chain.type][chain.id];
+    if (!(0, dop_sharedmodel_v5_1.isDefined)(dopSmartWalletContract)) {
+        throw new Error(`DopSmartWallet contract not yet loaded for network ${network.publicName}`);
+    }
+    return dopSmartWalletContract;
+};
+exports.getDopSmartWalletContractForNetwork = getDopSmartWalletContractForNetwork;
+const getRelayAdaptContractForNetwork = (networkName) => {
+    const network = dop_sharedmodel_v5_1.NETWORK_CONFIG[networkName];
+    const { chain } = network;
+    const relayAdaptContract = (0, engine_1.getEngine)().relayAdaptContracts[chain.type][chain.id];
+    if (!(0, dop_sharedmodel_v5_1.isDefined)(relayAdaptContract)) {
+        throw new Error(`Relay Adapt contract not yet loaded for network ${network.publicName}`);
+    }
+    return relayAdaptContract;
+};
+exports.getRelayAdaptContractForNetwork = getRelayAdaptContractForNetwork;
+const createFallbackProviderForNetwork = async (networkName, fallbackProviderJsonConfig) => {
+    const existingProvider = fallbackProviderMap[networkName];
+    if (existingProvider) {
+        return existingProvider;
+    }
+    const fallbackProvider = (0, dop_sharedmodel_v5_1.createFallbackProviderFromJsonConfig)(fallbackProviderJsonConfig);
+    (0, exports.setFallbackProviderForNetwork)(networkName, fallbackProvider);
+    return fallbackProvider;
+};
+const createPollingProviderForNetwork = async (networkName, fallbackProvider, pollingInterval) => {
+    const existingProvider = pollingProviderMap[networkName];
+    if (existingProvider) {
+        return existingProvider;
+    }
+    const pollingProvider = await (0, dop_engine_v5_1.createPollingJsonRpcProviderForListeners)(fallbackProvider, pollingInterval);
+    (0, exports.setPollingProviderForNetwork)(networkName, pollingProvider);
+    return pollingProvider;
+};
+const loadProviderForNetwork = async (chain, networkName, fallbackProviderJsonConfig, pollingInterval) => {
+    (0, logger_1.sendMessage)(`Load provider for network: ${networkName}`);
+    const fallbackProvider = await createFallbackProviderForNetwork(networkName, fallbackProviderJsonConfig);
+    const pollingProvider = await createPollingProviderForNetwork(networkName, fallbackProvider, pollingInterval);
+    const network = dop_sharedmodel_v5_1.NETWORK_CONFIG[networkName];
+    const { proxyContract, relayAdaptContract, deploymentBlock, publicName } = network;
+    // eslint-disable-next-line
+    if (!proxyContract) {
+        throw new Error(`Could not find Proxy contract for network: ${publicName}`);
+    }
+    // eslint-disable-next-line
+    if (!relayAdaptContract) {
+        throw new Error(`Could not find Relay Adapt contract for network: ${publicName}`);
+    }
+    const engine = (0, engine_1.getEngine)();
+    // This function will set up the contracts for this chain.
+    // Throws if provider does not respond.
+    await engine.loadNetwork(chain, proxyContract, relayAdaptContract, fallbackProvider, pollingProvider, deploymentBlock ?? 0);
+    // NOTE: This is an async call, but we need not await.
+    // Let Engine scan events in the background.
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    engine.scanHistory(chain);
+};
+/**
+ * Note: The first provider listed in your fallback provider config is used as a polling provider
+ * for new DOP events (balance updates).
+ */
+const loadProvider = async (fallbackProviderJsonConfig, networkName, pollingInterval = 15000) => {
+    try {
+        delete fallbackProviderMap[networkName];
+        const { chain } = dop_sharedmodel_v5_1.NETWORK_CONFIG[networkName];
+        if (fallbackProviderJsonConfig.chainId !== chain.id) {
+            throw new Error('Invalid chain ID');
+        }
+        await loadProviderForNetwork(chain, networkName, fallbackProviderJsonConfig, pollingInterval);
+        const dopSmartWalletContract = (0, exports.getDopSmartWalletContractForNetwork)(networkName);
+        const { shield, unshield, nft } = await dopSmartWalletContract.fees();
+        // Note: Shield and Unshield fees are in basis points.
+        // NFT fee is in wei (though currently 0).
+        const feesSerialized = {
+            shield: shield.toString(),
+            unshield: unshield.toString(),
+            nft: nft.toString(),
+        };
+        return { feesSerialized };
+    }
+    catch (err) {
+        throw (0, error_1.reportAndSanitizeError)(exports.loadProvider.name, err);
+    }
+};
+exports.loadProvider = loadProvider;
+const unloadProvider = async (networkName) => {
+    await fallbackProviderMap[networkName]?.destroy();
+    pollingProviderMap[networkName]?.destroy();
+    delete fallbackProviderMap[networkName];
+    delete pollingProviderMap[networkName];
+};
+exports.unloadProvider = unloadProvider;
+const pauseAllPollingProviders = (excludeNetworkName) => {
+    Object.keys(pollingProviderMap).forEach(networkName => {
+        if (networkName === excludeNetworkName) {
+            return;
+        }
+        const pollingProvider = pollingProviderMap[networkName];
+        if ((0, dop_sharedmodel_v5_1.isDefined)(pollingProvider) && !pollingProvider.paused) {
+            pollingProvider.pause();
+        }
+    });
+};
+exports.pauseAllPollingProviders = pauseAllPollingProviders;
+const resumeIsolatedPollingProviderForNetwork = (networkName) => {
+    (0, exports.pauseAllPollingProviders)(networkName);
+    const pollingProviderForNetwork = pollingProviderMap[networkName];
+    if ((0, dop_sharedmodel_v5_1.isDefined)(pollingProviderForNetwork) &&
+        pollingProviderForNetwork.paused) {
+        pollingProviderForNetwork.resume();
+    }
+};
+exports.resumeIsolatedPollingProviderForNetwork = resumeIsolatedPollingProviderForNetwork;
+//# sourceMappingURL=providers.js.map

package/dist/services/dop/core/providers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"providers.js","sourceRoot":"","sources":["../../../../src/services/dop/core/providers.ts"],"names":[],"mappings":";;;AAAA,2DAO4B;AAC5B,kDAAoD;AACpD,qCAAqC;AACrC,iDAMuB;AACvB,gDAA8D;AAG9D,MAAM,mBAAmB,GAA8B,EAAE,CAAC;AAC1D,MAAM,kBAAkB,GAAoC,EAAE,CAAC;AAExD,MAAM,6BAA6B,GAAG,CAC3C,WAAwB,EACN,EAAE;IACpB,MAAM,QAAQ,GAAG,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAClD,IAAI,CAAC,IAAA,8BAAS,EAAC,QAAQ,CAAC,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,uCAAuC,WAAW,EAAE,CAAC,CAAC;KACvE;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AARW,QAAA,6BAA6B,iCAQxC;AAEK,MAAM,4BAA4B,GAAG,CAC1C,WAAwB,EACA,EAAE;IAC1B,MAAM,QAAQ,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;IACjD,IAAI,CAAC,IAAA,8BAAS,EAAC,QAAQ,CAAC,EAAE;QACxB,MAAM,IAAI,KAAK,CACb,+CAA+C,WAAW,EAAE,CAC7D,CAAC;KACH;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAVW,QAAA,4BAA4B,gCAUvC;AAEK,MAAM,6BAA6B,GAAG,CAC3C,WAAwB,EACxB,QAA0B,EACpB,EAAE;IACR,mBAAmB,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;AAC9C,CAAC,CAAC;AALW,QAAA,6BAA6B,iCAKxC;AAEK,MAAM,4BAA4B,GAAG,CAC1C,WAAwB,EACxB,QAAgC,EAC1B,EAAE;IACR,kBAAkB,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;AAC7C,CAAC,CAAC;AALW,QAAA,4BAA4B,gCAKvC;AAEK,MAAM,uBAAuB,GAAG,CAAC,WAAwB,EAAE,EAAE;IAClE,MAAM,OAAO,GAAG,mCAAc,CAAC,WAAW,CAAC,CAAC;IAC5C,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IAC1B,MAAM,UAAU,GAAG,IAAA,kBAAS,GAAE,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACjE,IAAI,CAAC,IAAA,8BAAS,EAAC,UAAU,CAAC,EAAE;QAC1B,MAAM,IAAI,KAAK,CACb,yCAAyC,OAAO,CAAC,UAAU,EAAE,CAC9D,CAAC;KACH;IACD,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAVW,QAAA,uBAAuB,2BAUlC;AAEK,MAAM,mCAAmC,GAAG,CACjD,WAAwB,EACA,EAAE;IAC1B,MAAM,OAAO,GAAG,mCAAc,CAAC,WAAW,CAAC,CAAC;IAC5C,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IAE1B,MAAM,sBAAsB,GAC1B,IAAA,kBAAS,GAAE,CAAC,uBAAuB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC5D,IAAI,CAAC,IAAA,8BAAS,EAAC,sBAAsB,CAAC,EAAE;QACtC,MAAM,IAAI,KAAK,CACb,sDAAsD,OAAO,CAAC,UAAU,EAAE,CAC3E,CAAC;KACH;IACD,OAAO,sBAAsB,CAAC;AAChC,CAAC,CAAC;AAdW,QAAA,mCAAmC,uCAc9C;AAEK,MAAM,+BAA+B,GAAG,CAC7C,WAAwB,EACJ,EAAE;IACtB,MAAM,OAAO,GAAG,mCAAc,CAAC,WAAW,CAAC,CAAC;IAC5C,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IAC1B,MAAM,kBAAkB,GACtB,IAAA,kBAAS,GAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACxD,IAAI,CAAC,IAAA,8BAAS,EAAC,kBAAkB,CAAC,EAAE;QAClC,MAAM,IAAI,KAAK,CACb,mDAAmD,OAAO,CAAC,UAAU,EAAE,CACxE,CAAC;KACH;IACD,OAAO,kBAAkB,CAAC;AAC5B,CAAC,CAAC;AAbW,QAAA,+BAA+B,mCAa1C;AAEF,MAAM,gCAAgC,GAAG,KAAK,EAC5C,WAAwB,EACxB,0BAAsD,EAC3B,EAAE;IAC7B,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAC1D,IAAI,gBAAgB,EAAE;QACpB,OAAO,gBAAgB,CAAC;KACzB;IACD,MAAM,gBAAgB,GAAG,IAAA,yDAAoC,EAC3D,0BAA0B,CAC3B,CAAC;IACF,IAAA,qCAA6B,EAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC;IAC7D,OAAO,gBAAgB,CAAC;AAC1B,CAAC,CAAC;AAEF,MAAM,+BAA+B,GAAG,KAAK,EAC3C,WAAwB,EACxB,gBAAkC,EAClC,eAAuB,EACU,EAAE;IACnC,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;IACzD,IAAI,gBAAgB,EAAE;QACpB,OAAO,gBAAgB,CAAC;KACzB;IACD,MAAM,eAAe,GAAG,MAAM,IAAA,wDAAwC,EACpE,gBAAgB,EAChB,eAAe,CAChB,CAAC;IACF,IAAA,oCAA4B,EAAC,WAAW,EAAE,eAAe,CAAC,CAAC;IAC3D,OAAO,eAAe,CAAC;AACzB,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,KAAK,EAClC,KAAY,EACZ,WAAwB,EACxB,0BAAsD,EACtD,eAAuB,EACvB,EAAE;IACF,IAAA,oBAAW,EAAC,8BAA8B,WAAW,EAAE,CAAC,CAAC;IAEzD,MAAM,gBAAgB,GAAG,MAAM,gCAAgC,CAC7D,WAAW,EACX,0BAA0B,CAC3B,CAAC;IACF,MAAM,eAAe,GAAG,MAAM,+BAA+B,CAC3D,WAAW,EACX,gBAAgB,EAChB,eAAe,CAChB,CAAC;IAEF,MAAM,OAAO,GAAG,mCAAc,CAAC,WAAW,CAAC,CAAC;IAC5C,MAAM,EAAE,aAAa,EAAE,kBAAkB,EAAE,eAAe,EAAE,UAAU,EAAE,GACtE,OAAO,CAAC;IACV,2BAA2B;IAC3B,IAAI,CAAC,aAAa,EAAE;QAClB,MAAM,IAAI,KAAK,CAAC,8CAA8C,UAAU,EAAE,CAAC,CAAC;KAC7E;IACD,2BAA2B;IAC3B,IAAI,CAAC,kBAAkB,EAAE;QACvB,MAAM,IAAI,KAAK,CACb,oDAAoD,UAAU,EAAE,CACjE,CAAC;KACH;IAED,MAAM,MAAM,GAAG,IAAA,kBAAS,GAAE,CAAC;IAE3B,0DAA0D;IAC1D,uCAAuC;IACvC,MAAM,MAAM,CAAC,WAAW,CACtB,KAAK,EACL,aAAa,EACb,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,EACf,eAAe,IAAI,CAAC,CACrB,CAAC;IAEF,sDAAsD;IACtD,4CAA4C;IAC5C,mEAAmE;IACnE,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF;;;GAGG;AACI,MAAM,YAAY,GAAG,KAAK,EAC/B,0BAAsD,EACtD,WAAwB,EACxB,eAAe,GAAG,KAAK,EACQ,EAAE;IACjC,IAAI;QACF,OAAO,mBAAmB,CAAC,WAAW,CAAC,CAAC;QAExC,MAAM,EAAE,KAAK,EAAE,GAAG,mCAAc,CAAC,WAAW,CAAC,CAAC;QAC9C,IAAI,0BAA0B,CAAC,OAAO,KAAK,KAAK,CAAC,EAAE,EAAE;YACnD,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;SACrC;QAED,MAAM,sBAAsB,CAC1B,KAAK,EACL,WAAW,EACX,0BAA0B,EAC1B,eAAe,CAChB,CAAC;QAEF,MAAM,sBAAsB,GAC1B,IAAA,2CAAmC,EAAC,WAAW,CAAC,CAAC;QAEnD,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,MAAM,sBAAsB,CAAC,IAAI,EAAE,CAAC;QAEtE,sDAAsD;QACtD,0CAA0C;QAC1C,MAAM,cAAc,GAAG;YACrB,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE;YACzB,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE;YAC7B,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE;SACpB,CAAC;QAEF,OAAO,EAAE,cAAc,EAAE,CAAC;KAC3B;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAA,8BAAsB,EAAC,oBAAY,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KACtD;AACH,CAAC,CAAC;AArCW,QAAA,YAAY,gBAqCvB;AAEK,MAAM,cAAc,GAAG,KAAK,EACjC,WAAwB,EACT,EAAE;IACjB,MAAM,mBAAmB,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,CAAC;IAClD,kBAAkB,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,CAAC;IAC3C,OAAO,mBAAmB,CAAC,WAAW,CAAC,CAAC;IACxC,OAAO,kBAAkB,CAAC,WAAW,CAAC,CAAC;AACzC,CAAC,CAAC;AAPW,QAAA,cAAc,kBAOzB;AAEK,MAAM,wBAAwB,GAAG,CACtC,kBAAgC,EAC1B,EAAE;IACR,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;QACpD,IAAI,WAAW,KAAK,kBAAkB,EAAE;YACtC,OAAO;SACR;QACD,MAAM,eAAe,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACxD,IAAI,IAAA,8BAAS,EAAC,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE;YACzD,eAAe,CAAC,KAAK,EAAE,CAAC;SACzB;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAZW,QAAA,wBAAwB,4BAYnC;AAEK,MAAM,uCAAuC,GAAG,CACrD,WAAwB,EAClB,EAAE;IACR,IAAA,gCAAwB,EACtB,WAAW,CACZ,CAAC;IACF,MAAM,yBAAyB,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAClE,IACE,IAAA,8BAAS,EAAC,yBAAyB,CAAC;QACpC,yBAAyB,CAAC,MAAM,EAChC;QACA,yBAAyB,CAAC,MAAM,EAAE,CAAC;KACpC;AACH,CAAC,CAAC;AAbW,QAAA,uCAAuC,2CAalD","sourcesContent":["import {\n  FallbackProviderJsonConfig,\n  createFallbackProviderFromJsonConfig,\n  NetworkName,\n  NETWORK_CONFIG,\n  LoadProviderResponse,\n  isDefined,\n} from 'dop-sharedmodel-v5';\nimport { sendMessage } from '../../../utils/logger';\nimport { getEngine } from './engine';\nimport {\n  Chain,\n  DopSmartWalletContract,\n  RelayAdaptContract,\n  PollingJsonRpcProvider,\n  createPollingJsonRpcProviderForListeners,\n} from 'dop-engine-v5';\nimport { reportAndSanitizeError } from '../../../utils/error';\nimport { FallbackProvider } from 'ethers';\n\nconst fallbackProviderMap: MapType<FallbackProvider> = {};\nconst pollingProviderMap: MapType<PollingJsonRpcProvider> = {};\n\nexport const getFallbackProviderForNetwork = (\n  networkName: NetworkName,\n): FallbackProvider => {\n  const provider = fallbackProviderMap[networkName];\n  if (!isDefined(provider)) {\n    throw new Error(`Provider not yet loaded for network ${networkName}`);\n  }\n  return provider;\n};\n\nexport const getPollingProviderForNetwork = (\n  networkName: NetworkName,\n): PollingJsonRpcProvider => {\n  const provider = pollingProviderMap[networkName];\n  if (!isDefined(provider)) {\n    throw new Error(\n      `Polling provider not yet loaded for network ${networkName}`,\n    );\n  }\n  return provider;\n};\n\nexport const setFallbackProviderForNetwork = (\n  networkName: NetworkName,\n  provider: FallbackProvider,\n): void => {\n  fallbackProviderMap[networkName] = provider;\n};\n\nexport const setPollingProviderForNetwork = (\n  networkName: NetworkName,\n  provider: PollingJsonRpcProvider,\n): void => {\n  pollingProviderMap[networkName] = provider;\n};\n\nexport const getMerkleTreeForNetwork = (networkName: NetworkName) => {\n  const network = NETWORK_CONFIG[networkName];\n  const { chain } = network;\n  const merkleTree = getEngine().merkletrees[chain.type][chain.id];\n  if (!isDefined(merkleTree)) {\n    throw new Error(\n      `MerkleTree not yet loaded for network ${network.publicName}`,\n    );\n  }\n  return merkleTree;\n};\n\nexport const getDopSmartWalletContractForNetwork = (\n  networkName: NetworkName,\n): DopSmartWalletContract => {\n  const network = NETWORK_CONFIG[networkName];\n  const { chain } = network;\n\n  const dopSmartWalletContract =\n    getEngine().dopSmartWalletContracts[chain.type][chain.id];\n  if (!isDefined(dopSmartWalletContract)) {\n    throw new Error(\n      `DopSmartWallet contract not yet loaded for network ${network.publicName}`,\n    );\n  }\n  return dopSmartWalletContract;\n};\n\nexport const getRelayAdaptContractForNetwork = (\n  networkName: NetworkName,\n): RelayAdaptContract => {\n  const network = NETWORK_CONFIG[networkName];\n  const { chain } = network;\n  const relayAdaptContract =\n    getEngine().relayAdaptContracts[chain.type][chain.id];\n  if (!isDefined(relayAdaptContract)) {\n    throw new Error(\n      `Relay Adapt contract not yet loaded for network ${network.publicName}`,\n    );\n  }\n  return relayAdaptContract;\n};\n\nconst createFallbackProviderForNetwork = async (\n  networkName: NetworkName,\n  fallbackProviderJsonConfig: FallbackProviderJsonConfig,\n): Promise<FallbackProvider> => {\n  const existingProvider = fallbackProviderMap[networkName];\n  if (existingProvider) {\n    return existingProvider;\n  }\n  const fallbackProvider = createFallbackProviderFromJsonConfig(\n    fallbackProviderJsonConfig,\n  );\n  setFallbackProviderForNetwork(networkName, fallbackProvider);\n  return fallbackProvider;\n};\n\nconst createPollingProviderForNetwork = async (\n  networkName: NetworkName,\n  fallbackProvider: FallbackProvider,\n  pollingInterval: number,\n): Promise<PollingJsonRpcProvider> => {\n  const existingProvider = pollingProviderMap[networkName];\n  if (existingProvider) {\n    return existingProvider;\n  }\n  const pollingProvider = await createPollingJsonRpcProviderForListeners(\n    fallbackProvider,\n    pollingInterval,\n  );\n  setPollingProviderForNetwork(networkName, pollingProvider);\n  return pollingProvider;\n};\n\nconst loadProviderForNetwork = async (\n  chain: Chain,\n  networkName: NetworkName,\n  fallbackProviderJsonConfig: FallbackProviderJsonConfig,\n  pollingInterval: number,\n) => {\n  sendMessage(`Load provider for network: ${networkName}`);\n\n  const fallbackProvider = await createFallbackProviderForNetwork(\n    networkName,\n    fallbackProviderJsonConfig,\n  );\n  const pollingProvider = await createPollingProviderForNetwork(\n    networkName,\n    fallbackProvider,\n    pollingInterval,\n  );\n\n  const network = NETWORK_CONFIG[networkName];\n  const { proxyContract, relayAdaptContract, deploymentBlock, publicName } =\n    network;\n  // eslint-disable-next-line\n  if (!proxyContract) {\n    throw new Error(`Could not find Proxy contract for network: ${publicName}`);\n  }\n  // eslint-disable-next-line\n  if (!relayAdaptContract) {\n    throw new Error(\n      `Could not find Relay Adapt contract for network: ${publicName}`,\n    );\n  }\n\n  const engine = getEngine();\n\n  // This function will set up the contracts for this chain.\n  // Throws if provider does not respond.\n  await engine.loadNetwork(\n    chain,\n    proxyContract,\n    relayAdaptContract,\n    fallbackProvider,\n    pollingProvider,\n    deploymentBlock ?? 0,\n  );\n\n  // NOTE: This is an async call, but we need not await.\n  // Let Engine scan events in the background.\n  // eslint-disable-next-line @typescript-eslint/no-floating-promises\n  engine.scanHistory(chain);\n};\n\n/**\n * Note: The first provider listed in your fallback provider config is used as a polling provider\n * for new DOP events (balance updates).\n */\nexport const loadProvider = async (\n  fallbackProviderJsonConfig: FallbackProviderJsonConfig,\n  networkName: NetworkName,\n  pollingInterval = 15000,\n): Promise<LoadProviderResponse> => {\n  try {\n    delete fallbackProviderMap[networkName];\n\n    const { chain } = NETWORK_CONFIG[networkName];\n    if (fallbackProviderJsonConfig.chainId !== chain.id) {\n      throw new Error('Invalid chain ID');\n    }\n\n    await loadProviderForNetwork(\n      chain,\n      networkName,\n      fallbackProviderJsonConfig,\n      pollingInterval,\n    );\n\n    const dopSmartWalletContract =\n      getDopSmartWalletContractForNetwork(networkName);\n\n    const { shield, unshield, nft } = await dopSmartWalletContract.fees();\n\n    // Note: Shield and Unshield fees are in basis points.\n    // NFT fee is in wei (though currently 0).\n    const feesSerialized = {\n      shield: shield.toString(),\n      unshield: unshield.toString(),\n      nft: nft.toString(),\n    };\n\n    return { feesSerialized };\n  } catch (err) {\n    throw reportAndSanitizeError(loadProvider.name, err);\n  }\n};\n\nexport const unloadProvider = async (\n  networkName: NetworkName,\n): Promise<void> => {\n  await fallbackProviderMap[networkName]?.destroy();\n  pollingProviderMap[networkName]?.destroy();\n  delete fallbackProviderMap[networkName];\n  delete pollingProviderMap[networkName];\n};\n\nexport const pauseAllPollingProviders = (\n  excludeNetworkName?: NetworkName,\n): void => {\n  Object.keys(pollingProviderMap).forEach(networkName => {\n    if (networkName === excludeNetworkName) {\n      return;\n    }\n    const pollingProvider = pollingProviderMap[networkName];\n    if (isDefined(pollingProvider) && !pollingProvider.paused) {\n      pollingProvider.pause();\n    }\n  });\n};\n\nexport const resumeIsolatedPollingProviderForNetwork = (\n  networkName: NetworkName,\n): void => {\n  pauseAllPollingProviders(\n    networkName, // excludeNetworkName\n  );\n  const pollingProviderForNetwork = pollingProviderMap[networkName];\n  if (\n    isDefined(pollingProviderForNetwork) &&\n    pollingProviderForNetwork.paused\n  ) {\n    pollingProviderForNetwork.resume();\n  }\n};\n"]}

package/dist/services/dop/core/shields.d.ts

@@ -0,0 +1,7 @@
+import { NetworkName } from 'dop-sharedmodel-v5';
+export type ShieldData = {
+    txid: string;
+    hash: string;
+    timestamp: Optional<number>;
+};
+export declare const getAllShields: (networkName: NetworkName, startingBlock: number) => Promise<ShieldData[]>;

package/dist/services/dop/core/shields.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllShields = void 0;
+const dop_sharedmodel_v5_1 = require("dop-sharedmodel-v5");
+const engine_1 = require("./engine");
+const getAllShields = async (networkName, startingBlock) => {
+    const engine = (0, engine_1.getEngine)();
+    const { chain } = dop_sharedmodel_v5_1.NETWORK_CONFIG[networkName];
+    const encryptCommitments = await engine.getAllEncryptCommitments(chain, startingBlock);
+    return encryptCommitments.map(commitment => {
+        const shieldData = {
+            txid: commitment.txid,
+            hash: commitment.hash,
+            timestamp: commitment.timestamp,
+        };
+        return shieldData;
+    });
+};
+exports.getAllShields = getAllShields;
+//# sourceMappingURL=shields.js.map

package/dist/services/dop/core/shields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shields.js","sourceRoot":"","sources":["../../../../src/services/dop/core/shields.ts"],"names":[],"mappings":";;;AAAA,2DAAiE;AACjE,qCAAqC;AAQ9B,MAAM,aAAa,GAAG,KAAK,EAChC,WAAwB,EACxB,aAAqB,EACrB,EAAE;IACF,MAAM,MAAM,GAAG,IAAA,kBAAS,GAAE,CAAC;IAC3B,MAAM,EAAE,KAAK,EAAE,GAAG,mCAAc,CAAC,WAAW,CAAC,CAAC;IAC9C,MAAM,kBAAkB,GAAG,MAAM,MAAM,CAAC,wBAAwB,CAC9D,KAAK,EACL,aAAa,CACd,CAAC;IAEF,OAAO,kBAAkB,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;QACzC,MAAM,UAAU,GAAe;YAC7B,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,SAAS,EAAE,UAAU,CAAC,SAAS;SAChC,CAAC;QACF,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAnBW,QAAA,aAAa,iBAmBxB","sourcesContent":["import { NETWORK_CONFIG, NetworkName } from 'dop-sharedmodel-v5';\nimport { getEngine } from './engine';\n\nexport type ShieldData = {\n  txid: string;\n  hash: string;\n  timestamp: Optional<number>;\n};\n\nexport const getAllShields = async (\n  networkName: NetworkName,\n  startingBlock: number,\n) => {\n  const engine = getEngine();\n  const { chain } = NETWORK_CONFIG[networkName];\n  const encryptCommitments = await engine.getAllEncryptCommitments(\n    chain,\n    startingBlock,\n  );\n\n  return encryptCommitments.map(commitment => {\n    const shieldData: ShieldData = {\n      txid: commitment.txid,\n      hash: commitment.hash,\n      timestamp: commitment.timestamp,\n    };\n    return shieldData;\n  });\n};\n"]}

package/dist/services/dop/history/transaction-history.d.ts

@@ -0,0 +1,4 @@
+import { Chain } from 'dop-engine-v5';
+import { TransactionHistoryItem, TransactionHistoryItemCategory } from 'dop-sharedmodel-v5';
+export declare const categoryForTransactionHistoryItem: (historyItem: TransactionHistoryItem) => TransactionHistoryItemCategory;
+export declare const getWalletTransactionHistory: (chain: Chain, dopWalletID: string, startingBlock: Optional<number>) => Promise<TransactionHistoryItem[]>;

package/dist/services/dop/history/transaction-history.js

@@ -0,0 +1,166 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWalletTransactionHistory = exports.categoryForTransactionHistoryItem = void 0;
+const dop_engine_v5_1 = require("dop-engine-v5");
+const dop_sharedmodel_v5_1 = require("dop-sharedmodel-v5");
+const engine_1 = require("../core/engine");
+const bytes_1 = require("../util/bytes");
+const error_1 = require("../../../utils/error");
+const transactionHistoryReceiveTokenAmountToDopERC20Amount = (transactionHistoryReceiveTokenAmount) => {
+    return {
+        ...transactionHistoryTokenAmountToDopERC20Amount(transactionHistoryReceiveTokenAmount),
+        memoText: transactionHistoryReceiveTokenAmount.memoText,
+        senderAddress: transactionHistoryReceiveTokenAmount.senderAddress,
+        shieldFee: transactionHistoryReceiveTokenAmount.shieldFee,
+    };
+};
+const transactionHistoryReceiveNFTToDopNFTAmount = (transactionHistoryReceiveTokenAmount) => {
+    return {
+        ...transactionHistoryNFTToDopNFTAmount(transactionHistoryReceiveTokenAmount),
+        memoText: transactionHistoryReceiveTokenAmount.memoText,
+        senderAddress: transactionHistoryReceiveTokenAmount.senderAddress,
+        shieldFee: transactionHistoryReceiveTokenAmount.shieldFee,
+    };
+};
+const transactionHistoryTransferTokenAmountToDopERC20Amount = (transactionHistoryTokenAmount) => {
+    const walletSource = transactionHistoryTokenAmount.noteAnnotationData?.walletSource;
+    return {
+        ...transactionHistoryTokenAmountToDopERC20Amount(transactionHistoryTokenAmount),
+        recipientAddress: transactionHistoryTokenAmount.recipientAddress,
+        memoText: transactionHistoryTokenAmount.memoText,
+        walletSource,
+    };
+};
+const transactionHistoryUnshieldTokenAmountToDopERC20Amount = (transactionHistoryUnshieldTokenAmount) => {
+    return {
+        ...transactionHistoryTransferTokenAmountToDopERC20Amount(transactionHistoryUnshieldTokenAmount),
+        unshieldFee: transactionHistoryUnshieldTokenAmount.unshieldFee,
+    };
+};
+const transactionHistoryTransferNFTToDopNFTAmount = (transactionHistoryNFT) => {
+    const walletSource = transactionHistoryNFT.noteAnnotationData?.walletSource;
+    return {
+        ...transactionHistoryNFTToDopNFTAmount(transactionHistoryNFT),
+        memoText: transactionHistoryNFT.memoText,
+        walletSource,
+        recipientAddress: transactionHistoryNFT.recipientAddress,
+    };
+};
+const transactionHistoryUnshieldNFTToDopNFTAmount = (transactionHistoryNFT) => {
+    return {
+        ...transactionHistoryTransferNFTToDopNFTAmount(transactionHistoryNFT),
+        unshieldFee: transactionHistoryNFT.unshieldFee,
+    };
+};
+const transactionHistoryTokenAmountToDopERC20Amount = (transactionHistoryTokenAmount) => {
+    return {
+        tokenAddress: (0, bytes_1.parseDopTokenAddress)(transactionHistoryTokenAmount.tokenData.tokenAddress).toLowerCase(),
+        amount: transactionHistoryTokenAmount.amount,
+    };
+};
+const transactionHistoryNFTToDopNFTAmount = (transactionHistoryNFT) => {
+    return {
+        nftAddress: (0, bytes_1.parseDopTokenAddress)(transactionHistoryNFT.tokenData.tokenAddress).toLowerCase(),
+        nftTokenType: transactionHistoryNFT.tokenData.tokenType,
+        tokenSubID: transactionHistoryNFT.tokenData.tokenSubID,
+        amount: transactionHistoryNFT.amount,
+    };
+};
+const filterERC20 = (tokenAmount) => {
+    return tokenAmount.tokenData.tokenType === dop_engine_v5_1.TokenType.ERC20;
+};
+const filterNFT = (tokenAmount) => {
+    switch (tokenAmount.tokenData.tokenType) {
+        case dop_engine_v5_1.TokenType.ERC20:
+            return false;
+        case dop_engine_v5_1.TokenType.ERC721:
+        case dop_engine_v5_1.TokenType.ERC1155:
+            return tokenAmount.amount > BigInt(0);
+    }
+};
+const receiveERC20AmountsHaveShieldFee = (receiveERC20Amounts) => {
+    return receiveERC20Amounts.find(amount => amount.shieldFee) != null;
+};
+const categoryForTransactionHistoryItem = (historyItem) => {
+    const hasTransferNFTs = historyItem.transferNFTAmounts.length > 0;
+    const hasReceiveNFTs = historyItem.receiveNFTAmounts.length > 0;
+    const hasUnshieldNFTs = historyItem.unshieldNFTAmounts.length > 0;
+    if (hasTransferNFTs || hasReceiveNFTs || hasUnshieldNFTs) {
+        // Some kind of NFT Transfer. Unhandled case.
+        return dop_sharedmodel_v5_1.TransactionHistoryItemCategory.Unknown;
+    }
+    const hasTransferERC20s = historyItem.transferERC20Amounts.length > 0;
+    const hasReceiveERC20s = historyItem.receiveERC20Amounts.length > 0;
+    const hasUnshieldERC20s = historyItem.unshieldERC20Amounts.length > 0;
+    if (hasTransferERC20s && !hasReceiveERC20s && !hasUnshieldERC20s) {
+        // Only transfer erc20s.
+        return dop_sharedmodel_v5_1.TransactionHistoryItemCategory.TransferSendERC20s;
+    }
+    if (!hasTransferERC20s && hasReceiveERC20s && !hasUnshieldERC20s) {
+        // Only receive erc20s.
+        const hasShieldFee = receiveERC20AmountsHaveShieldFee(historyItem.receiveERC20Amounts);
+        if (hasShieldFee) {
+            // Note: Shield fees were added to contract events in Mar 2023.
+            // Prior shields will show as TransferReceiveERC20s without fees.
+            return dop_sharedmodel_v5_1.TransactionHistoryItemCategory.ShieldERC20s;
+        }
+        return dop_sharedmodel_v5_1.TransactionHistoryItemCategory.TransferReceiveERC20s;
+    }
+    if (!hasTransferERC20s && !hasReceiveERC20s && hasUnshieldERC20s) {
+        // Only unshield erc20s.
+        return dop_sharedmodel_v5_1.TransactionHistoryItemCategory.UnshieldERC20s;
+    }
+    return dop_sharedmodel_v5_1.TransactionHistoryItemCategory.Unknown;
+};
+exports.categoryForTransactionHistoryItem = categoryForTransactionHistoryItem;
+const serializeTransactionHistory = (transactionHistory) => {
+    const historyItemsUncategorized = transactionHistory.map(historyEntry => ({
+        txid: (0, dop_engine_v5_1.formatToByteLength)(historyEntry.txid, dop_engine_v5_1.ByteLength.UINT_256, true),
+        blockNumber: historyEntry.blockNumber,
+        timestamp: historyEntry.timestamp,
+        transferERC20Amounts: historyEntry.transferTokenAmounts
+            .filter(filterERC20)
+            .map(transactionHistoryTransferTokenAmountToDopERC20Amount),
+        relayerFeeERC20Amount: historyEntry.relayerFeeTokenAmount
+            ? transactionHistoryTokenAmountToDopERC20Amount(historyEntry.relayerFeeTokenAmount)
+            : undefined,
+        changeERC20Amounts: historyEntry.changeTokenAmounts
+            .filter(filterERC20)
+            .map(transactionHistoryTokenAmountToDopERC20Amount),
+        receiveERC20Amounts: historyEntry.receiveTokenAmounts
+            .filter(filterERC20)
+            .map(transactionHistoryReceiveTokenAmountToDopERC20Amount),
+        unshieldERC20Amounts: historyEntry.unshieldTokenAmounts
+            .filter(filterERC20)
+            .map(transactionHistoryUnshieldTokenAmountToDopERC20Amount),
+        receiveNFTAmounts: historyEntry.receiveTokenAmounts
+            .filter(filterNFT)
+            .map(transactionHistoryReceiveNFTToDopNFTAmount),
+        transferNFTAmounts: historyEntry.transferTokenAmounts
+            .filter(filterNFT)
+            .map(transactionHistoryTransferNFTToDopNFTAmount),
+        unshieldNFTAmounts: historyEntry.unshieldTokenAmounts
+            .filter(filterNFT)
+            .map(transactionHistoryUnshieldNFTToDopNFTAmount),
+        version: historyEntry.version,
+        category: dop_sharedmodel_v5_1.TransactionHistoryItemCategory.Unknown,
+    }));
+    // Add category for items based on token types.
+    return historyItemsUncategorized.map(historyItem => ({
+        ...historyItem,
+        category: (0, exports.categoryForTransactionHistoryItem)(historyItem),
+    }));
+};
+const getWalletTransactionHistory = async (chain, dopWalletID, startingBlock) => {
+    try {
+        const wallet = (0, engine_1.walletForID)(dopWalletID);
+        const transactionHistory = await wallet.getTransactionHistory(chain, startingBlock);
+        return serializeTransactionHistory(transactionHistory);
+    }
+    catch (err) {
+        (0, error_1.reportAndSanitizeError)(exports.getWalletTransactionHistory.name, err);
+        throw new Error('Could not load DOP wallet transaction history.');
+    }
+};
+exports.getWalletTransactionHistory = getWalletTransactionHistory;
+//# sourceMappingURL=transaction-history.js.map

package/dist/services/dop/history/transaction-history.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction-history.js","sourceRoot":"","sources":["../../../../src/services/dop/history/transaction-history.ts"],"names":[],"mappings":";;;AAAA,iDAUuB;AACvB,2DAW4B;AAC5B,2CAA6C;AAC7C,yCAAqD;AACrD,gDAA8D;AAE9D,MAAM,oDAAoD,GAAG,CAC3D,oCAA0E,EACnD,EAAE;IACzB,OAAO;QACL,GAAG,6CAA6C,CAC9C,oCAAoC,CACrC;QACD,QAAQ,EAAE,oCAAoC,CAAC,QAAQ;QACvD,aAAa,EAAE,oCAAoC,CAAC,aAAa;QACjE,SAAS,EAAE,oCAAoC,CAAC,SAAS;KAC1D,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,0CAA0C,GAAG,CACjD,oCAA0E,EACrD,EAAE;IACvB,OAAO;QACL,GAAG,mCAAmC,CACpC,oCAAoC,CACrC;QACD,QAAQ,EAAE,oCAAoC,CAAC,QAAQ;QACvD,aAAa,EAAE,oCAAoC,CAAC,aAAa;QACjE,SAAS,EAAE,oCAAoC,CAAC,SAAS;KAC1D,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,qDAAqD,GAAG,CAC5D,6BAAoE,EAChD,EAAE;IACtB,MAAM,YAAY,GAChB,6BAA6B,CAAC,kBAAkB,EAAE,YAAY,CAAC;IACjE,OAAO;QACL,GAAG,6CAA6C,CAC9C,6BAA6B,CAC9B;QACD,gBAAgB,EAAE,6BAA6B,CAAC,gBAAgB;QAChE,QAAQ,EAAE,6BAA6B,CAAC,QAAQ;QAChD,YAAY;KACb,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,qDAAqD,GAAG,CAC5D,qCAA4E,EACpD,EAAE;IAC1B,OAAO;QACL,GAAG,qDAAqD,CACtD,qCAAqC,CACtC;QACD,WAAW,EAAE,qCAAqC,CAAC,WAAW;KAC/D,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,2CAA2C,GAAG,CAClD,qBAA4D,EAC1C,EAAE;IACpB,MAAM,YAAY,GAAG,qBAAqB,CAAC,kBAAkB,EAAE,YAAY,CAAC;IAC5E,OAAO;QACL,GAAG,mCAAmC,CAAC,qBAAqB,CAAC;QAC7D,QAAQ,EAAE,qBAAqB,CAAC,QAAQ;QACxC,YAAY;QACZ,gBAAgB,EAAE,qBAAqB,CAAC,gBAAgB;KACzD,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,2CAA2C,GAAG,CAClD,qBAA4D,EACtC,EAAE;IACxB,OAAO;QACL,GAAG,2CAA2C,CAAC,qBAAqB,CAAC;QACrE,WAAW,EAAE,qBAAqB,CAAC,WAAW;KAC/C,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,6CAA6C,GAAG,CACpD,6BAA4D,EAC5C,EAAE;IAClB,OAAO;QACL,YAAY,EAAE,IAAA,4BAAoB,EAChC,6BAA6B,CAAC,SAAS,CAAC,YAAY,CACrD,CAAC,WAAW,EAAE;QACf,MAAM,EAAE,6BAA6B,CAAC,MAAM;KAC7C,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,mCAAmC,GAAG,CAC1C,qBAAoD,EACtC,EAAE;IAChB,OAAO;QACL,UAAU,EAAE,IAAA,4BAAoB,EAC9B,qBAAqB,CAAC,SAAS,CAAC,YAAY,CAC7C,CAAC,WAAW,EAAE;QACf,YAAY,EAAE,qBAAqB,CAAC,SAAS,CAAC,SAAkB;QAChE,UAAU,EAAE,qBAAqB,CAAC,SAAS,CAAC,UAAU;QACtD,MAAM,EAAE,qBAAqB,CAAC,MAAM;KACrC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,WAA0C,EAAE,EAAE;IACjE,OAAO,WAAW,CAAC,SAAS,CAAC,SAAS,KAAK,yBAAS,CAAC,KAAK,CAAC;AAC7D,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,WAA0C,EAAE,EAAE;IAC/D,QAAQ,WAAW,CAAC,SAAS,CAAC,SAAS,EAAE;QACvC,KAAK,yBAAS,CAAC,KAAK;YAClB,OAAO,KAAK,CAAC;QACf,KAAK,yBAAS,CAAC,MAAM,CAAC;QACtB,KAAK,yBAAS,CAAC,OAAO;YACpB,OAAO,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;KACzC;AACH,CAAC,CAAC;AAEF,MAAM,gCAAgC,GAAG,CACvC,mBAA4C,EACnC,EAAE;IACX,OAAO,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC;AACtE,CAAC,CAAC;AAEK,MAAM,iCAAiC,GAAG,CAC/C,WAAmC,EACH,EAAE;IAClC,MAAM,eAAe,GAAG,WAAW,CAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC,CAAC;IAClE,MAAM,cAAc,GAAG,WAAW,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC;IAChE,MAAM,eAAe,GAAG,WAAW,CAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC,CAAC;IAClE,IAAI,eAAe,IAAI,cAAc,IAAI,eAAe,EAAE;QACxD,6CAA6C;QAC7C,OAAO,mDAA8B,CAAC,OAAO,CAAC;KAC/C;IAED,MAAM,iBAAiB,GAAG,WAAW,CAAC,oBAAoB,CAAC,MAAM,GAAG,CAAC,CAAC;IACtE,MAAM,gBAAgB,GAAG,WAAW,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,CAAC;IACpE,MAAM,iBAAiB,GAAG,WAAW,CAAC,oBAAoB,CAAC,MAAM,GAAG,CAAC,CAAC;IAEtE,IAAI,iBAAiB,IAAI,CAAC,gBAAgB,IAAI,CAAC,iBAAiB,EAAE;QAChE,wBAAwB;QACxB,OAAO,mDAA8B,CAAC,kBAAkB,CAAC;KAC1D;IAED,IAAI,CAAC,iBAAiB,IAAI,gBAAgB,IAAI,CAAC,iBAAiB,EAAE;QAChE,uBAAuB;QACvB,MAAM,YAAY,GAAG,gCAAgC,CACnD,WAAW,CAAC,mBAAmB,CAChC,CAAC;QACF,IAAI,YAAY,EAAE;YAChB,+DAA+D;YAC/D,iEAAiE;YACjE,OAAO,mDAA8B,CAAC,YAAY,CAAC;SACpD;QACD,OAAO,mDAA8B,CAAC,qBAAqB,CAAC;KAC7D;IAED,IAAI,CAAC,iBAAiB,IAAI,CAAC,gBAAgB,IAAI,iBAAiB,EAAE;QAChE,wBAAwB;QACxB,OAAO,mDAA8B,CAAC,cAAc,CAAC;KACtD;IAED,OAAO,mDAA8B,CAAC,OAAO,CAAC;AAChD,CAAC,CAAC;AAvCW,QAAA,iCAAiC,qCAuC5C;AAEF,MAAM,2BAA2B,GAAG,CAClC,kBAA6C,EACnB,EAAE;IAC5B,MAAM,yBAAyB,GAC7B,kBAAkB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QACtC,IAAI,EAAE,IAAA,kCAAkB,EAAC,YAAY,CAAC,IAAI,EAAE,0BAAU,CAAC,QAAQ,EAAE,IAAI,CAAC;QACtE,WAAW,EAAE,YAAY,CAAC,WAAW;QACrC,SAAS,EAAE,YAAY,CAAC,SAAS;QACjC,oBAAoB,EAAE,YAAY,CAAC,oBAAoB;aACpD,MAAM,CAAC,WAAW,CAAC;aACnB,GAAG,CAAC,qDAAqD,CAAC;QAC7D,qBAAqB,EAAE,YAAY,CAAC,qBAAqB;YACvD,CAAC,CAAC,6CAA6C,CAC3C,YAAY,CAAC,qBAAqB,CACnC;YACH,CAAC,CAAC,SAAS;QACb,kBAAkB,EAAE,YAAY,CAAC,kBAAkB;aAChD,MAAM,CAAC,WAAW,CAAC;aACnB,GAAG,CAAC,6CAA6C,CAAC;QACrD,mBAAmB,EAAE,YAAY,CAAC,mBAAmB;aAClD,MAAM,CAAC,WAAW,CAAC;aACnB,GAAG,CAAC,oDAAoD,CAAC;QAC5D,oBAAoB,EAAE,YAAY,CAAC,oBAAoB;aACpD,MAAM,CAAC,WAAW,CAAC;aACnB,GAAG,CAAC,qDAAqD,CAAC;QAC7D,iBAAiB,EAAE,YAAY,CAAC,mBAAmB;aAChD,MAAM,CAAC,SAAS,CAAC;aACjB,GAAG,CAAC,0CAA0C,CAAC;QAClD,kBAAkB,EAAE,YAAY,CAAC,oBAAoB;aAClD,MAAM,CAAC,SAAS,CAAC;aACjB,GAAG,CAAC,2CAA2C,CAAC;QACnD,kBAAkB,EAAE,YAAY,CAAC,oBAAoB;aAClD,MAAM,CAAC,SAAS,CAAC;aACjB,GAAG,CAAC,2CAA2C,CAAC;QACnD,OAAO,EAAE,YAAY,CAAC,OAAO;QAC7B,QAAQ,EAAE,mDAA8B,CAAC,OAAO;KACjD,CAAC,CAAC,CAAC;IAEN,+CAA+C;IAC/C,OAAO,yBAAyB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACnD,GAAG,WAAW;QACd,QAAQ,EAAE,IAAA,yCAAiC,EAAC,WAAW,CAAC;KACzD,CAAC,CAAC,CAAC;AACN,CAAC,CAAC;AAEK,MAAM,2BAA2B,GAAG,KAAK,EAC9C,KAAY,EACZ,WAAmB,EACnB,aAA+B,EACI,EAAE;IACrC,IAAI;QACF,MAAM,MAAM,GAAG,IAAA,oBAAW,EAAC,WAAW,CAAC,CAAC;QACxC,MAAM,kBAAkB,GAAG,MAAM,MAAM,CAAC,qBAAqB,CAC3D,KAAK,EACL,aAAa,CACd,CAAC;QACF,OAAO,2BAA2B,CAAC,kBAAkB,CAAC,CAAC;KACxD;IAAC,OAAO,GAAG,EAAE;QACZ,IAAA,8BAAsB,EAAC,mCAA2B,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC9D,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;KACnE;AACH,CAAC,CAAC;AAhBW,QAAA,2BAA2B,+BAgBtC","sourcesContent":["import {\n  TransactionHistoryTransferTokenAmount,\n  TransactionHistoryTokenAmount,\n  TransactionHistoryEntry,\n  Chain,\n  TransactionHistoryReceiveTokenAmount,\n  TokenType,\n  formatToByteLength,\n  ByteLength,\n  TransactionHistoryUnshieldTokenAmount,\n} from 'dop-engine-v5';\nimport {\n  TransactionHistoryItem,\n  DopERC20Amount,\n  DopSendERC20Amount,\n  DopReceiveERC20Amount,\n  DopSendNFTAmount,\n  DopNFTAmount,\n  DopReceiveNFTAmount,\n  DopUnshieldERC20Amount,\n  DopUnshieldNFTAmount,\n  TransactionHistoryItemCategory,\n} from 'dop-sharedmodel-v5';\nimport { walletForID } from '../core/engine';\nimport { parseDopTokenAddress } from '../util/bytes';\nimport { reportAndSanitizeError } from '../../../utils/error';\n\nconst transactionHistoryReceiveTokenAmountToDopERC20Amount = (\n  transactionHistoryReceiveTokenAmount: TransactionHistoryReceiveTokenAmount,\n): DopReceiveERC20Amount => {\n  return {\n    ...transactionHistoryTokenAmountToDopERC20Amount(\n      transactionHistoryReceiveTokenAmount,\n    ),\n    memoText: transactionHistoryReceiveTokenAmount.memoText,\n    senderAddress: transactionHistoryReceiveTokenAmount.senderAddress,\n    shieldFee: transactionHistoryReceiveTokenAmount.shieldFee,\n  };\n};\n\nconst transactionHistoryReceiveNFTToDopNFTAmount = (\n  transactionHistoryReceiveTokenAmount: TransactionHistoryReceiveTokenAmount,\n): DopReceiveNFTAmount => {\n  return {\n    ...transactionHistoryNFTToDopNFTAmount(\n      transactionHistoryReceiveTokenAmount,\n    ),\n    memoText: transactionHistoryReceiveTokenAmount.memoText,\n    senderAddress: transactionHistoryReceiveTokenAmount.senderAddress,\n    shieldFee: transactionHistoryReceiveTokenAmount.shieldFee,\n  };\n};\n\nconst transactionHistoryTransferTokenAmountToDopERC20Amount = (\n  transactionHistoryTokenAmount: TransactionHistoryTransferTokenAmount,\n): DopSendERC20Amount => {\n  const walletSource =\n    transactionHistoryTokenAmount.noteAnnotationData?.walletSource;\n  return {\n    ...transactionHistoryTokenAmountToDopERC20Amount(\n      transactionHistoryTokenAmount,\n    ),\n    recipientAddress: transactionHistoryTokenAmount.recipientAddress,\n    memoText: transactionHistoryTokenAmount.memoText,\n    walletSource,\n  };\n};\n\nconst transactionHistoryUnshieldTokenAmountToDopERC20Amount = (\n  transactionHistoryUnshieldTokenAmount: TransactionHistoryUnshieldTokenAmount,\n): DopUnshieldERC20Amount => {\n  return {\n    ...transactionHistoryTransferTokenAmountToDopERC20Amount(\n      transactionHistoryUnshieldTokenAmount,\n    ),\n    unshieldFee: transactionHistoryUnshieldTokenAmount.unshieldFee,\n  };\n};\n\nconst transactionHistoryTransferNFTToDopNFTAmount = (\n  transactionHistoryNFT: TransactionHistoryTransferTokenAmount,\n): DopSendNFTAmount => {\n  const walletSource = transactionHistoryNFT.noteAnnotationData?.walletSource;\n  return {\n    ...transactionHistoryNFTToDopNFTAmount(transactionHistoryNFT),\n    memoText: transactionHistoryNFT.memoText,\n    walletSource,\n    recipientAddress: transactionHistoryNFT.recipientAddress,\n  };\n};\n\nconst transactionHistoryUnshieldNFTToDopNFTAmount = (\n  transactionHistoryNFT: TransactionHistoryUnshieldTokenAmount,\n): DopUnshieldNFTAmount => {\n  return {\n    ...transactionHistoryTransferNFTToDopNFTAmount(transactionHistoryNFT),\n    unshieldFee: transactionHistoryNFT.unshieldFee,\n  };\n};\n\nconst transactionHistoryTokenAmountToDopERC20Amount = (\n  transactionHistoryTokenAmount: TransactionHistoryTokenAmount,\n): DopERC20Amount => {\n  return {\n    tokenAddress: parseDopTokenAddress(\n      transactionHistoryTokenAmount.tokenData.tokenAddress,\n    ).toLowerCase(),\n    amount: transactionHistoryTokenAmount.amount,\n  };\n};\n\nconst transactionHistoryNFTToDopNFTAmount = (\n  transactionHistoryNFT: TransactionHistoryTokenAmount,\n): DopNFTAmount => {\n  return {\n    nftAddress: parseDopTokenAddress(\n      transactionHistoryNFT.tokenData.tokenAddress,\n    ).toLowerCase(),\n    nftTokenType: transactionHistoryNFT.tokenData.tokenType as 1 | 2,\n    tokenSubID: transactionHistoryNFT.tokenData.tokenSubID,\n    amount: transactionHistoryNFT.amount,\n  };\n};\n\nconst filterERC20 = (tokenAmount: TransactionHistoryTokenAmount) => {\n  return tokenAmount.tokenData.tokenType === TokenType.ERC20;\n};\n\nconst filterNFT = (tokenAmount: TransactionHistoryTokenAmount) => {\n  switch (tokenAmount.tokenData.tokenType) {\n    case TokenType.ERC20:\n      return false;\n    case TokenType.ERC721:\n    case TokenType.ERC1155:\n      return tokenAmount.amount > BigInt(0);\n  }\n};\n\nconst receiveERC20AmountsHaveShieldFee = (\n  receiveERC20Amounts: DopReceiveERC20Amount[],\n): boolean => {\n  return receiveERC20Amounts.find(amount => amount.shieldFee) != null;\n};\n\nexport const categoryForTransactionHistoryItem = (\n  historyItem: TransactionHistoryItem,\n): TransactionHistoryItemCategory => {\n  const hasTransferNFTs = historyItem.transferNFTAmounts.length > 0;\n  const hasReceiveNFTs = historyItem.receiveNFTAmounts.length > 0;\n  const hasUnshieldNFTs = historyItem.unshieldNFTAmounts.length > 0;\n  if (hasTransferNFTs || hasReceiveNFTs || hasUnshieldNFTs) {\n    // Some kind of NFT Transfer. Unhandled case.\n    return TransactionHistoryItemCategory.Unknown;\n  }\n\n  const hasTransferERC20s = historyItem.transferERC20Amounts.length > 0;\n  const hasReceiveERC20s = historyItem.receiveERC20Amounts.length > 0;\n  const hasUnshieldERC20s = historyItem.unshieldERC20Amounts.length > 0;\n\n  if (hasTransferERC20s && !hasReceiveERC20s && !hasUnshieldERC20s) {\n    // Only transfer erc20s.\n    return TransactionHistoryItemCategory.TransferSendERC20s;\n  }\n\n  if (!hasTransferERC20s && hasReceiveERC20s && !hasUnshieldERC20s) {\n    // Only receive erc20s.\n    const hasShieldFee = receiveERC20AmountsHaveShieldFee(\n      historyItem.receiveERC20Amounts,\n    );\n    if (hasShieldFee) {\n      // Note: Shield fees were added to contract events in Mar 2023.\n      // Prior shields will show as TransferReceiveERC20s without fees.\n      return TransactionHistoryItemCategory.ShieldERC20s;\n    }\n    return TransactionHistoryItemCategory.TransferReceiveERC20s;\n  }\n\n  if (!hasTransferERC20s && !hasReceiveERC20s && hasUnshieldERC20s) {\n    // Only unshield erc20s.\n    return TransactionHistoryItemCategory.UnshieldERC20s;\n  }\n\n  return TransactionHistoryItemCategory.Unknown;\n};\n\nconst serializeTransactionHistory = (\n  transactionHistory: TransactionHistoryEntry[],\n): TransactionHistoryItem[] => {\n  const historyItemsUncategorized: TransactionHistoryItem[] =\n    transactionHistory.map(historyEntry => ({\n      txid: formatToByteLength(historyEntry.txid, ByteLength.UINT_256, true),\n      blockNumber: historyEntry.blockNumber,\n      timestamp: historyEntry.timestamp,\n      transferERC20Amounts: historyEntry.transferTokenAmounts\n        .filter(filterERC20)\n        .map(transactionHistoryTransferTokenAmountToDopERC20Amount),\n      relayerFeeERC20Amount: historyEntry.relayerFeeTokenAmount\n        ? transactionHistoryTokenAmountToDopERC20Amount(\n            historyEntry.relayerFeeTokenAmount,\n          )\n        : undefined,\n      changeERC20Amounts: historyEntry.changeTokenAmounts\n        .filter(filterERC20)\n        .map(transactionHistoryTokenAmountToDopERC20Amount),\n      receiveERC20Amounts: historyEntry.receiveTokenAmounts\n        .filter(filterERC20)\n        .map(transactionHistoryReceiveTokenAmountToDopERC20Amount),\n      unshieldERC20Amounts: historyEntry.unshieldTokenAmounts\n        .filter(filterERC20)\n        .map(transactionHistoryUnshieldTokenAmountToDopERC20Amount),\n      receiveNFTAmounts: historyEntry.receiveTokenAmounts\n        .filter(filterNFT)\n        .map(transactionHistoryReceiveNFTToDopNFTAmount),\n      transferNFTAmounts: historyEntry.transferTokenAmounts\n        .filter(filterNFT)\n        .map(transactionHistoryTransferNFTToDopNFTAmount),\n      unshieldNFTAmounts: historyEntry.unshieldTokenAmounts\n        .filter(filterNFT)\n        .map(transactionHistoryUnshieldNFTToDopNFTAmount),\n      version: historyEntry.version,\n      category: TransactionHistoryItemCategory.Unknown,\n    }));\n\n  // Add category for items based on token types.\n  return historyItemsUncategorized.map(historyItem => ({\n    ...historyItem,\n    category: categoryForTransactionHistoryItem(historyItem),\n  }));\n};\n\nexport const getWalletTransactionHistory = async (\n  chain: Chain,\n  dopWalletID: string,\n  startingBlock: Optional<number>,\n): Promise<TransactionHistoryItem[]> => {\n  try {\n    const wallet = walletForID(dopWalletID);\n    const transactionHistory = await wallet.getTransactionHistory(\n      chain,\n      startingBlock,\n    );\n    return serializeTransactionHistory(transactionHistory);\n  } catch (err) {\n    reportAndSanitizeError(getWalletTransactionHistory.name, err);\n    throw new Error('Could not load DOP wallet transaction history.');\n  }\n};\n"]}

package/dist/services/dop/index.d.ts

@@ -0,0 +1,4 @@
+export * from './core';
+export * from './util';
+export * from './process';
+export * from './wallets';

package/dist/services/dop/index.js

@@ -0,0 +1,21 @@
+"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("./core"), exports);
+__exportStar(require("./util"), exports);
+__exportStar(require("./process"), exports);
+__exportStar(require("./wallets"), exports);
+//# sourceMappingURL=index.js.map

package/dist/services/dop/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/dop/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAuB;AACvB,yCAAuB;AACvB,4CAA0B;AAC1B,4CAA0B","sourcesContent":["export * from './core';\nexport * from './util';\nexport * from './process';\nexport * from './wallets';\n"]}

package/dist/services/dop/process/extract-first-note.d.ts

@@ -0,0 +1,6 @@
+import { AddressData, CommitmentCiphertext } from 'dop-engine-v5';
+import { Network, DopERC20Amount } from 'dop-sharedmodel-v5';
+import { ContractTransaction } from 'ethers';
+export declare const extractFirstNoteERC20AmountMapFromTransactionRequest: (dopWalletID: string, network: Network, transactionRequest: ContractTransaction, useRelayAdapt: boolean) => Promise<MapType<bigint>>;
+export declare const extractERC20AmountFromCommitmentCiphertext: (network: Network, commitmentCiphertext: CommitmentCiphertext, commitmentHash: string, receivingViewingPrivateKey: Uint8Array, receivingDopAddressData: AddressData) => Promise<Optional<DopERC20Amount>>;
+export { CommitmentCiphertext };