@bsv/sdk 1.0.34 → 1.0.37

package/mod.ts

@@ -4,6 +4,7 @@ export * from "./src/script/templates/index.js"
 export * from "./src/transaction/index.js"
 export * from "./src/transaction/fee-models/index.js"
 export * from "./src/transaction/broadcasters/index.js"
+export * from "./src/transaction/chaintrackers/index.js"
 export * from "./src/transaction/http/index.js"
 export * from "./src/messages/index.js"
 export * from "./src/compat/index.js"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/sdk",
-  "version": "1.0.34",
+  "version": "1.0.37",
   "type": "module",
   "description": "BSV Blockchain Software Development Kit",
   "main": "dist/cjs/mod.js",

package/src/primitives/PrivateKey.ts

@@ -209,15 +209,17 @@ export default class PrivateKey extends BigNumber {
    * Base58Check encodes the hash of the public key associated with this private key with a prefix to indicate locking script type.
    * Defaults to P2PKH for mainnet, otherwise known as a "Bitcoin Address".
    *
-   * @param prefix defaults to [0x00] for mainnet, set to [0x6f] for testnet.
+   * @param prefix defaults to [0x00] for mainnet, set to [0x6f] for testnet or use the strings 'testnet' or 'mainnet'
    *
    * @returns Returns the address encoding associated with the hash of the public key associated with this private key.
    *
    * @example
-   * const address = pubkey.toAddress()
-   * const testnetAddress = pubkey.toAddress([0x6f])
+   * const address = privkey.toAddress()
+   * const address = privkey.toAddress('mainnet')
+   * const testnetAddress = privkey.toAddress([0x6f])
+   * const testnetAddress = privkey.toAddress('testnet')
    */
-  toAddress (prefix: number[] = [0x00]): string {
+  toAddress (prefix: number[] | string = [0x00]): string {
     return this.toPublicKey().toAddress(prefix)
   }
 

package/src/primitives/PublicKey.ts

@@ -145,15 +145,26 @@ export default class PublicKey extends Point {
    * Base58Check encodes the hash of the public key with a prefix to indicate locking script type.
    * Defaults to P2PKH for mainnet, otherwise known as a "Bitcoin Address".
    *
-   * @param prefix defaults to [0x00] for mainnet, set to [0x6f] for testnet.
+   * @param prefix defaults to [0x00] for mainnet, set to [0x6f] for testnet or use the strings 'mainnet' or 'testnet'
    *
    * @returns Returns the address encoding associated with the hash of the public key.
    *
    * @example
    * const address = pubkey.toAddress()
+   * const address = pubkey.toAddress('mainnet')
    * const testnetAddress = pubkey.toAddress([0x6f])
+   * const testnetAddress = pubkey.toAddress('testnet')
    */
-  toAddress (prefix: number[] = [0x00]): string {
+  toAddress (prefix: number[] | string = [0x00]): string {
+    if (typeof prefix === 'string') {
+      if (prefix === 'testnet' || prefix === 'test') {
+        prefix = [0x6f]
+      } else if (prefix === 'mainnet' || prefix === 'main') {
+        prefix = [0x00]
+      } else {
+        throw new Error(`Invalid prefix ${prefix}`)
+      }
+    }
     return toBase58Check(this.toHash() as number[], prefix)
   }
 

package/src/script/templates/P2PKH.ts

@@ -91,6 +91,7 @@ export default class P2PKH implements ScriptTemplate {
           )
         }
         sourceSatoshis ||= input.sourceTransaction?.outputs[input.sourceOutputIndex].satoshis
+        sourceSatoshis ||= input.sourceSatoshis
         if (!sourceSatoshis) {
           throw new Error(
             'The sourceSatoshis or input sourceTransaction is required for transaction signing.'

package/src/transaction/Transaction.ts

@@ -10,8 +10,8 @@ import { Broadcaster, BroadcastResponse, BroadcastFailure } from './Broadcaster.
 import MerklePath from './MerklePath.js'
 import Spend from '../script/Spend.js'
 import ChainTracker from './ChainTracker.js'
-import {defaultBroadcaster} from "./broadcasters/DefaultBroadcaster.js";
-import {defaultChainTracker} from "./chaintrackers/DefaultChainTracker.js";
+import { defaultBroadcaster } from './broadcasters/DefaultBroadcaster.js'
+import { defaultChainTracker } from './chaintrackers/DefaultChainTracker.js'
 
 /**
  * Represents a complete Bitcoin transaction. This class encapsulates all the details
@@ -293,26 +293,35 @@ export default class Transaction {
   /**
    * Computes fees prior to signing.
    * If no fee model is provided, uses a SatoshisPerKilobyte fee model that pays 10 sat/kb.
+   * If fee is a number, the transaction uses that value as fee.
    *
-   * @param model - The initialized fee model to use
+   * @param modelOrFee - The initialized fee model to use or fixed fee for the transaction
    * @param changeDistribution - Specifies how the change should be distributed
    * amongst the change outputs
    *
    * TODO: Benford's law change distribution.
    */
-  async fee (model?: FeeModel, changeDistribution: 'equal' | 'random' = 'equal'): Promise<void> {
+  async fee (modelOrFee?: FeeModel | number, changeDistribution: 'equal' | 'random' = 'equal'): Promise<void> {
     this.cachedHash = undefined
-    if (typeof model === 'undefined') {
-      model = new SatoshisPerKilobyte(10)
+    if (typeof modelOrFee === 'undefined') {
+      modelOrFee = new SatoshisPerKilobyte(10)
     }
-    const fee = await model.computeFee(this)
+    if (typeof modelOrFee === 'number') {
+      const sats = modelOrFee
+      modelOrFee = {
+        computeFee: async () => sats
+      }
+    }
+    const fee = await modelOrFee.computeFee(this)
     // change = inputs - fee - non-change outputs
     let change = 0
     for (const input of this.inputs) {
-      if (typeof input.sourceTransaction !== 'object') {
-        throw new Error('Source transactions are required for all inputs during fee computation')
+      if (typeof input.sourceTransaction !== 'object' && typeof input.sourceSatoshis !== 'number') {
+        throw new Error('Source transactions or sourceSatoshis are required for all inputs during fee computation')
       }
-      change += input.sourceTransaction.outputs[input.sourceOutputIndex].satoshis
+      change += input.sourceTransaction
+        ? input.sourceTransaction.outputs[input.sourceOutputIndex].satoshis
+        : input.sourceSatoshis
     }
     change -= fee
     let changeCount = 0
@@ -350,6 +359,28 @@ export default class Transaction {
     }
   }
 
+  /**
+   * Utility method that returns the current fee based on inputs and outputs
+   *
+   * @returns The current transaction fee
+   */
+  getFee (): number {
+    let totalIn = 0
+    for (const input of this.inputs) {
+      if (typeof input.sourceTransaction !== 'object' && typeof input.sourceSatoshis !== 'number') {
+        throw new Error('Source transactions or sourceSatoshis are required for all inputs to calculate fee')
+      }
+      totalIn += input.sourceTransaction
+        ? input.sourceTransaction.outputs[input.sourceOutputIndex].satoshis
+        : input.sourceSatoshis || 0
+    }
+    let totalOut = 0
+    for (const output of this.outputs) {
+      totalOut += output.satoshis || 0
+    }
+    return totalIn - totalOut
+  }
+
   /**
    * Signs a transaction, hydrating all its unlocking scripts based on the provided script templates where they are available.
    */

package/src/transaction/TransactionInput.ts

@@ -16,6 +16,9 @@ import Transaction from './Transaction.js'
  * @property {number} sourceOutputIndex - The index of the output in the source transaction
  *           that this input is spending. It is zero-based, indicating the position of the
  *           output in the array of outputs of the source transaction.
+ * @property {number} [sourceSatoshis] - The amount of satoshis of the source transaction
+ *           output that this input is spending, used for fee calculation and signing when
+ *           source transaction is not present
  * @property {UnlockingScript} [unlockingScript] - Optional. The script that 'unlocks' the
  *           source output for spending. This script typically contains signatures and
  *           public keys that evidence the ownership of the output.
@@ -54,6 +57,7 @@ export default interface TransactionInput {
   sourceTransaction?: Transaction
   sourceTXID?: string
   sourceOutputIndex: number
+  sourceSatoshis?: number
   unlockingScript?: UnlockingScript
   unlockingScriptTemplate?: {
     sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>

package/src/transaction/__tests/Transaction.test.ts

@@ -317,6 +317,32 @@ describe('Transaction', () => {
       // 4000 sats in - 1000 sats out - 1033 sats fee = expected 1967 sats change
       expect(spendTx.outputs[1].satoshis).toEqual(1967)
     })
+    it('Computes fee using FixedFee model', async () => {
+      const privateKey = new PrivateKey(1)
+      const publicKey = new Curve().g.mul(privateKey)
+      const publicKeyHash = hash160(publicKey.encode(true)) as number[]
+      const p2pkh = new P2PKH()
+      const sourceTx = new Transaction(1, [], [{
+        lockingScript: p2pkh.lock(publicKeyHash),
+        satoshis: 4000
+      }], 0)
+      const spendTx = new Transaction(1, [{
+        sourceTransaction: sourceTx,
+        sourceOutputIndex: 0,
+        unlockingScriptTemplate: p2pkh.unlock(privateKey),
+        sequence: 0xffffffff
+      }], [{
+        satoshis: 1000,
+        lockingScript: p2pkh.lock(publicKeyHash)
+      }, {
+        lockingScript: p2pkh.lock(publicKeyHash),
+        change: true
+      }], 0)
+      expect(spendTx.outputs[1].satoshis).not.toBeDefined()
+      await spendTx.fee(1033)
+      // 4000 sats in - 1000 sats out - 1033 sats fee = expected 1967 sats change
+      expect(spendTx.outputs[1].satoshis).toEqual(1967)
+    })
     it('Distributes change among multiple change outputs', async () => {
       const privateKey = new PrivateKey(1)
       const publicKey = new Curve().g.mul(privateKey)
@@ -352,6 +378,41 @@ describe('Transaction', () => {
       expect(spendTx.outputs[1].satoshis).toEqual(983)
       expect(spendTx.outputs[2].satoshis).toEqual(983)
     })
+    it('Calculates fee for utxo based transaction', async () => {
+      const utxos = [ // WoC format utxos
+        {
+          height: 1600000,
+          tx_pos: 0,
+          tx_hash: '672dd6a93fa5d7ba6794e0bdf8b479440b95a55ec10ad3d9e03585ecb5628d8d',
+          value: 10000
+        },
+        {
+          height: 1600000,
+          tx_pos: 0,
+          tx_hash: 'f33505acf37a7726cc37d391bc6f889b8684ac2a2d581c4be2a4b1c8b46609bc',
+          value: 10000
+        },
+      ]
+      const priv = PrivateKey.fromRandom()
+      const tx = new Transaction()
+      utxos.forEach(utxo => {
+        const script = new P2PKH().lock(priv.toPublicKey().toHash())
+        tx.addInput({
+          sourceTXID: utxo.tx_hash,
+          sourceOutputIndex: utxo.tx_pos,
+          sourceSatoshis: utxo.value,
+          unlockingScriptTemplate: new P2PKH()
+            .unlock(priv, 'all', false, utxo.value, script)
+        })
+      })
+      tx.addOutput({
+        lockingScript: new P2PKH().lock(priv.toAddress()),
+        change: true
+      })
+      await tx.fee({ computeFee: async () => 10 })
+      expect(tx.outputs[0].satoshis).toEqual(20000 - 10)
+      expect(tx.getFee()).toEqual(10)
+    })
   })
 
   describe('Broadcast', () => {