@vbyte/btc-dev 1.1.7 → 2.0.0

package/dist/types/address.d.ts

@@ -1,7 +1,7 @@
-import type { ScriptInfo } from './script.js';
-export type AddressFormat = 'base58' | 'bech32' | 'bech32m';
-export type AddressType = 'p2pkh' | 'p2sh' | 'p2wpkh' | 'p2wsh' | 'p2tr';
-export type ChainNetwork = 'main' | 'testnet' | 'regtest' | string;
+import type { ScriptInfo } from "./script.js";
+export type AddressFormat = "base58" | "bech32" | "bech32m";
+export type AddressType = "p2pkh" | "p2sh" | "p2wpkh" | "p2wsh" | "p2tr";
+export type ChainNetwork = "main" | "testnet" | "regtest" | string;
 export type AddressConfigEntry = [
     prefix: string,
     type: AddressType,

package/dist/types/index.d.ts

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

package/dist/types/index.js

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

package/dist/types/meta.d.ts

@@ -2,20 +2,20 @@ export type LocktimeData = LocktimeStamp | LocktimeHeight;
 export type SequenceConfig = Partial<SequenceData>;
 export type SequenceData = SequenceHeightLock | SequenceStampLock;
 export interface LocktimeStamp {
-    type: 'timelock';
+    type: "timelock";
     stamp: number;
 }
 export interface LocktimeHeight {
-    type: 'heightlock';
+    type: "heightlock";
     height: number;
 }
 export interface SequenceStampLock {
     stamp: number;
-    mode: 'stamp';
+    mode: "stamp";
 }
 export interface SequenceHeightLock {
     height: number;
-    mode: 'height';
+    mode: "height";
 }
 export interface LocktimeField {
     hex: string;

package/dist/types/psbt.d.ts

@@ -1,5 +1,5 @@
-import type { Transaction } from '@scure/btc-signer';
-import type { TransactionInput, TransactionOutput } from '@scure/btc-signer/psbt';
+import type { Transaction } from "@scure/btc-signer";
+import type { TransactionInput, TransactionOutput } from "@scure/btc-signer/psbt.js";
 export type PSBTData = Transaction;
 export type PSBTInput = TransactionInput;
 export type PSBTOutput = TransactionOutput;

package/dist/types/script.d.ts

@@ -1,5 +1,5 @@
-export type LockScriptType = 'p2pkh' | 'p2sh' | 'p2wpkh' | 'p2wsh' | 'p2tr' | 'opreturn';
-export type SpendScriptType = 'p2pkh' | 'p2sh' | 'p2wpkh' | 'p2wsh' | 'p2tr' | 'p2ts';
+export type LockScriptType = "p2pkh" | "p2sh" | "p2wpkh" | "p2wsh" | "p2tr" | "opreturn";
+export type SpendScriptType = "p2pkh" | "p2sh" | "p2wpkh" | "p2wsh" | "p2tr" | "p2ts";
 export type WitnessVersion = 0 | 1 | null;
 export interface ScriptInfo {
     asm: string[];

package/dist/types/sighash.d.ts

@@ -1,5 +1,5 @@
-import { TxInput } from './txdata.js';
-export type SigHashType = 'segwit' | 'taproot';
+import type { TxInput } from "./txdata.js";
+export type SigHashType = "segwit" | "taproot";
 export interface SigHashOptions {
     extension?: string;
     extflag?: number;

package/dist/types/witness.d.ts

@@ -1,4 +1,4 @@
-import type { SpendScriptType, WitnessVersion } from './script.js';
+import type { SpendScriptType, WitnessVersion } from "./script.js";
 export type WitnessContext = WitnessData | TaprootScript | SegwitScript | TaprootSpend | SegwitSpend;
 export interface WitnessSize {
     total: number;
@@ -16,19 +16,19 @@ export interface WitnessData {
 export interface TaprootScript extends WitnessData {
     cblock: string;
     script: string;
-    type: 'p2ts';
+    type: "p2ts";
     version: 1;
 }
 export interface SegwitScript extends WitnessData {
     script: string;
-    type: 'p2wsh';
+    type: "p2wsh";
     version: 0;
 }
 export interface TaprootSpend extends WitnessData {
-    type: 'p2tr';
+    type: "p2tr";
     version: 1;
 }
 export interface SegwitSpend extends WitnessData {
-    type: 'p2wpkh';
+    type: "p2wpkh";
     version: 0;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vbyte/btc-dev",
-  "version": "1.1.7",
+  "version": "2.0.0",
   "description": "Batteries-included toolset for plebian bitcoin development",
   "type": "module",
   "keywords": [
@@ -24,8 +24,8 @@
   "files": [
     "README.md",
     "LICENSE",
-    "dist",
-    "src"
+    "CHANGELOG.md",
+    "dist"
   ],
   "main": "./dist/main.cjs",
   "module": "./dist/index.js",
@@ -33,9 +33,9 @@
   "types": "./dist/types/index.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/types/index.d.ts",
       "import": "./dist/index.js",
-      "default": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "default": "./dist/index.js"
     },
     "./address": {
       "types": "./dist/lib/address/index.d.ts",
@@ -72,6 +72,8 @@
   },
   "scripts": {
     "build": "./scripts/build.sh",
+    "check": "npx tsc --project tsconfig.json --noEmit",
+    "lint": "biome check src/",
     "package": "npm test | faucet && npm run build",
     "release": "./scripts/release.sh",
     "scratch": "npm run script test/scratch.ts",
@@ -79,27 +81,28 @@
     "test": "npm run script test/src/tape.ts"
   },
   "dependencies": {
-    "@noble/curves": "1.9.7",
-    "@noble/hashes": "1.8.0",
-    "@scure/btc-signer": "1.8.1",
-    "@vbyte/buff": "^1.0.2",
+    "@noble/curves": "2.0.1",
+    "@noble/hashes": "2.0.1",
+    "@scure/btc-signer": "2.0.1",
+    "@vbyte/buff": "^1.0.4",
     "@vbyte/micro-lib": "^1.1.2",
-    "zod": "^4.1.5"
+    "zod": "^4.3.5"
   },
   "devDependencies": {
+    "@biomejs/biome": "2.3.12",
     "@cmdcode/core-cmd": "^1.6.5",
-    "@rollup/plugin-commonjs": "^28.0.6",
+    "@rollup/plugin-commonjs": "^29.0.0",
     "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-node-resolve": "^16.0.3",
     "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^12.1.4",
-    "@types/node": "^24.3.1",
+    "@rollup/plugin-typescript": "^12.3.0",
+    "@types/node": "^25.0.10",
     "@types/tape": "^5.8.1",
     "faucet": "^0.0.4",
-    "rollup": "^4.50.1",
+    "rollup": "^4.55.3",
     "tape": "^5.9.0",
     "tslib": "^2.8.1",
-    "tsx": "^4.20.5",
-    "typescript": "^5.9.2"
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3"
   }
 }

package/src/const.ts

@@ -1,61 +0,0 @@
-export const COINBASE = {
-  TXID : '00'.repeat(32),
-  VOUT : 0xFFFFFFFF,
-}
-
-export const DEFAULT = {
-  LOCKTIME : 0,
-  SEQUENCE : 0xFFFFFFFF,
-  VERSION  : 2,
-}
-
-export const TAPLEAF_VERSIONS = [
-  0xc0, 0xc2, 0xc4, 0xc6, 0xc8, 0xca, 0xcc, 0xce,
-  0xd0, 0xd2, 0xd4, 0xd6, 0xd8, 0xda, 0xdc, 0xde,
-  0xe0, 0xe2, 0xe4, 0xe6, 0xe8, 0xea, 0xec, 0xee,
-  0xf0, 0xf2, 0xf4, 0xf6, 0xf8, 0xfa, 0xfc, 0xfe,
-  0x66, 0x7e, 0x80, 0x84, 0x96, 0x98, 0xba, 0xbc,
-  0xbe
-]
-
-export const TAPLEAF_DEFAULT_VERSION = 0xc0
-
-export const LOCK_SCRIPT_TYPE = {
-  P2PKH    : 'p2pkh',
-  P2SH     : 'p2sh',
-  P2WPKH   : 'p2wpkh',
-  P2WSH    : 'p2wsh',
-  P2TR     : 'p2tr',
-  OPRETURN : 'opreturn',
-} as const
-
-export const SPEND_SCRIPT_TYPE = {
-  P2PKH    : 'p2pkh',
-  P2SH     : 'p2sh',
-  P2WPKH   : 'p2wpkh',
-  P2WSH    : 'p2wsh',
-  P2TR     : 'p2tr',
-  P2TS     : 'p2ts',
-} as const
-
-export const LOCK_SCRIPT_REGEX : Record<string, RegExp> = {
-  [LOCK_SCRIPT_TYPE.P2PKH]    : /^76a914[0-9a-f]{40}88ac$/i,
-  [LOCK_SCRIPT_TYPE.P2SH]     : /^a914[0-9a-f]{40}87$/i,
-  [LOCK_SCRIPT_TYPE.P2WPKH]   : /^0014[0-9a-f]{40}$/i,
-  [LOCK_SCRIPT_TYPE.P2WSH]    : /^0020[0-9a-f]{64}$/i,
-  [LOCK_SCRIPT_TYPE.P2TR]     : /^5120[0-9a-f]{64}$/i,
-  [LOCK_SCRIPT_TYPE.OPRETURN] : /^6a[0-9a-f]{2,}$/i,
-} as const
-
-export const SCRIPT_INT_KEY = ''
-
-export const TX_SIZE = {
-  GLOBAL_BASE : 8,
-  GLOBAL_WIT  : 10,
-  TXIN_BASE   : 32 + 4 + 4,
-  TXOUT_BASE  : 8,
-}
-
-export const SIGHASH_DEFAULT = 0x01
-export const SIGHASH_SEGWIT  = [ 0x01, 0x02, 0x03, 0x81, 0x82, 0x83 ]
-export const SIGHASH_TAPROOT = [ 0x00, ...SIGHASH_SEGWIT ]

package/src/index.ts

@@ -1,13 +0,0 @@
-export * as ADDRESS from './lib/address/index.js'
-export * as META    from './lib/meta/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'
-
-export type * from './types/index.js'

package/src/lib/address/api.ts

@@ -1,50 +0,0 @@
-import { Buff, Bytes }          from '@vbyte/buff'
-import { get_lock_script_type } from '@/lib/script/lock.js'
-import { get_address_info }     from './util.js'
-import { LOCK_SCRIPT_TYPE }     from '@/const.js'
-
-import { P2PKH }  from './p2pkh.js'
-import { P2SH }   from './p2sh.js'
-import { P2TR }   from './p2tr.js'
-import { P2WPKH } from './p2wpkh.js'
-import { P2WSH }  from './p2wsh.js'
-
-import type { AddressInfo, ChainNetwork } from '@/types/index.js'
-
-/**
- * Get the address for a given locking script.
- * 
- * @param script - The locking script.
- * @param network - The network to use.
- * @returns The address.
- */
-export function get_address (
-  script  : Bytes,
-  network : ChainNetwork = 'main'
-) : string {
-  // Convert the script into bytes.
-  const bytes = Buff.bytes(script)
-  // Get the address configuration.
-  const type  = get_lock_script_type(bytes)
-  // If the script type is not recognized, throw an error.
-  if (type === null) throw new Error('unknown locking script: ' + bytes.hex)
-  // Create the address based on the script type.
-  switch (type) {
-    case LOCK_SCRIPT_TYPE.P2PKH:
-      return P2PKH.encode_address(script, network)
-    case LOCK_SCRIPT_TYPE.P2SH:
-      return P2SH.encode_address(script, network)
-    case LOCK_SCRIPT_TYPE.P2WPKH:
-      return P2WPKH.encode_address(script, network)
-    case LOCK_SCRIPT_TYPE.P2WSH:
-      return P2WSH.encode_address(script, network)
-    case LOCK_SCRIPT_TYPE.P2TR:
-      return P2TR.encode_address(script, network)
-    default:
-      throw new Error('unknown script type: ' + type)
-  }
-}
-
-export function parse_address (address : string) : AddressInfo {
-  return get_address_info(address)
-}

package/src/lib/address/encode.ts

@@ -1,183 +0,0 @@
-import { Buff } from '@vbyte/buff'
-
-import { Assert, B58chk, Bech32, Bech32m } from '@vbyte/micro-lib'
-
-import type {
-  AddressFormat,
-  EncoderConfig,
-} from '@/types/address.js'
-
-const ENCODING_REGEX = {
-  base58  : /^[13mn2][a-km-zA-HJ-NP-Z1-9]{25,34}$/,
-  bech32  : /^(bc|tb|bcrt)1q[ac-hj-np-z02-9]{6,87}$/,
-  bech32m : /^(bc|tb|bcrt)1p[ac-hj-np-z02-9]{6,87}$/
-}
-
-const VERSION = {
-  bech32  : 0,
-  bech32m : 1
-}
-
-/**
- * Decode an address.
- * 
- * @param address - The address to decode.
- * @returns The decoded address.
- */
-export function decode_address (address : string) : EncoderConfig {
-  // Get the address format.
-  const format = get_address_format(address)
-  // If the format is not found, throw an error.
-  if (format === null) throw new Error('unrecognized address format: ' + format)
-  // Decode the address based on the format.
-  if (format === 'base58')  return base58_decode(address)
-  if (format === 'bech32')  return bech32_decode(address)
-  if (format === 'bech32m') return bech32m_decode(address)
-  // If we didn't find a matching decoder, throw.
-  throw new Error('unable to find a matching address configuration')
-}
-
-/**
- * Encode an address.
- * 
- * @param address - The address to encode.
- * @returns The encoded address as a string, or null if the address is not
- *          recognized.
- */
-export function encode_address (
-  config : EncoderConfig
-) : string {
-  // Encode the address based on the format.
-  if (config.format === 'base58')  return base58_encode(config)
-  if (config.format === 'bech32')  return bech32_encode(config)
-  if (config.format === 'bech32m') return bech32m_encode(config)
-  // If the format is not recognized, throw an error.
-  throw new Error('unrecognized encoding format: ' + config.format)
-}
-
-/**
- * Get the encoding type for a given address.
- * 
- * @param address - The address to get the encoding type for.
- * @returns The encoding type, or null if the address is not recognized.
- */
-function get_address_format (address : string) : AddressFormat | null {
-  // For each encoding type, check if the address matches the regex.
-  for (const [ format, regex ] of Object.entries(ENCODING_REGEX)) {
-    // If the address matches the regex, return the format.
-    if (regex.test(address)) return format as AddressFormat
-    // If the address does not match the regex, continue to the next encoding type.
-  }
-  // If no encoding type matches the address, return null.
-  return null
-}
-
-/**
- * Encode data as a base58 string.
- * 
- * @param config - The encoder configuration.
- * @returns The encoded base58 string.
- */
-function base58_encode (config : EncoderConfig) : string {
-  // Assert the format is correct.
-  Assert.ok(config.format === 'base58', 'encoding mismatch')
-  // Assert the version is specified.
-  Assert.exists(config.version, 'must specify a version')
-  // Convert the data into bytes with a version prefix.
-  const bytes = Buff.join([ config.version, config.data ])
-  // Encode the data as a base58 string.
-  return B58chk.encode(bytes)
-}
-
-/**
- * Decode data as a base58 string.
- * 
- * @param encoded - The base58 string to decode.
- * @returns The decoded data.
- */
-function base58_decode (encoded : string) : EncoderConfig {
-  // Decode the encoded data.
-  const bytes = B58chk.decode(encoded)
-  // Get the data from the decoded bytes.
-  const data  = bytes.slice(1)
-  // Get the version from the decoded bytes.
-  const version = bytes[0]
-  // Return the decoded address.
-  return { data, format: 'base58', version }
-}
-
-/**
- * Encode data as a bech32 string.
- * 
- * @param config - The encoder configuration.
- * @returns The encoded bech32 string.
- */
-function bech32_encode (config : EncoderConfig) : string {
-  // Assert the format is correct.
-  Assert.ok(config.format === 'bech32', 'encoding mismatch')
-  // Assert the prefix is specified.
-  Assert.exists(config.prefix, 'prefix is required')
-  // Convert the data into bytes.
-  const bytes = Buff.bytes(config.data)
-  // Convert the bytes into words.
-  const words = Bech32.to_words(bytes)
-  // Encode the data as a bech32 string.
-  return Bech32.encode(config.prefix, [ VERSION.bech32, ...words ])
-}
-
-/**
- * Decode data as a bech32 string.
- * 
- * @param encoded - The bech32 string to decode.
- * @returns The decoded data.
- */
-function bech32_decode (encoded : string) : EncoderConfig {
-  // Decode the encoded data.
-  const { prefix, words } = Bech32.decode(encoded)
-  // Get the version and rest of the words.
-  const [ version, ...rest ] = words
-  // Assert the version is correct.
-  Assert.ok(version === VERSION.bech32, 'bech32 version mismatch')
-  // Convert the rest of the words into bytes.
-  const data = Bech32.to_bytes(rest)
-  // Return the decoded address.
-  return { data, format: 'bech32', prefix, version }
-}
-
-/**
- * Encode data as a bech32 string.
- * 
- * @param config - The encoder configuration.
- * @returns The encoded bech32 string.
- */
-function bech32m_encode (config : EncoderConfig) : string {
-  // Assert the format is correct.
-  Assert.ok(config.format === 'bech32m', 'encoding mismatch')
-  // Assert the prefix is specified.
-  Assert.exists(config.prefix, 'prefix is required')
-  // Convert the data into bytes.
-  const bytes   = Buff.bytes(config.data)
-  // Convert the bytes into words.
-  const words   = Bech32m.to_words(bytes)
-  // Encode the data as a bech32m string.
-  return Bech32m.encode(config.prefix, [ VERSION.bech32m, ...words ])
-}
-
-/**
- * Decode data as a bech32 string.
- * 
- * @param encoded - The bech32 string to decode.
- * @returns The decoded data.
- */
-function bech32m_decode (encoded : string) : EncoderConfig {
-  // Decode the encoded data.
-  const { prefix, words }    = Bech32m.decode(encoded)
-  // Get the version and rest of the words.
-  const [ version, ...rest ] = words
-  // Assert the version is correct.
-  Assert.ok(version === VERSION.bech32m, 'bech32m version mismatch')
-  // Convert the rest of the words into bytes.
-  const data = Bech32m.to_bytes(rest)
-  // Return the decoded address.
-  return { data, format: 'bech32m', prefix, version }
-}

package/src/lib/address/index.ts

@@ -1,7 +0,0 @@
-export { P2PKH }  from './p2pkh.js'
-export { P2SH }   from './p2sh.js'
-export { P2WPKH } from './p2wpkh.js'
-export { P2WSH }  from './p2wsh.js'
-export { P2TR }   from './p2tr.js'
-
-export * from './api.js'

package/src/lib/address/p2pkh.ts

@@ -1,94 +0,0 @@
-import { Buff, Bytes }        from '@vbyte/buff'
-import { Assert }             from '@vbyte/micro-lib'
-import { hash160 }            from '@vbyte/micro-lib/hash'
-import { encode_address }     from './encode.js'
-import { is_p2pkh_script }    from '@/lib/script/lock.js'
-import { LOCK_SCRIPT_TYPE }   from '@/const.js'
-
-import {
-  get_address_config,
-  get_address_info
-} from './util.js'
-
-import type {
-  AddressInfo,
-  ChainNetwork
-} from '@/types/index.js'
-
-const ADDRESS_TYPE = LOCK_SCRIPT_TYPE.P2PKH
-
-export namespace P2PKH {
-  export const create_address = create_p2pkh_address
-  export const create_script  = create_p2pkh_script
-  export const encode_address = encode_p2pkh_address
-  export const encode_script  = encode_p2pkh_script
-  export const decode_address = decode_p2pkh_address
-  export const decode_script  = decode_p2pkh_script
-}
-
-function create_p2pkh_address (
-  pubkey  : Bytes,
-  network : ChainNetwork = 'main',
-) : string {
-  // Create the p2pkh script.
-  const script = create_p2pkh_script(pubkey)
-  // Encode the script as an address.
-  return encode_p2pkh_address(script, network)
-}
-
-function create_p2pkh_script (pubkey : Bytes) : Buff {
-  // Convert the public key into bytes.
-  const bytes = Buff.bytes(pubkey)
-  // Assert the public key is 33 bytes.
-  Assert.size(bytes, 33, 'invalid pubkey size')
-  // Convert the bytes into a hash.
-  const hash = hash160(bytes)
-  // Return the script.
-  return encode_p2pkh_script(hash)
-}
-
-function encode_p2pkh_script (pk_hash : Bytes) : Buff {
-  return Buff.join([ '76a914', pk_hash, '88ac' ])
-}
-
-function encode_p2pkh_address (
-  script  : Bytes,
-  network : ChainNetwork = 'main',
-) : string {
-  // Get the public key hash from the script.
-  const pk_hash = decode_p2pkh_script(script)
-  // Get the address configuration.
-  const config  = get_address_config(network, ADDRESS_TYPE)
-  // Assert the configuration exists.
-  Assert.exists(config,           `unrecognized address config: ${ADDRESS_TYPE} on ${network}` )
-  // Assert the payload size is correct.
-  Assert.size(pk_hash, config.size, `invalid payload size: ${pk_hash.length} !== ${config.size}` )
-  // Encode the address.
-  return encode_address({
-    data    : pk_hash,
-    format  : 'base58',
-    version : config.version
-  })
-}
-
-function decode_p2pkh_address (
-  address : string
-) : AddressInfo {
-  // Parse the address.
-  const parsed = get_address_info(address)
-  // Assert the address type is correct.
-  Assert.ok(parsed.type === 'p2pkh', `address type mismatch: ${parsed.type} !== ${ADDRESS_TYPE}`)
-  // Return the parsed address.
-  return parsed
-}
-
-function decode_p2pkh_script (
-  script  : Bytes,
-) : Buff {
-  // Convert the script into bytes.
-  const bytes = Buff.bytes(script)
-  // Assert the script is a p2pkh script.
-  Assert.ok(is_p2pkh_script(script), `invalid p2pkh script`)
-  // Return the public key hash from the script.
-  return bytes.slice(3, 23)
-}