@bsv/wallet-toolbox 1.1.7 → 1.1.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/wallet-toolbox",
-  "version": "1.1.7",
+  "version": "1.1.9",
   "description": "BRC100 conforming wallet, wallet storage and wallet signer components",
   "main": "./out/src/index.js",
   "types": "./out/src/index.d.ts",
@@ -57,7 +57,7 @@
     "standard": "^17.1.0",
     "ts-jest": "^29.0.5",
     "ts-node": "^10.9.1",
-    "ts2md": "^0.2.7",
+    "ts2md": "^0.2.8",
     "typescript": "^5.2.2"
   }
 }

package/src/monitor/tasks/TaskCheckForProofs.ts

@@ -1,9 +1,10 @@
 import {
   asString,
   doubleSha256BE,
-  entity,
+  EntityProvenTx,
+  EntityProvenTxReq,
   sdk,
-  table
+  TableProvenTxReq
 } from '../../index.client'
 import { Monitor } from '../Monitor'
 import { WalletMonitorTask } from './WalletMonitorTask'
@@ -96,17 +97,17 @@ export class TaskCheckForProofs extends WalletMonitorTask {
    * @returns reqs partitioned by status
    */
   async getProofs(
-    reqs: table.ProvenTxReq[],
+    reqs: TableProvenTxReq[],
     indent = 0,
     countsAsAttempt = false,
     ignoreStatus = false
   ): Promise<{
-    proven: table.ProvenTxReq[]
-    invalid: table.ProvenTxReq[]
+    proven: TableProvenTxReq[]
+    invalid: TableProvenTxReq[]
     log: string
   }> {
-    const proven: table.ProvenTxReq[] = []
-    const invalid: table.ProvenTxReq[] = []
+    const proven: TableProvenTxReq[] = []
+    const invalid: TableProvenTxReq[] = []
 
     let log = ''
     for (const reqApi of reqs) {
@@ -126,7 +127,7 @@ export class TaskCheckForProofs extends WalletMonitorTask {
         continue
       }
 
-      const req = new entity.ProvenTxReq(reqApi)
+      const req = new EntityProvenTxReq(reqApi)
 
       if (Number.isInteger(req.provenTxId)) {
         log += `Already linked to provenTxId ${req.provenTxId}.\n`
@@ -170,7 +171,7 @@ export class TaskCheckForProofs extends WalletMonitorTask {
       const since = new Date()
 
       let r: sdk.GetMerklePathResult
-      let ptx: entity.ProvenTx | undefined
+      let ptx: EntityProvenTx | undefined
 
       // External services will try multiple providers until one returns a proof,
       // or they all fail.
@@ -188,7 +189,7 @@ export class TaskCheckForProofs extends WalletMonitorTask {
       // one more time.
       //
       r = await this.monitor.services.getMerklePath(req.txid)
-      ptx = await entity.ProvenTx.fromReq(
+      ptx = await EntityProvenTx.fromReq(
         req,
         r,
         countsAsAttempt && req.status !== 'nosend'

package/src/monitor/tasks/TaskSendWaiting.ts

@@ -1,4 +1,4 @@
-import { entity, table } from '../../storage/index.client'
+import { EntityProvenTxReq, TableProvenTxReq } from '../../storage/index.client'
 import { verifyTruthy } from '../../utility/index.client'
 import { Monitor } from '../Monitor'
 import { WalletMonitorTask } from './WalletMonitorTask'
@@ -63,7 +63,7 @@ export class TaskSendWaiting extends WalletMonitorTask {
    * @param reqApis
    */
   async processUnsent(
-    reqApis: table.ProvenTxReq[],
+    reqApis: TableProvenTxReq[],
     indent = 0
   ): Promise<string> {
     let log = ''
@@ -75,8 +75,8 @@ export class TaskSendWaiting extends WalletMonitorTask {
         log += `  status now ${reqApi.status}\n`
         continue
       }
-      const req = new entity.ProvenTxReq(reqApi)
-      const reqs: entity.ProvenTxReq[] = []
+      const req = new EntityProvenTxReq(reqApi)
+      const reqs: EntityProvenTxReq[] = []
       if (req.batch) {
         // Make sure wew process entire batch together for efficient beef generation
         const batchReqApis = await this.storage.findProvenTxReqs({
@@ -89,7 +89,7 @@ export class TaskSendWaiting extends WalletMonitorTask {
           )
           if (index > -1) reqApis.slice(index, index + 1)
           // And add to reqs being processed now:
-          reqs.push(new entity.ProvenTxReq(bra))
+          reqs.push(new EntityProvenTxReq(bra))
         }
       } else {
         // Just a single non-batched req...

package/src/sdk/StorageSyncReader.ts

@@ -1,11 +1,29 @@
-import { sdk, table } from '../index.client'
+import {
+  sdk,
+  TableCertificate,
+  TableCertificateField,
+  TableCertificateX,
+  TableCommission,
+  TableOutput,
+  TableOutputBasket,
+  TableOutputTag,
+  TableOutputTagMap,
+  TableProvenTx,
+  TableProvenTxReq,
+  TableSettings,
+  TableSyncState,
+  TableTransaction,
+  TableTxLabel,
+  TableTxLabelMap,
+  TableUser
+} from '../index.client'
 
 /**
  * This is the minimal interface required for a WalletStorageProvider to export data to another provider.
  */
 export interface StorageSyncReader {
   isAvailable(): boolean
-  makeAvailable(): Promise<table.Settings>
+  makeAvailable(): Promise<TableSettings>
 
   destroy(): Promise<void>
 
@@ -15,37 +33,37 @@ export interface StorageSyncReader {
   //
   /////////////////
 
-  getSettings(): table.Settings
+  getSettings(): TableSettings
 
-  findUserByIdentityKey(key: string): Promise<table.User | undefined>
+  findUserByIdentityKey(key: string): Promise<TableUser | undefined>
 
-  findSyncStates(args: sdk.FindSyncStatesArgs): Promise<table.SyncState[]>
+  findSyncStates(args: sdk.FindSyncStatesArgs): Promise<TableSyncState[]>
 
   findCertificateFields(
     args: sdk.FindCertificateFieldsArgs
-  ): Promise<table.CertificateField[]>
-  findCertificates(args: sdk.FindCertificatesArgs): Promise<table.Certificate[]>
-  findCommissions(args: sdk.FindCommissionsArgs): Promise<table.Commission[]>
+  ): Promise<TableCertificateField[]>
+  findCertificates(args: sdk.FindCertificatesArgs): Promise<TableCertificateX[]>
+  findCommissions(args: sdk.FindCommissionsArgs): Promise<TableCommission[]>
   findOutputBaskets(
     args: sdk.FindOutputBasketsArgs
-  ): Promise<table.OutputBasket[]>
-  findOutputs(args: sdk.FindOutputsArgs): Promise<table.Output[]>
-  findOutputTags(args: sdk.FindOutputTagsArgs): Promise<table.OutputTag[]>
-  findTransactions(args: sdk.FindTransactionsArgs): Promise<table.Transaction[]>
-  findTxLabels(args: sdk.FindTxLabelsArgs): Promise<table.TxLabel[]>
+  ): Promise<TableOutputBasket[]>
+  findOutputs(args: sdk.FindOutputsArgs): Promise<TableOutput[]>
+  findOutputTags(args: sdk.FindOutputTagsArgs): Promise<TableOutputTag[]>
+  findTransactions(args: sdk.FindTransactionsArgs): Promise<TableTransaction[]>
+  findTxLabels(args: sdk.FindTxLabelsArgs): Promise<TableTxLabel[]>
 
   getProvenTxsForUser(
     args: sdk.FindForUserSincePagedArgs
-  ): Promise<table.ProvenTx[]>
+  ): Promise<TableProvenTx[]>
   getProvenTxReqsForUser(
     args: sdk.FindForUserSincePagedArgs
-  ): Promise<table.ProvenTxReq[]>
+  ): Promise<TableProvenTxReq[]>
   getTxLabelMapsForUser(
     args: sdk.FindForUserSincePagedArgs
-  ): Promise<table.TxLabelMap[]>
+  ): Promise<TableTxLabelMap[]>
   getOutputTagMapsForUser(
     args: sdk.FindForUserSincePagedArgs
-  ): Promise<table.OutputTagMap[]>
+  ): Promise<TableOutputTagMap[]>
 
   getSyncChunk(args: RequestSyncChunkArgs): Promise<SyncChunk>
 }
@@ -131,19 +149,19 @@ export interface SyncChunk {
   toStorageIdentityKey: string
   userIdentityKey: string
 
-  user?: table.User
-  provenTxs?: table.ProvenTx[]
-  provenTxReqs?: table.ProvenTxReq[]
-  outputBaskets?: table.OutputBasket[]
-  txLabels?: table.TxLabel[]
-  outputTags?: table.OutputTag[]
-  transactions?: table.Transaction[]
-  txLabelMaps?: table.TxLabelMap[]
-  commissions?: table.Commission[]
-  outputs?: table.Output[]
-  outputTagMaps?: table.OutputTagMap[]
-  certificates?: table.Certificate[]
-  certificateFields?: table.CertificateField[]
+  user?: TableUser
+  provenTxs?: TableProvenTx[]
+  provenTxReqs?: TableProvenTxReq[]
+  outputBaskets?: TableOutputBasket[]
+  txLabels?: TableTxLabel[]
+  outputTags?: TableOutputTag[]
+  transactions?: TableTransaction[]
+  txLabelMaps?: TableTxLabelMap[]
+  commissions?: TableCommission[]
+  outputs?: TableOutput[]
+  outputTagMaps?: TableOutputTagMap[]
+  certificates?: TableCertificate[]
+  certificateFields?: TableCertificateField[]
 }
 
 export interface ProcessSyncChunkResult {

package/src/sdk/StorageSyncReaderWriter.ts

@@ -1,4 +1,21 @@
-import { sdk, table } from '../index.client'
+import {
+  sdk,
+  TableCertificate,
+  TableCertificateField,
+  TableCommission,
+  TableOutput,
+  TableOutputBasket,
+  TableOutputTag,
+  TableOutputTagMap,
+  TableProvenTx,
+  TableProvenTxReq,
+  TableProvenTxReqDynamics,
+  TableSyncState,
+  TableTransaction,
+  TableTxLabel,
+  TableTxLabelMap,
+  TableUser
+} from '../index.client'
 
 /**
  * This is the minimal interface required for a WalletStorageProvider to import and export data to another provider.
@@ -18,97 +35,94 @@ export interface StorageSyncReaderWriter extends sdk.StorageSyncReader {
 
   findOutputTagMaps(
     args: sdk.FindOutputTagMapsArgs
-  ): Promise<table.OutputTagMap[]>
-  findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<table.ProvenTxReq[]>
-  findProvenTxs(args: sdk.FindProvenTxsArgs): Promise<table.ProvenTx[]>
-  findTxLabelMaps(args: sdk.FindTxLabelMapsArgs): Promise<table.TxLabelMap[]>
+  ): Promise<TableOutputTagMap[]>
+  findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<TableProvenTxReq[]>
+  findProvenTxs(args: sdk.FindProvenTxsArgs): Promise<TableProvenTx[]>
+  findTxLabelMaps(args: sdk.FindTxLabelMapsArgs): Promise<TableTxLabelMap[]>
 
   countOutputTagMaps(args: sdk.FindOutputTagMapsArgs): Promise<number>
   countProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<number>
   countProvenTxs(args: sdk.FindProvenTxsArgs): Promise<number>
   countTxLabelMaps(args: sdk.FindTxLabelMapsArgs): Promise<number>
 
-  insertProvenTx(tx: table.ProvenTx, trx?: sdk.TrxToken): Promise<number>
-  insertProvenTxReq(tx: table.ProvenTxReq, trx?: sdk.TrxToken): Promise<number>
-  insertUser(user: table.User, trx?: sdk.TrxToken): Promise<number>
+  insertProvenTx(tx: TableProvenTx, trx?: sdk.TrxToken): Promise<number>
+  insertProvenTxReq(tx: TableProvenTxReq, trx?: sdk.TrxToken): Promise<number>
+  insertUser(user: TableUser, trx?: sdk.TrxToken): Promise<number>
   insertCertificate(
-    certificate: table.Certificate,
+    certificate: TableCertificate,
     trx?: sdk.TrxToken
   ): Promise<number>
   insertCertificateField(
-    certificateField: table.CertificateField,
+    certificateField: TableCertificateField,
     trx?: sdk.TrxToken
   ): Promise<void>
   insertOutputBasket(
-    basket: table.OutputBasket,
+    basket: TableOutputBasket,
     trx?: sdk.TrxToken
   ): Promise<number>
-  insertTransaction(tx: table.Transaction, trx?: sdk.TrxToken): Promise<number>
+  insertTransaction(tx: TableTransaction, trx?: sdk.TrxToken): Promise<number>
   insertCommission(
-    commission: table.Commission,
+    commission: TableCommission,
     trx?: sdk.TrxToken
   ): Promise<number>
-  insertOutput(output: table.Output, trx?: sdk.TrxToken): Promise<number>
-  insertOutputTag(tag: table.OutputTag, trx?: sdk.TrxToken): Promise<number>
+  insertOutput(output: TableOutput, trx?: sdk.TrxToken): Promise<number>
+  insertOutputTag(tag: TableOutputTag, trx?: sdk.TrxToken): Promise<number>
   insertOutputTagMap(
-    tagMap: table.OutputTagMap,
-    trx?: sdk.TrxToken
-  ): Promise<void>
-  insertTxLabel(label: table.TxLabel, trx?: sdk.TrxToken): Promise<number>
-  insertTxLabelMap(
-    labelMap: table.TxLabelMap,
+    tagMap: TableOutputTagMap,
     trx?: sdk.TrxToken
   ): Promise<void>
+  insertTxLabel(label: TableTxLabel, trx?: sdk.TrxToken): Promise<number>
+  insertTxLabelMap(labelMap: TableTxLabelMap, trx?: sdk.TrxToken): Promise<void>
   insertSyncState(
-    syncState: table.SyncState,
+    syncState: TableSyncState,
     trx?: sdk.TrxToken
   ): Promise<number>
 
   updateCertificateField(
     certificateId: number,
     fieldName: string,
-    update: Partial<table.CertificateField>,
+    update: Partial<TableCertificateField>,
     trx?: sdk.TrxToken
   ): Promise<number>
   updateCertificate(
     id: number,
-    update: Partial<table.Certificate>,
+    update: Partial<TableCertificate>,
     trx?: sdk.TrxToken
   ): Promise<number>
   updateCommission(
     id: number,
-    update: Partial<table.Commission>,
+    update: Partial<TableCommission>,
     trx?: sdk.TrxToken
   ): Promise<number>
   updateOutputBasket(
     id: number,
-    update: Partial<table.OutputBasket>,
+    update: Partial<TableOutputBasket>,
     trx?: sdk.TrxToken
   ): Promise<number>
   updateOutput(
     id: number,
-    update: Partial<table.Output>,
+    update: Partial<TableOutput>,
     trx?: sdk.TrxToken
   ): Promise<number>
   updateOutputTagMap(
     outputId: number,
     tagId: number,
-    update: Partial<table.OutputTagMap>,
+    update: Partial<TableOutputTagMap>,
     trx?: sdk.TrxToken
   ): Promise<number>
   updateOutputTag(
     id: number,
-    update: Partial<table.OutputTag>,
+    update: Partial<TableOutputTag>,
     trx?: sdk.TrxToken
   ): Promise<number>
   updateProvenTxReq(
     id: number | number[],
-    update: Partial<table.ProvenTxReq>,
+    update: Partial<TableProvenTxReq>,
     trx?: sdk.TrxToken
   ): Promise<number>
   updateProvenTxReqDynamics(
     id: number,
-    update: Partial<table.ProvenTxReqDynamics>,
+    update: Partial<TableProvenTxReqDynamics>,
     trx?: sdk.TrxToken
   ): Promise<number>
   updateProvenTxReqWithNewProvenTx(
@@ -116,17 +130,17 @@ export interface StorageSyncReaderWriter extends sdk.StorageSyncReader {
   ): Promise<sdk.UpdateProvenTxReqWithNewProvenTxResult>
   updateProvenTx(
     id: number,
-    update: Partial<table.ProvenTx>,
+    update: Partial<TableProvenTx>,
     trx?: sdk.TrxToken
   ): Promise<number>
   updateSyncState(
     id: number,
-    update: Partial<table.SyncState>,
+    update: Partial<TableSyncState>,
     trx?: sdk.TrxToken
   ): Promise<number>
   updateTransaction(
     id: number | number[],
-    update: Partial<table.Transaction>,
+    update: Partial<TableTransaction>,
     trx?: sdk.TrxToken
   ): Promise<number>
   updateTransactionStatus(
@@ -143,115 +157,115 @@ export interface StorageSyncReaderWriter extends sdk.StorageSyncReader {
   updateTxLabelMap(
     transactionId: number,
     txLabelId: number,
-    update: Partial<table.TxLabelMap>,
+    update: Partial<TableTxLabelMap>,
     trx?: sdk.TrxToken
   ): Promise<number>
   updateTxLabel(
     id: number,
-    update: Partial<table.TxLabel>,
+    update: Partial<TableTxLabel>,
     trx?: sdk.TrxToken
   ): Promise<number>
   updateUser(
     id: number,
-    update: Partial<table.User>,
+    update: Partial<TableUser>,
     trx?: sdk.TrxToken
   ): Promise<number>
 
   findCertificateById(
     id: number,
     trx?: sdk.TrxToken
-  ): Promise<table.Certificate | undefined>
+  ): Promise<TableCertificate | undefined>
   findCommissionById(
     id: number,
     trx?: sdk.TrxToken
-  ): Promise<table.Commission | undefined>
+  ): Promise<TableCommission | undefined>
   findOutputById(
     id: number,
     trx?: sdk.TrxToken,
     noScript?: boolean
-  ): Promise<table.Output | undefined>
+  ): Promise<TableOutput | undefined>
   findOutputBasketById(
     id: number,
     trx?: sdk.TrxToken
-  ): Promise<table.OutputBasket | undefined>
+  ): Promise<TableOutputBasket | undefined>
   findProvenTxById(
     id: number,
     trx?: sdk.TrxToken | undefined
-  ): Promise<table.ProvenTx | undefined>
+  ): Promise<TableProvenTx | undefined>
   findProvenTxReqById(
     id: number,
     trx?: sdk.TrxToken | undefined
-  ): Promise<table.ProvenTxReq | undefined>
+  ): Promise<TableProvenTxReq | undefined>
   findSyncStateById(
     id: number,
     trx?: sdk.TrxToken
-  ): Promise<table.SyncState | undefined>
+  ): Promise<TableSyncState | undefined>
   findTransactionById(
     id: number,
     trx?: sdk.TrxToken,
     noRawTx?: boolean
-  ): Promise<table.Transaction | undefined>
+  ): Promise<TableTransaction | undefined>
   findTxLabelById(
     id: number,
     trx?: sdk.TrxToken
-  ): Promise<table.TxLabel | undefined>
+  ): Promise<TableTxLabel | undefined>
   findOutputTagById(
     id: number,
     trx?: sdk.TrxToken
-  ): Promise<table.OutputTag | undefined>
-  findUserById(id: number, trx?: sdk.TrxToken): Promise<table.User | undefined>
+  ): Promise<TableOutputTag | undefined>
+  findUserById(id: number, trx?: sdk.TrxToken): Promise<TableUser | undefined>
 
   findOrInsertUser(
     identityKey: string,
     trx?: sdk.TrxToken
-  ): Promise<{ user: table.User; isNew: boolean }>
+  ): Promise<{ user: TableUser; isNew: boolean }>
 
   findOrInsertTransaction(
-    newTx: table.Transaction,
+    newTx: TableTransaction,
     trx?: sdk.TrxToken
-  ): Promise<{ tx: table.Transaction; isNew: boolean }>
+  ): Promise<{ tx: TableTransaction; isNew: boolean }>
   findOrInsertOutputBasket(
     userId: number,
     name: string,
     trx?: sdk.TrxToken
-  ): Promise<table.OutputBasket>
+  ): Promise<TableOutputBasket>
   findOrInsertTxLabel(
     userId: number,
     label: string,
     trx?: sdk.TrxToken
-  ): Promise<table.TxLabel>
+  ): Promise<TableTxLabel>
   findOrInsertTxLabelMap(
     transactionId: number,
     txLabelId: number,
     trx?: sdk.TrxToken
-  ): Promise<table.TxLabelMap>
+  ): Promise<TableTxLabelMap>
   findOrInsertOutputTag(
     userId: number,
     tag: string,
     trx?: sdk.TrxToken
-  ): Promise<table.OutputTag>
+  ): Promise<TableOutputTag>
   findOrInsertOutputTagMap(
     outputId: number,
     outputTagId: number,
     trx?: sdk.TrxToken
-  ): Promise<table.OutputTagMap>
+  ): Promise<TableOutputTagMap>
   findOrInsertSyncStateAuth(
     auth: sdk.AuthId,
     storageIdentityKey: string,
     storageName: string
-  ): Promise<{ syncState: table.SyncState; isNew: boolean }>
+  ): Promise<{ syncState: TableSyncState; isNew: boolean }>
   findOrInsertProvenTxReq(
-    newReq: table.ProvenTxReq,
+    newReq: TableProvenTxReq,
     trx?: sdk.TrxToken
-  ): Promise<{ req: table.ProvenTxReq; isNew: boolean }>
+  ): Promise<{ req: TableProvenTxReq; isNew: boolean }>
   findOrInsertProvenTx(
-    newProven: table.ProvenTx,
+    newProven: TableProvenTx,
     trx?: sdk.TrxToken
-  ): Promise<{ proven: table.ProvenTx; isNew: boolean }>
-  findUsers(args: sdk.FindUsersArgs): Promise<table.User[]>
+  ): Promise<{ proven: TableProvenTx; isNew: boolean }>
+  findUsers(args: sdk.FindUsersArgs): Promise<TableUser[]>
 
   tagOutput(
-    partial: Partial<table.Output>,
+    partial: Partial<TableOutput>,
     tag: string,
     trx?: sdk.TrxToken
   ): Promise<void>