@bsv/wallet-toolbox 1.1.12 → 1.1.14

package/src/storage/methods/createAction.ts

@@ -27,6 +27,7 @@ import {
   TableTransaction,
   validateStorageFeeModel,
   verifyId,
+  verifyInteger,
   verifyNumber,
   verifyOne,
   verifyOneOrNone,
@@ -35,7 +36,8 @@ import {
 import {
   generateChangeSdk,
   GenerateChangeSdkChangeInput,
-  GenerateChangeSdkParams
+  GenerateChangeSdkParams,
+  maxPossibleSatoshis
 } from './generateChange'
 
 export async function createAction(
@@ -109,8 +111,19 @@ export async function createAction(
     transactionId: newTx.transactionId!
   }
 
-  const { allocatedChange, changeOutputs, derivationPrefix } =
-    await fundNewTransactionSdk(storage, userId, vargs, ctx)
+  const {
+    allocatedChange,
+    changeOutputs,
+    derivationPrefix,
+    maxPossibleSatoshisAdjustment
+  } = await fundNewTransactionSdk(storage, userId, vargs, ctx)
+
+  if (maxPossibleSatoshisAdjustment) {
+    const a = maxPossibleSatoshisAdjustment
+    if (ctx.xoutputs[a.fixedOutputIndex].satoshis !== maxPossibleSatoshis)
+      throw new sdk.WERR_INTERNAL()
+    ctx.xoutputs[a.fixedOutputIndex].satoshis = a.satoshis
+  }
 
   // The satoshis of the transaction is the satoshis we get back in change minus the satoshis we spend.
   const satoshis =
@@ -443,7 +456,7 @@ async function createNewOutputs(
     }
 
     const ro: sdk.StorageCreateTransactionSdkOutput = {
-      vout: verifyTruthy(o.vout),
+      vout: verifyInteger(o.vout),
       satoshis: verifyTruthy(o.satoshis),
       lockingScript: !o.lockingScript ? '' : asString(o.lockingScript),
       providedBy: verifyTruthy(o.providedBy) as sdk.StorageProvidedBy,
@@ -767,6 +780,10 @@ async function fundNewTransactionSdk(
   allocatedChange: TableOutput[]
   changeOutputs: TableOutput[]
   derivationPrefix: string
+  maxPossibleSatoshisAdjustment?: {
+    fixedOutputIndex: number
+    satoshis: number
+  }
 }> {
   const params: GenerateChangeSdkParams = {
     fixedInputs: ctx.xinputs.map(xi => ({
@@ -891,7 +908,12 @@ async function fundNewTransactionSdk(
     allocatedChange: TableOutput[]
     changeOutputs: TableOutput[]
     derivationPrefix: string
+    maxPossibleSatoshisAdjustment?: {
+      fixedOutputIndex: number
+      satoshis: number
+    }
   } = {
+    maxPossibleSatoshisAdjustment: gcr.maxPossibleSatoshisAdjustment,
     allocatedChange: gcr.allocatedChangeInputs.map(i => outputs[i.outputId]),
     changeOutputs: gcr.changeOutputs.map(
       (o, i) =>

package/src/storage/methods/generateChange.ts

@@ -1,11 +1,20 @@
 import { sdk, validateStorageFeeModel } from '../../index.client'
 
+/**
+ * An output of this satoshis amount will be adjusted to the largest fundable amount.
+ */
+export const maxPossibleSatoshis = 2099999999999999
+
 export interface GenerateChangeSdkResult {
   allocatedChangeInputs: GenerateChangeSdkChangeInput[]
   changeOutputs: GenerateChangeSdkChangeOutput[]
   size: number
   fee: number
   satsPerKb: number
+  maxPossibleSatoshisAdjustment?: {
+    fixedOutputIndex: number
+    satoshis: number
+  }
 }
 
 /**
@@ -38,7 +47,7 @@ export async function generateChangeSdk(
 
   // eslint-disable-next-line no-useless-catch
   try {
-    validateGenerateChangeSdkParams(params)
+    const vgcpr = validateGenerateChangeSdkParams(params)
 
     const satsPerKb = params.feeModel.value || 0
 
@@ -269,6 +278,20 @@ export async function generateChangeSdk(
      */
     await fundTransaction()
 
+    if (feeExcess() < 0 && vgcpr.hasMaxPossibleOutput !== undefined) {
+      // Reduce the fixed output with satoshis of maxPossibleSatoshis to what will just fund the transaction...
+      if (
+        fixedOutputs[vgcpr.hasMaxPossibleOutput].satoshis !==
+        maxPossibleSatoshis
+      )
+        throw new sdk.WERR_INTERNAL()
+      fixedOutputs[vgcpr.hasMaxPossibleOutput].satoshis += feeExcess()
+      r.maxPossibleSatoshisAdjustment = {
+        fixedOutputIndex: vgcpr.hasMaxPossibleOutput,
+        satoshis: fixedOutputs[vgcpr.hasMaxPossibleOutput].satoshis
+      }
+    }
+
     /**
      * Trigger an account funding event if we don't have enough to cover this transaction.
      */
@@ -448,11 +471,18 @@ export interface GenerateChangeSdkChangeOutput {
   lockingScriptLength: number
 }
 
+export interface ValidateGenerateChangeSdkParamsResult {
+  hasMaxPossibleOutput?: number
+}
+
 export function validateGenerateChangeSdkParams(
   params: GenerateChangeSdkParams
-) {
+): ValidateGenerateChangeSdkParamsResult {
   if (!Array.isArray(params.fixedInputs))
     throw new sdk.WERR_INVALID_PARAMETER('fixedInputs', 'an array of objects')
+
+  const r: ValidateGenerateChangeSdkParamsResult = {}
+
   params.fixedInputs.forEach((x, i) => {
     sdk.validateSatoshis(x.satoshis, `fixedInputs[${i}].satoshis`)
     sdk.validateInteger(
@@ -473,6 +503,14 @@ export function validateGenerateChangeSdkParams(
       undefined,
       0
     )
+    if (x.satoshis === maxPossibleSatoshis) {
+      if (r.hasMaxPossibleOutput !== undefined)
+        throw new sdk.WERR_INVALID_PARAMETER(
+          `fixedOutputs[${i}].satoshis`,
+          `valid satoshis amount. Only one 'maxPossibleSatoshis' output allowed.`
+        )
+      r.hasMaxPossibleOutput = i
+    }
   })
 
   params.feeModel = validateStorageFeeModel(params.feeModel)
@@ -492,6 +530,8 @@ export function validateGenerateChangeSdkParams(
     params.changeUnlockingScriptLength,
     `changeUnlockingScriptLength`
   )
+
+  return r
 }
 
 export interface GenerateChangeSdkStorageChange

package/src/storage/methods/processAction.ts

@@ -24,6 +24,7 @@ import {
   TxScriptOffsets,
   validateStorageFeeModel,
   verifyId,
+  verifyInteger,
   verifyNumber,
   verifyOne,
   verifyOneOrNone,
@@ -359,7 +360,7 @@ async function validateCommitNewTxToStorageArgs(
   // outputs spendable will be updated for change to true and all others to !!o.tracked when tx has been broadcast
   // MAX_OUTPUTSCRIPT_LENGTH is limit for scripts left in outputs table
   for (const o of vargs.outputOutputs) {
-    const vout = verifyTruthy(o.vout)
+    const vout = verifyInteger(o.vout)
     const offset = vargs.txScriptOffsets.outputs[vout]
     const rawTxScript = asString(
       vargs.rawTx.slice(offset.offset, offset.offset + offset.length)

package/src/storage/schema/entities/__tests/ProvenTxTests.test.ts

@@ -100,7 +100,6 @@ describe('ProvenTx class method tests', () => {
       getHeight: async () => height,
       getBsvExchangeRate: async () => 0,
       getFiatExchangeRate: async () => 1,
-      postTxs: async () => [],
       postBeef: async () => [],
       getUtxoStatus: async () => ({
         name: 'mock-service',

package/src/storage/sync/StorageMySQLDojoReader.ts

@@ -298,7 +298,7 @@ export class StorageMySQLDojoReader extends StorageReader {
         spendable: !!d.spendable,
         change: d.providedBy !== 'you' && d.purpose === 'change',
         outputDescription: (d.description || '').trim(),
-        vout: verifyInteger(d.vout),
+        vout: verifyInteger(typeof d.vout !== 'number' ? 9999 : d.vout),
         satoshis: verifyInteger(d.amount),
         providedBy: verifyTruthy(d.providedBy || '')
           .trim()

package/src/utility/{ScriptTemplateSABPPP.ts → ScriptTemplateBRC29.ts}

@@ -9,27 +9,25 @@ import {
   LockingScript,
   P2PKH,
   PrivateKey,
-  Script,
-  Transaction,
-  UnlockingScript
+  Script
 } from '@bsv/sdk'
 
-export interface ScriptTemplateParamsSABPPP {
+export const brc29ProtocolID: WalletProtocol = [2, '3241645161d8']
+
+export interface ScriptTemplateParamsBRC29 {
   derivationPrefix?: string
   derivationSuffix?: string
   keyDeriver: KeyDeriverApi
 }
 
-export const brc29ProtocolID: WalletProtocol = [2, '3241645161d8']
-
 /**
  * Simple Authenticated BSV P2PKH Payment Protocol
  * https://brc.dev/29
  */
-export class ScriptTemplateSABPPP implements ScriptTemplate {
+export class ScriptTemplateBRC29 implements ScriptTemplate {
   p2pkh: P2PKH
 
-  constructor(public params: ScriptTemplateParamsSABPPP) {
+  constructor(public params: ScriptTemplateParamsBRC29) {
     this.p2pkh = new P2PKH()
 
     verifyTruthy(params.derivationPrefix)

package/src/utility/index.all.ts

@@ -1,5 +1,5 @@
 export * from './stampLog'
-export * from './ScriptTemplateSABPPP'
+export * from './ScriptTemplateBRC29'
 export * from './parseTxScriptOffsets'
 export * from './tscProofToMerklePath'
 export * from './utilityHelpers'

package/src/utility/index.client.ts

@@ -1,5 +1,5 @@
 export * from './stampLog'
-export * from './ScriptTemplateSABPPP'
+export * from './ScriptTemplateBRC29'
 export * from './parseTxScriptOffsets'
 export * from './tscProofToMerklePath'
 export * from './utilityHelpers'

package/src/utility/utilityHelpers.ts

@@ -87,7 +87,7 @@ export function verifyTruthy<T>(
   v: T | null | undefined,
   description?: string
 ): T {
-  if (v == null)
+  if (!v)
     throw new sdk.WERR_INTERNAL(description ?? 'A truthy value is required.')
   return v
 }

package/test/Wallet/StorageClient/storageClient.man.test.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import { StorageClient } from '../../../src/index.all'
+import { sdk, StorageClient } from '../../../src/index.all'
 import { _tu, TestWalletOnly } from '../../utils/TestUtilsWalletStorage'
 
 /**
@@ -32,17 +32,17 @@ describe('walletStorageClient test', () => {
     {
       const client = new StorageClient(
         wallet,
-        'https://staging-dojo.babbage.systems'
+        'https://staging-storage.babbage.systems'
       )
       await storage.addWalletStorageProvider(client)
       await storage.updateBackups()
     }
   })
 
-  test('2 create storage client wallet', async () => {
+  test('2 create storage client backup for test wallet', async () => {
     const ctx = await _tu.createTestWalletWithStorageClient({
       rootKeyHex: '1'.repeat(64),
-      endpointUrl: 'https://staging-dojo.babbage.systems'
+      endpointUrl: 'https://staging-storage.babbage.systems'
     })
     ctxs.push(ctx)
     const { wallet, storage } = ctx
@@ -52,4 +52,30 @@ describe('walletStorageClient test', () => {
       expect(auth.userId).toBeTruthy()
     }
   })
+
+  test('3 create storage client backup for main wallet', async () => {
+    const filePath = process.env.MY_MAIN_FILEPATH
+    const identityKey = process.env.MY_MAIN_IDENTITY || ''
+    const rootKeyHex = env.devKeys[identityKey]
+    expect(filePath && identityKey && rootKeyHex)
+
+    const chain: sdk.Chain = 'main'
+
+    const main = await _tu.createSQLiteTestWallet({
+      filePath,
+      databaseName: 'tone42',
+      chain,
+      rootKeyHex
+    })
+    ctxs.push(main)
+
+    {
+      const client = new StorageClient(
+        main.wallet,
+        'https://storage.babbage.systems'
+      )
+      await main.storage.addWalletStorageProvider(client)
+      await main.storage.updateBackups()
+    }
+  })
 })

package/test/Wallet/live/walletLive.man.test.ts

@@ -16,7 +16,7 @@ import {
   sdk,
   verifyOne,
   verifyId,
-  ScriptTemplateSABPPP,
+  ScriptTemplateBRC29,
   randomBytesBase64,
   randomBytes,
   EntityProvenTxReq,
@@ -451,7 +451,7 @@ export function createWalletPaymentOutput(args: {
   derivationSuffix: string
   lockingScript: string
 } {
-  const t = new ScriptTemplateSABPPP({
+  const t = new ScriptTemplateBRC29({
     derivationPrefix: randomBytesBase64(8),
     derivationSuffix: randomBytesBase64(8),
     keyDeriver: new KeyDeriver(PrivateKey.fromString(args.fromRootKeyHex))
@@ -495,7 +495,7 @@ export async function createWalletPaymentAction(args: {
 }> {
   const { toIdentityKey, outputSatoshis, keyDeriver, wallet } = args
 
-  const t = new ScriptTemplateSABPPP({
+  const t = new ScriptTemplateBRC29({
     derivationPrefix: randomBytesBase64(8),
     derivationSuffix: randomBytesBase64(8),
     keyDeriver

package/test/Wallet/sync/Wallet.updateWalletLegacyTestData.man.test.ts

@@ -66,6 +66,60 @@ describe('Wallet sync tests', () => {
     done0 = true
   })
 
+  test.skip('0a sync production dojo to local MySQL', async () => {
+    console.log(
+      'Importing from production dojo to local MySQL productiondojotone'
+    )
+    const identityKeyTone = process.env.MY_MAIN_IDENTITY || ''
+    const rootKeyHex = env.devKeys[identityKeyTone]
+    const chain: sdk.Chain = 'main'
+    const connection = JSON.parse(process.env.MAIN_DOJO_CONNECTION || '')
+    const readerKnex = _tu.createMySQLFromConnection(connection)
+    const reader = new StorageMySQLDojoReader({ chain, knex: readerKnex })
+    const writer = await _tu.createMySQLTestWallet({
+      databaseName: 'productiondojotone',
+      chain: 'main',
+      rootKeyHex,
+      dropAll: true
+    })
+
+    const identityKey = writer.identityKey
+    await writer.storage.syncFromReader(
+      identityKey,
+      new StorageSyncReader({ identityKey }, reader)
+    )
+
+    await reader.destroy()
+    await writer.activeStorage.destroy()
+  })
+
+  test('0b sweep mysql dojo sync to new sqlite', async () => {
+    const identityKeyTone = process.env.MY_MAIN_IDENTITY || ''
+    const rootKeyHex = env.devKeys[identityKeyTone]
+    const chain: sdk.Chain = 'main'
+
+    const sweepFrom = await _tu.createMySQLTestWallet({
+      databaseName: 'productiondojotone',
+      chain: 'main',
+      rootKeyHex
+    })
+
+    const sweepTo = await _tu.createSQLiteTestWallet({
+      filePath: '/Users/tone/Kz/tone42.sqlite',
+      databaseName: 'tone42',
+      chain: 'main',
+      rootKeyHex
+    })
+
+    //await sweepTo.activeStorage.updateProvenTxReq(2, { status: 'invalid' })
+    //await sweepTo.activeStorage.updateTransactionStatus('failed', 2)
+
+    await sweepFrom.wallet.sweepTo(sweepTo.wallet)
+
+    await sweepTo.wallet.destroy()
+    await sweepFrom.wallet.destroy()
+  })
+
   test('1 aggressively purge records from MySQL stagingdojotone', async () => {
     await waitFor0()
 

package/test/services/Services.test.ts

@@ -120,34 +120,4 @@ describe('Wallet services tests', () => {
       }
     }
   })
-
-  test('6 postBeef', async () => {
-    for (const { chain, wallet, services } of ctxs) {
-      if (!wallet.services || !services)
-        throw new sdk.WERR_INTERNAL('test requires setup with services')
-      {
-        if (chain === 'main') {
-          const txid =
-            'b56ccf7dd0eb6bb0341cb92a2045d902106e4c2add0a4af057c85e9dfaaebddf'
-          const rawTx = await wallet.services.getRawTx(txid)
-          const mp = await wallet.services.getMerklePath(txid)
-          const beef = new Beef()
-          beef.mergeBump(mp.merklePath!)
-          beef.mergeRawTx(rawTx.rawTx!)
-          // Using postTxs as postBeef is problematic still...
-          const r = await wallet.services.postTxs(beef, [txid])
-          if (r[0].status === 'error') {
-            console.log(`
-${r[0].error?.message}
-${beef.toLogString()}
-${beef.toHex()}
-              `)
-          } else {
-            expect(r[0].txidResults[0].txid).toBe(txid)
-            expect(r[0].status).toBe('success')
-          }
-        }
-      }
-    }
-  })
 })