@vbyte/btc-dev 1.0.11 → 1.0.12

package/dist/types/txdata.d.ts

@@ -3,13 +3,20 @@ export interface TxOutpoint {
     txid: string;
     vout: number;
 }
-export interface TxInputTemplate extends TxOutpoint {
+export interface TxInputConfig extends TxOutpoint {
     coinbase?: string | null;
     prevout?: TxOutput | null;
     script_sig?: string | null;
     sequence?: number;
     witness?: string[];
 }
+export interface TxInputTemplate extends TxOutpoint {
+    coinbase: string | null;
+    prevout: TxOutput | null;
+    script_sig: string | null;
+    sequence: number;
+    witness: string[];
+}
 export interface TxCoinbaseInput extends TxOutpoint {
     coinbase: string;
     prevout: null;
@@ -27,15 +34,19 @@ export interface TxVirtualInput extends TxOutpoint {
 export interface TxSpendInput extends TxVirtualInput {
     prevout: TxOutput;
 }
+export interface TxOutputTemplate {
+    script_pk: string;
+    value: number | bigint;
+}
 export interface TxOutput {
     script_pk: string;
     value: bigint;
 }
 export interface TxTemplate {
-    locktime?: number;
-    vin?: TxInputTemplate[];
-    vout?: TxOutput[];
-    version?: number;
+    locktime: number;
+    vin: TxInputTemplate[];
+    vout: TxOutputTemplate[];
+    version: number;
 }
 export interface TxData {
     locktime: number;
@@ -43,6 +54,18 @@ export interface TxData {
     vout: TxOutput[];
     version: number;
 }
+export interface TxDecodedData {
+    locktime: number;
+    vin: (TxCoinbaseInput | TxVirtualInput)[];
+    vout: TxOutput[];
+    version: number;
+}
+export interface TxSpendData {
+    locktime: number;
+    vin: TxSpendInput[];
+    vout: TxOutput[];
+    version: number;
+}
 export interface TxSize {
     base: number;
     total: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vbyte/btc-dev",
-  "version": "1.0.11",
+  "version": "1.0.12",
   "description": "Batteries-included toolset for plebian bitcoin development",
   "type": "module",
   "keywords": [
@@ -87,7 +87,7 @@
     "@noble/hashes": "^1.8.0",
     "@scure/btc-signer": "^1.8.1",
     "@vbyte/buff": "^1.0.2",
-    "@vbyte/micro-lib": "^1.0.11",
+    "@vbyte/micro-lib": "^1.0.14",
     "zod": "^3.25.69"
   },
   "devDependencies": {

package/src/index.ts

@@ -1,5 +1,3 @@
-export * from './class/index.js'
-
 export * as ADDRESS from './lib/address/index.js'
 export * as META    from './lib/meta/index.js'
 export * as PSBT    from './lib/psbt/index.js'

package/src/lib/sighash/segwit.ts

@@ -73,14 +73,14 @@ export function hash_segwit_tx (
 
   const sighash = [
     encode_tx_version(version),
-    hash_prevouts(vin, is_anypay),
-    hash_sequence(vin, flag, is_anypay),
+    bip143_hash_prevouts(vin, is_anypay),
+    bip143_hash_sequence(vin, flag, is_anypay),
     encode_txin_txid(txid),
     encode_txin_vout(prevIdx),
     prefix_script_size(script),
     encode_vout_value(value),
     encode_txin_sequence(sequence),
-    hash_outputs(vout, flag, txindex),
+    bip143_hash_outputs(vout, flag, txindex),
     encode_tx_locktime(locktime),
     Buff.num(sigflag, 4).reverse()
   ]
@@ -88,7 +88,7 @@ export function hash_segwit_tx (
   return hash256(Buff.join(sighash))
 }
 
-function hash_prevouts (
+export function bip143_hash_prevouts (
   vin : TxInput[],
   isAnypay ?: boolean
 ) : Uint8Array {
@@ -106,7 +106,7 @@ function hash_prevouts (
   return hash256(Buff.join(stack))
 }
 
-function hash_sequence (
+export function bip143_hash_sequence (
   vin      : TxInput[],
   sigflag  : number,
   isAnyPay : boolean
@@ -123,7 +123,7 @@ function hash_sequence (
   return hash256(Buff.join(stack))
 }
 
-function hash_outputs (
+export function bip143_hash_outputs (
   vout    : TxOutput[],
   sigflag : number,
   idx    ?: number

package/src/lib/sighash/taproot.ts

@@ -1,11 +1,15 @@
 import { Buff }               from '@vbyte/buff'
 import { Assert }             from '@vbyte/micro-lib'
 import { hash340, sha256 }    from '@vbyte/micro-lib/hash'
-import { prefix_script_size } from '@/lib/script/util.js'
 import { encode_tapscript }   from '@/lib/taproot/encode.js'
 import { parse_tx }           from '@/lib/tx/parse.js'
 import * as CONST             from '@/const.js'
-import { parse_txinput }      from './util.js'
+
+import {
+  parse_txinput,
+  get_annex_data,
+  get_prevout
+} from './util.js'
 
 import {
   encode_txin_vout,
@@ -13,7 +17,8 @@ import {
   encode_txin_sequence,
   encode_txin_txid,
   encode_vout_value,
-  encode_tx_version
+  encode_tx_version,
+  encode_script_data
 } from '@/lib/tx/encode.js'
 
 import type {
@@ -26,6 +31,14 @@ import type {
 export function hash_taproot_tx (
   template : TxData | string,
   config   : SigHashOptions = {}
+) : Buff {
+  const preimage = get_taproot_tx_preimage(template, config)
+  return hash340('TapSighash', preimage)
+}
+
+export function get_taproot_tx_preimage (
+  template : TxData | string,
+  config   : SigHashOptions = {}
 ) : Buff {
   // Unpack configuration.
   const {
@@ -36,6 +49,7 @@ export function hash_taproot_tx (
     key_version   = 0x00,
     separator_pos = 0xFFFFFFFF
   } = config
+
   // Normalize the txdata object.
   const tx = parse_tx(template)
   // Unpack the txdata object.
@@ -66,11 +80,9 @@ export function hash_taproot_tx (
   const annexBit  = (annex !== undefined) ? 1 : 0
   const extendBit = (extension !== undefined) ? 1 : 0
   const spendType = ((extflag + extendBit) * 2) + annexBit
-  const hashtag   = hash340('TapSighash')
 
   // Begin building our preimage.
   const preimage : (string | Uint8Array)[] = [
-    hashtag,                      // Buffer input with TapSighash.
     Buff.num(0x00, 1),            // Add zero-byte.
     Buff.num(sigflag, 1),         // Commit to signature flag.
     encode_tx_version(version),   // Commit to tx version.
@@ -82,17 +94,17 @@ export function hash_taproot_tx (
     // then commit to all inputs.
     const prevouts = input.map(e => get_prevout(e))
     preimage.push(
-      hash_outpoints(input),   // Commit to txid/vout for each input.
-      hash_amounts(prevouts),  // Commit to prevout amount for each input.
-      hash_scripts(prevouts),  // Commit to prevout script for each input.
-      hash_sequence(input)     // Commit to sequence value for each input.
+      bip341_hash_outpoints(input),   // Commit to txid/vout for each input.
+      bip341_hash_amounts(prevouts),  // Commit to prevout amount for each input.
+      bip341_hash_scripts(prevouts),  // Commit to prevout script for each input.
+      bip341_hash_sequence(input)     // Commit to sequence value for each input.
     )
   }
 
   if ((sigflag & 0x03) < 2 || (sigflag & 0x03) > 3) {
     // If neither SINGLE or NONE flags are set,
     // include a commitment to all outputs.
-    preimage.push(hash_outputs(output))
+    preimage.push(bip341_hash_outputs(output))
   }
 
   // At this step, we include the spend type.
@@ -106,7 +118,7 @@ export function hash_taproot_tx (
       encode_txin_txid(txid),                // Commit to the input txid.
       encode_txin_vout(vout),                // Commit to the input vout index.
       encode_vout_value(value),              // Commit to the input's prevout value.
-      prefix_script_size(script_pk),         // Commit to the input's prevout script.
+      encode_script_data(script_pk),         // Commit to the input's prevout script.
       encode_txin_sequence(sequence)         // Commit to the input's sequence value.
     )
   } else {
@@ -127,7 +139,7 @@ export function hash_taproot_tx (
     // commitment to the output which is adjacent
     // to the input that we are signing for.
     Assert.ok(typeof txindex === 'number')
-    preimage.push(hash_output(output[txindex]))
+    preimage.push(bip341_hash_output(output[txindex]))
   }
 
   if (extension !== undefined) {
@@ -135,19 +147,16 @@ export function hash_taproot_tx (
     // other commitments (such as a tapleaf), then we
     // will add it to the preimage here.
     preimage.push(
-      Buff.bytes(extension),      // Extention data (in bytes).
-      Buff.num(key_version),      // Key version (reserved for future upgrades).
-      Buff.num(separator_pos, 4)  // If OP_CODESEPARATOR is used, this must be set.
+      Buff.bytes(extension),           // Extention data (in bytes).
+      Buff.num(key_version),           // Key version (reserved for future upgrades).
+      Buff.num(separator_pos, 4,'le')  // If OP_CODESEPARATOR is used, this must be set.
     )
   }
 
-  // Useful for debugging the preimage stack.
-  // console.log(preimage.map(e => Buff.raw(e).hex))
-
-  return sha256(Buff.join(preimage))
+  return Buff.join(preimage)
 }
 
-export function hash_outpoints (
+export function bip341_hash_outpoints (
   vin : TxInput[]
 ) : Buff {
   const stack = []
@@ -158,79 +167,40 @@ export function hash_outpoints (
   return sha256(Buff.join(stack))
 }
 
-export function hash_sequence (
+export function bip341_hash_sequence (
   vin : TxInput[]
 ) : Buff {
-  const stack = []
-  for (const { sequence } of vin) {
-    stack.push(encode_txin_sequence(sequence))
-  }
-  return sha256(Buff.join(stack))
+  return sha256(...vin.map(vin => encode_txin_sequence(vin.sequence)))
 }
 
-export function hash_amounts (
+export function bip341_hash_amounts (
   prevouts : TxOutput[]
 ) : Buff {
-  const stack = []
-  for (const { value } of prevouts) {
-    stack.push(encode_vout_value(value))
-  }
-  return sha256(Buff.join(stack))
+  return sha256(...prevouts.map(prevout => encode_vout_value(prevout.value)))
 }
 
-export function hash_scripts (
+export function bip341_hash_scripts (
   prevouts : TxOutput[]
 ) : Buff {
-  const stack = []
-  for (const { script_pk } of prevouts) {
-    stack.push(prefix_script_size(script_pk))
-  }
-  return sha256(Buff.join(stack))
+  return sha256(...prevouts.map(prevout => encode_script_data(prevout.script_pk)))
 }
 
-export function hash_outputs (
+export function bip341_hash_outputs (
   vout : TxOutput[]
 ) : Buff {
   const stack = []
   for (const { value, script_pk } of vout) {
     stack.push(encode_vout_value(value))
-    stack.push(prefix_script_size(script_pk))
+    stack.push(encode_script_data(script_pk))
   }
-  return sha256(Buff.join(stack))
+  return sha256(...stack)
 }
 
-export function hash_output (
+export function bip341_hash_output (
   vout : TxOutput
 ) : Buff {
   return sha256(
     encode_vout_value(vout.value),
-    prefix_script_size(vout.script_pk)
+    encode_script_data(vout.script_pk)
   )
 }
-
-function get_annex_data (
-  witness ?: string[]
-) : Buff | undefined {
-  // If no witness exists, return undefined.
-  if (witness === undefined) return
-  // If there are less than two elements, return undefined.
-  if (witness.length < 2) return
-  // Define the last element as the annex.
-  const annex = witness.at(-1)
-  // If the annex is a string and starts with '50',
-  if (typeof annex === 'string' && annex.startsWith('50')) {
-    // Convert the annex to a buffer with a varint prefix.
-    const bytes = Buff.hex(annex).prefix_varint('be')
-    // Return the sha256 of the annex.
-    return sha256(bytes)
-  }
-  // Else, return undefined.
-  return undefined
-}
-
-function get_prevout (vin : TxInput) : TxOutput {
-  if (vin.prevout === null) {
-    throw new Error('Prevout data missing for input: ' + String(vin.txid))
-  }
-  return vin.prevout
-}

package/src/lib/sighash/util.ts

@@ -1,12 +1,19 @@
 import { Buff }   from '@vbyte/buff'
 import { Assert } from '@vbyte/micro-lib'
+import { sha256 } from '@vbyte/micro-lib/hash'
 
 import type {
   SigHashOptions,
   TxInput,
   TxData,
+  TxOutput,
 } from '@/types/index.js'
 
+export function get_prevout (vin : TxInput) : TxOutput {
+  Assert.exists(vin.prevout, 'Prevout data missing for input: ' + String(vin.txid))
+  return vin.prevout
+}
+
 export function parse_txinput (
   txdata  : TxData,
   config ?: SigHashOptions
@@ -23,7 +30,22 @@ export function parse_txinput (
   return txinput
 }
 
-export function format_sigflag (flag : number) {
-  return (flag !== 0) ? Buff.num(flag, 1).hex : ''
+export function get_annex_data (
+  witness ?: string[]
+) : Buff | undefined {
+  // If no witness exists, return undefined.
+  if (witness === undefined) return
+  // If there are less than two elements, return undefined.
+  if (witness.length < 2) return
+  // Define the last element as the annex.
+  const annex = witness.at(-1)
+  // If the annex is a string and starts with '50',
+  if (typeof annex === 'string' && annex.startsWith('50')) {
+    // Convert the annex to a buffer with a varint prefix.
+    const bytes = Buff.hex(annex).prefix_varint('be')
+    // Return the sha256 of the annex.
+    return sha256(bytes)
+  }
+  // Else, return undefined.
+  return undefined
 }
-

package/src/lib/signer/sign.ts

@@ -1,9 +1,9 @@
+import { Buff }            from '@vbyte/buff'
 import { ECC }             from '@vbyte/micro-lib'
 import { parse_tx }        from '@/lib/tx/parse.js'
 import { SIGHASH_DEFAULT } from '@/const.js'
-import { hash_segwit_tx }  from '../sighash/segwit.js'
-import { hash_taproot_tx } from '../sighash/taproot.js'
-import { format_sigflag }  from '../sighash/util.js'
+import { hash_segwit_tx }  from '@/lib/sighash/segwit.js'
+import { hash_taproot_tx } from '@/lib/sighash/taproot.js'
 
 import type {
   SigHashOptions,
@@ -17,7 +17,7 @@ export function sign_segwit_tx (
 ) {
   const tx   = parse_tx(txdata)
   const msg  = hash_segwit_tx(tx, options)
-  const sig  = ECC.sign_ecdsa(seckey, msg).hex
+  const sig  = ECC.get_ecdsa_sig(seckey, msg).hex
   const flag = format_sigflag(options.sigflag ?? SIGHASH_DEFAULT)
   return sig + flag
 }
@@ -29,7 +29,11 @@ export function sign_taproot_tx (
 ) {
   const tx   = parse_tx(txdata)
   const msg  = hash_taproot_tx(tx, options)
-  const sig  = ECC.sign_bip340(seckey, msg).hex
+  const sig  = ECC.get_bip340_sig(seckey, msg).hex
   const flag = format_sigflag(options.sigflag ?? 0)
   return sig + flag
 }
+
+function format_sigflag (flag : number) {
+  return (flag !== 0) ? Buff.num(flag, 1).hex : ''
+}

package/src/lib/signer/verify.ts

@@ -1,12 +1,3 @@
-// import { Buff, Bytes, Stream }  from '@vbyte/buff'
-// import { safeThrow }     from '@/lib/utils.js'
-// import { checkPath }     from '@/lib/tap/key.js'
-// import { getTapLeaf }    from '@/lib/tap/tree.js'
-// import { Tx }            from '@/lib/tx/index.js'
-// import { Script }        from '@/lib/script/index.js'
-// import { HashConfig, TxData }    from '@/types/index.js'
-// import { TxTemplate }    from '@/schema/types.js'
-// import { hashTx }        from './segwit.js'
 import { Bytes } from '@vbyte/buff'
 
 import type {
@@ -14,7 +5,7 @@ import type {
   TxData
 } from '@/types/index.js'
 
-export function verify_segwit_tx (
+export function verify_tx (
   _txdata  : TxData | Bytes,
   _config  : SigHashOptions = {}
 ) : boolean {
@@ -22,14 +13,6 @@ export function verify_segwit_tx (
   return true
 }
 
-export function verify_taproot_tx (
-  _txdata  : TxData | Bytes,
-  _config  : SigHashOptions = {}
-) : boolean {
-  console.warn('verify_taproot_tx is not implemented')
-  return true
-}
-
 // export function verify_signature (
 //   txdata  : TxData | Bytes,
 //   index   : number,

package/src/lib/tx/create.ts

@@ -1,76 +1,84 @@
-import { Assert }              from '@vbyte/micro-lib'
-import { COINBASE, DEFAULT }   from '@/const.js'
+import { Assert }            from '@vbyte/micro-lib'
+import { COINBASE, DEFAULT } from '@/const.js'
+
+import {
+  normalize_prevout,
+  normalize_sequence,
+  normalize_value
+} from './util.js'
 
 import {
-  assert_tx_output,
   assert_tx_template,
-  assert_vin_template
+  assert_vin_template,
+  assert_vout_template
 } from './validate.js'
 
 import type {
   TxData,
-  TxInputTemplate,
   TxInput,
   TxOutput,
   TxTemplate,
   TxSpendInput,
-  TxCoinbaseInput
+  TxCoinbaseInput,
+  TxOutputTemplate,
+  TxVirtualInput,
+  TxInputConfig
 } from '@/types/index.js'
 
 export function create_coinbase_input (
-  config : TxInputTemplate | TxInput
+  config : TxInputConfig
 ) : TxCoinbaseInput {
   assert_vin_template(config)
   Assert.exists(config.coinbase, 'coinbase is required')
-  const coinbase   = config.coinbase
-  const prevout    = null
-  const script_sig = null
-  const sequence   = config.sequence ?? DEFAULT.SEQUENCE
   const txid       = COINBASE.TXID
   const vout       = COINBASE.VOUT
+  const coinbase   = config.coinbase
   const witness    = config.witness  ?? []
-  return { coinbase, prevout, script_sig, sequence, witness, txid, vout }
+  const sequence   = normalize_sequence(config.sequence)
+  return { coinbase, prevout: null, script_sig: null, sequence, witness, txid, vout }
+}
+
+export function create_virtual_input (
+  config : TxInputConfig
+) : TxVirtualInput {
+  assert_vin_template(config)
+  Assert.is_empty(config.coinbase, 'coinbase is not allowed')
+  Assert.is_empty(config.prevout,  'prevout is not allowed')
+  const { txid, vout, script_sig = null, witness = [] } = config
+  const sequence = normalize_sequence(config.sequence)
+  return { txid, vout, coinbase: null, prevout: null, script_sig, sequence, witness }
 }
 
 export function create_spend_input (
-  config : TxInputTemplate | TxInput
+  config : TxInputConfig
 ) : TxSpendInput {
   assert_vin_template(config)
   Assert.exists(config.prevout, 'prevout is required')
-  const prevout    = config.prevout
-  const coinbase   = null
-  const script_sig = config.script_sig ?? null
-  const sequence   = config.sequence   ?? DEFAULT.SEQUENCE
-  const witness    = config.witness    ?? []
-  return { ...config, coinbase, prevout, script_sig, sequence, witness }
+  const { txid, vout, script_sig = null, witness = [] } = config
+  const prevout    = normalize_prevout(config.prevout)
+  const sequence   = normalize_sequence(config.sequence)
+  return { txid, vout, coinbase: null, prevout, script_sig, sequence, witness }
 }
 
 export function create_tx_input (
-  config : TxInputTemplate | TxInput
+  config : TxInputConfig
 ) : TxInput {
-  assert_vin_template(config)
-  Assert.exists(config.txid, 'txid is required')
-  Assert.exists(config.vout, 'vout is required')
-  const coinbase   = config.coinbase   ?? null
-  const prevout    = config.prevout    ?? null
-  const script_sig = config.script_sig ?? null
-  const sequence   = config.sequence   ?? DEFAULT.SEQUENCE
-  const witness    = config.witness    ?? []
-  if (coinbase !== null) return create_coinbase_input(config)
-  if (prevout  !== null) return create_spend_input(config)
-  return { ...config, coinbase, prevout, script_sig, sequence, witness }
+  if (config.coinbase) return create_coinbase_input(config)
+  if (config.prevout)  return create_spend_input(config)
+  return create_virtual_input(config)
 }
 
 export function create_tx_output (
-  config : TxOutput
+  config : TxOutputTemplate
 ) : TxOutput {
-  assert_tx_output(config)
-  const { script_pk, value } = config
-  return { script_pk, value : BigInt(value) }
+  assert_vout_template(config)
+  const script_pk = config.script_pk
+  const value     = normalize_value(config.value)
+  return { script_pk, value }
 }
 
 export function create_tx (
-  config: TxTemplate | TxData
+  config: Partial<TxTemplate> = {}
 ) : TxData {
   assert_tx_template(config)
   const { vin = [], vout = [] } = config