add repeatable txids from createAction for test support

Author: tonesnotes

src/Wallet.ts

@@ -119,6 +119,11 @@ export class Wallet implements WalletInterface, ProtoWallet {
 
   pendingSignActions: Record<string, PendingSignAction>
 
+  /**
+   * For repeatability testing, set to an array of random numbers from [0..1).
+   */
+  randomVals?: number[] = undefined
+
   constructor(
     argsOrSigner: WalletArgs | WalletSigner,
     services?: sdk.WalletServices,
@@ -632,6 +637,10 @@ export class Wallet implements WalletInterface, ProtoWallet {
       args,
       sdk.validateCreateActionArgs
     )
+    if (this.randomVals && this.randomVals.length > 1) {
+      vargs.randomVals = [...this.randomVals]
+    }
+
     const r = await createAction(this, auth, vargs)
 
     if (r.signableTransaction) {

src/sdk/validationHelpers.ts

@@ -403,6 +403,7 @@ export interface ValidCreateActionArgs extends ValidProcessActionArgs {
   options: ValidCreateActionOptions
   // true if transaction creation completion will require a `signAction` call.
   isSignAction: boolean
+  randomVals?: number[]
 }
 
 export interface ValidSignActionArgs extends ValidProcessActionArgs {
@@ -428,7 +429,8 @@ export function validateCreateActionArgs(
     isDelayed: false,
     isNoSend: false,
     isNewTx: false,
-    isSignAction: false
+    isSignAction: false,
+    randomVals: undefined
   }
   vargs.isSendWith = vargs.options.sendWith.length > 0
   vargs.isNewTx = vargs.inputs.length > 0 || vargs.outputs.length > 0

src/storage/methods/createAction.ts

@@ -7,7 +7,9 @@ import {
   PrivateKey,
   PubKeyHex,
   PublicKey,
-  Script
+  Random,
+  Script,
+  Utils
 } from '@bsv/sdk'
 import {
   asArray,
@@ -781,7 +783,8 @@ async function fundNewTransactionSdk(
     changeLockingScriptLength: 25,
     changeUnlockingScriptLength: 107,
     targetNetCount:
-      ctx.changeBasket.numberOfDesiredUTXOs - ctx.availableChangeCount
+      ctx.changeBasket.numberOfDesiredUTXOs - ctx.availableChangeCount,
+    randomVals: vargs.randomVals
   }
 
   const noSendChange = [...ctx.noSendChangeIn]
@@ -845,8 +848,42 @@ async function fundNewTransactionSdk(
     releaseChangeInput
   )
 
+  const nextRandomVal = (): number => {
+    let val = 0
+    if (!vargs.randomVals || vargs.randomVals.length === 0) {
+      val = Math.random()
+    } else {
+      val = vargs.randomVals.shift() || 0
+      vargs.randomVals.push(val)
+    }
+    return val
+  }
+
+  /**
+   * @returns a random integer betweenn min and max, inclussive.
+   */
+  const rand = (min: number, max: number): number => {
+    if (max < min)
+      throw new sdk.WERR_INVALID_PARAMETER(
+        'max',
+        `less than min (${min}). max is (${max})`
+      )
+    return Math.floor(nextRandomVal() * (max - min + 1) + min)
+  }
+
+  const randomDerivation = (count: number) : string => {
+    let val: number[] = []
+    if (!vargs.randomVals || vargs.randomVals.length === 0) {
+      val = Random(count)
+    } else {
+      for (let i = 0; i < count; i++)
+        val.push(rand(0, 255))
+    }
+    return Utils.toBase64(val)
+  }
+
   // Generate a derivation prefix for the payment
-  const derivationPrefix = randomBytesBase64(16)
+  const derivationPrefix = randomDerivation(16)
 
   const r: {
     allocatedChange: table.Output[]
@@ -870,7 +907,7 @@ async function fundNewTransactionSdk(
           change: true,
           type: 'P2PKH',
           derivationPrefix,
-          derivationSuffix: randomBytesBase64(16),
+          derivationSuffix: randomDerivation(16),
           providedBy: 'storage',
           purpose: 'change',
           customInstructions: undefined,

test/wallet/action/createAction.test.ts

@@ -16,21 +16,23 @@ describe('createAction test', () => {
   const env = _tu.getEnv('test')
   const testName = () => expect.getState().currentTestName || 'test'
 
-  const ctxs: TestWalletNoSetup[] = []
+  let ctxs: TestWalletNoSetup[]
 
-  beforeAll(async () => {
+  beforeEach(async () => {
+    ctxs = []
     if (env.runMySQL)
       ctxs.push(await _tu.createLegacyWalletMySQLCopy('createActionTests'))
-    ctxs.push(await _tu.createLegacyWalletSQLiteCopy('createActionTests'))
+    ctxs.push(await _tu.createLegacyWalletSQLiteCopy(`${testName()}`))
     _tu.mockPostServicesAsSuccess(ctxs)
   })
 
-  afterAll(async () => {
+  afterEach(async () => {
     for (const ctx of ctxs) {
       await ctx.storage.destroy()
     }
   })
-  test('1_invalid_params', async () => {
+
+  test('0_invalid_params', async () => {
     for (const { wallet } of ctxs) {
       {
         const log = `\n${testName()}\n`
@@ -64,6 +66,32 @@ describe('createAction test', () => {
     }
   })
 
+  test('1_repeatable txid', async () => {
+    for (const { wallet } of ctxs) {
+      wallet.randomVals = [0.1, 0.2, 0.3, 0.7, 0.8, 0.9]
+      const root = '02135476'
+      const kp = _tu.getKeyPair(root.repeat(8))
+        const createArgs: CreateActionArgs = {
+          description: `repeatable`,
+          outputs: [
+            {
+              satoshis: 45,
+              lockingScript: _tu.getLockP2PKH(kp.address).toHex(),
+              outputDescription: 'pay echo'
+            }
+          ],
+          options: {
+            randomizeOutputs: false,
+            signAndProcess: true,
+            noSend: true
+          }
+        }
+
+        const cr = await wallet.createAction(createArgs)
+        expect(cr.txid === '4f428a93c43c2d120204ecdc06f7916be8a5f4542cc8839a0fd79bd1b44582f3')
+      }
+  })
+
   test('2_signableTransaction', async () => {
     for (const { wallet } of ctxs) {
       const root = '02135476'