@vbyte/btc-dev 1.1.2 → 1.1.4

package/src/lib/tx/util.ts

@@ -1,77 +1,54 @@
-import { Buff, Bytes }        from '@vbyte/buff'
+import { Buff }               from '@vbyte/buff'
 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'
+import { DEFAULT } from '@/const.js'
 
 import type {
   TxData,
   TxOutput,
-  TxOutputInfo,
   TxOutputTemplate,
-  TxOutputType,
-  TxValue,
-  WitnessVersion
+  TxValue
 } from '@/types/index.js'
 
-export function is_return_script (script : Bytes) : boolean {
-  const bytes = Buff.bytes(script)
-  return bytes.at(0) === 0x6a
-}
-
-export function get_vout_script_info (script : Bytes) : TxOutputInfo {
-  return {
-    type    : get_vout_script_type(script),
-    version : get_vout_script_version(script)
-  }
-}
-
-export function get_vout_script_type (
-  script : Bytes
-) : TxOutputType | null {
-  const hex = Buff.bytes(script).hex
-  for (const [ type, regex ] of Object.entries(LOCK_SCRIPT_REGEX)) {
-    if (regex.test(hex)) return type as TxOutputType
+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 null
+  // Return the txid of the transaction data.
+  return hash256(txdata).reverse().hex
 }
 
-export function get_vout_script_version (
-  script : Bytes
-) : WitnessVersion | null{
-  const version = Buff.bytes(script)
-  switch (version.at(0)) {
-    case 0x00 : return 0
-    case 0x51 : return 1
-    default   : return null
+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_txid (
-  txdata : TxData
-) : string {
-  assert_tx_template(txdata)
-  const data = encode_tx(txdata, false)
-  return hash256(data).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_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 }
 }
 

package/src/lib/witness/parse.ts

@@ -4,7 +4,8 @@ import { TAPLEAF_VERSIONS } from '@/const.js'
 
 import type {
   WitnessData,
-  WitnessType
+  SpendScriptType,
+  WitnessVersion
 } from '@/types/index.js'
 
 export function parse_witness (
@@ -64,13 +65,13 @@ function parse_cblock_data (
 
 function parse_witness_script (
   elems : Uint8Array[],
-  type  : WitnessType
+  type  : SpendScriptType | null
 ) {
   let script : Uint8Array | undefined
   switch (type) {
-    case 'p2tr-ts':
+    case 'p2ts':
       script = elems.at(-1)
-    case 'p2w-sh':
+    case 'p2wsh':
       script = elems.at(-1)
   }
   return (script !== undefined) ? new Buff(script).hex : null
@@ -79,14 +80,14 @@ function parse_witness_script (
 function parse_witness_type (
   elems  : Uint8Array[],
   cblock : string | null
-) : WitnessType {
+) : SpendScriptType | null{
   // Get the important elements of the witness.
   let param_0 = elems.at(0),
       param_1 = elems.at(1),
       param_x = elems.at(-1)
   // If the cblock is present and the last element exists:
   if (cblock !== null && param_x !== undefined) {
-    return 'p2tr-ts'
+    return 'p2ts'
   // If the witness elements match the profile of a p2w-pkh:
   } else if (
     elems.length === 2    &&
@@ -95,29 +96,32 @@ function parse_witness_type (
     param_0.length >=  64 &&
     param_1.length === 33
   ) {
-    return 'p2w-pkh'
+    return 'p2wpkh'
   // If the witness elements match the profile of a p2tr-pk:
   } else if (
     elems.length === 1    &&
     param_0 !== undefined &&
     param_0.length === 64
   ) {
-    return 'p2tr-pk'
+    return 'p2tr'
   // If there is at least two witness elements:
   } else if (
     elems.length > 1      && 
     param_x !== undefined &&
     is_valid_script(param_x)
   ) {
-    return 'p2w-sh'
+    return 'p2wsh'
   // If the witness elements don't match any known profile:
   } else {
-    return 'unknown'
+    return null
   }
 }
 
-function parse_witness_version (type : WitnessType) : number | null {
-  if (type.startsWith('p2tr')) return 1
-  if (type.startsWith('p2w'))  return 0
+function parse_witness_version (
+  type : SpendScriptType | null
+) : WitnessVersion | null {
+  if (type === null) return null
+  if (type.startsWith('p2w')) return 0
+  if (type.startsWith('p2t')) return 1
   return null
 }

package/src/types/address.ts

@@ -1,7 +1,8 @@
+import type { ScriptInfo } from './script.js'
+
 export type AddressFormat = 'base58' | 'bech32'  | 'bech32m'
-export type AddressType   = 'p2pkh'  | 'p2sh'    | 'p2w-pkh' | 'p2w-sh' | 'p2tr'
+export type AddressType   = 'p2pkh'  | 'p2sh'    | 'p2wpkh' | 'p2wsh' | 'p2tr'
 export type ChainNetwork  = 'main'   | 'testnet' | 'regtest' | string
-export type AddressData   = AddressContext & ScriptData
 
 export type AddressConfigEntry = [
   prefix  : string,
@@ -12,7 +13,7 @@ export type AddressConfigEntry = [
   version : number
 ]
 
-export interface DecodedAddress {
+export interface EncoderConfig {
   format   : AddressFormat
   data     : Uint8Array
   prefix?  : string
@@ -28,12 +29,7 @@ export interface AddressConfig {
   version : number
 }
 
-export interface AddressContext extends AddressConfig {
-  data : Uint8Array
-  hex  : string
-}
-
-export interface ScriptData {
-  script_asm : string[]
-  script_hex : string
+export interface AddressInfo extends AddressConfig {
+  data   : string
+  script : ScriptInfo
 }

package/src/types/index.ts

@@ -1,6 +1,7 @@
 export * from './address.js'
 export * from './meta.js'
 export * from './psbt.js'
+export * from './script.js'
 export * from './sighash.js'
 export * from './taproot.js'
 export * from './txdata.js'

package/src/types/meta.ts

@@ -1,19 +1,6 @@
-import type{ WitnessType, WitnessVersion } from './witness.js'
-
 export type LocktimeData   = LocktimeStamp | LocktimeHeight
 export type SequenceConfig = Partial<SequenceData>
 export type SequenceData   = SequenceHeightLock | SequenceStampLock
-export type TxOutputType   = 'p2pkh' | 'p2sh' | 'p2w-pkh' | 'p2w-sh' | 'p2tr' | 'opreturn'
-
-export interface TxOutputInfo {
-  type    : TxOutputType   | null
-  version : WitnessVersion | null
-}
-
-export interface TxInputInfo {
-  type    : WitnessType
-  version : WitnessVersion
-}  
 
 export interface LocktimeStamp {
   type  : 'timelock'  // Discriminator for timelock type
@@ -49,11 +36,6 @@ export interface SequenceField {
   value : number
 }
 
-export interface ScriptField {
-  asm : string[]
-  hex : string
-}
-
 export interface InscriptionData {
   content  ?: string
   delegate ?: string

package/src/types/script.ts

@@ -0,0 +1,18 @@
+export type LockScriptType  = 'p2pkh' | 'p2sh'   | 'p2wpkh' | 'p2wsh'  | 'p2tr' | 'opreturn'
+export type SpendScriptType = 'p2pkh' | 'p2sh'   | 'p2wpkh' | 'p2wsh'  | 'p2tr' | 'p2ts'
+export type WitnessVersion  = 0 | 1 | null
+
+export interface ScriptInfo {
+  asm : string[]
+  hex : string
+}
+
+export interface LockScriptInfo {
+  type    : LockScriptType | null
+  version : WitnessVersion | null
+}
+
+export interface SpendScriptInfo {
+  type    : SpendScriptType
+  version : WitnessVersion
+}

package/src/types/witness.ts

@@ -1,6 +1,6 @@
+import type { SpendScriptType, WitnessVersion } from './script.js'
+
 export type WitnessContext = WitnessData | TaprootScript | SegwitScript | TaprootSpend | SegwitSpend
-export type WitnessVersion = number | null
-export type WitnessType    = 'p2w-pkh' | 'p2w-sh' | 'p2tr-pk' | 'p2tr-ts' | 'unknown'
 
 export interface WitnessSize {
   total : number
@@ -13,30 +13,30 @@ export interface WitnessData {
   params  : string[]
   script  : string | null
   stack   : string[]
-  type    : WitnessType
-  version : WitnessVersion
+  type    : SpendScriptType | null
+  version : WitnessVersion  | null
 }
 
 export interface TaprootScript extends WitnessData {
   cblock  : string
   script  : string
-  type    : 'p2tr-ts'
+  type    : 'p2ts'
   version : 1
 }
 
 export interface SegwitScript extends WitnessData {
   script  : string
-  type    : 'p2w-sh'
+  type    : 'p2wsh'
   version : 0
 }
 
 export interface TaprootSpend extends WitnessData {
-  type    : 'p2tr-pk'
+  type    : 'p2tr'
   version : 1
 }
 
 export interface SegwitSpend extends WitnessData {
-  type    : 'p2w-pkh'
+  type    : 'p2wpkh'
   version : 0
 }