@bsv/wallet-toolbox 1.1.13 → 1.1.14

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/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/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')
-          }
-        }
-      }
-    }
-  })
 })

package/test/utils/TestUtilsWalletStorage.ts

@@ -11,6 +11,7 @@ import {
   SatoshiValue,
   SignActionArgs,
   SignActionResult,
+  Transaction,
   Utils,
   WalletAction,
   WalletActionInput,
@@ -49,7 +50,9 @@ import {
   TableCertificate,
   TableCertificateField,
   TableOutputTagMap,
-  TableOutputTag
+  TableOutputTag,
+  ScriptTemplateBRC29,
+  Setup
 } from '../../src/index.all'
 
 import { Knex, knex as makeKnex } from 'knex'
@@ -57,22 +60,22 @@ import { Knex, knex as makeKnex } from 'knex'
 import * as dotenv from 'dotenv'
 dotenv.config()
 
-const localMySqlConnection = process.env.LOCAL_MYSQL_CONNECTION || ''
+const localMySqlConnection = process.env.MYSQL_CONNECTION || ''
 
 export interface TuEnv {
   chain: sdk.Chain
-  userId: number
   identityKey: string
-  mainTaalApiKey: string
-  testTaalApiKey: string
+  identityKey2: string
+  taalApiKey: string
   devKeys: Record<string, string>
-  noMySQL: boolean
+  runMySQL: boolean
   runSlowTests: boolean
   logTests: boolean
 }
 
 export abstract class TestUtilsWalletStorage {
-  static getEnv(chain: sdk.Chain) {
+
+  static getEnv(chain: sdk.Chain): TuEnv {
     // Identity keys of the lead maintainer of this repo...
     const identityKey =
       (chain === 'main'
@@ -86,18 +89,13 @@ export abstract class TestUtilsWalletStorage {
     const logTests = !!process.env.LOGTESTS
     const runMySQL = !!process.env.RUNMYSQL
     const runSlowTests = !!process.env.RUNSLOWTESTS
+    const mainTaalApiKey = process.env.MAIN_TAAL_API_KEY || ''
+    const testTaalApiKey = process.env.TEST_TAAL_API_KEY || ''
     return {
       chain,
       identityKey,
       identityKey2,
-      mainTaalApiKey: verifyTruthy(
-        process.env.MAIN_TAAL_API_KEY || '',
-        `.env value for 'mainTaalApiKey' is required.`
-      ),
-      testTaalApiKey: verifyTruthy(
-        process.env.TEST_TAAL_API_KEY || '',
-        `.env value for 'testTaalApiKey' is required.`
-      ),
+      taalApiKey: chain === 'main' ? mainTaalApiKey : testTaalApiKey,
       devKeys: JSON.parse(DEV_KEYS) as Record<string, string>,
       runMySQL,
       runSlowTests,
@@ -281,17 +279,16 @@ export abstract class TestUtilsWalletStorage {
     endpointUrl?: string
     chain?: sdk.Chain
   }): Promise<TestWalletOnly> {
-    if (args.chain === 'main')
-      throw new sdk.WERR_INVALID_PARAMETER(
-        'chain',
-        `'test' for now, 'main' is not yet supported.`
-      )
-
+    args.chain ||= 'test'
     const wo = await _tu.createWalletOnly({
-      chain: 'test',
+      chain: args.chain,
       rootKeyHex: args.rootKeyHex
     })
-    args.endpointUrl ||= 'https://staging-dojo.babbage.systems'
+    args.endpointUrl ||=
+      args.chain === 'main'
+        ? 'https://storage.babbage.systems'
+        : 'https://staging-storage.babbage.systems'
+
     const client = new StorageClient(wo.wallet, args.endpointUrl)
     await wo.storage.addWalletStorageProvider(client)
     await wo.storage.makeAvailable()
@@ -1224,7 +1221,7 @@ export abstract class TestUtilsWalletStorage {
 
           // Need to convert
           const lockingScriptValue = input.sourceLockingScript
-            ? hexStringToNumberArray(input.sourceLockingScript)
+            ? Utils.toArray(input.sourceLockingScript, 'hex')
             : undefined
 
           prevOutput = await _tu.insertTestOutput(
@@ -1396,6 +1393,160 @@ export abstract class TestUtilsWalletStorage {
         )
     }
   }
+
+  static async createWalletSetupEnv(chain: sdk.Chain): Promise<TestWalletOnly> {
+    const env = Setup.getEnv(chain)
+    const rootKeyHex = env.devKeys[env.identityKey]
+
+    if (env.filePath) {
+      return await _tu.createSQLiteTestWallet({
+        filePath: env.filePath,
+        databaseName: 'setupEnvWallet',
+        chain,
+        rootKeyHex
+      })
+    }
+
+    return await _tu.createTestWalletWithStorageClient({
+      chain,
+      rootKeyHex
+    })
+  }
+
+  /**
+   * Create a pair of transacitons that cancel out, other than the transaciton fees.
+   * Both created transactions are left with status 'noSend'.
+   * This allows the transactions to either be broadcast by an external party,
+   * or they may be aborted.
+   *
+   * `doubleSpendTx` should only be used for double spend testing.
+   * It attempts to forward the txidDo input, which should already have been reclaimed by txidUndo, to a random private key output.
+   *
+   * @param wallet the wallet that will create both transactions, or Chain and createWalletEnv is used to create a wallet.
+   * @param satoshis amount of new output created and consumed. Defaults to 41.
+   * @returns { txidDo: string, txidUndo: string, beef: Beef, doubleSpendTx: transaction }
+   */
+  static async createNoSendTxPair(
+    wallet: Wallet | sdk.Chain,
+    satoshis = 41
+  ): Promise<{
+    txidDo: string
+    txidUndo: string
+    beef: Beef
+    doubleSpendTx: Transaction
+  }> {
+    let destroyWallet = false
+    if (wallet === 'main' || wallet === 'test') {
+      wallet = (await _tu.createWalletSetupEnv(wallet)).wallet
+      destroyWallet = true
+    }
+
+    const derivationPrefix = randomBytesBase64(8)
+    const derivationSuffix = randomBytesBase64(8)
+    const keyDeriver = wallet.keyDeriver
+
+    const t = new ScriptTemplateBRC29({
+      derivationPrefix,
+      derivationSuffix,
+      keyDeriver
+    })
+
+    let label = 'doTxPair'
+    const car = await wallet.createAction({
+      outputs: [
+        {
+          lockingScript: t
+            .lock(keyDeriver.rootKey.toString(), wallet.identityKey)
+            .toHex(),
+          satoshis,
+          outputDescription: label,
+          customInstructions: JSON.stringify({
+            derivationPrefix,
+            derivationSuffix,
+            type: 'BRC29'
+          })
+        }
+      ],
+      options: {
+        randomizeOutputs: false,
+        noSend: true
+      },
+      description: label
+    })
+
+    const beef = Beef.fromBinary(car.tx!)
+    const txidDo = car.txid!
+    const outpoint = `${car.txid!}.0`
+
+    const unlock = t.unlock(
+      keyDeriver.rootKey.toString(),
+      wallet.identityKey,
+      satoshis
+    )
+
+    label = 'undoTxPair'
+
+    const car2 = await wallet.createAction({
+      inputBEEF: beef.toBinary(),
+      inputs: [
+        {
+          outpoint,
+          unlockingScriptLength: t.unlockLength,
+          inputDescription: label
+        }
+      ],
+      description: label,
+      options: {
+        noSend: true,
+        noSendChange: car.noSendChange
+      }
+    })
+
+    const st = car2.signableTransaction!
+    const stBeef = Beef.fromBinary(st.tx)
+    const tx = wallet.beef.findAtomicTransaction(stBeef.txs.slice(-1)[0].txid)!
+    tx.inputs[0].unlockingScriptTemplate = unlock
+    await tx.sign()
+    const unlockingScript = tx.inputs[0].unlockingScript!.toHex()
+
+    const signArgs: SignActionArgs = {
+      reference: st.reference,
+      spends: { 0: { unlockingScript } },
+      options: {
+        noSend: true
+      }
+    }
+
+    const sar = await wallet.signAction(signArgs)
+
+    beef.mergeBeef(sar.tx!)
+    const txidUndo = sar.txid!
+
+    if (destroyWallet) await wallet.destroy()
+
+    const doubleSpendTx = new Transaction()
+    const sourceTXID = txidDo
+    const sourceOutputIndex = 0
+    const sourceSatoshis = satoshis
+    doubleSpendTx.addInput({
+      sourceOutputIndex,
+      sourceTXID,
+      sourceTransaction: beef.findAtomicTransaction(sourceTXID),
+      unlockingScriptTemplate: unlock
+    })
+    doubleSpendTx.addOutput({
+      satoshis: sourceSatoshis - 10,
+      lockingScript: new P2PKH().lock(PrivateKey.fromRandom().toAddress())
+    })
+    await doubleSpendTx.sign()
+
+    return {
+      txidDo,
+      txidUndo,
+      beef,
+      doubleSpendTx
+    }
+  }
 }
 
 export abstract class _tu extends TestUtilsWalletStorage {}
@@ -1535,18 +1686,6 @@ function mockPostServices(
           return Promise.resolve([r])
         }
       )
-    services.postTxs = jest
-      .fn()
-      .mockImplementation(
-        (beef: Beef, txids: string[]): Promise<sdk.PostBeefResult[]> => {
-          const r: sdk.PostBeefResult = {
-            name: 'mock',
-            status: 'success',
-            txidResults: txids.map(txid => ({ txid, status }))
-          }
-          return Promise.resolve([r])
-        }
-      )
   }
 }
 
@@ -2179,12 +2318,3 @@ export async function logInput(
 export function logBasket(basket: TableOutputBasket): string {
   return `\n-- Basket --\nName: ${basket.name}\n`
 }
-
-export function hexStringToNumberArray(hexString: string): number[] {
-  const sanitizedHex = hexString.replace(/[^a-fA-F0-9]/g, '')
-  const result: number[] = []
-  for (let i = 0; i < sanitizedHex.length; i += 2) {
-    result.push(parseInt(sanitizedHex.substr(i, 2), 16))
-  }
-  return result
-}

package/test/wallet/list/listActions2.test.ts

@@ -1,12 +1,9 @@
-//@ts-nocheck
 import * as bsv from '@bsv/sdk'
 import { sdk, StorageProvider } from '../../../src/index.client'
 import {
   _tu,
   expectToThrowWERR,
-  hexStringToNumberArray,
   MockData,
-  TestSetup2,
   TestWalletNoSetup
 } from '../../utils/TestUtilsWalletStorage'
 
@@ -57,7 +54,7 @@ describe('listActions2 single action tests', () => {
   beforeEach(async () => {
     ctxs = []
     const args = {
-      chain: 'test',
+      chain: <sdk.Chain>'test',
       mockData,
       databaseName: testName(),
       rootKeyHex: '2'.repeat(64),
@@ -743,7 +740,7 @@ describe('listActions2 single action tests', () => {
         vout: 2,
         outputDescription: 'new description',
         basketId: 1,
-        lockingScript: hexStringToNumberArray('0123456789abcdef')
+        lockingScript: bsv.Utils.toArray('0123456789abcdef', 'hex')
       })
       await storage.updateOutputTag(2, { tag: 'new tag' })
       await storage.updateOutputTagMap(1, 2, {})
@@ -773,7 +770,7 @@ describe('listActions2 single action tests', () => {
         vout: 2,
         outputDescription: 'new description',
         basketId: 1,
-        lockingScript: hexStringToNumberArray('0123456789abcdef')
+        lockingScript: bsv.Utils.toArray('0123456789abcdef', 'hex')
       })
       await storage.updateOutputTag(2, { tag: 'new tag' })
       await storage.updateOutputTagMap(1, 2, {})
@@ -1243,7 +1240,7 @@ describe('listActions2 two action tests', () => {
   beforeEach(async () => {
     ctxs = []
     const args = {
-      chain: 'test',
+      chain: <sdk.Chain>'test',
       mockData,
       databaseName: testName(),
       rootKeyHex: '2'.repeat(64),

package/out/src/services/__tests/postBeefToArcTaal.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=postBeefToArcTaal.test.d.ts.map

package/out/src/services/__tests/postBeefToArcTaal.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"postBeefToArcTaal.test.d.ts","sourceRoot":"","sources":["../../../../src/services/__tests/postBeefToArcTaal.test.ts"],"names":[],"mappings":""}