@bsv/wallet-toolbox 1.1.6 → 1.1.8

package/src/storage/schema/entities/ProvenTxReq.ts

@@ -2,53 +2,53 @@ import { MerklePath } from '@bsv/sdk'
 import {
   arraysEqual,
   asString,
-  entity,
   sdk,
   StorageProvider,
-  table,
+  TableProvenTxReq,
+  TableProvenTxReqDynamics,
   verifyId,
   verifyOne,
   verifyOneOrNone,
   verifyTruthy,
   WalletStorageManager
 } from '../../../index.client'
-import { EntityBase } from '.'
+import { EntityBase, EntityStorage, SyncMap } from '.'
 
 import { StorageProcessActionArgs } from '../../../sdk'
 
-export class ProvenTxReq extends EntityBase<table.ProvenTxReq> {
+export class EntityProvenTxReq extends EntityBase<TableProvenTxReq> {
   static async fromStorageTxid(
-    storage: entity.EntityStorage,
+    storage: EntityStorage,
     txid: string,
     trx?: sdk.TrxToken
-  ): Promise<ProvenTxReq | undefined> {
+  ): Promise<EntityProvenTxReq | undefined> {
     const reqApi = verifyOneOrNone(
       await storage.findProvenTxReqs({ partial: { txid }, trx })
     )
     if (!reqApi) return undefined
-    return new ProvenTxReq(reqApi)
+    return new EntityProvenTxReq(reqApi)
   }
 
   static async fromStorageId(
-    storage: entity.EntityStorage,
+    storage: EntityStorage,
     id: number,
     trx?: sdk.TrxToken
-  ): Promise<ProvenTxReq> {
+  ): Promise<EntityProvenTxReq> {
     const reqApi = verifyOneOrNone(
       await storage.findProvenTxReqs({ partial: { provenTxReqId: id }, trx })
     )
     if (!reqApi)
       throw new sdk.WERR_INTERNAL(`proven_tx_reqs with id ${id} is missing.`)
-    return new ProvenTxReq(reqApi)
+    return new EntityProvenTxReq(reqApi)
   }
 
   static fromTxid(
     txid: string,
     rawTx: number[],
     inputBEEF?: number[]
-  ): ProvenTxReq {
+  ): EntityProvenTxReq {
     const now = new Date()
-    return new ProvenTxReq({
+    return new EntityProvenTxReq({
       provenTxReqId: 0,
       created_at: now,
       updated_at: now,
@@ -118,7 +118,7 @@ export class ProvenTxReq extends EntityBase<table.ProvenTxReq> {
   }
 
   async refreshFromStorage(
-    storage: entity.EntityStorage | WalletStorageManager
+    storage: EntityStorage | WalletStorageManager
   ): Promise<void> {
     const newApi = verifyOne(
       await storage.findProvenTxReqs({ partial: { provenTxReqId: this.id } })
@@ -127,7 +127,7 @@ export class ProvenTxReq extends EntityBase<table.ProvenTxReq> {
     this.unpackApi()
   }
 
-  constructor(api?: table.ProvenTxReq) {
+  constructor(api?: TableProvenTxReq) {
     const now = new Date()
     super(
       api || {
@@ -294,18 +294,18 @@ export class ProvenTxReq extends EntityBase<table.ProvenTxReq> {
   }
 
   /**
-     * Updates database record with current state of this entity.
+     * Updates database record with current state of this EntityUser
 
      * @param storage 
      * @param trx 
      */
-  async updateStorage(storage: entity.EntityStorage, trx?: sdk.TrxToken) {
+  async updateStorage(storage: EntityStorage, trx?: sdk.TrxToken) {
     this.updated_at = new Date()
     this.updateApi()
     if (this.id === 0) {
       await storage.insertProvenTxReq(this.api)
     }
-    const update: Partial<table.ProvenTxReq> = { ...this.api }
+    const update: Partial<TableProvenTxReq> = { ...this.api }
     await storage.updateProvenTxReq(this.id, update, trx)
   }
 
@@ -329,7 +329,7 @@ export class ProvenTxReq extends EntityBase<table.ProvenTxReq> {
   ) {
     this.updated_at = new Date()
     this.updateApi()
-    const update: Partial<table.ProvenTxReqDynamics> = {
+    const update: Partial<TableProvenTxReqDynamics> = {
       updated_at: this.api.updated_at,
       provenTxId: this.api.provenTxId,
       status: this.api.status,
@@ -351,19 +351,19 @@ export class ProvenTxReq extends EntityBase<table.ProvenTxReq> {
   }
 
   async insertOrMerge(
-    storage: entity.EntityStorage,
+    storage: EntityStorage,
     trx?: sdk.TrxToken
-  ): Promise<ProvenTxReq> {
-    const req = await storage.transaction<ProvenTxReq>(async trx => {
+  ): Promise<EntityProvenTxReq> {
+    const req = await storage.transaction<EntityProvenTxReq>(async trx => {
       let reqApi0 = this.toApi()
       const { req: reqApi1, isNew } = await storage.findOrInsertProvenTxReq(
         reqApi0,
         trx
       )
       if (isNew) {
-        return new entity.ProvenTxReq(reqApi1)
+        return new EntityProvenTxReq(reqApi1)
       } else {
-        const req = new ProvenTxReq(reqApi1)
+        const req = new EntityProvenTxReq(reqApi1)
         req.mergeNotifyTransactionIds(reqApi0)
         req.mergeHistory(reqApi0)
         await req.updateStorage(storage, trx)
@@ -457,7 +457,7 @@ export class ProvenTxReq extends EntityBase<table.ProvenTxReq> {
     this.api.provenTxReqId = v
   }
   override get entityName(): string {
-    return 'ProvenTxReq'
+    return 'provenTxReq'
   }
   override get entityTable(): string {
     return 'proven_tx_reqs'
@@ -467,8 +467,8 @@ export class ProvenTxReq extends EntityBase<table.ProvenTxReq> {
    * 'convergent' equality must satisfy (A sync B) equals (B sync A)
    */
   override equals(
-    ei: table.ProvenTxReq,
-    syncMap?: entity.SyncMap | undefined
+    ei: TableProvenTxReq,
+    syncMap?: SyncMap | undefined
   ): boolean {
     const eo = this.toApi()
     if (
@@ -513,23 +513,23 @@ export class ProvenTxReq extends EntityBase<table.ProvenTxReq> {
   }
 
   static async mergeFind(
-    storage: entity.EntityStorage,
+    storage: EntityStorage,
     userId: number,
-    ei: table.ProvenTxReq,
-    syncMap: entity.SyncMap,
+    ei: TableProvenTxReq,
+    syncMap: SyncMap,
     trx?: sdk.TrxToken
-  ): Promise<{ found: boolean; eo: ProvenTxReq; eiId: number }> {
+  ): Promise<{ found: boolean; eo: EntityProvenTxReq; eiId: number }> {
     const ef = verifyOneOrNone(
       await storage.findProvenTxReqs({ partial: { txid: ei.txid }, trx })
     )
     return {
       found: !!ef,
-      eo: new ProvenTxReq(ef || { ...ei }),
+      eo: new EntityProvenTxReq(ef || { ...ei }),
       eiId: verifyId(ei.provenTxReqId)
     }
   }
 
-  mapNotifyTransactionIds(syncMap: entity.SyncMap): void {
+  mapNotifyTransactionIds(syncMap: SyncMap): void {
     // Map external notification transaction ids to local ids
     const externalIds = this.notify.transactionIds || []
     this.notify.transactionIds = []
@@ -542,12 +542,9 @@ export class ProvenTxReq extends EntityBase<table.ProvenTxReq> {
     }
   }
 
-  mergeNotifyTransactionIds(
-    ei: table.ProvenTxReq,
-    syncMap?: entity.SyncMap
-  ): void {
+  mergeNotifyTransactionIds(ei: TableProvenTxReq, syncMap?: SyncMap): void {
     // Map external notification transaction ids to local ids and merge them if they exist.
-    const eie = new ProvenTxReq(ei)
+    const eie = new EntityProvenTxReq(ei)
     if (eie.notify.transactionIds) {
       this.notify.transactionIds ||= []
       for (const transactionId of eie.notify.transactionIds) {
@@ -563,11 +560,11 @@ export class ProvenTxReq extends EntityBase<table.ProvenTxReq> {
 
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   mergeHistory(
-    ei: table.ProvenTxReq,
-    syncMap?: entity.SyncMap,
+    ei: TableProvenTxReq,
+    syncMap?: SyncMap,
     noDupes?: boolean
   ): void {
-    const eie = new ProvenTxReq(ei)
+    const eie = new EntityProvenTxReq(ei)
     if (eie.history.notes) {
       for (const [k, v] of Object.entries(eie.history.notes)) {
         this.addHistoryNote(v, new Date(k), noDupes)
@@ -580,9 +577,9 @@ export class ProvenTxReq extends EntityBase<table.ProvenTxReq> {
   }
 
   override async mergeNew(
-    storage: entity.EntityStorage,
+    storage: EntityStorage,
     userId: number,
-    syncMap: entity.SyncMap,
+    syncMap: SyncMap,
     trx?: sdk.TrxToken
   ): Promise<void> {
     if (this.provenTxId)
@@ -605,10 +602,10 @@ export class ProvenTxReq extends EntityBase<table.ProvenTxReq> {
    * On terminal failure: `doubleSpend` trumps `invalid` as it contains more data.
    */
   override async mergeExisting(
-    storage: entity.EntityStorage,
+    storage: EntityStorage,
     since: Date | undefined,
-    ei: table.ProvenTxReq,
-    syncMap: entity.SyncMap,
+    ei: TableProvenTxReq,
+    syncMap: SyncMap,
     trx?: sdk.TrxToken
   ): Promise<boolean> {
     if (!this.batch && ei.batch) this.batch = ei.batch

package/src/storage/schema/entities/SyncState.ts

@@ -1,24 +1,38 @@
 import {
   createSyncMap,
   EntityBase,
+  EntityCertificate,
+  EntityCertificateField,
+  EntityCommission,
+  EntityOutput,
+  EntityOutputBasket,
+  EntityOutputTag,
+  EntityOutputTagMap,
+  EntityProvenTx,
+  EntityProvenTxReq,
+  EntityStorage,
   EntitySyncMap,
+  EntityTransaction,
+  EntityTxLabel,
+  EntityTxLabelMap,
+  EntityUser,
   MergeEntity,
   SyncError,
   SyncMap
 } from '.'
 import {
-  entity,
   maxDate,
   sdk,
-  table,
+  TableSettings,
+  TableSyncState,
   verifyId,
   verifyOne,
   verifyOneOrNone,
   verifyTruthy
 } from '../../../index.client'
 
-export class SyncState extends EntityBase<table.SyncState> {
-  constructor(api?: table.SyncState) {
+export class EntitySyncState extends EntityBase<TableSyncState> {
+  constructor(api?: TableSyncState) {
     const now = new Date()
     super(
       api || {
@@ -48,7 +62,7 @@ export class SyncState extends EntityBase<table.SyncState> {
     this.validateSyncMap(this.syncMap)
   }
 
-  validateSyncMap(sm: entity.SyncMap) {
+  validateSyncMap(sm: SyncMap) {
     for (const key of Object.keys(sm)) {
       const esm: EntitySyncMap = sm[key]
       if (typeof esm.maxUpdated_at === 'string')
@@ -59,8 +73,8 @@ export class SyncState extends EntityBase<table.SyncState> {
   static async fromStorage(
     storage: sdk.WalletStorageSync,
     userIdentityKey: string,
-    remoteSettings: table.Settings
-  ): Promise<entity.SyncState> {
+    remoteSettings: TableSettings
+  ): Promise<EntitySyncState> {
     const { user } = verifyTruthy(
       await storage.findOrInsertUser(userIdentityKey)
     )
@@ -71,7 +85,7 @@ export class SyncState extends EntityBase<table.SyncState> {
         remoteSettings.storageName
       )
     )
-    const ss = new SyncState(api)
+    const ss = new EntitySyncState(api)
     return ss
   }
 
@@ -82,7 +96,7 @@ export class SyncState extends EntityBase<table.SyncState> {
    * @param trx
    */
   async updateStorage(
-    storage: entity.EntityStorage,
+    storage: EntityStorage,
     notSyncMap?: boolean,
     trx?: sdk.TrxToken
   ) {
@@ -91,7 +105,7 @@ export class SyncState extends EntityBase<table.SyncState> {
     if (this.id === 0) {
       await storage.insertSyncState(this.api)
     } else {
-      const update: Partial<table.SyncState> = { ...this.api }
+      const update: Partial<TableSyncState> = { ...this.api }
       if (notSyncMap) delete update.syncMap
       delete update.created_at
       await storage.updateSyncState(verifyId(this.id), update, trx)
@@ -183,7 +197,7 @@ export class SyncState extends EntityBase<table.SyncState> {
     this.api.syncStateId = id
   }
   override get entityName(): string {
-    return 'table.SyncState'
+    return 'syncState'
   }
   override get entityTable(): string {
     return 'sync_states'
@@ -209,30 +223,39 @@ export class SyncState extends EntityBase<table.SyncState> {
    * @param iSyncMap
    */
   mergeSyncMap(iSyncMap: SyncMap) {
-    SyncState.mergeIdMap(iSyncMap.provenTx.idMap!, this.syncMap.provenTx.idMap!)
-    SyncState.mergeIdMap(
+    EntitySyncState.mergeIdMap(
+      iSyncMap.provenTx.idMap!,
+      this.syncMap.provenTx.idMap!
+    )
+    EntitySyncState.mergeIdMap(
       iSyncMap.outputBasket.idMap!,
       this.syncMap.outputBasket.idMap!
     )
-    SyncState.mergeIdMap(
+    EntitySyncState.mergeIdMap(
       iSyncMap.transaction.idMap!,
       this.syncMap.transaction.idMap!
     )
-    SyncState.mergeIdMap(
+    EntitySyncState.mergeIdMap(
       iSyncMap.provenTxReq.idMap!,
       this.syncMap.provenTxReq.idMap!
     )
-    SyncState.mergeIdMap(iSyncMap.txLabel.idMap!, this.syncMap.txLabel.idMap!)
-    SyncState.mergeIdMap(iSyncMap.output.idMap!, this.syncMap.output.idMap!)
-    SyncState.mergeIdMap(
+    EntitySyncState.mergeIdMap(
+      iSyncMap.txLabel.idMap!,
+      this.syncMap.txLabel.idMap!
+    )
+    EntitySyncState.mergeIdMap(
+      iSyncMap.output.idMap!,
+      this.syncMap.output.idMap!
+    )
+    EntitySyncState.mergeIdMap(
       iSyncMap.outputTag.idMap!,
       this.syncMap.outputTag.idMap!
     )
-    SyncState.mergeIdMap(
+    EntitySyncState.mergeIdMap(
       iSyncMap.certificate.idMap!,
       this.syncMap.certificate.idMap!
     )
-    SyncState.mergeIdMap(
+    EntitySyncState.mergeIdMap(
       iSyncMap.commission.idMap!,
       this.syncMap.commission.idMap!
     )
@@ -257,21 +280,21 @@ export class SyncState extends EntityBase<table.SyncState> {
     return JSON.stringify(es)
   }
 
-  override equals(ei: table.SyncState, syncMap?: SyncMap | undefined): boolean {
+  override equals(ei: TableSyncState, syncMap?: SyncMap | undefined): boolean {
     return false
   }
 
   override async mergeNew(
-    storage: entity.EntityStorage,
+    storage: EntityStorage,
     userId: number,
     syncMap: SyncMap,
     trx?: sdk.TrxToken
   ): Promise<void> {}
 
   override async mergeExisting(
-    storage: entity.EntityStorage,
+    storage: EntityStorage,
     since: Date | undefined,
-    ei: table.SyncState,
+    ei: TableSyncState,
     syncMap: SyncMap,
     trx?: sdk.TrxToken
   ): Promise<boolean> {
@@ -313,7 +336,7 @@ export class SyncState extends EntityBase<table.SyncState> {
   }
 
   async processSyncChunk(
-    writer: entity.EntityStorage,
+    writer: EntityStorage,
     args: sdk.RequestSyncChunkArgs,
     chunk: sdk.SyncChunk
   ): Promise<{
@@ -325,62 +348,62 @@ export class SyncState extends EntityBase<table.SyncState> {
     const mes = [
       new MergeEntity(
         chunk.provenTxs,
-        entity.ProvenTx.mergeFind,
+        EntityProvenTx.mergeFind,
         this.syncMap.provenTx
       ),
       new MergeEntity(
         chunk.outputBaskets,
-        entity.OutputBasket.mergeFind,
+        EntityOutputBasket.mergeFind,
         this.syncMap.outputBasket
       ),
       new MergeEntity(
         chunk.outputTags,
-        entity.OutputTag.mergeFind,
+        EntityOutputTag.mergeFind,
         this.syncMap.outputTag
       ),
       new MergeEntity(
         chunk.txLabels,
-        entity.TxLabel.mergeFind,
+        EntityTxLabel.mergeFind,
         this.syncMap.txLabel
       ),
       new MergeEntity(
         chunk.transactions,
-        entity.Transaction.mergeFind,
+        EntityTransaction.mergeFind,
         this.syncMap.transaction
       ),
       new MergeEntity(
         chunk.outputs,
-        entity.Output.mergeFind,
+        EntityOutput.mergeFind,
         this.syncMap.output
       ),
       new MergeEntity(
         chunk.txLabelMaps,
-        entity.TxLabelMap.mergeFind,
+        EntityTxLabelMap.mergeFind,
         this.syncMap.txLabelMap
       ),
       new MergeEntity(
         chunk.outputTagMaps,
-        entity.OutputTagMap.mergeFind,
+        EntityOutputTagMap.mergeFind,
         this.syncMap.outputTagMap
       ),
       new MergeEntity(
         chunk.certificates,
-        entity.Certificate.mergeFind,
+        EntityCertificate.mergeFind,
         this.syncMap.certificate
       ),
       new MergeEntity(
         chunk.certificateFields,
-        entity.CertificateField.mergeFind,
+        EntityCertificateField.mergeFind,
         this.syncMap.certificateField
       ),
       new MergeEntity(
         chunk.commissions,
-        entity.Commission.mergeFind,
+        EntityCommission.mergeFind,
         this.syncMap.commission
       ),
       new MergeEntity(
         chunk.provenTxReqs,
-        entity.ProvenTxReq.mergeFind,
+        EntityProvenTxReq.mergeFind,
         this.syncMap.provenTxReq
       )
     ]
@@ -393,7 +416,7 @@ export class SyncState extends EntityBase<table.SyncState> {
     // Merge User
     if (chunk.user) {
       const ei = chunk.user
-      const { found, eo } = await entity.User.mergeFind(writer, this.userId, ei)
+      const { found, eo } = await EntityUser.mergeFind(writer, this.userId, ei)
       if (found) {
         if (await eo.mergeExisting(writer, args.since, ei)) {
           maxUpdated_at = maxDate(maxUpdated_at, ei.updated_at)

package/src/storage/schema/entities/Transaction.ts

@@ -1,16 +1,16 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import { Transaction as BsvTransaction, TransactionInput } from '@bsv/sdk'
 import {
-  entity,
   optionalArraysEqual,
   sdk,
-  table,
+  TableOutput,
+  TableTransaction,
   verifyId,
   verifyOneOrNone
 } from '../../../index.client'
-import { EntityBase } from '.'
+import { EntityBase, EntityProvenTx, EntityStorage, SyncMap } from '.'
 
-export class Transaction extends EntityBase<table.Transaction> {
+export class EntityTransaction extends EntityBase<TableTransaction> {
   /**
    * @returns @bsv/sdk Transaction object from parsed rawTx.
    * If rawTx is undefined, returns undefined.
@@ -36,9 +36,9 @@ export class Transaction extends EntityBase<table.Transaction> {
    * Not all transaction inputs correspond to prior storage outputs.
    */
   async getInputs(
-    storage: entity.EntityStorage,
+    storage: EntityStorage,
     trx?: sdk.TrxToken
-  ): Promise<table.Output[]> {
+  ): Promise<TableOutput[]> {
     const inputs = await storage.findOutputs({
       partial: { userId: this.userId, spentBy: this.id },
       trx
@@ -62,7 +62,7 @@ export class Transaction extends EntityBase<table.Transaction> {
     return inputs
   }
 
-  constructor(api?: table.Transaction) {
+  constructor(api?: TableTransaction) {
     const now = new Date()
     super(
       api || {
@@ -202,15 +202,15 @@ export class Transaction extends EntityBase<table.Transaction> {
     this.api.transactionId = v
   }
   override get entityName(): string {
-    return 'ojoTransaction'
+    return 'transaction'
   }
   override get entityTable(): string {
     return 'transactions'
   }
 
   override equals(
-    ei: table.Transaction,
-    syncMap?: entity.SyncMap | undefined
+    ei: TableTransaction,
+    syncMap?: SyncMap | undefined
   ): boolean {
     const eo = this.toApi()
 
@@ -251,12 +251,12 @@ export class Transaction extends EntityBase<table.Transaction> {
   }
 
   static async mergeFind(
-    storage: entity.EntityStorage,
+    storage: EntityStorage,
     userId: number,
-    ei: table.Transaction,
-    syncMap: entity.SyncMap,
+    ei: TableTransaction,
+    syncMap: SyncMap,
     trx?: sdk.TrxToken
-  ): Promise<{ found: boolean; eo: entity.Transaction; eiId: number }> {
+  ): Promise<{ found: boolean; eo: EntityTransaction; eiId: number }> {
     const ef = verifyOneOrNone(
       await storage.findTransactions({
         partial: { reference: ei.reference, userId },
@@ -265,15 +265,15 @@ export class Transaction extends EntityBase<table.Transaction> {
     )
     return {
       found: !!ef,
-      eo: new entity.Transaction(ef || { ...ei }),
+      eo: new EntityTransaction(ef || { ...ei }),
       eiId: verifyId(ei.transactionId)
     }
   }
 
   override async mergeNew(
-    storage: entity.EntityStorage,
+    storage: EntityStorage,
     userId: number,
-    syncMap: entity.SyncMap,
+    syncMap: SyncMap,
     trx?: sdk.TrxToken
   ): Promise<void> {
     if (this.provenTxId)
@@ -284,10 +284,10 @@ export class Transaction extends EntityBase<table.Transaction> {
   }
 
   override async mergeExisting(
-    storage: entity.EntityStorage,
+    storage: EntityStorage,
     since: Date | undefined,
-    ei: table.Transaction,
-    syncMap: entity.SyncMap,
+    ei: TableTransaction,
+    syncMap: SyncMap,
     trx?: sdk.TrxToken
   ): Promise<boolean> {
     let wasMerged = false
@@ -318,9 +318,9 @@ export class Transaction extends EntityBase<table.Transaction> {
   }
 
   async getProvenTx(
-    storage: entity.EntityStorage,
+    storage: EntityStorage,
     trx?: sdk.TrxToken
-  ): Promise<entity.ProvenTx | undefined> {
+  ): Promise<EntityProvenTx | undefined> {
     if (!this.provenTxId) return undefined
     const p = verifyOneOrNone(
       await storage.findProvenTxs({
@@ -329,6 +329,6 @@ export class Transaction extends EntityBase<table.Transaction> {
       })
     )
     if (!p) return undefined
-    return new entity.ProvenTx(p)
+    return new EntityProvenTx(p)
   }
 }