@bsv/wallet-toolbox 1.1.0

package/out/src/storage/StorageSyncReader.js

@@ -0,0 +1,142 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StorageSyncReader = void 0;
+const index_client_1 = require("../index.client");
+/**
+ * The `StorageSyncReader` non-abstract class must be used when authentication checking access to the methods of a `StorageBaseReader` is required.
+ *
+ * Constructed from an `auth` object that must minimally include the authenticated user's identityKey,
+ * and the `StorageBaseReader` to be protected.
+ */
+class StorageSyncReader {
+    constructor(auth, storage) {
+        this.auth = auth;
+        this.storage = storage;
+    }
+    isAvailable() {
+        return this.storage.isAvailable();
+    }
+    async makeAvailable() {
+        await this.storage.makeAvailable();
+        if (this.auth.userId === undefined) {
+            const user = await this.storage.findUserByIdentityKey(this.auth.identityKey);
+            if (!user)
+                throw new index_client_1.sdk.WERR_UNAUTHORIZED();
+            this.auth.userId = user.userId;
+        }
+        return this.getSettings();
+    }
+    destroy() {
+        return this.storage.destroy();
+    }
+    getSettings() {
+        return this.storage.getSettings();
+    }
+    async getSyncChunk(args) {
+        if (!this.auth.userId)
+            await this.makeAvailable();
+        if (args.identityKey !== this.auth.identityKey)
+            throw new index_client_1.sdk.WERR_UNAUTHORIZED();
+        return await this.storage.getSyncChunk(args);
+    }
+    async findUserByIdentityKey(key) {
+        if (!this.auth.userId)
+            await this.makeAvailable();
+        if (key !== this.auth.identityKey)
+            throw new index_client_1.sdk.WERR_UNAUTHORIZED();
+        return await this.storage.findUserByIdentityKey(key);
+    }
+    async findSyncStates(args) {
+        if (!this.auth.userId)
+            await this.makeAvailable();
+        if (args.partial.userId !== this.auth.userId)
+            throw new index_client_1.sdk.WERR_UNAUTHORIZED();
+        return await this.storage.findSyncStates(args);
+    }
+    async findCertificateFields(args) {
+        if (!this.auth.userId)
+            await this.makeAvailable();
+        if (args.partial.userId !== this.auth.userId)
+            throw new index_client_1.sdk.WERR_UNAUTHORIZED();
+        return await this.storage.findCertificateFields(args);
+    }
+    async findCertificates(args) {
+        if (!this.auth.userId)
+            await this.makeAvailable();
+        if (args.partial.userId !== this.auth.userId)
+            throw new index_client_1.sdk.WERR_UNAUTHORIZED();
+        return await this.storage.findCertificates(args);
+    }
+    async findCommissions(args) {
+        if (!this.auth.userId)
+            await this.makeAvailable();
+        if (args.partial.userId !== this.auth.userId)
+            throw new index_client_1.sdk.WERR_UNAUTHORIZED();
+        return await this.storage.findCommissions(args);
+    }
+    async findOutputBaskets(args) {
+        if (!this.auth.userId)
+            await this.makeAvailable();
+        if (args.partial.userId !== this.auth.userId)
+            throw new index_client_1.sdk.WERR_UNAUTHORIZED();
+        return await this.storage.findOutputBaskets(args);
+    }
+    async findOutputs(args) {
+        if (!this.auth.userId)
+            await this.makeAvailable();
+        if (args.partial.userId !== this.auth.userId)
+            throw new index_client_1.sdk.WERR_UNAUTHORIZED();
+        return await this.storage.findOutputs(args);
+    }
+    async findOutputTags(args) {
+        if (!this.auth.userId)
+            await this.makeAvailable();
+        if (args.partial.userId !== this.auth.userId)
+            throw new index_client_1.sdk.WERR_UNAUTHORIZED();
+        return await this.storage.findOutputTags(args);
+    }
+    async findTransactions(args) {
+        if (!this.auth.userId)
+            await this.makeAvailable();
+        if (args.partial.userId !== this.auth.userId)
+            throw new index_client_1.sdk.WERR_UNAUTHORIZED();
+        return await this.storage.findTransactions(args);
+    }
+    async findTxLabels(args) {
+        if (!this.auth.userId)
+            await this.makeAvailable();
+        if (args.partial.userId !== this.auth.userId)
+            throw new index_client_1.sdk.WERR_UNAUTHORIZED();
+        return await this.storage.findTxLabels(args);
+    }
+    async getProvenTxsForUser(args) {
+        if (!this.auth.userId)
+            await this.makeAvailable();
+        if (args.userId !== this.auth.userId)
+            throw new index_client_1.sdk.WERR_UNAUTHORIZED();
+        return await this.storage.getProvenTxsForUser(args);
+    }
+    async getProvenTxReqsForUser(args) {
+        if (!this.auth.userId)
+            await this.makeAvailable();
+        if (args.userId !== this.auth.userId)
+            throw new index_client_1.sdk.WERR_UNAUTHORIZED();
+        return await this.storage.getProvenTxReqsForUser(args);
+    }
+    async getTxLabelMapsForUser(args) {
+        if (!this.auth.userId)
+            await this.makeAvailable();
+        if (args.userId !== this.auth.userId)
+            throw new index_client_1.sdk.WERR_UNAUTHORIZED();
+        return await this.storage.getTxLabelMapsForUser(args);
+    }
+    async getOutputTagMapsForUser(args) {
+        if (!this.auth.userId)
+            await this.makeAvailable();
+        if (args.userId !== this.auth.userId)
+            throw new index_client_1.sdk.WERR_UNAUTHORIZED();
+        return await this.storage.getOutputTagMapsForUser(args);
+    }
+}
+exports.StorageSyncReader = StorageSyncReader;
+//# sourceMappingURL=StorageSyncReader.js.map

package/out/src/storage/StorageSyncReader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageSyncReader.js","sourceRoot":"","sources":["../../../src/storage/StorageSyncReader.ts"],"names":[],"mappings":";;;AAAA,kDAA4C;AAG5C;;;;;GAKG;AACH,MAAa,iBAAiB;IAC5B,YACS,IAAgB,EAChB,OAAsB;QADtB,SAAI,GAAJ,IAAI,CAAY;QAChB,YAAO,GAAP,OAAO,CAAe;IAC5B,CAAC;IAEJ,WAAW;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAA;IACnC,CAAC;IACD,KAAK,CAAC,aAAa;QACjB,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAA;QAClC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACnC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,qBAAqB,CACnD,IAAI,CAAC,IAAI,CAAC,WAAW,CACtB,CAAA;YACD,IAAI,CAAC,IAAI;gBAAE,MAAM,IAAI,kBAAG,CAAC,iBAAiB,EAAE,CAAA;YAC5C,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;QAChC,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,EAAE,CAAA;IAC3B,CAAC;IACD,OAAO;QACL,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAA;IAC/B,CAAC;IACD,WAAW;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAA;IACnC,CAAC;IACD,KAAK,CAAC,YAAY,CAAC,IAA8B;QAC/C,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QACjD,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,IAAI,CAAC,WAAW;YAC5C,MAAM,IAAI,kBAAG,CAAC,iBAAiB,EAAE,CAAA;QACnC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;IAC9C,CAAC;IACD,KAAK,CAAC,qBAAqB,CAAC,GAAW;QACrC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QACjD,IAAI,GAAG,KAAK,IAAI,CAAC,IAAI,CAAC,WAAW;YAAE,MAAM,IAAI,kBAAG,CAAC,iBAAiB,EAAE,CAAA;QACpE,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAA;IACtD,CAAC;IACD,KAAK,CAAC,cAAc,CAClB,IAA4B;QAE5B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QACjD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM;YAC1C,MAAM,IAAI,kBAAG,CAAC,iBAAiB,EAAE,CAAA;QACnC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,CAAA;IAChD,CAAC;IACD,KAAK,CAAC,qBAAqB,CACzB,IAAmC;QAEnC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QACjD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM;YAC1C,MAAM,IAAI,kBAAG,CAAC,iBAAiB,EAAE,CAAA;QACnC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAA;IACvD,CAAC;IACD,KAAK,CAAC,gBAAgB,CACpB,IAA8B;QAE9B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QACjD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM;YAC1C,MAAM,IAAI,kBAAG,CAAC,iBAAiB,EAAE,CAAA;QACnC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;IAClD,CAAC;IACD,KAAK,CAAC,eAAe,CACnB,IAA6B;QAE7B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QACjD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM;YAC1C,MAAM,IAAI,kBAAG,CAAC,iBAAiB,EAAE,CAAA;QACnC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;IACjD,CAAC;IACD,KAAK,CAAC,iBAAiB,CACrB,IAA+B;QAE/B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QACjD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM;YAC1C,MAAM,IAAI,kBAAG,CAAC,iBAAiB,EAAE,CAAA;QACnC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;IACnD,CAAC;IACD,KAAK,CAAC,WAAW,CAAC,IAAyB;QACzC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QACjD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM;YAC1C,MAAM,IAAI,kBAAG,CAAC,iBAAiB,EAAE,CAAA;QACnC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;IAC7C,CAAC;IACD,KAAK,CAAC,cAAc,CAClB,IAA4B;QAE5B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QACjD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM;YAC1C,MAAM,IAAI,kBAAG,CAAC,iBAAiB,EAAE,CAAA;QACnC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,CAAA;IAChD,CAAC;IACD,KAAK,CAAC,gBAAgB,CACpB,IAA8B;QAE9B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QACjD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM;YAC1C,MAAM,IAAI,kBAAG,CAAC,iBAAiB,EAAE,CAAA;QACnC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;IAClD,CAAC;IACD,KAAK,CAAC,YAAY,CAAC,IAA0B;QAC3C,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QACjD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM;YAC1C,MAAM,IAAI,kBAAG,CAAC,iBAAiB,EAAE,CAAA;QACnC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;IAC9C,CAAC;IACD,KAAK,CAAC,mBAAmB,CACvB,IAAmC;QAEnC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QACjD,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,kBAAG,CAAC,iBAAiB,EAAE,CAAA;QACvE,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;IACrD,CAAC;IACD,KAAK,CAAC,sBAAsB,CAC1B,IAAmC;QAEnC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QACjD,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,kBAAG,CAAC,iBAAiB,EAAE,CAAA;QACvE,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAA;IACxD,CAAC;IACD,KAAK,CAAC,qBAAqB,CACzB,IAAmC;QAEnC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QACjD,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,kBAAG,CAAC,iBAAiB,EAAE,CAAA;QACvE,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAA;IACvD,CAAC;IACD,KAAK,CAAC,uBAAuB,CAC3B,IAAmC;QAEnC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QACjD,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,kBAAG,CAAC,iBAAiB,EAAE,CAAA;QACvE,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAA;IACzD,CAAC;CACF;AArID,8CAqIC"}

package/out/src/storage/WalletStorageManager.d.ts

@@ -0,0 +1,103 @@
+import { AbortActionArgs, AbortActionResult, InternalizeActionArgs, InternalizeActionResult, ListActionsResult, ListCertificatesResult, ListOutputsResult, RelinquishCertificateArgs, RelinquishOutputArgs } from '@bsv/sdk';
+import { sdk, StorageProvider, StorageSyncReader, table } from '../index.client';
+/**
+ * The `SignerStorage` class delivers authentication checking storage access to the wallet.
+ *
+ * If manages multiple `StorageBase` derived storage services: one actice, the rest as backups.
+ *
+ * Of the storage services, one is 'active' at any one time.
+ * On startup, and whenever triggered by the wallet, `SignerStorage` runs a syncrhonization sequence:
+ *
+ * 1. While synchronizing, all other access to storage is blocked waiting.
+ * 2. The active service is confirmed, potentially triggering a resolution process if there is disagreement.
+ * 3. Changes are pushed from the active storage service to each inactive, backup service.
+ *
+ * Some storage services do not support multiple writers. `SignerStorage` manages wait-blocking write requests
+ * for these services.
+ */
+export declare class WalletStorageManager implements sdk.WalletStorage {
+    stores: sdk.WalletStorageProvider[];
+    _authId: sdk.AuthId;
+    _services?: sdk.WalletServices;
+    _userIdentityKeyToId: Record<string, number>;
+    _readerCount: number;
+    _writerCount: number;
+    /**
+     * if true, allow only a single writer to proceed at a time.
+     * queue the blocked requests so they get executed in order when released.
+     */
+    _isSingleWriter: boolean;
+    /**
+     * if true, allow no new reader or writers to proceed.
+     * queue the blocked requests so they get executed in order when released.
+     */
+    _syncLocked: boolean;
+    /**
+     * if true, allow no new reader or writers or sync to proceed.
+     * queue the blocked requests so they get executed in order when released.
+     */
+    _storageProviderLocked: boolean;
+    constructor(identityKey: string, active?: sdk.WalletStorageProvider, backups?: sdk.WalletStorageProvider[]);
+    isStorageProvider(): boolean;
+    getUserId(): Promise<number>;
+    getAuth(mustBeActive?: boolean): Promise<sdk.AuthId>;
+    getActive(): sdk.WalletStorageProvider;
+    getActiveForWriter(): Promise<sdk.WalletStorageWriter>;
+    getActiveForReader(): Promise<sdk.WalletStorageReader>;
+    getActiveForSync(): Promise<sdk.WalletStorageSync>;
+    getActiveForStorageProvider(): Promise<StorageProvider>;
+    runAsWriter<R>(writer: (active: sdk.WalletStorageWriter) => Promise<R>): Promise<R>;
+    runAsReader<R>(reader: (active: sdk.WalletStorageReader) => Promise<R>): Promise<R>;
+    /**
+     *
+     * @param sync the function to run with sync access lock
+     * @param activeSync from chained sync functions, active storage already held under sync access lock.
+     * @returns
+     */
+    runAsSync<R>(sync: (active: sdk.WalletStorageSync) => Promise<R>, activeSync?: sdk.WalletStorageSync): Promise<R>;
+    runAsStorageProvider<R>(sync: (active: StorageProvider) => Promise<R>): Promise<R>;
+    /**
+     *
+     * @returns true if the active `WalletStorageProvider` also implements `StorageProvider`
+     */
+    isActiveStorageProvider(): boolean;
+    isAvailable(): boolean;
+    addWalletStorageProvider(provider: sdk.WalletStorageProvider): Promise<void>;
+    setServices(v: sdk.WalletServices): void;
+    getServices(): sdk.WalletServices;
+    getSettings(): table.Settings;
+    makeAvailable(): Promise<table.Settings>;
+    migrate(storageName: string, storageIdentityKey: string): Promise<string>;
+    destroy(): Promise<void>;
+    findOrInsertUser(identityKey: string): Promise<{
+        user: table.User;
+        isNew: boolean;
+    }>;
+    abortAction(args: AbortActionArgs): Promise<AbortActionResult>;
+    createAction(vargs: sdk.ValidCreateActionArgs): Promise<sdk.StorageCreateActionResult>;
+    internalizeAction(args: InternalizeActionArgs): Promise<InternalizeActionResult>;
+    relinquishCertificate(args: RelinquishCertificateArgs): Promise<number>;
+    relinquishOutput(args: RelinquishOutputArgs): Promise<number>;
+    processAction(args: sdk.StorageProcessActionArgs): Promise<sdk.StorageProcessActionResults>;
+    insertCertificate(certificate: table.Certificate): Promise<number>;
+    listActions(vargs: sdk.ValidListActionsArgs): Promise<ListActionsResult>;
+    listCertificates(args: sdk.ValidListCertificatesArgs): Promise<ListCertificatesResult>;
+    listOutputs(vargs: sdk.ValidListOutputsArgs): Promise<ListOutputsResult>;
+    findCertificates(args: sdk.FindCertificatesArgs): Promise<table.Certificate[]>;
+    findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<table.OutputBasket[]>;
+    findOutputs(args: sdk.FindOutputsArgs): Promise<table.Output[]>;
+    findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<table.ProvenTxReq[]>;
+    syncFromReader(identityKey: string, reader: StorageSyncReader): Promise<void>;
+    updateBackups(activeSync?: sdk.WalletStorageSync): Promise<void>;
+    syncToWriter(auth: sdk.AuthId, writer: sdk.WalletStorageProvider, activeSync?: sdk.WalletStorageSync): Promise<{
+        inserts: number;
+        updates: number;
+    }>;
+    /**
+     * Updates backups and switches to new active storage provider from among current backup providers.
+     *
+     * @param storageIdentityKey of current backup storage provider that is to become the new active provider.
+     */
+    setActive(storageIdentityKey: string): Promise<void>;
+}
+//# sourceMappingURL=WalletStorageManager.d.ts.map

package/out/src/storage/WalletStorageManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WalletStorageManager.d.ts","sourceRoot":"","sources":["../../../src/storage/WalletStorageManager.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,qBAAqB,EACrB,uBAAuB,EAEvB,iBAAiB,EACjB,sBAAsB,EAEtB,iBAAiB,EACjB,yBAAyB,EACzB,oBAAoB,EACrB,MAAM,UAAU,CAAA;AACjB,OAAO,EAEL,GAAG,EACH,eAAe,EACf,iBAAiB,EACjB,KAAK,EAEN,MAAM,iBAAiB,CAAA;AAExB;;;;;;;;;;;;;;GAcG;AACH,qBAAa,oBAAqB,YAAW,GAAG,CAAC,aAAa;IAC5D,MAAM,EAAE,GAAG,CAAC,qBAAqB,EAAE,CAAK;IACxC,OAAO,EAAE,GAAG,CAAC,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,GAAG,CAAC,cAAc,CAAA;IAC9B,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAK;IACjD,YAAY,EAAE,MAAM,CAAI;IACxB,YAAY,EAAE,MAAM,CAAI;IACxB;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAO;IAC/B;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAQ;IAC5B;;;OAGG;IACH,sBAAsB,EAAE,OAAO,CAAQ;gBAGrC,WAAW,EAAE,MAAM,EACnB,MAAM,CAAC,EAAE,GAAG,CAAC,qBAAqB,EAClC,OAAO,CAAC,EAAE,GAAG,CAAC,qBAAqB,EAAE;IAQvC,iBAAiB,IAAI,OAAO;IAItB,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IAK5B,OAAO,CAAC,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC;IAe1D,SAAS,IAAI,GAAG,CAAC,qBAAqB;IAQhC,kBAAkB,IAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;IAatD,kBAAkB,IAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;IAYtD,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;IAmBlD,2BAA2B,IAAI,OAAO,CAAC,eAAe,CAAC;IAoBvD,WAAW,CAAC,CAAC,EACjB,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,mBAAmB,KAAK,OAAO,CAAC,CAAC,CAAC,GACtD,OAAO,CAAC,CAAC,CAAC;IAUP,WAAW,CAAC,CAAC,EACjB,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,mBAAmB,KAAK,OAAO,CAAC,CAAC,CAAC,GACtD,OAAO,CAAC,CAAC,CAAC;IAUb;;;;;OAKG;IACG,SAAS,CAAC,CAAC,EACf,IAAI,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,iBAAiB,KAAK,OAAO,CAAC,CAAC,CAAC,EACnD,UAAU,CAAC,EAAE,GAAG,CAAC,iBAAiB,GACjC,OAAO,CAAC,CAAC,CAAC;IAUP,oBAAoB,CAAC,CAAC,EAC1B,IAAI,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,OAAO,CAAC,CAAC,CAAC,GAC5C,OAAO,CAAC,CAAC,CAAC;IAUb;;;OAGG;IACH,uBAAuB,IAAI,OAAO;IAIlC,WAAW,IAAI,OAAO;IAIhB,wBAAwB,CAC5B,QAAQ,EAAE,GAAG,CAAC,qBAAqB,GAClC,OAAO,CAAC,IAAI,CAAC;IAMhB,WAAW,CAAC,CAAC,EAAE,GAAG,CAAC,cAAc;IAIjC,WAAW,IAAI,GAAG,CAAC,cAAc;IAMjC,WAAW,IAAI,KAAK,CAAC,QAAQ;IAIvB,aAAa,IAAI,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC;IAOxC,OAAO,CACX,WAAW,EAAE,MAAM,EACnB,kBAAkB,EAAE,MAAM,GACzB,OAAO,CAAC,MAAM,CAAC;IAMZ,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAMxB,gBAAgB,CACpB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC;QAAE,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,CAAC;IAgB1C,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAO9D,YAAY,CAChB,KAAK,EAAE,GAAG,CAAC,qBAAqB,GAC/B,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC;IAMnC,iBAAiB,CACrB,IAAI,EAAE,qBAAqB,GAC1B,OAAO,CAAC,uBAAuB,CAAC;IAQ7B,qBAAqB,CACzB,IAAI,EAAE,yBAAyB,GAC9B,OAAO,CAAC,MAAM,CAAC;IAOZ,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC;IAQ7D,aAAa,CACjB,IAAI,EAAE,GAAG,CAAC,wBAAwB,GACjC,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC;IAMrC,iBAAiB,CAAC,WAAW,EAAE,KAAK,CAAC,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAOlE,WAAW,CACf,KAAK,EAAE,GAAG,CAAC,oBAAoB,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAMvB,gBAAgB,CACpB,IAAI,EAAE,GAAG,CAAC,yBAAyB,GAClC,OAAO,CAAC,sBAAsB,CAAC;IAM5B,WAAW,CACf,KAAK,EAAE,GAAG,CAAC,oBAAoB,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAMvB,gBAAgB,CACpB,IAAI,EAAE,GAAG,CAAC,oBAAoB,GAC7B,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;IAMzB,iBAAiB,CACrB,IAAI,EAAE,GAAG,CAAC,qBAAqB,GAC9B,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;IAM1B,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,eAAe,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IAO/D,gBAAgB,CACpB,IAAI,EAAE,GAAG,CAAC,oBAAoB,GAC7B,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;IAMzB,cAAc,CAClB,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,iBAAiB,GACxB,OAAO,CAAC,IAAI,CAAC;IAmCV,aAAa,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,iBAAiB;IAShD,YAAY,CAChB,IAAI,EAAE,GAAG,CAAC,MAAM,EAChB,MAAM,EAAE,GAAG,CAAC,qBAAqB,EACjC,UAAU,CAAC,EAAE,GAAG,CAAC,iBAAiB,GACjC,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAmChD;;;;OAIG;IACG,SAAS,CAAC,kBAAkB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAgC3D"}

package/out/src/storage/WalletStorageManager.js

@@ -0,0 +1,408 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WalletStorageManager = void 0;
+const index_client_1 = require("../index.client");
+/**
+ * The `SignerStorage` class delivers authentication checking storage access to the wallet.
+ *
+ * If manages multiple `StorageBase` derived storage services: one actice, the rest as backups.
+ *
+ * Of the storage services, one is 'active' at any one time.
+ * On startup, and whenever triggered by the wallet, `SignerStorage` runs a syncrhonization sequence:
+ *
+ * 1. While synchronizing, all other access to storage is blocked waiting.
+ * 2. The active service is confirmed, potentially triggering a resolution process if there is disagreement.
+ * 3. Changes are pushed from the active storage service to each inactive, backup service.
+ *
+ * Some storage services do not support multiple writers. `SignerStorage` manages wait-blocking write requests
+ * for these services.
+ */
+class WalletStorageManager {
+    constructor(identityKey, active, backups) {
+        this.stores = [];
+        this._userIdentityKeyToId = {};
+        this._readerCount = 0;
+        this._writerCount = 0;
+        /**
+         * if true, allow only a single writer to proceed at a time.
+         * queue the blocked requests so they get executed in order when released.
+         */
+        this._isSingleWriter = true;
+        /**
+         * if true, allow no new reader or writers to proceed.
+         * queue the blocked requests so they get executed in order when released.
+         */
+        this._syncLocked = false;
+        /**
+         * if true, allow no new reader or writers or sync to proceed.
+         * queue the blocked requests so they get executed in order when released.
+         */
+        this._storageProviderLocked = false;
+        this.stores = [];
+        if (active)
+            this.stores.push(active);
+        if (backups)
+            this.stores = this.stores.concat(backups);
+        this._authId = { identityKey };
+    }
+    isStorageProvider() {
+        return false;
+    }
+    async getUserId() {
+        if (!this._authId.userId)
+            await this.getAuth();
+        return this._authId.userId;
+    }
+    async getAuth(mustBeActive) {
+        if (!this.isAvailable())
+            await this.makeAvailable();
+        const { user, isNew } = await this.getActive().findOrInsertUser(this._authId.identityKey);
+        if (!user)
+            throw new index_client_1.sdk.WERR_INVALID_PARAMETER('identityKey', 'exist on storage.');
+        this._authId.userId = user.userId;
+        this._authId.isActive =
+            user.activeStorage === undefined ||
+                user.activeStorage === this.getSettings().storageIdentityKey;
+        if (mustBeActive && !this._authId.isActive)
+            throw new index_client_1.sdk.WERR_NOT_ACTIVE();
+        return this._authId;
+    }
+    getActive() {
+        if (this.stores.length < 1)
+            throw new index_client_1.sdk.WERR_INVALID_OPERATION('An active WalletStorageProvider must be added to this WalletStorageManager');
+        return this.stores[0];
+    }
+    async getActiveForWriter() {
+        while (this._storageProviderLocked ||
+            this._syncLocked ||
+            (this._isSingleWriter && this._writerCount > 0) ||
+            this._readerCount > 0) {
+            await (0, index_client_1.wait)(100);
+        }
+        this._writerCount++;
+        return this.getActive();
+    }
+    async getActiveForReader() {
+        while (this._storageProviderLocked ||
+            this._syncLocked ||
+            (this._isSingleWriter && this._writerCount > 0)) {
+            await (0, index_client_1.wait)(100);
+        }
+        this._readerCount++;
+        return this.getActive();
+    }
+    async getActiveForSync() {
+        // Wait for a current sync task to complete...
+        while (this._syncLocked) {
+            await (0, index_client_1.wait)(100);
+        }
+        // Set syncLocked which prevents any new storageProvider, readers or writers...
+        this._syncLocked = true;
+        // Wait for any current storageProvider, readers and writers to complete
+        while (this._storageProviderLocked ||
+            this._readerCount > 0 ||
+            this._writerCount > 0) {
+            await (0, index_client_1.wait)(100);
+        }
+        // Allow the sync to proceed on the active store.
+        return this.getActive();
+    }
+    async getActiveForStorageProvider() {
+        // Wait for a current storageProvider call to complete...
+        while (this._storageProviderLocked) {
+            await (0, index_client_1.wait)(100);
+        }
+        // Set storageProviderLocked which prevents any new sync, readers or writers...
+        this._storageProviderLocked = true;
+        // Wait for any current sync, readers and writers to complete
+        while (this._syncLocked || this._readerCount > 0 || this._writerCount > 0) {
+            await (0, index_client_1.wait)(100);
+        }
+        // We can finally confirm that active storage is still able to support `StorageProvider`
+        if (!this.getActive().isStorageProvider())
+            throw new index_client_1.sdk.WERR_INVALID_OPERATION('Active "WalletStorageProvider" does not support "StorageProvider" interface.');
+        // Allow the sync to proceed on the active store.
+        return this.getActive();
+    }
+    async runAsWriter(writer) {
+        try {
+            const active = await this.getActiveForWriter();
+            const r = await writer(active);
+            return r;
+        }
+        finally {
+            this._writerCount--;
+        }
+    }
+    async runAsReader(reader) {
+        try {
+            const active = await this.getActiveForReader();
+            const r = await reader(active);
+            return r;
+        }
+        finally {
+            this._readerCount--;
+        }
+    }
+    /**
+     *
+     * @param sync the function to run with sync access lock
+     * @param activeSync from chained sync functions, active storage already held under sync access lock.
+     * @returns
+     */
+    async runAsSync(sync, activeSync) {
+        try {
+            const active = activeSync || (await this.getActiveForSync());
+            const r = await sync(active);
+            return r;
+        }
+        finally {
+            if (!activeSync)
+                this._syncLocked = false;
+        }
+    }
+    async runAsStorageProvider(sync) {
+        try {
+            const active = await this.getActiveForStorageProvider();
+            const r = await sync(active);
+            return r;
+        }
+        finally {
+            this._storageProviderLocked = false;
+        }
+    }
+    /**
+     *
+     * @returns true if the active `WalletStorageProvider` also implements `StorageProvider`
+     */
+    isActiveStorageProvider() {
+        return this.getActive().isStorageProvider();
+    }
+    isAvailable() {
+        return this.getActive().isAvailable();
+    }
+    async addWalletStorageProvider(provider) {
+        await provider.makeAvailable();
+        if (this._services)
+            provider.setServices(this._services);
+        this.stores.push(provider);
+    }
+    setServices(v) {
+        this._services = v;
+        for (const store of this.stores)
+            store.setServices(v);
+    }
+    getServices() {
+        if (!this._services)
+            throw new index_client_1.sdk.WERR_INVALID_OPERATION('Must setServices first.');
+        return this._services;
+    }
+    getSettings() {
+        return this.getActive().getSettings();
+    }
+    async makeAvailable() {
+        return await this.runAsWriter(async (writer) => {
+            writer.makeAvailable();
+            return writer.getSettings();
+        });
+    }
+    async migrate(storageName, storageIdentityKey) {
+        return await this.runAsWriter(async (writer) => {
+            return writer.migrate(storageName, storageIdentityKey);
+        });
+    }
+    async destroy() {
+        return await this.runAsWriter(async (writer) => {
+            for (const store of this.stores)
+                await store.destroy();
+        });
+    }
+    async findOrInsertUser(identityKey) {
+        const auth = await this.getAuth();
+        if (identityKey != auth.identityKey)
+            throw new index_client_1.sdk.WERR_UNAUTHORIZED();
+        return await this.runAsWriter(async (writer) => {
+            const r = await writer.findOrInsertUser(identityKey);
+            if (auth.userId && auth.userId !== r.user.userId)
+                throw new index_client_1.sdk.WERR_INTERNAL('userId may not change for given identityKey');
+            this._authId.userId = r.user.userId;
+            return r;
+        });
+    }
+    async abortAction(args) {
+        index_client_1.sdk.validateAbortActionArgs(args);
+        return await this.runAsWriter(async (writer) => {
+            const auth = await this.getAuth(true);
+            return await writer.abortAction(auth, args);
+        });
+    }
+    async createAction(vargs) {
+        return await this.runAsWriter(async (writer) => {
+            const auth = await this.getAuth(true);
+            return await writer.createAction(auth, vargs);
+        });
+    }
+    async internalizeAction(args) {
+        index_client_1.sdk.validateInternalizeActionArgs(args);
+        return await this.runAsWriter(async (writer) => {
+            const auth = await this.getAuth(true);
+            return await writer.internalizeAction(auth, args);
+        });
+    }
+    async relinquishCertificate(args) {
+        index_client_1.sdk.validateRelinquishCertificateArgs(args);
+        return await this.runAsWriter(async (writer) => {
+            const auth = await this.getAuth(true);
+            return await writer.relinquishCertificate(auth, args);
+        });
+    }
+    async relinquishOutput(args) {
+        index_client_1.sdk.validateRelinquishOutputArgs(args);
+        return await this.runAsWriter(async (writer) => {
+            const auth = await this.getAuth(true);
+            return await writer.relinquishOutput(auth, args);
+        });
+    }
+    async processAction(args) {
+        return await this.runAsWriter(async (writer) => {
+            const auth = await this.getAuth(true);
+            return await writer.processAction(auth, args);
+        });
+    }
+    async insertCertificate(certificate) {
+        return await this.runAsWriter(async (writer) => {
+            const auth = await this.getAuth(true);
+            return await writer.insertCertificateAuth(auth, certificate);
+        });
+    }
+    async listActions(vargs) {
+        const auth = await this.getAuth();
+        return await this.runAsReader(async (reader) => {
+            return await reader.listActions(auth, vargs);
+        });
+    }
+    async listCertificates(args) {
+        const auth = await this.getAuth();
+        return await this.runAsReader(async (reader) => {
+            return await reader.listCertificates(auth, args);
+        });
+    }
+    async listOutputs(vargs) {
+        const auth = await this.getAuth();
+        return await this.runAsReader(async (reader) => {
+            return await reader.listOutputs(auth, vargs);
+        });
+    }
+    async findCertificates(args) {
+        const auth = await this.getAuth();
+        return await this.runAsReader(async (reader) => {
+            return await reader.findCertificatesAuth(auth, args);
+        });
+    }
+    async findOutputBaskets(args) {
+        const auth = await this.getAuth();
+        return await this.runAsReader(async (reader) => {
+            return await reader.findOutputBasketsAuth(auth, args);
+        });
+    }
+    async findOutputs(args) {
+        const auth = await this.getAuth();
+        return await this.runAsReader(async (reader) => {
+            return await reader.findOutputsAuth(auth, args);
+        });
+    }
+    async findProvenTxReqs(args) {
+        return await this.runAsReader(async (reader) => {
+            return await reader.findProvenTxReqs(args);
+        });
+    }
+    async syncFromReader(identityKey, reader) {
+        const auth = await this.getAuth();
+        if (identityKey !== auth.identityKey)
+            throw new index_client_1.sdk.WERR_UNAUTHORIZED();
+        const readerSettings = await reader.makeAvailable();
+        return await this.runAsSync(async (sync) => {
+            const writer = sync;
+            const writerSettings = this.getSettings();
+            let log = '';
+            let inserts = 0, updates = 0;
+            for (;;) {
+                const ss = await index_client_1.entity.SyncState.fromStorage(writer, identityKey, readerSettings);
+                const args = ss.makeRequestSyncChunkArgs(identityKey, writerSettings.storageIdentityKey);
+                const chunk = await reader.getSyncChunk(args);
+                const r = await writer.processSyncChunk(args, chunk);
+                inserts += r.inserts;
+                updates += r.updates;
+                //log += `${r.maxUpdated_at} inserted ${r.inserts} updated ${r.updates}\n`
+                if (r.done)
+                    break;
+            }
+            //console.log(log)
+            console.log(`sync complete: ${inserts} inserts, ${updates} updates`);
+        });
+    }
+    async updateBackups(activeSync) {
+        const auth = await this.getAuth();
+        return await this.runAsSync(async (sync) => {
+            for (const backup of this.stores.slice(1)) {
+                await this.syncToWriter(auth, backup, sync);
+            }
+        }, activeSync);
+    }
+    async syncToWriter(auth, writer, activeSync) {
+        const identityKey = auth.identityKey;
+        const writerSettings = await writer.makeAvailable();
+        return await this.runAsSync(async (sync) => {
+            const reader = sync;
+            const readerSettings = this.getSettings();
+            let log = '';
+            let inserts = 0, updates = 0;
+            for (;;) {
+                const ss = await index_client_1.entity.SyncState.fromStorage(writer, identityKey, readerSettings);
+                const args = ss.makeRequestSyncChunkArgs(identityKey, writerSettings.storageIdentityKey);
+                const chunk = await reader.getSyncChunk(args);
+                const r = await writer.processSyncChunk(args, chunk);
+                inserts += r.inserts;
+                updates += r.updates;
+                log += `${r.maxUpdated_at} inserted ${r.inserts} updated ${r.updates}\n`;
+                if (r.done)
+                    break;
+            }
+            //console.log(log)
+            //console.log(`sync complete: ${inserts} inserts, ${updates} updates`)
+            return { inserts, updates };
+        }, activeSync);
+    }
+    /**
+     * Updates backups and switches to new active storage provider from among current backup providers.
+     *
+     * @param storageIdentityKey of current backup storage provider that is to become the new active provider.
+     */
+    async setActive(storageIdentityKey) {
+        const newActiveIndex = this.stores.findIndex(s => s.getSettings().storageIdentityKey === storageIdentityKey);
+        if (newActiveIndex < 0)
+            throw new index_client_1.sdk.WERR_INVALID_PARAMETER('storageIdentityKey', `registered with this "WalletStorageManager" as a backup data store.`);
+        if (newActiveIndex === 0)
+            /** Setting the current active as the new active is a permitted no-op. */
+            return;
+        const auth = await this.getAuth();
+        const newActive = this.stores[newActiveIndex];
+        const newActiveStorageIdentityKey = (await newActive.makeAvailable())
+            .storageIdentityKey;
+        return await this.runAsSync(async (sync) => {
+            await sync.setActive(auth, newActiveStorageIdentityKey);
+            await this.updateBackups(sync);
+            // swap stores...
+            const oldActive = this.stores[0];
+            this.stores[0] = this.stores[newActiveIndex];
+            this.stores[newActiveIndex] = oldActive;
+            this._authId = {
+                ...this._authId,
+                userId: undefined,
+                isActive: undefined
+            };
+        });
+    }
+}
+exports.WalletStorageManager = WalletStorageManager;
+//# sourceMappingURL=WalletStorageManager.js.map