@bsv/wallet-toolbox 1.4.9 → 1.4.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/wallet-toolbox",
-  "version": "1.4.9",
+  "version": "1.4.11",
   "description": "BRC100 conforming wallet, wallet storage and wallet signer components",
   "main": "./out/src/index.js",
   "types": "./out/src/index.d.ts",
@@ -32,7 +32,7 @@
   "dependencies": {
     "@bsv/auth-express-middleware": "^1.1.3",
     "@bsv/payment-express-middleware": "^1.0.6",
-    "@bsv/sdk": "^1.6.6",
+    "@bsv/sdk": "^1.6.7",
     "express": "^4.21.2",
     "idb": "^8.0.2",
     "knex": "^3.1.0",

package/src/monitor/tasks/TaskReviewStatus.ts

@@ -8,7 +8,7 @@ import { WalletMonitorTask } from './WalletMonitorTask'
  *
  * Looks for aged Transactions with provenTxId with status != 'completed', sets status to 'completed'.
  *
- * Looks for reqs with 'invalid' status that
+ * Looks for reqs with 'invalid' status that have corresonding transactions with status other than 'failed'.
  */
 export class TaskReviewStatus extends WalletMonitorTask {
   static taskName = 'ReviewStatus'

package/src/storage/WalletStorageManager.ts

@@ -80,30 +80,14 @@ export class WalletStorageManager implements sdk.WalletStorage {
    * Configured services if any. If valid, shared with stores (which may ignore it).
    */
   _services?: sdk.WalletServices
+
   /**
-   * How many read access operations are pending
-   */
-  _readerCount: number = 0
-  /**
-   * How many write access operations are pending
-   */
-  _writerCount: number = 0
-  /**
-   * if true, allow only a single writer to proceed at a time.
-   * queue the blocked requests so they get executed in order when released.
-   */
-  _isSingleWriter: boolean = true
-  /**
-   * if true, allow no new reader or writers to proceed.
-   * queue the blocked requests so they get executed in order when released.
-   */
-  _syncLocked: boolean = false
-  /**
-   * if true, allow no new reader or writers or sync to proceed.
-   * queue the blocked requests so they get executed in order when released.
+   * Creates a new WalletStorageManager with the given identityKey and optional active and backup storage providers.
+   *
+   * @param identityKey The identity key of the user for whom this wallet is being managed.
+   * @param active An optional active storage provider. If not provided, no active storage will be set.
+   * @param backups An optional array of backup storage providers. If not provided, no backups will be set.
    */
-  _storageProviderLocked: boolean = false
-
   constructor(identityKey: string, active?: sdk.WalletStorageProvider, backups?: sdk.WalletStorageProvider[]) {
     const stores = [...(backups || [])]
     if (active) stores.unshift(active)
@@ -260,64 +244,84 @@ export class WalletStorageManager implements sdk.WalletStorage {
     return this._stores.map(b => b.settings!.storageIdentityKey)
   }
 
-  async getActiveForWriter(): Promise<sdk.WalletStorageWriter> {
+  private readonly readerLocks: Array<(value: void | PromiseLike<void>) => void> = []
+  private readonly writerLocks: Array<(value: void | PromiseLike<void>) => void> = []
+  private readonly syncLocks: Array<(value: void | PromiseLike<void>) => void> = []
+  private readonly spLocks: Array<(value: void | PromiseLike<void>) => void> = []
+
+  private async getActiveLock(
+    lockQueue: Array<(value: void | PromiseLike<void>) => void>
+  ): Promise<void> {
     if (!this.isAvailable()) await this.makeAvailable()
-    while (
-      this._storageProviderLocked ||
-      this._syncLocked ||
-      (this._isSingleWriter && this._writerCount > 0) ||
-      this._readerCount > 0
-    ) {
-      await wait(100)
+
+    let resolveNewLock: () => void = () => {}
+    const newLock = new Promise<void>(resolve => {
+      resolveNewLock = resolve
+      lockQueue.push(resolve)
+    })
+    if (lockQueue.length === 1) {
+      resolveNewLock()
     }
-    this._writerCount++
-    return this.getActive()
+    await newLock
   }
 
-  async getActiveForReader(): Promise<sdk.WalletStorageReader> {
-    if (!this.isAvailable()) await this.makeAvailable()
-    while (this._storageProviderLocked || this._syncLocked || (this._isSingleWriter && this._writerCount > 0)) {
-      await wait(100)
+  private releaseActiveLock(queue: Array<(value: void | PromiseLike<void>) => void>): void {
+    queue.shift() // Remove the current lock from the queue
+    if (queue.length > 0) {
+      queue[0]()
     }
-    this._readerCount++
+  }
+
+  private async getActiveForReader(): Promise<sdk.WalletStorageReader> {
+    await this.getActiveLock(this.readerLocks)
     return this.getActive()
   }
+  private releaseActiveForReader(): void {
+    this.releaseActiveLock(this.readerLocks)
+  }
 
-  async getActiveForSync(): Promise<sdk.WalletStorageSync> {
-    if (!this.isAvailable()) await this.makeAvailable()
-    // Wait for a current sync task to complete...
-    while (this._syncLocked) {
-      await wait(100)
-    }
-    // Set syncLocked which prevents any new storageProvider, readers or writers...
-    this._syncLocked = true
-    // Wait for any current storageProvider, readers and writers to complete
-    while (this._storageProviderLocked || this._readerCount > 0 || this._writerCount > 0) {
-      await wait(100)
-    }
-    // Allow the sync to proceed on the active store.
+  private async getActiveForWriter(): Promise<sdk.WalletStorageWriter> {
+    await this.getActiveLock(this.readerLocks)
+    await this.getActiveLock(this.writerLocks)
     return this.getActive()
   }
+  private releaseActiveForWriter(): void {
+    this.releaseActiveLock(this.writerLocks)
+    this.releaseActiveLock(this.readerLocks)
+  }
 
-  async getActiveForStorageProvider(): Promise<StorageProvider> {
-    if (!this.isAvailable()) await this.makeAvailable()
-    // Wait for a current storageProvider call to complete...
-    while (this._storageProviderLocked) {
-      await wait(100)
-    }
-    // Set storageProviderLocked which prevents any new sync, readers or writers...
-    this._storageProviderLocked = true
-    // Wait for any current sync, readers and writers to complete
-    while (this._syncLocked || this._readerCount > 0 || this._writerCount > 0) {
-      await wait(100)
-    }
+  private async getActiveForSync(): Promise<sdk.WalletStorageSync> {
+    await this.getActiveLock(this.readerLocks)
+    await this.getActiveLock(this.writerLocks)
+    await this.getActiveLock(this.syncLocks)
+    return this.getActive()
+  }
+  private releaseActiveForSync(): void {
+    this.releaseActiveLock(this.syncLocks)
+    this.releaseActiveLock(this.writerLocks)
+    this.releaseActiveLock(this.readerLocks)
+  }
+
+  private async getActiveForStorageProvider(): Promise<StorageProvider> {
+    await this.getActiveLock(this.readerLocks)
+    await this.getActiveLock(this.writerLocks)
+    await this.getActiveLock(this.syncLocks)
+    await this.getActiveLock(this.spLocks)
+
+    const active = this.getActive()
     // We can finally confirm that active storage is still able to support `StorageProvider`
-    if (!this.getActive().isStorageProvider())
+    if (!active.isStorageProvider())
       throw new sdk.WERR_INVALID_OPERATION(
         'Active "WalletStorageProvider" does not support "StorageProvider" interface.'
       )
     // Allow the sync to proceed on the active store.
-    return this.getActive() as unknown as StorageProvider
+    return active as unknown as StorageProvider
+  }
+  private releaseActiveForStorageProvider(): void {
+    this.releaseActiveLock(this.spLocks)
+    this.releaseActiveLock(this.syncLocks)
+    this.releaseActiveLock(this.writerLocks)
+    this.releaseActiveLock(this.readerLocks)
   }
 
   async runAsWriter<R>(writer: (active: sdk.WalletStorageWriter) => Promise<R>): Promise<R> {
@@ -326,7 +330,7 @@ export class WalletStorageManager implements sdk.WalletStorage {
       const r = await writer(active)
       return r
     } finally {
-      this._writerCount--
+      this.releaseActiveForWriter()
     }
   }
 
@@ -336,7 +340,7 @@ export class WalletStorageManager implements sdk.WalletStorage {
       const r = await reader(active)
       return r
     } finally {
-      this._readerCount--
+      this.releaseActiveForReader()
     }
   }
 
@@ -355,7 +359,7 @@ export class WalletStorageManager implements sdk.WalletStorage {
       const r = await sync(active)
       return r
     } finally {
-      if (!activeSync) this._syncLocked = false
+      if (!activeSync) this.releaseActiveForSync()
     }
   }
 
@@ -365,7 +369,7 @@ export class WalletStorageManager implements sdk.WalletStorage {
       const r = await sync(active)
       return r
     } finally {
-      this._storageProviderLocked = false
+      this.releaseActiveForStorageProvider()
     }
   }
 

package/src/storage/methods/createAction.ts

@@ -209,10 +209,22 @@ async function createNewInputs(
     const o = i.output
     newInputs.push({ i, o })
     if (o) {
-      await storage.updateOutput(o.outputId!, {
-        spendable: false,
-        spentBy: ctx.transactionId,
-        spendingDescription: i.inputDescription
+      await storage.transaction(async trx => {
+        const o2 = verifyOne(await storage.findOutputs({ partial: { outputId: o.outputId }, trx }))
+        if (o2.spendable != true || o2.spentBy !== undefined)
+          throw new sdk.WERR_INVALID_PARAMETER(
+            `inputs[${i.vin}]`,
+            `spendable output. output ${o.txid}:${o.vout} appears to have been spent.`
+          )
+        await storage.updateOutput(
+          o.outputId!,
+          {
+            spendable: false,
+            spentBy: ctx.transactionId,
+            spendingDescription: i.inputDescription
+          },
+          trx
+        )
       })
     }
   }

package/src/storage/methods/listOutputsKnex.ts

@@ -124,8 +124,8 @@ export async function listOutputs(
   const noTags = tagIds.length === 0
   const includeSpent = specOp && specOp.includeSpent ? specOp.includeSpent : false
 
-  const txStatusOk = `(select status as tstatus from transactions where transactions.transactionId = outputs.transactionId) in ('completed', 'unproven', 'nosend')`
-  const txStatusOkCteq = `(select status as tstatus from transactions where transactions.transactionId = o.transactionId) in ('completed', 'unproven', 'nosend')`
+  const txStatusOk = `(select status as tstatus from transactions where transactions.transactionId = outputs.transactionId) in ('completed', 'unproven', 'nosend', 'sending')`
+  const txStatusOkCteq = `(select status as tstatus from transactions where transactions.transactionId = o.transactionId) in ('completed', 'unproven', 'nosend', 'sending')`
 
   const makeWithTagsQueries = () => {
     let cteqOptions = ''

package/src/storage/methods/processAction.ts

@@ -393,7 +393,7 @@ async function validateCommitNewTxToStorageArgs(
       )
     const update: Partial<TableOutput> = {
       txid: vargs.txid,
-      spendable: o.basketId !== undefined, // spendability is gated by transaction status. Remains true until the output is spent.
+      spendable: true, // spendability is gated by transaction status. Remains true until the output is spent.
       scriptLength: offset.length,
       scriptOffset: offset.offset
     }

package/test/bsv-ts-sdk/LocalKVStore.test.ts

@@ -0,0 +1,94 @@
+import { _tu, logger, TestWalletNoSetup } from '../utils/TestUtilsWalletStorage'
+import { LocalKVStore } from '@bsv/sdk'
+
+describe('LocalKVStore tests', () => {
+  jest.setTimeout(99999999)
+
+  const testName = () => expect.getState().currentTestName || 'test'
+  let ctxs: TestWalletNoSetup[] = []
+  const context = 'test kv store'
+  const key1 = 'key1'
+  const key2 = 'key2'
+
+  beforeEach(async () => {
+    ctxs = [await _tu.createLegacyWalletSQLiteCopy(`${testName()}`)]
+  })
+
+  afterEach(async () => {
+    for (const ctx of ctxs) {
+      await ctx.storage.destroy()
+    }
+  })
+
+  test('0 get non-existent', async () => {
+    for (const { storage, wallet } of ctxs) {
+      const kvStore = new LocalKVStore(wallet, context, false, undefined, true)
+      const value = await kvStore.get(key1)
+      expect(value).toBeUndefined()
+    }
+  })
+
+  test('1 set get', async () => {
+    for (const { storage, wallet } of ctxs) {
+      const kvStore = new LocalKVStore(wallet, context, false, undefined, true)
+      await kvStore.set(key1, 'value1')
+      const value = await kvStore.get(key1)
+      expect(value).toBe('value1')
+    }
+  })
+
+  test('3 set x 4 get', async () => {
+    for (const { storage, wallet } of ctxs) {
+      const kvStore = new LocalKVStore(wallet, context, false, undefined, true)
+      const promises = [
+        kvStore.set(key1, 'value1'),
+        kvStore.set(key1, 'value2'),
+        kvStore.set(key1, 'value3'),
+        kvStore.set(key1, 'value4')
+      ]
+      await Promise.all(promises)
+      const value = await kvStore.get(key1)
+      expect(value).toBe('value4')
+    }
+  })
+
+  test('4 promise test', async () => {
+    let resolveNewLock: () => void = () => {}
+    const newLock = new Promise<void>(resolve => {
+      resolveNewLock = resolve
+    })
+    const t = Date.now()
+    setTimeout(() => {
+      resolveNewLock()
+    }, 1000)
+    await newLock
+    const elapsed = Date.now() - t
+    logger(`Elapsed time: ${elapsed} ms`)
+    expect(elapsed).toBeGreaterThanOrEqual(1000)
+  })
+
+  test('5 set x 4 get set x 4 get', async () => {
+    for (const { storage, wallet } of ctxs) {
+      const kvStore = new LocalKVStore(wallet, context, false, undefined, true)
+      let v4: string | undefined
+      async function captureValue(): Promise<void> {
+        v4 = await kvStore.get(key1)
+      }
+      const promises = [
+        kvStore.set(key1, 'value1'),
+        kvStore.set(key1, 'value2'),
+        kvStore.set(key1, 'value3'),
+        kvStore.set(key1, 'value4'),
+        captureValue(),
+        kvStore.set(key1, 'value5'),
+        kvStore.set(key1, 'value6'),
+        kvStore.set(key1, 'value7'),
+        kvStore.set(key1, 'value8')
+      ]
+      await Promise.all(promises)
+      const v8 = await kvStore.get(key1)
+      expect(v4).toBe('value4')
+      expect(v8).toBe('value8')
+    }
+  })
+})

package/test/storage/idb/update.test.ts

@@ -25,7 +25,7 @@ import 'fake-indexeddb/auto'
 
 setLogging(false)
 
-describe('update tests', () => {
+describe('idb update tests', () => {
   jest.setTimeout(99999999)
 
   const chain: sdk.Chain = 'test'
@@ -501,7 +501,7 @@ describe('update tests', () => {
   })
 
   test('7a updateTransactionStatus', async () => {
-    const { activeStorage: storage } = await _tu.createLegacyWalletSQLiteCopy('updateTransactionStatus6a')
+    const { activeStorage: storage } = await _tu.createLegacyWalletSQLiteCopy('updateTransactionStatus7a')
 
     let tx = verifyOne(
       await storage.findTransactions({

package/test/storage/update.test.ts

@@ -21,7 +21,7 @@ import {
 
 setLogging(false)
 
-describe('idb update tests', () => {
+describe('update tests', () => {
   jest.setTimeout(99999999)
 
   const chain: sdk.Chain = 'test'
@@ -523,7 +523,7 @@ describe('idb update tests', () => {
   })
 
   test('7a updateTransactionStatus', async () => {
-    const { activeStorage: storage } = await _tu.createLegacyWalletSQLiteCopy('updateTransactionStatus6a')
+    const { activeStorage: storage } = await _tu.createLegacyWalletSQLiteCopy('updateTransactionStatus7a')
 
     let tx = verifyOne(
       await storage.findTransactions({

package/test/wallet/action/createAction2.test.ts

@@ -227,7 +227,7 @@ describe('createAction2 nosend transactions', () => {
     1: sourceTXID:70afdc54187a1cdb8e35f7d00e5e111cbf5c43c4dc3f1da2cc44479133c75f9e.0 sats:4 desc:'Funding output' 
        lock:(48)76a914abcdef0123456789abcdef0123456789abcdef88ac unlock:(16)47304402207f2e9a seq:4294967295
   outputs: 2
-    0: sats:2 lock:(48)76a914abcdef0123456789abcdef0123456789abcdef88ac index:0 spendable:false desc:'First spending 
+    0: sats:2 lock:(48)76a914abcdef0123456789abcdef0123456789abcdef88ac index:0 spendable:true desc:'First spending 
        Output for check on change '
     1: sats:996 lock:(50)76a9145947e66cdd43c70fb1780116b79e6f7d96e30e0888ac index:1 spendable:true basket:'default'`)
     }
@@ -287,7 +287,7 @@ describe('createAction2 nosend transactions', () => {
        lock:(50)76a914ab2b66432503a3681fc5af1502207ca458c8752d88ac 
        unlock:(212)4730440220113a6f72035a6ddcd6930db7e3f3d5c70486f9aaefb095e6fa3557afa916ec37022054... seq:4294967295
   outputs: 2
-    0: sats:4 lock:(48)76a914abcdef0123456789abcdef0123456789abcdef88ac index:0 spendable:false desc:'returnTXIDOnly 
+    0: sats:4 lock:(48)76a914abcdef0123456789abcdef0123456789abcdef88ac index:0 spendable:true desc:'returnTXIDOnly 
        false test'
     1: sats:990 lock:(50)76a9145947e66cdd43c70fb1780116b79e6f7d96e30e0888ac index:1 spendable:true basket:'default'`)
     }