@bsv/wallet-toolbox 1.5.11 → 1.5.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/wallet-toolbox",
-  "version": "1.5.11",
+  "version": "1.5.13",
   "description": "BRC100 conforming wallet, wallet storage and wallet signer components",
   "main": "./out/src/index.js",
   "types": "./out/src/index.d.ts",
@@ -32,7 +32,7 @@
   "dependencies": {
     "@bsv/auth-express-middleware": "^1.2.0",
     "@bsv/payment-express-middleware": "^1.2.1",
-    "@bsv/sdk": "^1.6.15",
+    "@bsv/sdk": "^1.6.16",
     "express": "^4.21.2",
     "idb": "^8.0.2",
     "knex": "^3.1.0",

package/src/Setup.ts

@@ -1,11 +1,13 @@
 import { KeyPairAddress, SetupWallet, SetupWalletClient } from './SetupWallet'
 import {
   BEEF,
+  CachedKeyDeriver,
   CreateActionArgs,
   CreateActionOptions,
   CreateActionOutput,
   CreateActionResult,
   KeyDeriver,
+  KeyDeriverApi,
   LockingScript,
   P2PKH,
   PrivateKey,
@@ -142,7 +144,7 @@ DEV_KEYS = '{
     args.rootKeyHex ||= args.env.devKeys[args.env.identityKey]
     const rootKey = PrivateKey.fromHex(args.rootKeyHex)
     const identityKey = rootKey.toPublicKey().toString()
-    const keyDeriver = new KeyDeriver(rootKey)
+    const keyDeriver = new CachedKeyDeriver(rootKey)
     const storage = new WalletStorageManager(identityKey, args.active, args.backups)
     if (storage.canMakeAvailable()) await storage.makeAvailable()
     const serviceOptions = Services.createDefaultOptions(chain)
@@ -196,7 +198,7 @@ DEV_KEYS = '{
     const chain = args.chain
     const endpointUrl = args.storageUrl || `https://${args.chain !== 'main' ? 'staging-' : ''}storage.babbage.systems`
     const rootKey = PrivateKey.fromHex(args.rootKeyHex)
-    const keyDeriver = new KeyDeriver(rootKey)
+    const keyDeriver = new CachedKeyDeriver(rootKey)
     const storage = new WalletStorageManager(keyDeriver.identityKey)
     const services = new Services(chain)
     const privilegedKeyManager = args.privilegedKeyGetter
@@ -512,7 +514,7 @@ export interface SetupWalletKnex extends SetupWallet {
 
   rootKey: PrivateKey
   identityKey: string
-  keyDeriver: KeyDeriver
+  keyDeriver: KeyDeriverApi
   chain: sdk.Chain
   storage: WalletStorageManager
   services: Services

package/src/SetupClient.ts

@@ -1,10 +1,12 @@
 import {
   BEEF,
+  CachedKeyDeriver,
   CreateActionArgs,
   CreateActionOptions,
   CreateActionOutput,
   CreateActionResult,
   KeyDeriver,
+  KeyDeriverApi,
   LockingScript,
   P2PKH,
   PrivateKey,
@@ -34,7 +36,7 @@ export abstract class SetupClient {
     const chain = args.chain
     const rootKey = PrivateKey.fromHex(args.rootKeyHex)
     const identityKey = rootKey.toPublicKey().toString()
-    const keyDeriver = new KeyDeriver(rootKey)
+    const keyDeriver = new CachedKeyDeriver(rootKey)
     const storage = new WalletStorageManager(identityKey, args.active, args.backups)
     if (storage.canMakeAvailable()) await storage.makeAvailable()
     const serviceOptions = Services.createDefaultOptions(chain)
@@ -84,7 +86,7 @@ export abstract class SetupClient {
     const chain = args.chain
     const endpointUrl = args.storageUrl || `https://${args.chain !== 'main' ? 'staging-' : ''}storage.babbage.systems`
     const rootKey = PrivateKey.fromHex(args.rootKeyHex)
-    const keyDeriver = new KeyDeriver(rootKey)
+    const keyDeriver = new CachedKeyDeriver(rootKey)
     const storage = new WalletStorageManager(keyDeriver.identityKey)
     const services = new Services(chain)
     const privilegedKeyManager = args.privilegedKeyGetter
@@ -290,7 +292,7 @@ export interface SetupWalletIdb extends SetupWallet {
 
   rootKey: PrivateKey
   identityKey: string
-  keyDeriver: KeyDeriver
+  keyDeriver: KeyDeriverApi
   chain: sdk.Chain
   storage: WalletStorageManager
   services: Services

package/src/SetupWallet.ts

@@ -1,4 +1,4 @@
-import { PrivateKey, KeyDeriver, PublicKey } from '@bsv/sdk'
+import { PrivateKey, KeyDeriver, PublicKey, KeyDeriverApi } from '@bsv/sdk'
 import { WalletStorageManager, Monitor, sdk } from './index.client'
 import { Services } from './services'
 import { Wallet } from './Wallet'
@@ -23,7 +23,7 @@ export interface SetupWallet {
   /**
    * The `KeyDeriver` component used by the wallet for key derivation and cryptographic functions.
    */
-  keyDeriver: KeyDeriver
+  keyDeriver: KeyDeriverApi
   /**
    * The chain ('main' or 'test') which the wallet accesses.
    */

package/src/Wallet.ts

@@ -65,7 +65,8 @@ import {
   Certificate,
   LookupResolver,
   AtomicBEEF,
-  BEEF
+  BEEF,
+  KeyDeriverApi
 } from '@bsv/sdk'
 import * as sdk from './sdk'
 import { acquireDirectCertificate } from './signer/methods/acquireDirectCertificate'
@@ -92,7 +93,7 @@ import { ScriptTemplateBRC29 } from './utility/ScriptTemplateBRC29'
 
 export interface WalletArgs {
   chain: sdk.Chain
-  keyDeriver: KeyDeriver
+  keyDeriver: KeyDeriverApi
   storage: WalletStorageManager
   services?: sdk.WalletServices
   monitor?: Monitor
@@ -107,7 +108,7 @@ function isWalletSigner(args: WalletArgs | WalletSigner): args is WalletSigner {
 
 export class Wallet implements WalletInterface, ProtoWallet {
   chain: sdk.Chain
-  keyDeriver: KeyDeriver
+  keyDeriver: KeyDeriverApi
   storage: WalletStorageManager
   settingsManager: WalletSettingsManager
   lookupResolver: LookupResolver

package/src/__tests/WalletPermissionsManager.proxying.test.ts

@@ -679,7 +679,7 @@ describe('WalletPermissionsManager - Regression & Integration with Underlying Wa
     const result = await manager.waitForAuthentication({}, 'someone.com')
     expect(result.authenticated).toBe(true)
     expect(underlying.waitForAuthentication).toHaveBeenCalledTimes(1)
-  })
+  }, 30000)
 
   it('should proxy getHeight', async () => {
     const result = await manager.getHeight({}, 'someone.com')

package/src/monitor/Monitor.ts

@@ -42,6 +42,12 @@ export interface MonitorOptions {
   unprovenAttemptsLimitTest: number
 
   unprovenAttemptsLimitMain: number
+
+  /**
+   * These are hooks for a wallet-toolbox client to get transaction updates.
+   */
+  onTransactionBroadcasted?: (broadcastResult: sdk.ReviewActionResult) => Promise<void>
+  onTransactionProven?: (txStatus: sdk.ProvenTransactionStatus) => Promise<void>
 }
 
 /**
@@ -75,6 +81,8 @@ export class Monitor {
   chain: sdk.Chain
   storage: MonitorStorage
   chaintracks: ChaintracksServiceClient
+  onTransactionBroadcasted?: (broadcastResult: sdk.ReviewActionResult) => Promise<void>
+  onTransactionProven?: (txStatus: sdk.ProvenTransactionStatus) => Promise<void>
 
   constructor(options: MonitorOptions) {
     this.options = { ...options }
@@ -82,6 +90,8 @@ export class Monitor {
     this.chain = this.services.chain
     this.storage = options.storage
     this.chaintracks = options.chaintracks
+    this.onTransactionProven = options.onTransactionProven
+    this.onTransactionBroadcasted = options.onTransactionBroadcasted
   }
 
   oneSecond = 1000
@@ -286,6 +296,32 @@ export class Monitor {
     TaskCheckForProofs.checkNow = true
   }
 
+  /**
+   * This is a function run from a TaskSendWaiting Monitor task.
+   *
+   * This allows the user of wallet-toolbox to 'subscribe' for transaction broadcast updates.
+   *
+   * @param broadcastResult
+   */
+  callOnBroadcastedTransaction(broadcastResult: sdk.ReviewActionResult): void {
+    if (this.onTransactionBroadcasted) {
+      this.onTransactionBroadcasted(broadcastResult)
+    }
+  }
+
+  /**
+   * This is a function run from a TaskCheckForProofs Monitor task.
+   *
+   * This allows the user of wallet-toolbox to 'subscribe' for transaction updates.
+   *
+   * @param txStatus
+   */
+  callOnProvenTransaction(txStatus: sdk.ProvenTransactionStatus): void {
+    if (this.onTransactionProven) {
+      this.onTransactionProven(txStatus)
+    }
+  }
+
   /**
    * Process reorg event received from Chaintracks
    *
@@ -301,18 +337,3 @@ export class Monitor {
     /* */
   }
 }
-
-function sum<T>(a: T[], getNum: (v: T) => number): number {
-  let s = 0
-  for (const v of a) s += getNum(v)
-  return s
-}
-
-function filter<T>(a: T[], pred: (v: T) => boolean): { ts: T[]; fs: T[] } {
-  const ts: T[] = []
-  const fs: T[] = []
-  for (const v of a)
-    if (pred(v)) ts.push(v)
-    else fs.push(v)
-  return { ts, fs }
-}

package/src/monitor/tasks/TaskCheckForProofs.ts

@@ -216,6 +216,15 @@ export async function getProofs(
       req.apiHistory = r.history
       req.provenTxId = r.provenTxId
       req.notified = true
+
+      task.monitor.callOnProvenTransaction({
+        txid,
+        txIndex: index,
+        blockHeight: height,
+        blockHash,
+        merklePath,
+        merkleRoot
+      })
     } else {
       if (countsAsAttempt && req.status !== 'nosend') {
         req.attempts++

package/src/monitor/tasks/TaskSendWaiting.ts

@@ -3,7 +3,9 @@ import { verifyTruthy } from '../../utility/index.client'
 import { Monitor } from '../Monitor'
 import { WalletMonitorTask } from './WalletMonitorTask'
 import { attemptToPostReqsToNetwork } from '../../storage/methods/attemptToPostReqsToNetwork'
-import { ProvenTxReqStatus } from '../../sdk'
+import { ProvenTxReqStatus, WERR_INTERNAL } from '../../sdk'
+import { ReviewActionResult, SendWithResult } from '@bsv/sdk'
+import { aggregateActionResults } from '../../utility/aggregateResults'
 
 export class TaskSendWaiting extends WalletMonitorTask {
   static taskName = 'SendWaiting'
@@ -103,6 +105,15 @@ export class TaskSendWaiting extends WalletMonitorTask {
         return attemptToPostReqsToNetwork(sp, reqs)
       })
 
+      if (this.monitor.onTransactionBroadcasted) {
+        const rar = await this.storage.runAsStorageProvider(async sp => {
+          const ars: SendWithResult[] = [{ txid: req.txid, status: 'sending' }]
+          const { rar } = await aggregateActionResults(sp, ars, r)
+          return rar
+        })
+        this.monitor.callOnBroadcastedTransaction(rar[0])
+      }
+
       log += r.log
     }
     return log

package/src/sdk/types.ts

@@ -133,6 +133,18 @@ export type ReqHistoryNote = {
   [key: string]: boolean | string | number | undefined
 }
 
+/**
+ * The transaction status that a client will receive when subscribing to transaction updates in the Monitor.
+ */
+export interface ProvenTransactionStatus {
+  txid: string
+  txIndex: number
+  blockHeight: number
+  blockHash: string
+  merklePath: number[]
+  merkleRoot: string
+}
+
 /**
  * `listOutputs` special operation basket name value.
  *

package/src/services/__tests/ARC.timeout.man.test.ts

@@ -45,7 +45,7 @@ describe('ARC tests', () => {
 
     const headers: Record<string, string> = {
       'Content-Type': 'application/json',
-      'XDeployment-ID': 'wallet-toolbox-test11',
+      'XDeployment-ID': 'wallet-toolbox-test11'
       //Authorization: `Bearer ${envMain.gorillaPoolApiKey}`
     }
 

package/src/signer/WalletSigner.ts

@@ -1,4 +1,4 @@
-import { KeyDeriver } from '@bsv/sdk'
+import { KeyDeriver, KeyDeriverApi } from '@bsv/sdk'
 import { sdk } from '../index.client'
 import { WalletStorageManager } from '../storage/WalletStorageManager'
 
@@ -6,10 +6,10 @@ export class WalletSigner {
   isWalletSigner: true = true
 
   chain: sdk.Chain
-  keyDeriver: KeyDeriver
+  keyDeriver: KeyDeriverApi
   storage: WalletStorageManager
 
-  constructor(chain: sdk.Chain, keyDeriver: KeyDeriver, storage: WalletStorageManager) {
+  constructor(chain: sdk.Chain, keyDeriver: KeyDeriverApi, storage: WalletStorageManager) {
     this.chain = chain
     this.keyDeriver = keyDeriver
     this.storage = storage

package/src/storage/methods/processAction.ts

@@ -7,9 +7,7 @@ import {
   parseTxScriptOffsets,
   randomBytesBase64,
   sdk,
-  sha256Hash,
   stampLog,
-  stampLogFormat,
   StorageProvider,
   TableCommission,
   TableOutput,
@@ -17,16 +15,14 @@ import {
   TableProvenTxReq,
   TableTransaction,
   TxScriptOffsets,
-  validateStorageFeeModel,
   verifyId,
   verifyInteger,
-  verifyNumber,
   verifyOne,
   verifyOneOrNone,
   verifyTruthy
 } from '../../index.client'
-import { ReviewActionResult, ProvenTxReqNonTerminalStatus, StorageGetBeefOptions } from '../../sdk'
-import { PostReqsToNetworkDetails } from './attemptToPostReqsToNetwork'
+import { ReviewActionResult } from '../../sdk'
+import { aggregateActionResults } from '../../utility/aggregateResults'
 
 export async function processAction(
   storage: StorageProvider,
@@ -122,15 +118,6 @@ export async function shareReqsWithWorld(
   // Collect what we know about these sendWith transaction txids from storage.
   const r = await storage.getReqsAndBeefToShareWithWorld(txids, [])
 
-  // Initialize aggregate results for each txid
-  const ars: {
-    txid: string
-    status: SendWithResultStatus
-    getReq: GetReqsAndBeefDetail
-    postReq?: PostReqsToNetworkDetails
-    ndr?: ReviewActionResult
-  }[] = []
-
   const readyToSendReqs: EntityProvenTxReq[] = []
   for (const getReq of r.details) {
     let status: SendWithResultStatus = 'failed'
@@ -139,9 +126,8 @@ export async function shareReqsWithWorld(
       status = 'sending'
       readyToSendReqs.push(new EntityProvenTxReq(getReq.req!))
     }
-    ars.push({
+    swr.push({
       txid: getReq.txid,
-      getReq,
       status
     })
   }
@@ -171,11 +157,11 @@ export async function shareReqsWithWorld(
         await storage.updateTransaction(transactionIds, { status: 'sending' }, trx)
       })
     }
-    return createResults()
+    return { swr, ndr }
   }
 
   if (readyToSendReqIds.length < 1) {
-    return createResults()
+    return { swr, ndr }
   }
 
   if (batch) {
@@ -189,53 +175,8 @@ export async function shareReqsWithWorld(
   //
   const prtn = await storage.attemptToPostReqsToNetwork(readyToSendReqs)
 
-  // merge the individual PostBeefResultForTxid results to postBeef in aggregate results.
-  for (const ar of ars) {
-    const txid = ar.txid
-    const d = prtn.details.find(d => d.txid === txid)
-    if (!d) throw new sdk.WERR_INTERNAL(`missing details for ${txid}`)
-    ar.ndr = { txid: d.txid, status: 'success', competingTxs: d.competingTxs }
-    switch (d.status) {
-      case 'success':
-        // processing network has accepted this transaction
-        ar.status = 'unproven'
-        break
-      case 'doubleSpend':
-        // confirmed double spend.
-        ar.status = 'failed'
-        ar.ndr.status = 'doubleSpend'
-        if (d.competingTxs) ar.ndr.competingBeef = await createMergedBeefOfTxids(d.competingTxs, storage)
-        break
-      case 'serviceError':
-        // services might improve
-        ar.status = 'sending'
-        ar.ndr.status = 'serviceError'
-        break
-      case 'invalidTx':
-        // nothing will fix this transaction
-        ar.status = 'failed'
-        ar.ndr.status = 'invalidTx'
-        break
-      case 'unknown':
-      case 'invalid':
-      default:
-        throw new sdk.WERR_INTERNAL(`processAction with notDelayed status ${d.status} should not occur.`)
-    }
-  }
-
-  return createResults()
-
-  function createResults(): { swr: SendWithResult[]; ndr: ReviewActionResult[] | undefined } {
-    swr = []
-    ndr = isDelayed ? undefined : []
-    for (const ar of ars) {
-      swr.push({ txid: ar.txid, status: ar.status })
-      if (ar.ndr && ndr) {
-        ndr.push(ar.ndr)
-      }
-    }
-    return { swr, ndr }
-  }
+  const { swr: swrRes, rar } = await aggregateActionResults(storage, swr, prtn)
+  return { swr: swrRes, ndr: rar }
 }
 
 interface ReqTxStatus {
@@ -452,15 +393,3 @@ async function commitNewTxToStorage(
 
   return r
 }
-
-async function createMergedBeefOfTxids(txids: string[], storage: StorageProvider): Promise<number[]> {
-  const beef = new Beef()
-  const options: StorageGetBeefOptions = {
-    mergeToBeef: beef,
-    ignoreNewProven: true
-  }
-  for (const txid of txids) {
-    await storage.getBeefForTransaction(txid, options)
-  }
-  return beef.toBinary()
-}

package/src/utility/ScriptTemplateBRC29.ts

@@ -9,7 +9,8 @@ import {
   LockingScript,
   P2PKH,
   PrivateKey,
-  Script
+  Script,
+  CachedKeyDeriver
 } from '@bsv/sdk'
 
 export const brc29ProtocolID: WalletProtocol = [2, '3241645161d8']
@@ -41,7 +42,7 @@ export class ScriptTemplateBRC29 implements ScriptTemplate {
   getKeyDeriver(privKey: PrivateKey | HexString): KeyDeriverApi {
     if (typeof privKey === 'string') privKey = PrivateKey.fromHex(privKey)
     if (!this.params.keyDeriver || this.params.keyDeriver.rootKey.toHex() !== privKey.toHex())
-      return new KeyDeriver(privKey)
+      return new CachedKeyDeriver(privKey)
     return this.params.keyDeriver
   }
 

package/src/utility/aggregateResults.ts

@@ -0,0 +1,68 @@
+import { Beef, ReviewActionResult, SendWithResult } from '@bsv/sdk'
+import { PostReqsToNetworkResult } from '../storage/methods/attemptToPostReqsToNetwork'
+import { StorageGetBeefOptions, WERR_INTERNAL } from '../sdk'
+import { StorageProvider } from '../index.client'
+
+export const aggregateActionResults = async (
+  storage: StorageProvider,
+  sendWithResultReqs: SendWithResult[],
+  postToNetworkResult: PostReqsToNetworkResult
+): Promise<{
+  swr: SendWithResult[]
+  rar: ReviewActionResult[]
+}> => {
+  const swr: SendWithResult[] = []
+  const rar: ReviewActionResult[] = []
+
+  for (const ar of sendWithResultReqs) {
+    const txid = ar.txid
+
+    const d = postToNetworkResult.details.find(d => d.txid === txid)
+    if (!d) throw new WERR_INTERNAL(`missing details for ${txid}`)
+
+    const arNdr: ReviewActionResult = { txid: d.txid, status: 'success', competingTxs: d.competingTxs }
+    switch (d.status) {
+      case 'success':
+        // processing network has accepted this transaction
+        ar.status = 'unproven'
+        break
+      case 'doubleSpend':
+        // confirmed double spend.
+        ar.status = 'failed'
+        arNdr.status = 'doubleSpend'
+        if (d.competingTxs) arNdr.competingBeef = await createMergedBeefOfTxids(d.competingTxs, storage)
+        break
+      case 'serviceError':
+        // services might improve
+        ar.status = 'sending'
+        arNdr.status = 'serviceError'
+        break
+      case 'invalidTx':
+        // nothing will fix this transaction
+        ar.status = 'failed'
+        arNdr.status = 'invalidTx'
+        break
+      case 'unknown':
+      case 'invalid':
+      default:
+        throw new WERR_INTERNAL(`processAction with notDelayed status ${d.status} should not occur.`)
+    }
+
+    swr.push({ txid, status: ar.status })
+    rar.push(arNdr)
+  }
+
+  return { swr, rar }
+}
+
+async function createMergedBeefOfTxids(txids: string[], storage: StorageProvider): Promise<number[]> {
+  const beef = new Beef()
+  const options: StorageGetBeefOptions = {
+    mergeToBeef: beef,
+    ignoreNewProven: true
+  }
+  for (const txid of txids) {
+    await storage.getBeefForTransaction(txid, options)
+  }
+  return beef.toBinary()
+}

package/test/Wallet/live/walletLive.man.test.ts

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import {
   Beef,
+  CachedKeyDeriver,
   CreateActionArgs,
   InternalizeActionArgs,
   KeyDeriver,
@@ -426,7 +427,7 @@ export function createWalletPaymentOutput(args: {
   const t = new ScriptTemplateBRC29({
     derivationPrefix: randomBytesBase64(8),
     derivationSuffix: randomBytesBase64(8),
-    keyDeriver: new KeyDeriver(PrivateKey.fromString(args.fromRootKeyHex))
+    keyDeriver: new CachedKeyDeriver(PrivateKey.fromString(args.fromRootKeyHex))
   })
 
   const lockingScript = t.lock(args.fromRootKeyHex, args.toIdentityKey)