@bsv/wallet-toolbox 1.1.7 → 1.1.9

package/src/storage/index.client.ts

@@ -1,6 +1,6 @@
 export * from './WalletStorageManager'
 export * from './StorageProvider'
 export * from './StorageSyncReader'
-export * as table from './schema/tables'
-export * as entity from './schema/entities'
+export * from './schema/tables/index'
+export * from './schema/entities/index'
 export * from './remoting/StorageClient'

package/src/storage/methods/attemptToPostReqsToNetwork.ts

@@ -1,6 +1,6 @@
 import { Beef } from '@bsv/sdk'
 import { StorageProvider } from '../StorageProvider'
-import { entity, sdk } from '../../index.client'
+import { EntityProvenTxReq, sdk } from '../../index.client'
 
 /**
  * Attempt to post one or more `ProvenTxReq` with status 'unsent'
@@ -10,7 +10,7 @@ import { entity, sdk } from '../../index.client'
  */
 export async function attemptToPostReqsToNetwork(
   storage: StorageProvider,
-  reqs: entity.ProvenTxReq[],
+  reqs: EntityProvenTxReq[],
   trx?: sdk.TrxToken
 ): Promise<PostReqsToNetworkResult> {
   const r: PostReqsToNetworkResult = {
@@ -169,7 +169,7 @@ export type PostReqsToNetworkDetailsStatus =
 
 export interface PostReqsToNetworkDetails {
   txid: string
-  req: entity.ProvenTxReq
+  req: EntityProvenTxReq
   status: PostReqsToNetworkDetailsStatus
   pbrft: sdk.PostTxResultForTxid
   data?: string

package/src/storage/methods/createAction.ts

@@ -14,14 +14,17 @@ import {
 import {
   asArray,
   asString,
-  entity,
+  EntityProvenTx,
   randomBytesBase64,
   sdk,
   sha256Hash,
   stampLog,
   stampLogFormat,
   StorageProvider,
-  table,
+  TableOutput,
+  TableOutputBasket,
+  TableOutputTag,
+  TableTransaction,
   validateStorageFeeModel,
   verifyId,
   verifyNumber,
@@ -157,8 +160,8 @@ export async function createAction(
 interface CreateTransactionSdkContext {
   xinputs: XValidCreateActionInput[]
   xoutputs: XValidCreateActionOutput[]
-  changeBasket: table.OutputBasket
-  noSendChangeIn: table.Output[]
+  changeBasket: TableOutputBasket
+  noSendChangeIn: TableOutput[]
   availableChangeCount: number
   feeModel: sdk.StorageFeeModel
   transactionId: number
@@ -168,7 +171,7 @@ interface XValidCreateActionInput extends sdk.ValidCreateActionInput {
   vin: number
   lockingScript: Script
   satoshis: number
-  output?: table.Output
+  output?: TableOutput
 }
 
 export interface XValidCreateActionOutput extends sdk.ValidCreateActionOutput {
@@ -184,9 +187,9 @@ function makeDefaultOutput(
   transactionId: number,
   satoshis: number,
   vout: number
-): table.Output {
+): TableOutput {
   const now = new Date()
-  const output: table.Output = {
+  const output: TableOutput = {
     created_at: now,
     updated_at: now,
     outputId: 0,
@@ -219,13 +222,13 @@ async function createNewInputs(
   userId: number,
   vargs: sdk.ValidCreateActionArgs,
   ctx: CreateTransactionSdkContext,
-  allocatedChange: table.Output[]
+  allocatedChange: TableOutput[]
 ): Promise<sdk.StorageCreateTransactionSdkInput[]> {
   const r: sdk.StorageCreateTransactionSdkInput[] = []
 
   const newInputs: {
     i?: XValidCreateActionInput
-    o?: table.Output
+    o?: TableOutput
     unlockLen?: number
   }[] = []
   for (const i of ctx.xinputs) {
@@ -298,7 +301,7 @@ async function createNewOutputs(
   userId: number,
   vargs: sdk.ValidCreateActionArgs,
   ctx: CreateTransactionSdkContext,
-  changeOutputs: table.Output[]
+  changeOutputs: TableOutput[]
 ): Promise<{
   outputs: sdk.StorageCreateTransactionSdkOutput[]
   changeVouts: number[]
@@ -306,7 +309,7 @@ async function createNewOutputs(
   const outputs: sdk.StorageCreateTransactionSdkOutput[] = []
 
   // Lookup output baskets
-  const txBaskets: Record<string, table.OutputBasket> = {}
+  const txBaskets: Record<string, TableOutputBasket> = {}
   for (const xo of ctx.xoutputs) {
     if (xo.basket !== undefined && !txBaskets[xo.basket])
       txBaskets[xo.basket] = await storage.findOrInsertOutputBasket(
@@ -315,14 +318,14 @@ async function createNewOutputs(
       )
   }
   // Lookup output tags
-  const txTags: Record<string, table.OutputTag> = {}
+  const txTags: Record<string, TableOutputTag> = {}
   for (const xo of ctx.xoutputs) {
     for (const tag of xo.tags) {
       txTags[tag] = await storage.findOrInsertOutputTag(userId, tag)
     }
   }
 
-  const newOutputs: { o: table.Output; tags: string[] }[] = []
+  const newOutputs: { o: TableOutput; tags: string[] }[] = []
 
   for (const xo of ctx.xoutputs) {
     const lockingScript = asArray(xo.lockingScript)
@@ -463,9 +466,9 @@ async function createNewTxRecord(
   userId: number,
   vargs: sdk.ValidCreateActionArgs,
   storageBeef: Beef
-): Promise<table.Transaction> {
+): Promise<TableTransaction> {
   const now = new Date()
-  const newTx: table.Transaction = {
+  const newTx: TableTransaction = {
     created_at: now,
     updated_at: now,
     transactionId: 0,
@@ -695,7 +698,7 @@ async function validateRequiredInputs(
             `valid and contain proof data for ${txid}`
           )
         btx = beef.mergeRawTx(asArray(rawTx))
-        if (proven) beef.mergeBump(new entity.ProvenTx(proven).getMerklePath())
+        if (proven) beef.mergeBump(new EntityProvenTx(proven).getMerklePath())
       }
       // btx is valid has parsed transaction data.
       if (vout >= btx.tx.outputs.length)
@@ -716,9 +719,9 @@ async function validateNoSendChange(
   storage: StorageProvider,
   userId: number,
   vargs: sdk.ValidCreateActionArgs,
-  changeBasket: table.OutputBasket
-): Promise<table.Output[]> {
-  const r: table.Output[] = []
+  changeBasket: TableOutputBasket
+): Promise<TableOutput[]> {
+  const r: TableOutput[] = []
 
   if (!vargs.isNoSend) return []
 
@@ -761,8 +764,8 @@ async function fundNewTransactionSdk(
   vargs: sdk.ValidCreateActionArgs,
   ctx: CreateTransactionSdkContext
 ): Promise<{
-  allocatedChange: table.Output[]
-  changeOutputs: table.Output[]
+  allocatedChange: TableOutput[]
+  changeOutputs: TableOutput[]
   derivationPrefix: string
 }> {
   const params: GenerateChangeSdkParams = {
@@ -788,7 +791,7 @@ async function fundNewTransactionSdk(
   }
 
   const noSendChange = [...ctx.noSendChangeIn]
-  const outputs: Record<number, table.Output> = {}
+  const outputs: Record<number, TableOutput> = {}
 
   const allocateChangeInput = async (
     targetSatoshis: number,
@@ -885,14 +888,14 @@ async function fundNewTransactionSdk(
   const derivationPrefix = randomDerivation(16)
 
   const r: {
-    allocatedChange: table.Output[]
-    changeOutputs: table.Output[]
+    allocatedChange: TableOutput[]
+    changeOutputs: TableOutput[]
     derivationPrefix: string
   } = {
     allocatedChange: gcr.allocatedChangeInputs.map(i => outputs[i.outputId]),
     changeOutputs: gcr.changeOutputs.map(
       (o, i) =>
-        <table.Output>{
+        <TableOutput>{
           // what we knnow now and can insert into the database for this new transaction's change output
           created_at: new Date(),
           updated_at: new Date(),
@@ -949,7 +952,7 @@ async function mergeAllocatedChangeBeefs(
   storage: StorageProvider,
   userId: number,
   vargs: sdk.ValidCreateActionArgs,
-  allocatedChange: table.Output[],
+  allocatedChange: TableOutput[],
   beef: Beef
 ): Promise<number[] | undefined> {
   const options: sdk.StorageGetBeefOptions = {

package/src/storage/methods/getBeefForTransaction.ts

@@ -1,7 +1,7 @@
 import { Beef } from '@bsv/sdk'
 import {
   asBsvSdkTx,
-  entity,
+  EntityProvenTx,
   sdk,
   StorageProvider,
   verifyTruthy
@@ -51,7 +51,7 @@ async function getProvenOrRawTxFromServices(
   options: sdk.StorageGetBeefOptions
 ): Promise<sdk.ProvenOrRawTx> {
   const services = storage.getServices()
-  const por = await entity.ProvenTx.fromTxid(txid, await storage.getServices())
+  const por = await EntityProvenTx.fromTxid(txid, await storage.getServices())
   if (por.proven && !options.ignoreStorage && !options.ignoreNewProven) {
     por.proven.provenTxId = await storage.insertProvenTx(por.proven.toApi())
   }
@@ -111,7 +111,7 @@ async function mergeBeefForTransactionRecurse(
     // storage has proven this txid,
     // merge both the raw transaction and its merkle path
     beef.mergeRawTx(r.proven.rawTx)
-    beef.mergeBump(new entity.ProvenTx(r.proven).getMerklePath())
+    beef.mergeBump(new EntityProvenTx(r.proven).getMerklePath())
     return beef
   }
 

package/src/storage/methods/getSyncChunk.ts

@@ -1,4 +1,19 @@
-import { sdk, table, verifyTruthy } from '../../index.client'
+import {
+  sdk,
+  TableCertificate,
+  TableCertificateField,
+  TableCommission,
+  TableOutput,
+  TableOutputBasket,
+  TableOutputTag,
+  TableOutputTagMap,
+  TableProvenTx,
+  TableProvenTxReq,
+  TableTransaction,
+  TableTxLabel,
+  TableTxLabelMap,
+  verifyTruthy
+} from '../../index.client'
 import { StorageReader } from '../StorageReader'
 
 /**
@@ -34,7 +49,7 @@ export async function getSyncChunk(
       preAdd: () => {
         r.provenTxs = []
       },
-      addItem: (i: table.ProvenTx) => {
+      addItem: (i: TableProvenTx) => {
         r.provenTxs!.push(i)
       },
       findItems: async (
@@ -50,7 +65,7 @@ export async function getSyncChunk(
       preAdd: () => {
         r.outputBaskets = []
       },
-      addItem: (i: table.OutputBasket) => {
+      addItem: (i: TableOutputBasket) => {
         r.outputBaskets!.push(i)
       },
       findItems: async (
@@ -70,7 +85,7 @@ export async function getSyncChunk(
       preAdd: () => {
         r.outputTags = []
       },
-      addItem: (i: table.OutputTag) => {
+      addItem: (i: TableOutputTag) => {
         r.outputTags!.push(i)
       },
       findItems: async (
@@ -90,7 +105,7 @@ export async function getSyncChunk(
       preAdd: () => {
         r.txLabels = []
       },
-      addItem: (i: table.TxLabel) => {
+      addItem: (i: TableTxLabel) => {
         r.txLabels!.push(i)
       },
       findItems: async (
@@ -110,7 +125,7 @@ export async function getSyncChunk(
       preAdd: () => {
         r.transactions = []
       },
-      addItem: (i: table.Transaction) => {
+      addItem: (i: TableTransaction) => {
         r.transactions!.push(i)
       },
       findItems: async (
@@ -130,7 +145,7 @@ export async function getSyncChunk(
       preAdd: () => {
         r.outputs = []
       },
-      addItem: (i: table.Output) => {
+      addItem: (i: TableOutput) => {
         r.outputs!.push(i)
       },
       findItems: async (
@@ -150,7 +165,7 @@ export async function getSyncChunk(
       preAdd: () => {
         r.txLabelMaps = []
       },
-      addItem: (i: table.TxLabelMap) => {
+      addItem: (i: TableTxLabelMap) => {
         r.txLabelMaps!.push(i)
       },
       findItems: async (
@@ -166,7 +181,7 @@ export async function getSyncChunk(
       preAdd: () => {
         r.outputTagMaps = []
       },
-      addItem: (i: table.OutputTagMap) => {
+      addItem: (i: TableOutputTagMap) => {
         r.outputTagMaps!.push(i)
       },
       findItems: async (
@@ -182,7 +197,7 @@ export async function getSyncChunk(
       preAdd: () => {
         r.certificates = []
       },
-      addItem: (i: table.Certificate) => {
+      addItem: (i: TableCertificate) => {
         r.certificates!.push(i)
       },
       findItems: async (
@@ -202,7 +217,7 @@ export async function getSyncChunk(
       preAdd: () => {
         r.certificateFields = []
       },
-      addItem: (i: table.CertificateField) => {
+      addItem: (i: TableCertificateField) => {
         r.certificateFields!.push(i)
       },
       findItems: async (
@@ -222,7 +237,7 @@ export async function getSyncChunk(
       preAdd: () => {
         r.commissions = []
       },
-      addItem: (i: table.Commission) => {
+      addItem: (i: TableCommission) => {
         r.commissions!.push(i)
       },
       findItems: async (
@@ -242,7 +257,7 @@ export async function getSyncChunk(
       preAdd: () => {
         r.provenTxReqs = []
       },
-      addItem: (i: table.ProvenTxReq) => {
+      addItem: (i: TableProvenTxReq) => {
         r.provenTxReqs!.push(i)
       },
       findItems: async (

package/src/storage/methods/internalizeAction.ts

@@ -10,12 +10,14 @@ import {
   Beef
 } from '@bsv/sdk'
 import {
-  entity,
+  EntityProvenTxReq,
   randomBytesBase64,
   sdk,
   stampLog,
   StorageProvider,
-  table,
+  TableOutput,
+  TableOutputBasket,
+  TableTransaction,
   verifyId,
   verifyOne,
   verifyOneOrNone
@@ -77,7 +79,7 @@ interface BasketInsertionX extends BasketInsertion {
   /** incoming transaction output */
   txo: TransactionOutput
   /** if valid, corresponding storage output  */
-  eo?: table.Output
+  eo?: TableOutput
 }
 
 interface WalletPaymentX extends WalletPayment {
@@ -86,7 +88,7 @@ interface WalletPaymentX extends WalletPayment {
   /** incoming transaction output */
   txo: TransactionOutput
   /** if valid, corresponding storage output  */
-  eo?: table.Output
+  eo?: TableOutput
   /** corresponds to an existing change output */
   ignore: boolean
 }
@@ -99,13 +101,13 @@ class InternalizeActionContext {
   /** the incoming transaction extracted from AtomicBEEF */
   tx: BsvTransaction
   /** the user's change basket */
-  changeBasket: table.OutputBasket
+  changeBasket: TableOutputBasket
   /** cached baskets referenced by basket insertions */
-  baskets: Record<string, table.OutputBasket>
+  baskets: Record<string, TableOutputBasket>
   /** existing storage transaction for this txid and userId */
-  etx?: table.Transaction
+  etx?: TableTransaction
   /** existing outputs */
-  eos: table.Output[]
+  eos: TableOutput[]
   /** all the basket insertions from incoming outputs array */
   basketInsertions: BasketInsertionX[]
   /** all the wallet payments from incoming outputs array */
@@ -128,7 +130,7 @@ class InternalizeActionContext {
     }
     this.ab = new Beef()
     this.tx = new BsvTransaction()
-    this.changeBasket = {} as table.OutputBasket
+    this.changeBasket = {} as TableOutputBasket
     this.baskets = {}
     this.basketInsertions = []
     this.walletPayments = []
@@ -154,7 +156,7 @@ class InternalizeActionContext {
     this.r.satoshis = v
   }
 
-  async getBasket(basketName: string): Promise<table.OutputBasket> {
+  async getBasket(basketName: string): Promise<TableOutputBasket> {
     let b = this.baskets[basketName]
     if (b) return b
     b = await this.storage.findOrInsertOutputBasket(this.userId, basketName)
@@ -322,9 +324,9 @@ class InternalizeActionContext {
   async findOrInsertTargetTransaction(
     satoshis: number,
     status: sdk.TransactionStatus
-  ): Promise<table.Transaction> {
+  ): Promise<TableTransaction> {
     const now = new Date()
-    const newTx: table.Transaction = {
+    const newTx: TableTransaction = {
       created_at: now,
       updated_at: now,
       transactionId: 0,
@@ -386,7 +388,7 @@ class InternalizeActionContext {
 
     // transaction record for user is new, but the txid may not be new to storage
     // make sure storage pursues getting a proof for it.
-    const newReq = entity.ProvenTxReq.fromTxid(
+    const newReq = EntityProvenTxReq.fromTxid(
       this.txid,
       this.tx.toBinary(),
       this.args.tx
@@ -428,7 +430,7 @@ class InternalizeActionContext {
     payment: WalletPaymentX
   ): Promise<void> {
     const now = new Date()
-    const txOut: table.Output = {
+    const txOut: TableOutput = {
       created_at: now,
       updated_at: now,
       outputId: 0,
@@ -462,7 +464,7 @@ class InternalizeActionContext {
     payment: WalletPaymentX
   ) {
     const outputId = payment.eo!.outputId!
-    const update: Partial<table.Output> = {
+    const update: Partial<TableOutput> = {
       basketId: this.changeBasket.basketId,
       type: 'P2PKH',
       customInstructions: undefined,
@@ -482,7 +484,7 @@ class InternalizeActionContext {
     basket: BasketInsertionX
   ) {
     const outputId = basket.eo!.outputId!
-    const update: Partial<table.Output> = {
+    const update: Partial<TableOutput> = {
       basketId: (await this.getBasket(basket.basket)).basketId,
       type: 'custom',
       customInstructions: basket.customInstructions,
@@ -502,7 +504,7 @@ class InternalizeActionContext {
     basket: BasketInsertionX
   ): Promise<void> {
     const now = new Date()
-    const txOut: table.Output = {
+    const txOut: TableOutput = {
       created_at: now,
       updated_at: now,
       outputId: 0,

package/src/storage/methods/listActions.ts

@@ -6,7 +6,7 @@ import {
   WalletActionOutput,
   WalletActionInput
 } from '@bsv/sdk'
-import { table } from '../index.client'
+import { TableOutputX, TableTransaction, TableTxLabel } from '../index.client'
 import { asString, sdk, verifyOne } from '../../index.client'
 import { StorageKnex } from '../StorageKnex'
 
@@ -27,7 +27,7 @@ export async function listActions(
 
   let labelIds: number[] = []
   if (vargs.labels.length > 0) {
-    const q = k<table.TxLabel>('tx_labels')
+    const q = k<TableTxLabel>('tx_labels')
       .where({
         userId: auth.userId,
         isDeleted: false
@@ -107,7 +107,7 @@ export async function listActions(
 
   q.limit(limit).offset(offset).orderBy('transactionId', 'asc')
 
-  const txs: Partial<table.Transaction>[] = await q
+  const txs: Partial<TableTransaction>[] = await q
 
   if (!limit || txs.length < limit) r.totalActions = txs.length
   else {
@@ -141,7 +141,7 @@ export async function listActions(
           ).map(l => l.label)
         }
         if (vargs.includeOutputs) {
-          const outputs: table.OutputX[] = await storage.findOutputs({
+          const outputs: TableOutputX[] = await storage.findOutputs({
             partial: { transactionId: tx.transactionId },
             noScript: !vargs.includeOutputLockingScripts
           })
@@ -162,7 +162,7 @@ export async function listActions(
           }
         }
         if (vargs.includeInputs) {
-          const inputs: table.OutputX[] = await storage.findOutputs({
+          const inputs: TableOutputX[] = await storage.findOutputs({
             partial: { spentBy: tx.transactionId },
             noScript: !vargs.includeInputSourceLockingScripts
           })

package/src/storage/methods/listCertificates.ts

@@ -2,7 +2,7 @@ import {
   ListCertificatesResult,
   OriginatorDomainNameStringUnder250Bytes
 } from '@bsv/sdk'
-import { StorageProvider, table } from '../index.client'
+import { StorageProvider, TableCertificate } from '../index.client'
 import { sdk } from '../../index.client'
 
 export async function listCertificates(
@@ -13,7 +13,7 @@ export async function listCertificates(
 ): Promise<ListCertificatesResult> {
   const paged: sdk.Paged = { limit: vargs.limit, offset: vargs.offset }
 
-  const partial: Partial<table.Certificate> = {
+  const partial: Partial<TableCertificate> = {
     userId: auth.userId,
     isDeleted: false
   }

package/src/storage/methods/listOutputs.ts

@@ -4,7 +4,7 @@ import {
   OriginatorDomainNameStringUnder250Bytes,
   WalletOutput
 } from '@bsv/sdk'
-import { table } from '../index.client'
+import { TableOutput, TableOutputBasket, TableOutputTag } from '../index.client'
 import { asString, sdk, verifyId, verifyOne } from '../../index.client'
 import { StorageKnex } from '../StorageKnex'
 
@@ -39,7 +39,7 @@ export async function listOutputs(
     */
 
   let basketId: number | undefined = undefined
-  const basketsById: Record<number, table.OutputBasket> = {}
+  const basketsById: Record<number, TableOutputBasket> = {}
   if (vargs.basket) {
     const baskets = await dsk.findOutputBaskets({
       partial: { userId, name: vargs.basket },
@@ -56,7 +56,7 @@ export async function listOutputs(
 
   let tagIds: number[] = []
   if (vargs.tags && vargs.tags.length > 0) {
-    const q = k<table.OutputTag>('output_tags')
+    const q = k<TableOutputTag>('output_tags')
       .where({
         userId: userId,
         isDeleted: false
@@ -119,7 +119,7 @@ export async function listOutputs(
   }
 
   const makeWithoutTagsQueries = () => {
-    const where: Partial<table.Output> = { userId }
+    const where: Partial<TableOutput> = { userId }
     if (basketId) where.basketId = basketId
     if (!includeSpent) where.spendable = true
     const q = k('outputs').where(where).whereRaw(txStatusOk)
@@ -134,7 +134,7 @@ export async function listOutputs(
   // Sort order when limit and offset are possible must be ascending for determinism.
   q.limit(limit).offset(offset).orderBy('outputId', 'asc')
 
-  const outputs: table.Output[] = await q
+  const outputs: TableOutput[] = await q
 
   if (!limit || outputs.length < limit) r.totalOutputs = outputs.length
   else {