@vbyte/btc-dev 1.0.0

package/dist/types/address.d.ts

@@ -0,0 +1,34 @@
+export type AddressFormat = 'base58' | 'bech32' | 'bech32m';
+export type AddressType = 'p2pkh' | 'p2sh' | 'p2w-pkh' | 'p2w-sh' | 'p2tr';
+export type ChainNetwork = 'main' | 'testnet' | 'regtest';
+export type AddressData = AddressContext & ScriptData;
+export type AddressConfigEntry = [
+    prefix: string,
+    type: AddressType,
+    network: ChainNetwork,
+    size: number,
+    format: AddressFormat,
+    version: number
+];
+export interface DecodedAddress {
+    format: AddressFormat;
+    data: Uint8Array;
+    prefix?: string;
+    version?: number;
+}
+export interface AddressConfig {
+    format: AddressFormat;
+    network: ChainNetwork;
+    prefix: string;
+    size: number;
+    type: AddressType;
+    version: number;
+}
+export interface AddressContext extends AddressConfig {
+    data: Uint8Array;
+    hex: string;
+}
+export interface ScriptData {
+    script_asm: string[];
+    script_hex: string;
+}

package/dist/types/address.js

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

package/dist/types/index.d.ts

@@ -0,0 +1,9 @@
+export * from './address.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 './txmeta.js';
+export * from './witness.js';

package/dist/types/index.js

@@ -0,0 +1,9 @@
+export * from './address.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 './txmeta.js';
+export * from './witness.js';

package/dist/types/meta.d.ts

@@ -0,0 +1,10 @@
+export interface InscriptionData {
+    content?: string;
+    delegate?: string;
+    mimetype?: string;
+    opcode?: number;
+    parent?: string;
+    pointer?: number;
+    ref?: string;
+    rune?: string;
+}

package/dist/types/meta.js

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

package/dist/types/psbt.d.ts

@@ -0,0 +1,9 @@
+import type { Transaction } from '@scure/btc-signer';
+import type { TransactionInput, TransactionOutput } from '@scure/btc-signer/psbt';
+export type PSBTData = Transaction;
+export type PSBTInput = TransactionInput;
+export type PSBTOutput = TransactionOutput;
+export interface PSBTPrevouts {
+    amounts: bigint[];
+    scripts: Uint8Array[];
+}

package/dist/types/psbt.js

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

package/dist/types/sighash.d.ts

@@ -0,0 +1,14 @@
+import { TxInput } from './txdata.js';
+export type SigHashType = 'segwit' | 'taproot';
+export interface SigHashOptions {
+    extension?: string;
+    extflag?: number;
+    txindex?: number;
+    key_version?: number;
+    pubkey?: string;
+    script?: string;
+    separator_pos?: number;
+    sigflag?: number;
+    throws?: boolean;
+    txinput?: TxInput;
+}

package/dist/types/sighash.js

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

package/dist/types/taproot.d.ts

@@ -0,0 +1,35 @@
+type Bytes = string | Uint8Array;
+export type TapTree = Array<Bytes | Bytes[]>;
+export type MerkleProof = [
+    root: string,
+    target: string | undefined,
+    path: string[]
+];
+export interface TaprootConfig {
+    pubkey: Bytes;
+    leaves?: TapTree;
+    target?: Bytes;
+    version?: number;
+}
+export interface TaprootContext {
+    cblock: string;
+    int_key: string;
+    parity: number;
+    taproot: string | null;
+    tapkey: string;
+    taptweak: string;
+}
+export interface ControlBlock {
+    int_key: string;
+    parity: number;
+    path: string[];
+    version: number;
+}
+export interface ProofData {
+    cblock: ControlBlock;
+    params: string[];
+    script: string;
+    tapkey: string;
+    tweak: string;
+}
+export {};

package/dist/types/taproot.js

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

package/dist/types/transaction.d.ts

@@ -0,0 +1,81 @@
+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 {
+    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;
+}

package/dist/types/transaction.js

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

package/dist/types/txdata.d.ts

@@ -0,0 +1,45 @@
+export type TxInput = CoinbaseInput | SpendInput | VirtualInput;
+export interface TxOutpoint {
+    txid: string;
+    vout: number;
+}
+export interface TxInputTemplate extends TxOutpoint {
+    coinbase?: string | null;
+    prevout?: TxOutput | null;
+    script_sig?: string | null;
+    sequence?: number;
+    witness?: string[];
+}
+export interface CoinbaseInput extends TxOutpoint {
+    coinbase: string;
+    prevout: null;
+    script_sig: null;
+    sequence: number;
+    witness: string[];
+}
+export interface VirtualInput extends TxOutpoint {
+    coinbase: null;
+    prevout: TxOutput | null;
+    script_sig: string | null;
+    sequence: number;
+    witness: string[];
+}
+export interface SpendInput extends VirtualInput {
+    prevout: TxOutput;
+}
+export interface TxOutput {
+    script_pk: string;
+    value: bigint;
+}
+export interface TxTemplate {
+    locktime?: number;
+    vin?: TxInputTemplate[];
+    vout?: TxOutput[];
+    version?: number;
+}
+export interface TxData {
+    locktime: number;
+    vin: TxInput[];
+    vout: TxOutput[];
+    version: number;
+}

package/dist/types/txdata.js

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

package/dist/types/txmeta.d.ts

@@ -0,0 +1,19 @@
+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';
+}

package/dist/types/txmeta.js

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

package/dist/types/witness.d.ts

@@ -0,0 +1,30 @@
+export type WitnessContext = WitnessInfo | TaprootScript | SegwitScript | TaprootSpend | SegwitSpend;
+export type WitnessVersion = number | null;
+export type WitnessType = 'p2w-pkh' | 'p2w-sh' | 'p2tr-pk' | 'p2tr-ts' | 'unknown';
+export interface WitnessInfo {
+    annex: string | null;
+    cblock: string | null;
+    params: string[];
+    script: string | null;
+    type: WitnessType;
+    version: WitnessVersion;
+}
+export interface TaprootScript extends WitnessInfo {
+    cblock: string;
+    script: string;
+    type: 'p2tr-ts';
+    version: 1;
+}
+export interface SegwitScript extends WitnessInfo {
+    script: string;
+    type: 'p2w-sh';
+    version: 0;
+}
+export interface TaprootSpend extends WitnessInfo {
+    type: 'p2tr-pk';
+    version: 1;
+}
+export interface SegwitSpend extends WitnessInfo {
+    type: 'p2w-pkh';
+    version: 0;
+}

package/dist/types/witness.js

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

package/package.json

@@ -0,0 +1,106 @@
+{
+  "name": "@vbyte/btc-dev",
+  "version": "1.0.0",
+  "description": "Batteries-included toolset for plebian bitcoin development",
+  "type": "module",
+  "keywords": [
+    "bitcoin",
+    "blockchain",
+    "psbt",
+    "transaction",
+    "segwit",
+    "taproot"
+  ],
+  "author": "Christopher Scott",
+  "license": "CC-BY-1.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cmdruid/btc-dev.git"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "files": [
+    "README.md",
+    "LICENSE",
+    "dist",
+    "src"
+  ],
+  "main": "./dist/main.cjs",
+  "module": "./dist/index.js",
+  "unpkg": "./dist/script.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "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"
+    },
+    "./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"
+    },
+    "./sighash": {
+      "types": "./dist/lib/sighash/index.d.ts",
+      "import": "./dist/lib/sighash/index.js"
+    },
+    "./taproot": {
+      "types": "./dist/lib/taproot/index.d.ts",
+      "import": "./dist/lib/taproot/index.js"
+    },
+    "./tx": {
+      "types": "./dist/lib/tx/index.d.ts",
+      "import": "./dist/lib/tx/index.js"
+    }
+  },
+  "scripts": {
+    "build": "./scripts/build.sh",
+    "package": "npm test | faucet && npm run build",
+    "release": "./scripts/release.sh",
+    "scratch": "npm run script test/scratch.ts",
+    "script": "tsx --tsconfig ./test/tsconfig.json",
+    "test": "npm run script test/src/tape.ts"
+  },
+  "dependencies": {
+    "@noble/curves": "^1.9.2",
+    "@noble/hashes": "^1.8.0",
+    "@scure/btc-signer": "^1.8.1",
+    "@vbyte/buff": "^1.0.2",
+    "@vbyte/micro-lib": "^1.0.11",
+    "zod": "^3.25.69"
+  },
+  "devDependencies": {
+    "@cmdcode/core-cmd": "^1.6.5",
+    "@rollup/plugin-commonjs": "^28.0.6",
+    "@rollup/plugin-json": "^6.1.0",
+    "@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/tape": "^5.8.1",
+    "faucet": "^0.0.4",
+    "rollup": "^4.44.1",
+    "tape": "^5.9.0",
+    "tslib": "^2.8.1",
+    "tsx": "^4.20.3",
+    "typescript": "^5.8.3"
+  }
+}

package/src/class/index.ts

@@ -0,0 +1,5 @@
+export * from './signer.js'
+export * from './tx.js'
+export * from './txin.js'
+export * from './txout.js'
+export * from './witness.js'

package/src/class/signer.ts

@@ -0,0 +1,47 @@
+import { Buff, Bytes } from '@vbyte/buff'
+import { ECC }         from '@vbyte/micro-lib'
+
+import {
+  sign_segwit_tx,
+  sign_taproot_tx
+} from '@/lib/sighash/sign.js'
+
+import type {
+  SigHashOptions,
+  TxData
+} from '@/types/index.js'
+
+export class TxSigner {
+  private readonly _seckey : string
+
+  constructor (seckey : Bytes) {
+    this._seckey = Buff.bytes(seckey).hex
+  }
+
+  get pubkey () {
+    return {
+      segwit  : ECC.get_pubkey(this._seckey, 'ecdsa'),
+      taproot : ECC.get_pubkey(this._seckey, 'bip340')
+    }
+  }
+
+  get sign_msg () {
+    return {
+      ecdsa : (msg : Bytes) => {
+        const bytes = Buff.bytes(msg)
+        return ECC.sign_ecdsa(this._seckey, bytes)
+      },
+      bip340 : (msg : Bytes) => {
+        const bytes = Buff.bytes(msg)
+        return ECC.sign_bip340(this._seckey, bytes)
+      }
+    }
+  }
+
+  get sign_tx () {
+    return {
+      segwit  : (tx : TxData, options : SigHashOptions) => sign_segwit_tx(this._seckey, tx, options),
+      taproot : (tx : TxData, options : SigHashOptions) => sign_taproot_tx(this._seckey, tx, options)
+    }
+  }
+}

package/src/class/tx.ts

@@ -0,0 +1,118 @@
+import { TransactionInput }  from './txin.js'
+import { TransactionOutput } from './txout.js'
+
+import {
+  decode_tx_data,
+  get_txid,
+  is_return_script,
+  parse_tx_data,
+  Locktime,
+  get_txsize,
+  get_tx_value,
+  get_txhash,
+  encode_tx_locktime,
+} from '@/lib/tx/index.js'
+
+import type {
+  TxData,
+  TxTemplate,
+  TxSize,
+  TxValue,
+  TransactionData
+} from '@/types/index.js'
+
+export class Transaction {
+
+  private readonly _size  : TxSize
+  private readonly _tx    : TxData
+  private readonly _hash  : string
+  private readonly _value : TxValue
+  private readonly _vin   : TransactionInput[]
+  private readonly _vout  : TransactionOutput[]
+
+  constructor (txdata : string | TxData | TxTemplate) {
+    this._tx = (typeof txdata !== 'string')
+      ? parse_tx_data(txdata)
+      : decode_tx_data(txdata)
+
+    this._vin  = this._tx.vin.map(txin => new TransactionInput(txin))
+    this._vout = this._tx.vout.map(txout => new TransactionOutput(txout))
+
+    this._size  = get_txsize(this._tx)
+    this._hash  = get_txhash(this._tx)
+    this._value = get_tx_value(this._tx)
+  }
+
+  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 hash () : string {
+    return this._hash
+  }
+
+  get locktime () {
+    return {
+      hex   : encode_tx_locktime(this._tx.locktime).hex,
+      data  : Locktime.decode(this._tx.locktime),
+      value : this._tx.locktime
+    }
+  }
+
+  get return () {
+    return this._tx.vout.find(txout => is_return_script(txout.script_pk)) || null
+  }
+
+  get size () {
+    return {
+      ...this._size,
+      segwit  : this._vin.reduce((acc, txin)   => acc + (txin.witness?.vsize ?? 0), 0),
+      vin     : this._vin.reduce((acc, txin)   => acc + txin.size,  0),
+      vout    : this._vout.reduce((acc, txout) => acc + txout.size, 0),
+      witness : this._vin.reduce((acc, txin)   => acc + (txin.witness?.size ?? 0), 0)
+    }
+  }
+
+  get spends () : TransactionOutput[] {
+    return this._tx.vin
+      .filter(txin => txin.prevout !== null)
+      .map(txin => new TransactionOutput(txin.prevout!))
+  }
+
+  get txid () : string {
+    return get_txid(this._tx)
+  }
+
+  get value () {
+    return this._value
+  }
+
+  get version () : number {
+    return this._tx.version
+  }
+
+  get vin () : TransactionInput[] {
+    return this._vin
+  }
+
+  get vout () : TransactionOutput[] {
+    return this._vout
+  }
+
+  toJSON   () { return this.data }
+  toString () { return JSON.stringify(this.data) }
+}
+
+
+