@bsv/wallet-toolbox 1.3.17 → 1.3.19

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/wallet-toolbox",
-  "version": "1.3.17",
+  "version": "1.3.19",
   "description": "BRC100 conforming wallet, wallet storage and wallet signer components",
   "main": "./out/src/index.js",
   "types": "./out/src/index.d.ts",

package/src/storage/StorageReaderWriter.ts

@@ -168,8 +168,8 @@ export abstract class StorageReaderWriter extends StorageReader {
           basketId: 0,
           userId: user.userId,
           name: 'default',
-          numberOfDesiredUTXOs: 32,
-          minimumDesiredUTXOValue: 1000,
+          numberOfDesiredUTXOs: 144,
+          minimumDesiredUTXOValue: 32,
           isDeleted: false
         })
         break

package/src/storage/methods/__test/GenerateChange/generateChangeSdk.test.ts

@@ -174,7 +174,7 @@ describe('generateChange tests', () => {
 
     const r = await generateChangeSdk(params, allocateChangeInput, releaseChangeInput)
     expect(JSON.stringify(r)).toBe(
-      '{"allocatedChangeInputs":[{"satoshis":1004,"outputId":15011,"spendable":false},{"satoshis":1000,"outputId":15017,"spendable":false},{"satoshis":1000,"outputId":15013,"spendable":false}],"changeOutputs":[{"satoshis":688,"lockingScriptLength":25},{"satoshis":1000,"lockingScriptLength":25}],"size":39658,"fee":80,"satsPerKb":2}'
+      '{"allocatedChangeInputs":[{"satoshis":1004,"outputId":15011,"spendable":false},{"satoshis":1000,"outputId":15017,"spendable":false}],"changeOutputs":[{"satoshis":689,"lockingScriptLength":25}],"size":39476,"fee":79,"satsPerKb":2}'
     )
     expectTransactionSize(params, r)
   })
@@ -195,7 +195,7 @@ describe('generateChange tests', () => {
 
     const r = await generateChangeSdk(params, allocateChangeInput, releaseChangeInput)
     expect(JSON.stringify(r)).toBe(
-      '{"allocatedChangeInputs":[{"satoshis":1004,"outputId":15011,"spendable":false},{"satoshis":1000,"outputId":15017,"spendable":false},{"satoshis":1000,"outputId":15013,"spendable":false}],"changeOutputs":[{"satoshis":569,"lockingScriptLength":25},{"satoshis":1000,"lockingScriptLength":25}],"size":39658,"fee":199,"satsPerKb":5}'
+      '{"allocatedChangeInputs":[{"satoshis":1004,"outputId":15011,"spendable":false},{"satoshis":1000,"outputId":15017,"spendable":false}],"changeOutputs":[{"satoshis":570,"lockingScriptLength":25}],"size":39476,"fee":198,"satsPerKb":5}'
     )
     expectTransactionSize(params, r)
   })
@@ -216,7 +216,7 @@ describe('generateChange tests', () => {
 
     const r = await generateChangeSdk(params, allocateChangeInput, releaseChangeInput)
     expect(JSON.stringify(r)).toBe(
-      '{"allocatedChangeInputs":[{"satoshis":1004,"outputId":15011,"spendable":false},{"satoshis":1000,"outputId":15017,"spendable":false},{"satoshis":1000,"outputId":15013,"spendable":false}],"changeOutputs":[{"satoshis":728,"lockingScriptLength":25},{"satoshis":1000,"lockingScriptLength":25}],"size":39658,"fee":40,"satsPerKb":1}'
+      '{"allocatedChangeInputs":[{"satoshis":1004,"outputId":15011,"spendable":false},{"satoshis":1000,"outputId":15017,"spendable":false}],"changeOutputs":[{"satoshis":728,"lockingScriptLength":25}],"size":39476,"fee":40,"satsPerKb":1}'
     )
     expectTransactionSize(params, r)
   })
@@ -887,55 +887,87 @@ describe('generateChange tests', () => {
       { satoshis: 1034, outputId: 18492 }
     ]
   }
+  const d14: TestCase = {
+    p: {
+      fixedInputs: [],
+      fixedOutputs: [{ satoshis: 3, lockingScriptLength: 141 }],
+      feeModel: { model: 'sat/kb', value: 2 },
+      changeInitialSatoshis: 1000,
+      changeFirstSatoshis: 285,
+      changeLockingScriptLength: 25,
+      changeUnlockingScriptLength: 107,
+      targetNetCount: 22
+    },
+    availableChange: [
+      { satoshis: 995, outputId: 16190 },
+      { satoshis: 1000, outputId: 18487 },
+      { satoshis: 1000, outputId: 18488 },
+      { satoshis: 1000, outputId: 18489 },
+      { satoshis: 1000, outputId: 18490 },
+      { satoshis: 1000, outputId: 18491 },
+      { satoshis: 1000, outputId: 18492 },
+      { satoshis: 1000, outputId: 18493 },
+      { satoshis: 1000, outputId: 18494 },
+      { satoshis: 1000, outputId: 18495 },
+      { satoshis: 100, outputId: 18496 }
+    ]
+  }
+
+  const test8Cases = [
+    {
+      n: 14,
+      d: d14,
+      er: '{"allocatedChangeInputs":[{"satoshis":1000,"outputId":18495,"spendable":false}],"changeOutputs":[{"satoshis":996,"lockingScriptLength":25}],"size":342,"fee":1,"satsPerKb":2}'
+    },
+    {
+      n: 13,
+      d: d13,
+      er: '{"allocatedChangeInputs":[{"satoshis":1000,"outputId":18489,"spendable":false}],"changeOutputs":[{"satoshis":497,"lockingScriptLength":25}],"size":429,"fee":1,"satsPerKb":2}'
+    },
+    {
+      n: 12,
+      d: d12,
+      er: '{"allocatedChangeInputs":[{"satoshis":14030,"outputId":21194,"spendable":false}],"changeOutputs":[{"satoshis":13800,"lockingScriptLength":25}],"size":260,"fee":29,"satsPerKb":110}'
+    },
+    {
+      n: 11,
+      d: d11,
+      er: '{"allocatedChangeInputs":[{"satoshis":285,"outputId":21319,"spendable":false},{"satoshis":1000,"outputId":21309,"spendable":false}],"changeOutputs":[{"satoshis":1039,"lockingScriptLength":25}],"size":408,"fee":45,"satsPerKb":110}'
+    },
+    {
+      n: 10,
+      d: d10,
+      er: '{"allocatedChangeInputs":[{"satoshis":14030,"outputId":21194,"spendable":false}],"changeOutputs":[{"satoshis":13800,"lockingScriptLength":25}],"size":260,"fee":29,"satsPerKb":110}'
+    },
+    {
+      n: 9,
+      d: d9,
+      er: '{"allocatedChangeInputs":[{"satoshis":4571,"outputId":15626,"spendable":false}],"changeOutputs":[{"satoshis":3368,"lockingScriptLength":25}],"size":1373,"fee":3,"satsPerKb":2}'
+    },
+    {
+      n: 8,
+      d: d8,
+      er: '{"allocatedChangeInputs":[{"satoshis":1817,"outputId":15658,"spendable":false}],"changeOutputs":[{"satoshis":52,"lockingScriptLength":25}],"size":260,"fee":1,"satsPerKb":2}'
+    },
+    {
+      n: 7,
+      d: d7,
+      er: '{"allocatedChangeInputs":[{"satoshis":1817,"outputId":15658,"spendable":false}],"changeOutputs":[{"satoshis":46,"lockingScriptLength":25}],"size":260,"fee":1,"satsPerKb":2}'
+    },
+    {
+      n: 6,
+      d: d6,
+      er: '{"allocatedChangeInputs":[{"satoshis":1000,"outputId":16346,"spendable":false}],"changeOutputs":[{"satoshis":298,"lockingScriptLength":25}],"size":673,"fee":2,"satsPerKb":2}'
+    },
+    {
+      n: 5,
+      d: d5,
+      er: '{"allocatedChangeInputs":[],"changeOutputs":[{"satoshis":799,"lockingScriptLength":25}],"size":191,"fee":1,"satsPerKb":2}'
+    }
+  ]
 
-  test('8 paramsText d5 d6 d7 d8 d9 d10 d11 d12 d13', async () => {
-    for (const { n, d, er } of [
-      {
-        n: 13,
-        d: d13,
-        er: '{"allocatedChangeInputs":[{"satoshis":1000,"outputId":18489,"spendable":false}],"changeOutputs":[{"satoshis":497,"lockingScriptLength":25}],"size":429,"fee":1,"satsPerKb":2}'
-      },
-      {
-        n: 12,
-        d: d12,
-        er: '{"allocatedChangeInputs":[{"satoshis":14030,"outputId":21194,"spendable":false}],"changeOutputs":[{"satoshis":13800,"lockingScriptLength":25}],"size":260,"fee":29,"satsPerKb":110}'
-      },
-      {
-        n: 11,
-        d: d11,
-        er: '{"allocatedChangeInputs":[{"satoshis":285,"outputId":21319,"spendable":false},{"satoshis":1000,"outputId":21309,"spendable":false}],"changeOutputs":[{"satoshis":1039,"lockingScriptLength":25}],"size":408,"fee":45,"satsPerKb":110}'
-      },
-      {
-        n: 10,
-        d: d10,
-        er: '{"allocatedChangeInputs":[{"satoshis":14030,"outputId":21194,"spendable":false}],"changeOutputs":[{"satoshis":13800,"lockingScriptLength":25}],"size":260,"fee":29,"satsPerKb":110}'
-      },
-      {
-        n: 9,
-        d: d9,
-        er: '{"allocatedChangeInputs":[{"satoshis":4571,"outputId":15626,"spendable":false}],"changeOutputs":[{"satoshis":3368,"lockingScriptLength":25}],"size":1373,"fee":3,"satsPerKb":2}'
-      },
-      {
-        n: 8,
-        d: d8,
-        er: '{"allocatedChangeInputs":[{"satoshis":1817,"outputId":15658,"spendable":false}],"changeOutputs":[{"satoshis":52,"lockingScriptLength":25}],"size":260,"fee":1,"satsPerKb":2}'
-      },
-      {
-        n: 7,
-        d: d7,
-        er: '{"allocatedChangeInputs":[{"satoshis":1817,"outputId":15658,"spendable":false}],"changeOutputs":[{"satoshis":46,"lockingScriptLength":25}],"size":260,"fee":1,"satsPerKb":2}'
-      },
-      {
-        n: 6,
-        d: d6,
-        er: '{"allocatedChangeInputs":[{"satoshis":1000,"outputId":16346,"spendable":false}],"changeOutputs":[{"satoshis":298,"lockingScriptLength":25}],"size":673,"fee":2,"satsPerKb":2}'
-      },
-      {
-        n: 5,
-        d: d5,
-        er: '{"allocatedChangeInputs":[],"changeOutputs":[{"satoshis":799,"lockingScriptLength":25}],"size":191,"fee":1,"satsPerKb":2}'
-      }
-    ]) {
+  test('8 paramsText d5 d6 d7 d8 d9 d10 d11 d12 d13 d14', async () => {
+    for (const { n, d, er } of test8Cases) {
       const params: GenerateChangeSdkParams = { ...d.p }
       const availableChange: GenerateChangeSdkChangeInput[] = [...d.availableChange]
 

package/src/storage/methods/generateChange.ts

@@ -236,6 +236,17 @@ export async function generateChangeSdk(
         if (feeExcess() < 0)
           // Not enough available funding even if no change outputs
           break
+        // At this point we have a funded transaction, but there may be change outputs that are each costing as change input,
+        // resulting in pointless churn of change outputs.
+        // And remove change inputs that funded only a single change output (along with that output)...
+        const changeInputs = [...r.allocatedChangeInputs]
+        while (changeInputs.length > 1 && r.changeOutputs.length > 1) {
+          const lastOutput = r.changeOutputs.slice(-1)[0]
+          const i = changeInputs.findIndex(ci => ci.satoshis <= lastOutput.satoshis)
+          if (i < 0) break
+          r.changeOutputs.pop()
+          changeInputs.splice(i, 1)
+        }
         // and try again...
       }
     }

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

@@ -1,5 +1,15 @@
-import { WalletOutput } from '@bsv/sdk'
-import { sdk, Services, Setup, StorageKnex, TableOutput, TableUser, verifyOne, verifyOneOrNone } from '../../../src'
+import { Transaction, WalletOutput } from '@bsv/sdk'
+import {
+  sdk,
+  Services,
+  Setup,
+  StorageKnex,
+  TableOutput,
+  TableTransaction,
+  TableUser,
+  verifyOne,
+  verifyOneOrNone
+} from '../../../src'
 import { _tu, TuEnv } from '../../utils/TestUtilsWalletStorage'
 import { specOpInvalidChange, ValidListOutputsArgs } from '../../../src/sdk'
 import { LocalWalletTestOptions } from '../../utils/localWalletMethods'
@@ -194,6 +204,29 @@ describe('operations.man tests', () => {
      */
     await storage.destroy()
   })
+  test('9 review recent transaction change use', async () => {
+    const { env, storage, services } = await createMainReviewSetup()
+    const countTxs = await storage.countTransactions({
+      partial: { userId: 311 },
+      status: ['completed', 'unproven', 'failed']
+    })
+    const txs = await storage.findTransactions({
+      partial: { userId: 311 },
+      status: ['unproven', 'completed', 'failed'],
+      paged: { limit: 100, offset: Math.max(0, countTxs - 100) }
+    })
+    for (const tx of txs) {
+      const ls = await toLogString(tx, storage)
+      console.log(ls)
+    }
+    const countReqs = await storage.countProvenTxReqs({ partial: {}, status: ['completed', 'unmined'] })
+    const reqs = await storage.findProvenTxReqs({
+      partial: {},
+      status: ['unmined', 'completed'],
+      paged: { limit: 100, offset: countReqs - 100 }
+    })
+    await storage.destroy()
+  })
 })
 
 async function createMainReviewSetup(): Promise<{
@@ -217,3 +250,33 @@ async function createMainReviewSetup(): Promise<{
   await storage.makeAvailable()
   return { env, storage, services }
 }
+
+async function toLogString(tx: TableTransaction, storage: StorageKnex): Promise<string> {
+  const rawTx = await storage.getRawTxOfKnownValidTransaction(tx.txid)
+  const btx = Transaction.fromBinary(rawTx!)
+  let log = `tx ${tx.txid} ${tx.status} s:${tx.satoshis} uid:${tx.userId} tid:${tx.transactionId}\n`
+  for (let i = 0; i < Math.max(btx.inputs.length, btx.outputs.length); i++) {
+    let ilog: string = ''
+    let olog: string = ''
+    if (i < btx.inputs.length) {
+      const input = btx.inputs[i]
+      ilog = `${logTxid(input.sourceTXID!)}.${input.sourceOutputIndex}`
+    }
+    if (i < btx.outputs.length) {
+      const output = btx.outputs[i]
+      olog = `${ar('' + output.satoshis, 9)} ${output.lockingScript.toHex().length / 2}`
+    }
+    log += `${ar('' + i, 5)} ${al(ilog, 20)} ${olog}\n`
+  }
+  return log
+
+  function logTxid(txid: string): string {
+    return `${txid.slice(0, 6)}..${txid.slice(-6)}`
+  }
+  function al(v: string | number, w: number): string {
+    return v.toString().padEnd(w)
+  }
+  function ar(v: string | number, w: number): string {
+    return v.toString().padStart(w)
+  }
+}