@bopen-io/wallet-toolbox 1.7.18

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

@@ -0,0 +1,290 @@
+import { StorageProvidedBy, TrxToken } from '../../../sdk/WalletStorage.interfaces'
+import { optionalArraysEqual, verifyId, verifyOneOrNone } from '../../../utility/utilityHelpers'
+import { TableOutput } from '../tables/TableOutput'
+import { EntityBase, EntityStorage, SyncMap } from './EntityBase'
+
+export class EntityOutput extends EntityBase<TableOutput> {
+  constructor(api?: TableOutput) {
+    const now = new Date()
+    super(
+      api || {
+        outputId: 0,
+        created_at: now,
+        updated_at: now,
+        userId: 0,
+        transactionId: 0,
+        spendable: false,
+        change: false,
+        satoshis: 0,
+        outputDescription: '',
+        vout: 0,
+        type: '',
+        providedBy: 'you',
+        purpose: '',
+
+        txid: undefined,
+        basketId: undefined,
+        spentBy: undefined,
+        derivationPrefix: undefined,
+        derivationSuffix: undefined,
+        senderIdentityKey: undefined,
+        customInstructions: undefined,
+        spendingDescription: undefined,
+        scriptLength: undefined,
+        scriptOffset: undefined,
+        lockingScript: undefined
+      }
+    )
+  }
+
+  override updateApi(): void {
+    /* nothing needed yet... */
+  }
+
+  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 userId() {
+    return this.api.userId
+  }
+  set userId(v: number) {
+    this.api.userId = v
+  }
+  get transactionId() {
+    return this.api.transactionId
+  }
+  set transactionId(v: number) {
+    this.api.transactionId = v
+  }
+  get basketId() {
+    return this.api.basketId
+  }
+  set basketId(v: number | undefined) {
+    this.api.basketId = v
+  }
+  get spentBy() {
+    return this.api.spentBy
+  }
+  set spentBy(v: number | undefined) {
+    this.api.spentBy = v
+  }
+  get vout() {
+    return this.api.vout
+  }
+  set vout(v: number) {
+    this.api.vout = v
+  }
+  get satoshis() {
+    return this.api.satoshis
+  }
+  set satoshis(v: number) {
+    this.api.satoshis = v
+  }
+  get outputDescription() {
+    return this.api.outputDescription
+  }
+  set outputDescription(v: string) {
+    this.api.outputDescription = v
+  }
+  get spendable() {
+    return this.api.spendable
+  }
+  set spendable(v: boolean) {
+    this.api.spendable = v
+  }
+  get change() {
+    return this.api.change
+  }
+  set change(v: boolean) {
+    this.api.change = v
+  }
+
+  get txid() {
+    return this.api.txid
+  }
+  set txid(v: string | undefined) {
+    this.api.txid = v
+  }
+  get type() {
+    return this.api.type
+  }
+  set type(v: string) {
+    this.api.type = v
+  }
+  get providedBy() {
+    return this.api.providedBy
+  }
+  set providedBy(v: StorageProvidedBy) {
+    this.api.providedBy = v
+  }
+  get purpose() {
+    return this.api.purpose
+  }
+  set purpose(v: string) {
+    this.api.purpose = v
+  }
+  get spendingDescription() {
+    return this.api.spendingDescription
+  }
+  set spendingDescription(v: string | undefined) {
+    this.api.spendingDescription = v
+  }
+  get derivationPrefix() {
+    return this.api.derivationPrefix
+  }
+  set derivationPrefix(v: string | undefined) {
+    this.api.derivationPrefix = v
+  }
+  get derivationSuffix() {
+    return this.api.derivationSuffix
+  }
+  set derivationSuffix(v: string | undefined) {
+    this.api.derivationSuffix = v
+  }
+  get senderIdentityKey() {
+    return this.api.senderIdentityKey
+  }
+  set senderIdentityKey(v: string | undefined) {
+    this.api.senderIdentityKey = v
+  }
+  get customInstructions() {
+    return this.api.customInstructions
+  }
+  set customInstructions(v: string | undefined) {
+    this.api.customInstructions = v
+  }
+  get lockingScript() {
+    return this.api.lockingScript
+  }
+  set lockingScript(v: number[] | undefined) {
+    this.api.lockingScript = v
+  }
+  get scriptLength() {
+    return this.api.scriptLength
+  }
+  set scriptLength(v: number | undefined) {
+    this.api.scriptLength = v
+  }
+  get scriptOffset() {
+    return this.api.scriptOffset
+  }
+  set scriptOffset(v: number | undefined) {
+    this.api.scriptOffset = v
+  }
+
+  override get id(): number {
+    return this.api.outputId
+  }
+  override set id(v: number) {
+    this.api.outputId = v
+  }
+  override get entityName(): string {
+    return 'output'
+  }
+  override get entityTable(): string {
+    return 'outputs'
+  }
+
+  override equals(ei: TableOutput, syncMap?: SyncMap | undefined): boolean {
+    if (
+      this.transactionId !== (syncMap ? syncMap.transaction.idMap[ei.transactionId] : ei.transactionId) ||
+      this.basketId !== (syncMap && ei.basketId ? syncMap.outputBasket.idMap[ei.basketId] : ei.basketId) ||
+      this.spentBy !== (syncMap && ei.spentBy ? syncMap.transaction.idMap[ei.spentBy] : ei.spentBy) ||
+      this.vout !== ei.vout ||
+      this.satoshis !== ei.satoshis ||
+      this.spendable !== ei.spendable ||
+      this.change !== ei.change ||
+      this.txid !== ei.txid ||
+      this.type !== ei.type ||
+      this.providedBy !== ei.providedBy ||
+      this.purpose !== ei.purpose ||
+      this.outputDescription !== ei.outputDescription ||
+      this.spendingDescription !== ei.spendingDescription ||
+      this.derivationPrefix !== ei.derivationPrefix ||
+      this.derivationSuffix !== ei.derivationSuffix ||
+      this.senderIdentityKey !== ei.senderIdentityKey ||
+      this.customInstructions !== ei.customInstructions ||
+      !optionalArraysEqual(this.lockingScript, ei.lockingScript) ||
+      this.scriptLength !== ei.scriptLength ||
+      this.scriptOffset !== ei.scriptOffset
+    )
+      return false
+
+    return true
+  }
+
+  static async mergeFind(
+    storage: EntityStorage,
+    userId: number,
+    ei: TableOutput,
+    syncMap: SyncMap,
+    trx?: TrxToken
+  ): Promise<{ found: boolean; eo: EntityOutput; eiId: number }> {
+    const transactionId = syncMap.transaction.idMap[ei.transactionId]
+    const basketId = ei.basketId ? syncMap.outputBasket.idMap[ei.basketId] : null
+    const ef = verifyOneOrNone(
+      await storage.findOutputs({
+        partial: { userId, transactionId, vout: ei.vout },
+        trx
+      })
+    )
+    return {
+      found: !!ef,
+      eo: new EntityOutput(ef || { ...ei }),
+      eiId: verifyId(ei.outputId)
+    }
+  }
+
+  override async mergeNew(storage: EntityStorage, userId: number, syncMap: SyncMap, trx?: TrxToken): Promise<void> {
+    this.userId = userId
+    this.basketId = this.basketId ? syncMap.outputBasket.idMap[this.basketId] : undefined
+    this.transactionId = syncMap.transaction.idMap[this.transactionId]
+    this.spentBy = this.spentBy ? syncMap.transaction.idMap[this.spentBy] : undefined
+    this.outputId = 0
+    this.outputId = await storage.insertOutput(this.toApi(), trx)
+  }
+
+  override async mergeExisting(
+    storage: EntityStorage,
+    since: Date | undefined,
+    ei: TableOutput,
+    syncMap: SyncMap,
+    trx?: TrxToken
+  ): Promise<boolean> {
+    let wasMerged = false
+    if (ei.updated_at > this.updated_at) {
+      this.spentBy = ei.spentBy ? syncMap.transaction.idMap[ei.spentBy] : undefined
+      this.spendable = ei.spendable
+      this.change = ei.change
+      this.type = ei.type
+      this.providedBy = ei.providedBy
+      this.purpose = ei.purpose
+      this.outputDescription = ei.outputDescription
+      this.spendingDescription = ei.spendingDescription
+      this.senderIdentityKey = ei.senderIdentityKey
+      this.customInstructions = ei.customInstructions
+      this.scriptLength = ei.scriptLength
+      this.scriptOffset = ei.scriptOffset
+      this.lockingScript = ei.lockingScript
+      this.updated_at = new Date(Math.max(ei.updated_at.getTime(), this.updated_at.getTime()))
+      await storage.updateOutput(this.id, this.toApi(), trx)
+      wasMerged = true
+    }
+    return wasMerged
+  }
+}

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

@@ -0,0 +1,153 @@
+import { TrxToken } from '../../../sdk/WalletStorage.interfaces'
+import { verifyId, verifyOneOrNone } from '../../../utility/utilityHelpers'
+import { TableOutputBasket } from '../tables/TableOutputBasket'
+import { EntityBase, EntityStorage, SyncMap } from './EntityBase'
+
+export class EntityOutputBasket extends EntityBase<TableOutputBasket> {
+  constructor(api?: TableOutputBasket) {
+    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: TableOutputBasket, syncMap?: 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: EntityStorage,
+    userId: number,
+    ei: TableOutputBasket,
+    syncMap: SyncMap,
+    trx?: TrxToken
+  ): Promise<{ found: boolean; eo: EntityOutputBasket; eiId: number }> {
+    const ef = verifyOneOrNone(
+      await storage.findOutputBaskets({
+        partial: { name: ei.name, userId },
+        trx
+      })
+    )
+    return {
+      found: !!ef,
+      eo: new EntityOutputBasket(ef || { ...ei }),
+      eiId: verifyId(ei.basketId)
+    }
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  override async mergeNew(storage: EntityStorage, userId: number, syncMap: SyncMap, trx?: 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: EntityStorage,
+    since: Date | undefined,
+    ei: TableOutputBasket,
+    syncMap: SyncMap,
+    trx?: 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(Math.max(ei.updated_at.getTime(), this.updated_at.getTime()))
+      await storage.updateOutputBasket(this.id, this.toApi(), trx)
+      wasMerged = true
+    }
+    return wasMerged
+  }
+}

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

@@ -0,0 +1,121 @@
+import { TrxToken } from '../../../sdk/WalletStorage.interfaces'
+import { verifyId, verifyOneOrNone } from '../../../utility/utilityHelpers'
+import { TableOutputTag } from '../tables/TableOutputTag'
+import { EntityBase, EntityStorage, SyncMap } from './EntityBase'
+
+export class EntityOutputTag extends EntityBase<TableOutputTag> {
+  constructor(api?: TableOutputTag) {
+    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 'outputTag'
+  }
+  override get entityTable(): string {
+    return 'output_tags'
+  }
+
+  override equals(ei: TableOutputTag, syncMap?: 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: EntityStorage,
+    userId: number,
+    ei: TableOutputTag,
+    syncMap: SyncMap,
+    trx?: TrxToken
+  ): Promise<{ found: boolean; eo: EntityOutputTag; eiId: number }> {
+    const ef = verifyOneOrNone(await storage.findOutputTags({ partial: { tag: ei.tag, userId }, trx }))
+    return {
+      found: !!ef,
+      eo: new EntityOutputTag(ef || { ...ei }),
+      eiId: verifyId(ei.outputTagId)
+    }
+  }
+
+  override async mergeNew(storage: EntityStorage, userId: number, syncMap: SyncMap, trx?: TrxToken): Promise<void> {
+    this.userId = userId
+    this.outputTagId = 0
+    this.outputTagId = await storage.insertOutputTag(this.toApi(), trx)
+  }
+
+  override async mergeExisting(
+    storage: EntityStorage,
+    since: Date | undefined,
+    ei: TableOutputTag,
+    syncMap: SyncMap,
+    trx?: TrxToken
+  ): Promise<boolean> {
+    let wasMerged = false
+    if (ei.updated_at > this.updated_at) {
+      this.isDeleted = ei.isDeleted
+      this.updated_at = new Date(Math.max(ei.updated_at.getTime(), this.updated_at.getTime()))
+      await storage.updateOutputTag(this.id, this.toApi(), trx)
+      wasMerged = true
+    }
+    return wasMerged
+  }
+}

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

@@ -0,0 +1,123 @@
+import { TrxToken } from '../../../sdk/WalletStorage.interfaces'
+import { WERR_INVALID_OPERATION } from '../../../sdk/WERR_errors'
+import { verifyId, verifyOneOrNone } from '../../../utility/utilityHelpers'
+import { TableOutputTagMap } from '../tables/TableOutputTagMap'
+import { EntityBase, EntityStorage, SyncMap } from './EntityBase'
+
+export class EntityOutputTagMap extends EntityBase<TableOutputTagMap> {
+  constructor(api?: TableOutputTagMap) {
+    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 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: TableOutputTagMap, syncMap?: 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: EntityStorage,
+    userId: number,
+    ei: TableOutputTagMap,
+    syncMap: SyncMap,
+    trx?: TrxToken
+  ): Promise<{ found: boolean; eo: EntityOutputTagMap; 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 EntityOutputTagMap(ef || { ...ei }),
+      eiId: -1
+    }
+  }
+
+  override async mergeNew(storage: EntityStorage, userId: number, syncMap: SyncMap, trx?: 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: EntityStorage,
+    since: Date | undefined,
+    ei: TableOutputTagMap,
+    syncMap: SyncMap,
+    trx?: TrxToken
+  ): Promise<boolean> {
+    let wasMerged = false
+    if (ei.updated_at > this.updated_at) {
+      this.isDeleted = ei.isDeleted
+      this.updated_at = new Date(Math.max(ei.updated_at.getTime(), this.updated_at.getTime()))
+      await storage.updateOutputTagMap(this.outputId, this.outputTagId, this.toApi(), trx)
+      wasMerged = true
+    }
+    return wasMerged
+  }
+}