@btc-vision/bitcoin 6.5.6 → 7.0.0-alpha.0

package/build/transaction.d.ts

@@ -1,15 +1,45 @@
+import type { Bytes32, Satoshi, Script } from './types.js';
+/**
+ * Cache for Taproot sighash intermediate values.
+ * These are identical for all inputs with SIGHASH_ALL, so compute once and reuse.
+ */
+export interface TaprootHashCache {
+    readonly hashPrevouts: Bytes32;
+    readonly hashAmounts: Bytes32;
+    readonly hashScriptPubKeys: Bytes32;
+    readonly hashSequences: Bytes32;
+    readonly hashOutputs: Bytes32;
+}
 export interface Output {
-    script: Buffer;
-    value: number;
+    readonly script: Script;
+    readonly value: Satoshi;
 }
 export interface Input {
-    hash: Buffer;
-    index: number;
-    script: Buffer;
+    readonly hash: Bytes32;
+    readonly index: number;
+    script: Script;
     sequence: number;
-    witness: Buffer[];
+    witness: Uint8Array[];
 }
+/**
+ * Represents a Bitcoin transaction.
+ *
+ * @example
+ * ```typescript
+ * import { Transaction, fromHex } from '@btc-vision/bitcoin';
+ *
+ * // Parse a transaction from hex
+ * const tx = Transaction.fromHex('0100000001...');
+ *
+ * // Create a new transaction
+ * const newTx = new Transaction();
+ * newTx.version = 2;
+ * newTx.addInput(prevTxHash, 0);
+ * newTx.addOutput(scriptPubKey, 50000n);
+ * ```
+ */
 export declare class Transaction {
+    #private;
     static readonly DEFAULT_SEQUENCE = 4294967295;
     static readonly SIGHASH_DEFAULT = 0;
     static readonly SIGHASH_ALL = 1;
@@ -27,25 +57,137 @@ export declare class Transaction {
     locktime: number;
     ins: Input[];
     outs: Output[];
-    static fromBuffer(buffer: Buffer, _NO_STRICT?: boolean): Transaction;
+    /**
+     * Parse a transaction from a Uint8Array buffer.
+     *
+     * @param buffer - The raw transaction bytes
+     * @param _NO_STRICT - If true, allow extra data after transaction
+     * @returns Parsed Transaction instance
+     */
+    static fromBuffer(buffer: Uint8Array, _NO_STRICT?: boolean): Transaction;
+    /**
+     * Parse a transaction from a hex string.
+     *
+     * @param hex - The transaction as a hex string
+     * @returns Parsed Transaction instance
+     */
     static fromHex(hex: string): Transaction;
-    static isCoinbaseHash(buffer: Buffer): boolean;
+    /**
+     * Check if a hash is a coinbase hash (all zeros).
+     *
+     * @param hash - 32-byte hash to check
+     * @returns true if hash is all zeros (coinbase)
+     */
+    static isCoinbaseHash(hash: Bytes32): boolean;
     isCoinbase(): boolean;
-    addInput(hash: Buffer, index: number, sequence?: number, scriptSig?: Buffer): number;
-    addOutput(scriptPubKey: Buffer, value: number): number;
+    /**
+     * Add an input to this transaction.
+     *
+     * @param hash - 32-byte hash of the previous transaction
+     * @param index - Output index in the previous transaction
+     * @param sequence - Sequence number (defaults to 0xffffffff)
+     * @param scriptSig - Input script (defaults to empty)
+     * @returns The index of the newly added input
+     */
+    addInput(hash: Bytes32, index: number, sequence?: number, scriptSig?: Script): number;
+    /**
+     * Add an output to this transaction.
+     *
+     * @param scriptPubKey - Output script (locking script)
+     * @param value - Output value in satoshis (bigint)
+     * @returns The index of the newly added output
+     */
+    addOutput(scriptPubKey: Script, value: Satoshi): number;
     hasWitnesses(): boolean;
     weight(): number;
     virtualSize(): number;
     byteLength(_ALLOW_WITNESS?: boolean): number;
     clone(): Transaction;
-    hashForSignature(inIndex: number, prevOutScript: Buffer, hashType: number): Buffer;
-    hashForWitnessV1(inIndex: number, prevOutScripts: Buffer[], values: number[], hashType: number, leafHash?: Buffer, annex?: Buffer): Buffer;
-    hashForWitnessV0(inIndex: number, prevOutScript: Buffer, value: number, hashType: number): Buffer;
-    getHash(forWitness?: boolean): Buffer;
+    /**
+     * Hash transaction for signing a specific input.
+     *
+     * Bitcoin uses a different hash for each signed transaction input.
+     * This method copies the transaction, makes the necessary changes based on the
+     * hashType, and then hashes the result.
+     * This hash can then be used to sign the provided transaction input.
+     *
+     * @param inIndex - Index of the input being signed
+     * @param prevOutScript - The script of the output being spent
+     * @param hashType - Signature hash type
+     * @returns 32-byte hash for signing
+     */
+    hashForSignature(inIndex: number, prevOutScript: Script, hashType: number): Bytes32;
+    /**
+     * Hash transaction for signing a Taproot (witness v1) input.
+     *
+     * @param inIndex - Index of the input being signed
+     * @param prevOutScripts - Scripts of all inputs being spent
+     * @param values - Values of all inputs being spent (bigint satoshis)
+     * @param hashType - Signature hash type
+     * @param leafHash - Optional leaf hash for script path spending
+     * @param annex - Optional annex data
+     * @returns 32-byte hash for signing
+     */
+    hashForWitnessV1(inIndex: number, prevOutScripts: readonly Script[], values: readonly Satoshi[], hashType: number, leafHash?: Bytes32, annex?: Uint8Array, taprootCache?: TaprootHashCache): Bytes32;
+    /**
+     * Pre-compute intermediate hashes for Taproot signing.
+     * Call this once before signing multiple inputs to avoid O(n^2) performance.
+     *
+     * @param prevOutScripts - Array of previous output scripts for all inputs
+     * @param values - Array of previous output values for all inputs
+     * @returns Cache object to pass to hashForWitnessV1
+     */
+    getTaprootHashCache(prevOutScripts: readonly Script[], values: readonly Satoshi[]): TaprootHashCache;
+    /**
+     * Hash transaction for signing a SegWit v0 (P2WPKH/P2WSH) input.
+     *
+     * @param inIndex - Index of the input being signed
+     * @param prevOutScript - The script of the output being spent
+     * @param value - Value of the output being spent (bigint satoshis)
+     * @param hashType - Signature hash type
+     * @returns 32-byte hash for signing
+     */
+    hashForWitnessV0(inIndex: number, prevOutScript: Script, value: Satoshi, hashType: number): Bytes32;
+    /**
+     * Get the transaction hash.
+     *
+     * @param forWitness - If true, include witness data (wtxid)
+     * @returns 32-byte transaction hash
+     */
+    getHash(forWitness?: boolean): Bytes32;
+    /**
+     * Get the transaction ID (txid) as a hex string.
+     *
+     * @returns Transaction ID in reversed hex format
+     */
     getId(): string;
-    toBuffer(buffer?: Buffer, initialOffset?: number): Buffer;
+    /**
+     * Serialize the transaction to a Uint8Array buffer.
+     *
+     * @param buffer - Optional pre-allocated buffer
+     * @param initialOffset - Optional starting offset in buffer
+     * @returns Serialized transaction bytes
+     */
+    toBuffer(buffer?: Uint8Array, initialOffset?: number): Uint8Array;
+    /**
+     * Serialize the transaction to a hex string.
+     *
+     * @returns Transaction as hex string
+     */
     toHex(): string;
-    setInputScript(index: number, scriptSig: Buffer): void;
-    setWitness(index: number, witness: Buffer[]): void;
-    private __toBuffer;
+    /**
+     * Set the input script for a specific input.
+     *
+     * @param index - Input index
+     * @param scriptSig - The script to set
+     */
+    setInputScript(index: number, scriptSig: Script): void;
+    /**
+     * Set the witness data for a specific input.
+     *
+     * @param index - Input index
+     * @param witness - Array of witness elements
+     */
+    setWitness(index: number, witness: Uint8Array[]): void;
 }
+//# sourceMappingURL=transaction.d.ts.map

package/build/transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../src/transaction.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AA6B3D;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAC/B,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC;IACpC,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAChC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;CACjC;AAED,MAAM,WAAW,MAAM;IACnB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,KAAK;IAClB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,UAAU,EAAE,CAAC;CACzB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,WAAW;;IACpB,MAAM,CAAC,QAAQ,CAAC,gBAAgB,cAAc;IAC9C,MAAM,CAAC,QAAQ,CAAC,eAAe,KAAQ;IACvC,MAAM,CAAC,QAAQ,CAAC,WAAW,KAAQ;IACnC,MAAM,CAAC,QAAQ,CAAC,YAAY,KAAQ;IACpC,MAAM,CAAC,QAAQ,CAAC,cAAc,KAAQ;IACtC,MAAM,CAAC,QAAQ,CAAC,oBAAoB,OAAQ;IAC5C,MAAM,CAAC,QAAQ,CAAC,mBAAmB,KAAQ;IAC3C,MAAM,CAAC,QAAQ,CAAC,kBAAkB,OAAQ;IAC1C,MAAM,CAAC,QAAQ,CAAC,2BAA2B,KAAQ;IACnD,MAAM,CAAC,QAAQ,CAAC,yBAAyB,KAAQ;IAEjD,MAAM,CAAC,QAAQ,CAAC,YAAY,KAAK;IACjC,MAAM,CAAC,QAAQ,CAAC,cAAc,SAAS;IACvC,MAAM,CAAC,QAAQ,CAAC,oBAAoB,QAAQ;IAE5C,OAAO,EAAE,MAAM,CAAK;IACpB,QAAQ,EAAE,MAAM,CAAK;IACrB,GAAG,EAAE,KAAK,EAAE,CAAM;IAClB,IAAI,EAAE,MAAM,EAAE,CAAM;IAEpB;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,WAAW;IA4DxE;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW;IAIxC;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO;IAU7C,UAAU,IAAI,OAAO;IAIrB;;;;;;;;OAQG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM;IA+BrF;;;;;;OAMG;IACH,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,MAAM;IAiBvD,YAAY,IAAI,OAAO;IAMvB,MAAM,IAAI,MAAM;IAMhB,WAAW,IAAI,MAAM;IAIrB,UAAU,CAAC,cAAc,GAAE,OAAc,GAAG,MAAM;IAqBlD,KAAK,IAAI,WAAW;IAyBpB;;;;;;;;;;;;OAYG;IACH,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO;IAmFnF;;;;;;;;;;OAUG;IACH,gBAAgB,CACZ,OAAO,EAAE,MAAM,EACf,cAAc,EAAE,SAAS,MAAM,EAAE,EACjC,MAAM,EAAE,SAAS,OAAO,EAAE,EAC1B,QAAQ,EAAE,MAAM,EAChB,QAAQ,CAAC,EAAE,OAAO,EAClB,KAAK,CAAC,EAAE,UAAU,EAClB,YAAY,CAAC,EAAE,gBAAgB,GAChC,OAAO;IAgKV;;;;;;;OAOG;IACH,mBAAmB,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,OAAO,EAAE,GAAG,gBAAgB;IAiDpG;;;;;;;;OAQG;IACH,gBAAgB,CACZ,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,MAAM,EACrB,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,MAAM,GACjB,OAAO;IA8FV;;;;;OAKG;IACH,OAAO,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO;IAMtC;;;;OAIG;IACH,KAAK,IAAI,MAAM;IAKf;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,UAAU;IAIjE;;;;OAIG;IACH,KAAK,IAAI,MAAM;IAIf;;;;;OAKG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAWtD;;;;;OAKG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,IAAI;CAgEzD"}