@bsv/wallet-toolbox 1.1.0

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

@@ -0,0 +1,334 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { Transaction as BsvTransaction, TransactionInput } from '@bsv/sdk'
+import {
+  entity,
+  optionalArraysEqual,
+  sdk,
+  table,
+  verifyId,
+  verifyOneOrNone
+} from '../../../index.client'
+import { EntityBase } from '.'
+
+export class Transaction extends EntityBase<table.Transaction> {
+  /**
+   * @returns @bsv/sdk Transaction object from parsed rawTx.
+   * If rawTx is undefined, returns undefined.
+   */
+  getBsvTx(): BsvTransaction | undefined {
+    if (!this.rawTx) return undefined
+    return BsvTransaction.fromBinary(this.rawTx)
+  }
+
+  /**
+   * @returns array of @bsv/sdk TransactionInput objects from parsed rawTx.
+   * If rawTx is undefined, an empty array is returned.
+   */
+  getBsvTxIns(): TransactionInput[] {
+    const tx = this.getBsvTx()
+    if (!tx) return []
+    return tx.inputs
+  }
+
+  /**
+   * Returns an array of "known" inputs to this transaction which belong to the same userId.
+   * Uses both spentBy and rawTx inputs (if available) to locate inputs from among user's outputs.
+   * Not all transaction inputs correspond to prior storage outputs.
+   */
+  async getInputs(
+    storage: entity.EntityStorage,
+    trx?: sdk.TrxToken
+  ): Promise<table.Output[]> {
+    const inputs = await storage.findOutputs({
+      partial: { userId: this.userId, spentBy: this.id },
+      trx
+    })
+    // Merge "inputs" by spentBy and userId
+    for (const input of this.getBsvTxIns()) {
+      //console.log(`getInputs of ${this.id}: ${input.txid()} ${input.txOutNum}`)
+      const pso = verifyOneOrNone(
+        await storage.findOutputs({
+          partial: {
+            userId: this.userId,
+            txid: input.sourceTXID,
+            vout: input.sourceOutputIndex
+          },
+          trx
+        })
+      )
+      if (pso && !inputs.some(i => i.outputId === pso.outputId))
+        inputs.push(pso)
+    }
+    return inputs
+  }
+
+  constructor(api?: table.Transaction) {
+    const now = new Date()
+    super(
+      api || {
+        transactionId: 0,
+        created_at: now,
+        updated_at: now,
+        userId: 0,
+        txid: '',
+        status: 'unprocessed',
+        reference: '',
+        satoshis: 0,
+        description: '',
+        isOutgoing: false,
+        rawTx: undefined,
+        inputBEEF: undefined
+      }
+    )
+  }
+
+  override updateApi(): void {
+    /* nothing needed yet... */
+  }
+
+  get transactionId() {
+    return this.api.transactionId
+  }
+  set transactionId(v: number) {
+    this.api.transactionId = v
+  }
+
+  get created_at() {
+    return this.api.created_at
+  }
+  set created_at(v: Date) {
+    this.api.created_at = v
+  }
+
+  get updated_at() {
+    return this.api.updated_at
+  }
+  set updated_at(v: Date) {
+    this.api.updated_at = v
+  }
+
+  get version() {
+    return this.api.version
+  }
+  set version(v: number | undefined) {
+    this.api.version = v
+  }
+
+  get lockTime() {
+    return this.api.lockTime
+  }
+  set lockTime(v: number | undefined) {
+    this.api.lockTime = v
+  }
+
+  get isOutgoing() {
+    return this.api.isOutgoing
+  }
+  set isOutgoing(v: boolean) {
+    this.api.isOutgoing = v
+  }
+
+  get status() {
+    return this.api.status
+  }
+  set status(v: sdk.TransactionStatus) {
+    this.api.status = v
+  }
+
+  get userId() {
+    return this.api.userId
+  }
+  set userId(v: number) {
+    this.api.userId = v
+  }
+
+  get provenTxId() {
+    return this.api.provenTxId
+  }
+  set provenTxId(v: number | undefined) {
+    this.api.provenTxId = v
+  }
+
+  get satoshis() {
+    return this.api.satoshis
+  }
+  set satoshis(v: number) {
+    this.api.satoshis = v
+  }
+
+  get txid() {
+    return this.api.txid
+  }
+  set txid(v: string | undefined) {
+    this.api.txid = v
+  }
+
+  get reference() {
+    return this.api.reference
+  }
+  set reference(v: string) {
+    this.api.reference = v
+  }
+
+  get inputBEEF() {
+    return this.api.inputBEEF
+  }
+  set inputBEEF(v: number[] | undefined) {
+    this.api.inputBEEF = v
+  }
+
+  get description() {
+    return this.api.description
+  }
+  set description(v: string) {
+    this.api.description = v
+  }
+
+  get rawTx() {
+    return this.api.rawTx
+  }
+  set rawTx(v: number[] | undefined) {
+    this.api.rawTx = v
+  }
+
+  // Extended (computed / dependent entity) Properties
+  //get labels() { return this.api.labels }
+  //set labels(v: string[] | undefined) { this.api.labels = v }
+
+  override get id(): number {
+    return this.api.transactionId
+  }
+  override set id(v: number) {
+    this.api.transactionId = v
+  }
+  override get entityName(): string {
+    return 'ojoTransaction'
+  }
+  override get entityTable(): string {
+    return 'transactions'
+  }
+
+  override equals(
+    ei: table.Transaction,
+    syncMap?: entity.SyncMap | undefined
+  ): boolean {
+    const eo = this.toApi()
+
+    // Properties that are never updated
+    if (
+      eo.transactionId !==
+        (syncMap
+          ? syncMap.transaction.idMap[verifyId(ei.transactionId)]
+          : ei.transactionId) ||
+      eo.reference !== ei.reference
+    )
+      return false
+
+    if (
+      eo.version !== ei.version ||
+      eo.lockTime !== ei.lockTime ||
+      eo.isOutgoing !== ei.isOutgoing ||
+      eo.status !== ei.status ||
+      eo.satoshis !== ei.satoshis ||
+      eo.txid !== ei.txid ||
+      eo.description !== ei.description ||
+      !optionalArraysEqual(eo.rawTx, ei.rawTx) ||
+      !optionalArraysEqual(eo.inputBEEF, ei.inputBEEF)
+    )
+      return false
+
+    if (
+      !eo.provenTxId !== !ei.provenTxId ||
+      (ei.provenTxId &&
+        eo.provenTxId !==
+          (syncMap
+            ? syncMap.transaction.idMap[verifyId(ei.provenTxId)]
+            : ei.provenTxId))
+    )
+      return false
+
+    return true
+  }
+
+  static async mergeFind(
+    storage: entity.EntityStorage,
+    userId: number,
+    ei: table.Transaction,
+    syncMap: entity.SyncMap,
+    trx?: sdk.TrxToken
+  ): Promise<{ found: boolean; eo: entity.Transaction; eiId: number }> {
+    const ef = verifyOneOrNone(
+      await storage.findTransactions({
+        partial: { reference: ei.reference, userId },
+        trx
+      })
+    )
+    return {
+      found: !!ef,
+      eo: new entity.Transaction(ef || { ...ei }),
+      eiId: verifyId(ei.transactionId)
+    }
+  }
+
+  override async mergeNew(
+    storage: entity.EntityStorage,
+    userId: number,
+    syncMap: entity.SyncMap,
+    trx?: sdk.TrxToken
+  ): Promise<void> {
+    if (this.provenTxId)
+      this.provenTxId = syncMap.provenTx.idMap[this.provenTxId]
+    this.userId = userId
+    this.transactionId = 0
+    this.transactionId = await storage.insertTransaction(this.toApi(), trx)
+  }
+
+  override async mergeExisting(
+    storage: entity.EntityStorage,
+    since: Date | undefined,
+    ei: table.Transaction,
+    syncMap: entity.SyncMap,
+    trx?: sdk.TrxToken
+  ): Promise<boolean> {
+    let wasMerged = false
+    if (ei.updated_at > this.updated_at) {
+      // Properties that are never updated:
+      // transactionId
+      // userId
+      // reference
+
+      // Merged properties
+      this.version = ei.version
+      this.lockTime = ei.lockTime
+      this.isOutgoing = ei.isOutgoing
+      this.status = ei.status
+      this.provenTxId = ei.provenTxId
+        ? syncMap.transaction.idMap[ei.provenTxId]
+        : undefined
+      this.satoshis = ei.satoshis
+      this.txid = ei.txid
+      this.description = ei.description
+      this.rawTx = ei.rawTx
+      this.inputBEEF = ei.inputBEEF
+      this.updated_at = new Date()
+      await storage.updateTransaction(this.id, this.toApi(), trx)
+      wasMerged = true
+    }
+    return wasMerged
+  }
+
+  async getProvenTx(
+    storage: entity.EntityStorage,
+    trx?: sdk.TrxToken
+  ): Promise<entity.ProvenTx | undefined> {
+    if (!this.provenTxId) return undefined
+    const p = verifyOneOrNone(
+      await storage.findProvenTxs({
+        partial: { provenTxId: this.provenTxId },
+        trx
+      })
+    )
+    if (!p) return undefined
+    return new entity.ProvenTx(p)
+  }
+}

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

@@ -0,0 +1,135 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { MerklePath } from '@bsv/sdk'
+import {
+  arraysEqual,
+  entity,
+  sdk,
+  table,
+  verifyId,
+  verifyOneOrNone
+} from '../../../index.client'
+import { EntityBase } from '.'
+
+export class TxLabel extends EntityBase<table.TxLabel> {
+  constructor(api?: table.TxLabel) {
+    const now = new Date()
+    super(
+      api || {
+        txLabelId: 0,
+        created_at: now,
+        updated_at: now,
+        label: '',
+        userId: 0,
+        isDeleted: false
+      }
+    )
+  }
+
+  override updateApi(): void {
+    /* nothing needed yet... */
+  }
+
+  get txLabelId() {
+    return this.api.txLabelId
+  }
+  set txLabelId(v: number) {
+    this.api.txLabelId = v
+  }
+  get created_at() {
+    return this.api.created_at
+  }
+  set created_at(v: Date) {
+    this.api.created_at = v
+  }
+  get updated_at() {
+    return this.api.updated_at
+  }
+  set updated_at(v: Date) {
+    this.api.updated_at = v
+  }
+  get label() {
+    return this.api.label
+  }
+  set label(v: string) {
+    this.api.label = v
+  }
+  get userId() {
+    return this.api.userId
+  }
+  set userId(v: number) {
+    this.api.userId = v
+  }
+  get isDeleted() {
+    return this.api.isDeleted
+  }
+  set isDeleted(v: boolean) {
+    this.api.isDeleted = v
+  }
+
+  override get id(): number {
+    return this.api.txLabelId
+  }
+  override set id(v: number) {
+    this.api.txLabelId = v
+  }
+  override get entityName(): string {
+    return 'entity.TxLabel'
+  }
+  override get entityTable(): string {
+    return 'tx_labels'
+  }
+
+  override equals(ei: table.TxLabel, syncMap?: entity.SyncMap): boolean {
+    const eo = this.toApi()
+    if (eo.label != ei.label || eo.isDeleted != ei.isDeleted) return false
+    if (!syncMap) {
+      if (eo.userId !== ei.userId) return false
+    }
+    return true
+  }
+
+  static async mergeFind(
+    storage: entity.EntityStorage,
+    userId: number,
+    ei: table.TxLabel,
+    syncMap: entity.SyncMap,
+    trx?: sdk.TrxToken
+  ): Promise<{ found: boolean; eo: entity.TxLabel; eiId: number }> {
+    const ef = verifyOneOrNone(
+      await storage.findTxLabels({ partial: { label: ei.label, userId }, trx })
+    )
+    return {
+      found: !!ef,
+      eo: new entity.TxLabel(ef || { ...ei }),
+      eiId: verifyId(ei.txLabelId)
+    }
+  }
+
+  override async mergeNew(
+    storage: entity.EntityStorage,
+    userId: number,
+    syncMap: entity.SyncMap,
+    trx?: sdk.TrxToken
+  ): Promise<void> {
+    this.userId = userId
+    this.txLabelId = 0
+    this.txLabelId = await storage.insertTxLabel(this.toApi(), trx)
+  }
+
+  override async mergeExisting(
+    storage: entity.EntityStorage,
+    since: Date | undefined,
+    ei: table.TxLabel,
+    syncMap: entity.SyncMap,
+    trx?: sdk.TrxToken
+  ): Promise<boolean> {
+    let wasMerged = false
+    if (ei.updated_at > this.updated_at) {
+      this.isDeleted = ei.isDeleted
+      this.updated_at = new Date()
+      await storage.updateTxLabel(this.id, this.toApi(), trx)
+      wasMerged = true
+    }
+    return wasMerged
+  }
+}

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

@@ -0,0 +1,148 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { MerklePath } from '@bsv/sdk'
+import {
+  arraysEqual,
+  entity,
+  sdk,
+  table,
+  verifyId,
+  verifyOneOrNone
+} from '../../../index.client'
+import { EntityBase } from '.'
+
+export class TxLabelMap extends EntityBase<table.TxLabelMap> {
+  constructor(api?: table.TxLabelMap) {
+    const now = new Date()
+    super(
+      api || {
+        created_at: now,
+        updated_at: now,
+        transactionId: 0,
+        txLabelId: 0,
+        isDeleted: false
+      }
+    )
+  }
+
+  override updateApi(): void {
+    /* nothing needed yet... */
+  }
+
+  get txLabelId() {
+    return this.api.txLabelId
+  }
+  set txLabelId(v: number) {
+    this.api.txLabelId = v
+  }
+  get transactionId() {
+    return this.api.transactionId
+  }
+  set transactionId(v: number) {
+    this.api.transactionId = v
+  }
+  get created_at() {
+    return this.api.created_at
+  }
+  set created_at(v: Date) {
+    this.api.created_at = v
+  }
+  get updated_at() {
+    return this.api.updated_at
+  }
+  set updated_at(v: Date) {
+    this.api.updated_at = v
+  }
+  get isDeleted() {
+    return this.api.isDeleted
+  }
+  set isDeleted(v: boolean) {
+    this.api.isDeleted = v
+  }
+
+  override get id(): number {
+    throw new sdk.WERR_INVALID_OPERATION('entity has no "id" value')
+  } // entity does not have its own id.
+  override get entityName(): string {
+    return 'TxLabelMap'
+  }
+  override get entityTable(): string {
+    return 'tx_labels_map'
+  }
+
+  override equals(
+    ei: table.TxLabelMap,
+    syncMap?: entity.SyncMap | undefined
+  ): boolean {
+    const eo = this.toApi()
+
+    if (
+      eo.transactionId !==
+        (syncMap
+          ? syncMap.transaction.idMap[verifyId(ei.transactionId)]
+          : ei.transactionId) ||
+      eo.txLabelId !==
+        (syncMap
+          ? syncMap.txLabel.idMap[verifyId(ei.txLabelId)]
+          : ei.txLabelId) ||
+      eo.isDeleted !== ei.isDeleted
+    )
+      return false
+
+    return true
+  }
+
+  static async mergeFind(
+    storage: entity.EntityStorage,
+    userId: number,
+    ei: table.TxLabelMap,
+    syncMap: entity.SyncMap,
+    trx?: sdk.TrxToken
+  ): Promise<{ found: boolean; eo: entity.TxLabelMap; eiId: number }> {
+    const transactionId = syncMap.transaction.idMap[ei.transactionId]
+    const txLabelId = syncMap.txLabel.idMap[ei.txLabelId]
+    const ef = verifyOneOrNone(
+      await storage.findTxLabelMaps({
+        partial: { transactionId, txLabelId },
+        trx
+      })
+    )
+    return {
+      found: !!ef,
+      eo: new entity.TxLabelMap(ef || { ...ei }),
+      eiId: -1
+    }
+  }
+
+  override async mergeNew(
+    storage: entity.EntityStorage,
+    userId: number,
+    syncMap: entity.SyncMap,
+    trx?: sdk.TrxToken
+  ): Promise<void> {
+    this.transactionId = syncMap.transaction.idMap[this.transactionId]
+    this.txLabelId = syncMap.txLabel.idMap[this.txLabelId]
+    await storage.insertTxLabelMap(this.toApi(), trx)
+  }
+
+  override async mergeExisting(
+    storage: entity.EntityStorage,
+    since: Date | undefined,
+    ei: table.TxLabelMap,
+    syncMap: entity.SyncMap,
+    trx?: sdk.TrxToken
+  ): Promise<boolean> {
+    let wasMerged = false
+    if (ei.updated_at > this.updated_at) {
+      this.isDeleted = ei.isDeleted
+      this.updated_at = new Date()
+      await storage.updateTxLabelMap(
+        this.transactionId,
+        this.txLabelId,
+        this.toApi(),
+        trx
+      )
+      wasMerged = true
+    }
+    return wasMerged
+  }
+}