@vbyte/btc-dev 1.0.15 → 1.1.1

package/dist/types/taproot.d.ts

@@ -14,6 +14,7 @@ export interface TaprootConfig {
 export interface TaprootContext {
     cblock: string;
     int_key: string;
+    path: string[];
     parity: number;
     taproot: string | null;
     tapkey: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vbyte/btc-dev",
-  "version": "1.0.15",
+  "version": "1.1.1",
   "description": "Batteries-included toolset for plebian bitcoin development",
   "type": "module",
   "keywords": [
@@ -45,10 +45,6 @@
       "types": "./dist/lib/meta/index.d.ts",
       "import": "./dist/lib/meta/index.js"
     },
-    "./psbt": {
-      "types": "./dist/lib/psbt/index.d.ts",
-      "import": "./dist/lib/psbt/index.js"
-    },
     "./script": {
       "types": "./dist/lib/script/index.d.ts",
       "import": "./dist/lib/script/index.js"
@@ -87,8 +83,8 @@
     "@noble/hashes": "^1.8.0",
     "@scure/btc-signer": "^1.8.1",
     "@vbyte/buff": "^1.0.2",
-    "@vbyte/micro-lib": "^1.0.14",
-    "zod": "^3.25.69"
+    "@vbyte/micro-lib": "^1.1.1",
+    "zod": "^4.0.5"
   },
   "devDependencies": {
     "@cmdcode/core-cmd": "^1.6.5",
@@ -97,10 +93,10 @@
     "@rollup/plugin-node-resolve": "^16.0.1",
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^12.1.4",
-    "@types/node": "^24.0.10",
+    "@types/node": "^24.0.14",
     "@types/tape": "^5.8.1",
     "faucet": "^0.0.4",
-    "rollup": "^4.44.1",
+    "rollup": "^4.45.1",
     "tape": "^5.9.0",
     "tslib": "^2.8.1",
     "tsx": "^4.20.3",

package/src/index.ts

@@ -1,6 +1,5 @@
 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 SIGNER  from './lib/signer/index.js'

package/src/lib/meta/locktime.ts

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

package/src/lib/meta/ref.ts

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

package/src/lib/meta/scribe.ts

@@ -1,7 +1,7 @@
-import { Buff, Stream }  from '@vbyte/buff'
-import { Assert }        from '@vbyte/micro-lib'
-import { encode_script } from '@/lib/script/encode.js'
-import { decode_script } from '@/lib/script/decode.js'
+import { Buff, Bytes, Stream } from '@vbyte/buff'
+import { Assert }              from '@vbyte/micro-lib'
+import { encode_script }       from '@/lib/script/encode.js'
+import { decode_script }       from '@/lib/script/decode.js'
 
 import type { InscriptionData } from '@/types/index.js'
 
@@ -9,23 +9,24 @@ const _0n  = BigInt(0)
 const _1n  = BigInt(1)
 const _26n = BigInt(26)
 
-export namespace ScribeEncoder {
+export namespace InscriptionUtil {
+  export type Type    = InscriptionData
   export const encode = encode_inscription
   export const decode = decode_inscription
 }
 
 export function decode_inscription (
-  script : string
+  script : Bytes
 ) : InscriptionData[] {
   const envelopes = parse_envelopes(script)
   return envelopes.map(parse_record)
 }
 
-export function encode_inscription (data : InscriptionData[]) : string {
-  return data.map(create_envelope).join('')
+export function encode_inscription (data : InscriptionData[]) : Buff {
+  return Buff.join(data.map(create_envelope))
 }
 
-function create_envelope (data : InscriptionData) : string {
+function create_envelope (data : InscriptionData) : Buff {
   let asm : string[] = [ 'OP_0', 'OP_IF', '6f7264' ]
 
   if (typeof data.delegate === 'string') {
@@ -73,7 +74,7 @@ function create_envelope (data : InscriptionData) : string {
 }
 
 function parse_envelopes (
-  script : string
+  script : Bytes
 ) : string[][] {
 
   const words     = decode_script(script)
@@ -98,7 +99,7 @@ function parse_envelopes (
   return envelopes
 }
 
-function parse_record (envelope : string[]) {
+function parse_record (envelope : Bytes[]) {
   const record : InscriptionData = {}
 
   for (let i = 0; i < envelope.length; i++) {
@@ -124,7 +125,7 @@ function parse_record (envelope : string[]) {
         i += 1
         break
       case 'OP_WITHIN':
-        record.ref = envelope[i+1]
+        record.ref = decode_bytes(envelope[i+1])
         i += 1
         break;
       case 'OP_NOP':
@@ -139,6 +140,10 @@ function parse_record (envelope : string[]) {
   return record
 }
 
+function decode_bytes (bytes : Bytes) : string {
+  return Buff.bytes(bytes).hex
+}
+
 function encode_id (
   identifier : string
 ) : string {
@@ -151,9 +156,9 @@ function encode_id (
 }
 
 function decode_id (
-  hexstr : string
+  identifier : Bytes
 ) : string {
-  const bytes = Buff.hex(hexstr)
+  const bytes = Buff.bytes(identifier)
   const idx   = bytes.at(-1) ?? 0
   const txid  = bytes.slice(0, -1).reverse().hex
   return txid + 'i' + String(idx)
@@ -166,9 +171,9 @@ function encode_pointer (
 }
 
 function decode_pointer (
-  hexstr : string
+  bytes : Bytes
 ) : number {
-  return Buff.hex(hexstr).reverse().num
+  return Buff.bytes(bytes).reverse().num
 }
 
 function encode_label (
@@ -178,9 +183,9 @@ function encode_label (
 }
 
 function decode_label (
-  hexstr : string
+  label : Bytes
 ) : string {
-  return Buff.hex(hexstr).str
+  return Buff.bytes(label).str
 }
 
 function encode_content (
@@ -204,11 +209,11 @@ function encode_content (
 }
 
 function decode_content (
-  hexstrs : string[],
-  type    : 'hex' | 'utf8' = 'hex'
+  chunks : Bytes[],
+  format : 'hex' | 'utf8' = 'hex'
 ) : string {
-  const data = Buff.join(hexstrs)
-  return (type === 'hex')
+  const data = Buff.join(chunks)
+  return (format === 'hex')
     ? data.hex
     : data.str
 }
@@ -225,9 +230,9 @@ function encode_rune_label (label : string) : string {
   return Buff.big(big).reverse().hex
 }
 
-function decode_rune_label (hex: string): string {
+function decode_rune_label (label: Bytes): string {
   // Convert hex to BigInt, with byte order reversed
-  let big = Buff.hex(hex).reverse().big
+  let big = Buff.bytes(label).reverse().big
   // Add 1 as per the encoding algorithm
   big = big + _1n
   // Initialize result string

package/src/lib/meta/sequence.ts

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

package/src/lib/script/decode.ts

@@ -1,4 +1,4 @@
-import { Stream } from '@vbyte/buff'
+import { Bytes, Stream } from '@vbyte/buff'
 
 import {
   get_op_code,
@@ -10,7 +10,7 @@ import {
  * Decode a bitcoin script into asm instructions.
  */
 export function decode_script (
-  script : string | Uint8Array
+  script : Bytes
 ) : string[] {
   const stream = new Stream(script)
 

package/src/lib/script/encode.ts

@@ -10,8 +10,8 @@ const MAX_WORD_SIZE = 520
 export function encode_script (
   words : (string | number | Uint8Array)[],
   varint = false
-) : string {
-  if (words.length === 0) return '00'
+) : Buff {
+  if (words.length === 0) return Buff.num(0, 1)
 
   const bytes = []
 
@@ -23,11 +23,10 @@ export function encode_script (
   const buffer = Buff.join(bytes)
 
   return (varint)
-    ? buffer.prepend(Buff.varint(buffer.length, 'le')).hex
-    : buffer.hex
+    ? buffer.prepend(Buff.varint(buffer.length, 'le'))
+    : buffer
 }
 
-
 /** Check if the word is a valid opcode,
  *  and return its integer value.
  */

package/src/lib/taproot/cblock.ts

@@ -64,6 +64,7 @@ export function create_taproot (config : TaprootConfig) : TaprootContext {
 
   return {
     int_key  : Buff.bytes(pubkey).hex,
+    path,
     parity,
     taproot  : taproot ?? null,
     cblock   : cblock.hex,

package/src/types/taproot.ts

@@ -18,6 +18,7 @@ export interface TaprootConfig {
 export interface TaprootContext {
   cblock   : string
   int_key  : string
+  path     : string[]
   parity   : number
   taproot  : string | null
   tapkey   : string

package/dist/lib/psbt/encoder.d.ts

@@ -1,5 +0,0 @@
-import { Transaction } from '@scure/btc-signer';
-import type { PSBTData } from '../../types/index.js';
-export declare function decode_psbt(b64str: string): Transaction;
-export declare function encode_psbt(psbt: PSBTData): string;
-export declare function parse_psbt(psbt: string | PSBTData): Transaction;

package/dist/lib/psbt/encoder.js

@@ -1,21 +0,0 @@
-import { Base64 } from '@vbyte/micro-lib';
-import { Transaction } from '@scure/btc-signer';
-export function decode_psbt(b64str) {
-    const psbt = Base64.decode(b64str);
-    return Transaction.fromPSBT(psbt, { allowUnknownOutputs: true });
-}
-export function encode_psbt(psbt) {
-    const psbt_bytes = psbt.toPSBT(0);
-    return Base64.encode(psbt_bytes);
-}
-export function parse_psbt(psbt) {
-    if (psbt instanceof Transaction) {
-        return psbt;
-    }
-    else if (typeof psbt === 'string') {
-        return decode_psbt(psbt);
-    }
-    else {
-        throw new Error('invalid psbt input: ' + psbt);
-    }
-}

package/dist/lib/psbt/index.d.ts

@@ -1,4 +0,0 @@
-export * from './encoder.js';
-export * from './meta.js';
-export * from './util.js';
-export * from './validate.js';

package/dist/lib/psbt/index.js

@@ -1,4 +0,0 @@
-export * from './encoder.js';
-export * from './meta.js';
-export * from './util.js';
-export * from './validate.js';

package/dist/lib/psbt/meta.d.ts

@@ -1,3 +0,0 @@
-import { PSBTData } from '../../types/index.js';
-export declare function get_vsize(psbt: string | PSBTData): number;
-export declare function get_txhex(psbt: PSBTData): string;

package/dist/lib/psbt/meta.js

@@ -1,11 +0,0 @@
-import { parse_psbt } from './encoder.js';
-import { finalize_legacy_inputs } from './util.js';
-export function get_vsize(psbt) {
-    const pdata = parse_psbt(psbt);
-    return pdata.vsize;
-}
-export function get_txhex(psbt) {
-    let pdata = parse_psbt(psbt);
-    pdata = finalize_legacy_inputs(pdata);
-    return pdata.hex;
-}

package/dist/lib/psbt/util.d.ts

@@ -1,5 +0,0 @@
-import type { PSBTData, PSBTInput, PSBTOutput, PSBTPrevouts } from '../../types/index.js';
-export declare function collect_vins(psbt: string | PSBTData): PSBTInput[];
-export declare function collect_vouts(psbt: string | PSBTData): PSBTOutput[];
-export declare function collect_prevouts(psbt: PSBTData): PSBTPrevouts;
-export declare function finalize_legacy_inputs(pdata: PSBTData): import("node_modules/@scure/btc-signer/transaction.js").Transaction;

package/dist/lib/psbt/util.js

@@ -1,44 +0,0 @@
-import { Assert } from '@vbyte/micro-lib';
-import { parse_psbt } from './encoder.js';
-export function collect_vins(psbt) {
-    const pdata = parse_psbt(psbt);
-    const count = pdata.inputsLength;
-    const vins = [];
-    for (let i = 0; i < count; i++) {
-        const vin = pdata.getInput(i);
-        vins.push(vin);
-    }
-    return vins;
-}
-export function collect_vouts(psbt) {
-    const pdata = parse_psbt(psbt);
-    const count = pdata.outputsLength;
-    const vouts = [];
-    for (let i = 0; i < count; i++) {
-        const vout = pdata.getOutput(i);
-        vouts.push(vout);
-    }
-    return vouts;
-}
-export function collect_prevouts(psbt) {
-    const amounts = [], scripts = [];
-    const pdata = parse_psbt(psbt);
-    for (let i = 0; i < pdata.inputsLength; i++) {
-        const txin = pdata.getInput(i);
-        Assert.exists(txin.witnessUtxo, `witness utxo does not exist for input ${i}`);
-        amounts.push(txin.witnessUtxo.amount);
-        scripts.push(txin.witnessUtxo.script);
-    }
-    return { amounts, scripts };
-}
-export function finalize_legacy_inputs(pdata) {
-    for (let i = 0; i < pdata.inputsLength; i++) {
-        const pvin = pdata.getInput(i);
-        const script = pvin.redeemScript;
-        const psig = pvin.partialSig?.at(0);
-        if (script !== undefined && psig !== undefined) {
-            pdata.finalizeIdx(i);
-        }
-    }
-    return pdata;
-}

package/dist/lib/psbt/validate.d.ts

@@ -1,2 +0,0 @@
-import type { PSBTData } from '../../types/index.js';
-export declare function assert_psbt_is_funded(psbt: string | PSBTData): void;

package/dist/lib/psbt/validate.js

@@ -1,11 +0,0 @@
-import { Assert } from '@vbyte/micro-lib';
-import { parse_psbt } from './encoder.js';
-import { collect_vins, collect_vouts } from './util.js';
-export function assert_psbt_is_funded(psbt) {
-    const pdata = parse_psbt(psbt);
-    const pvouts = collect_vins(pdata);
-    const txouts = collect_vouts(pdata);
-    const vin_amt = pvouts.reduce((p, n) => p + Number(n.witnessUtxo?.amount ?? 0), 0);
-    const out_amt = txouts.reduce((p, n) => p + Number(n.amount ?? 0), 0);
-    Assert.ok(vin_amt >= out_amt, `value in (${vin_amt}) < value out (${out_amt})`);
-}

package/src/lib/psbt/encoder.ts

@@ -1,24 +0,0 @@
-import { Base64 }      from '@vbyte/micro-lib'
-import { Transaction } from '@scure/btc-signer'
-
-import type { PSBTData } from '@/types/index.js'
-
-export function decode_psbt (b64str : string) : Transaction {
-  const psbt = Base64.decode(b64str)
-  return Transaction.fromPSBT(psbt, { allowUnknownOutputs: true })
-}
-
-export function encode_psbt (psbt : PSBTData) : string {
-  const psbt_bytes = psbt.toPSBT(0)
-  return Base64.encode(psbt_bytes)
-}
-
-export function parse_psbt (psbt : string | PSBTData) : Transaction {
-  if (psbt instanceof Transaction) {
-    return psbt
-  } else if (typeof psbt === 'string') {
-    return decode_psbt(psbt)
-  } else {
-    throw new Error('invalid psbt input: ' + psbt)
-  }
-}

package/src/lib/psbt/index.ts

@@ -1,4 +0,0 @@
-export * from './encoder.js'
-export * from './meta.js'
-export * from './util.js'
-export * from './validate.js'

package/src/lib/psbt/meta.ts

@@ -1,15 +0,0 @@
-import { parse_psbt }             from './encoder.js'
-import { finalize_legacy_inputs } from './util.js'
-
-import { PSBTData } from '@/types/index.js'
-
-export function get_vsize (psbt : string | PSBTData) : number {
-  const pdata = parse_psbt(psbt)
-  return pdata.vsize
-}
-
-export function get_txhex (psbt : PSBTData) : string {
-  let pdata = parse_psbt(psbt)
-      pdata = finalize_legacy_inputs(pdata)
-  return pdata.hex
-}

package/src/lib/psbt/util.ts

@@ -1,62 +0,0 @@
-import { Assert }     from '@vbyte/micro-lib'
-import { parse_psbt } from './encoder.js'
-
-import type {
-  PSBTData,
-  PSBTInput,
-  PSBTOutput,
-  PSBTPrevouts
-} from '@/types/index.js'
-
-export function collect_vins (
-  psbt : string | PSBTData
-) : PSBTInput[] {
-  const pdata = parse_psbt(psbt)
-  const count = pdata.inputsLength
-  const vins : PSBTInput[] = []
-  for (let i = 0; i < count; i++) {
-    const vin = pdata.getInput(i)
-    vins.push(vin)
-  }
-  return vins
-}
-
-export function collect_vouts (
-  psbt : string | PSBTData
-) : PSBTOutput[] {
-  const pdata = parse_psbt(psbt)
-  const count = pdata.outputsLength
-  const vouts : PSBTOutput[] = []
-  for (let i = 0; i < count; i++) {
-    const vout = pdata.getOutput(i)
-    vouts.push(vout)
-  }
-  return vouts
-}
-
-export function collect_prevouts (
-  psbt : PSBTData
-) : PSBTPrevouts {
-  const amounts : bigint[]     = [],
-        scripts : Uint8Array[] = []
-  const pdata = parse_psbt(psbt)
-  for (let i = 0; i < pdata.inputsLength; i++) {
-    const txin = pdata.getInput(i)
-    Assert.exists(txin.witnessUtxo, `witness utxo does not exist for input ${i}`)
-    amounts.push(txin.witnessUtxo.amount)
-    scripts.push(txin.witnessUtxo.script)
-  }
-  return { amounts, scripts }
-}
-
-export function finalize_legacy_inputs (pdata : PSBTData) {
-  for (let i = 0; i < pdata.inputsLength; i++) {
-    const pvin   = pdata.getInput(i)
-    const script = pvin.redeemScript
-    const psig   = pvin.partialSig?.at(0)
-    if (script !== undefined && psig !== undefined) {
-      pdata.finalizeIdx(i)
-    }
-  }
-  return pdata
-}

package/src/lib/psbt/validate.ts

@@ -1,18 +0,0 @@
-import { Assert }     from '@vbyte/micro-lib'
-import { parse_psbt } from './encoder.js'
-
-import {
-  collect_vins,
-  collect_vouts
-} from './util.js'
-
-import type { PSBTData } from '@/types/index.js'
-
-export function assert_psbt_is_funded (psbt : string | PSBTData) : void {
-  const pdata   = parse_psbt(psbt)
-  const pvouts  = collect_vins(pdata)
-  const txouts  = collect_vouts(pdata)
-  const vin_amt = pvouts.reduce((p, n) => p + Number(n.witnessUtxo?.amount ?? 0), 0)
-  const out_amt = txouts.reduce((p, n) => p + Number(n.amount ?? 0), 0)
-  Assert.ok(vin_amt >= out_amt, `value in (${vin_amt}) < value out (${out_amt})`)
-}