wallet-storage/src/storage/schema/entities/OutputBasket.ts

BRC100 conforming wallet, wallet storage and wallet signer components

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
    }
}