@bsv/wallet-toolbox 2.1.28 → 2.2.0

package/docs/wallet.md

@@ -6594,32 +6594,36 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 
 | | | |
 | --- | --- | --- |
-| [ARC](#class-arc) | [Monitor](#class-monitor) | [TaskSendWaiting](#class-tasksendwaiting) |
-| [ArcSSEClient](#class-arcsseclient) | [PrivilegedKeyManager](#class-privilegedkeymanager) | [TaskUnFail](#class-taskunfail) |
-| [Bitails](#class-bitails) | [ScriptTemplateBRC29](#class-scripttemplatebrc29) | [WERR_BAD_REQUEST](#class-werr_bad_request) |
-| [BulkFileDataManager](#class-bulkfiledatamanager) | [SdkWhatsOnChain](#class-sdkwhatsonchain) | [WERR_BROADCAST_UNAVAILABLE](#class-werr_broadcast_unavailable) |
-| [BulkFileDataReader](#class-bulkfiledatareader) | [ServiceCollection](#class-servicecollection) | [WERR_INSUFFICIENT_FUNDS](#class-werr_insufficient_funds) |
-| [BulkFilesReader](#class-bulkfilesreader) | [Services](#class-services) | [WERR_INTERNAL](#class-werr_internal) |
-| [BulkFilesReaderFs](#class-bulkfilesreaderfs) | [SingleWriterMultiReaderLock](#class-singlewritermultireaderlock) | [WERR_INVALID_MERKLE_ROOT](#class-werr_invalid_merkle_root) |
-| [BulkFilesReaderStorage](#class-bulkfilesreaderstorage) | [StorageClient](#class-storageclient) | [WERR_INVALID_OPERATION](#class-werr_invalid_operation) |
-| [BulkHeaderFile](#class-bulkheaderfile) | [StorageClientBase](#class-storageclientbase) | [WERR_INVALID_PARAMETER](#class-werr_invalid_parameter) |
-| [BulkHeaderFileFs](#class-bulkheaderfilefs) | [StorageProvider](#class-storageprovider) | [WERR_INVALID_PUBLIC_KEY](#class-werr_invalid_public_key) |
-| [BulkHeaderFileStorage](#class-bulkheaderfilestorage) | [StorageReader](#class-storagereader) | [WERR_MISSING_PARAMETER](#class-werr_missing_parameter) |
-| [BulkHeaderFiles](#class-bulkheaderfiles) | [StorageReaderWriter](#class-storagereaderwriter) | [WERR_NETWORK_CHAIN](#class-werr_network_chain) |
-| [Chaintracks](#class-chaintracks) | [TaskArcadeSSE](#class-taskarcadesse) | [WERR_NOT_ACTIVE](#class-werr_not_active) |
-| [ChaintracksChainTracker](#class-chaintrackschaintracker) | [TaskCheckForProofs](#class-taskcheckforproofs) | [WERR_NOT_IMPLEMENTED](#class-werr_not_implemented) |
-| [ChaintracksFetch](#class-chaintracksfetch) | [TaskCheckNoSends](#class-taskchecknosends) | [WERR_REVIEW_ACTIONS](#class-werr_review_actions) |
-| [ChaintracksServiceClient](#class-chaintracksserviceclient) | [TaskClock](#class-taskclock) | [WERR_UNAUTHORIZED](#class-werr_unauthorized) |
-| [ChaintracksStorageBase](#class-chaintracksstoragebase) | [TaskFailAbandoned](#class-taskfailabandoned) | [Wallet](#class-wallet) |
-| [EntityBase](#class-entitybase) | [TaskMineBlock](#class-taskmineblock) | [WalletError](#class-walleterror) |
-| [EntityProvenTx](#class-entityproventx) | [TaskMonitorCallHistory](#class-taskmonitorcallhistory) | [WalletLogger](#class-walletlogger) |
-| [EntityProvenTxReq](#class-entityproventxreq) | [TaskNewHeader](#class-tasknewheader) | [WalletMonitorTask](#class-walletmonitortask) |
-| [HeightRange](#class-heightrange) | [TaskPurge](#class-taskpurge) | [WalletSettingsManager](#class-walletsettingsmanager) |
-| [MockChainMigrations](#class-mockchainmigrations) | [TaskReorg](#class-taskreorg) | [WalletSigner](#class-walletsigner) |
-| [MockChainStorage](#class-mockchainstorage) | [TaskReviewDoubleSpends](#class-taskreviewdoublespends) | [WalletStorageManager](#class-walletstoragemanager) |
-| [MockChainTracker](#class-mockchaintracker) | [TaskReviewProvenTxs](#class-taskreviewproventxs) | [WhatsOnChain](#class-whatsonchain) |
-| [MockMiner](#class-mockminer) | [TaskReviewStatus](#class-taskreviewstatus) | [WhatsOnChainNoServices](#class-whatsonchainnoservices) |
-| [MockServices](#class-mockservices) | [TaskReviewUtxos](#class-taskreviewutxos) |  |
+| [ARC](#class-arc) | [EntityTxLabelMap](#class-entitytxlabelmap) | [TaskReorg](#class-taskreorg) |
+| [ArcSSEClient](#class-arcsseclient) | [EntityUser](#class-entityuser) | [TaskReviewDoubleSpends](#class-taskreviewdoublespends) |
+| [Bitails](#class-bitails) | [HeightRange](#class-heightrange) | [TaskReviewProvenTxs](#class-taskreviewproventxs) |
+| [BulkFileDataManager](#class-bulkfiledatamanager) | [MergeEntity](#class-mergeentity) | [TaskReviewStatus](#class-taskreviewstatus) |
+| [BulkFileDataReader](#class-bulkfiledatareader) | [MockChainMigrations](#class-mockchainmigrations) | [TaskReviewUtxos](#class-taskreviewutxos) |
+| [BulkFilesReader](#class-bulkfilesreader) | [MockChainStorage](#class-mockchainstorage) | [TaskSendWaiting](#class-tasksendwaiting) |
+| [BulkFilesReaderFs](#class-bulkfilesreaderfs) | [MockChainTracker](#class-mockchaintracker) | [TaskUnFail](#class-taskunfail) |
+| [BulkFilesReaderStorage](#class-bulkfilesreaderstorage) | [MockMiner](#class-mockminer) | [WERR_BAD_REQUEST](#class-werr_bad_request) |
+| [BulkHeaderFile](#class-bulkheaderfile) | [MockServices](#class-mockservices) | [WERR_BROADCAST_UNAVAILABLE](#class-werr_broadcast_unavailable) |
+| [BulkHeaderFileFs](#class-bulkheaderfilefs) | [Monitor](#class-monitor) | [WERR_INSUFFICIENT_FUNDS](#class-werr_insufficient_funds) |
+| [BulkHeaderFileStorage](#class-bulkheaderfilestorage) | [PrivilegedKeyManager](#class-privilegedkeymanager) | [WERR_INTERNAL](#class-werr_internal) |
+| [BulkHeaderFiles](#class-bulkheaderfiles) | [ScriptTemplateBRC29](#class-scripttemplatebrc29) | [WERR_INVALID_MERKLE_ROOT](#class-werr_invalid_merkle_root) |
+| [Chaintracks](#class-chaintracks) | [SdkWhatsOnChain](#class-sdkwhatsonchain) | [WERR_INVALID_OPERATION](#class-werr_invalid_operation) |
+| [ChaintracksChainTracker](#class-chaintrackschaintracker) | [ServiceCollection](#class-servicecollection) | [WERR_INVALID_PARAMETER](#class-werr_invalid_parameter) |
+| [ChaintracksFetch](#class-chaintracksfetch) | [Services](#class-services) | [WERR_INVALID_PUBLIC_KEY](#class-werr_invalid_public_key) |
+| [ChaintracksServiceClient](#class-chaintracksserviceclient) | [SingleWriterMultiReaderLock](#class-singlewritermultireaderlock) | [WERR_MISSING_PARAMETER](#class-werr_missing_parameter) |
+| [ChaintracksStorageBase](#class-chaintracksstoragebase) | [StorageClient](#class-storageclient) | [WERR_NETWORK_CHAIN](#class-werr_network_chain) |
+| [EntityBase](#class-entitybase) | [StorageClientBase](#class-storageclientbase) | [WERR_NOT_ACTIVE](#class-werr_not_active) |
+| [EntityCertificate](#class-entitycertificate) | [StorageProvider](#class-storageprovider) | [WERR_NOT_IMPLEMENTED](#class-werr_not_implemented) |
+| [EntityCertificateField](#class-entitycertificatefield) | [StorageReader](#class-storagereader) | [WERR_REVIEW_ACTIONS](#class-werr_review_actions) |
+| [EntityCommission](#class-entitycommission) | [StorageReaderWriter](#class-storagereaderwriter) | [WERR_UNAUTHORIZED](#class-werr_unauthorized) |
+| [EntityOutput](#class-entityoutput) | [TaskArcadeSSE](#class-taskarcadesse) | [Wallet](#class-wallet) |
+| [EntityOutputBasket](#class-entityoutputbasket) | [TaskCheckForProofs](#class-taskcheckforproofs) | [WalletError](#class-walleterror) |
+| [EntityOutputTag](#class-entityoutputtag) | [TaskCheckNoSends](#class-taskchecknosends) | [WalletLogger](#class-walletlogger) |
+| [EntityOutputTagMap](#class-entityoutputtagmap) | [TaskClock](#class-taskclock) | [WalletMonitorTask](#class-walletmonitortask) |
+| [EntityProvenTx](#class-entityproventx) | [TaskFailAbandoned](#class-taskfailabandoned) | [WalletSettingsManager](#class-walletsettingsmanager) |
+| [EntityProvenTxReq](#class-entityproventxreq) | [TaskMineBlock](#class-taskmineblock) | [WalletSigner](#class-walletsigner) |
+| [EntitySyncState](#class-entitysyncstate) | [TaskMonitorCallHistory](#class-taskmonitorcallhistory) | [WalletStorageManager](#class-walletstoragemanager) |
+| [EntityTransaction](#class-entitytransaction) | [TaskNewHeader](#class-tasknewheader) | [WhatsOnChain](#class-whatsonchain) |
+| [EntityTxLabel](#class-entitytxlabel) | [TaskPurge](#class-taskpurge) | [WhatsOnChainNoServices](#class-whatsonchainnoservices) |
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
@@ -7509,6 +7513,328 @@ abstract updateApi(): void
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
+---
+##### Class: EntityCertificate
+
+```ts
+export class EntityCertificate extends EntityBase<TableCertificate> {
+    constructor(api?: TableCertificate) 
+    override updateApi(): void 
+    get certificateId() 
+    set certificateId(v: number) 
+    get created_at() 
+    set created_at(v: Date) 
+    get updated_at() 
+    set updated_at(v: Date) 
+    get userId() 
+    set userId(v: number) 
+    get type() 
+    set type(v: string) 
+    get subject() 
+    set subject(v: string) 
+    get verifier() 
+    set verifier(v: string | undefined) 
+    get serialNumber() 
+    set serialNumber(v: string) 
+    get certifier() 
+    set certifier(v: string) 
+    get revocationOutpoint() 
+    set revocationOutpoint(v: string) 
+    get signature() 
+    set signature(v: string) 
+    get isDeleted() 
+    set isDeleted(v: boolean) 
+    override get id(): number 
+    override set id(v: number) 
+    override get entityName(): string 
+    override get entityTable(): string 
+    override equals(ei: TableCertificate, syncMap?: SyncMap): boolean 
+    static async mergeFind(storage: EntityStorage, userId: number, ei: TableCertificate, syncMap: SyncMap, trx?: TrxToken): Promise<{
+        found: boolean;
+        eo: EntityCertificate;
+        eiId: number;
+    }> 
+    override async mergeNew(storage: EntityStorage, userId: number, syncMap: SyncMap, trx?: TrxToken): Promise<void> 
+    override async mergeExisting(storage: EntityStorage, since: Date | undefined, ei: TableCertificate, syncMap: SyncMap, trx?: TrxToken): Promise<boolean> 
+}
+```
+
+See also: [EntityBase](./storage.md#class-entitybase), [EntityStorage](./storage.md#type-entitystorage), [SyncMap](./storage.md#interface-syncmap), [TableCertificate](./storage.md#interface-tablecertificate), [TrxToken](./client.md#interface-trxtoken)
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
+---
+##### Class: EntityCertificateField
+
+```ts
+export class EntityCertificateField extends EntityBase<TableCertificateField> {
+    constructor(api?: TableCertificateField) 
+    override updateApi(): void 
+    get userId() 
+    set userId(v: number) 
+    get certificateId() 
+    set certificateId(v: number) 
+    get created_at() 
+    set created_at(v: Date) 
+    get updated_at() 
+    set updated_at(v: Date) 
+    get fieldName() 
+    set fieldName(v: string) 
+    get fieldValue() 
+    set fieldValue(v: string) 
+    get masterKey() 
+    set masterKey(v: string) 
+    override get id(): number 
+    override get entityName(): string 
+    override get entityTable(): string 
+    override equals(ei: TableCertificateField, syncMap?: SyncMap | undefined): boolean 
+    static async mergeFind(storage: EntityStorage, userId: number, ei: TableCertificateField, syncMap: SyncMap, trx?: TrxToken): Promise<{
+        found: boolean;
+        eo: EntityCertificateField;
+        eiId: number;
+    }> 
+    override async mergeNew(storage: EntityStorage, userId: number, syncMap: SyncMap, trx?: TrxToken): Promise<void> 
+    override async mergeExisting(storage: EntityStorage, since: Date | undefined, ei: TableCertificateField, syncMap: SyncMap, trx?: TrxToken): Promise<boolean> 
+}
+```
+
+See also: [EntityBase](./storage.md#class-entitybase), [EntityStorage](./storage.md#type-entitystorage), [SyncMap](./storage.md#interface-syncmap), [TableCertificateField](./storage.md#interface-tablecertificatefield), [TrxToken](./client.md#interface-trxtoken)
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
+---
+##### Class: EntityCommission
+
+```ts
+export class EntityCommission extends EntityBase<TableCommission> {
+    constructor(api?: TableCommission) 
+    override updateApi(): void 
+    get commissionId() 
+    set commissionId(v: number) 
+    get created_at() 
+    set created_at(v: Date) 
+    get updated_at() 
+    set updated_at(v: Date) 
+    get transactionId() 
+    set transactionId(v: number) 
+    get userId() 
+    set userId(v: number) 
+    get isRedeemed() 
+    set isRedeemed(v: boolean) 
+    get keyOffset() 
+    set keyOffset(v: string) 
+    get lockingScript() 
+    set lockingScript(v: number[]) 
+    get satoshis() 
+    set satoshis(v: number) 
+    override get id(): number 
+    override set id(v: number) 
+    override get entityName(): string 
+    override get entityTable(): string 
+    override equals(ei: TableCommission, syncMap?: SyncMap | undefined): boolean 
+    static async mergeFind(storage: EntityStorage, userId: number, ei: TableCommission, syncMap: SyncMap, trx?: TrxToken): Promise<{
+        found: boolean;
+        eo: EntityCommission;
+        eiId: number;
+    }> 
+    override async mergeNew(storage: EntityStorage, userId: number, syncMap: SyncMap, trx?: TrxToken): Promise<void> 
+    override async mergeExisting(storage: EntityStorage, since: Date | undefined, ei: TableCommission, syncMap: SyncMap, trx?: TrxToken): Promise<boolean> 
+}
+```
+
+See also: [EntityBase](./storage.md#class-entitybase), [EntityStorage](./storage.md#type-entitystorage), [SyncMap](./storage.md#interface-syncmap), [TableCommission](./storage.md#interface-tablecommission), [TrxToken](./client.md#interface-trxtoken)
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
+---
+##### Class: EntityOutput
+
+```ts
+export class EntityOutput extends EntityBase<TableOutput> {
+    constructor(api?: TableOutput) 
+    override updateApi(): void 
+    get outputId() 
+    set outputId(v: number) 
+    get created_at() 
+    set created_at(v: Date) 
+    get updated_at() 
+    set updated_at(v: Date) 
+    get userId() 
+    set userId(v: number) 
+    get transactionId() 
+    set transactionId(v: number) 
+    get basketId() 
+    set basketId(v: number | undefined) 
+    get spentBy() 
+    set spentBy(v: number | undefined) 
+    get vout() 
+    set vout(v: number) 
+    get satoshis() 
+    set satoshis(v: number) 
+    get outputDescription() 
+    set outputDescription(v: string) 
+    get spendable() 
+    set spendable(v: boolean) 
+    get change() 
+    set change(v: boolean) 
+    get txid() 
+    set txid(v: string | undefined) 
+    get type() 
+    set type(v: string) 
+    get providedBy() 
+    set providedBy(v: StorageProvidedBy) 
+    get purpose() 
+    set purpose(v: string) 
+    get spendingDescription() 
+    set spendingDescription(v: string | undefined) 
+    get derivationPrefix() 
+    set derivationPrefix(v: string | undefined) 
+    get derivationSuffix() 
+    set derivationSuffix(v: string | undefined) 
+    get senderIdentityKey() 
+    set senderIdentityKey(v: string | undefined) 
+    get customInstructions() 
+    set customInstructions(v: string | undefined) 
+    get lockingScript() 
+    set lockingScript(v: number[] | undefined) 
+    get scriptLength() 
+    set scriptLength(v: number | undefined) 
+    get scriptOffset() 
+    set scriptOffset(v: number | undefined) 
+    override get id(): number 
+    override set id(v: number) 
+    override get entityName(): string 
+    override get entityTable(): string 
+    override equals(ei: TableOutput, syncMap?: SyncMap | undefined): boolean 
+    static async mergeFind(storage: EntityStorage, userId: number, ei: TableOutput, syncMap: SyncMap, trx?: TrxToken): Promise<{
+        found: boolean;
+        eo: EntityOutput;
+        eiId: number;
+    }> 
+    override async mergeNew(storage: EntityStorage, userId: number, syncMap: SyncMap, trx?: TrxToken): Promise<void> 
+    override async mergeExisting(storage: EntityStorage, since: Date | undefined, ei: TableOutput, syncMap: SyncMap, trx?: TrxToken): Promise<boolean> 
+}
+```
+
+See also: [EntityBase](./storage.md#class-entitybase), [EntityStorage](./storage.md#type-entitystorage), [StorageProvidedBy](./client.md#type-storageprovidedby), [SyncMap](./storage.md#interface-syncmap), [TableOutput](./storage.md#interface-tableoutput), [TrxToken](./client.md#interface-trxtoken)
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
+---
+##### Class: EntityOutputBasket
+
+```ts
+export class EntityOutputBasket extends EntityBase<TableOutputBasket> {
+    constructor(api?: TableOutputBasket) 
+    get basketId() 
+    set basketId(v: number) 
+    get created_at() 
+    set created_at(v: Date) 
+    get updated_at() 
+    set updated_at(v: Date) 
+    get userId() 
+    set userId(v: number) 
+    get name() 
+    set name(v: string) 
+    get numberOfDesiredUTXOs() 
+    set numberOfDesiredUTXOs(v: number) 
+    get minimumDesiredUTXOValue() 
+    set minimumDesiredUTXOValue(v: number) 
+    get isDeleted() 
+    set isDeleted(v: boolean) 
+    override get id() 
+    override set id(v: number) 
+    override get entityName(): string 
+    override get entityTable(): string 
+    override updateApi(): void 
+    override equals(ei: TableOutputBasket, syncMap?: SyncMap): boolean 
+    static async mergeFind(storage: EntityStorage, userId: number, ei: TableOutputBasket, syncMap: SyncMap, trx?: TrxToken): Promise<{
+        found: boolean;
+        eo: EntityOutputBasket;
+        eiId: number;
+    }> 
+    override async mergeNew(storage: EntityStorage, userId: number, syncMap: SyncMap, trx?: TrxToken): Promise<void> 
+    override async mergeExisting(storage: EntityStorage, since: Date | undefined, ei: TableOutputBasket, syncMap: SyncMap, trx?: TrxToken): Promise<boolean> 
+}
+```
+
+See also: [EntityBase](./storage.md#class-entitybase), [EntityStorage](./storage.md#type-entitystorage), [SyncMap](./storage.md#interface-syncmap), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TrxToken](./client.md#interface-trxtoken)
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
+---
+##### Class: EntityOutputTag
+
+```ts
+export class EntityOutputTag extends EntityBase<TableOutputTag> {
+    constructor(api?: TableOutputTag) 
+    override updateApi(): void 
+    get outputTagId() 
+    set outputTagId(v: number) 
+    get created_at() 
+    set created_at(v: Date) 
+    get updated_at() 
+    set updated_at(v: Date) 
+    get tag() 
+    set tag(v: string) 
+    get userId() 
+    set userId(v: number) 
+    get isDeleted() 
+    set isDeleted(v: boolean) 
+    override get id(): number 
+    override set id(v: number) 
+    override get entityName(): string 
+    override get entityTable(): string 
+    override equals(ei: TableOutputTag, syncMap?: SyncMap | undefined): boolean 
+    static async mergeFind(storage: EntityStorage, userId: number, ei: TableOutputTag, syncMap: SyncMap, trx?: TrxToken): Promise<{
+        found: boolean;
+        eo: EntityOutputTag;
+        eiId: number;
+    }> 
+    override async mergeNew(storage: EntityStorage, userId: number, syncMap: SyncMap, trx?: TrxToken): Promise<void> 
+    override async mergeExisting(storage: EntityStorage, since: Date | undefined, ei: TableOutputTag, syncMap: SyncMap, trx?: TrxToken): Promise<boolean> 
+}
+```
+
+See also: [EntityBase](./storage.md#class-entitybase), [EntityStorage](./storage.md#type-entitystorage), [SyncMap](./storage.md#interface-syncmap), [TableOutputTag](./storage.md#interface-tableoutputtag), [TrxToken](./client.md#interface-trxtoken)
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
+---
+##### Class: EntityOutputTagMap
+
+```ts
+export class EntityOutputTagMap extends EntityBase<TableOutputTagMap> {
+    constructor(api?: TableOutputTagMap) 
+    override updateApi(): void 
+    get outputTagId() 
+    set outputTagId(v: number) 
+    get outputId() 
+    set outputId(v: number) 
+    get created_at() 
+    set created_at(v: Date) 
+    get updated_at() 
+    set updated_at(v: Date) 
+    get isDeleted() 
+    set isDeleted(v: boolean) 
+    override get id(): number 
+    override get entityName(): string 
+    override get entityTable(): string 
+    override equals(ei: TableOutputTagMap, syncMap?: SyncMap | undefined): boolean 
+    static async mergeFind(storage: EntityStorage, userId: number, ei: TableOutputTagMap, syncMap: SyncMap, trx?: TrxToken): Promise<{
+        found: boolean;
+        eo: EntityOutputTagMap;
+        eiId: number;
+    }> 
+    override async mergeNew(storage: EntityStorage, userId: number, syncMap: SyncMap, trx?: TrxToken): Promise<void> 
+    override async mergeExisting(storage: EntityStorage, since: Date | undefined, ei: TableOutputTagMap, syncMap: SyncMap, trx?: TrxToken): Promise<boolean> 
+}
+```
+
+See also: [EntityBase](./storage.md#class-entitybase), [EntityStorage](./storage.md#type-entitystorage), [SyncMap](./storage.md#interface-syncmap), [TableOutputTagMap](./storage.md#interface-tableoutputtagmap), [TrxToken](./client.md#interface-trxtoken)
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
 ---
 ##### Class: EntityProvenTx
 
@@ -7780,6 +8106,313 @@ See also: [StorageProvider](./storage.md#class-storageprovider), [TrxToken](./cl
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
+---
+##### Class: EntitySyncState
+
+```ts
+export class EntitySyncState extends EntityBase<TableSyncState> {
+    constructor(api?: TableSyncState) 
+    validateSyncMap(sm: SyncMap) 
+    static async fromStorage(storage: WalletStorageSync, userIdentityKey: string, remoteSettings: TableSettings): Promise<EntitySyncState> 
+    async updateStorage(storage: EntityStorage, notSyncMap?: boolean, trx?: TrxToken) 
+    override updateApi(notSyncMap?: boolean): void 
+    set created_at(v: Date) 
+    get created_at() 
+    set updated_at(v: Date) 
+    get updated_at() 
+    set userId(v: number) 
+    get userId() 
+    set storageIdentityKey(v: string) 
+    get storageIdentityKey() 
+    set storageName(v: string) 
+    get storageName() 
+    set init(v: boolean) 
+    get init() 
+    set refNum(v: string) 
+    get refNum() 
+    set status(v: SyncStatus) 
+    get status(): SyncStatus 
+    set when(v: Date | undefined) 
+    get when() 
+    set satoshis(v: number | undefined) 
+    get satoshis() 
+    get apiErrorLocal() 
+    get apiErrorOther() 
+    get apiSyncMap() 
+    override get id(): number 
+    set id(id: number) 
+    override get entityName(): string 
+    override get entityTable(): string 
+    static mergeIdMap(fromMap: Record<number, number>, toMap: Record<number, number>) 
+    mergeSyncMap(iSyncMap: SyncMap) 
+    errorLocal: SyncError | undefined;
+    errorOther: SyncError | undefined;
+    syncMap: SyncMap;
+    override equals(ei: TableSyncState, syncMap?: SyncMap | undefined): boolean 
+    override async mergeNew(storage: EntityStorage, userId: number, syncMap: SyncMap, trx?: TrxToken): Promise<void> 
+    override async mergeExisting(storage: EntityStorage, since: Date | undefined, ei: TableSyncState, syncMap: SyncMap, trx?: TrxToken): Promise<boolean> 
+    makeRequestSyncChunkArgs(forIdentityKey: string, forStorageIdentityKey: string, maxRoughSize?: number, maxItems?: number): RequestSyncChunkArgs 
+    static syncChunkSummary(c: SyncChunk): string {
+        let log = "";
+        log += `SYNC CHUNK SUMMARY
+  from storage: ${c.fromStorageIdentityKey}
+  to storage: ${c.toStorageIdentityKey}
+  for user: ${c.userIdentityKey}
+`;
+        if (c.user != null)
+            log += `  USER activeStorage ${c.user.activeStorage}\n`;
+        if (c.provenTxs != null) {
+            log += "  PROVEN_TXS\n";
+            for (const r of c.provenTxs) {
+                log += `    ${r.provenTxId} ${r.txid}\n`;
+            }
+        }
+        if (c.provenTxReqs != null) {
+            log += "  PROVEN_TX_REQS\n";
+            for (const r of c.provenTxReqs) {
+                log += `    ${r.provenTxReqId} ${r.txid} ${r.status} ${r.provenTxId || ""}\n`;
+            }
+        }
+        if (c.transactions != null) {
+            log += "  TRANSACTIONS\n";
+            for (const r of c.transactions) {
+                log += `    ${r.transactionId} ${r.txid} ${r.status} ${r.provenTxId || ""} sats:${r.satoshis}\n`;
+            }
+        }
+        if (c.outputs != null) {
+            log += "  OUTPUTS\n";
+            for (const r of c.outputs) {
+                log += `    ${r.outputId} ${r.txid}.${r.vout} ${r.transactionId} ${r.spendable ? "spendable" : ""} sats:${r.satoshis}\n`;
+            }
+        }
+        return log;
+    }
+    async processSyncChunk(writer: EntityStorage, args: RequestSyncChunkArgs, chunk: SyncChunk): Promise<{
+        done: boolean;
+        maxUpdated_at: Date | undefined;
+        updates: number;
+        inserts: number;
+    }> 
+}
+```
+
+See also: [EntityBase](./storage.md#class-entitybase), [EntityStorage](./storage.md#type-entitystorage), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [SyncChunk](./client.md#interface-syncchunk), [SyncError](./storage.md#interface-syncerror), [SyncMap](./storage.md#interface-syncmap), [SyncStatus](./client.md#type-syncstatus), [TableSettings](./storage.md#interface-tablesettings), [TableSyncState](./storage.md#interface-tablesyncstate), [TrxToken](./client.md#interface-trxtoken), [WalletStorageSync](./client.md#interface-walletstoragesync)
+
+###### Method mergeSyncMap
+
+Merge additions to the syncMap
+
+```ts
+mergeSyncMap(iSyncMap: SyncMap) 
+```
+See also: [SyncMap](./storage.md#interface-syncmap)
+
+###### Method updateStorage
+
+Handles both insert and update based on id value: zero indicates insert.
+
+```ts
+async updateStorage(storage: EntityStorage, notSyncMap?: boolean, trx?: TrxToken) 
+```
+See also: [EntityStorage](./storage.md#type-entitystorage), [TrxToken](./client.md#interface-trxtoken)
+
+Argument Details
+
++ **notSyncMap**
+  + if not new and true, excludes updating syncMap in storage.
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
+---
+##### Class: EntityTransaction
+
+```ts
+export class EntityTransaction extends EntityBase<TableTransaction> {
+    getBsvTx(): BsvTransaction | undefined 
+    getBsvTxIns(): TransactionInput[] 
+    async getInputs(storage: EntityStorage, trx?: TrxToken): Promise<TableOutput[]> 
+    constructor(api?: TableTransaction) 
+    override updateApi(): void 
+    get transactionId() 
+    set transactionId(v: number) 
+    get created_at() 
+    set created_at(v: Date) 
+    get updated_at() 
+    set updated_at(v: Date) 
+    get version() 
+    set version(v: number | undefined) 
+    get lockTime() 
+    set lockTime(v: number | undefined) 
+    get isOutgoing() 
+    set isOutgoing(v: boolean) 
+    get status() 
+    set status(v: TransactionStatus) 
+    get userId() 
+    set userId(v: number) 
+    get provenTxId() 
+    set provenTxId(v: number | undefined) 
+    get satoshis() 
+    set satoshis(v: number) 
+    get txid() 
+    set txid(v: string | undefined) 
+    get reference() 
+    set reference(v: string) 
+    get inputBEEF() 
+    set inputBEEF(v: number[] | undefined) 
+    get description() 
+    set description(v: string) 
+    get rawTx() 
+    set rawTx(v: number[] | undefined) 
+    override get id(): number 
+    override set id(v: number) 
+    override get entityName(): string 
+    override get entityTable(): string 
+    override equals(ei: TableTransaction, syncMap?: SyncMap | undefined): boolean 
+    static async mergeFind(storage: EntityStorage, userId: number, ei: TableTransaction, syncMap: SyncMap, trx?: TrxToken): Promise<{
+        found: boolean;
+        eo: EntityTransaction;
+        eiId: number;
+    }> 
+    override async mergeNew(storage: EntityStorage, userId: number, syncMap: SyncMap, trx?: TrxToken): Promise<void> 
+    override async mergeExisting(storage: EntityStorage, since: Date | undefined, ei: TableTransaction, syncMap: SyncMap, trx?: TrxToken): Promise<boolean> 
+    async getProvenTx(storage: EntityStorage, trx?: TrxToken): Promise<EntityProvenTx | undefined> 
+}
+```
+
+See also: [EntityBase](./storage.md#class-entitybase), [EntityProvenTx](./storage.md#class-entityproventx), [EntityStorage](./storage.md#type-entitystorage), [SyncMap](./storage.md#interface-syncmap), [TableOutput](./storage.md#interface-tableoutput), [TableTransaction](./storage.md#interface-tabletransaction), [TransactionStatus](./client.md#type-transactionstatus), [TrxToken](./client.md#interface-trxtoken)
+
+###### Method getBsvTxIns
+
+```ts
+getBsvTxIns(): TransactionInput[] 
+```
+
+Returns
+
+array of
+
+###### Method getInputs
+
+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.
+
+```ts
+async getInputs(storage: EntityStorage, trx?: TrxToken): Promise<TableOutput[]> 
+```
+See also: [EntityStorage](./storage.md#type-entitystorage), [TableOutput](./storage.md#interface-tableoutput), [TrxToken](./client.md#interface-trxtoken)
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
+---
+##### Class: EntityTxLabel
+
+```ts
+export class EntityTxLabel extends EntityBase<TableTxLabel> {
+    constructor(api?: TableTxLabel) 
+    override updateApi(): void 
+    get txLabelId() 
+    set txLabelId(v: number) 
+    get created_at() 
+    set created_at(v: Date) 
+    get updated_at() 
+    set updated_at(v: Date) 
+    get label() 
+    set label(v: string) 
+    get userId() 
+    set userId(v: number) 
+    get isDeleted() 
+    set isDeleted(v: boolean) 
+    override get id(): number 
+    override set id(v: number) 
+    override get entityName(): string 
+    override get entityTable(): string 
+    override equals(ei: TableTxLabel, syncMap?: SyncMap): boolean 
+    static async mergeFind(storage: EntityStorage, userId: number, ei: TableTxLabel, syncMap: SyncMap, trx?: TrxToken): Promise<{
+        found: boolean;
+        eo: EntityTxLabel;
+        eiId: number;
+    }> 
+    override async mergeNew(storage: EntityStorage, userId: number, syncMap: SyncMap, trx?: TrxToken): Promise<void> 
+    override async mergeExisting(storage: EntityStorage, since: Date | undefined, ei: TableTxLabel, syncMap: SyncMap, trx?: TrxToken): Promise<boolean> 
+}
+```
+
+See also: [EntityBase](./storage.md#class-entitybase), [EntityStorage](./storage.md#type-entitystorage), [SyncMap](./storage.md#interface-syncmap), [TableTxLabel](./storage.md#interface-tabletxlabel), [TrxToken](./client.md#interface-trxtoken)
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
+---
+##### Class: EntityTxLabelMap
+
+```ts
+export class EntityTxLabelMap extends EntityBase<TableTxLabelMap> {
+    constructor(api?: TableTxLabelMap) 
+    override updateApi(): void 
+    get txLabelId() 
+    set txLabelId(v: number) 
+    get transactionId() 
+    set transactionId(v: number) 
+    get created_at() 
+    set created_at(v: Date) 
+    get updated_at() 
+    set updated_at(v: Date) 
+    get isDeleted() 
+    set isDeleted(v: boolean) 
+    override get id(): number 
+    override get entityName(): string 
+    override get entityTable(): string 
+    override equals(ei: TableTxLabelMap, syncMap?: SyncMap | undefined): boolean 
+    static async mergeFind(storage: EntityStorage, userId: number, ei: TableTxLabelMap, syncMap: SyncMap, trx?: TrxToken): Promise<{
+        found: boolean;
+        eo: EntityTxLabelMap;
+        eiId: number;
+    }> 
+    override async mergeNew(storage: EntityStorage, userId: number, syncMap: SyncMap, trx?: TrxToken): Promise<void> 
+    override async mergeExisting(storage: EntityStorage, since: Date | undefined, ei: TableTxLabelMap, syncMap: SyncMap, trx?: TrxToken): Promise<boolean> 
+}
+```
+
+See also: [EntityBase](./storage.md#class-entitybase), [EntityStorage](./storage.md#type-entitystorage), [SyncMap](./storage.md#interface-syncmap), [TableTxLabelMap](./storage.md#interface-tabletxlabelmap), [TrxToken](./client.md#interface-trxtoken)
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
+---
+##### Class: EntityUser
+
+```ts
+export class EntityUser extends EntityBase<TableUser> {
+    constructor(api?: TableUser) 
+    override updateApi(): void 
+    get userId() 
+    set userId(v: number) 
+    get created_at() 
+    set created_at(v: Date) 
+    get updated_at() 
+    set updated_at(v: Date) 
+    get identityKey() 
+    set identityKey(v: string) 
+    get activeStorage() 
+    set activeStorage(v: string) 
+    override get id(): number 
+    override set id(v: number) 
+    override get entityName(): string 
+    override get entityTable(): string 
+    override equals(ei: TableUser, syncMap?: SyncMap | undefined): boolean 
+    static async mergeFind(storage: EntityStorage, userId: number, ei: TableUser, trx?: TrxToken): Promise<{
+        found: boolean;
+        eo: EntityUser;
+        eiId: number;
+    }> 
+    override async mergeNew(storage: EntityStorage, userId: number, syncMap: SyncMap, trx?: TrxToken): Promise<void> 
+    override async mergeExisting(storage: EntityStorage, since: Date | undefined, ei: TableUser, syncMap?: SyncMap, trx?: TrxToken): Promise<boolean> 
+}
+```
+
+See also: [EntityBase](./storage.md#class-entitybase), [EntityStorage](./storage.md#type-entitystorage), [SyncMap](./storage.md#interface-syncmap), [TableUser](./storage.md#interface-tableuser), [TrxToken](./client.md#interface-trxtoken)
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
 ---
 ##### Class: HeightRange
 
@@ -7922,6 +8555,44 @@ See also: [HeightRange](./services.md#class-heightrange)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
+---
+##### Class: MergeEntity
+
+```ts
+export class MergeEntity<API extends EntityTimeStamp, DE extends EntityBase<API>> {
+    idMap: Record<number, number>;
+    constructor(public stateArray: API[] | undefined, public find: (storage: EntityStorage, userId: number, ei: API, syncMap: SyncMap, trx?: TrxToken) => Promise<{
+        found: boolean;
+        eo: DE;
+        eiId: number;
+    }>, public esm: EntitySyncMap) 
+    updateSyncMap(map: Record<number, number>, inId: number, outId: number) 
+    async merge(since: Date | undefined, storage: EntityStorage, userId: number, syncMap: SyncMap, trx?: TrxToken): Promise<{
+        inserts: number;
+        updates: number;
+    }> 
+}
+```
+
+See also: [EntityBase](./storage.md#class-entitybase), [EntityStorage](./storage.md#type-entitystorage), [EntitySyncMap](./storage.md#interface-entitysyncmap), [EntityTimeStamp](./client.md#interface-entitytimestamp), [SyncMap](./storage.md#interface-syncmap), [TrxToken](./client.md#interface-trxtoken)
+
+###### Method merge
+
+```ts
+async merge(since: Date | undefined, storage: EntityStorage, userId: number, syncMap: SyncMap, trx?: TrxToken): Promise<{
+    inserts: number;
+    updates: number;
+}> 
+```
+See also: [EntityStorage](./storage.md#type-entitystorage), [SyncMap](./storage.md#interface-syncmap), [TrxToken](./client.md#interface-trxtoken)
+
+Argument Details
+
++ **since**
+  + date of current sync chunk
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
 ---
 ##### Class: MockChainMigrations
 
@@ -9377,7 +10048,8 @@ See also: [UpdateProvenTxReqWithNewProvenTxArgs](./client.md#interface-updatepro
 
 For all `status` values besides 'failed', just updates the transaction records status property.
 
-For 'status' of 'failed', attempts to make outputs previously allocated as inputs to this transaction usable again.
+For 'status' of 'failed', attempts to make outputs previously allocated as inputs to this transaction usable again
+and makes outputs generated by this transaction non-spendable.
 
 ```ts
 async updateTransactionStatus(status: TransactionStatus, transactionId?: number, userId?: number, reference?: string, trx?: TrxToken): Promise<void>