@bsv/wallet-toolbox 1.5.20 → 1.5.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/wallet-toolbox",
-  "version": "1.5.20",
+  "version": "1.5.21",
   "description": "BRC100 conforming wallet, wallet storage and wallet signer components",
   "main": "./out/src/index.js",
   "types": "./out/src/index.d.ts",
@@ -30,9 +30,9 @@
   },
   "homepage": "https://github.com/bsv-blockchain/wallet-toolbox#readme",
   "dependencies": {
-    "@bsv/auth-express-middleware": "^1.2.2",
+    "@bsv/auth-express-middleware": "^1.2.3",
     "@bsv/payment-express-middleware": "^1.2.3",
-    "@bsv/sdk": "^1.6.20",
+    "@bsv/sdk": "^1.6.23",
     "express": "^4.21.2",
     "idb": "^8.0.2",
     "knex": "^3.1.0",

package/src/WalletPermissionsManager.ts

@@ -1044,7 +1044,6 @@ export class WalletPermissionsManager implements WalletInterface {
     }
   }
 
-
   /**
    * Ensures the originator has label usage permission.
    * If no valid (unexpired) permission token is found, triggers a permission request flow.
@@ -2909,15 +2908,15 @@ export class WalletPermissionsManager implements WalletInterface {
    * do not produce multiple user prompts.
    */
   private buildRequestKey(r: PermissionRequest): string {
-  switch (r.type) {
-    case 'protocol':
-      return `proto:${r.originator}:${!!r.privileged}:${r.protocolID?.join(',')}:${r.counterparty}`
-    case 'basket':
-      return `basket:${r.originator}:${r.basket}`
-    case 'certificate':
-      return `cert:${r.originator}:${!!r.privileged}:${r.certificate?.verifier}:${r.certificate?.certType}:${r.certificate?.fields.join('|')}`
-    case 'spending':
-      return `spend:${r.originator}:${r.spending?.satoshis}`
-  }
+    switch (r.type) {
+      case 'protocol':
+        return `proto:${r.originator}:${!!r.privileged}:${r.protocolID?.join(',')}:${r.counterparty}`
+      case 'basket':
+        return `basket:${r.originator}:${r.basket}`
+      case 'certificate':
+        return `cert:${r.originator}:${!!r.privileged}:${r.certificate?.verifier}:${r.certificate?.certType}:${r.certificate?.fields.join('|')}`
+      case 'spending':
+        return `spend:${r.originator}:${r.spending?.satoshis}`
+    }
   }
 }

package/src/sdk/validationHelpers.ts

@@ -881,7 +881,7 @@ export interface ValidListOutputsArgs extends ValidWalletSignerArgs {
   includeTags: BooleanDefaultFalse
   includeLabels: BooleanDefaultFalse
   limit: PositiveIntegerDefault10Max10000
-  offset: PositiveIntegerOrZero
+  offset: number
   seekPermission: BooleanDefaultTrue
   knownTxids: string[]
 }
@@ -896,7 +896,10 @@ export interface ValidListOutputsArgs extends ValidWalletSignerArgs {
  * @param {BooleanDefaultFalse} [args.includeTags] - Optional. Whether the tags associated with the output should be returned.
  * @param {BooleanDefaultFalse} [args.includeLabels] - Optional. Whether the labels associated with the transaction containing the output should be returned.
  * @param {PositiveIntegerDefault10Max10000} [args.limit] - Optional limit on the number of outputs to return.
- * @param {PositiveIntegerOrZero} [args.offset] - Optional. Number of outputs to skip before starting to return results.
+ * @param {number} [args.offset] - If positive or zero: Number of outputs to skip before starting to return results, oldest first.
+ * If negative: Outputs are returned newest first and offset of -1 is the newest output.
+ * When using negative offsets, caution is required as new outputs may be added between calls,
+ * potentially causing outputs to be duplicated across calls.
  * @param {BooleanDefaultTrue} [args.seekPermission] — Optional. Whether to seek permission from the user for this operation if required. Default true, will return an error rather than proceed if set to false.
  */
 export function validateListOutputsArgs(args: ListOutputsArgs): ValidListOutputsArgs {
@@ -915,7 +918,7 @@ export function validateListOutputsArgs(args: ListOutputsArgs): ValidListOutputs
     includeTags: defaultFalse(args.includeTags),
     includeLabels: defaultFalse(args.includeLabels),
     limit: validateInteger(args.limit, 'limit', 10, 1, 10000),
-    offset: validateInteger(args.offset, 'offset', 0, 0),
+    offset: validateInteger(args.offset, 'offset', 0, undefined, undefined),
     seekPermission: defaultTrue(args.seekPermission),
     knownTxids: []
   }

package/src/storage/methods/listOutputsIdb.ts

@@ -3,7 +3,7 @@ import { TableOutput, TableOutputBasket, TableOutputTag } from '../index.client'
 import { asString, sdk, verifyId, verifyOne } from '../../index.client'
 import { getBasketToSpecOp, ListOutputsSpecOp } from './ListOutputsSpecOp'
 import { StorageIdb } from '../StorageIdb'
-import { TransactionStatus } from '../../sdk'
+import { TransactionStatus, WERR_NOT_IMPLEMENTED } from '../../sdk'
 
 export async function listOutputsIdb(
   storage: StorageIdb,
@@ -14,6 +14,7 @@ export async function listOutputsIdb(
   const userId = verifyId(auth.userId)
   const limit = vargs.limit
   const offset = vargs.offset
+  if (offset < 0) throw new WERR_NOT_IMPLEMENTED('Negative offset not supported in IndexedDB')
 
   const r: ListOutputsResult = {
     totalOutputs: 0,

package/src/storage/methods/listOutputsKnex.ts

@@ -13,7 +13,12 @@ export async function listOutputs(
   const trx: sdk.TrxToken | undefined = undefined
   const userId = verifyId(auth.userId)
   const limit = vargs.limit
-  const offset = vargs.offset
+  let offset = vargs.offset
+  let orderBy: 'asc' | 'desc' = 'asc'
+  if (offset < 0) {
+    offset = -offset - 1
+    orderBy = 'desc'
+  }
 
   const k = dsk.toDb(trx)
 
@@ -23,14 +28,14 @@ export async function listOutputs(
   }
 
   /*
-        ListOutputsArgs {
+        ValidListOutputsArgs {
             basket: BasketStringUnder300Bytes
 
-            tags?: OutputTagStringUnder300Bytes[]
-            tagQueryMode?: 'all' | 'any' // default any
+            tags: OutputTagStringUnder300Bytes[]
+            tagQueryMode: 'all' | 'any' // default any
 
-            limit?: PositiveIntegerDefault10Max10000
-            offset?: PositiveIntegerOrZero
+            limit: PositiveIntegerDefault10Max10000 // default 10
+            offset: number // default 0
         }
     */
 
@@ -166,7 +171,7 @@ export async function listOutputs(
   // Sort order when limit and offset are possible must be ascending for determinism.
   if (!specOp || !specOp.ignoreLimit) q.limit(limit).offset(offset)
 
-  q.orderBy('outputId', 'asc')
+  q.orderBy('outputId', orderBy)
 
   let outputs: TableOutput[] = await q
 

package/test/wallet/list/listOutputs.test.ts

@@ -3,7 +3,8 @@ import {
   Beef,
   ListOutputsArgs,
   OriginatorDomainNameStringUnder250Bytes,
-  OutputTagStringUnder300Bytes
+  OutputTagStringUnder300Bytes,
+  WalletOutput
 } from '@bsv/sdk'
 import { _tu, TestWalletProviderNoSetup } from '../../utils/TestUtilsWalletStorage'
 import path from 'path'
@@ -340,4 +341,75 @@ describe('listOutputs test', () => {
       })
     }
   })
+
+  test('13 offsets', async () => {
+    let i = -1
+    for (const { wallet } of ctxs) {
+      i++
+      let totalOutputs: number = 0
+      const limit = 4
+      let allOutputs: WalletOutput[] = []
+      {
+        const args: ListOutputsArgs = {
+          basket: 'default'
+        }
+        const r = await wallet.listOutputs(args)
+        totalOutputs = r.totalOutputs
+      }
+      {
+        const args: ListOutputsArgs = {
+          basket: 'default',
+          offset: 0,
+          limit: totalOutputs
+        }
+        const r = await wallet.listOutputs(args)
+        expect(r.totalOutputs).toBe(totalOutputs)
+        expect(r.outputs.length).toBe(totalOutputs)
+        expect(r.totalOutputs).toBe(totalOutputs)
+        allOutputs = r.outputs
+      }
+      {
+        const args: ListOutputsArgs = {
+          basket: 'default',
+          offset: totalOutputs - limit,
+          limit
+        }
+        const r = await wallet.listOutputs(args)
+        expect(r.totalOutputs).toBe(totalOutputs)
+        expect(r.outputs.length).toBe(limit)
+        expect(r.outputs[0].outpoint).toBe(allOutputs[totalOutputs - limit].outpoint)
+        expect(r.outputs[1].outpoint).toBe(allOutputs[totalOutputs - limit + 1].outpoint)
+        expect(r.outputs[2].outpoint).toBe(allOutputs[totalOutputs - limit + 2].outpoint)
+        expect(r.outputs[3].outpoint).toBe(allOutputs[totalOutputs - limit + 3].outpoint)
+      }
+      if (i === 1) {
+        const args: ListOutputsArgs = {
+          basket: 'default',
+          offset: -1,
+          limit
+        }
+        const r = await wallet.listOutputs(args)
+        expect(r.totalOutputs).toBe(totalOutputs)
+        expect(r.outputs.length).toBe(limit)
+        expect(r.outputs[0].outpoint).toBe(allOutputs[totalOutputs - 1].outpoint)
+        expect(r.outputs[1].outpoint).toBe(allOutputs[totalOutputs - 2].outpoint)
+        expect(r.outputs[2].outpoint).toBe(allOutputs[totalOutputs - 3].outpoint)
+        expect(r.outputs[3].outpoint).toBe(allOutputs[totalOutputs - 4].outpoint)
+      }
+      if (i === 1) {
+        const args: ListOutputsArgs = {
+          basket: 'default',
+          offset: -3,
+          limit
+        }
+        const r = await wallet.listOutputs(args)
+        expect(r.totalOutputs).toBe(totalOutputs)
+        expect(r.outputs.length).toBe(limit)
+        expect(r.outputs[0].outpoint).toBe(allOutputs[totalOutputs - 3].outpoint)
+        expect(r.outputs[1].outpoint).toBe(allOutputs[totalOutputs - 4].outpoint)
+        expect(r.outputs[2].outpoint).toBe(allOutputs[totalOutputs - 5].outpoint)
+        expect(r.outputs[3].outpoint).toBe(allOutputs[totalOutputs - 6].outpoint)
+      }
+    }
+  })
 })