@bsv/wallet-toolbox 1.1.0

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

@@ -0,0 +1,165 @@
+import { MerklePath } from '@bsv/sdk'
+import {
+  arraysEqual,
+  entity,
+  sdk,
+  table,
+  verifyId,
+  verifyOneOrNone
+} from '../../../index.client'
+import { EntityBase } from '.'
+
+export class OutputBasket extends EntityBase<table.OutputBasket> {
+  constructor(api?: table.OutputBasket) {
+    const now = new Date()
+    super(
+      api || {
+        basketId: 0,
+        created_at: now,
+        updated_at: now,
+        userId: 0,
+        name: '',
+        numberOfDesiredUTXOs: 0,
+        minimumDesiredUTXOValue: 0,
+        isDeleted: false
+      }
+    )
+  }
+
+  get basketId() {
+    return this.api.basketId
+  }
+  set basketId(v: number) {
+    this.api.basketId = 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 userId() {
+    return this.api.userId
+  }
+  set userId(v: number) {
+    this.api.userId = v
+  }
+  get name() {
+    return this.api.name
+  }
+  set name(v: string) {
+    this.api.name = v
+  }
+  get numberOfDesiredUTXOs() {
+    return this.api.numberOfDesiredUTXOs
+  }
+  set numberOfDesiredUTXOs(v: number) {
+    this.api.numberOfDesiredUTXOs = v
+  }
+  get minimumDesiredUTXOValue() {
+    return this.api.minimumDesiredUTXOValue
+  }
+  set minimumDesiredUTXOValue(v: number) {
+    this.api.minimumDesiredUTXOValue = v
+  }
+  get isDeleted() {
+    return this.api.isDeleted
+  }
+  set isDeleted(v: boolean) {
+    this.api.isDeleted = v
+  }
+
+  override get id() {
+    return this.api.basketId
+  }
+  override set id(v: number) {
+    this.api.basketId = v
+  }
+  override get entityName(): string {
+    return 'OutputBasket'
+  }
+  override get entityTable(): string {
+    return 'output_baskets'
+  }
+
+  override updateApi(): void {
+    /* nothing needed yet... */
+  }
+
+  override equals(ei: table.OutputBasket, syncMap?: entity.SyncMap): boolean {
+    const eo = this.api
+    if (
+      eo.name != ei.name ||
+      eo.numberOfDesiredUTXOs != ei.numberOfDesiredUTXOs ||
+      eo.minimumDesiredUTXOValue != ei.minimumDesiredUTXOValue
+    )
+      return false
+    if (syncMap) {
+      if (eo.basketId !== syncMap.outputBasket.idMap[verifyId(ei.basketId)])
+        return false
+    } else {
+      if (eo.basketId !== ei.basketId || eo.userId !== ei.userId) return false
+    }
+    return true
+  }
+
+  static async mergeFind(
+    storage: entity.EntityStorage,
+    userId: number,
+    ei: table.OutputBasket,
+    syncMap: entity.SyncMap,
+    trx?: sdk.TrxToken
+  ): Promise<{ found: boolean; eo: OutputBasket; eiId: number }> {
+    const ef = verifyOneOrNone(
+      await storage.findOutputBaskets({
+        partial: { name: ei.name, userId },
+        trx
+      })
+    )
+    return {
+      found: !!ef,
+      eo: new OutputBasket(ef || { ...ei }),
+      eiId: verifyId(ei.basketId)
+    }
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  override async mergeNew(
+    storage: entity.EntityStorage,
+    userId: number,
+    syncMap: entity.SyncMap,
+    trx?: sdk.TrxToken
+  ): Promise<void> {
+    this.userId = userId
+    this.name ||= 'default'
+    this.basketId = 0
+    this.basketId = await storage.insertOutputBasket(this.toApi(), trx)
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  override async mergeExisting(
+    storage: entity.EntityStorage,
+    since: Date | undefined,
+    ei: table.OutputBasket,
+    syncMap: entity.SyncMap,
+    trx?: sdk.TrxToken
+  ): Promise<boolean> {
+    let wasMerged = false
+    if (ei.updated_at > this.updated_at) {
+      // basket name is its identity, should not change
+      this.minimumDesiredUTXOValue = ei.minimumDesiredUTXOValue
+      this.numberOfDesiredUTXOs = ei.numberOfDesiredUTXOs
+      this.isDeleted = ei.isDeleted
+      this.updated_at = new Date()
+      await storage.updateOutputBasket(this.id, this.toApi(), trx)
+      wasMerged = true
+    }
+    return wasMerged
+  }
+}

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

@@ -0,0 +1,138 @@
+/* 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 OutputTag extends EntityBase<table.OutputTag> {
+  constructor(api?: table.OutputTag) {
+    const now = new Date()
+    super(
+      api || {
+        outputTagId: 0,
+        created_at: now,
+        updated_at: now,
+        tag: '',
+        userId: 0,
+        isDeleted: false
+      }
+    )
+  }
+
+  override updateApi(): void {
+    /* nothing needed yet... */
+  }
+
+  get outputTagId() {
+    return this.api.outputTagId
+  }
+  set outputTagId(v: number) {
+    this.api.outputTagId = 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 tag() {
+    return this.api.tag
+  }
+  set tag(v: string) {
+    this.api.tag = 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.outputTagId
+  }
+  override set id(v: number) {
+    this.api.outputTagId = v
+  }
+  override get entityName(): string {
+    return 'entity.OutputTag'
+  }
+  override get entityTable(): string {
+    return 'output_tags'
+  }
+
+  override equals(
+    ei: table.OutputTag,
+    syncMap?: entity.SyncMap | undefined
+  ): boolean {
+    const eo = this.toApi()
+    if (eo.tag != ei.tag || 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.OutputTag,
+    syncMap: entity.SyncMap,
+    trx?: sdk.TrxToken
+  ): Promise<{ found: boolean; eo: entity.OutputTag; eiId: number }> {
+    const ef = verifyOneOrNone(
+      await storage.findOutputTags({ partial: { tag: ei.tag, userId }, trx })
+    )
+    return {
+      found: !!ef,
+      eo: new entity.OutputTag(ef || { ...ei }),
+      eiId: verifyId(ei.outputTagId)
+    }
+  }
+
+  override async mergeNew(
+    storage: entity.EntityStorage,
+    userId: number,
+    syncMap: entity.SyncMap,
+    trx?: sdk.TrxToken
+  ): Promise<void> {
+    this.userId = userId
+    this.outputTagId = 0
+    this.outputTagId = await storage.insertOutputTag(this.toApi(), trx)
+  }
+
+  override async mergeExisting(
+    storage: entity.EntityStorage,
+    since: Date | undefined,
+    ei: table.OutputTag,
+    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.updateOutputTag(this.id, this.toApi(), trx)
+      wasMerged = true
+    }
+    return wasMerged
+  }
+}

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

@@ -0,0 +1,146 @@
+/* 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 OutputTagMap extends EntityBase<table.OutputTagMap> {
+  constructor(api?: table.OutputTagMap) {
+    const now = new Date()
+    super(
+      api || {
+        created_at: now,
+        updated_at: now,
+        outputId: 0,
+        outputTagId: 0,
+        isDeleted: false
+      }
+    )
+  }
+
+  override updateApi(): void {
+    /* nothing needed yet... */
+  }
+
+  get outputTagId() {
+    return this.api.outputTagId
+  }
+  set outputTagId(v: number) {
+    this.api.outputTagId = v
+  }
+  get outputId() {
+    return this.api.outputId
+  }
+  set outputId(v: number) {
+    this.api.outputId = 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')
+  }
+  override get entityName(): string {
+    return 'OutputTagMap'
+  }
+  override get entityTable(): string {
+    return 'output_tags_map'
+  }
+
+  override equals(
+    ei: table.OutputTagMap,
+    syncMap?: entity.SyncMap | undefined
+  ): boolean {
+    const eo = this.toApi()
+
+    if (
+      eo.outputId !==
+        (syncMap ? syncMap.output.idMap[verifyId(ei.outputId)] : ei.outputId) ||
+      eo.outputTagId !==
+        (syncMap
+          ? syncMap.outputTag.idMap[verifyId(ei.outputTagId)]
+          : ei.outputTagId) ||
+      eo.isDeleted !== ei.isDeleted
+    )
+      return false
+
+    return true
+  }
+
+  static async mergeFind(
+    storage: entity.EntityStorage,
+    userId: number,
+    ei: table.OutputTagMap,
+    syncMap: entity.SyncMap,
+    trx?: sdk.TrxToken
+  ): Promise<{ found: boolean; eo: entity.OutputTagMap; eiId: number }> {
+    const outputId = syncMap.output.idMap[ei.outputId]
+    const outputTagId = syncMap.outputTag.idMap[ei.outputTagId]
+    const ef = verifyOneOrNone(
+      await storage.findOutputTagMaps({
+        partial: { outputId, outputTagId },
+        trx
+      })
+    )
+    return {
+      found: !!ef,
+      eo: new entity.OutputTagMap(ef || { ...ei }),
+      eiId: -1
+    }
+  }
+
+  override async mergeNew(
+    storage: entity.EntityStorage,
+    userId: number,
+    syncMap: entity.SyncMap,
+    trx?: sdk.TrxToken
+  ): Promise<void> {
+    this.outputId = syncMap.output.idMap[this.outputId]
+    this.outputTagId = syncMap.outputTag.idMap[this.outputTagId]
+    await storage.insertOutputTagMap(this.toApi(), trx)
+  }
+
+  override async mergeExisting(
+    storage: entity.EntityStorage,
+    since: Date | undefined,
+    ei: table.OutputTagMap,
+    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.updateOutputTagMap(
+        this.outputId,
+        this.outputTagId,
+        this.toApi(),
+        trx
+      )
+      wasMerged = true
+    }
+    return wasMerged
+  }
+}