@zill-protocol/client 4.1.2

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## 4.1.2
+
+### Patch Changes
+
+- Initial publish under the @zill-protocol scope.
+- Updated dependencies
+  - @zill-protocol/config@1.7.4
+  - @zill-protocol/core@3.3.1
+  - @zill-protocol/crypto@0.4.3
+
+All notable changes to this package are documented in this file.
+
+## Unreleased
+
+- Initial changelog reset.

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./src/index";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,18 @@
+"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("./src/index"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B"}

package/dist/package.json

@@ -0,0 +1,58 @@
+{
+    "name": "@zill-protocol/client",
+    "version": "4.1.2",
+    "license": "MIT",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist/**/*",
+        "src/**/*"
+    ],
+    "scripts": {
+        "build": "yarn clean; tsc --build",
+        "check": "tsc --noEmit",
+        "clean": "rm -rf .turbo dist",
+        "gen-test-cases:operationhash": "npx ts-node ./scripts/genOperationHashTestCase.ts",
+        "gen-test-cases:registryentry": "npx ts-node ./scripts/genCanonAddrRegistryEntryHashTestCase.ts",
+        "gen-test-cases:poseidonext": "npx ts-node ./scripts/genPoseidonExtTestCase.ts",
+        "lint": "eslint --fix src --ext .ts",
+        "prettier:check": "prettier --check ./src ./test",
+        "prettier:write": "prettier --write ./src ./test",
+        "publish": "yarn build; yarn npm publish --access public",
+        "test:unit": "mocha --require ts-node/register test/** --timeout 45000 --exit"
+    },
+    "dependencies": {
+        "@zill-protocol/config": "workspace:^",
+        "@zill-protocol/contracts": "^3.0.0",
+        "@zill-protocol/core": "workspace:^",
+        "@zill-protocol/crypto": "workspace:^",
+        "async-mutex": "^0.4.0",
+        "big-integer": "^1.6.42",
+        "bigint-json-serialization": "^1.0.1",
+        "ethers": "^5.7.2",
+        "js-sha256": "^0.9.0"
+    },
+    "devDependencies": {
+        "@types/chai": "^4.3.3",
+        "@types/chai-as-promised": "^7.1.5",
+        "@types/mocha": "^10.0.0",
+        "@types/node": "^25.0.1",
+        "@types/sinon": "^10.0.13",
+        "@types/sinon-chai": "^3.2.9",
+        "@typescript-eslint/eslint-plugin": "^8.49.0",
+        "@typescript-eslint/parser": "^8.49.0",
+        "chai": "^4.3.6",
+        "chai-as-promised": "^7.1.1",
+        "eslint": "^9.39.2",
+        "eslint-config-prettier": "^10.1.8",
+        "mocha": "^10.1.0",
+        "prettier": "^3.7.4",
+        "sinon": "^15.0.1",
+        "sinon-chai": "^3.7.0",
+        "ts-node": "^10.9.2",
+        "typescript": "^5.9.3"
+    },
+    "engines": {
+        "node": ">=18"
+    }
+}

package/dist/src/NocturneClient.d.ts

@@ -0,0 +1,68 @@
+import { NocturneConfig } from "@zill-protocol/config";
+import { Handler } from "@zill-protocol/contracts";
+import { NocturneViewer } from "@zill-protocol/crypto";
+import ethers from "ethers";
+import { GetNotesOpts, NocturneDB } from "./NocturneDB";
+import { OpTracker } from "./OpTracker";
+import { EthToTokenConverter } from "./conversion";
+import { OperationRequest } from "./operationRequest/operationRequest";
+import { SyncOpts } from "./syncSDK";
+import { OpHistoryRecord, OperationMetadata, PendingOutputRecord } from "./types";
+import { Asset, AssetWithBalance, IncludedNote, OperationStatus, PreSignOperation, SDKSyncAdapter, SignedOperation, SparseMerkleProver, TotalEntityIndex } from "@zill-protocol/core";
+export declare class NocturneClient {
+    protected provider: ethers.providers.Provider;
+    protected config: NocturneConfig;
+    protected handlerContract: Handler;
+    protected merkleProver: SparseMerkleProver;
+    protected db: NocturneDB;
+    protected syncAdapter: SDKSyncAdapter;
+    protected tokenConverter: EthToTokenConverter;
+    protected opTracker: OpTracker;
+    protected pendingOutputsListeners: Set<(outputs: PendingOutputRecord[]) => void>;
+    readonly viewer: NocturneViewer;
+    readonly gasAssets: Map<string, Asset>;
+    constructor(viewer: NocturneViewer, provider: ethers.providers.Provider, configOrNetworkName: NocturneConfig | string, merkleProver: SparseMerkleProver, db: NocturneDB, syncAdapter: SDKSyncAdapter, tokenConverter: EthToTokenConverter, nulliferChecker: OpTracker);
+    clearDb(): Promise<void>;
+    sync(opts?: SyncOpts): Promise<number | undefined>;
+    prepareOperation(opRequest: OperationRequest, gasMultiplier: number): Promise<PreSignOperation>;
+    getAllAssetBalances(opts?: GetNotesOpts): Promise<AssetWithBalance[]>;
+    getBalanceForAsset(asset: Asset, opts?: GetNotesOpts): Promise<bigint>;
+    getNotesForAsset(asset: Asset, opts?: GetNotesOpts): Promise<IncludedNote[]>;
+    getPrivateBalanceBreakdown(asset: Asset): Promise<{
+        confirmed: bigint;
+        pendingUncommitted: bigint;
+        pendingLocal: bigint;
+        pending: bigint;
+        total: bigint;
+    }>;
+    getPendingBalanceForAsset(asset: Asset): Promise<bigint>;
+    getPendingOutputs(opts?: {
+        asset?: Asset;
+    }): Promise<PendingOutputRecord[]>;
+    listPendingNotes(opts?: {
+        asset?: Asset;
+    }): Promise<PendingOutputRecord[]>;
+    addPendingOutputs(outputs: PendingOutputRecord[]): Promise<void>;
+    addPendingOutputsFromOperation(op: PreSignOperation | SignedOperation): Promise<void>;
+    removePendingOutputsByOpDigest(opDigest: bigint): Promise<void>;
+    onPendingNoteConfirmed(listener: (outputs: PendingOutputRecord[]) => void): () => void;
+    getLatestSyncedMerkleIndex(): Promise<number | undefined>;
+    getLatestCommittedMerkleIndex(): Promise<number | undefined>;
+    /**
+     * Force-nullify notes locally by nullifier. This is useful as a mitigation
+     * when the sync source cannot supply nullifiers (e.g. Mirror down) but the
+     * bundler reports the nullifier already exists on-chain.
+     */
+    forceNullifyNotes(nullifiers: bigint[]): Promise<number[]>;
+    getCurrentTreeRoot(): bigint;
+    hasEnoughBalanceForOperationRequest(opRequest: OperationRequest): Promise<boolean>;
+    getCreationBlockOfNewestNoteInOp(op: PreSignOperation | SignedOperation): Promise<number>;
+    addOpToHistory(op: PreSignOperation | SignedOperation, metadata: OperationMetadata): Promise<void>;
+    removeOpFromHistory(digest: bigint): Promise<void>;
+    getOpHistory(includePending?: boolean): Promise<OpHistoryRecord[]>;
+    getOpHistoryRecord(digest: bigint): Promise<OpHistoryRecord | undefined>;
+    setOpStatusInHistory(digest: bigint, status: OperationStatus): Promise<void>;
+    pruneOptimisticNullifiers(): Promise<void>;
+}
+export declare function getTotalEntityIndexOfNewestNoteInOp(db: NocturneDB, op: PreSignOperation | SignedOperation): Promise<TotalEntityIndex>;
+//# sourceMappingURL=NocturneClient.d.ts.map

package/dist/src/NocturneClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NocturneClient.d.ts","sourceRoot":"","sources":["../../src/NocturneClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAsB,MAAM,uBAAuB,CAAC;AAC3E,OAAO,EAAE,OAAO,EAAoB,MAAM,0BAA0B,CAAC;AACrE,OAAO,EAAE,cAAc,EAAuB,MAAM,uBAAuB,CAAC;AAC5E,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAEnD,OAAO,EACL,gBAAgB,EAEjB,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,QAAQ,EAAW,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAMlF,OAAO,EACL,KAAK,EAEL,gBAAgB,EAChB,YAAY,EAIZ,eAAe,EAEf,gBAAgB,EAChB,cAAc,EACd,eAAe,EACf,kBAAkB,EAClB,gBAAgB,EAIjB,MAAM,qBAAqB,CAAC;AAI7B,qBAAa,cAAc;IACzB,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC;IAC9C,SAAS,CAAC,MAAM,EAAE,cAAc,CAAC;IACjC,SAAS,CAAC,eAAe,EAAE,OAAO,CAAC;IACnC,SAAS,CAAC,YAAY,EAAE,kBAAkB,CAAC;IAC3C,SAAS,CAAC,EAAE,EAAE,UAAU,CAAC;IACzB,SAAS,CAAC,WAAW,EAAE,cAAc,CAAC;IACtC,SAAS,CAAC,cAAc,EAAE,mBAAmB,CAAC;IAC9C,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC;IAC/B,SAAS,CAAC,uBAAuB,EAAE,GAAG,CACpC,CAAC,OAAO,EAAE,mBAAmB,EAAE,KAAK,IAAI,CACzC,CAAa;IAEd,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAChC,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;gBAGrC,MAAM,EAAE,cAAc,EACtB,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACnC,mBAAmB,EAAE,cAAc,GAAG,MAAM,EAC5C,YAAY,EAAE,kBAAkB,EAChC,EAAE,EAAE,UAAU,EACd,WAAW,EAAE,cAAc,EAC3B,cAAc,EAAE,mBAAmB,EACnC,eAAe,EAAE,SAAS;IAsCtB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAKxB,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IA0ClD,gBAAgB,CACpB,SAAS,EAAE,gBAAgB,EAC3B,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,gBAAgB,CAAC;IAoBtB,mBAAmB,CAAC,IAAI,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAarE,kBAAkB,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAItE,gBAAgB,CACpB,KAAK,EAAE,KAAK,EACZ,IAAI,CAAC,EAAE,YAAY,GAClB,OAAO,CAAC,YAAY,EAAE,CAAC;IAIpB,0BAA0B,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC;QACtD,SAAS,EAAE,MAAM,CAAC;QAClB,kBAAkB,EAAE,MAAM,CAAC;QAC3B,YAAY,EAAE,MAAM,CAAC;QACrB,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IAkBI,yBAAyB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC;IAIxD,iBAAiB,CACrB,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,KAAK,CAAA;KAAE,GACvB,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAI3B,gBAAgB,CACpB,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,KAAK,CAAA;KAAE,GACvB,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAI3B,iBAAiB,CAAC,OAAO,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhE,8BAA8B,CAClC,EAAE,EAAE,gBAAgB,GAAG,eAAe,GACrC,OAAO,CAAC,IAAI,CAAC;IAiDV,8BAA8B,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrE,sBAAsB,CACpB,QAAQ,EAAE,CAAC,OAAO,EAAE,mBAAmB,EAAE,KAAK,IAAI,GACjD,MAAM,IAAI;IAOP,0BAA0B,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAIzD,6BAA6B,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAIlE;;;;OAIG;IACG,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAIhE,kBAAkB,IAAI,MAAM;IAItB,mCAAmC,CACvC,SAAS,EAAE,gBAAgB,GAC1B,OAAO,CAAC,OAAO,CAAC;IAmBb,gCAAgC,CACpC,EAAE,EAAE,gBAAgB,GAAG,eAAe,GACrC,OAAO,CAAC,MAAM,CAAC;IAUZ,cAAc,CAClB,EAAE,EAAE,gBAAgB,GAAG,eAAe,EACtC,QAAQ,EAAE,iBAAiB,GAC1B,OAAO,CAAC,IAAI,CAAC;IAIV,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlD,YAAY,CAAC,cAAc,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAIlE,kBAAkB,CACtB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAIjC,oBAAoB,CACxB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,IAAI,CAAC;IAIV,yBAAyB,IAAI,OAAO,CAAC,IAAI,CAAC;CAGjD;AAED,wBAAsB,mCAAmC,CACvD,EAAE,EAAE,UAAU,EACd,EAAE,EAAE,gBAAgB,GAAG,eAAe,GACrC,OAAO,CAAC,gBAAgB,CAAC,CAkB3B"}

package/dist/src/NocturneClient.js

@@ -0,0 +1,264 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NocturneClient = void 0;
+exports.getTotalEntityIndexOfNewestNoteInOp = getTotalEntityIndexOfNewestNoteInOp;
+const config_1 = require("@zill-protocol/config");
+const contracts_1 = require("@zill-protocol/contracts");
+const crypto_1 = require("@zill-protocol/crypto");
+const NocturneDB_1 = require("./NocturneDB");
+const opRequestGas_1 = require("./opRequestGas");
+const operationRequest_1 = require("./operationRequest/operationRequest");
+const prepareOperation_1 = require("./prepareOperation");
+const syncSDK_1 = require("./syncSDK");
+const utils_1 = require("./utils");
+const core_1 = require("@zill-protocol/core");
+const PRUNE_OPTIMISTIC_NFS_TIMER = 60 * 1000; // 1 minute
+class NocturneClient {
+    constructor(viewer, provider, configOrNetworkName, merkleProver, db, syncAdapter, tokenConverter, nulliferChecker) {
+        this.pendingOutputsListeners = new Set();
+        if (typeof configOrNetworkName == "string") {
+            this.config = (0, config_1.loadNocturneConfig)(configOrNetworkName);
+        }
+        else {
+            this.config = configOrNetworkName;
+        }
+        this.provider = provider;
+        this.gasAssets = new Map(Array.from(this.config.erc20s.entries())
+            .filter(([_, config]) => config.isGasAsset)
+            .map(([ticker, config]) => {
+            return [ticker, core_1.AssetTrait.erc20AddressToAsset(config.address)];
+        }));
+        this.viewer = viewer;
+        console.log(`Canonical address: `, this.viewer.canonicalAddress());
+        this.handlerContract = contracts_1.Handler__factory.connect(this.config.handlerAddress, provider);
+        this.merkleProver = merkleProver;
+        this.db = db;
+        this.syncAdapter = syncAdapter;
+        this.tokenConverter = tokenConverter;
+        this.opTracker = nulliferChecker;
+        // set an interval to prune optimistic nfs to ensure they don't get stuck
+        const prune = async () => {
+            await this.pruneOptimisticNullifiers();
+            setTimeout(prune, PRUNE_OPTIMISTIC_NFS_TIMER);
+        };
+        void prune();
+    }
+    async clearDb() {
+        await this.db.kv.clear();
+    }
+    // Sync SDK, returning last synced merkle index of last state diff
+    async sync(opts) {
+        const hasListeners = this.pendingOutputsListeners.size > 0;
+        const shouldNotify = hasListeners || opts?.onPendingOutputsConfirmed;
+        const onPendingOutputsConfirmed = shouldNotify
+            ? (outputs) => {
+                if (!outputs.length) {
+                    return;
+                }
+                if (hasListeners) {
+                    for (const listener of this.pendingOutputsListeners) {
+                        try {
+                            listener(outputs);
+                        }
+                        catch (err) {
+                            console.warn("[sync] pending output listener failed", err);
+                        }
+                    }
+                }
+                opts?.onPendingOutputsConfirmed?.(outputs);
+            }
+            : undefined;
+        const baseOpts = opts
+            ? {
+                ...opts,
+                finalityBlocks: opts.finalityBlocks ?? this.config.finalityBlocks,
+            }
+            : undefined;
+        const mergedOpts = onPendingOutputsConfirmed
+            ? { ...(baseOpts ?? {}), onPendingOutputsConfirmed }
+            : baseOpts;
+        const latestSyncedMerkleIndex = await (0, syncSDK_1.syncSDK)({ viewer: this.viewer }, this.syncAdapter, this.db, this.merkleProver, mergedOpts);
+        return latestSyncedMerkleIndex;
+    }
+    async prepareOperation(opRequest, gasMultiplier) {
+        opRequest = await (0, operationRequest_1.ensureOpRequestChainInfo)(opRequest, this.provider);
+        const deps = {
+            db: this.db,
+            gasAssets: this.gasAssets,
+            tokenConverter: this.tokenConverter,
+            handlerContract: this.handlerContract,
+            merkle: this.merkleProver,
+            viewer: this.viewer,
+        };
+        const gasAccountedOpRequest = await (0, opRequestGas_1.handleGasForOperationRequest)(deps, opRequest, gasMultiplier);
+        return await (0, prepareOperation_1.prepareOperation)(deps, gasAccountedOpRequest);
+    }
+    async getAllAssetBalances(opts) {
+        const notes = await this.db.getAllNotes(opts);
+        return Array.from(notes.entries()).map(([assetString, notes]) => {
+            const asset = NocturneDB_1.NocturneDB.parseAssetKey(assetString);
+            const balance = notes.reduce((a, b) => a + b.value, 0n);
+            return {
+                asset,
+                balance,
+                numNotes: notes.length,
+            };
+        });
+    }
+    async getBalanceForAsset(asset, opts) {
+        return await this.db.getBalanceForAsset(asset, opts);
+    }
+    async getNotesForAsset(asset, opts) {
+        return await this.db.getNotesForAsset(asset, opts);
+    }
+    async getPrivateBalanceBreakdown(asset) {
+        const [confirmed, totalUncommitted, pendingLocal] = await Promise.all([
+            this.db.getBalanceForAsset(asset),
+            this.db.getBalanceForAsset(asset, { includeUncommitted: true }),
+            this.db.getPendingBalanceForAsset(asset),
+        ]);
+        const pendingUncommitted = totalUncommitted > confirmed ? totalUncommitted - confirmed : 0n;
+        const pending = pendingUncommitted + pendingLocal;
+        return {
+            confirmed,
+            pendingUncommitted,
+            pendingLocal,
+            pending,
+            total: confirmed + pending,
+        };
+    }
+    async getPendingBalanceForAsset(asset) {
+        return await this.db.getPendingBalanceForAsset(asset);
+    }
+    async getPendingOutputs(opts) {
+        return await this.db.getPendingOutputs(opts);
+    }
+    async listPendingNotes(opts) {
+        return await this.db.getPendingOutputs(opts);
+    }
+    async addPendingOutputs(outputs) {
+        await this.db.addPendingOutputs(outputs);
+    }
+    async addPendingOutputsFromOperation(op) {
+        const senderOwner = crypto_1.StealthAddressTrait.fromCanonAddress(this.viewer.canonicalAddress());
+        const senderKey = crypto_1.StealthAddressTrait.toString(senderOwner);
+        const digest = core_1.OperationTrait.computeDigest(op);
+        const outputs = [];
+        for (const joinSplit of op.joinSplits) {
+            let notes = [];
+            if ("newNoteA" in joinSplit) {
+                notes = [joinSplit.newNoteA, joinSplit.newNoteB];
+            }
+            else {
+                const decryptedNotes = [
+                    joinSplit.newNoteAEncrypted,
+                    joinSplit.newNoteBEncrypted,
+                ]
+                    .map((encryptedNote) => {
+                    try {
+                        const { sender, ...note } = (0, core_1.decryptNote)(this.viewer, encryptedNote);
+                        return note;
+                    }
+                    catch (err) {
+                        return null;
+                    }
+                })
+                    .filter((note) => note !== null);
+                notes = decryptedNotes;
+            }
+            for (const note of notes) {
+                if (note.value <= 0n) {
+                    continue;
+                }
+                const ownerKey = crypto_1.StealthAddressTrait.toString(note.owner);
+                if (ownerKey !== senderKey) {
+                    continue;
+                }
+                outputs.push({
+                    commitment: core_1.NoteTrait.toCommitment(note),
+                    asset: note.asset,
+                    value: note.value,
+                    createdAt: Date.now(),
+                    opDigest: digest,
+                });
+            }
+        }
+        await this.db.addPendingOutputs(outputs);
+    }
+    async removePendingOutputsByOpDigest(opDigest) {
+        await this.db.removePendingOutputsByOpDigest(opDigest);
+    }
+    onPendingNoteConfirmed(listener) {
+        this.pendingOutputsListeners.add(listener);
+        return () => {
+            this.pendingOutputsListeners.delete(listener);
+        };
+    }
+    async getLatestSyncedMerkleIndex() {
+        return await this.db.latestSyncedMerkleIndex();
+    }
+    async getLatestCommittedMerkleIndex() {
+        return await this.db.latestCommittedMerkleIndex();
+    }
+    /**
+     * Force-nullify notes locally by nullifier. This is useful as a mitigation
+     * when the sync source cannot supply nullifiers (e.g. Mirror down) but the
+     * bundler reports the nullifier already exists on-chain.
+     */
+    async forceNullifyNotes(nullifiers) {
+        return await this.db.nullifyNotes(nullifiers);
+    }
+    getCurrentTreeRoot() {
+        return this.merkleProver.getRoot();
+    }
+    async hasEnoughBalanceForOperationRequest(opRequest) {
+        const assetRequestedAmounts = new core_1.MapWithObjectKeys();
+        for (const joinSplitRequest of opRequest.joinSplitRequests) {
+            const asset = joinSplitRequest.asset;
+            let currentAmount = assetRequestedAmounts.get(asset) || 0n;
+            currentAmount += (0, utils_1.getJoinSplitRequestTotalValue)(joinSplitRequest);
+            assetRequestedAmounts.set(asset, currentAmount);
+        }
+        for (const [asset, requestedAmount] of assetRequestedAmounts.entries()) {
+            const balance = await this.db.getBalanceForAsset(asset);
+            if (balance < requestedAmount) {
+                return false;
+            }
+        }
+        return true;
+    }
+    async getCreationBlockOfNewestNoteInOp(op) {
+        const totalEntityIndex = await getTotalEntityIndexOfNewestNoteInOp(this.db, op);
+        return Number(core_1.TotalEntityIndexTrait.toComponents(totalEntityIndex).blockNumber);
+    }
+    async addOpToHistory(op, metadata) {
+        await this.db.addOpToHistory(op, metadata);
+    }
+    async removeOpFromHistory(digest) {
+        await this.db.removeOpFromHistory(digest);
+    }
+    async getOpHistory(includePending) {
+        return await this.db.getHistory(includePending);
+    }
+    async getOpHistoryRecord(digest) {
+        return await this.db.getHistoryRecord(digest);
+    }
+    async setOpStatusInHistory(digest, status) {
+        await this.db.setStatusForOp(digest, status);
+    }
+    async pruneOptimisticNullifiers() {
+        await this.db.pruneOptimisticNFs();
+    }
+}
+exports.NocturneClient = NocturneClient;
+async function getTotalEntityIndexOfNewestNoteInOp(db, op) {
+    // get the max merkle index of any note in any joinsplit in the op
+    const maxMerkleIndex = (0, core_1.maxArray)((0, utils_1.getMerkleIndicesAndNfsFromOp)(op).map(({ merkleIndex }) => merkleIndex));
+    // get the corresponding TotalEntityIndex
+    const totalEntityIndex = await db.getTotalEntityIndexForMerkleIndex(Number(maxMerkleIndex));
+    if (totalEntityIndex === undefined) {
+        throw new Error(`totalEntityIndex not found for newest note with merkle index ${maxMerkleIndex}`);
+    }
+    return totalEntityIndex;
+}
+//# sourceMappingURL=NocturneClient.js.map

package/dist/src/NocturneClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NocturneClient.js","sourceRoot":"","sources":["../../src/NocturneClient.ts"],"names":[],"mappings":";;;AAyYA,kFAqBC;AA9ZD,kDAA2E;AAC3E,wDAAqE;AACrE,kDAA4E;AAE5E,6CAAwD;AAGxD,iDAA8D;AAC9D,0EAG6C;AAC7C,yDAAsD;AACtD,uCAA8C;AAE9C,mCAGiB;AAEjB,8CAkB6B;AAE7B,MAAM,0BAA0B,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,WAAW;AAEzD,MAAa,cAAc;IAgBzB,YACE,MAAsB,EACtB,QAAmC,EACnC,mBAA4C,EAC5C,YAAgC,EAChC,EAAc,EACd,WAA2B,EAC3B,cAAmC,EACnC,eAA0B;QAflB,4BAAuB,GAE7B,IAAI,GAAG,EAAE,CAAC;QAeZ,IAAI,OAAO,mBAAmB,IAAI,QAAQ,EAAE,CAAC;YAC3C,IAAI,CAAC,MAAM,GAAG,IAAA,2BAAkB,EAAC,mBAAmB,CAAC,CAAC;QACxD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,GAAG,mBAAmB,CAAC;QACpC,CAAC;QAED,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,CACtB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;aACrC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC;aAC1C,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE;YACxB,OAAO,CAAC,MAAM,EAAE,iBAAU,CAAC,mBAAmB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QAClE,CAAC,CAAC,CACL,CAAC;QAEF,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACnE,IAAI,CAAC,eAAe,GAAG,4BAAgB,CAAC,OAAO,CAC7C,IAAI,CAAC,MAAM,CAAC,cAAc,EAC1B,QAAQ,CACT,CAAC;QACF,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,eAAe,CAAC;QAEjC,yEAAyE;QACzE,MAAM,KAAK,GAAG,KAAK,IAAI,EAAE;YACvB,MAAM,IAAI,CAAC,yBAAyB,EAAE,CAAC;YACvC,UAAU,CAAC,KAAK,EAAE,0BAA0B,CAAC,CAAC;QAChD,CAAC,CAAC;QACF,KAAK,KAAK,EAAE,CAAC;IACf,CAAC;IAED,KAAK,CAAC,OAAO;QACX,MAAM,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC;IAC3B,CAAC;IAED,kEAAkE;IAClE,KAAK,CAAC,IAAI,CAAC,IAAe;QACxB,MAAM,YAAY,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,GAAG,CAAC,CAAC;QAC3D,MAAM,YAAY,GAAG,YAAY,IAAI,IAAI,EAAE,yBAAyB,CAAC;QACrE,MAAM,yBAAyB,GAAG,YAAY;YAC5C,CAAC,CAAC,CAAC,OAA8B,EAAE,EAAE;gBACjC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;oBACpB,OAAO;gBACT,CAAC;gBACD,IAAI,YAAY,EAAE,CAAC;oBACjB,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;wBACpD,IAAI,CAAC;4BACH,QAAQ,CAAC,OAAO,CAAC,CAAC;wBACpB,CAAC;wBAAC,OAAO,GAAG,EAAE,CAAC;4BACb,OAAO,CAAC,IAAI,CAAC,uCAAuC,EAAE,GAAG,CAAC,CAAC;wBAC7D,CAAC;oBACH,CAAC;gBACH,CAAC;gBACD,IAAI,EAAE,yBAAyB,EAAE,CAAC,OAAO,CAAC,CAAC;YAC7C,CAAC;YACH,CAAC,CAAC,SAAS,CAAC;QAEd,MAAM,QAAQ,GAAG,IAAI;YACnB,CAAC,CAAC;gBACE,GAAG,IAAI;gBACP,cAAc,EAAE,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc;aAClE;YACH,CAAC,CAAC,SAAS,CAAC;QACd,MAAM,UAAU,GAAG,yBAAyB;YAC1C,CAAC,CAAC,EAAE,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,EAAE,yBAAyB,EAAE;YACpD,CAAC,CAAC,QAAQ,CAAC;QAEb,MAAM,uBAAuB,GAAG,MAAM,IAAA,iBAAO,EAC3C,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,EACvB,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,EAAE,EACP,IAAI,CAAC,YAAY,EACjB,UAAU,CACX,CAAC;QAEF,OAAO,uBAAuB,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,gBAAgB,CACpB,SAA2B,EAC3B,aAAqB;QAErB,SAAS,GAAG,MAAM,IAAA,2CAAwB,EAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAErE,MAAM,IAAI,GAAG;YACX,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,MAAM,EAAE,IAAI,CAAC,YAAY;YACzB,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC;QACF,MAAM,qBAAqB,GAAG,MAAM,IAAA,2CAA4B,EAC9D,IAAI,EACJ,SAAS,EACT,aAAa,CACd,CAAC;QAEF,OAAO,MAAM,IAAA,mCAAgB,EAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;IAC7D,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,IAAmB;QAC3C,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC9C,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,CAAC,EAAE,EAAE;YAC9D,MAAM,KAAK,GAAG,uBAAU,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YACpD,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YACxD,OAAO;gBACL,KAAK;gBACL,OAAO;gBACP,QAAQ,EAAE,KAAK,CAAC,MAAM;aACvB,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,KAAY,EAAE,IAAmB;QACxD,OAAO,MAAM,IAAI,CAAC,EAAE,CAAC,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACvD,CAAC;IAED,KAAK,CAAC,gBAAgB,CACpB,KAAY,EACZ,IAAmB;QAEnB,OAAO,MAAM,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,0BAA0B,CAAC,KAAY;QAO3C,MAAM,CAAC,SAAS,EAAE,gBAAgB,EAAE,YAAY,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACpE,IAAI,CAAC,EAAE,CAAC,kBAAkB,CAAC,KAAK,CAAC;YACjC,IAAI,CAAC,EAAE,CAAC,kBAAkB,CAAC,KAAK,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,CAAC;YAC/D,IAAI,CAAC,EAAE,CAAC,yBAAyB,CAAC,KAAK,CAAC;SACzC,CAAC,CAAC;QACH,MAAM,kBAAkB,GACtB,gBAAgB,GAAG,SAAS,CAAC,CAAC,CAAC,gBAAgB,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;QACnE,MAAM,OAAO,GAAG,kBAAkB,GAAG,YAAY,CAAC;QAClD,OAAO;YACL,SAAS;YACT,kBAAkB;YAClB,YAAY;YACZ,OAAO;YACP,KAAK,EAAE,SAAS,GAAG,OAAO;SAC3B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,yBAAyB,CAAC,KAAY;QAC1C,OAAO,MAAM,IAAI,CAAC,EAAE,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,IAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,gBAAgB,CACpB,IAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,OAA8B;QACpD,MAAM,IAAI,CAAC,EAAE,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,8BAA8B,CAClC,EAAsC;QAEtC,MAAM,WAAW,GAAG,4BAAmB,CAAC,gBAAgB,CACtD,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAC/B,CAAC;QACF,MAAM,SAAS,GAAG,4BAAmB,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC5D,MAAM,MAAM,GAAG,qBAAc,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QAChD,MAAM,OAAO,GAA0B,EAAE,CAAC;QAE1C,KAAK,MAAM,SAAS,IAAI,EAAE,CAAC,UAAU,EAAE,CAAC;YACtC,IAAI,KAAK,GAAW,EAAE,CAAC;YACvB,IAAI,UAAU,IAAI,SAAS,EAAE,CAAC;gBAC5B,KAAK,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;YACnD,CAAC;iBAAM,CAAC;gBACN,MAAM,cAAc,GAAG;oBACrB,SAAS,CAAC,iBAAiB;oBAC3B,SAAS,CAAC,iBAAiB;iBAC5B;qBACE,GAAG,CAAC,CAAC,aAAa,EAAe,EAAE;oBAClC,IAAI,CAAC;wBACH,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAA,kBAAW,EAAC,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;wBACpE,OAAO,IAAI,CAAC;oBACd,CAAC;oBAAC,OAAO,GAAG,EAAE,CAAC;wBACb,OAAO,IAAI,CAAC;oBACd,CAAC;gBACH,CAAC,CAAC;qBACD,MAAM,CAAC,CAAC,IAAI,EAAgB,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;gBACjD,KAAK,GAAG,cAAc,CAAC;YACzB,CAAC;YACD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,IAAI,IAAI,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC;oBACrB,SAAS;gBACX,CAAC;gBACD,MAAM,QAAQ,GAAG,4BAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC1D,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;oBAC3B,SAAS;gBACX,CAAC;gBACD,OAAO,CAAC,IAAI,CAAC;oBACX,UAAU,EAAE,gBAAS,CAAC,YAAY,CAAC,IAAI,CAAC;oBACxC,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;oBACrB,QAAQ,EAAE,MAAM;iBACjB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,MAAM,IAAI,CAAC,EAAE,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,8BAA8B,CAAC,QAAgB;QACnD,MAAM,IAAI,CAAC,EAAE,CAAC,8BAA8B,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED,sBAAsB,CACpB,QAAkD;QAElD,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC3C,OAAO,GAAG,EAAE;YACV,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAChD,CAAC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,0BAA0B;QAC9B,OAAO,MAAM,IAAI,CAAC,EAAE,CAAC,uBAAuB,EAAE,CAAC;IACjD,CAAC;IAED,KAAK,CAAC,6BAA6B;QACjC,OAAO,MAAM,IAAI,CAAC,EAAE,CAAC,0BAA0B,EAAE,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,iBAAiB,CAAC,UAAoB;QAC1C,OAAO,MAAM,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IAChD,CAAC;IAED,kBAAkB;QAChB,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;IACrC,CAAC;IAED,KAAK,CAAC,mCAAmC,CACvC,SAA2B;QAE3B,MAAM,qBAAqB,GAAG,IAAI,wBAAiB,EAAiB,CAAC;QACrE,KAAK,MAAM,gBAAgB,IAAI,SAAS,CAAC,iBAAiB,EAAE,CAAC;YAC3D,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC;YACrC,IAAI,aAAa,GAAG,qBAAqB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YAC3D,aAAa,IAAI,IAAA,qCAA6B,EAAC,gBAAgB,CAAC,CAAC;YACjE,qBAAqB,CAAC,GAAG,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;QAClD,CAAC;QAED,KAAK,MAAM,CAAC,KAAK,EAAE,eAAe,CAAC,IAAI,qBAAqB,CAAC,OAAO,EAAE,EAAE,CAAC;YACvE,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YACxD,IAAI,OAAO,GAAG,eAAe,EAAE,CAAC;gBAC9B,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,gCAAgC,CACpC,EAAsC;QAEtC,MAAM,gBAAgB,GAAG,MAAM,mCAAmC,CAChE,IAAI,CAAC,EAAE,EACP,EAAE,CACH,CAAC;QACF,OAAO,MAAM,CACX,4BAAqB,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC,WAAW,CACjE,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,EAAsC,EACtC,QAA2B;QAE3B,MAAM,IAAI,CAAC,EAAE,CAAC,cAAc,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,MAAc;QACtC,MAAM,IAAI,CAAC,EAAE,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,cAAwB;QACzC,OAAO,MAAM,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,kBAAkB,CACtB,MAAc;QAEd,OAAO,MAAM,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,oBAAoB,CACxB,MAAc,EACd,MAAuB;QAEvB,MAAM,IAAI,CAAC,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,yBAAyB;QAC7B,MAAM,IAAI,CAAC,EAAE,CAAC,kBAAkB,EAAE,CAAC;IACrC,CAAC;CACF;AA7VD,wCA6VC;AAEM,KAAK,UAAU,mCAAmC,CACvD,EAAc,EACd,EAAsC;IAEtC,kEAAkE;IAClE,MAAM,cAAc,GAAG,IAAA,eAAQ,EAC7B,IAAA,oCAA4B,EAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC,CACvE,CAAC;IAEF,yCAAyC;IACzC,MAAM,gBAAgB,GAAG,MAAM,EAAE,CAAC,iCAAiC,CACjE,MAAM,CAAC,cAAc,CAAC,CACvB,CAAC;IAEF,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CACb,gEAAgE,cAAc,EAAE,CACjF,CAAC;IACJ,CAAC;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC"}

package/dist/src/NocturneDB.d.ts

@@ -0,0 +1,100 @@
+import { OptimisticNFRecord, OpHistoryRecord, OperationMetadata, PendingOutputRecord } from "./types";
+import { Asset, IncludedNote, IncludedNoteWithNullifier, KVStore, StateDiff, TotalEntityIndex, WithTotalEntityIndex, OperationStatus, PreSignOperation, SignedOperation } from "@zill-protocol/core";
+import { Mutex } from "async-mutex";
+export type AssetKey = string;
+type AllNotes = Map<AssetKey, IncludedNote[]>;
+export interface GetNotesOpts {
+    includeUncommitted?: boolean;
+    ignoreOptimisticNFs?: boolean;
+}
+export declare class NocturneDB {
+    kv: KVStore;
+    protected mutex: Mutex;
+    constructor(kv: KVStore);
+    static formatIndexKey(merkleIndex: number): string;
+    static formatAssetKey(asset: Asset): string;
+    static formatNullifierKey(nullifier: bigint): string;
+    static formatMerkleIndexToTotalEntityIndexKey(merkleIndex: number): string;
+    static formatOptimisticNFRecordKey(merkleIndex: number): string;
+    static formatOpHistoryRecordKey(digest: bigint): string;
+    static formatPendingOutputKey(commitment: bigint): string;
+    static parseMerkleIndexFromOptimisticNFRecordKey(key: string): number;
+    static parseIndexKey(key: string): number;
+    static parseAssetKey(key: string): Asset;
+    protected _getHistoryRecord(digest: bigint): Promise<OpHistoryRecord | undefined>;
+    protected _setHistoryRecord(digest: bigint, record: OpHistoryRecord): Promise<void>;
+    protected getHistoryArray(): Promise<bigint[]>;
+    protected setHistoryArray(history: bigint[]): Promise<void>;
+    getHistory(includePending?: boolean): Promise<OpHistoryRecord[]>;
+    getHistoryRecord(digest: bigint): Promise<OpHistoryRecord | undefined>;
+    setStatusForOp(opDigest: bigint, status: OperationStatus): Promise<void>;
+    addOpToHistory(op: PreSignOperation | SignedOperation, metadata: OperationMetadata, status?: OperationStatus): Promise<void>;
+    removeOpFromHistory(digest: bigint, removeOptimisticNFs?: boolean): Promise<void>;
+    pruneOptimisticNFs(): Promise<void>;
+    getOptimisticNFRecord(merkleIndex: number): Promise<OptimisticNFRecord | undefined>;
+    getAllOptimisticNFRecords(): Promise<Map<number, OptimisticNFRecord>>;
+    removeOptimisticNFRecords(merkleIndices: number[]): Promise<void>;
+    storeNotes(notesWithTotalEntityIndices: WithTotalEntityIndex<IncludedNoteWithNullifier>[]): Promise<void>;
+    nullifyNotes(nullifiers: bigint[]): Promise<number[]>;
+    /**
+     * Get all *committed* notes for an asset
+     *
+     * @param asset the asset to get notes for
+     * @param opts optional options. See `GetNotesOpts` for more details.
+     * @returns notes an array of notes for the asset. The array has no guaranteed order.
+     */
+    getNotesForAsset(asset: Asset, opts?: GetNotesOpts): Promise<IncludedNote[]>;
+    private filterNotesByOpts;
+    /**
+     * Get TotalEntityIndex at which an owned note with merkleIndex `merkleIndex` was inserted into the tree (not necessarily committed)
+     *
+     * @param merkleIndex the merkleIndex to get the TotalEntityIndex for
+     * @returns the totalEntityIndex in unix millis at which the merkleIndex was inserted into the tree,
+     *          or undefined if the corresponding note is nullified or not owned
+     */
+    getTotalEntityIndexForMerkleIndex(merkleIndex: number): Promise<bigint | undefined>;
+    currentTotalEntityIndex(): Promise<TotalEntityIndex | undefined>;
+    setCurrentTotalEntityIndex(totalEntityIndex: TotalEntityIndex): Promise<void>;
+    latestSyncedMerkleIndex(): Promise<number | undefined>;
+    setlatestSyncedMerkleIndex(index: number): Promise<void>;
+    latestCommittedMerkleIndex(): Promise<number | undefined>;
+    setlatestCommittedMerkleIndex(index: number): Promise<void>;
+    lastCommitTotalEntityIndex(): Promise<TotalEntityIndex | undefined>;
+    setLastCommitTotalEntityIndex(totalEntityIndex: TotalEntityIndex): Promise<void>;
+    applyStateDiff(diff: StateDiff, opts?: {
+        onPendingOutputsConfirmed?: (outputs: PendingOutputRecord[]) => void;
+    }): Promise<number[]>;
+    addPendingOutputs(outputs: PendingOutputRecord[]): Promise<void>;
+    getPendingOutputs(opts?: {
+        asset?: Asset;
+    }): Promise<PendingOutputRecord[]>;
+    getPendingBalanceForAsset(asset: Asset): Promise<bigint>;
+    removePendingOutputsByCommitments(commitments: bigint[]): Promise<PendingOutputRecord[]>;
+    removePendingOutputsByOpDigest(opDigest: bigint): Promise<void>;
+    /**
+     * Get total value of all notes for a given asset
+     *
+     * @param asset the asset to get balance for
+     * @param opts optional options. See `GetNotesOpts` for more details.
+     * @returns total value of all notes for the asset summed up
+     */
+    getBalanceForAsset(asset: Asset, opts?: GetNotesOpts): Promise<bigint>;
+    /**
+     * Get all notes in the KV store
+     *
+     * @param opts optional options. See `GetNotesOpts` for more details.
+     * @returns allNotes a map of all notes in the KV store. keys are the `NoteAssetKey` for an asset,
+     *          and values are an array of `IncludedNote`s for that asset. The array has no guaranteed order.
+     */
+    getAllNotes(opts?: GetNotesOpts): Promise<AllNotes>;
+    private static makeNoteKV;
+    private static makeNullifierKV;
+    private static makeMerkleIndexToTotalEntityIndexKV;
+    private static makeOptimisticNFRecordKV;
+    private getUpdatedAssetKVsWithNotesAdded;
+    private getUpdatedAssetKVsWithNotesRemoved;
+    private getMerkleIndicesForAsset;
+    private getNotesByMerkleIndices;
+}
+export {};
+//# sourceMappingURL=NocturneDB.d.ts.map

package/dist/src/NocturneDB.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NocturneDB.d.ts","sourceRoot":"","sources":["../../src/NocturneDB.ts"],"names":[],"mappings":"AACA,OAAO,EACL,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,SAAS,CAAC;AAEjB,OAAO,EACL,KAAK,EAEL,YAAY,EAGZ,yBAAyB,EAGzB,OAAO,EACP,SAAS,EACT,gBAAgB,EAChB,oBAAoB,EACpB,eAAe,EAGf,gBAAgB,EAChB,eAAe,EAChB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAwBpC,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC9B,KAAK,QAAQ,GAAG,GAAG,CAAC,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;AAM9C,MAAM,WAAW,YAAY;IAC3B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,qBAAa,UAAU;IAMd,EAAE,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC;gBAEX,EAAE,EAAE,OAAO;IAKvB,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAOlD,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM;IAM3C,MAAM,CAAC,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAIpD,MAAM,CAAC,sCAAsC,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAO1E,MAAM,CAAC,2BAA2B,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAO/D,MAAM,CAAC,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAIvD,MAAM,CAAC,sBAAsB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;IAIzD,MAAM,CAAC,yCAAyC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAIrE,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAIzC,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK;cASxB,iBAAiB,CAC/B,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;cAUvB,iBAAiB,CAC/B,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,IAAI,CAAC;cAMA,eAAe,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;cASpC,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAK3D,UAAU,CAAC,cAAc,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAsBhE,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAMtE,cAAc,CAClB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,IAAI,CAAC;IAsBV,cAAc,CAClB,EAAE,EAAE,gBAAgB,GAAG,eAAe,EACtC,QAAQ,EAAE,iBAAiB,EAC3B,MAAM,CAAC,EAAE,eAAe,GACvB,OAAO,CAAC,IAAI,CAAC;IAoCV,mBAAmB,CACvB,MAAM,EAAE,MAAM,EACd,mBAAmB,CAAC,EAAE,OAAO,GAC5B,OAAO,CAAC,IAAI,CAAC;IAsBV,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAgBnC,qBAAqB,CACzB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC;IAWpC,yBAAyB,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAarE,yBAAyB,CAAC,aAAa,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAKjE,UAAU,CACd,2BAA2B,EAAE,oBAAoB,CAAC,yBAAyB,CAAC,EAAE,GAC7E,OAAO,CAAC,IAAI,CAAC;IAiCV,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IA2B3D;;;;;;OAMG;IACG,gBAAgB,CACpB,KAAK,EAAE,KAAK,EACZ,IAAI,CAAC,EAAE,YAAY,GAClB,OAAO,CAAC,YAAY,EAAE,CAAC;YAMZ,iBAAiB;IA4B/B;;;;;;OAMG;IACG,iCAAiC,CACrC,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAQxB,uBAAuB,IAAI,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAKhE,0BAA0B,CAC9B,gBAAgB,EAAE,gBAAgB,GACjC,OAAO,CAAC,IAAI,CAAC;IAKV,uBAAuB,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAKtD,0BAA0B,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKxD,0BAA0B,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAKzD,6BAA6B,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAK3D,0BAA0B,IAAI,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAKnE,6BAA6B,CACjC,gBAAgB,EAAE,gBAAgB,GACjC,OAAO,CAAC,IAAI,CAAC;IAMV,cAAc,CAClB,IAAI,EAAE,SAAS,EACf,IAAI,CAAC,EAAE;QACL,yBAAyB,CAAC,EAAE,CAAC,OAAO,EAAE,mBAAmB,EAAE,KAAK,IAAI,CAAC;KACtE,GACA,OAAO,CAAC,MAAM,EAAE,CAAC;IAiDd,iBAAiB,CAAC,OAAO,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAWhE,iBAAiB,CACrB,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,KAAK,CAAA;KAAE,GACvB,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAwB3B,yBAAyB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC;IAKxD,iCAAiC,CACrC,WAAW,EAAE,MAAM,EAAE,GACpB,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAmB3B,8BAA8B,CAClC,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;;OAMG;IACG,kBAAkB,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAK5E;;;;;;OAMG;IACG,WAAW,CAAC,IAAI,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC;IAoBzD,OAAO,CAAC,MAAM,CAAC,UAAU;IAOzB,OAAO,CAAC,MAAM,CAAC,eAAe;IAI9B,OAAO,CAAC,MAAM,CAAC,mCAAmC;IAUlD,OAAO,CAAC,MAAM,CAAC,wBAAwB;YASzB,gCAAgC;YAsBhC,kCAAkC;YAsBlC,wBAAwB;YAUxB,uBAAuB;CAStC"}