@bsv/wallet-toolbox 1.6.18 → 1.6.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/wallet-toolbox",
-  "version": "1.6.18",
+  "version": "1.6.20",
   "description": "BRC100 conforming wallet, wallet storage and wallet signer components",
   "main": "./out/src/index.js",
   "types": "./out/src/index.d.ts",

package/src/Wallet.ts

@@ -615,6 +615,15 @@ export class Wallet implements WalletInterface, ProtoWallet {
     return r
   }
 
+  /** 2-minute cache of trust settings for identity resolution paths */
+  private _trustSettingsCache?: {
+    expiresAt: number
+    trustSettings: Awaited<ReturnType<WalletSettingsManager['get']>>['trustSettings']
+  }
+
+  /** 2-minute cache of queryOverlay() results keyed by normalized query */
+  private _overlayCache: Map<string, { expiresAt: number; value: unknown }> = new Map()
+
   async discoverByIdentityKey(
     args: DiscoverByIdentityKeyArgs,
     originator?: OriginatorDomainNameStringUnder250Bytes
@@ -622,21 +631,42 @@ export class Wallet implements WalletInterface, ProtoWallet {
     validateOriginator(originator)
     this.validateAuthAndArgs(args, validateDiscoverByIdentityKeyArgs)
 
-    const trustSettings = (await this.settingsManager.get()).trustSettings
-    const results = await queryOverlay(
-      {
-        identityKey: args.identityKey,
-        certifiers: trustSettings.trustedCertifiers.map(certifier => certifier.identityKey)
-      },
-      this.lookupResolver
-    )
-    if (!results) {
-      return {
-        totalCertificates: 0,
-        certificates: []
-      }
+    const TTL_MS = 2 * 60 * 1000
+    const now = Date.now()
+
+    // --- trustSettings cache (2 minutes) ---
+    let trustSettings =
+      this._trustSettingsCache && this._trustSettingsCache.expiresAt > now
+        ? this._trustSettingsCache.trustSettings
+        : undefined
+
+    if (!trustSettings) {
+      const settings = await this.settingsManager.get()
+      trustSettings = settings.trustSettings
+      this._trustSettingsCache = { trustSettings, expiresAt: now + TTL_MS }
     }
-    return transformVerifiableCertificatesWithTrust(trustSettings, results)
+
+    const certifiers = trustSettings.trustedCertifiers.map(c => c.identityKey).sort()
+
+    // --- queryOverlay cache (2 minutes) ---
+    const cacheKey = JSON.stringify({
+      fn: 'discoverByIdentityKey',
+      identityKey: args.identityKey,
+      certifiers
+    })
+
+    let cached = this._overlayCache.get(cacheKey)
+    if (!cached || cached.expiresAt <= now) {
+      const value = await queryOverlay({ identityKey: args.identityKey, certifiers }, this.lookupResolver)
+      cached = { value, expiresAt: now + TTL_MS }
+      this._overlayCache.set(cacheKey, cached)
+    }
+
+    if (!cached.value) {
+      return { totalCertificates: 0, certificates: [] }
+    }
+
+    return transformVerifiableCertificatesWithTrust(trustSettings, cached.value as any)
   }
 
   async discoverByAttributes(
@@ -646,21 +676,50 @@ export class Wallet implements WalletInterface, ProtoWallet {
     validateOriginator(originator)
     this.validateAuthAndArgs(args, validateDiscoverByAttributesArgs)
 
-    const trustSettings = (await this.settingsManager.get()).trustSettings
-    const results = await queryOverlay(
-      {
-        attributes: args.attributes,
-        certifiers: trustSettings.trustedCertifiers.map(certifier => certifier.identityKey)
-      },
-      this.lookupResolver
-    )
-    if (!results) {
-      return {
-        totalCertificates: 0,
-        certificates: []
-      }
+    const TTL_MS = 2 * 60 * 1000
+    const now = Date.now()
+
+    // --- trustSettings cache (2 minutes) ---
+    let trustSettings =
+      this._trustSettingsCache && this._trustSettingsCache.expiresAt > now
+        ? this._trustSettingsCache.trustSettings
+        : undefined
+
+    if (!trustSettings) {
+      const settings = await this.settingsManager.get()
+      trustSettings = settings.trustSettings
+      this._trustSettingsCache = { trustSettings, expiresAt: now + TTL_MS }
+    }
+
+    const certifiers = trustSettings.trustedCertifiers.map(c => c.identityKey).sort()
+
+    // Normalize attributes for a stable cache key.
+    // If attributes is an object, sort its top-level keys; if it's an array, sort a shallow copy.
+    let attributesKey: unknown = args.attributes
+    if (args.attributes && typeof args.attributes === 'object') {
+      const keys = Object.keys(args.attributes as Record<string, unknown>).sort()
+      attributesKey = JSON.stringify(args.attributes, keys)
     }
-    return transformVerifiableCertificatesWithTrust(trustSettings, results)
+
+    // --- queryOverlay cache (2 minutes) ---
+    const cacheKey = JSON.stringify({
+      fn: 'discoverByAttributes',
+      attributes: attributesKey,
+      certifiers
+    })
+
+    let cached = this._overlayCache.get(cacheKey)
+    if (!cached || cached.expiresAt <= now) {
+      const value = await queryOverlay({ attributes: args.attributes, certifiers }, this.lookupResolver)
+      cached = { value, expiresAt: now + TTL_MS }
+      this._overlayCache.set(cacheKey, cached)
+    }
+
+    if (!cached.value) {
+      return { totalCertificates: 0, certificates: [] }
+    }
+
+    return transformVerifiableCertificatesWithTrust(trustSettings, cached.value as any)
   }
 
   verifyReturnedTxidOnly(beef: Beef, knownTxids?: string[]): Beef {

package/src/index.all.ts

@@ -19,6 +19,7 @@ export * from './SimpleWalletManager'
 export * from './wab-client/auth-method-interactors/AuthMethodInteractor'
 export * from './wab-client/auth-method-interactors/PersonaIDInteractor'
 export * from './wab-client/auth-method-interactors/TwilioPhoneInteractor'
+export * from './wab-client/auth-method-interactors/DevConsoleInteractor'
 export * from './wab-client/WABClient'
 export * from './Wallet'
 export * from './WalletAuthenticationManager'

package/src/index.client.ts

@@ -17,6 +17,7 @@ export * from './SimpleWalletManager'
 export * from './wab-client/auth-method-interactors/AuthMethodInteractor'
 export * from './wab-client/auth-method-interactors/PersonaIDInteractor'
 export * from './wab-client/auth-method-interactors/TwilioPhoneInteractor'
+export * from './wab-client/auth-method-interactors/DevConsoleInteractor'
 export * from './wab-client/WABClient'
 export * from './Wallet'
 export * from './WalletAuthenticationManager'

package/src/index.mobile.ts

@@ -13,6 +13,7 @@ export * from './SimpleWalletManager'
 export * from './wab-client/auth-method-interactors/AuthMethodInteractor'
 export * from './wab-client/auth-method-interactors/PersonaIDInteractor'
 export * from './wab-client/auth-method-interactors/TwilioPhoneInteractor'
+export * from './wab-client/auth-method-interactors/DevConsoleInteractor'
 export * from './wab-client/WABClient'
 export * from './Wallet'
 export * from './WalletAuthenticationManager'

package/src/wab-client/auth-method-interactors/DevConsoleInteractor.ts

@@ -0,0 +1,73 @@
+import { AuthMethodInteractor, AuthPayload, StartAuthResponse, CompleteAuthResponse } from './AuthMethodInteractor'
+
+/**
+ * DevConsoleInteractor
+ *
+ * A client-side class that knows how to call the WAB server for DevConsole-based authentication.
+ * This is a development-only auth method that generates OTP codes and logs them to the console.
+ */
+export class DevConsoleInteractor extends AuthMethodInteractor {
+  public methodType = 'DevConsole'
+
+  /**
+   * Start the DevConsole authentication on the server.
+   * - The server will generate an OTP code and log it to the console for development use.
+   * @param serverUrl         - The base URL of the WAB server (e.g. http://localhost:3000)
+   * @param presentationKey   - The 256-bit key the client is attempting to authenticate with
+   * @param payload           - { phoneNumber: string } (identifier for the authentication)
+   * @returns                 - { success, message, data }
+   */
+  public async startAuth(serverUrl: string, presentationKey: string, payload: AuthPayload): Promise<StartAuthResponse> {
+    const res = await fetch(`${serverUrl}/auth/start`, {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify({
+        methodType: this.methodType,
+        presentationKey,
+        payload
+      })
+    })
+
+    if (!res.ok) {
+      return {
+        success: false,
+        message: `HTTP error ${res.status}`
+      }
+    }
+
+    return res.json()
+  }
+
+  /**
+   * Complete the DevConsole authentication on the server.
+   * - The server will verify the OTP code that was generated and logged to the console.
+   * @param serverUrl         - The base URL of the WAB server
+   * @param presentationKey   - The 256-bit key
+   * @param payload           - { phoneNumber: string, otp: string } (the identifier and OTP code from console)
+   * @returns                 - { success, message, presentationKey }
+   */
+  public async completeAuth(
+    serverUrl: string,
+    presentationKey: string,
+    payload: AuthPayload
+  ): Promise<CompleteAuthResponse> {
+    const res = await fetch(`${serverUrl}/auth/complete`, {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify({
+        methodType: this.methodType,
+        presentationKey,
+        payload
+      })
+    })
+
+    if (!res.ok) {
+      return {
+        success: false,
+        message: `HTTP error ${res.status}`
+      }
+    }
+
+    return res.json()
+  }
+}