@bsv/wallet-toolbox 1.1.31 → 1.1.33

package/package.json

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

package/src/Wallet.ts

@@ -116,6 +116,12 @@ export class Wallet implements WalletInterface, ProtoWallet {
    * Over time, this allows an active wallet to drastically reduce the amount of data transmitted.
    */
   beef: BeefParty
+  /**
+   * If true, signableTransactions will include sourceTransaction for each input,
+   * including those that do not require signature and those that were also contained
+   * in the inputBEEF.
+   */
+  includeAllSourceTransactions: boolean = true
   /**
    * If true, beefs returned to the user may contain txidOnly transactions.
    */
@@ -676,42 +682,19 @@ export class Wallet implements WalletInterface, ProtoWallet {
       args,
       sdk.validateCreateActionArgs
     )
+    vargs.includeAllSourceTransactions = this.includeAllSourceTransactions
     if (this.randomVals && this.randomVals.length > 1) {
       vargs.randomVals = [...this.randomVals]
     }
 
     const r = await createAction(this, auth, vargs)
 
-    if (r.signableTransaction) {
-      const st = r.signableTransaction
-      const ab = Beef.fromBinary(st.tx)
-      if (!ab.atomicTxid)
-        throw new sdk.WERR_INTERNAL(
-          'Missing atomicTxid in signableTransaction result'
-        )
-      if (ab.txs.length < 1 || ab.txs[ab.txs.length - 1].txid !== ab.atomicTxid)
-        throw new sdk.WERR_INTERNAL(
-          'atomicTxid does not match txid of last AtomicBEEF transaction'
-        )
-      // Merge the inputBEEF into the beef going back to the user for lockingScripts.
-      if (vargs.inputBEEF) {
-        ab.mergeBeef(vargs.inputBEEF)
-        r.signableTransaction.tx = ab.toBinaryAtomic(ab.atomicTxid)
-      }
-      // Remove the new, partially constructed transaction from beef as it will never be a valid transaction.
-      ab.txs.slice(ab.txs.length - 1)
-      this.beef.mergeBeefFromParty(this.storageParty, ab)
-    } else if (r.tx) {
+    if (r.tx) {
       this.beef.mergeBeefFromParty(this.storageParty, r.tx)
     }
 
     if (r.tx) r.tx = this.verifyReturnedTxidOnlyAtomicBEEF(r.tx)
 
-    if (r.signableTransaction?.tx)
-      r.signableTransaction.tx = this.verifyReturnedTxidOnlyAtomicBEEF(
-        r.signableTransaction.tx
-      )
-
     if (
       !vargs.options.acceptDelayedBroadcast &&
       r.sendWithResults &&

package/src/sdk/WalletStorage.interfaces.ts

@@ -244,6 +244,10 @@ export interface StorageCreateTransactionSdkInput {
   sourceVout: number
   sourceSatoshis: number
   sourceLockingScript: string
+  /**
+   *
+   */
+  sourceTransaction?: number[]
   unlockingScriptLength: number
   providedBy: StorageProvidedBy
   type: string

package/src/sdk/validationHelpers.ts

@@ -404,6 +404,12 @@ export interface ValidCreateActionArgs extends ValidProcessActionArgs {
   // true if transaction creation completion will require a `signAction` call.
   isSignAction: boolean
   randomVals?: number[]
+  /**
+   * If true, signableTransactions will include sourceTransaction for each input,
+   * including those that do not require signature and those that were also contained
+   * in the inputBEEF.
+   */
+  includeAllSourceTransactions: boolean
 }
 
 export interface ValidSignActionArgs extends ValidProcessActionArgs {
@@ -430,7 +436,8 @@ export function validateCreateActionArgs(
     isNoSend: false,
     isNewTx: false,
     isSignAction: false,
-    randomVals: undefined
+    randomVals: undefined,
+    includeAllSourceTransactions: false
   }
   vargs.isSendWith = vargs.options.sendWith.length > 0
   vargs.isNewTx = vargs.inputs.length > 0 || vargs.outputs.length > 0

package/src/signer/methods/createAction.ts

@@ -1,4 +1,5 @@
 import {
+  Beef,
   CreateActionResult,
   SendWithResult,
   SignActionResult,
@@ -79,7 +80,7 @@ function makeSignableTransactionResult(
       : undefined,
     signableTransaction: {
       reference: prior.dcr.reference,
-      tx: makeAtomicBeef(prior.tx, prior.dcr.inputBeef)
+      tx: makeSignableTransactionBeef(prior.tx, prior.dcr.inputBeef)
     }
   }
 
@@ -88,6 +89,21 @@ function makeSignableTransactionResult(
   return r
 }
 
+function makeSignableTransactionBeef(
+  tx: Transaction,
+  inputBEEF: number[]
+): number[] {
+  for (const input of tx.inputs) {
+    if (!input.sourceTransaction)
+      throw new sdk.WERR_INTERNAL(
+        'Every signableTransaction input must have a sourceTransaction'
+      )
+  }
+  const beef = new Beef()
+  beef.mergeTransaction(tx)
+  return beef.toBinaryAtomic(tx.id('hex'))
+}
+
 /**
  * Derive a change output locking script
  */
@@ -230,6 +246,8 @@ function buildSignableTransaction(
 } {
   const changeKeys = wallet.getClientChangeKeyPair()
 
+  const inputBeef = args.inputBEEF ? Beef.fromBinary(args.inputBEEF) : undefined
+
   const { inputs: storageInputs, outputs: storageOutputs } = dctr
 
   const tx = new Transaction(args.version, [], [], args.lockTime)
@@ -313,9 +331,15 @@ function buildSignableTransaction(
       const unlock = hasUnlock
         ? asBsvSdkScript(argsInput.unlockingScript!)
         : new Script()
+      const sourceTransaction = args.isSignAction
+        ? inputBeef?.findTxid(argsInput.outpoint.txid)?.tx
+        : undefined
       const inputToAdd: TransactionInput = {
         sourceTXID: argsInput.outpoint.txid,
         sourceOutputIndex: argsInput.outpoint.vout,
+        // Include the source transaction for access to the outputs locking script and output satoshis for user side fee calculation.
+        // TODO: Make this conditional to improve performance when user can supply locking scripts themselves.
+        sourceTransaction,
         unlockingScript: unlock,
         sequence: argsInput.sequenceNumber
       }
@@ -340,6 +364,9 @@ function buildSignableTransaction(
       const inputToAdd: TransactionInput = {
         sourceTXID: storageInput.sourceTxid,
         sourceOutputIndex: storageInput.sourceVout,
+        sourceTransaction: storageInput.sourceTransaction
+          ? Transaction.fromBinary(storageInput.sourceTransaction)
+          : undefined,
         unlockingScript: new Script(),
         sequence: 0xffffffff
       }
@@ -362,3 +389,14 @@ function buildSignableTransaction(
     log: ''
   }
 }
+
+function makeDummyTransactionForOutputSatoshis(
+  vout: number,
+  satoshis: number
+): Transaction {
+  const tx = new Transaction()
+  for (let i = 0; i < vout; i++)
+    tx.addOutput({ lockingScript: new Script(), satoshis: 0 })
+  tx.addOutput({ lockingScript: new Script(), satoshis })
+  return tx
+}

package/src/storage/methods/createAction.ts

@@ -268,12 +268,17 @@ async function createNewInputs(
         throw new sdk.WERR_INTERNAL(
           `vin ${vin} non-fixedInput without unlockLen`
         )
+      const sourceTransaction =
+        vargs.includeAllSourceTransactions && vargs.isSignAction
+          ? await storage.getRawTxOfKnownValidTransaction(o.txid!)
+          : undefined
       const ri: sdk.StorageCreateTransactionSdkInput = {
         vin,
         sourceTxid: o.txid!,
         sourceVout: o!.vout!,
         sourceSatoshis: o.satoshis!,
         sourceLockingScript: asString(o.lockingScript!),
+        sourceTransaction,
         unlockingScriptLength: unlockLen ? unlockLen : i!.unlockingScriptLength,
         providedBy:
           i && o.providedBy === 'storage'

package/test/utils/TestUtilsWalletStorage.ts

@@ -1503,7 +1503,7 @@ export abstract class TestUtilsWalletStorage {
 
     const st = car2.signableTransaction!
     const stBeef = Beef.fromBinary(st.tx)
-    const tx = wallet.beef.findAtomicTransaction(stBeef.txs.slice(-1)[0].txid)!
+    const tx = stBeef.findAtomicTransaction(stBeef.txs.slice(-1)[0].txid)!
     tx.inputs[0].unlockingScriptTemplate = unlock
     await tx.sign()
     const unlockingScript = tx.inputs[0].unlockingScript!.toHex()