@vbyte/btc-dev 1.0.2 → 1.0.4

package/dist/types/{transaction.d.ts → class.d.ts}

@@ -1,55 +1,31 @@
-import { LocktimeInfo, SequenceInfo } from './meta.js';
-import { TxOutput } from './txdata.js';
+import type { LocktimeData, SequenceData } from './meta.js';
+import type { TxOutput, TxOutputType, TxSize, TxValue } from './txdata.js';
 import type { WitnessType, WitnessVersion } from './witness.js';
-export type TxOutputType = WitnessType | 'p2pkh' | 'p2sh' | 'opreturn';
-export interface TxOutputInfo {
-    type: TxOutputType;
-    version: WitnessVersion;
-}
-export interface TxInputInfo {
-    type: WitnessType;
-    version: WitnessVersion;
-}
 export interface LocktimeField {
     hex: string;
-    data: LocktimeInfo | null;
+    data: LocktimeData | null;
     value: number;
 }
 export interface SequenceField {
     hex: string;
-    data: SequenceInfo | null;
+    data: SequenceData | null;
     value: number;
 }
 export interface ScriptField {
     asm: string[];
     hex: string;
 }
-export interface TxSize {
-    base: number;
-    real: number;
-    weight: number;
-    vsize: number;
-}
-export interface TxValue {
-    fees: bigint;
-    vin: bigint;
-    vout: bigint;
-}
-export interface WitnessSize {
-    size: number;
-    vsize: number;
-}
 export interface TransactionData {
     hash: string;
     locktime: LocktimeField;
     return: TxOutput | null;
     size: TxSize;
-    spends: TxOutputField[];
+    spends: TransactionOutputData[];
     txid: string;
     value: TxValue;
     version: number;
-    vin: TxInputField[];
-    vout: TxOutputField[];
+    vin: TransactionInputData[];
+    vout: TransactionOutputData[];
 }
 export interface WitnessField {
     annex: string | null;
@@ -62,9 +38,9 @@ export interface WitnessField {
     version: WitnessVersion;
     vsize: number;
 }
-export interface TxInputField {
+export interface TransactionInputData {
     coinbase?: string | null;
-    prevout?: TxOutputField | null;
+    prevout?: TransactionOutputData | null;
     script_sig?: ScriptField | null;
     sequence: SequenceField;
     size: number;
@@ -72,7 +48,7 @@ export interface TxInputField {
     vout: number;
     witness?: WitnessField | null;
 }
-export interface TxOutputField {
+export interface TransactionOutputData {
     script_pk: ScriptField;
     size: number;
     type: TxOutputType;

package/dist/types/index.d.ts

@@ -1,8 +1,8 @@
 export * from './address.js';
+export * from './class.js';
 export * from './meta.js';
 export * from './psbt.js';
 export * from './sighash.js';
 export * from './taproot.js';
-export * from './transaction.js';
 export * from './txdata.js';
 export * from './witness.js';

package/dist/types/index.js

@@ -1,8 +1,8 @@
 export * from './address.js';
+export * from './class.js';
 export * from './meta.js';
 export * from './psbt.js';
 export * from './sighash.js';
 export * from './taproot.js';
-export * from './transaction.js';
 export * from './txdata.js';
 export * from './witness.js';

package/dist/types/meta.d.ts

@@ -1,6 +1,6 @@
-export type LocktimeInfo = LocktimeStamp | LocktimeHeight;
-export type SequenceConfig = Partial<SequenceInfo>;
-export type SequenceInfo = SequenceHeightLock | SequenceStampLock;
+export type LocktimeData = LocktimeStamp | LocktimeHeight;
+export type SequenceConfig = Partial<SequenceData>;
+export type SequenceData = SequenceHeightLock | SequenceStampLock;
 export interface LocktimeStamp {
     type: 'timelock';
     stamp: number;

package/dist/types/txdata.d.ts

@@ -1,4 +1,14 @@
+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;
@@ -43,3 +53,14 @@ export interface TxData {
     vout: TxOutput[];
     version: number;
 }
+export interface TxSize {
+    base: number;
+    real: number;
+    weight: number;
+    vsize: number;
+}
+export interface TxValue {
+    fees: bigint;
+    vin: bigint;
+    vout: bigint;
+}

package/dist/types/witness.d.ts

@@ -1,7 +1,11 @@
-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 WitnessInfo {
+export interface WitnessSize {
+    size: number;
+    vsize: number;
+}
+export interface WitnessData {
     annex: string | null;
     cblock: string | null;
     params: string[];
@@ -9,22 +13,22 @@ export interface WitnessInfo {
     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.2",
+  "version": "1.0.4",
   "description": "Batteries-included toolset for plebian bitcoin development",
   "type": "module",
   "keywords": [
@@ -42,8 +42,8 @@
       "import": "./dist/lib/address/index.js"
     },
     "./meta": {
-      "types": "./dist/lib/meta.d.ts",
-      "import": "./dist/lib/meta.js"
+      "types": "./dist/lib/meta/index.d.ts",
+      "import": "./dist/lib/meta/index.js"
     },
     "./psbt": {
       "types": "./dist/lib/psbt/index.d.ts",

package/src/class/txin.ts

@@ -10,7 +10,7 @@ import {
 
 import type {
   TxInput,
-  TxInputField
+  TransactionInputData
 } from '@/types/index.js'
 
 export class TransactionInput {
@@ -31,7 +31,7 @@ export class TransactionInput {
     return this._txin.coinbase
   }
 
-  get data () : TxInputField {
+  get data () : TransactionInputData {
     return {
       coinbase    : this.coinbase,
       prevout     : this.prevout?.data ?? null,

package/src/class/txout.ts

@@ -5,7 +5,7 @@ import {
   get_vout_info
 } from '@/lib/tx/index.js'
 
-import type { TxOutput, TxOutputField, TxOutputInfo } from '@/types/index.js'
+import type { TxOutput, TransactionOutputData, TxOutputInfo } from '@/types/index.js'
 
 export class TransactionOutput {
 
@@ -19,7 +19,7 @@ export class TransactionOutput {
     this._txout = txout
   }
 
-  get data () : TxOutputField {
+  get data () : TransactionOutputData {
     return {
       script_pk : this.script_pk,
       size      : this.size,

package/src/class/witness.ts

@@ -9,7 +9,7 @@ import {
 import type {
   ScriptField,
   WitnessField,
-  WitnessInfo,
+  WitnessData,
   WitnessSize,
   WitnessType
 } from '@/types/index.js'
@@ -17,7 +17,7 @@ import type {
 export class TransactionWitness {
 
   private readonly _data  : Buff[]
-  private readonly _meta  : WitnessInfo
+  private readonly _meta  : WitnessData
   private readonly _size  : WitnessSize
 
   constructor (witness : Bytes[]) {

package/src/lib/meta/locktime.ts

@@ -1,6 +1,6 @@
 import { Assert } from '@vbyte/micro-lib'
 
-import type { LocktimeInfo } from '@/types/index.js'
+import type { LocktimeData } from '@/types/index.js'
 
 // The threshold between block height and timestamp.
 const LOCKTIME_THRESHOLD = 500000000
@@ -15,7 +15,7 @@ export namespace LocktimeUtil {
  * According to BIP-65, the value is simply the numeric value as a string.
  */
 export function encode_locktime (
-  locktime : LocktimeInfo
+  locktime : LocktimeData
 ) : number {
   switch (locktime.type) {
     case 'timelock':
@@ -37,7 +37,7 @@ export function encode_locktime (
  */
 export function decode_locktime (
   locktime : number
-) : LocktimeInfo | null {
+) : LocktimeData | null {
   // Check if the value is valid (non-negative)
   if (isNaN(locktime) || locktime <= 0) {
     return null

package/src/lib/meta/sequence.ts

@@ -11,7 +11,7 @@
  * that allows additional metadata to be encoded in the sequence field (to be used by on-chain indexers).
  */
 
-import type { SequenceConfig, SequenceInfo } from '@/types/index.js'
+import type { SequenceConfig, SequenceData } from '@/types/index.js'
 
 /* ===== [ Constants ] ===================================================== */
 
@@ -65,7 +65,7 @@ export function encode_sequence (data : SequenceConfig): number {
  * @returns A SequenceData object or null if the sequence doesn't represent special data
  * @throws Error if the sequence value is invalid or exceeds maximum values
  */
-export function decode_sequence (sequence: number | string) : SequenceInfo | null {
+export function decode_sequence (sequence: number | string) : SequenceData | null {
   // Parse and validate the sequence value.
   const seq = parse_sequence(sequence)
   // If the sequence is disabled, return null.

package/src/lib/witness/parse.ts

@@ -3,13 +3,13 @@ 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 (
   witness : Bytes[]
-) : WitnessInfo {
+) : WitnessData {
   // Parse the witness data.
   const elems   = witness.map(e => Buff.bytes(e))
   const annex   = parse_annex_data(elems)

package/src/types/class.ts

@@ -0,0 +1,64 @@
+import type { LocktimeData, SequenceData }              from './meta.js'
+import type { TxOutput, TxOutputType, TxSize, TxValue } from './txdata.js'
+import type { WitnessType, 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 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
+  script_sig? : ScriptField           | null
+  sequence    : SequenceField
+  size        : number
+  txid        : string
+  vout        : number
+  witness?    : WitnessField | null
+}
+
+export interface TransactionOutputData {
+  script_pk : ScriptField
+  size      : number
+  type      : TxOutputType
+  value     : bigint
+  version   : WitnessVersion | null
+}

package/src/types/index.ts

@@ -1,8 +1,8 @@
 export * from './address.js'
+export * from './class.js'
 export * from './meta.js'
 export * from './psbt.js'
 export * from './sighash.js'
 export * from './taproot.js'
-export * from './transaction.js'
 export * from './txdata.js'
 export * from './witness.js'

package/src/types/meta.ts

@@ -1,6 +1,6 @@
-export type LocktimeInfo   = LocktimeStamp | LocktimeHeight
-export type SequenceConfig = Partial<SequenceInfo>
-export type SequenceInfo   = SequenceHeightLock | SequenceStampLock
+export type LocktimeData   = LocktimeStamp | LocktimeHeight
+export type SequenceConfig = Partial<SequenceData>
+export type SequenceData   = SequenceHeightLock | SequenceStampLock
 
 export interface LocktimeStamp {
   type  : 'timelock'  // Discriminator for timelock type

package/src/types/txdata.ts

@@ -1,4 +1,17 @@
-export type TxInput = TxCoinbaseInput | TxSpendInput | TxVirtualInput
+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
@@ -51,3 +64,16 @@ export interface TxData {
   vout     : TxOutput[]
   version  : number
 }
+
+export interface TxSize {
+  base   : number
+  real   : number
+  weight : number
+  vsize  : number
+}
+
+export interface TxValue {
+  fees : bigint
+  vin  : bigint
+  vout : bigint
+}

package/src/types/witness.ts

@@ -1,8 +1,13 @@
-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 WitnessInfo {
+export interface WitnessSize {
+  size  : number
+  vsize : number
+}
+
+export interface WitnessData {
   annex   : string | null
   cblock  : string | null
   params  : string[]
@@ -11,25 +16,25 @@ export interface WitnessInfo {
   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/src/types/transaction.ts

@@ -1,98 +0,0 @@
-import { LocktimeInfo, SequenceInfo } from './meta.js'
-import { TxOutput }                   from './txdata.js'
-
-import type {
-  WitnessType,
-  WitnessVersion
-} from './witness.js'
-
-export type TxOutputType = WitnessType | 'p2pkh' | 'p2sh' | 'opreturn'
-
-export interface TxOutputInfo {
-  type    : TxOutputType
-  version : WitnessVersion
-}
-
-export interface TxInputInfo {
-  type    : WitnessType
-  version : WitnessVersion
-}
-
-export interface LocktimeField {
-  hex   : string
-  data  : LocktimeInfo | null
-  value : number
-}
-
-export interface SequenceField {
-  hex   : string
-  data  : SequenceInfo | null
-  value : number
-}
-
-export interface ScriptField {
-  asm : string[]
-  hex : string
-}
-
-export interface TxSize {
-  base   : number
-  real   : number
-  weight : number
-  vsize  : number
-}
-
-export interface TxValue {
-  fees : bigint
-  vin  : bigint
-  vout : bigint
-}
-
-export interface WitnessSize {
-  size  : number
-  vsize : number
-}
-
-export interface TransactionData {
-  hash     : string
-  locktime : LocktimeField
-  return   : TxOutput | null
-  size     : TxSize
-  spends   : TxOutputField[]
-  txid     : string
-  value    : TxValue
-  version  : number
-  vin      : TxInputField[]
-  vout     : TxOutputField[]
-}
-
-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 TxInputField {
-  coinbase?   : string        | null
-  prevout?    : TxOutputField | null
-  script_sig? : ScriptField   | null
-  sequence    : SequenceField
-  size        : number
-  txid        : string
-  vout        : number
-  witness?    : WitnessField | null
-}
-
-export interface TxOutputField {
-  script_pk : ScriptField
-  size      : number
-  type      : TxOutputType
-  value     : bigint
-  version   : WitnessVersion | null
-}