@bsv/wallet-toolbox 1.3.0 → 1.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/wallet-toolbox",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "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.2",
     "@bsv/payment-express-middleware": "^1.0.6",
-    "@bsv/sdk": "^1.4.19",
+    "@bsv/sdk": "^1.4.20",
     "express": "^4.21.2",
     "knex": "^3.1.0",
     "mysql2": "^3.12.0",

package/src/services/providers/WhatsOnChain.ts

@@ -466,8 +466,8 @@ export class WhatsOnChain extends SdkWhatsOnChain {
           headers: this.getHttpHeaders()
         }
 
-        const response = await this.httpClient.request<WhatsOnChainUtxoStatus[]>(
-          `${this.URL}/script/${scriptHash}/unspent`,
+        const response = await this.httpClient.request<WhatsOnChainUtxoStatus>(
+          `${this.URL}/script/${scriptHash}/unspent/all`,
           requestOptions
         )
         if (response.statusText === 'Too Many Requests' && retry < 2) {
@@ -479,30 +479,31 @@ export class WhatsOnChain extends SdkWhatsOnChain {
         if (!response.data || !response.ok || response.status !== 200)
           throw new sdk.WERR_INVALID_OPERATION(`WoC getUtxoStatus response ${response.statusText}`)
 
-        if (Array.isArray(response.data)) {
-          const data = response.data
-          if (data.length === 0) {
-            r.status = 'success'
-            r.error = undefined
-            r.isUtxo = false
-          } else {
-            r.status = 'success'
-            r.error = undefined
-            for (const s of data) {
-              r.details.push({
-                txid: s.tx_hash,
-                satoshis: s.value,
-                height: s.height,
-                index: s.tx_pos
-              })
-            }
-            if (outpoint) {
-              const { txid, vout } = parseWalletOutpoint(outpoint)
-              r.isUtxo = r.details.find(d => d.txid === txid && d.index === vout) !== undefined
-            } else r.isUtxo = r.details.length > 0
-          }
+        const data = response.data
+
+        if (data.script !== scriptHash || !Array.isArray(data.result)) {
+          throw new sdk.WERR_INTERNAL('data. is not an array')
+        }
+
+        if (data.result.length === 0) {
+          r.status = 'success'
+          r.error = undefined
+          r.isUtxo = false
         } else {
-          throw new sdk.WERR_INTERNAL('data is not an array')
+          r.status = 'success'
+          r.error = undefined
+          for (const s of data.result) {
+            r.details.push({
+              txid: s.tx_hash,
+              satoshis: s.value,
+              height: s.height,
+              index: s.tx_pos
+            })
+          }
+          if (outpoint) {
+            const { txid, vout } = parseWalletOutpoint(outpoint)
+            r.isUtxo = r.details.find(d => d.txid === txid && d.index === vout) !== undefined
+          } else r.isUtxo = r.details.length > 0
         }
 
         return r
@@ -661,13 +662,6 @@ interface WhatsOnChainTscProof {
   txOrId: string
 }
 
-interface WhatsOnChainUtxoStatus {
-  value: number
-  height: number
-  tx_pos: number
-  tx_hash: string
-}
-
 interface WhatsOnChainScriptHashHistory {
   tx_hash: string
   height?: number
@@ -691,3 +685,40 @@ interface WhatsOnChainTxsStatusData {
    */
   error?: string
 }
+
+/**
+ * GET https://api.whatsonchain.com/v1/bsv/<network>/script/<scriptHash>/unspent/all
+ * 
+ * Response
+{
+  "error":"",
+  "status":200,
+  "statusText":"OK",
+  "ok":true,
+  "data":{
+    "script":"d3ef8eeb691e7405caca142bfcd6f499b142884d7883e6701a0ee76047b4af32",
+    "result":[
+      {
+        "height":893652,
+        "tx_pos":11,
+        "tx_hash":"2178a1e93d46edda946d9069f9b157ddfacb451fee0278e657941f09bfdb5d8f",
+        "value":1005,
+        "isSpentInMempoolTx":false,
+        "status":"confirmed"
+      }
+    ]
+  }
+}
+ * 
+ */
+interface WhatsOnChainUtxoStatus {
+  script: string
+  result: {
+    value: number
+    height: number
+    tx_pos: number
+    tx_hash: string
+    isSpentInMempoolTx: boolean
+    status: string // 'confirmed'
+  }[]
+}

package/src/storage/methods/listOutputs.ts

@@ -3,11 +3,13 @@ import { TableOutput, TableOutputBasket, TableOutputTag } from '../index.client'
 import { asString, sdk, verifyId, verifyInteger, verifyOne } from '../../index.client'
 import { StorageKnex } from '../StorageKnex'
 import { ValidListOutputsArgs } from '../../sdk'
+import { spec } from 'node:test/reporters'
 
 interface ListOutputsSpecOp {
   name: string
   useBasket?: string
   ignoreLimit?: boolean
+  includeSpent?: boolean
   includeOutputScripts?: boolean
   resultFromTags?: (
     s: StorageKnex,
@@ -62,6 +64,7 @@ const basketToSpecOp: Record<string, ListOutputsSpecOp> = {
     name: 'invalidChangeOutputs',
     useBasket: 'default',
     ignoreLimit: true,
+    includeSpent: false,
     includeOutputScripts: true,
     tagsToIntercept: ['release', 'all'],
     filterOutputs: async (
@@ -71,7 +74,8 @@ const basketToSpecOp: Record<string, ListOutputsSpecOp> = {
       specOpTags: string[],
       outputs: TableOutput[]
     ): Promise<TableOutput[]> => {
-      const filteredOutputs: TableOutput[] = []
+      const updateToSpent: TableOutput[] = []
+      const updateToSpendable: TableOutput[] = []
       const services = s.getServices()
       for (const o of outputs) {
         await s.validateOutputScript(o)
@@ -84,17 +88,23 @@ const basketToSpecOp: Record<string, ListOutputsSpecOp> = {
         } else {
           ok = undefined
         }
-        if (ok === false) {
-          filteredOutputs.push(o)
+        if (ok === false && o.spendable) {
+          updateToSpent.push(o)
+        } else if (ok === true && !o.spendable) {
+          updateToSpendable.push(o)
         }
       }
       if (specOpTags.indexOf('release') >= 0) {
-        for (const o of filteredOutputs) {
+        for (const o of updateToSpent) {
           await s.updateOutput(o.outputId, { spendable: false })
           o.spendable = false
         }
+        for (const o of updateToSpendable) {
+          await s.updateOutput(o.outputId, { spendable: true })
+          o.spendable = true
+        }
       }
-      return filteredOutputs
+      return updateToSpent.concat(updateToSpendable)
     }
   },
   [sdk.specOpSetWalletChangeParams]: {
@@ -236,7 +246,7 @@ export async function listOutputs(
   ]
 
   const noTags = tagIds.length === 0
-  const includeSpent = false
+  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')`

package/test/Wallet/support/opers1.man.test.ts

@@ -51,9 +51,9 @@ describe('operations1 tests', () => {
       let r = await storage.listOutputs(auth, vargs)
       if (r.totalOutputs > 0) {
         const total: number = r.outputs.reduce((s, o) => (s += o.satoshis), 0)
-        log += `userId ${userId}: ${r.totalOutputs} unspendable utxos, total ${total}, ${user.identityKey}\n`
+        log += `userId ${userId}: ${r.totalOutputs} utxos updated, total ${total}, ${user.identityKey}\n`
         for (const o of r.outputs) {
-          log += `  ${o.outpoint} ${o.satoshis}\n`
+          log += `  ${o.outpoint} ${o.satoshis} now ${o.spendable ? 'spendable' : 'spent'}\n`
         }
         withInvalid[userId] = { user, outputs: r.outputs, total }
       }