@vbyte/btc-dev 1.0.0 → 1.0.2

package/dist/types/address.d.ts

@@ -1,6 +1,6 @@
 export type AddressFormat = 'base58' | 'bech32' | 'bech32m';
 export type AddressType = 'p2pkh' | 'p2sh' | 'p2w-pkh' | 'p2w-sh' | 'p2tr';
-export type ChainNetwork = 'main' | 'testnet' | 'regtest';
+export type ChainNetwork = 'main' | 'testnet' | 'regtest' | string;
 export type AddressData = AddressContext & ScriptData;
 export type AddressConfigEntry = [
     prefix: string,

package/dist/types/index.d.ts

@@ -5,5 +5,4 @@ export * from './sighash.js';
 export * from './taproot.js';
 export * from './transaction.js';
 export * from './txdata.js';
-export * from './txmeta.js';
 export * from './witness.js';

package/dist/types/index.js

@@ -5,5 +5,4 @@ export * from './sighash.js';
 export * from './taproot.js';
 export * from './transaction.js';
 export * from './txdata.js';
-export * from './txmeta.js';
 export * from './witness.js';

package/dist/types/meta.d.ts

@@ -1,3 +1,22 @@
+export type LocktimeInfo = LocktimeStamp | LocktimeHeight;
+export type SequenceConfig = Partial<SequenceInfo>;
+export type SequenceInfo = SequenceHeightLock | SequenceStampLock;
+export interface LocktimeStamp {
+    type: 'timelock';
+    stamp: number;
+}
+export interface LocktimeHeight {
+    type: 'heightlock';
+    height: number;
+}
+export interface SequenceStampLock {
+    stamp: number;
+    mode: 'stamp';
+}
+export interface SequenceHeightLock {
+    height: number;
+    mode: 'height';
+}
 export interface InscriptionData {
     content?: string;
     delegate?: string;

package/dist/types/transaction.d.ts

@@ -1,5 +1,5 @@
+import { LocktimeInfo, SequenceInfo } from './meta.js';
 import { TxOutput } from './txdata.js';
-import { LocktimeInfo, SequenceInfo } from './txmeta.js';
 import type { WitnessType, WitnessVersion } from './witness.js';
 export type TxOutputType = WitnessType | 'p2pkh' | 'p2sh' | 'opreturn';
 export interface TxOutputInfo {

package/dist/types/txdata.d.ts

@@ -1,4 +1,4 @@
-export type TxInput = CoinbaseInput | SpendInput | VirtualInput;
+export type TxInput = TxCoinbaseInput | TxSpendInput | TxVirtualInput;
 export interface TxOutpoint {
     txid: string;
     vout: number;
@@ -10,21 +10,21 @@ export interface TxInputTemplate extends TxOutpoint {
     sequence?: number;
     witness?: string[];
 }
-export interface CoinbaseInput extends TxOutpoint {
+export interface TxCoinbaseInput extends TxOutpoint {
     coinbase: string;
     prevout: null;
     script_sig: null;
     sequence: number;
     witness: string[];
 }
-export interface VirtualInput extends TxOutpoint {
+export interface TxVirtualInput extends TxOutpoint {
     coinbase: null;
     prevout: TxOutput | null;
     script_sig: string | null;
     sequence: number;
     witness: string[];
 }
-export interface SpendInput extends VirtualInput {
+export interface TxSpendInput extends TxVirtualInput {
     prevout: TxOutput;
 }
 export interface TxOutput {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vbyte/btc-dev",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Batteries-included toolset for plebian bitcoin development",
   "type": "module",
   "keywords": [
@@ -35,17 +35,12 @@
     ".": {
       "types": "./dist/types/index.d.ts",
       "import": "./dist/index.js",
-      "require": "./dist/main.cjs",
       "default": "./dist/index.js"
     },
     "./address": {
       "types": "./dist/lib/address/index.d.ts",
       "import": "./dist/lib/address/index.js"
     },
-    "./class": {
-      "types": "./dist/class/index.d.ts",
-      "import": "./dist/class/index.js"
-    },
     "./meta": {
       "types": "./dist/lib/meta.d.ts",
       "import": "./dist/lib/meta.js"
@@ -62,6 +57,10 @@
       "types": "./dist/lib/sighash/index.d.ts",
       "import": "./dist/lib/sighash/index.js"
     },
+    "./signer": {
+      "types": "./dist/lib/signer/index.d.ts",
+      "import": "./dist/lib/signer/index.js"
+    },
     "./taproot": {
       "types": "./dist/lib/taproot/index.d.ts",
       "import": "./dist/lib/taproot/index.js"
@@ -69,6 +68,10 @@
     "./tx": {
       "types": "./dist/lib/tx/index.d.ts",
       "import": "./dist/lib/tx/index.js"
+    },
+    "./witness": {
+      "types": "./dist/lib/witness/index.d.ts",
+      "import": "./dist/lib/witness/index.js"
     }
   },
   "scripts": {

package/src/class/signer.ts

@@ -4,7 +4,7 @@ import { ECC }         from '@vbyte/micro-lib'
 import {
   sign_segwit_tx,
   sign_taproot_tx
-} from '@/lib/sighash/sign.js'
+} from '@/lib/signer/sign.js'
 
 import type {
   SigHashOptions,

package/src/class/tx.ts

@@ -1,12 +1,12 @@
+import { LocktimeUtil }      from '@/lib/meta/index.js'
 import { TransactionInput }  from './txin.js'
 import { TransactionOutput } from './txout.js'
 
 import {
-  decode_tx_data,
+  decode_tx,
   get_txid,
   is_return_script,
-  parse_tx_data,
-  Locktime,
+  parse_tx,
   get_txsize,
   get_tx_value,
   get_txhash,
@@ -32,8 +32,8 @@ export class Transaction {
 
   constructor (txdata : string | TxData | TxTemplate) {
     this._tx = (typeof txdata !== 'string')
-      ? parse_tx_data(txdata)
-      : decode_tx_data(txdata)
+      ? 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))
@@ -65,7 +65,7 @@ export class Transaction {
   get locktime () {
     return {
       hex   : encode_tx_locktime(this._tx.locktime).hex,
-      data  : Locktime.decode(this._tx.locktime),
+      data  : LocktimeUtil.decode(this._tx.locktime),
       value : this._tx.locktime
     }
   }

package/src/class/txin.ts

@@ -1,11 +1,11 @@
 import { decode_script }      from '@/lib/script/index.js'
+import { SequenceUtil }       from '@/lib/meta/index.js'
 import { TransactionOutput }  from './txout.js'
 import { TransactionWitness } from './witness.js'
 
 import {
   encode_txin_sequence,
   get_txin_size,
-  Sequence
 } from '@/lib/tx/index.js'
 
 import type {
@@ -69,7 +69,7 @@ export class TransactionInput {
   get sequence () {
     return {
       hex   : encode_txin_sequence(this._txin.sequence).hex,
-      data  : Sequence.decode(this._txin.sequence),
+      data  : SequenceUtil.decode(this._txin.sequence),
       value : this._txin.sequence
     }
   }

package/src/class/witness.ts

@@ -4,7 +4,7 @@ import { decode_script } from '@/lib/script/index.js'
 import {
   parse_witness_data,
   get_witness_size,
-} from '@/lib/tx/index.js'
+} from '@/lib/witness/index.js'
 
 import type {
   ScriptField,

package/src/index.ts

@@ -1,12 +1,14 @@
 export * from './class/index.js'
 
-export * as Address from './lib/address/index.js'
-export * as Meta    from './lib/meta/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'
-export * as Script  from './lib/script/index.js'
-export * as Sighash from './lib/sighash/index.js'
-export * as Taproot from './lib/taproot/index.js'
-export * as Tx      from './lib/tx/index.js'
+export * as SCRIPT  from './lib/script/index.js'
+export * as SIGHASH from './lib/sighash/index.js'
+export * as SIGNER  from './lib/signer/index.js'
+export * as TAPROOT from './lib/taproot/index.js'
+export * as TX      from './lib/tx/index.js'
+export * as WITNESS from './lib/witness/index.js'
 
 export * as CONST  from './const.js'
 export * as SCHEMA from './schema/index.js'

package/src/lib/meta/index.ts

@@ -1,2 +1,4 @@
-export * from './pointer.js'
+export * from './locktime.js'
+export * from './ref.js'
 export * from './scribe.js'
+export * from './sequence.js'

package/src/lib/{tx → meta}/locktime.ts

@@ -5,7 +5,7 @@ import type { LocktimeInfo } from '@/types/index.js'
 // The threshold between block height and timestamp.
 const LOCKTIME_THRESHOLD = 500000000
 
-export namespace Locktime {
+export namespace LocktimeUtil {
   export const encode = encode_locktime
   export const decode = decode_locktime
 }

package/src/lib/meta/{pointer.ts → ref.ts}

@@ -1,4 +1,4 @@
-export namespace TxPointer {
+export namespace RefEncoder {
   export const outpoint = {
     encode : encode_outpoint,
     decode : decode_outpoint,

package/src/lib/meta/scribe.ts

@@ -9,7 +9,7 @@ const _0n  = BigInt(0)
 const _1n  = BigInt(1)
 const _26n = BigInt(26)
 
-export namespace Inscription {
+export namespace ScribeEncoder {
   export const encode = encode_inscription
   export const decode = decode_inscription
 }

package/src/lib/{tx → meta}/sequence.ts

@@ -23,7 +23,7 @@ const TIMELOCK_GRANULARITY = 512         // Seconds per timestamp unit (BIP-68 s
 
 /* ===== [ API ] ============================================================ */
 
-export namespace Sequence {
+export namespace SequenceUtil {
   export const encode = encode_sequence
   export const decode = decode_sequence
 }

package/src/lib/sighash/index.ts

@@ -1,5 +1,3 @@
 export * from './segwit.js'
-export * from './sign.js'
 export * from './taproot.js'
-export * from './verify.js'
 export * from './util.js'

package/src/lib/sighash/segwit.ts

@@ -15,7 +15,7 @@ import {
   encode_txin_txid,
   encode_vout_value,
   encode_tx_version,
-  parse_tx_data
+  parse_tx
 } from '@/lib/tx/index.js'
 
 import {
@@ -34,7 +34,7 @@ export function hash_segwit_tx (
   // Unpack the sigflag from our config object.
   const { sigflag = 0x01, txindex } = options
   // Normalize the tx into JSON format.
-  const tx = parse_tx_data(txdata)
+  const tx = parse_tx(txdata)
   // Check if the ANYONECANPAY flag is set.
   const is_anypay = (sigflag & 0x80) === 0x80
   // Save a normalized version of the sigflag.

package/src/lib/sighash/taproot.ts

@@ -3,7 +3,7 @@ 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_data }      from '@/lib/tx/parse.js'
+import { parse_tx }           from '@/lib/tx/parse.js'
 import * as CONST             from '@/const.js'
 import { parse_txinput }      from './util.js'
 
@@ -37,7 +37,7 @@ export function hash_taproot_tx (
     separator_pos = 0xFFFFFFFF
   } = config
   // Normalize the txdata object.
-  const tx = parse_tx_data(template)
+  const tx = parse_tx(template)
   // Unpack the txdata object.
   const { version, vin: input, vout: output, locktime } = tx
   // Parse the input we are signing from the config.

package/src/lib/signer/index.ts

@@ -0,0 +1,2 @@
+export * from './sign.js'
+export * from './verify.js'

package/src/lib/{sighash → signer}/sign.ts

@@ -1,9 +1,9 @@
 import { ECC }             from '@vbyte/micro-lib'
-import { parse_tx_data }   from '@/lib/tx/parse.js'
+import { parse_tx }        from '@/lib/tx/parse.js'
 import { SIGHASH_DEFAULT } from '@/const.js'
-import { hash_segwit_tx }  from './segwit.js'
-import { hash_taproot_tx } from './taproot.js'
-import { format_sigflag }  from './util.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 type {
   SigHashOptions,
@@ -15,7 +15,7 @@ export function sign_segwit_tx (
   txdata  : TxData,
   options : SigHashOptions,
 ) {
-  const tx   = parse_tx_data(txdata)
+  const tx   = parse_tx(txdata)
   const msg  = hash_segwit_tx(tx, options)
   const sig  = ECC.sign_ecdsa(seckey, msg).hex
   const flag = format_sigflag(options.sigflag ?? SIGHASH_DEFAULT)
@@ -27,7 +27,7 @@ export function sign_taproot_tx (
   txdata  : TxData,
   options : SigHashOptions,
 ) {
-  const tx   = parse_tx_data(txdata)
+  const tx   = parse_tx(txdata)
   const msg  = hash_taproot_tx(tx, options)
   const sig  = ECC.sign_bip340(seckey, msg).hex
   const flag = format_sigflag(options.sigflag ?? 0)

package/src/lib/{sighash → signer}/verify.ts

@@ -7,6 +7,28 @@
 // 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 {
+  SigHashOptions,
+  TxData
+} from '@/types/index.js'
+
+export function verify_segwit_tx (
+  _txdata  : TxData | Bytes,
+  _config  : SigHashOptions = {}
+) : boolean {
+  console.warn('verify_segwit_tx is not implemented')
+  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,

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/tx/witness.js'
+import { parse_witness_data } from '@/lib/witness/parse.js'
 
 import {
   encode_tapbranch,

package/src/lib/tx/create.ts

@@ -13,13 +13,13 @@ import type {
   TxInput,
   TxOutput,
   TxTemplate,
-  SpendInput,
-  CoinbaseInput
+  TxSpendInput,
+  TxCoinbaseInput
 } from '@/types/index.js'
 
 export function create_coinbase_input (
   config : TxInputTemplate | TxInput
-) : CoinbaseInput {
+) : TxCoinbaseInput {
   assert_vin_template(config)
   Assert.exists(config.coinbase, 'coinbase is required')
   const coinbase   = config.coinbase
@@ -34,7 +34,7 @@ export function create_coinbase_input (
 
 export function create_spend_input (
   config : TxInputTemplate | TxInput
-) : SpendInput {
+) : TxSpendInput {
   assert_vin_template(config)
   Assert.exists(config.prevout, 'prevout is required')
   const prevout    = config.prevout
@@ -69,7 +69,7 @@ export function create_tx_output (
   return { script_pk, value : BigInt(value) }
 }
 
-export function create_tx_data (
+export function create_tx (
   config: TxTemplate | TxData
 ) : TxData {
   assert_tx_template(config)

package/src/lib/tx/decode.ts

@@ -7,9 +7,9 @@ import {
   TxData,
   TxInput,
   TxOutput,
-  CoinbaseInput,
-  VirtualInput,
-  SpendInput
+  TxCoinbaseInput,
+  TxVirtualInput,
+  TxSpendInput
 } from '@/types/index.js'
 
 interface TxEncoderConfig {
@@ -22,7 +22,7 @@ const DEFAULT_CONFIG : TxEncoderConfig = {
   segwit   : true
 }
 
-export function decode_tx_data (
+export function decode_tx (
   txbytes : Bytes,
   options : Partial<TxEncoderConfig> = {}
 ) : TxData {
@@ -87,11 +87,11 @@ function read_vin (stream : Stream, prevout : TxOutput | null = null) : TxInput
   const sequence   = stream.read(4).reverse().num
   const witness : string[] = []
   if (txid === COINBASE.TXID && vout === COINBASE.VOUT) {
-    return { coinbase : script_sig, prevout: null, script_sig : null, sequence, txid, vout, witness } as CoinbaseInput
+    return { coinbase : script_sig, prevout: null, script_sig : null, sequence, txid, vout, witness } as TxCoinbaseInput
   } else if (prevout !== null) {
-    return { coinbase : null, prevout, script_sig, sequence, txid, vout, witness } as SpendInput
+    return { coinbase : null, prevout, script_sig, sequence, txid, vout, witness } as TxSpendInput
   } else {
-    return { coinbase : null, prevout, script_sig, sequence, txid, vout, witness } as VirtualInput
+    return { coinbase : null, prevout, script_sig, sequence, txid, vout, witness } as TxVirtualInput
   }
 }
 

package/src/lib/tx/encode.ts

@@ -1,6 +1,6 @@
 import { Buff }          from '@vbyte/buff'
 import { Assert }        from '@vbyte/micro-lib'
-import { parse_tx_data } from './parse.js'
+import { parse_tx }      from './parse.js'
 import { COINBASE }      from '@/const.js'
 
 import {
@@ -9,11 +9,11 @@ import {
   TxData
 } from '@/types/index.js'
 
-export function encode_tx_data (
+export function encode_tx (
   txdata : TxData,
   segwit = true
 ) : Buff {
-  const tx = parse_tx_data(txdata)
+  const tx = parse_tx(txdata)
   // Unpack the transaction data.
   const { version, vin, vout, locktime } = tx
   // Create a buffer for the transaction.

package/src/lib/tx/index.ts

@@ -1,10 +1,7 @@
 export * from './create.js'
 export * from './decode.js'
 export * from './encode.js'
-export * from './locktime.js'
-export * from './meta.js'
+export * from './util.js'
 export * from './parse.js'
-export * from './sequence.js'
 export * from './size.js'
 export * from './validate.js'
-export * from './witness.js'

package/src/lib/tx/parse.ts

@@ -1,16 +1,16 @@
-import { decode_tx_data }     from './decode.js'
-import { create_tx_data }     from './create.js'
+import { decode_tx }          from './decode.js'
+import { create_tx     }      from './create.js'
 import { assert_tx_template } from './validate.js'
 
 import type { TxData } from '@/types/index.js'
 
-export function parse_tx_data (
+export function parse_tx (
   txdata : unknown
 ) : TxData {
   if (typeof txdata === 'string') {
-    return decode_tx_data(txdata)
+    return decode_tx(txdata)
   } else {
     assert_tx_template(txdata)
-    return create_tx_data(txdata)
+    return create_tx(txdata)
   }
 }

package/src/lib/tx/size.ts

@@ -1,8 +1,8 @@
 import { Buff, Bytes }   from '@vbyte/buff'
-import { parse_tx_data } from './parse.js'
+import { parse_tx }      from './parse.js'
 
 import {
-  encode_tx_data,
+  encode_tx,
   encode_tx_inputs,
   encode_tx_outputs,
   encode_tx_vout,
@@ -14,12 +14,10 @@ import type {
   TxData,
   TxInput,
   TxOutput,
-  TxSize,
-  WitnessSize,
+  TxSize
 } from '@/types/index.js'
 
-const WIT_FLAG_BYTES  = 2
-const WIT_LENGTH_BYTE = 1
+const WIT_FLAG_BYTES = 2
 
 export function get_vsize (
   bytes : Bytes
@@ -32,9 +30,9 @@ export function get_vsize (
 export function get_txsize (
   txdata : string | TxData
 ) : TxSize {
-  const json   = parse_tx_data(txdata)
-  const base   = encode_tx_data(json, false).length
-  const size   = encode_tx_data(json, true).length
+  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 remain = (weight % 4 > 0) ? 1 : 0
   const vsize  = Math.floor(weight / 4) + remain
@@ -68,10 +66,3 @@ export function get_txout_size (txoutput : TxOutput) : number {
   const bytes = encode_tx_vout(txoutput)
   return bytes.length
 }
-
-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 }
-}

package/src/lib/tx/{meta.ts → util.ts}

@@ -1,7 +1,7 @@
 import { hash256 }             from '@vbyte/micro-lib/hash'
 import { LOCK_SCRIPT_REGEX }   from '@/const.js'
-import { encode_tx_data }      from './encode.js'
-import { parse_tx_data }       from './parse.js'
+import { encode_tx }           from './encode.js'
+import { parse_tx }            from './parse.js'
 
 import type {
   TxData,
@@ -49,23 +49,23 @@ export function get_vout_version (
 export function get_txid (
   txdata : string | TxData
 ) : string {
-  const json = parse_tx_data(txdata)
-  const data = encode_tx_data(json, false)
+  const json = parse_tx(txdata)
+  const data = encode_tx(json, false)
   return hash256(data).reverse().hex
 }
 
 export function get_txhash (
   txdata : string | TxData
 ) : string {
-  const json = parse_tx_data(txdata)
-  const data = encode_tx_data(json, true)
+  const json = parse_tx(txdata)
+  const data = encode_tx(json, true)
   return hash256(data).reverse().hex
 }
 
 export function get_tx_value (
   txdata : string | TxData
 ) : TxValue {
-  const tx   = parse_tx_data(txdata)
+  const tx   = parse_tx(txdata)
   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

package/src/lib/tx/validate.ts

@@ -1,7 +1,7 @@
 import * as Schema from '@/schema/index.js'
 
 import {
-  SpendInput,
+  TxSpendInput,
   TxData,
   TxInput,
   TxInputTemplate,
@@ -13,7 +13,7 @@ export function assert_tx_template (txdata : unknown) : asserts txdata is TxTemp
   Schema.tx.tx_template.parse(txdata)
 }
 
-export function assert_has_prevouts (vin : TxInput[]) : asserts vin is SpendInput[] {
+export function assert_has_prevouts (vin : TxInput[]) : asserts vin is TxSpendInput[] {
   if (vin.some(txin => txin.prevout === null)) {
     throw new Error('transaction missing prevouts')
   }

package/src/lib/witness/index.ts

@@ -0,0 +1,2 @@
+export * from './parse.js'
+export * from './util.js'

package/src/lib/witness/util.ts

@@ -0,0 +1,12 @@
+import { Buff, Bytes } from '@vbyte/buff'
+
+import type { WitnessSize } from '@/types/index.js'
+
+const WIT_LENGTH_BYTE = 1
+
+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 }
+}