@vbyte/btc-dev 1.0.8 → 1.0.10

package/dist/types/index.d.ts

@@ -1,5 +1,4 @@
 export * from './address.js';
-export * from './class.js';
 export * from './meta.js';
 export * from './psbt.js';
 export * from './sighash.js';

package/dist/types/index.js

@@ -1,5 +1,4 @@
 export * from './address.js';
-export * from './class.js';
 export * from './meta.js';
 export * from './psbt.js';
 export * from './sighash.js';

package/dist/types/meta.d.ts

@@ -1,6 +1,16 @@
+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 = WitnessType | 'p2pkh' | 'p2sh' | 'opreturn';
+export interface TxOutputInfo {
+    type: TxOutputType;
+    version: WitnessVersion;
+}
+export interface TxInputInfo {
+    type: WitnessType;
+    version: WitnessVersion;
+}
 export interface LocktimeStamp {
     type: 'timelock';
     stamp: number;
@@ -17,6 +27,20 @@ export interface SequenceHeightLock {
     height: number;
     mode: 'height';
 }
+export interface LocktimeField {
+    hex: string;
+    data: LocktimeData | null;
+    value: number;
+}
+export interface SequenceField {
+    hex: string;
+    data: SequenceData | null;
+    value: number;
+}
+export interface ScriptField {
+    asm: string[];
+    hex: string;
+}
 export interface InscriptionData {
     content?: string;
     delegate?: string;

package/dist/types/txdata.d.ts

@@ -1,14 +1,4 @@
-import type { WitnessType, WitnessVersion } from './witness.js';
 export type TxInput = TxCoinbaseInput | TxSpendInput | TxVirtualInput;
-export type TxOutputType = WitnessType | 'p2pkh' | 'p2sh' | 'opreturn';
-export interface TxOutputInfo {
-    type: TxOutputType;
-    version: WitnessVersion;
-}
-export interface TxInputInfo {
-    type: WitnessType;
-    version: WitnessVersion;
-}
 export interface TxOutpoint {
     txid: string;
     vout: number;
@@ -56,8 +46,8 @@ export interface TxData {
 export interface TxSize {
     base: number;
     total: number;
-    weight: number;
     vsize: number;
+    weight: number;
 }
 export interface TxValue {
     fees: bigint;

package/package.json

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

package/src/class/signer.ts

@@ -1,5 +1,5 @@
 import { Buff, Bytes } from '@vbyte/buff'
-import { ECC }         from '@vbyte/micro-lib'
+import { Assert, ECC } from '@vbyte/micro-lib'
 
 import {
   sign_segwit_tx,
@@ -15,6 +15,8 @@ export class TxSigner {
   private readonly _seckey : string
 
   constructor (seckey : Bytes) {
+    Assert.ok(Buff.is_bytes(seckey), 'seckey must be a string or bytes')
+    Assert.size(seckey, 32,          'seckey must be 32 bytes')
     this._seckey = Buff.bytes(seckey).hex
   }
 

package/src/class/tx.ts

@@ -5,7 +5,6 @@ import { TransactionInput }  from './txin.js'
 import { TransactionOutput } from './txout.js'
 
 import {
-  decode_tx,
   get_txid,
   is_return_script,
   parse_tx,
@@ -20,7 +19,6 @@ import {
 import type {
   TxData,
   TxTemplate,
-  TransactionData,
   TxOutput,
   TxSize,
   TxValue,
@@ -39,30 +37,18 @@ export class Transaction {
   private _vout  : TransactionOutput[]
 
   constructor (txdata : string | TxData | TxTemplate = {}) {
-    this._tx = (typeof txdata !== 'string')
-      ? parse_tx(txdata)
-      : decode_tx(txdata)
+    this._tx    = parse_tx(txdata)
+    this._vin   = this._tx.vin.map(txin => new TransactionInput(txin))
+    this._vout  = this._tx.vout.map(txout => new TransactionOutput(txout))
+
     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 {
-    return {
-      hash     : this.hash,
-      locktime : this.locktime,
-      return   : this.return,
-      size     : this.size,
-      spends   : this.spends,
-      txid     : this.txid,
-      value    : this.value,
-      version  : this.version,
-      vin      : this.vin.map(txin => txin.data),
-      vout     : this.vout.map(txout => txout.data)
-    }
+  get data () : TxData {
+    return this._tx
   }
 
   get hash () : string {

package/src/class/txin.ts

@@ -4,20 +4,19 @@ import { TransactionOutput }  from './txout.js'
 import { TransactionWitness } from './witness.js'
 
 import {
+  assert_tx_input,
   encode_txin_sequence,
   get_txin_size,
 } from '@/lib/tx/index.js'
 
-import type {
-  TxInput,
-  TransactionInputData
-} from '@/types/index.js'
+import type { TxInput } from '@/types/index.js'
 
 export class TransactionInput {
 
   private readonly _txin : TxInput
 
   constructor (txin : TxInput) {
+    assert_tx_input(txin)
     this._txin = txin
   }
 
@@ -25,17 +24,8 @@ export class TransactionInput {
     return this._txin.coinbase
   }
 
-  get data () : TransactionInputData {
-    return {
-      coinbase    : this.coinbase,
-      prevout     : this.prevout?.data ?? null,
-      script_sig  : this.script_sig,
-      sequence    : this.sequence,
-      size        : this.size,
-      txid        : this.txid,
-      vout        : this.vout,
-      witness     : this.witness?.data ?? null
-    }
+  get data () : TxInput {
+    return this._txin
   }
 
   get has_prevout () : boolean {

package/src/class/txout.ts

@@ -1,29 +1,25 @@
 import { decode_script } from '@/lib/script/index.js'
 
 import {
+  assert_tx_output,
   get_txout_size,
   get_vout_type,
   get_vout_version
 } from '@/lib/tx/index.js'
 
-import type { TxOutput, TransactionOutputData } from '@/types/index.js'
+import type { TxOutput } from '@/types/index.js'
 
 export class TransactionOutput {
 
   private readonly _txout : TxOutput
 
   constructor (txout : TxOutput) {
+    assert_tx_output(txout)
     this._txout = txout
   }
 
-  get data () : TransactionOutputData {
-    return {
-      script_pk : this.script_pk,
-      size      : this.size,
-      type      : this.type,
-      value     : this.value,
-      version   : this.version
-    }
+  get data () : TxOutput {
+    return this._txout
   }
 
   get script_pk () {

package/src/class/witness.ts

@@ -5,6 +5,7 @@ import { decode_script } from '@/lib/script/index.js'
 import {
   parse_witness,
   get_witness_size,
+  assert_witness,
 } from '@/lib/witness/index.js'
 
 import type {
@@ -22,6 +23,7 @@ export class TransactionWitness {
   private _size : WitnessSize
 
   constructor (witness : Bytes[]) {
+    assert_witness(witness)
     this._elems = witness.map(e => Buff.bytes(e))
     this._data  = parse_witness(this._elems)
     this._size  = get_witness_size(this._elems)

package/src/lib/tx/decode.ts

@@ -29,7 +29,7 @@ export function decode_tx (
   // Merge the options with the default config.
   const config = { ...DEFAULT_CONFIG, ...options }
   // Assert the txhex is a bytes object.
-  Assert.is_bytes(txbytes, 'txbytes must be hex or a unit array')
+  Assert.is_bytes(txbytes, 'transaction must be hex or a byte-array')
   // Setup a byte-stream.
   const stream = new Stream(txbytes)
   // Parse tx version.

package/src/lib/tx/size.ts

@@ -24,7 +24,7 @@ export function get_vsize (
 ) : number {
   const weight = Buff.bytes(bytes).length
   const remain = (weight % 4 > 0) ? 1 : 0
-  return Math.floor(weight / 4) + remain
+  return Math.ceil(weight / 4) + remain
 }
 
 export function get_txsize (
@@ -35,7 +35,7 @@ export function get_txsize (
   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
+  const vsize  = Math.ceil(weight / 4) + remain
   return { base, total, vsize, weight }
 }
 

package/src/lib/witness/util.ts

@@ -1,4 +1,5 @@
 import { Buff, Bytes } from '@vbyte/buff'
+import { Assert }      from '@vbyte/micro-lib'
 
 import type { WitnessSize } from '@/types/index.js'
 
@@ -10,3 +11,8 @@ export function get_witness_size (witness : Bytes[]) : WitnessSize {
   const vsize = Math.ceil(WIT_LENGTH_BYTE + size / 4) 
   return { total: size, vsize }
 }
+
+export function assert_witness (witness : unknown) : asserts witness is Bytes[] {
+  Assert.ok(Array.isArray(witness), 'witness must be an array')
+  Assert.ok(witness.every(e => Buff.is_bytes(e)), 'witness must be an array of strings or bytes')
+}

package/src/types/index.ts

@@ -1,5 +1,4 @@
 export * from './address.js'
-export * from './class.js'
 export * from './meta.js'
 export * from './psbt.js'
 export * from './sighash.js'

package/src/types/meta.ts

@@ -1,6 +1,19 @@
+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   = WitnessType | 'p2pkh' | 'p2sh' | 'opreturn'
+
+export interface TxOutputInfo {
+  type    : TxOutputType
+  version : WitnessVersion
+}
+
+export interface TxInputInfo {
+  type    : WitnessType
+  version : WitnessVersion
+}  
 
 export interface LocktimeStamp {
   type  : 'timelock'  // Discriminator for timelock type
@@ -24,6 +37,23 @@ export interface SequenceHeightLock {
   mode   : 'height'   // Discriminator for heightlock mode.
 }
 
+export interface LocktimeField {
+  hex   : string
+  data  : LocktimeData | null
+  value : number
+}
+
+export interface SequenceField {
+  hex   : string
+  data  : SequenceData | null
+  value : number
+}
+
+export interface ScriptField {
+  asm : string[]
+  hex : string
+}
+
 export interface InscriptionData {
   content  ?: string
   delegate ?: string

package/src/types/txdata.ts

@@ -1,17 +1,4 @@
-import type { WitnessType, WitnessVersion } from './witness.js'
-
-export type TxInput      = TxCoinbaseInput | TxSpendInput | TxVirtualInput
-export type TxOutputType = WitnessType | 'p2pkh' | 'p2sh' | 'opreturn'
-
-export interface TxOutputInfo {
-  type    : TxOutputType
-  version : WitnessVersion
-}
-
-export interface TxInputInfo {
-  type    : WitnessType
-  version : WitnessVersion
-}  
+export type TxInput = TxCoinbaseInput | TxSpendInput | TxVirtualInput
 
 export interface TxOutpoint {
   txid : string
@@ -68,8 +55,8 @@ export interface TxData {
 export interface TxSize {
   base   : number
   total  : number
-  weight : number
   vsize  : number
+  weight : number
 }
 
 export interface TxValue {

package/dist/types/class.d.ts

@@ -1,46 +0,0 @@
-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;
-    data: LocktimeData | null;
-    value: number;
-}
-export interface SequenceField {
-    hex: string;
-    data: SequenceData | null;
-    value: number;
-}
-export interface ScriptField {
-    asm: string[];
-    hex: string;
-}
-export interface TransactionData {
-    hash: string;
-    locktime: LocktimeField;
-    return: TxOutput | null;
-    size: TxSize;
-    spends: TransactionOutputData[];
-    txid: string;
-    value: TxValue;
-    version: number;
-    vin: TransactionInputData[];
-    vout: TransactionOutputData[];
-}
-export interface TransactionInputData {
-    coinbase?: string | null;
-    prevout?: TransactionOutputData | null;
-    script_sig?: ScriptField | null;
-    sequence: SequenceField;
-    size: number;
-    txid: string;
-    vout: number;
-    witness?: WitnessData | null;
-}
-export interface TransactionOutputData {
-    script_pk: ScriptField;
-    size: number;
-    type: TxOutputType;
-    value: bigint;
-    version: WitnessVersion | null;
-}

package/dist/types/class.js

@@ -1 +0,0 @@
-export {};

package/src/types/class.ts

@@ -1,52 +0,0 @@
-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
-  data  : LocktimeData | null
-  value : number
-}
-
-export interface SequenceField {
-  hex   : string
-  data  : SequenceData | null
-  value : number
-}
-
-export interface ScriptField {
-  asm : string[]
-  hex : string
-}
-
-export interface TransactionData {
-  hash     : string
-  locktime : LocktimeField
-  return   : TxOutput | null
-  size     : TxSize
-  spends   : TransactionOutputData[]
-  txid     : string
-  value    : TxValue
-  version  : number
-  vin      : TransactionInputData[]
-  vout     : TransactionOutputData[]
-}
-
-export interface TransactionInputData {
-  coinbase?   : string                | null
-  prevout?    : TransactionOutputData | null
-  script_sig? : ScriptField           | null
-  sequence    : SequenceField
-  size        : number
-  txid        : string
-  vout        : number
-  witness?    : WitnessData | null
-}
-
-export interface TransactionOutputData {
-  script_pk : ScriptField
-  size      : number
-  type      : TxOutputType
-  value     : bigint
-  version   : WitnessVersion | null
-}