@bsv/wallet-toolbox 1.7.1 → 1.7.3

package/src/storage/remoting/StorageMobile.ts

@@ -2,14 +2,14 @@ import {
   AbortActionArgs,
   AbortActionResult,
   InternalizeActionArgs,
-  InternalizeActionResult,
   ListActionsResult,
   ListCertificatesResult,
   ListOutputsResult,
   RelinquishCertificateArgs,
   RelinquishOutputArgs,
   WalletInterface,
-  AuthFetch
+  AuthFetch,
+  Validation
 } from '@bsv/sdk'
 import {
   AuthId,
@@ -30,12 +30,6 @@ import {
 } from '../../sdk/WalletStorage.interfaces'
 import { WERR_INVALID_OPERATION } from '../../sdk/WERR_errors'
 import { WalletServices } from '../../sdk/WalletServices.interfaces'
-import {
-  ValidCreateActionArgs,
-  ValidListActionsArgs,
-  ValidListCertificatesArgs,
-  ValidListOutputsArgs
-} from '../../sdk/validationHelpers'
 import { TableSettings } from '../schema/tables/TableSettings'
 import { TableUser } from '../schema/tables/TableUser'
 import { TableSyncState } from '../schema/tables/TableSyncState'
@@ -229,7 +223,7 @@ export class StorageClient implements WalletStorageProvider {
    * @param args Validated extension of original wallet `createAction` arguments.
    * @returns `StorageCreateActionResults` supporting additional wallet processing to yield `createAction` results.
    */
-  async createAction(auth: AuthId, args: ValidCreateActionArgs): Promise<StorageCreateActionResult> {
+  async createAction(auth: AuthId, args: Validation.ValidCreateActionArgs): Promise<StorageCreateActionResult> {
     return this.rpcCall<StorageCreateActionResult>('createAction', [auth, args])
   }
 
@@ -309,7 +303,7 @@ export class StorageClient implements WalletStorageProvider {
    * @param args Validated extension of original wallet `listActions` arguments.
    * @returns `listActions` results.
    */
-  async listActions(auth: AuthId, vargs: ValidListActionsArgs): Promise<ListActionsResult> {
+  async listActions(auth: AuthId, vargs: Validation.ValidListActionsArgs): Promise<ListActionsResult> {
     const r = await this.rpcCall<ListActionsResult>('listActions', [auth, vargs])
     return r
   }
@@ -321,7 +315,7 @@ export class StorageClient implements WalletStorageProvider {
    * @param args Validated extension of original wallet `listOutputs` arguments.
    * @returns `listOutputs` results.
    */
-  async listOutputs(auth: AuthId, vargs: ValidListOutputsArgs): Promise<ListOutputsResult> {
+  async listOutputs(auth: AuthId, vargs: Validation.ValidListOutputsArgs): Promise<ListOutputsResult> {
     const r = await this.rpcCall<ListOutputsResult>('listOutputs', [auth, vargs])
     return r
   }
@@ -333,7 +327,7 @@ export class StorageClient implements WalletStorageProvider {
    * @param args Validated extension of original wallet `listCertificates` arguments.
    * @returns `listCertificates` results.
    */
-  async listCertificates(auth: AuthId, vargs: ValidListCertificatesArgs): Promise<ListCertificatesResult> {
+  async listCertificates(auth: AuthId, vargs: Validation.ValidListCertificatesArgs): Promise<ListCertificatesResult> {
     const r = await this.rpcCall<ListCertificatesResult>('listCertificates', [auth, vargs])
     return r
   }

package/src/storage/remoting/StorageServer.ts

@@ -5,7 +5,7 @@
  * and exposes it via a JSON-RPC POST endpoint using Express.
  */
 
-import { WalletInterface } from '@bsv/sdk'
+import { MakeWalletLogger, WalletInterface, WalletLoggerInterface } from '@bsv/sdk'
 import express, { Request, Response } from 'express'
 import { AuthMiddlewareOptions, createAuthMiddleware } from '@bsv/auth-express-middleware'
 import { createPaymentMiddleware } from '@bsv/payment-express-middleware'
@@ -15,6 +15,7 @@ import { WERR_UNAUTHORIZED } from '../../sdk/WERR_errors'
 import { SyncChunk } from '../../sdk/WalletStorage.interfaces'
 import { EntityTimeStamp } from '../../sdk/types'
 import { WalletError } from '../../sdk/WalletError'
+import { logWalletError } from '../../WalletLogger'
 
 export interface WalletStorageServerOptions {
   port: number
@@ -22,6 +23,7 @@ export interface WalletStorageServerOptions {
   monetize: boolean
   calculateRequestPrice?: (req: Request) => number | Promise<number>
   adminIdentityKeys?: string[]
+  makeLogger?: MakeWalletLogger
 }
 
 export class StorageServer {
@@ -32,6 +34,7 @@ export class StorageServer {
   private monetize: boolean
   private calculateRequestPrice?: (req: Request) => number | Promise<number>
   private adminIdentityKeys?: string[]
+  private makeLogger?: MakeWalletLogger
 
   constructor(storage: StorageProvider, options: WalletStorageServerOptions) {
     this.storage = storage
@@ -40,6 +43,7 @@ export class StorageServer {
     this.monetize = options.monetize
     this.calculateRequestPrice = options.calculateRequestPrice
     this.adminIdentityKeys = options.adminIdentityKeys
+    this.makeLogger = options.makeLogger
 
     this.setupRoutes()
   }
@@ -154,10 +158,35 @@ export class StorageServer {
               }
               break
           }
-          console.log(`StorageServer: method=${method} params=${JSON.stringify(params).slice(0, 512)}`)
-          const result = await (this.storage as any)[method](...(params || []))
-          console.log(`StorageServer: method=${method} result=${JSON.stringify(result || 'void').slice(0, 512)}`)
-          return res.json({ jsonrpc: '2.0', result, id })
+
+          // If makeLogger is valid, setup and potentially initialize to return data
+          let logger: WalletLoggerInterface | undefined
+          if (this.makeLogger && typeof params[1] === 'object') {
+            logger = this.makeLogger(params[1]['logger'])
+            params[1]['logger'] = logger
+            logger.group(`StorageSever ${method}`)
+          }
+
+          try {
+            const result = await (this.storage as any)[method](...(params || []))
+
+            if (logger) {
+              logger.groupEnd()
+              logger.flush?.()
+              if (logger.isOrigin) {
+                // Potentially only flush if isOrigin...
+              } else if (logger.logs && typeof result === 'object') {
+                // If not the start of logging, return logged data with result.
+                result['log'] = { logs: logger.logs }
+              }
+            }
+
+            return res.json({ jsonrpc: '2.0', result, id })
+          } catch (eu: unknown) {
+            logWalletError(eu, logger, 'error executing requested method')
+            logger?.flush?.()
+            throw eu
+          }
         } else {
           // Unknown method
           return res.status(400).json({
@@ -198,12 +227,22 @@ export class StorageServer {
     if (params[0]['identityKey']) params[0].userId = user.userId
   }
 
+  server: any
+
   public start(): void {
-    this.app.listen(this.port, () => {
+    this.server = this.app.listen(this.port, () => {
       console.log(`WalletStorageServer listening at http://localhost:${this.port}`)
     })
   }
 
+  public async close(): Promise<void> {
+    if (this.server) {
+      await this.server.close(() => {
+        console.log('WalletStorageServer closed')
+      })
+    }
+  }
+
   validateDate(date: Date | string | number): Date {
     let r: Date
     if (date instanceof Date) r = date

package/src/storage/remoting/__test/StorageClient.test.ts

@@ -0,0 +1,113 @@
+import { CreateActionArgs, WalletLoggerInterface } from '@bsv/sdk'
+import { _tu, TestWalletNoSetup, TestWalletOnly } from '../../../../test/utils/TestUtilsWalletStorage'
+import { wait } from '../../../utility/utilityHelpers'
+import { WalletLogger } from '../../../WalletLogger'
+import { StorageServer, WalletStorageServerOptions } from '../StorageServer'
+import { StorageClient } from '../StorageClient'
+
+describe('StorageClient tests', () => {
+  jest.setTimeout(99999999)
+
+  let server: { setup: TestWalletNoSetup; server: StorageServer }
+
+  let client: TestWalletOnly
+
+  beforeAll(async () => {
+    server = await createStorageServer()
+
+    client = await _tu.createTestWalletWithStorageClient({
+      rootKeyHex: server.setup.rootKey.toHex(),
+      endpointUrl: 'http://localhost:8042',
+      chain: server.setup.chain
+    })
+  })
+
+  afterAll(async () => {
+    await client.wallet.destroy()
+    await server.server.close()
+    await server.setup.wallet.destroy()
+  })
+
+  test('0 repeatable createAction', async () => {
+    const storageClient = client.storage.getActive() as StorageClient
+    const u = await storageClient.findOrInsertUser(server.setup.identityKey)
+    expect(u).toBeTruthy()
+  })
+
+  test('1 repeatable createAction', async () => {
+    const wallet = client.wallet
+    //wallet.makeLogger = () => console
+    wallet.makeLogger = () => new WalletLogger()
+    wallet.randomVals = [0.1, 0.2, 0.3, 0.7, 0.8, 0.9]
+    const root = '02135476'
+    const kp = _tu.getKeyPair(root.repeat(8))
+    const createArgs: CreateActionArgs = {
+      description: `repeatable`,
+      outputs: [
+        {
+          satoshis: 45,
+          lockingScript: _tu.getLockP2PKH(kp.address).toHex(),
+          outputDescription: 'pay echo'
+        }
+      ],
+      options: {
+        randomizeOutputs: false,
+        signAndProcess: true,
+        noSend: true
+      }
+    }
+
+    const cr = await wallet.createAction(createArgs)
+    expect(cr.txid === '4f428a93c43c2d120204ecdc06f7916be8a5f4542cc8839a0fd79bd1b44582f3')
+  })
+
+  test('1a error createAction', async () => {
+    if (_tu.noEnv('main')) return
+
+    const wallet = client.wallet
+    //wallet.makeLogger = () => console
+    wallet.makeLogger = () => new WalletLogger()
+    wallet.randomVals = [0.1, 0.2, 0.3, 0.7, 0.8, 0.9]
+    const root = '02135476'
+    const kp = _tu.getKeyPair(root.repeat(8))
+    const createArgs: CreateActionArgs = {
+      description: `error`,
+      outputs: [
+        {
+          satoshis: 45,
+          lockingScript: _tu.getLockP2PKH(kp.address).toHex(),
+          outputDescription: 'pay echo'
+        }
+      ],
+      options: {
+        randomizeOutputs: false,
+        signAndProcess: true,
+        noSend: false,
+        acceptDelayedBroadcast: false
+      }
+    }
+
+    const cr = await wallet.createAction(createArgs)
+    expect(cr.txid === '4f428a93c43c2d120204ecdc06f7916be8a5f4542cc8839a0fd79bd1b44582f3')
+  })
+})
+
+async function createStorageServer(): Promise<{ setup: TestWalletNoSetup; server: StorageServer }> {
+  const setup = await _tu.createLegacyWalletSQLiteCopy('StorageClientTest')
+
+  const options: WalletStorageServerOptions = {
+    port: Number(8042),
+    wallet: setup.wallet,
+    monetize: false,
+    adminIdentityKeys: [],
+    calculateRequestPrice: async () => {
+      return 0 // Monetize your server here! Price is in satoshis.
+    },
+    makeLogger: (log?: string | WalletLoggerInterface) => new WalletLogger(log)
+  }
+  const server = new StorageServer(setup.activeStorage, options)
+
+  server.start()
+
+  return { setup, server }
+}

package/src/storage/sync/StorageMySQLDojoReader.ts

@@ -1,4 +1,4 @@
-import { Utils } from '@bsv/sdk'
+import { Utils, Validation } from '@bsv/sdk'
 import { Knex } from 'knex'
 import { StorageReader, StorageReaderOptions } from '../StorageReader'
 import { TableSettings } from '../schema/tables/TableSettings'
@@ -46,7 +46,6 @@ import { asArray, asString } from '../../utility/utilityHelpers.buffer'
 import { TableTxLabelMap } from '../schema/tables/TableTxLabelMap'
 import { TableOutputTagMap } from '../schema/tables/TableOutputTagMap'
 import { TableMonitorEvent } from '../schema/tables/TableMonitorEvent'
-import { isHexString } from '../../sdk/validationHelpers'
 
 export interface StorageMySQLDojoReaderOptions extends StorageReaderOptions {
   chain: Chain
@@ -692,6 +691,6 @@ function convertSyncStatus(status: DojoSyncStatus): SyncStatus {
 
 function forceToBase64(s?: string | null): string {
   if (!s) return randomBytesBase64(12)
-  if (isHexString(s)) return Utils.toBase64(asArray(s.trim()))
+  if (Validation.isHexString(s)) return Utils.toBase64(asArray(s.trim()))
   return s.trim()
 }

package/test/Wallet/certificate/listCertificates.test.ts

@@ -1,4 +1,4 @@
-import { OriginatorDomainNameStringUnder250Bytes } from '@bsv/sdk'
+import { OriginatorDomainNameStringUnder250Bytes, Validation } from '@bsv/sdk'
 import { listCertificates } from '../../../src/storage/methods/listCertificates'
 import { StorageProvider } from '../../../src/storage/StorageProvider'
 import { sdk, TableCertificate, TableCertificateField } from '../../../src/index.all'
@@ -11,7 +11,7 @@ describe('listCertificates', () => {
   let auth: sdk.AuthId
 
   // This is a valid, minimal set of arguments for listCertificates
-  let vargs: sdk.ValidListCertificatesArgs
+  let vargs: Validation.ValidListCertificatesArgs
   let originator: OriginatorDomainNameStringUnder250Bytes | undefined
 
   // Helper so we can easily mock the transaction call

package/test/Wallet/local/localWallet2.man.test.ts

@@ -1,7 +1,7 @@
-import { Beef, PrivateKey, SignActionArgs, WalletOutput } from '@bsv/sdk'
-import { sdk, Services, Setup, StorageKnex, TableUser } from '../../../src'
-import { _tu, TuEnv } from '../../utils/TestUtilsWalletStorage'
-import { specOpInvalidChange, ValidListOutputsArgs, WERR_REVIEW_ACTIONS } from '../../../src/sdk'
+import { Beef, PrivateKey, SignActionArgs, WalletOutput, Validation } from '@bsv/sdk'
+import { sdk, Setup, TableUser } from '../../../src'
+import { _tu } from '../../utils/TestUtilsWalletStorage'
+import { specOpInvalidChange, WERR_REVIEW_ACTIONS } from '../../../src/sdk'
 import {
   burnOneSatTestOutput,
   createMainReviewSetup,
@@ -104,7 +104,7 @@ describe('localWallet2 tests', () => {
     const users = await storage.findUsers({ partial: {} })
     const withInvalid: Record<number, { user: TableUser; outputs: WalletOutput[]; total: number }> = {}
     // [76, 48, 166, 94, 110, 111, 81]
-    const vargs: ValidListOutputsArgs = {
+    const vargs: Validation.ValidListOutputsArgs = {
       basket: specOpInvalidChange,
       tags: [],
       tagQueryMode: 'all',

package/test/Wallet/signAction/mountaintop.man.test.ts

@@ -8,10 +8,11 @@ import {
   Transaction,
   TransactionSignature,
   UnlockingScript,
-  Utils
+  Utils,
+  Validation
 } from '@bsv/sdk'
 import { Setup, verifyInteger, verifyTruthy, Wallet } from '../../../src'
-import { parseWalletOutpoint } from '../../../src/sdk'
+const parseWalletOutpoint = Validation.parseWalletOutpoint
 
 describe('mountaintop tests', () => {
   jest.setTimeout(99999999)

package/test/Wallet/support/operations.man.test.ts

@@ -1,8 +1,7 @@
-import { Beef, MerklePath, Transaction, Utils, WalletOutput } from '@bsv/sdk'
-import { sdk, TableOutput, TableUser, verifyOne, verifyOneOrNone } from '../../../src'
+import { Beef, MerklePath, Transaction, WalletOutput, Validation, Utils } from '@bsv/sdk'
+import { TableOutput, TableUser, verifyOne, verifyOneOrNone } from '../../../src'
 import { _tu, logger } from '../../utils/TestUtilsWalletStorage'
-import { specOpInvalidChange, ValidListOutputsArgs } from '../../../src/sdk'
-import { LocalWalletTestOptions } from '../../utils/localWalletMethods'
+import { specOpInvalidChange } from '../../../src/sdk'
 import { Format } from '../../../src/utility/Format'
 import { asString } from '../../../src/utility/utilityHelpers.noBuffer'
 
@@ -13,7 +12,7 @@ describe('operations.man tests', () => {
     const { env, storage } = await _tu.createMainReviewSetup()
     const users = await storage.findUsers({ partial: { userId: 124 } })
     const withInvalid: Record<number, { user: TableUser; outputs: WalletOutput[]; total: number }> = {}
-    const vargs: ValidListOutputsArgs = {
+    const vargs: Validation.ValidListOutputsArgs = {
       basket: specOpInvalidChange,
       tags: ['release'],
       tagQueryMode: 'all',
@@ -298,7 +297,7 @@ describe('operations.man tests', () => {
     await storage.destroy()
   })
 
-  test('14 review inputs of tx utxo status', async () => {
+  test('14 review utxo status of inputs of tx', async () => {
     const { env, storage, services } = await _tu.createMainReviewSetup()
 
     const tx = Transaction.fromHex(testTxInputUtxoStatus)
@@ -327,6 +326,66 @@ describe('operations.man tests', () => {
     await storage.destroy()
   })
 
+  test('14a review utxo status of custom spentBy null spendable false outputs', async () => {
+    const { env, storage, services } = await _tu.createMainReviewSetup()
+
+    let offset = 0
+    const limit = 100
+
+    for (;;) {
+      let validOutputIds: number[] = []
+
+      let log = `offset ${offset}\n`
+      // select count(*)
+      // and o.lockingScript is null
+      // and o.txid = '533e50fba3fca9b08845fc46ae3df81713129876faddf84f9d26d4185dea8324'
+      const outputs: {
+        outputId: number
+        txid: string
+        vout: number
+        lockingScript: number[]
+        scriptOffset: number
+        scriptLength: number
+      }[] = (
+        await storage.knex.raw(`
+      select o.outputId, o.txid, o.vout, o.lockingScript, o.scriptOffset, o.scriptLength
+      from outputs o, transactions t
+      where o.transactionId = t.transactionId
+      and o.type = 'custom' and o.spentBy is null and o.spendable = 0
+      and t.status = 'completed'
+      limit ${limit}
+      offset ${offset}
+      `)
+      )[0]
+
+      for (const { outputId, txid, vout, lockingScript, scriptOffset, scriptLength } of outputs) {
+        let script: number[] | null | undefined = lockingScript
+        if (!lockingScript) {
+          script = await storage.getRawTxOfKnownValidTransaction(txid, scriptOffset, scriptLength)
+        }
+        expect(script).toBeTruthy()
+        const hex = Utils.toHex(script!)
+        const hash = services.hashOutputScript(hex)
+        const outpoint = `${txid}.${vout}`
+        const or = await services.getUtxoStatus(hash, undefined, outpoint)
+        if (or.isUtxo && or.status === 'success') {
+          log += `${outpoint} ${or.isUtxo} ${or.status}\n`
+          validOutputIds.push(outputId)
+        }
+      }
+      log += `offset ${offset}\n`
+      logger(log)
+
+      for (const outputId of validOutputIds) {
+        await storage.updateOutput(outputId, { spendable: true })
+      }
+
+      if (outputs.length < limit) break
+      offset += limit
+    }
+    await storage.destroy()
+  })
+
   test('15 abort a transaction', async () => {
     const { env, storage } = await _tu.createMainReviewSetup()
     const refOrTxid = '42671b6c9b79cec03bf5be9105203589b8b092774a40b459fbd835e5fd582202'

package/test/Wallet/support/reqErrorReview.2025.05.06.man.test.ts

@@ -1,18 +1,6 @@
-import { Beef, Transaction, WalletOutput } from '@bsv/sdk'
-import {
-  EntityProvenTxReq,
-  sdk,
-  Services,
-  Setup,
-  StorageKnex,
-  TableOutput,
-  TableProvenTxReq,
-  TableUser,
-  verifyOne,
-  verifyOneOrNone
-} from '../../../src'
+import { Beef, Transaction } from '@bsv/sdk'
+import { EntityProvenTxReq, sdk, TableProvenTxReq, verifyOneOrNone } from '../../../src'
 import { _tu, TuEnv } from '../../utils/TestUtilsWalletStorage'
-import { specOpInvalidChange, ValidListOutputsArgs } from '../../../src/sdk'
 import { LocalWalletTestOptions } from '../../utils/localWalletMethods'
 import { Format } from '../../../src/utility/Format'
 

package/test/WalletClient/WERR.man.test.ts

@@ -1,8 +1,8 @@
-import { CreateActionArgs, WalletClient } from '@bsv/sdk'
+import { Validation as V, CreateActionArgs, WalletClient } from '@bsv/sdk'
 import { specOpThrowReviewActions } from '../../src/sdk/types'
 import { WalletError } from '../../src/sdk/WalletError'
 import { WERR_REVIEW_ACTIONS } from '../../src/sdk/WERR_errors'
-import { validateCreateActionArgs, WalletErrorFromJson } from '../../src/sdk'
+import { WalletErrorFromJson } from '../../src/sdk'
 
 describe('WERR.man tests', () => {
   jest.setTimeout(99999999)
@@ -14,7 +14,7 @@ describe('WERR.man tests', () => {
       labels: [specOpThrowReviewActions],
       description: 'must throw'
     }
-    const vargs = validateCreateActionArgs(args)
+    const vargs = V.validateCreateActionArgs(args)
 
     try {
       const r = await wallet.createAction(args)

package/test/utils/localWalletMethods.ts

@@ -9,7 +9,8 @@ import {
   Script,
   SignActionArgs,
   SignActionOptions,
-  SignActionResult
+  SignActionResult,
+  Validation
 } from '@bsv/sdk'
 import {
   EntityProvenTxReq,
@@ -23,7 +24,6 @@ import {
   wait
 } from '../../src'
 import { _tu, logger, TestWalletNoSetup, TuEnv } from './TestUtilsWalletStorage'
-import { validateCreateActionArgs, ValidCreateActionArgs } from '../../src/sdk'
 import { setDisableDoubleSpendCheckForTest } from '../../src/storage/methods/createAction'
 
 export interface LocalWalletTestOptions {
@@ -133,7 +133,7 @@ export async function createOneSatTestOutput(
 
   let noSendChange: OutpointString[] | undefined = undefined
   let txids: string[] = []
-  let vargs: ValidCreateActionArgs
+  let vargs: Validation.ValidCreateActionArgs
 
   for (let i = 0; i < howMany; i++) {
     const args: CreateActionArgs = {
@@ -155,7 +155,7 @@ export async function createOneSatTestOutput(
         noSendChange
       }
     }
-    vargs = validateCreateActionArgs(args)
+    vargs = Validation.validateCreateActionArgs(args)
     car = await setup.wallet.createAction(args)
     expect(car.txid)
     txids.push(car.txid!)
@@ -187,7 +187,7 @@ export async function createOneSatTestOutput(
         sendWith: txids
       }
     }
-    vargs = validateCreateActionArgs(args)
+    vargs = Validation.validateCreateActionArgs(args)
     car = await setup.wallet.createAction(args)
   }
 

package/test/wallet/action/createAction.test.ts

@@ -2,6 +2,7 @@
 import { AtomicBEEF, Beef, CreateActionArgs, SignActionArgs } from '@bsv/sdk'
 import { sdk, StorageKnex } from '../../../src/index.all'
 import { _tu, expectToThrowWERR, TestWalletNoSetup } from '../../utils/TestUtilsWalletStorage'
+import { WalletLogger } from '../../../src/WalletLogger'
 
 const includeTestChaintracks = false
 const noLog = true
@@ -69,6 +70,8 @@ describe('createAction test', () => {
 
   test('1_repeatable txid', async () => {
     for (const { wallet } of ctxs) {
+      //wallet.makeLogger = () => console
+      wallet.makeLogger = () => new WalletLogger()
       wallet.randomVals = [0.1, 0.2, 0.3, 0.7, 0.8, 0.9]
       const root = '02135476'
       const kp = _tu.getKeyPair(root.repeat(8))