@bsv/wallet-toolbox 1.3.13 → 1.3.14

package/package.json

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

package/src/sdk/WalletServices.interfaces.ts

@@ -155,6 +155,19 @@ export interface WalletServices {
    * @param txOrLockTime either a bitcoin locktime value or hex, binary, un-encoded Transaction
    */
   nLockTimeIsFinal(txOrLockTime: string | number[] | BsvTransaction | number): Promise<boolean>
+
+  /**
+   * Constructs a `Beef` for the given `txid` using only external data retrieval services.
+   *
+   * In most cases, the `getBeefForTransaction` method of the `StorageProvider` class should be
+   * used instead to avoid redundantly retrieving data.
+   *
+   * @throws errors if txid does not correspond to a valid transaction as determined by the
+   * configured services.
+   *
+   * @param txid
+   */
+  getBeefForTxid(txid: string): Promise<Beef>
 }
 
 export type ScriptHashFormat = 'hashLE' | 'hashBE' | 'script'

package/src/services/Services.ts

@@ -7,6 +7,7 @@ import { WhatsOnChain } from './providers/WhatsOnChain'
 import { updateChaintracksFiatExchangeRates, updateExchangeratesapi } from './providers/echangeRates'
 import { ARC } from './providers/ARC'
 import { Bitails } from './providers/Bitails'
+import { getBeefForTxid } from './providers/getBeefForTxid'
 
 export class Services implements sdk.WalletServices {
   static createDefaultOptions(chain: sdk.Chain): sdk.WalletServicesOptions {
@@ -404,6 +405,11 @@ export class Services implements sdk.WalletServices {
     const height = await this.getHeight()
     return nLockTime < height
   }
+
+  async getBeefForTxid(txid: string): Promise<Beef> {
+    const beef = await getBeefForTxid(this, txid)
+    return beef
+  }
 }
 
 export function validateScriptHash(output: string, outputFormat?: sdk.GetUtxoStatusOutputFormat): string {

package/src/services/providers/getBeefForTxid.ts

@@ -0,0 +1,371 @@
+import { Beef, ListActionsResult, ListOutputsResult } from '@bsv/sdk'
+import {
+  TrxToken,
+  PurgeParams,
+  PurgeResults,
+  ProvenOrRawTx,
+  AuthId,
+  ValidListActionsArgs,
+  ValidListOutputsArgs,
+  FindCertificatesArgs,
+  FindOutputBasketsArgs,
+  FindOutputsArgs,
+  FindOutputTagMapsArgs,
+  FindProvenTxReqsArgs,
+  FindProvenTxsArgs,
+  FindTxLabelMapsArgs,
+  FindCertificateFieldsArgs,
+  FindCommissionsArgs,
+  FindMonitorEventsArgs,
+  FindOutputTagsArgs,
+  FindSyncStatesArgs,
+  FindTransactionsArgs,
+  FindTxLabelsArgs,
+  FindUsersArgs,
+  FindForUserSincePagedArgs,
+  StorageGetBeefOptions
+} from '../../sdk'
+import {
+  TableCertificate,
+  TableCertificateField,
+  TableCertificateX,
+  TableCommission,
+  TableMonitorEvent,
+  TableOutput,
+  TableOutputBasket,
+  TableOutputTag,
+  TableOutputTagMap,
+  TableProvenTx,
+  TableProvenTxReq,
+  TableSettings,
+  TableSyncState,
+  TableTransaction,
+  TableTxLabel,
+  TableTxLabelMap,
+  TableUser,
+  Services,
+  StorageAdminStats,
+} from '../../index.client'
+import { StorageProvider } from '../../storage/StorageProvider'
+
+export async function getBeefForTxid(services: Services, txid: string): Promise<Beef> {
+  const storage = new ServicesOnlyStorageProvider(services)
+  const beef = await storage.getBeefForTxid(txid)
+  return beef
+}
+
+/**
+ * The generalized implementation of getBeefForTransaction uses storage to
+ * avoid incurring the cost of redundant block chain data queries.
+ *
+ * This class makes the generalized implementation of getBeefForTransaction
+ * available in situations where there storage is not relevant.
+ */
+class ServicesOnlyStorageProvider extends StorageProvider {
+  gbo: StorageGetBeefOptions
+
+  constructor(services: Services) {
+    const o = StorageProvider.createStorageBaseOptions(services.chain)
+    super(o)
+    this.setServices(services)
+    this.gbo = {
+      ignoreServices: false,
+      ignoreStorage: true,
+      ignoreNewProven: true
+    }
+  }
+
+  async getBeefForTxid(txid: string): Promise<Beef> {
+    const beef = await this.getBeefForTransaction(txid, this.gbo)
+    return beef
+  }
+
+  nip = new Error('Method not implemented.')
+  override reviewStatus(args: { agedLimit: Date; trx?: TrxToken }): Promise<{ log: string }> {
+    throw this.nip
+  }
+  override purgeData(params: PurgeParams, trx?: TrxToken): Promise<PurgeResults> {
+    throw this.nip
+  }
+  override allocateChangeInput(
+    userId: number,
+    basketId: number,
+    targetSatoshis: number,
+    exactSatoshis: number | undefined,
+    excludeSending: boolean,
+    transactionId: number
+  ): Promise<TableOutput | undefined> {
+    throw this.nip
+  }
+  override getProvenOrRawTx(txid: string, trx?: TrxToken): Promise<ProvenOrRawTx> {
+    throw this.nip
+  }
+  override getRawTxOfKnownValidTransaction(
+    txid?: string,
+    offset?: number,
+    length?: number,
+    trx?: TrxToken
+  ): Promise<number[] | undefined> {
+    throw this.nip
+  }
+  override getLabelsForTransactionId(transactionId?: number, trx?: TrxToken): Promise<TableTxLabel[]> {
+    throw this.nip
+  }
+  override getTagsForOutputId(outputId: number, trx?: TrxToken): Promise<TableOutputTag[]> {
+    throw this.nip
+  }
+  override listActions(auth: AuthId, args: ValidListActionsArgs): Promise<ListActionsResult> {
+    throw this.nip
+  }
+  override listOutputs(auth: AuthId, args: ValidListOutputsArgs): Promise<ListOutputsResult> {
+    throw this.nip
+  }
+  override countChangeInputs(userId: number, basketId: number, excludeSending: boolean): Promise<number> {
+    throw this.nip
+  }
+  override findCertificatesAuth(auth: AuthId, args: FindCertificatesArgs): Promise<TableCertificateX[]> {
+    throw this.nip
+  }
+  override findOutputBasketsAuth(auth: AuthId, args: FindOutputBasketsArgs): Promise<TableOutputBasket[]> {
+    throw this.nip
+  }
+  override findOutputsAuth(auth: AuthId, args: FindOutputsArgs): Promise<TableOutput[]> {
+    throw this.nip
+  }
+  override insertCertificateAuth(auth: AuthId, certificate: TableCertificateX): Promise<number> {
+    throw this.nip
+  }
+  override dropAllData(): Promise<void> {
+    throw this.nip
+  }
+  override migrate(storageName: string, storageIdentityKey: string): Promise<string> {
+    throw this.nip
+  }
+  override findOutputTagMaps(args: FindOutputTagMapsArgs): Promise<TableOutputTagMap[]> {
+    throw this.nip
+  }
+  override findProvenTxReqs(args: FindProvenTxReqsArgs): Promise<TableProvenTxReq[]> {
+    throw this.nip
+  }
+  override findProvenTxs(args: FindProvenTxsArgs): Promise<TableProvenTx[]> {
+    throw this.nip
+  }
+  override findTxLabelMaps(args: FindTxLabelMapsArgs): Promise<TableTxLabelMap[]> {
+    throw this.nip
+  }
+  override countOutputTagMaps(args: FindOutputTagMapsArgs): Promise<number> {
+    throw this.nip
+  }
+  override countProvenTxReqs(args: FindProvenTxReqsArgs): Promise<number> {
+    throw this.nip
+  }
+  override countProvenTxs(args: FindProvenTxsArgs): Promise<number> {
+    throw this.nip
+  }
+  override countTxLabelMaps(args: FindTxLabelMapsArgs): Promise<number> {
+    throw this.nip
+  }
+  override insertCertificate(certificate: TableCertificate, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override insertCertificateField(certificateField: TableCertificateField, trx?: TrxToken): Promise<void> {
+    throw this.nip
+  }
+  override insertCommission(commission: TableCommission, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override insertMonitorEvent(event: TableMonitorEvent, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override insertOutput(output: TableOutput, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override insertOutputBasket(basket: TableOutputBasket, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override insertOutputTag(tag: TableOutputTag, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override insertOutputTagMap(tagMap: TableOutputTagMap, trx?: TrxToken): Promise<void> {
+    throw this.nip
+  }
+  override insertProvenTx(tx: TableProvenTx, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override insertProvenTxReq(tx: TableProvenTxReq, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override insertSyncState(syncState: TableSyncState, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override insertTransaction(tx: TableTransaction, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override insertTxLabel(label: TableTxLabel, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override insertTxLabelMap(labelMap: TableTxLabelMap, trx?: TrxToken): Promise<void> {
+    throw this.nip
+  }
+  override insertUser(user: TableUser, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override updateCertificate(id: number, update: Partial<TableCertificate>, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override updateCertificateField(
+    certificateId: number,
+    fieldName: string,
+    update: Partial<TableCertificateField>,
+    trx?: TrxToken
+  ): Promise<number> {
+    throw this.nip
+  }
+  override updateCommission(id: number, update: Partial<TableCommission>, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override updateMonitorEvent(id: number, update: Partial<TableMonitorEvent>, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override updateOutput(id: number, update: Partial<TableOutput>, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override updateOutputBasket(id: number, update: Partial<TableOutputBasket>, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override updateOutputTag(id: number, update: Partial<TableOutputTag>, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override updateOutputTagMap(
+    outputId: number,
+    tagId: number,
+    update: Partial<TableOutputTagMap>,
+    trx?: TrxToken
+  ): Promise<number> {
+    throw this.nip
+  }
+  override updateProvenTx(id: number, update: Partial<TableProvenTx>, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override updateProvenTxReq(
+    id: number | number[],
+    update: Partial<TableProvenTxReq>,
+    trx?: TrxToken
+  ): Promise<number> {
+    throw this.nip
+  }
+  override updateSyncState(id: number, update: Partial<TableSyncState>, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override updateTransaction(
+    id: number | number[],
+    update: Partial<TableTransaction>,
+    trx?: TrxToken
+  ): Promise<number> {
+    throw this.nip
+  }
+  override updateTxLabel(id: number, update: Partial<TableTxLabel>, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override updateTxLabelMap(
+    transactionId: number,
+    txLabelId: number,
+    update: Partial<TableTxLabelMap>,
+    trx?: TrxToken
+  ): Promise<number> {
+    throw this.nip
+  }
+  override updateUser(id: number, update: Partial<TableUser>, trx?: TrxToken): Promise<number> {
+    throw this.nip
+  }
+  override destroy(): Promise<void> {
+    throw this.nip
+  }
+  override transaction<T>(scope: (trx: TrxToken) => Promise<T>, trx?: TrxToken): Promise<T> {
+    throw this.nip
+  }
+  override readSettings(trx?: TrxToken): Promise<TableSettings> {
+    throw this.nip
+  }
+  override findCertificateFields(args: FindCertificateFieldsArgs): Promise<TableCertificateField[]> {
+    throw this.nip
+  }
+  override findCertificates(args: FindCertificatesArgs): Promise<TableCertificateX[]> {
+    throw this.nip
+  }
+  override findCommissions(args: FindCommissionsArgs): Promise<TableCommission[]> {
+    throw this.nip
+  }
+  override findMonitorEvents(args: FindMonitorEventsArgs): Promise<TableMonitorEvent[]> {
+    throw this.nip
+  }
+  override findOutputBaskets(args: FindOutputBasketsArgs): Promise<TableOutputBasket[]> {
+    throw this.nip
+  }
+  override findOutputs(args: FindOutputsArgs): Promise<TableOutput[]> {
+    throw this.nip
+  }
+  override findOutputTags(args: FindOutputTagsArgs): Promise<TableOutputTag[]> {
+    throw this.nip
+  }
+  override findSyncStates(args: FindSyncStatesArgs): Promise<TableSyncState[]> {
+    throw this.nip
+  }
+  override findTransactions(args: FindTransactionsArgs): Promise<TableTransaction[]> {
+    throw this.nip
+  }
+  override findTxLabels(args: FindTxLabelsArgs): Promise<TableTxLabel[]> {
+    throw this.nip
+  }
+  override findUsers(args: FindUsersArgs): Promise<TableUser[]> {
+    throw this.nip
+  }
+  override countCertificateFields(args: FindCertificateFieldsArgs): Promise<number> {
+    throw this.nip
+  }
+  override countCertificates(args: FindCertificatesArgs): Promise<number> {
+    throw this.nip
+  }
+  override countCommissions(args: FindCommissionsArgs): Promise<number> {
+    throw this.nip
+  }
+  override countMonitorEvents(args: FindMonitorEventsArgs): Promise<number> {
+    throw this.nip
+  }
+  override countOutputBaskets(args: FindOutputBasketsArgs): Promise<number> {
+    throw this.nip
+  }
+  override countOutputs(args: FindOutputsArgs): Promise<number> {
+    throw this.nip
+  }
+  override countOutputTags(args: FindOutputTagsArgs): Promise<number> {
+    throw this.nip
+  }
+  override countSyncStates(args: FindSyncStatesArgs): Promise<number> {
+    throw this.nip
+  }
+  override countTransactions(args: FindTransactionsArgs): Promise<number> {
+    throw this.nip
+  }
+  override countTxLabels(args: FindTxLabelsArgs): Promise<number> {
+    throw this.nip
+  }
+  override countUsers(args: FindUsersArgs): Promise<number> {
+    throw this.nip
+  }
+  override getProvenTxsForUser(args: FindForUserSincePagedArgs): Promise<TableProvenTx[]> {
+    throw this.nip
+  }
+  override getProvenTxReqsForUser(args: FindForUserSincePagedArgs): Promise<TableProvenTxReq[]> {
+    throw this.nip
+  }
+  override getTxLabelMapsForUser(args: FindForUserSincePagedArgs): Promise<TableTxLabelMap[]> {
+    throw this.nip
+  }
+  override getOutputTagMapsForUser(args: FindForUserSincePagedArgs): Promise<TableOutputTagMap[]> {
+    throw this.nip
+  }
+  override adminStats(adminIdentityKey: string): Promise<StorageAdminStats> {
+    throw this.nip
+  }
+}

package/src/storage/__test/StorageIdb.test.ts

@@ -29,7 +29,14 @@ describe('StorageIdb tests', () => {
     await store.migrate(store.dbName, PrivateKey.fromRandom().toHex())
     await store.makeAvailable()
     await wallet.storage.addWalletStorageProvider(store)
-    await wallet.storage.setActive(stores[0].storageIdentityKey, (s) => { console.log(s); return s })
-    await wallet.storage.updateBackups(undefined, (s) => { console.log(s); return s })
+    await wallet.storage.setActive(stores[0].storageIdentityKey, s => {
+      console.log(s)
+      return s
+    })
+    await wallet.storage.updateBackups(undefined, s => {
+      console.log(s)
+      return s
+    })
+    await wallet.destroy()
   })
 })

package/src/storage/schema/entities/__tests/ProvenTxTests.test.ts

@@ -134,7 +134,9 @@ describe('ProvenTx class method tests', () => {
         height: height,
         hash: blockHash
       }),
-      nLockTimeIsFinal: async () => true
+      nLockTimeIsFinal: async () => true,
+
+      getBeefForTxid: async () => new bsv.Beef()
     }
 
     // Call the method under test