@bsv/wallet-toolbox 1.3.20 → 1.3.22

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

@@ -0,0 +1,38 @@
+"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;
+    }
+    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.storage.getSettings();
+    }
+    destroy() {
+        return this.storage.destroy();
+    }
+    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);
+    }
+}
+exports.StorageSyncReader = StorageSyncReader;
+//# sourceMappingURL=StorageSyncReader.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"StorageSyncReader.js","sourceRoot":"","sources":["../../../../src/storage/StorageSyncReader.ts"],"names":[],"mappings":";;;AAAA,kDAkBwB;AAGxB;;;;;GAKG;AACH,MAAa,iBAAiB;IAC5B,YACS,IAAgB,EAChB,OAAsB;QADtB,SAAI,GAAJ,IAAI,CAAY;QAChB,YAAO,GAAP,OAAO,CAAe;IAC5B,CAAC;IAEJ,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,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;YAC5E,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,OAAO,CAAC,WAAW,EAAE,CAAA;IACnC,CAAC;IACD,OAAO;QACL,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAA;IAC/B,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;YAAE,MAAM,IAAI,kBAAG,CAAC,iBAAiB,EAAE,CAAA;QACjF,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;IAC9C,CAAC;CACF;AAvBD,8CAuBC"}

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

@@ -0,0 +1,184 @@
+import { AbortActionArgs, AbortActionResult, InternalizeActionArgs, InternalizeActionResult, ListActionsResult, ListCertificatesResult, ListOutputsResult, RelinquishCertificateArgs, RelinquishOutputArgs } from '@bsv/sdk';
+import * as sdk from '../sdk';
+import { TableCertificate, TableCertificateX, TableOutput, TableOutputBasket, TableProvenTxReq, TableSettings, TableUser } from '../storage/schema/tables';
+import { StorageProvider } from './StorageProvider';
+declare class ManagedStorage {
+    storage: sdk.WalletStorageProvider;
+    isAvailable: boolean;
+    isStorageProvider: boolean;
+    settings?: TableSettings;
+    user?: TableUser;
+    constructor(storage: sdk.WalletStorageProvider);
+}
+/**
+ * The `WalletStorageManager` 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, `WalletStorageManager` 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. `WalletStorageManager` manages wait-blocking write requests
+ * for these services.
+ */
+export declare class WalletStorageManager implements sdk.WalletStorage {
+    /**
+     * All configured stores including current active, backups, and conflicting actives.
+     */
+    _stores: ManagedStorage[];
+    /**
+     * True if makeAvailable has been run and access to managed stores (active) is allowed
+     */
+    _isAvailable: boolean;
+    /**
+     * The current active store which is only enabled if the store's user record activeStorage property matches its settings record storageIdentityKey property
+     */
+    _active?: ManagedStorage;
+    /**
+     * Stores to which state is pushed by updateBackups.
+     */
+    _backups?: ManagedStorage[];
+    /**
+     * Stores whose user record activeStorage property disagrees with the active store's user record activeStorage property.
+     */
+    _conflictingActives?: ManagedStorage[];
+    /**
+     * identityKey is always valid, userId and isActive are valid only if _isAvailable
+     */
+    _authId: sdk.AuthId;
+    /**
+     * Configured services if any. If valid, shared with stores (which may ignore it).
+     */
+    _services?: sdk.WalletServices;
+    /**
+     * How many read access operations are pending
+     */
+    _readerCount: number;
+    /**
+     * How many write access operations are pending
+     */
+    _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;
+    isAvailable(): boolean;
+    /**
+     * The active storage is "enabled" only if its `storageIdentityKey` matches the user's currently selected `activeStorage`,
+     * and only if there are no stores with conflicting `activeStorage` selections.
+     *
+     * A wallet may be created without including the user's currently selected active storage. This allows readonly access to their wallet data.
+     *
+     * In addition, if there are conflicting `activeStorage` selections among backup storage providers then the active remains disabled.
+     */
+    get isActiveEnabled(): boolean;
+    /**
+     * @returns true if at least one WalletStorageProvider has been added.
+     */
+    canMakeAvailable(): boolean;
+    /**
+     * This async function must be called after construction and before
+     * any other async function can proceed.
+     *
+     * Runs through `_stores` validating all properties and partitioning across `_active`, `_backups`, `_conflictingActives`.
+     *
+     * @throws WERR_INVALID_PARAMETER if canMakeAvailable returns false.
+     *
+     * @returns {TableSettings} from the active storage.
+     */
+    makeAvailable(): Promise<TableSettings>;
+    private verifyActive;
+    getAuth(mustBeActive?: boolean): Promise<sdk.AuthId>;
+    getUserId(): Promise<number>;
+    getActive(): sdk.WalletStorageProvider;
+    getActiveSettings(): TableSettings;
+    getActiveUser(): TableUser;
+    getActiveStore(): string;
+    getActiveStoreName(): string;
+    getBackupStores(): string[];
+    getConflictingStores(): string[];
+    getAllStores(): string[];
+    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;
+    addWalletStorageProvider(provider: sdk.WalletStorageProvider): Promise<void>;
+    setServices(v: sdk.WalletServices): void;
+    getServices(): sdk.WalletServices;
+    getSettings(): TableSettings;
+    migrate(storageName: string, storageIdentityKey: string): Promise<string>;
+    destroy(): Promise<void>;
+    findOrInsertUser(identityKey: string): Promise<{
+        user: TableUser;
+        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: TableCertificate): 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<TableCertificateX[]>;
+    findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<TableOutputBasket[]>;
+    findOutputs(args: sdk.FindOutputsArgs): Promise<TableOutput[]>;
+    findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<TableProvenTxReq[]>;
+    syncFromReader(identityKey: string, reader: sdk.WalletStorageSyncReader, activeSync?: sdk.WalletStorageSync, log?: string): Promise<{
+        inserts: number;
+        updates: number;
+        log: string;
+    }>;
+    syncToWriter(auth: sdk.AuthId, writer: sdk.WalletStorageProvider, activeSync?: sdk.WalletStorageSync, log?: string, progLog?: (s: string) => string): Promise<{
+        inserts: number;
+        updates: number;
+        log: string;
+    }>;
+    updateBackups(activeSync?: sdk.WalletStorageSync, progLog?: (s: string) => string): Promise<string>;
+    /**
+     * Updates backups and switches to new active storage provider from among current backup providers.
+     *
+     * Also resolves conflicting actives.
+     *
+     * @param storageIdentityKey of current backup storage provider that is to become the new active provider.
+     */
+    setActive(storageIdentityKey: string, progLog?: (s: string) => string): Promise<string>;
+    getStoreEndpointURL(store: ManagedStorage): string | undefined;
+    getStores(): sdk.WalletStorageInfo[];
+}
+export {};
+//# sourceMappingURL=WalletStorageManager.d.ts.map

package/mobile/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,EACvB,iBAAiB,EACjB,sBAAsB,EACtB,iBAAiB,EACjB,yBAAyB,EACzB,oBAAoB,EACrB,MAAM,UAAU,CAAA;AAEjB,OAAO,KAAK,GAAG,MAAM,QAAQ,CAAA;AAC7B,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACb,SAAS,EACV,MAAM,0BAA0B,CAAA;AAEjC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAGnD,cAAM,cAAc;IAMC,OAAO,EAAE,GAAG,CAAC,qBAAqB;IALrD,WAAW,EAAE,OAAO,CAAA;IACpB,iBAAiB,EAAE,OAAO,CAAA;IAC1B,QAAQ,CAAC,EAAE,aAAa,CAAA;IACxB,IAAI,CAAC,EAAE,SAAS,CAAA;gBAEG,OAAO,EAAE,GAAG,CAAC,qBAAqB;CAItD;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,oBAAqB,YAAW,GAAG,CAAC,aAAa;IAC5D;;OAEG;IACH,OAAO,EAAE,cAAc,EAAE,CAAK;IAC9B;;OAEG;IACH,YAAY,EAAE,OAAO,CAAQ;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,cAAc,CAAA;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAA;IAC3B;;OAEG;IACH,mBAAmB,CAAC,EAAE,cAAc,EAAE,CAAA;IACtC;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC,MAAM,CAAA;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,GAAG,CAAC,cAAc,CAAA;IAC9B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAI;IACxB;;OAEG;IACH,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;gBAE3B,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,EAAE,GAAG,CAAC,qBAAqB,EAAE;IAO1G,iBAAiB,IAAI,OAAO;IAI5B,WAAW,IAAI,OAAO;IAItB;;;;;;;OAOG;IACH,IAAI,eAAe,IAAI,OAAO,CAO7B;IAED;;OAEG;IACH,gBAAgB,IAAI,OAAO;IAI3B;;;;;;;;;OASG;IACG,aAAa,IAAI,OAAO,CAAC,aAAa,CAAC;IAsD7C,OAAO,CAAC,YAAY;IAQd,OAAO,CAAC,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC;IAMpD,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IAIlC,SAAS,IAAI,GAAG,CAAC,qBAAqB;IAItC,iBAAiB,IAAI,aAAa;IAIlC,aAAa,IAAI,SAAS;IAI1B,cAAc,IAAI,MAAM;IAIxB,kBAAkB,IAAI,MAAM;IAI5B,eAAe,IAAI,MAAM,EAAE;IAK3B,oBAAoB,IAAI,MAAM,EAAE;IAKhC,YAAY,IAAI,MAAM,EAAE;IAKlB,kBAAkB,IAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;IActD,kBAAkB,IAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;IAStD,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;IAgBlD,2BAA2B,IAAI,OAAO,CAAC,eAAe,CAAC;IAqBvD,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,mBAAmB,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAUnF,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,mBAAmB,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAUzF;;;;;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,EAAE,IAAI,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAUxF;;;OAGG;IACH,uBAAuB,IAAI,OAAO;IAI5B,wBAAwB,CAAC,QAAQ,EAAE,GAAG,CAAC,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAQlF,WAAW,CAAC,CAAC,EAAE,GAAG,CAAC,cAAc;IAIjC,WAAW,IAAI,GAAG,CAAC,cAAc;IAKjC,WAAW,IAAI,aAAa;IAItB,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAMzE,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAOxB,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,SAAS,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,CAAC;IAcnF,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAO9D,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,qBAAqB,GAAG,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC;IAMtF,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAQhF,qBAAqB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,MAAM,CAAC;IAOvE,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC;IAQ7D,aAAa,CAAC,IAAI,EAAE,GAAG,CAAC,wBAAwB,GAAG,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC;IAM3F,iBAAiB,CAAC,WAAW,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;IAOjE,WAAW,CAAC,KAAK,EAAE,GAAG,CAAC,oBAAoB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAMxE,gBAAgB,CAAC,IAAI,EAAE,GAAG,CAAC,yBAAyB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAMtF,WAAW,CAAC,KAAK,EAAE,GAAG,CAAC,oBAAoB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAMxE,gBAAgB,CAAC,IAAI,EAAE,GAAG,CAAC,oBAAoB,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAM9E,iBAAiB,CAAC,IAAI,EAAE,GAAG,CAAC,qBAAqB,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAMhF,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,eAAe,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAO9D,gBAAgB,CAAC,IAAI,EAAE,GAAG,CAAC,oBAAoB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAM7E,cAAc,CAClB,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,GAAG,CAAC,uBAAuB,EACnC,UAAU,CAAC,EAAE,GAAG,CAAC,iBAAiB,EAClC,GAAG,GAAE,MAAW,GACf,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IAsCvD,YAAY,CAChB,IAAI,EAAE,GAAG,CAAC,MAAM,EAChB,MAAM,EAAE,GAAG,CAAC,qBAAqB,EACjC,UAAU,CAAC,EAAE,GAAG,CAAC,iBAAiB,EAClC,GAAG,GAAE,MAAW,EAChB,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,GAC9B,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IAmCvD,aAAa,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAazG;;;;;;OAMG;IACG,SAAS,CAAC,kBAAkB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IA4F7F,mBAAmB,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM,GAAG,SAAS;IAK9D,SAAS,IAAI,GAAG,CAAC,iBAAiB,EAAE;CA2CrC"}