@vbyte/btc-dev 1.0.6 → 1.0.8

package/dist/types/class.d.ts

@@ -1,6 +1,6 @@
 import type { LocktimeData, SequenceData } from './meta.js';
 import type { TxOutput, TxOutputType, TxSize, TxValue } from './txdata.js';
-import type { WitnessType, WitnessVersion } from './witness.js';
+import type { WitnessData, WitnessVersion } from './witness.js';
 export interface LocktimeField {
     hex: string;
     data: LocktimeData | null;
@@ -27,17 +27,6 @@ export interface TransactionData {
     vin: TransactionInputData[];
     vout: TransactionOutputData[];
 }
-export interface WitnessField {
-    annex: string | null;
-    cblock: string | null;
-    params: string[];
-    script: ScriptField | null;
-    size: number;
-    stack: string[];
-    type: WitnessType;
-    version: WitnessVersion;
-    vsize: number;
-}
 export interface TransactionInputData {
     coinbase?: string | null;
     prevout?: TransactionOutputData | null;
@@ -46,7 +35,7 @@ export interface TransactionInputData {
     size: number;
     txid: string;
     vout: number;
-    witness?: WitnessField | null;
+    witness?: WitnessData | null;
 }
 export interface TransactionOutputData {
     script_pk: ScriptField;

package/dist/types/txdata.d.ts

@@ -55,7 +55,7 @@ export interface TxData {
 }
 export interface TxSize {
     base: number;
-    real: number;
+    total: number;
     weight: number;
     vsize: number;
 }

package/dist/types/witness.d.ts

@@ -1,34 +1,35 @@
-export type WitnessContext = WitnessInfo | TaprootScript | SegwitScript | TaprootSpend | SegwitSpend;
+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 {
-    size: number;
+    total: number;
     vsize: number;
 }
-export interface WitnessInfo {
+export interface WitnessData {
     annex: string | null;
     cblock: string | null;
     params: string[];
     script: string | null;
+    stack: string[];
     type: WitnessType;
     version: WitnessVersion;
 }
-export interface TaprootScript extends WitnessInfo {
+export interface TaprootScript extends WitnessData {
     cblock: string;
     script: string;
     type: 'p2tr-ts';
     version: 1;
 }
-export interface SegwitScript extends WitnessInfo {
+export interface SegwitScript extends WitnessData {
     script: string;
     type: 'p2w-sh';
     version: 0;
 }
-export interface TaprootSpend extends WitnessInfo {
+export interface TaprootSpend extends WitnessData {
     type: 'p2tr-pk';
     version: 1;
 }
-export interface SegwitSpend extends WitnessInfo {
+export interface SegwitSpend extends WitnessData {
     type: 'p2w-pkh';
     version: 0;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vbyte/btc-dev",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Batteries-included toolset for plebian bitcoin development",
   "type": "module",
   "keywords": [

package/src/class/tx.ts

@@ -1,3 +1,5 @@
+
+import { Assert }            from '@vbyte/micro-lib'
 import { LocktimeUtil }      from '@/lib/meta/index.js'
 import { TransactionInput }  from './txin.js'
 import { TransactionOutput } from './txout.js'
@@ -11,36 +13,41 @@ import {
   get_tx_value,
   get_txhash,
   encode_tx_locktime,
+  create_tx_input,
+  create_tx_output,
 } from '@/lib/tx/index.js'
 
 import type {
   TxData,
   TxTemplate,
+  TransactionData,
+  TxOutput,
   TxSize,
   TxValue,
-  TransactionData
+  TxInputTemplate
 } from '@/types/index.js'
 
 export class Transaction {
 
-  private readonly _size  : TxSize
-  private readonly _tx    : TxData
-  private readonly _hash  : string
-  private readonly _value : TxValue
-  private readonly _vin   : TransactionInput[]
-  private readonly _vout  : TransactionOutput[]
+  private readonly _tx : TxData
+
+  private _size  : TxSize & { segwit : number }
+  private _hash  : string
+  private _txid  : string
+  private _value : TxValue
+  private _vin   : TransactionInput[]
+  private _vout  : TransactionOutput[]
 
-  constructor (txdata : string | TxData | TxTemplate) {
+  constructor (txdata : string | TxData | TxTemplate = {}) {
     this._tx = (typeof txdata !== 'string')
       ? parse_tx(txdata)
       : decode_tx(txdata)
-
-    this._vin  = this._tx.vin.map(txin => new TransactionInput(txin))
-    this._vout = this._tx.vout.map(txout => new TransactionOutput(txout))
-
-    this._size  = get_txsize(this._tx)
+    this._size  = this._get_size()
     this._hash  = get_txhash(this._tx)
+    this._txid  = get_txid(this._tx)
     this._value = get_tx_value(this._tx)
+    this._vin   = this._tx.vin.map(txin => new TransactionInput(txin))
+    this._vout  = this._tx.vout.map(txout => new TransactionOutput(txout))
   }
 
   get data () : TransactionData {
@@ -75,13 +82,7 @@ export class Transaction {
   }
 
   get size () {
-    return {
-      ...this._size,
-      segwit  : this._vin.reduce((acc, txin)   => acc + (txin.witness?.vsize ?? 0), 0),
-      vin     : this._vin.reduce((acc, txin)   => acc + txin.size,  0),
-      vout    : this._vout.reduce((acc, txout) => acc + txout.size, 0),
-      witness : this._vin.reduce((acc, txin)   => acc + (txin.witness?.size ?? 0), 0)
-    }
+    return this._size
   }
 
   get spends () : TransactionOutput[] {
@@ -91,7 +92,7 @@ export class Transaction {
   }
 
   get txid () : string {
-    return get_txid(this._tx)
+    return this._txid
   }
 
   get value () {
@@ -110,9 +111,79 @@ export class Transaction {
     return this._vout
   }
 
-  toJSON   () { return this.data }
-  toString () { return JSON.stringify(this.data) }
-}
+  add_vin (tx_input : TxInputTemplate) {
+    const txin = create_tx_input(tx_input)
+    this._tx.vin.push(txin)
+    this._update_vin()
+  }
+
+  add_vout (tx_output : TxOutput) {
+    const txout = create_tx_output(tx_output)
+    this._tx.vout.push(txout)
+    this._update_vout()
+  }
 
+  insert_vin (index : number, tx_input : TxInputTemplate) {
+    Assert.ok(index >= 0 && index <= this._tx.vin.length, 'input goes out of bounds')
+    const txin = create_tx_input(tx_input)
+    if (index === this._tx.vin.length) {
+      this._tx.vin.push(txin)
+    } else {
+      this._tx.vin.splice(index, 0, txin)
+    }
+    this._update_vin()
+  }
 
+  insert_vout (index : number, tx_output : TxOutput) {
+    Assert.ok(index >= 0 && index <= this._tx.vout.length, 'output goes out of bounds')
+    const txout = create_tx_output(tx_output)
+    if (index === this._tx.vout.length) {
+      this._tx.vout.push(txout)
+    } else {
+      this._tx.vout.splice(index, 0, txout)
+    }
+    this._update_vout()
+  }
+
+  remove_vin (index : number) {
+    Assert.ok(this._tx.vin.at(index) !== undefined, 'input does not exist at index')
+    this._tx.vin.splice(index, 1)
+    this._update_vin()
+  }
 
+  remove_vout (index : number) {
+    Assert.ok(this._tx.vout.at(index) !== undefined, 'output does not exist at index')
+    this._tx.vout.splice(index, 1)
+    this._update_vout()
+  }
+
+  _get_size () {
+    return {
+      ...get_txsize(this._tx),
+      segwit  : this.vin.reduce((acc, txin)   => acc + (txin.witness?.size.vsize ?? 0), 0),
+      vin     : this.vin.reduce((acc, txin)   => acc + txin.size,  0),
+      vout    : this.vout.reduce((acc, txout) => acc + txout.size, 0),
+      witness : this.vin.reduce((acc, txin)   => acc + (txin.witness?.size.total ?? 0), 0)
+    }
+  }
+
+  _update_tx () {
+    this._size  = this._get_size()
+    this._hash  = get_txhash(this._tx)
+    this._txid  = get_txid(this._tx)
+    this._value = get_tx_value(this._tx)
+  }
+
+  _update_vin () {
+    this._vin = this._tx.vin.map(txin => new TransactionInput(txin))
+    this._update_tx()
+  }
+
+  _update_vout () {
+    this._vout = this._tx.vout.map(txout => new TransactionOutput(txout))
+    this._update_tx()
+  }
+
+  toJSON   () { return this.data }
+  toString () { return JSON.stringify(this.data) }
+}

package/src/class/txin.ts

@@ -15,16 +15,10 @@ import type {
 
 export class TransactionInput {
 
-  private readonly _size    : number
-  private readonly _txin    : TxInput
-  private readonly _witness : TransactionWitness | null
+  private readonly _txin : TxInput
 
   constructor (txin : TxInput) {
-    this._size    = get_txin_size(txin)
-    this._txin    = txin
-    this._witness = txin.witness.length > 0
-      ? new TransactionWitness(txin.witness)
-      : null
+    this._txin = txin
   }
 
   get coinbase () : string | null {
@@ -75,7 +69,7 @@ export class TransactionInput {
   }
 
   get size () {
-    return this._size
+    return get_txin_size(this._txin)
   }
 
   get txid () : string {
@@ -87,7 +81,9 @@ export class TransactionInput {
   }
 
   get witness () {
-    return this._witness
+    return this._txin.witness.length > 0
+      ? new TransactionWitness(this._txin.witness)
+      : null
   }
 
   toJSON   () { return this.data }

package/src/class/txout.ts

@@ -2,20 +2,17 @@ import { decode_script } from '@/lib/script/index.js'
 
 import {
   get_txout_size,
-  get_vout_info
+  get_vout_type,
+  get_vout_version
 } from '@/lib/tx/index.js'
 
-import type { TxOutput, TransactionOutputData, TxOutputInfo } from '@/types/index.js'
+import type { TxOutput, TransactionOutputData } from '@/types/index.js'
 
 export class TransactionOutput {
 
-  private readonly _info  : TxOutputInfo
-  private readonly _size  : number
   private readonly _txout : TxOutput
 
   constructor (txout : TxOutput) {
-    this._info  = get_vout_info(txout)
-    this._size  = get_txout_size(txout)
     this._txout = txout
   }
 
@@ -37,11 +34,11 @@ export class TransactionOutput {
   }
 
   get size () {
-    return this._size
+    return get_txout_size(this._txout)
   }
 
   get type () {
-    return this._info.type
+    return get_vout_type(this._txout.script_pk)
   }
 
   get value () : bigint {
@@ -49,7 +46,7 @@ export class TransactionOutput {
   }
 
   get version () {
-    return this._info.version
+    return get_vout_version(this._txout.script_pk)
   }
 
   toJSON   () { return this.data }

package/src/class/witness.ts

@@ -1,83 +1,95 @@
 import { Buff, Bytes }   from '@vbyte/buff'
+import { Assert }        from '@vbyte/micro-lib'
 import { decode_script } from '@/lib/script/index.js'
 
 import {
-  parse_witness_data,
+  parse_witness,
   get_witness_size,
 } from '@/lib/witness/index.js'
 
 import type {
   ScriptField,
-  WitnessField,
-  WitnessInfo,
+  WitnessData,
   WitnessSize,
   WitnessType
 } from '@/types/index.js'
 
 export class TransactionWitness {
 
-  private readonly _data  : Buff[]
-  private readonly _meta  : WitnessInfo
-  private readonly _size  : WitnessSize
+  private readonly _elems : Buff[]
+
+  private _data : WitnessData
+  private _size : WitnessSize
 
   constructor (witness : Bytes[]) {
-    this._data  = witness.map(e => Buff.bytes(e))
-    this._meta  = parse_witness_data(witness)
-    this._size  = get_witness_size(witness)
+    this._elems = witness.map(e => Buff.bytes(e))
+    this._data  = parse_witness(this._elems)
+    this._size  = get_witness_size(this._elems)
   }
 
   get annex () : string | null {
-    return this._meta.annex
+    return this._data.annex
   }
 
   get cblock () : string | null {
-    return this._meta.cblock
+    return this._data.cblock
   }
 
-  get data () : WitnessField {
-    return {
-      annex   : this.annex,
-      cblock  : this.cblock,
-      params  : this.params,
-      script  : this.script,
-      size    : this.size,
-      stack   : this.stack,
-      type    : this.type,
-      version : this.version,
-      vsize   : this.vsize
-    }
+  get data () : WitnessData {
+    return this._data
   }
 
   get params () : string[] {
-    return this._meta.params
+    return this._data.params
   }
 
   get script () : ScriptField | null {
-    if (this._meta.script === null) return null
+    if (this._data.script === null) return null
     return {
-      hex : this._meta.script,
-      asm : decode_script(this._meta.script)
+      hex : this._data.script,
+      asm : decode_script(this._data.script)
     }
   }
 
-  get size () : number {
-    return this._size.size
+  get size () : WitnessSize {
+    return this._size
   }
 
   get stack () : string[] {
-    return this._data.map(e => e.hex)
+    return this._elems.map(e => e.hex)
   }
 
   get type () : WitnessType {
-    return this._meta.type
+    return this._data.type
   }
 
   get version () : number | null {
-    return this._meta.version
+    return this._data.version
+  }
+
+  _update () {
+    this._data = parse_witness(this._elems)
+    this._size = get_witness_size(this._elems)
+  }
+
+  add (elem : Bytes) {
+    this._elems.push(Buff.bytes(elem))
+    this._update()
+  }
+
+  insert (index : number, elem : Bytes) {
+    Assert.ok(index >= 0 && index <= this._elems.length, 'index out of bounds')
+    if (index === this._elems.length) {
+      this._elems.push(Buff.bytes(elem))
+    } else {
+      this._elems.splice(index, 0, Buff.bytes(elem))
+    }
+    this._update()
   }
 
-  get vsize () : number {
-    return this._size.vsize
+  remove (index : number) {
+    this._elems.splice(index, 1)
+    this._update()
   }
 
   toJSON   () { return this.data }

package/src/lib/taproot/parse.ts

@@ -1,6 +1,6 @@
 import { Buff, Stream }       from '@vbyte/buff'
 import { Assert, ECC }        from '@vbyte/micro-lib'
-import { parse_witness_data } from '@/lib/witness/parse.js'
+import { parse_witness } from '@/lib/witness/parse.js'
 
 import {
   encode_tapbranch,
@@ -11,7 +11,7 @@ import {
 import type { ControlBlock } from '@/types/index.js'
 
 export function parse_taproot_witness (witness : string[]) {
-  const { cblock, params, script } = parse_witness_data(witness)
+  const { cblock, params, script } = parse_witness(witness)
 
   Assert.exists(cblock, 'cblock is null')
   Assert.exists(script, 'script is null')

package/src/lib/tx/size.ts

@@ -32,11 +32,11 @@ export function get_txsize (
 ) : TxSize {
   const json   = parse_tx(txdata)
   const base   = encode_tx(json, false).length
-  const size   = encode_tx(json, true).length
-  const weight = base * 3 + size
+  const total  = encode_tx(json, true).length
+  const weight = base * 3 + total
   const remain = (weight % 4 > 0) ? 1 : 0
   const vsize  = Math.floor(weight / 4) + remain
-  return { base, real: size, vsize, weight }
+  return { base, total, vsize, weight }
 }
 
 export function get_vin_size (vin : TxInput[]) : number {

package/src/lib/witness/parse.ts

@@ -3,15 +3,16 @@ import { is_valid_script }  from '@/lib/script/decode.js'
 import { TAPLEAF_VERSIONS } from '@/const.js'
 
 import type {
-  WitnessInfo,
+  WitnessData,
   WitnessType
 } from '@/types/index.js'
 
-export function parse_witness_data (
+export function parse_witness (
   witness : Bytes[]
-) : WitnessInfo {
+) : WitnessData {
   // Parse the witness data.
   const elems   = witness.map(e => Buff.bytes(e))
+  const stack   = witness.map(e => Buff.bytes(e).hex)
   const annex   = parse_annex_data(elems)
   if (annex !== null) elems.pop()
   const cblock  = parse_cblock_data(elems)
@@ -21,7 +22,7 @@ export function parse_witness_data (
   const script  = parse_witness_script(elems, type)
   if (script !== null) elems.pop()
   const params  = elems.map(e => e.hex)
-  return { annex, cblock, params, script, type, version }
+  return { annex, cblock, params, script, stack, type, version }
 }
 
 function parse_annex_data (

package/src/lib/witness/util.ts

@@ -8,5 +8,5 @@ export function get_witness_size (witness : Bytes[]) : WitnessSize {
   const stack = witness.map(e => Buff.bytes(e))
   const size  = stack.reduce((prev, next) => prev + next.length, 0)
   const vsize = Math.ceil(WIT_LENGTH_BYTE + size / 4) 
-  return { size, vsize }
+  return { total: size, vsize }
 }

package/src/types/class.ts

@@ -1,6 +1,6 @@
-import type { LocktimeData, SequenceData }              from './meta.js'
-import type { TxOutput, TxOutputType, TxSize, TxValue } from './txdata.js'
-import type { WitnessType, WitnessVersion }             from './witness.js'
+import type { LocktimeData, SequenceData }               from './meta.js'
+import type { TxOutput, TxOutputType, TxSize, TxValue }  from './txdata.js'
+import type { WitnessData, WitnessVersion }              from './witness.js'
 
 export interface LocktimeField {
   hex   : string
@@ -32,18 +32,6 @@ export interface TransactionData {
   vout     : TransactionOutputData[]
 }
 
-export interface WitnessField {
-  annex   : string | null
-  cblock  : string | null
-  params  : string[]
-  script  : ScriptField | null
-  size    : number
-  stack   : string[]
-  type    : WitnessType
-  version : WitnessVersion
-  vsize   : number
-}
-
 export interface TransactionInputData {
   coinbase?   : string                | null
   prevout?    : TransactionOutputData | null
@@ -52,7 +40,7 @@ export interface TransactionInputData {
   size        : number
   txid        : string
   vout        : number
-  witness?    : WitnessField | null
+  witness?    : WitnessData | null
 }
 
 export interface TransactionOutputData {

package/src/types/txdata.ts

@@ -67,7 +67,7 @@ export interface TxData {
 
 export interface TxSize {
   base   : number
-  real   : number
+  total  : number
   weight : number
   vsize  : number
 }

package/src/types/witness.ts

@@ -1,40 +1,41 @@
-export type WitnessContext = WitnessInfo | TaprootScript | SegwitScript | TaprootSpend | SegwitSpend
+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 {
-  size  : number
+  total : number
   vsize : number
 }
 
-export interface WitnessInfo {
+export interface WitnessData {
   annex   : string | null
   cblock  : string | null
   params  : string[]
   script  : string | null
+  stack   : string[]
   type    : WitnessType
   version : WitnessVersion
 }
 
-export interface TaprootScript extends WitnessInfo {
+export interface TaprootScript extends WitnessData {
   cblock  : string
   script  : string
   type    : 'p2tr-ts'
   version : 1
 }
 
-export interface SegwitScript extends WitnessInfo {
+export interface SegwitScript extends WitnessData {
   script  : string
   type    : 'p2w-sh'
   version : 0
 }
 
-export interface TaprootSpend extends WitnessInfo {
+export interface TaprootSpend extends WitnessData {
   type    : 'p2tr-pk'
   version : 1
 }
 
-export interface SegwitSpend extends WitnessInfo {
+export interface SegwitSpend extends WitnessData {
   type    : 'p2w-pkh'
   version : 0
 }