@bopen-io/wallet-toolbox 1.7.18 → 1.7.19

package/out/src/storage/remoting/StorageMobile.js

@@ -0,0 +1,477 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StorageClient = void 0;
+const sdk_1 = require("@bsv/sdk");
+const WERR_errors_1 = require("../../sdk/WERR_errors");
+/**
+ * `StorageClient` implements the `WalletStorageProvider` interface which allows it to
+ * serve as a BRC-100 wallet's active storage.
+ *
+ * Internally, it uses JSON-RPC over HTTPS to make requests of a remote server.
+ * Typically this server uses the `StorageServer` class to implement the service.
+ *
+ * The `AuthFetch` component is used to secure and authenticate the requests to the remote server.
+ *
+ * `AuthFetch` is initialized with a BRC-100 wallet which establishes the identity of
+ * the party making requests of the remote service.
+ *
+ * For details of the API implemented, follow the "See also" link for the `WalletStorageProvider` interface.
+ */
+class StorageClient {
+    constructor(wallet, endpointUrl) {
+        this.nextId = 1;
+        this.authClient = new sdk_1.AuthFetch(wallet);
+        this.endpointUrl = endpointUrl;
+    }
+    /**
+     * The `StorageClient` implements the `WalletStorageProvider` interface.
+     * It does not implement the lower level `StorageProvider` interface.
+     *
+     * @returns false
+     */
+    isStorageProvider() {
+        return false;
+    }
+    //////////////////////////////////////////////////////////////////////////////
+    // JSON-RPC helper
+    //////////////////////////////////////////////////////////////////////////////
+    /**
+     * Make a JSON-RPC call to the remote server.
+     * @param method The WalletStorage method name to call.
+     * @param params The array of parameters to pass to the method in order.
+     */
+    async rpcCall(method, params) {
+        try {
+            const id = this.nextId++;
+            const body = {
+                jsonrpc: '2.0',
+                method,
+                params,
+                id
+            };
+            let response;
+            try {
+                response = await this.authClient.fetch(this.endpointUrl, {
+                    method: 'POST',
+                    headers: { 'Content-Type': 'application/json' },
+                    body: JSON.stringify(body)
+                });
+            }
+            catch (eu) {
+                throw eu;
+            }
+            if (!response.ok) {
+                throw new Error(`WalletStorageClient rpcCall: network error ${response.status} ${response.statusText}`);
+            }
+            const json = await response.json();
+            if (json.error) {
+                const { code, message, data } = json.error;
+                const err = new Error(`RPC Error: ${message}`);
+                err.code = code;
+                err.data = data;
+                throw err;
+            }
+            return json.result;
+        }
+        catch (eu) {
+            throw eu;
+        }
+    }
+    /**
+     * @returns true once storage `TableSettings` have been retreived from remote storage.
+     */
+    isAvailable() {
+        // We'll just say "yes" if we have settings
+        return !!this.settings;
+    }
+    /**
+     * @returns remote storage `TableSettings` if they have been retreived by `makeAvailable`.
+     * @throws WERR_INVALID_OPERATION if `makeAvailable` has not yet been called.
+     */
+    getSettings() {
+        if (!this.settings) {
+            throw new WERR_errors_1.WERR_INVALID_OPERATION('call makeAvailable at least once before getSettings');
+        }
+        return this.settings;
+    }
+    /**
+     * Must be called prior to making use of storage.
+     * Retreives `TableSettings` from remote storage provider.
+     * @returns remote storage `TableSettings`
+     */
+    async makeAvailable() {
+        if (!this.settings) {
+            this.settings = await this.rpcCall('makeAvailable', []);
+        }
+        return this.settings;
+    }
+    //////////////////////////////////////////////////////////////////////////////
+    //
+    // Implementation of all WalletStorage interface methods
+    // They are simple pass-thrus to rpcCall
+    //
+    // IMPORTANT: The parameter ordering must match exactly as in your interface.
+    //////////////////////////////////////////////////////////////////////////////
+    /**
+     * Called to cleanup resources when no further use of this object will occur.
+     */
+    async destroy() {
+        return this.rpcCall('destroy', []);
+    }
+    /**
+     * Requests schema migration to latest.
+     * Typically remote storage will ignore this request.
+     * @param storageName Unique human readable name for remote storage if it does not yet exist.
+     * @param storageIdentityKey Unique identity key for remote storage if it does not yet exist.
+     * @returns current schema migration identifier
+     */
+    async migrate(storageName, storageIdentityKey) {
+        return this.rpcCall('migrate', [storageName]);
+    }
+    /**
+     * Remote storage does not offer `Services` to remote clients.
+     * @throws WERR_INVALID_OPERATION
+     */
+    getServices() {
+        // Typically, the client would not store or retrieve "Services" from a remote server.
+        // The "services" in local in-memory usage is a no-op or your own approach:
+        throw new WERR_errors_1.WERR_INVALID_OPERATION('getServices() not implemented in remote client. This method typically is not used remotely.');
+    }
+    /**
+     * Ignored. Remote storage cannot share `Services` with remote clients.
+     */
+    setServices(v) {
+        // Typically no-op for remote client
+        // Because "services" are usually local definitions to the Storage.
+    }
+    /**
+     * Storage level processing for wallet `internalizeAction`.
+     * Updates internalized outputs in remote storage.
+     * Triggers proof validation of containing transaction.
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args Original wallet `internalizeAction` arguments.
+     * @returns `internalizeAction` results
+     */
+    async internalizeAction(auth, args) {
+        return this.rpcCall('internalizeAction', [auth, args]);
+    }
+    /**
+     * Storage level processing for wallet `createAction`.
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args Validated extension of original wallet `createAction` arguments.
+     * @returns `StorageCreateActionResults` supporting additional wallet processing to yield `createAction` results.
+     */
+    async createAction(auth, args) {
+        return this.rpcCall('createAction', [auth, args]);
+    }
+    /**
+     * Storage level processing for wallet `createAction` and `signAction`.
+     *
+     * Handles remaining storage tasks once a fully signed transaction has been completed. This is common to both `createAction` and `signAction`.
+     *
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args `StorageProcessActionArgs` convey completed signed transaction to storage.
+     * @returns `StorageProcessActionResults` supporting final wallet processing to yield `createAction` or `signAction` results.
+     */
+    async processAction(auth, args) {
+        return this.rpcCall('processAction', [auth, args]);
+    }
+    /**
+     * Aborts an action by `reference` string.
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args original wallet `abortAction` args.
+     * @returns `abortAction` result.
+     */
+    async abortAction(auth, args) {
+        return this.rpcCall('abortAction', [auth, args]);
+    }
+    /**
+     * Used to both find and initialize a new user by identity key.
+     * It is up to the remote storage whether to allow creation of new users by this method.
+     * @param identityKey of the user.
+     * @returns `TableUser` for the user and whether a new user was created.
+     */
+    async findOrInsertUser(identityKey) {
+        return this.rpcCall('findOrInsertUser', [identityKey]);
+    }
+    /**
+     * Used to both find and insert a `TableSyncState` record for the user to track wallet data replication across storage providers.
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param storageName the name of the remote storage being sync'd
+     * @param storageIdentityKey the identity key of the remote storage being sync'd
+     * @returns `TableSyncState` and whether a new record was created.
+     */
+    async findOrInsertSyncStateAuth(auth, storageIdentityKey, storageName) {
+        const r = await this.rpcCall('findOrInsertSyncStateAuth', [
+            auth,
+            storageIdentityKey,
+            storageName
+        ]);
+        r.syncState = this.validateEntity(r.syncState, ['when']);
+        return r;
+    }
+    /**
+     * Inserts a new certificate with fields and keyring into remote storage.
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param certificate the certificate to insert.
+     * @returns record Id of the inserted `TableCertificate` record.
+     */
+    async insertCertificateAuth(auth, certificate) {
+        const r = await this.rpcCall('insertCertificateAuth', [auth, certificate]);
+        return r;
+    }
+    /**
+     * Storage level processing for wallet `listActions`.
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args Validated extension of original wallet `listActions` arguments.
+     * @returns `listActions` results.
+     */
+    async listActions(auth, vargs) {
+        const r = await this.rpcCall('listActions', [auth, vargs]);
+        return r;
+    }
+    /**
+     * Storage level processing for wallet `listOutputs`.
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args Validated extension of original wallet `listOutputs` arguments.
+     * @returns `listOutputs` results.
+     */
+    async listOutputs(auth, vargs) {
+        const r = await this.rpcCall('listOutputs', [auth, vargs]);
+        return r;
+    }
+    /**
+     * Storage level processing for wallet `listCertificates`.
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args Validated extension of original wallet `listCertificates` arguments.
+     * @returns `listCertificates` results.
+     */
+    async listCertificates(auth, vargs) {
+        const r = await this.rpcCall('listCertificates', [auth, vargs]);
+        return r;
+    }
+    /**
+     * Find user certificates, optionally with fields.
+     *
+     * This certificate retrieval method supports internal wallet operations.
+     * Field values are stored and retrieved encrypted.
+     *
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args `FindCertificatesArgs` determines which certificates to retrieve and whether to include fields.
+     * @returns array of certificates matching args.
+     */
+    async findCertificatesAuth(auth, args) {
+        const r = await this.rpcCall('findCertificatesAuth', [auth, args]);
+        this.validateEntities(r);
+        if (args.includeFields) {
+            for (const c of r) {
+                if (c.fields)
+                    this.validateEntities(c.fields);
+            }
+        }
+        return r;
+    }
+    /**
+     * Find output baskets.
+     *
+     * This retrieval method supports internal wallet operations.
+     *
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args `FindOutputBasketsArgs` determines which baskets to retrieve.
+     * @returns array of output baskets matching args.
+     */
+    async findOutputBasketsAuth(auth, args) {
+        const r = await this.rpcCall('findOutputBaskets', [auth, args]);
+        this.validateEntities(r);
+        return r;
+    }
+    /**
+     * Find outputs.
+     *
+     * This retrieval method supports internal wallet operations.
+     *
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args `FindOutputsArgs` determines which outputs to retrieve.
+     * @returns array of outputs matching args.
+     */
+    async findOutputsAuth(auth, args) {
+        const r = await this.rpcCall('findOutputsAuth', [auth, args]);
+        this.validateEntities(r);
+        return r;
+    }
+    /**
+     * Find requests for transaction proofs.
+     *
+     * This retrieval method supports internal wallet operations.
+     *
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args `FindProvenTxReqsArgs` determines which proof requests to retrieve.
+     * @returns array of proof requests matching args.
+     */
+    async findProvenTxReqs(args) {
+        const r = await this.rpcCall('findProvenTxReqs', [args]);
+        this.validateEntities(r);
+        return r;
+    }
+    /**
+     * Relinquish a certificate.
+     *
+     * For storage supporting replication records must be kept of deletions. Therefore certificates are marked as deleted
+     * when relinquished, and no longer returned by `listCertificates`, but are still retained by storage.
+     *
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args original wallet `relinquishCertificate` args.
+     */
+    async relinquishCertificate(auth, args) {
+        return this.rpcCall('relinquishCertificate', [auth, args]);
+    }
+    /**
+     * Relinquish an output.
+     *
+     * Relinquishing an output removes the output from whatever basket was tracking it.
+     *
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args original wallet `relinquishOutput` args.
+     */
+    async relinquishOutput(auth, args) {
+        return this.rpcCall('relinquishOutput', [auth, args]);
+    }
+    /**
+     * Process a "chunk" of replication data for the user.
+     *
+     * The normal data flow is for the active storage to push backups as a sequence of data chunks to backup storage providers.
+     *
+     * @param args a copy of the replication request args that initiated the sequence of data chunks.
+     * @param chunk the current data chunk to process.
+     * @returns whether processing is done, counts of inserts and udpates, and related progress tracking properties.
+     */
+    async processSyncChunk(args, chunk) {
+        const r = await this.rpcCall('processSyncChunk', [args, chunk]);
+        return r;
+    }
+    /**
+     * Request a "chunk" of replication data for a specific user and storage provider.
+     *
+     * The normal data flow is for the active storage to push backups as a sequence of data chunks to backup storage providers.
+     * Also supports recovery where non-active storage can attempt to merge available data prior to becoming active.
+     *
+     * @param args that identify the non-active storage which will receive replication data and constrains the replication process.
+     * @returns the next "chunk" of replication data
+     */
+    async getSyncChunk(args) {
+        const r = await this.rpcCall('getSyncChunk', [args]);
+        if (r.certificateFields)
+            r.certificateFields = this.validateEntities(r.certificateFields);
+        if (r.certificates)
+            r.certificates = this.validateEntities(r.certificates);
+        if (r.commissions)
+            r.commissions = this.validateEntities(r.commissions);
+        if (r.outputBaskets)
+            r.outputBaskets = this.validateEntities(r.outputBaskets);
+        if (r.outputTagMaps)
+            r.outputTagMaps = this.validateEntities(r.outputTagMaps);
+        if (r.outputTags)
+            r.outputTags = this.validateEntities(r.outputTags);
+        if (r.outputs)
+            r.outputs = this.validateEntities(r.outputs);
+        if (r.provenTxReqs)
+            r.provenTxReqs = this.validateEntities(r.provenTxReqs);
+        if (r.provenTxs)
+            r.provenTxs = this.validateEntities(r.provenTxs);
+        if (r.transactions)
+            r.transactions = this.validateEntities(r.transactions);
+        if (r.txLabelMaps)
+            r.txLabelMaps = this.validateEntities(r.txLabelMaps);
+        if (r.txLabels)
+            r.txLabels = this.validateEntities(r.txLabels);
+        if (r.user)
+            r.user = this.validateEntity(r.user);
+        return r;
+    }
+    /**
+     * Handles the data received when a new transaction proof is found in response to an outstanding request for proof data:
+     *
+     *   - Creates a new `TableProvenTx` record.
+     *   - Notifies all user transaction records of the new status.
+     *   - Updates the proof request record to 'completed' status which enables delayed deletion.
+     *
+     * @param args proof request and new transaction proof data
+     * @returns results of updates
+     */
+    async updateProvenTxReqWithNewProvenTx(args) {
+        const r = await this.rpcCall('updateProvenTxReqWithNewProvenTx', [args]);
+        return r;
+    }
+    /**
+     * Ensures up-to-date wallet data replication to all configured backup storage providers,
+     * then promotes one of the configured backups to active,
+     * demoting the current active to new backup.
+     *
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param newActiveStorageIdentityKey which must be a currently configured backup storage provider.
+     */
+    async setActive(auth, newActiveStorageIdentityKey) {
+        return this.rpcCall('setActive', [auth, newActiveStorageIdentityKey]);
+    }
+    validateDate(date) {
+        let r;
+        if (date instanceof Date)
+            r = date;
+        else
+            r = new Date(date);
+        return r;
+    }
+    /**
+     * Helper to force uniform behavior across database engines.
+     * Use to process all individual records with time stamps retreived from database.
+     */
+    validateEntity(entity, dateFields) {
+        entity.created_at = this.validateDate(entity.created_at);
+        entity.updated_at = this.validateDate(entity.updated_at);
+        if (dateFields) {
+            for (const df of dateFields) {
+                if (entity[df])
+                    entity[df] = this.validateDate(entity[df]);
+            }
+        }
+        for (const key of Object.keys(entity)) {
+            const val = entity[key];
+            if (val === null) {
+                entity[key] = undefined;
+            }
+            else if (val instanceof Uint8Array) {
+                entity[key] = Array.from(val);
+            }
+        }
+        return entity;
+    }
+    /**
+     * Helper to force uniform behavior across database engines.
+     * Use to process all arrays of records with time stamps retreived from database.
+     * @returns input `entities` array with contained values validated.
+     */
+    validateEntities(entities, dateFields) {
+        for (let i = 0; i < entities.length; i++) {
+            entities[i] = this.validateEntity(entities[i], dateFields);
+        }
+        return entities;
+    }
+}
+exports.StorageClient = StorageClient;
+//# sourceMappingURL=StorageMobile.js.map

package/out/src/storage/remoting/StorageMobile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageMobile.js","sourceRoot":"","sources":["../../../../src/storage/remoting/StorageMobile.ts"],"names":[],"mappings":";;;AAAA,kCAYiB;AAkBjB,uDAA8D;AAW9D;;;;;;;;;;;;;GAaG;AACH,MAAa,aAAa;IAQxB,YAAY,MAAuB,EAAE,WAAmB;QALhD,WAAM,GAAG,CAAC,CAAA;QAMhB,IAAI,CAAC,UAAU,GAAG,IAAI,eAAS,CAAC,MAAM,CAAC,CAAA;QACvC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACH,iBAAiB;QACf,OAAO,KAAK,CAAA;IACd,CAAC;IAED,8EAA8E;IAC9E,kBAAkB;IAClB,8EAA8E;IAE9E;;;;OAIG;IACK,KAAK,CAAC,OAAO,CAAI,MAAc,EAAE,MAAiB;QACxD,IAAI,CAAC;YACH,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAA;YACxB,MAAM,IAAI,GAAG;gBACX,OAAO,EAAE,KAAK;gBACd,MAAM;gBACN,MAAM;gBACN,EAAE;aACH,CAAA;YAED,IAAI,QAAkB,CAAA;YACtB,IAAI,CAAC;gBACH,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE;oBACvD,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;oBAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;iBAC3B,CAAC,CAAA;YACJ,CAAC;YAAC,OAAO,EAAW,EAAE,CAAC;gBACrB,MAAM,EAAE,CAAA;YACV,CAAC;YAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,8CAA8C,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAA;YACzG,CAAC;YAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;YAClC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,KAAK,CAAA;gBAC1C,MAAM,GAAG,GAAG,IAAI,KAAK,CAAC,cAAc,OAAO,EAAE,CAAC,CAE7C;gBAAC,GAAW,CAAC,IAAI,GAAG,IAAI,CACxB;gBAAC,GAAW,CAAC,IAAI,GAAG,IAAI,CAAA;gBACzB,MAAM,GAAG,CAAA;YACX,CAAC;YAED,OAAO,IAAI,CAAC,MAAM,CAAA;QACpB,CAAC;QAAC,OAAO,EAAW,EAAE,CAAC;YACrB,MAAM,EAAE,CAAA;QACV,CAAC;IACH,CAAC;IAED;;OAEG;IACH,WAAW;QACT,2CAA2C;QAC3C,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAA;IACxB,CAAC;IAED;;;OAGG;IACH,WAAW;QACT,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,MAAM,IAAI,oCAAsB,CAAC,qDAAqD,CAAC,CAAA;QACzF,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa;QACjB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAgB,eAAe,EAAE,EAAE,CAAC,CAAA;QACxE,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAED,8EAA8E;IAC9E,EAAE;IACF,wDAAwD;IACxD,wCAAwC;IACxC,EAAE;IACF,6EAA6E;IAC7E,8EAA8E;IAE9E;;OAEG;IACH,KAAK,CAAC,OAAO;QACX,OAAO,IAAI,CAAC,OAAO,CAAO,SAAS,EAAE,EAAE,CAAC,CAAA;IAC1C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,CAAC,WAAmB,EAAE,kBAA0B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAS,SAAS,EAAE,CAAC,WAAW,CAAC,CAAC,CAAA;IACvD,CAAC;IAED;;;OAGG;IACH,WAAW;QACT,qFAAqF;QACrF,2EAA2E;QAC3E,MAAM,IAAI,oCAAsB,CAC9B,6FAA6F,CAC9F,CAAA;IACH,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,CAAiB;QAC3B,oCAAoC;QACpC,mEAAmE;IACrE,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,iBAAiB,CAAC,IAAY,EAAE,IAA2B;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAiC,mBAAmB,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;IACxF,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,IAAsC;QACrE,OAAO,IAAI,CAAC,OAAO,CAA4B,cAAc,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;IAC9E,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,aAAa,CAAC,IAAY,EAAE,IAA8B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAA8B,eAAe,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;IACjF,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,IAAY,EAAE,IAAqB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAoB,aAAa,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;IACrE,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,gBAAgB,CAAC,WAAW;QAChC,OAAO,IAAI,CAAC,OAAO,CAAsC,kBAAkB,EAAE,CAAC,WAAW,CAAC,CAAC,CAAA;IAC7F,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,yBAAyB,CAC7B,IAAY,EACZ,kBAA0B,EAC1B,WAAmB;QAEnB,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,CAAgD,2BAA2B,EAAE;YACvG,IAAI;YACJ,kBAAkB;YAClB,WAAW;SACZ,CAAC,CAAA;QACF,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC,CAAA;QACxD,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,qBAAqB,CAAC,IAAY,EAAE,WAA8B;QACtE,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,CAAS,uBAAuB,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAA;QAClF,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,IAAY,EAAE,KAAsC;QACpE,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,CAAoB,aAAa,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAA;QAC7E,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,IAAY,EAAE,KAAsC;QACpE,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,CAAoB,aAAa,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAA;QAC7E,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,gBAAgB,CAAC,IAAY,EAAE,KAA2C;QAC9E,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,CAAyB,kBAAkB,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAA;QACvF,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,oBAAoB,CAAC,IAAY,EAAE,IAA0B;QACjE,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,CAAsB,sBAAsB,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;QACvF,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAA;QACxB,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,KAAK,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClB,IAAI,CAAC,CAAC,MAAM;oBAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;YAC/C,CAAC;QACH,CAAC;QACD,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,qBAAqB,CAAC,IAAY,EAAE,IAA2B;QACnE,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,CAAsB,mBAAmB,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;QACpF,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAA;QACxB,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,eAAe,CAAC,IAAY,EAAE,IAAqB;QACvD,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,CAAgB,iBAAiB,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;QAC5E,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAA;QACxB,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,gBAAgB,CAAC,IAA0B;QAC/C,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,CAAqB,kBAAkB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAA;QAC5E,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAA;QACxB,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,qBAAqB,CAAC,IAAY,EAAE,IAA+B;QACvE,OAAO,IAAI,CAAC,OAAO,CAAS,uBAAuB,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;IACpE,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,gBAAgB,CAAC,IAAY,EAAE,IAA0B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAS,kBAAkB,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;IAC/D,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,gBAAgB,CAAC,IAA0B,EAAE,KAAgB;QACjE,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,CAAyB,kBAAkB,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAA;QACvF,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,YAAY,CAAC,IAA0B;QAC3C,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,CAAY,cAAc,EAAE,CAAC,IAAI,CAAC,CAAC,CAAA;QAC/D,IAAI,CAAC,CAAC,iBAAiB;YAAE,CAAC,CAAC,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAA;QACzF,IAAI,CAAC,CAAC,YAAY;YAAE,CAAC,CAAC,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAA;QAC1E,IAAI,CAAC,CAAC,WAAW;YAAE,CAAC,CAAC,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,WAAW,CAAC,CAAA;QACvE,IAAI,CAAC,CAAC,aAAa;YAAE,CAAC,CAAC,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,aAAa,CAAC,CAAA;QAC7E,IAAI,CAAC,CAAC,aAAa;YAAE,CAAC,CAAC,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,aAAa,CAAC,CAAA;QAC7E,IAAI,CAAC,CAAC,UAAU;YAAE,CAAC,CAAC,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,UAAU,CAAC,CAAA;QACpE,IAAI,CAAC,CAAC,OAAO;YAAE,CAAC,CAAC,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;QAC3D,IAAI,CAAC,CAAC,YAAY;YAAE,CAAC,CAAC,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAA;QAC1E,IAAI,CAAC,CAAC,SAAS;YAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;QACjE,IAAI,CAAC,CAAC,YAAY;YAAE,CAAC,CAAC,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAA;QAC1E,IAAI,CAAC,CAAC,WAAW;YAAE,CAAC,CAAC,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,WAAW,CAAC,CAAA;QACvE,IAAI,CAAC,CAAC,QAAQ;YAAE,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAA;QAC9D,IAAI,CAAC,CAAC,IAAI;YAAE,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;QAChD,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,gCAAgC,CACpC,IAA0C;QAE1C,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,CAAyC,kCAAkC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAA;QAChH,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,SAAS,CAAC,IAAY,EAAE,2BAAmC;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAS,WAAW,EAAE,CAAC,IAAI,EAAE,2BAA2B,CAAC,CAAC,CAAA;IAC/E,CAAC;IAED,YAAY,CAAC,IAA4B;QACvC,IAAI,CAAO,CAAA;QACX,IAAI,IAAI,YAAY,IAAI;YAAE,CAAC,GAAG,IAAI,CAAA;;YAC7B,CAAC,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAA;QACvB,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;OAGG;IACH,cAAc,CAA4B,MAAS,EAAE,UAAqB;QACxE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;QACxD,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;QACxD,IAAI,UAAU,EAAE,CAAC;YACf,KAAK,MAAM,EAAE,IAAI,UAAU,EAAE,CAAC;gBAC5B,IAAI,MAAM,CAAC,EAAE,CAAC;oBAAE,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAA;YAC5D,CAAC;QACH,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACtC,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;YACvB,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;gBACjB,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAA;YACzB,CAAC;iBAAM,IAAI,GAAG,YAAY,UAAU,EAAE,CAAC;gBACrC,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAC/B,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAA4B,QAAa,EAAE,UAAqB;QAC9E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACzC,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAA;QAC5D,CAAC;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;CACF;AAxeD,sCAweC"}

package/out/src/storage/remoting/StorageServer.d.ts

@@ -0,0 +1,48 @@
+/**
+ * StorageServer.ts
+ *
+ * A server-side class that "has a" local WalletStorage (like a StorageKnex instance),
+ * and exposes it via a JSON-RPC POST endpoint using Express.
+ */
+import { MakeWalletLogger } from '@bsv/sdk';
+import { Request } from 'express';
+import { Wallet } from '../../Wallet';
+import { StorageProvider } from '../StorageProvider';
+import { EntityTimeStamp } from '../../sdk/types';
+export interface WalletStorageServerOptions {
+    port: number;
+    wallet: Wallet;
+    monetize: boolean;
+    calculateRequestPrice?: (req: Request) => number | Promise<number>;
+    adminIdentityKeys?: string[];
+    makeLogger?: MakeWalletLogger;
+}
+export declare class StorageServer {
+    private app;
+    private port;
+    private storage;
+    private wallet;
+    private monetize;
+    private calculateRequestPrice?;
+    private adminIdentityKeys?;
+    private makeLogger?;
+    constructor(storage: StorageProvider, options: WalletStorageServerOptions);
+    private setupRoutes;
+    private validateParam0;
+    server: any;
+    start(): void;
+    close(): Promise<void>;
+    validateDate(date: Date | string | number): Date;
+    /**
+     * Helper to force uniform behavior across database engines.
+     * Use to process all individual records with time stamps retreived from database.
+     */
+    validateEntity<T extends EntityTimeStamp>(entity: T, dateFields?: string[]): T;
+    /**
+     * Helper to force uniform behavior across database engines.
+     * Use to process all arrays of records with time stamps retreived from database.
+     * @returns input `entities` array with contained values validated.
+     */
+    validateEntities<T extends EntityTimeStamp>(entities: T[], dateFields?: string[]): T[];
+}
+//# sourceMappingURL=StorageServer.d.ts.map

package/out/src/storage/remoting/StorageServer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageServer.d.ts","sourceRoot":"","sources":["../../../../src/storage/remoting/StorageServer.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,gBAAgB,EAA0C,MAAM,UAAU,CAAA;AACnF,OAAgB,EAAE,OAAO,EAAY,MAAM,SAAS,CAAA;AAGpD,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAGpD,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAIjD,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,OAAO,CAAA;IACjB,qBAAqB,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAClE,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC5B,UAAU,CAAC,EAAE,gBAAgB,CAAA;CAC9B;AAED,qBAAa,aAAa;IACxB,OAAO,CAAC,GAAG,CAAY;IACvB,OAAO,CAAC,IAAI,CAAQ;IACpB,OAAO,CAAC,OAAO,CAAiB;IAChC,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,qBAAqB,CAAC,CAA4C;IAC1E,OAAO,CAAC,iBAAiB,CAAC,CAAU;IACpC,OAAO,CAAC,UAAU,CAAC,CAAkB;gBAEzB,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,0BAA0B;IAYzE,OAAO,CAAC,WAAW;YA2KL,cAAc;IAY5B,MAAM,EAAE,GAAG,CAAA;IAEJ,KAAK,IAAI,IAAI;IAMP,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAQnC,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI;IAOhD;;;OAGG;IACH,cAAc,CAAC,CAAC,SAAS,eAAe,EAAE,MAAM,EAAE,CAAC,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC;IAmB9E;;;;OAIG;IACH,gBAAgB,CAAC,CAAC,SAAS,eAAe,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;CAMvF"}