@bsv/wallet-toolbox 1.2.33 → 1.2.35

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/wallet-toolbox",
-  "version": "1.2.33",
+  "version": "1.2.35",
   "description": "BRC100 conforming wallet, wallet storage and wallet signer components",
   "main": "./out/src/index.js",
   "types": "./out/src/index.d.ts",
@@ -31,8 +31,8 @@
   "homepage": "https://github.com/bitcoin-sv/wallet-toolbox#readme",
   "dependencies": {
     "@bsv/auth-express-middleware": "^1.1.2",
-    "@bsv/payment-express-middleware": "^1.0.4",
-    "@bsv/sdk": "^1.4.17",
+    "@bsv/payment-express-middleware": "^1.0.5",
+    "@bsv/sdk": "^1.4.18",
     "express": "^4.21.2",
     "knex": "^3.1.0",
     "mysql2": "^3.12.0",

package/src/Setup.ts

@@ -17,12 +17,12 @@ import {
   sdk,
   Services,
   StorageClient,
+  StorageKnex,
   verifyTruthy,
   Wallet,
   WalletStorageManager
-} from './index.client'
+} from './index.all'
 import { Knex, knex as makeKnex } from 'knex'
-import { StorageKnex } from './index.all'
 
 import * as dotenv from 'dotenv'
 dotenv.config()

package/src/Wallet.ts

@@ -67,15 +67,7 @@ import {
   AtomicBEEF,
   BEEF
 } from '@bsv/sdk'
-import {
-  sdk,
-  toWalletNetwork,
-  Monitor,
-  WalletStorageManager,
-  WalletSigner,
-  randomBytesBase64,
-  ScriptTemplateBRC29
-} from './index.client'
+import * as sdk from './sdk'
 import { acquireDirectCertificate } from './signer/methods/acquireDirectCertificate'
 import { proveCertificate } from './signer/methods/proveCertificate'
 import { createAction, CreateActionResultX } from './signer/methods/createAction'
@@ -89,8 +81,14 @@ import {
   specOpInvalidChange,
   specOpNoSendActions,
   specOpSetWalletChangeParams,
+  specOpThrowReviewActions,
   specOpWalletBalance
 } from './sdk'
+import { WalletStorageManager } from './storage/WalletStorageManager'
+import { Monitor } from './monitor/Monitor'
+import { WalletSigner } from './signer/WalletSigner'
+import { randomBytesBase64, toWalletNetwork } from './utility/utilityHelpers'
+import { ScriptTemplateBRC29 } from './utility/ScriptTemplateBRC29'
 
 export interface WalletArgs {
   chain: sdk.Chain
@@ -682,6 +680,9 @@ export class Wallet implements WalletInterface, ProtoWallet {
     }
 
     const { auth, vargs } = this.validateAuthAndArgs(args, sdk.validateCreateActionArgs)
+
+    if (vargs.labels.indexOf(specOpThrowReviewActions) >= 0) throwDummyReviewActions()
+
     vargs.includeAllSourceTransactions = this.includeAllSourceTransactions
     if (this.randomVals && this.randomVals.length > 1) {
       vargs.randomVals = [...this.randomVals]
@@ -994,3 +995,34 @@ function throwIfAnyUnsuccessfulSignActions(r: SignActionResultX) {
 
   throw new sdk.WERR_REVIEW_ACTIONS(ndrs, swrs, r.txid, r.tx)
 }
+
+/**
+ * Throws a WERR_REVIEW_ACTIONS with a full set of properties to test data formats and propagation.
+ */
+function throwDummyReviewActions() {
+  const b58Beef =
+    'gno9MC7VXii1KoCkc2nsVyYJpqzN3dhBzYATETJcys62emMKfpBof4R7GozwYEaSapUtnNvqQ57aaYYjm3U2dv9eUJ1sV46boHkQgppYmAz9YH8FdZduV8aJayPViaKcyPmbDhEw6UW8TM5iFZLXNs7HBnJHUKCeTdNK4FUEL7vAugxAV9WUUZ43BZjJk2SmSeps9TCXjt1Ci9fKWp3d9QSoYvTpxwzyUFHjRKtbUgwq55ZfkBp5bV2Bpz9qSuKywKewW7Hh4S1nCUScwwzpKDozb3zic1V9p2k8rQxoPsRxjUJ8bjhNDdsN8d7KukFuc3n47fXzdWttvnxwsujLJRGnQbgJuknQqx3KLf5kJXHzwjG6TzigZk2t24qeB6d3hbYiaDr2fFkUJBL3tukTHhfNkQYRXuz3kucVDzvejHyqJaF51mXG8BjMN5aQj91ZJXCaPVqkMWCzmvyaqmXMdRiJdSAynhXbQK91xf6RwdNhz1tg5f9B6oJJMhsi9UYSVymmax8VLKD9AKzBCBDcfyD83m3jyS1VgKGZn3SkQmr6bsoWq88L3GsMnnmYUGogvdAYarTqg3pzkjCMxHzmJBMN6ofnUk8c1sRTXQue7BbyUaN5uZu3KW6CmFsEfpuqVvnqFW93TU1jrPP2S8yz8AexAnARPCKE8Yz7RfVaT6RCavwQKL3u5iookwRWEZXW1QWmM37yJWHD87SjVynyg327a1CLwcBxmE2CB48QeNVGyQki4CTQMqw2o8TMhDPJej1g68oniAjBcxBLSCs7KGvK3k7AfrHbCMULX9CTibYhCjdFjbsbBoocqJpxxcvkMo1fEEiAzZuiBVZQDYktDdTVbhKHvYkW25HcYX75NJrpNAhm7AjFeKLzEVxqAQkMfvTufpESNRZF4kQqg2Rg8h2ajcKTd5cpEPwXCrZLHm4EaZEmZVbg3QNfGhn7BJu1bHMtLqPD4y8eJxm2uGrW6saf6qKYmmu64F8A667NbD4yskPRQ1S863VzwGpxxmgLc1Ta3R46jEqsAoRDoZVUaCgBBZG3Yg1CTgi1EVBMXU7qvY4n3h8o2FLCEMWY4KadnV3iD4FbcdCmg4yxBosNAZgbPjhgGjCimjh4YsLd9zymGLmivmz2ZBg5m3xaiXT9NN81X9C1JUujd'
+  const beef = Beef.fromBinary(Utils.fromBase58(b58Beef))
+  const btx = beef.txs.slice(-1)[0]
+  const txid = btx.txid
+  debugger
+  throw new sdk.WERR_REVIEW_ACTIONS(
+    [
+      {
+        txid, // only care that it is syntactically a txid
+        status: 'doubleSpend',
+        competingTxs: [txid], // a txid in the beef
+        competingBeef: beef.toBinary()
+      }
+    ],
+    [
+      {
+        txid,
+        status: 'failed'
+      }
+    ],
+    txid,
+    beef.toBinaryAtomic(txid),
+    [`${txid}.0`]
+  )
+}

package/src/index.client.ts

@@ -1,16 +1,15 @@
 export * as sdk from './sdk/index'
 export * from './utility/index.client'
-export * from './Wallet'
 export * from './signer/WalletSigner'
-export * from './storage/index.client'
-export * from './services/Services'
-export * from './monitor/Monitor'
 export * from './WalletPermissionsManager'
 export * from './CWIStyleWalletManager'
 export * from './WalletAuthenticationManager'
-export * from './sdk/PrivilegedKeyManager'
-export * from './SimpleWalletManager'
 export * from './wab-client/WABClient'
 export * from './wab-client/auth-method-interactors/TwilioPhoneInteractor'
 export * from './wab-client/auth-method-interactors/PersonaIDInteractor'
 export * from './wab-client/auth-method-interactors/AuthMethodInteractor'
+export * from './services/Services'
+export * from './sdk/PrivilegedKeyManager'
+export * from './SimpleWalletManager'
+export * from './storage/index.client'
+export * from './Wallet'

package/src/monitor/Monitor.ts

@@ -1,20 +1,23 @@
-import { sdk, wait, Services, WalletStorageManager } from '../index.client'
+import * as sdk from '../sdk'
+import { Services } from '../services'
+import { wait } from '../utility/utilityHelpers'
 import { BlockHeader, ChaintracksServiceClient } from '../services/chaintracker'
+
+import { WalletMonitorTask } from './tasks/WalletMonitorTask'
+import { WalletStorageManager } from '../storage/WalletStorageManager'
+
 import { TaskPurge, TaskPurgeParams } from './tasks/TaskPurge'
 import { TaskReviewStatus } from './tasks/TaskReviewStatus'
 import { TaskSyncWhenIdle } from './tasks/TaskSyncWhenIdle'
 import { TaskFailAbandoned } from './tasks/TaskFailAbandoned'
 import { TaskCheckForProofs } from './tasks/TaskCheckForProofs'
-import { TaskSendWaiting } from './tasks/TaskSendWaiting'
-import { WalletMonitorTask } from './tasks/WalletMonitorTask'
 import { TaskClock } from './tasks/TaskClock'
-import { TaskNewHeader as TaskNewHeader } from './tasks/TaskNewHeader'
-import { TaskUnFail } from './tasks/TaskUnFail'
+import { TaskNewHeader } from './tasks/TaskNewHeader'
+
+import { TaskSendWaiting } from './tasks/TaskSendWaiting'
 import { TaskCheckNoSends } from './tasks/TaskCheckNoSends'
 
 export type MonitorStorage = WalletStorageManager
-//export type MonitorStorage = sdk.WalletStorage
-//export type MonitorStorage = sdk.WalletStorage
 
 export interface MonitorOptions {
   chain: sdk.Chain
@@ -130,7 +133,6 @@ export class Monitor {
     // No purging until invalid transactions are really invalid...
     //this._tasks.push(new TaskPurge(this, this.defaultPurgeParams, 6 * this.oneHour))
     this._tasks.push(new TaskReviewStatus(this))
-    this._tasks.push(new TaskUnFail(this))
   }
 
   /**
@@ -147,7 +149,6 @@ export class Monitor {
     // No purging until invalid transactions are really invalid...
     //this._tasks.push(new TaskPurge(this, this.defaultPurgeParams, 6 * this.oneHour))
     this._tasks.push(new TaskReviewStatus(this))
-    this._tasks.push(new TaskUnFail(this))
   }
 
   addTask(task: WalletMonitorTask): void {

package/src/monitor/MonitorDaemon.ts

@@ -9,6 +9,9 @@ import {
   WalletStorageManager
 } from '../index.all'
 
+// This task is not "client" compatible as it imports StorageKnex
+import { TaskUnFail } from './tasks/TaskUnFail'
+
 import { Knex, knex as makeKnex } from 'knex'
 
 import dotenv from 'dotenv'
@@ -115,6 +118,7 @@ export class MonitorDaemon {
 
     if (a.monitor._tasks.length === 0) {
       a.monitor.addMultiUserTasks()
+      a.monitor.addTask(new TaskUnFail(a.monitor))
     }
   }
 

package/src/monitor/tasks/TaskCheckForProofs.ts

@@ -1,4 +1,8 @@
-import { asString, doubleSha256BE, EntityProvenTx, EntityProvenTxReq, sdk, TableProvenTxReq } from '../../index.client'
+import { GetMerklePathResult } from '../../sdk'
+import { EntityProvenTx, EntityProvenTxReq } from '../../storage/schema/entities'
+import { TableProvenTxReq } from '../../storage/schema/tables'
+import { doubleSha256BE } from '../../utility/utilityHelpers'
+import { asString } from '../../utility/utilityHelpers.noBuffer'
 import { Monitor } from '../Monitor'
 import { WalletMonitorTask } from './WalletMonitorTask'
 
@@ -156,7 +160,7 @@ export async function getProofs(
 
     const since = new Date()
 
-    let r: sdk.GetMerklePathResult
+    let r: GetMerklePathResult
     let ptx: EntityProvenTx | undefined
 
     // External services will try multiple providers until one returns a proof,

package/src/monitor/tasks/TaskCheckNoSends.ts

@@ -1,4 +1,3 @@
-import { asString, doubleSha256BE, EntityProvenTx, EntityProvenTxReq, sdk, TableProvenTxReq } from '../../index.client'
 import { Monitor } from '../Monitor'
 import { getProofs } from './TaskCheckForProofs'
 import { WalletMonitorTask } from './WalletMonitorTask'

package/src/monitor/tasks/TaskNewHeader.ts

@@ -1,11 +1,10 @@
-import { sdk } from '../../index.client'
+import { BlockHeader } from '../../services/chaintracker/chaintracks/BlockHeaderApi'
 import { Monitor } from '../Monitor'
-import { TaskCheckForProofs } from './TaskCheckForProofs'
 import { WalletMonitorTask } from './WalletMonitorTask'
 
 export class TaskNewHeader extends WalletMonitorTask {
   static taskName = 'NewHeader'
-  header?: sdk.BlockHeader
+  header?: BlockHeader
 
   constructor(
     monitor: Monitor,
@@ -14,7 +13,7 @@ export class TaskNewHeader extends WalletMonitorTask {
     super(monitor, TaskNewHeader.taskName)
   }
 
-  async getHeader(): Promise<sdk.BlockHeader> {
+  async getHeader(): Promise<BlockHeader> {
     return await this.monitor.chaintracks.findChainTipHeader()
   }
 

package/src/monitor/tasks/TaskPurge.ts

@@ -1,4 +1,4 @@
-import { sdk } from '../../index.client'
+import { PurgeParams } from '../../sdk/WalletStorage.interfaces'
 import { Monitor } from '../Monitor'
 import { WalletMonitorTask } from './WalletMonitorTask'
 
@@ -27,7 +27,7 @@ import { WalletMonitorTask } from './WalletMonitorTask'
  *       + Delete mapi_responses records
  *       + proven_tx_reqs table delete records
  */
-export interface TaskPurgeParams extends sdk.PurgeParams {}
+export interface TaskPurgeParams extends PurgeParams {}
 
 export class TaskPurge extends WalletMonitorTask {
   static taskName = 'Purge'

package/src/monitor/tasks/TaskReviewStatus.ts

@@ -1,4 +1,3 @@
-import { sdk } from '../../index.client'
 import { Monitor } from '../Monitor'
 import { WalletMonitorTask } from './WalletMonitorTask'
 

package/src/monitor/tasks/TaskUnFail.ts

@@ -1,8 +1,9 @@
 import { Transaction, Utils } from '@bsv/sdk'
-import { EntityProvenTxReq, sdk, TableProvenTxReq } from '../../index.client'
 import { Monitor } from '../Monitor'
 import { WalletMonitorTask } from './WalletMonitorTask'
 import { StorageKnex } from '../../storage/StorageKnex'
+import { TableProvenTxReq } from '../../storage/schema/tables'
+import { EntityProvenTxReq } from '../../storage/schema/entities'
 
 /**
  * Setting provenTxReq status to 'unfail' when 'invalid' will attempt to find a merklePath, and if successful:

package/src/sdk/WalletServices.interfaces.ts

@@ -1,6 +1,7 @@
 import { ArcConfig, Beef, Transaction as BsvTransaction, ChainTracker, MerklePath } from '@bsv/sdk'
-import { sdk } from '../index.client'
 import { ChaintracksServiceClient } from '../services/chaintracker'
+import { Chain, ReqHistoryNote } from './types'
+import { WalletError } from './WalletError'
 /**
  * Defines standard interfaces to access functionality implemented by external transaction processing services.
  */
@@ -8,7 +9,7 @@ export interface WalletServices {
   /**
    * The chain being serviced.
    */
-  chain: sdk.Chain
+  chain: Chain
 
   /**
    * @returns standard `ChainTracker` service which requires `options.chaintracks` be valid.
@@ -107,7 +108,7 @@ export interface WalletServices {
    * @param txids
    * @param useNext
    */
-  getStatusForTxids(txids: string[], useNext?: boolean): Promise<sdk.GetStatusForTxidsResult>
+  getStatusForTxids(txids: string[], useNext?: boolean): Promise<GetStatusForTxidsResult>
 
   /**
    * Attempts to determine the UTXO status of a transaction output.
@@ -131,13 +132,13 @@ export interface WalletServices {
     useNext?: boolean
   ): Promise<GetUtxoStatusResult>
 
-  getScriptHashHistory(hash: string, useNext?: boolean): Promise<sdk.GetScriptHashHistoryResult>
+  getScriptHashHistory(hash: string, useNext?: boolean): Promise<GetScriptHashHistoryResult>
 
   /**
    * @returns a block header
    * @param hash block hash
    */
-  hashToHeader(hash: string): Promise<sdk.BlockHeader>
+  hashToHeader(hash: string): Promise<BlockHeader>
 
   /**
    * @returns whether the locktime value allows the transaction to be mined at the current chain height
@@ -162,7 +163,7 @@ export interface FiatExchangeRates {
 }
 
 export interface WalletServicesOptions {
-  chain: sdk.Chain
+  chain: Chain
   taalApiKey?: string
   bitailsApiKey?: string
   whatsOnChainApiKey?: string
@@ -187,8 +188,8 @@ export interface GetStatusForTxidsResult {
   /**
    * The first exception error that occurred during processing, if any.
    */
-  error?: sdk.WalletError
-  results: sdk.StatusForTxidResult[]
+  error?: WalletError
+  results: StatusForTxidResult[]
 }
 
 export interface StatusForTxidResult {
@@ -225,7 +226,7 @@ export interface GetRawTxResult {
   /**
    * The first exception error that occurred during processing, if any.
    */
-  error?: sdk.WalletError
+  error?: WalletError
 }
 
 /**
@@ -247,9 +248,9 @@ export interface GetMerklePathResult {
   /**
    * The first exception error that occurred during processing, if any.
    */
-  error?: sdk.WalletError
+  error?: WalletError
 
-  notes?: sdk.ReqHistoryNote[]
+  notes?: ReqHistoryNote[]
 }
 
 export interface PostTxResultForTxid {
@@ -281,7 +282,7 @@ export interface PostTxResultForTxid {
 
   data?: object | string | PostTxResultForTxidError
 
-  notes?: sdk.ReqHistoryNote[]
+  notes?: ReqHistoryNote[]
 
   /**
    * true iff service was unable to process a potentially valid transaction
@@ -311,7 +312,7 @@ export interface PostTxsResult {
    */
   status: 'success' | 'error'
 
-  error?: sdk.WalletError
+  error?: WalletError
 
   txidResults: PostTxResultForTxid[]
 
@@ -320,7 +321,7 @@ export interface PostTxsResult {
    */
   data?: object
 
-  notes?: sdk.ReqHistoryNote[]
+  notes?: ReqHistoryNote[]
 }
 
 export interface GetUtxoStatusDetails {
@@ -363,7 +364,7 @@ export interface GetUtxoStatusResult {
   /**
    * When status is 'error', provides code and description
    */
-  error?: sdk.WalletError
+  error?: WalletError
   /**
    * true if the output is associated with at least one unspent transaction output
    */
@@ -395,7 +396,7 @@ export interface GetScriptHashHistoryResult {
   /**
    * When status is 'error', provides code and description
    */
-  error?: sdk.WalletError
+  error?: WalletError
   /**
    * Transaction txid (and height if mined) that consumes the script hash. May not be a complete history.
    */
@@ -455,13 +456,13 @@ export type GetUtxoStatusService = (
   outpoint?: string
 ) => Promise<GetUtxoStatusResult>
 
-export type GetStatusForTxidsService = (txids: string[]) => Promise<sdk.GetStatusForTxidsResult>
+export type GetStatusForTxidsService = (txids: string[]) => Promise<GetStatusForTxidsResult>
 
 export type GetScriptHashHistoryService = (hash: string) => Promise<GetScriptHashHistoryResult>
 
 export type GetMerklePathService = (txid: string, services: WalletServices) => Promise<GetMerklePathResult>
 
-export type GetRawTxService = (txid: string, chain: sdk.Chain) => Promise<GetRawTxResult>
+export type GetRawTxService = (txid: string, chain: Chain) => Promise<GetRawTxResult>
 
 export type PostTxsService = (beef: Beef, txids: string[], services: WalletServices) => Promise<PostTxsResult>
 

package/src/sdk/WalletSigner.interfaces.ts

@@ -1,38 +1,11 @@
-import {
-  AbortActionArgs,
-  AbortActionResult,
-  AcquireCertificateArgs,
-  AcquireCertificateResult,
-  CreateActionArgs,
-  CreateActionResult,
-  DiscoverByAttributesArgs,
-  DiscoverByIdentityKeyArgs,
-  DiscoverCertificatesResult,
-  InternalizeActionArgs,
-  InternalizeActionResult,
-  KeyDeriverApi,
-  ListActionsArgs,
-  ListActionsResult,
-  ListCertificatesArgs,
-  ListCertificatesResult,
-  ListOutputsArgs,
-  ListOutputsResult,
-  ProveCertificateArgs,
-  ProveCertificateResult,
-  RelinquishCertificateArgs,
-  RelinquishCertificateResult,
-  RelinquishOutputArgs,
-  RelinquishOutputResult,
-  SignActionArgs,
-  SignActionResult
-} from '@bsv/sdk'
-import { sdk } from '../index.client'
+import { KeyDeriverApi } from '@bsv/sdk'
+import { Chain } from './types'
 
 /**
  */
 export interface WalletSigner {
   isWalletSigner: true
 
-  chain: sdk.Chain
+  chain: Chain
   keyDeriver: KeyDeriverApi
 }