@vbyte/btc-dev 1.1.2 → 1.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vbyte/btc-dev",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "Batteries-included toolset for plebian bitcoin development",
   "type": "module",
   "keywords": [
@@ -79,7 +79,7 @@
     "test": "npm run script test/src/tape.ts"
   },
   "dependencies": {
-    "@noble/curves": "^1.9.2",
+    "@noble/curves": "^1.9.3",
     "@noble/hashes": "^1.8.0",
     "@scure/btc-signer": "^1.8.1",
     "@vbyte/buff": "^1.0.2",

package/src/lib/signer/sign.ts

@@ -17,7 +17,7 @@ export function sign_segwit_tx (
 ) {
   const tx   = parse_tx(txdata)
   const msg  = hash_segwit_tx(tx, options)
-  const sig  = ECC.get_ecdsa_sig(seckey, msg).hex
+  const sig  = ECC.sign_ecdsa(seckey, msg).hex
   const flag = format_sigflag(options.sigflag ?? SIGHASH_DEFAULT)
   return sig + flag
 }
@@ -29,7 +29,7 @@ export function sign_taproot_tx (
 ) {
   const tx   = parse_tx(txdata)
   const msg  = hash_taproot_tx(tx, options)
-  const sig  = ECC.get_bip340_sig(seckey, msg).hex
+  const sig  = ECC.sign_bip340(seckey, msg).hex
   const flag = format_sigflag(options.sigflag ?? 0)
   return sig + flag
 }

package/src/lib/tx/util.ts

@@ -3,6 +3,7 @@ import { Test }               from '@vbyte/micro-lib'
 import { Assert }             from '@vbyte/micro-lib/assert'
 import { hash256 }            from '@vbyte/micro-lib/hash'
 import { encode_tx }          from './encode.js'
+import { parse_tx }           from './parse.js'
 import { assert_tx_template } from './validate.js'
 
 import { DEFAULT, LOCK_SCRIPT_REGEX } from '@/const.js'
@@ -29,20 +30,22 @@ export function get_vout_script_info (script : Bytes) : TxOutputInfo {
   }
 }
 
-export function get_vout_script_type (
-  script : Bytes
-) : TxOutputType | null {
+export function get_vout_script_type (script : Bytes) : TxOutputType | null {
+  // Get the hex string of the script.
   const hex = Buff.bytes(script).hex
+  // Iterate over the lock script regexes.
   for (const [ type, regex ] of Object.entries(LOCK_SCRIPT_REGEX)) {
+    // If the script matches the regex, return the type.
     if (regex.test(hex)) return type as TxOutputType
   }
+  // If the script does not match any regex, return null.
   return null
 }
 
-export function get_vout_script_version (
-  script : Bytes
-) : WitnessVersion | null{
+export function get_vout_script_version (script : Bytes) : WitnessVersion | null {
+  // Get the version of the script.
   const version = Buff.bytes(script)
+  // Return the version of the script.
   switch (version.at(0)) {
     case 0x00 : return 0
     case 0x51 : return 1
@@ -50,28 +53,40 @@ export function get_vout_script_version (
   }
 }
 
-export function get_txid (
-  txdata : TxData
-) : string {
-  assert_tx_template(txdata)
-  const data = encode_tx(txdata, false)
-  return hash256(data).reverse().hex
+export function get_txid (txdata : string | Uint8Array | TxData) : string {
+  // If the transaction data is an object,
+  if (typeof txdata === 'object') {
+    // Assert the structure of the transaction data is valid.
+    assert_tx_template(txdata)
+    // Encode the transaction data.
+    txdata = encode_tx(txdata, false)
+  }
+  // Return the txid of the transaction data.
+  return hash256(txdata).reverse().hex
 }
 
-export function get_txhash (
-  txdata : TxData
-) : string {
-  assert_tx_template(txdata)
-  const data = encode_tx(txdata, true)
-  return hash256(data).reverse().hex
+export function get_txhash (txdata : string | Uint8Array | TxData) : string {
+  // If the transaction data is an object,
+  if (typeof txdata === 'object') {
+    // Assert the structure of the transaction data is valid.
+    assert_tx_template(txdata)
+    // Encode the transaction data.
+    txdata = encode_tx(txdata, true)
+  }
+  // Return the txhash of the transaction data.
+  return hash256(txdata).reverse().hex
 }
 
-export function get_tx_value (
-  txdata : TxData
-) : TxValue {
-  const vin  = txdata.vin.reduce((acc, txin) => acc + (txin.prevout?.value ?? 0n), 0n)
-  const vout = txdata.vout.reduce((acc, txout) => acc + txout.value, 0n)
+export function get_tx_value (txdata : string | Uint8Array | TxData) : TxValue {
+  // Parse the transaction data.
+  const tx = parse_tx(txdata)
+  // Assert the structure of the transaction data is valid.
+  assert_tx_template(tx)
+  // Calculate the value of the transaction.
+  const vin  = tx.vin.reduce((acc, txin) => acc + (txin.prevout?.value ?? 0n), 0n)
+  const vout = tx.vout.reduce((acc, txout) => acc + txout.value, 0n)
   const fees = (vin > vout) ? (vin - vout) : 0n
+  // Return the value of the transaction.
   return { fees, vin, vout }
 }