@bopen-io/wallet-toolbox 2.1.21-parity-fix.2 → 2.6.2-brc153.2

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

@@ -4,45 +4,142 @@
  * 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 { MakeWalletLogger, TelemetryConfig } from '@bsv/sdk';
 import { Request } from 'express';
+import { AuthMiddlewareOptions } from '@bsv/auth-express-middleware';
+import type { PaymentReplayStore } from '@bsv/payment-express-middleware';
+import { Options as RateLimitOptions } from 'express-rate-limit';
 import { Wallet } from '../../Wallet';
 import { StorageProvider } from '../StorageProvider';
 import { EntityTimeStamp } from '../../sdk/types';
+import { TrustProxySetting } from './RateLimitPolicy';
+import { type HttpServerPolicyDefaults, type SecurityHeadersOptions } from './edgePolicy';
 export interface WalletStorageServerOptions {
+    /** Listener bind host. Omit to retain Node's historical all-interface behavior. */
+    host?: string;
     port: number;
     wallet: Wallet;
     monetize: boolean;
     calculateRequestPrice?: (req: Request) => number | Promise<number>;
     adminIdentityKeys?: string[];
     makeLogger?: MakeWalletLogger;
+    /**
+     * Shared BRC-103 session storage for multi-process or multi-replica servers.
+     * Defaults to the auth middleware's in-process SessionManager.
+     */
+    sessionManager?: AuthMiddlewareOptions['sessionManager'];
+    /**
+     * Authenticated request rate limiting. Defaults to 1,000 requests per
+     * identity key per minute. Override the store for shared enforcement across
+     * multiple server processes or replicas.
+     */
+    rateLimit?: Partial<RateLimitOptions>;
+    /**
+     * Pre-authentication IP rate limiting. Defaults to 300 requests per minute.
+     * Use a shared store when multiple server processes or replicas must enforce
+     * one aggregate limit.
+     */
+    preAuthRateLimit?: Partial<RateLimitOptions>;
+    /**
+     * Explicit Express proxy trust policy. Omit for the secure direct-socket
+     * default. Prefer a known hop count, subnet, or predicate; permissive
+     * `true` is intentionally unsupported.
+     */
+    trustProxy?: TrustProxySetting;
+    /** Exact browser origins allowed to call this server. Omit for public CORS. */
+    allowedOrigins?: string[];
+    /** Per-process in-flight request ceiling. Defaults to the selected resource profile (24 in standard). */
+    maxConcurrentRequests?: number;
+    /** Node HTTP timeout/connection policy overrides. */
+    http?: Partial<HttpServerPolicyDefaults>;
+    /** Security response-header and CSP overrides. */
+    securityHeaders?: SecurityHeadersOptions;
+    /** Emit one JSON log record for each authenticated RPC. Default: true. */
+    logRpcRequests?: boolean;
+    /** @deprecated Use structured RPC logging. Retained for compatibility. */
+    logShortReqs?: boolean;
+    /**
+     * Optional provider-neutral timing for ingress, authentication, RPC
+     * authorization, storage dispatch, and response formulation.
+     */
+    telemetry?: TelemetryConfig;
+    /** Default item limit inserted for list/find RPC calls that omit one. Default: 1,000. */
+    defaultRpcListLimit?: number;
+    /** Largest caller-selected list/find item limit. Use -1 to disable this operator ceiling. */
+    maxRpcListLimit?: number;
+    /** Maximum elements in any decoded request array. Use -1 only for trusted callers. */
+    maxRpcArrayItems?: number;
+    /** Maximum serialized JSON-RPC response bytes. Use -1 to disable. */
+    maxRpcResponseBytes?: number;
+    /** Durable BRC-105 replay claims for monetized multi-replica deployments. */
+    paymentReplayStore?: PaymentReplayStore;
 }
 export declare class StorageServer {
-    private app;
-    private port;
-    private storage;
-    private wallet;
-    private monetize;
-    private calculateRequestPrice?;
-    private adminIdentityKeys?;
-    private makeLogger?;
+    private readonly app;
+    private readonly host?;
+    private readonly port;
+    private readonly storage;
+    private readonly wallet;
+    private readonly monetize;
+    private readonly calculateRequestPrice?;
+    private readonly adminIdentityKeys?;
+    private readonly makeLogger?;
+    private readonly sessionManager?;
+    private readonly rateLimitOptions?;
+    private readonly preAuthRateLimitOptions?;
+    private readonly trustProxy?;
+    private readonly allowedOrigins?;
+    private readonly maxConcurrentRequests;
+    private readonly httpPolicy;
+    private readonly securityHeadersPolicy;
+    private readonly logRpcRequests;
+    private readonly telemetry;
+    private readonly telemetryConfig?;
+    private readonly defaultRpcListLimit;
+    private readonly maxRpcListLimit;
+    private readonly maxRpcArrayItems;
+    private readonly maxRpcResponseBytes;
+    private readonly paymentReplayStore?;
     constructor(storage: StorageProvider, options: WalletStorageServerOptions);
     private setupShortReqLogging;
     private setupRoutes;
+    private handleRpcRequest;
+    private handleRpcRequestCore;
+    private traceHttpRequest;
+    private sendRpc;
+    private enforceRpcRequestBudgets;
+    private enforceRpcArrayBudget;
+    private objectArgument;
+    private normalizedRpcLimit;
+    private sendRpcError;
+    private createRpcLog;
+    private dispatchRpcCall;
+    private traceRpcStep;
+    private authorizeRpcCall;
+    private logIgnoredDestroy;
+    private authorizeAdminStats;
+    private authorizeStandardRpcCall;
+    private createRpcLogger;
+    private finishRpcLogging;
+    private authenticatedAuth;
+    private bindAuthenticatedAuth;
     private validateParam0;
     server: any;
     start(): void;
     close(): Promise<void>;
+    /** @see {@link validateDate} */
     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.
+     * @see {@link validateEntity}
      */
     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.
+     * @see {@link validateEntities}
      */
     validateEntities<T extends EntityTimeStamp>(entities: T[], dateFields?: string[]): T[];
 }

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

@@ -1 +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;IAgBzE,OAAO,CAAC,oBAAoB;IA0C5B,OAAO,CAAC,WAAW;YAyLL,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"}
+{"version":3,"file":"StorageServer.d.ts","sourceRoot":"","sources":["../../../../src/storage/remoting/StorageServer.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,gBAAgB,EAEhB,eAAe,EAIhB,MAAM,UAAU,CAAA;AACjB,OAAgB,EAAE,OAAO,EAAY,MAAM,SAAS,CAAA;AACpD,OAAO,EAAE,qBAAqB,EAAqC,MAAM,8BAA8B,CAAA;AAEvG,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AACzE,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAa,MAAM,oBAAoB,CAAA;AAC3E,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAGpD,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAYjD,OAAO,EAAmE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACtH,OAAO,EAWL,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC5B,MAAM,cAAc,CAAA;AAkHrB,MAAM,WAAW,0BAA0B;IACzC,mFAAmF;IACnF,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,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;IAC7B;;;OAGG;IACH,cAAc,CAAC,EAAE,qBAAqB,CAAC,gBAAgB,CAAC,CAAA;IACxD;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAA;IACrC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAC5C;;;;OAIG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAC9B,+EAA+E;IAC/E,cAAc,CAAC,EAAE,MAAM,EAAE,CAAA;IACzB,yGAAyG;IACzG,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,qDAAqD;IACrD,IAAI,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,CAAA;IACxC,kDAAkD;IAClD,eAAe,CAAC,EAAE,sBAAsB,CAAA;IACxC,0EAA0E;IAC1E,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,0EAA0E;IAC1E,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;;OAGG;IACH,SAAS,CAAC,EAAE,eAAe,CAAA;IAC3B,yFAAyF;IACzF,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,6FAA6F;IAC7F,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,sFAAsF;IACtF,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,qEAAqE;IACrE,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,6EAA6E;IAC7E,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;CACxC;AAED,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAY;IAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAQ;IAC9B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAQ;IAC7B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAiB;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAC/B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAA4C;IACnF,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAU;IAC7C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAkB;IAC9C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAyC;IACzE,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAA2B;IAC7D,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAC,CAA2B;IACpE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAmB;IAC/C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAU;IAC1C,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAQ;IAC9C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA0B;IACrD,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAwB;IAC9D,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAS;IACxC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;IACrC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAiB;IAClD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAQ;IAC5C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAQ;IACxC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAQ;IACzC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAQ;IAC5C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAoB;IAExD,YAAY,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,0BAA0B,EAiFxE;IAED,OAAO,CAAC,oBAAoB;IA4B5B,OAAO,CAAC,WAAW;YA0JL,gBAAgB;YAiBhB,oBAAoB;IAiClC,OAAO,CAAC,gBAAgB;IAiCxB,OAAO,CAAC,OAAO;IAkBf,OAAO,CAAC,wBAAwB;IA8BhC,OAAO,CAAC,qBAAqB;IAoB7B,OAAO,CAAC,cAAc;IAatB,OAAO,CAAC,kBAAkB;IAc1B,OAAO,CAAC,YAAY;IAapB,OAAO,CAAC,YAAY;YAqBN,eAAe;YAsCf,YAAY;YAmBZ,gBAAgB;IA8B9B,OAAO,CAAC,iBAAiB;IAOzB,OAAO,CAAC,mBAAmB;YAUb,wBAAwB;IAQtC,OAAO,CAAC,eAAe;IAavB,OAAO,CAAC,gBAAgB;YAWV,iBAAiB;YAcjB,qBAAqB;YAerB,cAAc;IAe5B,MAAM,EAAE,GAAG,CAAA;IAEJ,KAAK,IAAI,IAAI,CAOnB;IAEY,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAMlC;IAED,gCAAgC;IAChC,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAE/C;IAED;;;;OAIG;IACH,cAAc,CAAC,CAAC,SAAS,eAAe,EAAE,MAAM,EAAE,CAAC,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,CAE7E;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,CAAC,SAAS,eAAe,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,CAErF;CACF"}