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

package/browser/psbt.d.ts

@@ -1,34 +1,58 @@
-import { Psbt as PsbtBase } from 'bip174';
-import { KeyValue, PartialSig, PsbtGlobal, PsbtGlobalUpdate, PsbtInput, PsbtInputUpdate, PsbtOutput, PsbtOutputUpdate } from 'bip174/src/lib/interfaces.js';
+import { KeyValue, PartialSig, PsbtGlobalUpdate, PsbtInput, PsbtInputUpdate, PsbtOutputUpdate } from 'bip174';
 import { BIP32Interface } from '@btc-vision/bip32';
 import { ECPairInterface } from 'ecpair';
-import { Network } from './networks.js';
 import { Transaction } from './transaction.js';
-export interface TransactionInput {
-    hash: string | Buffer;
-    index: number;
-    sequence?: number;
-}
-export interface PsbtTxInput extends TransactionInput {
-    hash: Buffer;
-}
-export interface TransactionOutput {
-    script: Buffer;
-    value: number;
-}
-export interface PsbtTxOutput extends TransactionOutput {
-    address: string | undefined;
-}
-export type ValidateSigFunction = (pubkey: Buffer, msghash: Buffer, signature: Buffer) => boolean;
-export interface PsbtBaseExtended extends Omit<PsbtBase, 'inputs'> {
-    inputs: PsbtInput[];
-    globalMap: PsbtGlobal;
-}
+import { Bytes32, PublicKey, Script } from './types.js';
+import { AllScriptType, FinalScriptsFunc, FinalTaprootScriptsFunc, HDSigner, HDSignerAsync, PsbtBaseExtended, PsbtCache, PsbtInputExtended, PsbtOpts, PsbtOptsOptional, PsbtOutputExtended, PsbtTxInput, PsbtTxOutput, Signer, SignerAlternative, SignerAsync, TaprootHashCheckSigner, ValidateSigFunction } from './psbt/types.js';
+export type { TransactionInput, PsbtTxInput, TransactionOutput, PsbtTxOutput, ValidateSigFunction, PsbtBaseExtended, PsbtOptsOptional, PsbtOpts, PsbtInputExtended, PsbtOutputExtended, PsbtOutputExtendedAddress, PsbtOutputExtendedScript, HDSigner, HDSignerAsync, SignerAlternative, Signer, SignerAsync, TaprootHashCheckSigner, PsbtCache, TxCacheNumberKey, ScriptType, AllScriptType, GetScriptReturn, FinalScriptsFunc, FinalTaprootScriptsFunc, } from './psbt/types.js';
+/**
+ * Psbt class can parse and generate a PSBT binary based off of the BIP174.
+ * There are 6 roles that this class fulfills. (Explained in BIP174)
+ *
+ * Creator: This can be done with `new Psbt()`
+ *
+ * Updater: This can be done with `psbt.addInput(input)`, `psbt.addInputs(inputs)`,
+ *   `psbt.addOutput(output)`, `psbt.addOutputs(outputs)` when you are looking to
+ *   add new inputs and outputs to the PSBT, and `psbt.updateGlobal(itemObject)`,
+ *   `psbt.updateInput(itemObject)`, `psbt.updateOutput(itemObject)`
+ *   addInput requires hash: Uint8Array | string; and index: number; as attributes
+ *   and can also include any attributes that are used in updateInput method.
+ *   addOutput requires script: Uint8Array; and value: bigint; and likewise can include
+ *   data for updateOutput.
+ *   For a list of what attributes should be what types. Check the bip174 library.
+ *   Also, check the integration tests for some examples of usage.
+ *
+ * Signer: There are a few methods. signAllInputs and signAllInputsAsync, which will search all input
+ *   information for your pubkey or pubkeyhash, and only sign inputs where it finds
+ *   your info. Or you can explicitly sign a specific input with signInput and
+ *   signInputAsync. For the async methods you can create a SignerAsync object
+ *   and use something like a hardware wallet to sign with. (You must implement this)
+ *
+ * Combiner: psbts can be combined easily with `psbt.combine(psbt2, psbt3, psbt4 ...)`
+ *   the psbt calling combine will always have precedence when a conflict occurs.
+ *   Combine checks if the internal bitcoin transaction is the same, so be sure that
+ *   all sequences, version, locktime, etc. are the same before combining.
+ *
+ * Input Finalizer: This role is fairly important. Not only does it need to construct
+ *   the input scriptSigs and witnesses, but it SHOULD verify the signatures etc.
+ *   Before running `psbt.finalizeAllInputs()` please run `psbt.validateSignaturesOfAllInputs()`
+ *   Running any finalize method will delete any data in the input(s) that are no longer
+ *   needed due to the finalized scripts containing the information.
+ *
+ * Transaction Extractor: This role will perform some checks before returning a
+ *   Transaction object. Such as fee rate not being larger than maximumFeeRate etc.
+ */
+/**
+ * Psbt class can parse and generate a PSBT binary based off of the BIP174.
+ */
 export declare class Psbt {
+    #private;
     data: PsbtBaseExtended;
-    private readonly __CACHE;
-    private readonly opts;
     constructor(opts?: PsbtOptsOptional, data?: PsbtBaseExtended);
+    /** @internal - Exposed for testing. Do not use in production code. */
+    get __CACHE(): PsbtCache;
+    /** @internal - Exposed for testing. Do not use in production code. */
+    get opts(): PsbtOpts;
     get inputCount(): number;
     get version(): number;
     set version(version: number);
@@ -38,7 +62,7 @@ export declare class Psbt {
     get txOutputs(): PsbtTxOutput[];
     static fromBase64(data: string, opts?: PsbtOptsOptional): Psbt;
     static fromHex(data: string, opts?: PsbtOptsOptional): Psbt;
-    static fromBuffer(buffer: Buffer, opts?: PsbtOptsOptional): Psbt;
+    static fromBuffer(buffer: Uint8Array, opts?: PsbtOptsOptional): Psbt;
     combine(...those: Psbt[]): this;
     clone(): Psbt;
     setMaximumFeeRate(satoshiPerByte: number): void;
@@ -48,32 +72,43 @@ export declare class Psbt {
     setInputSequence(inputIndex: number, sequence: number): this;
     addInputs(inputDatas: PsbtInputExtended[], checkPartialSigs?: boolean): this;
     addInput(inputData: PsbtInputExtended, checkPartialSigs?: boolean): this;
-    addOutputs(outputDatas: PsbtOutputExtended[]): this;
-    addOutput(outputData: PsbtOutputExtended): this;
+    addOutputs(outputDatas: PsbtOutputExtended[], checkPartialSigs?: boolean): this;
+    /**
+     * Add an output to the PSBT.
+     *
+     * **PERFORMANCE WARNING:** Passing an `address` string is ~10x slower than passing
+     * a `script` directly due to address parsing overhead (bech32 decode, etc.).
+     * For high-performance use cases with many outputs, pre-compute the script using
+     * `toOutputScript(address, network)` and pass `{ script, value }` instead.
+     *
+     * @param outputData - Output data with either `address` or `script`, and `value`
+     * @param checkPartialSigs - Whether to check for existing signatures (default: true)
+     */
+    addOutput(outputData: PsbtOutputExtended, checkPartialSigs?: boolean): this;
     extractTransaction(disableFeeCheck?: boolean, disableOutputChecks?: boolean): Transaction;
     getFeeRate(disableOutputChecks?: boolean): number;
     getFee(disableOutputChecks?: boolean): number;
     finalizeAllInputs(): this;
     finalizeInput(inputIndex: number, finalScriptsFunc?: FinalScriptsFunc | FinalTaprootScriptsFunc, canRunChecks?: boolean): this;
-    finalizeTaprootInput(inputIndex: number, tapLeafHashToFinalize?: Buffer, finalScriptsFunc?: FinalTaprootScriptsFunc): this;
+    finalizeTaprootInput(inputIndex: number, tapLeafHashToFinalize?: Bytes32, finalScriptsFunc?: FinalTaprootScriptsFunc): this;
     getInputType(inputIndex: number): AllScriptType;
-    inputHasPubkey(inputIndex: number, pubkey: Buffer): boolean;
+    inputHasPubkey(inputIndex: number, pubkey: PublicKey): boolean;
     inputHasHDKey(inputIndex: number, root: HDSigner): boolean;
-    outputHasPubkey(outputIndex: number, pubkey: Buffer): boolean;
+    outputHasPubkey(outputIndex: number, pubkey: PublicKey): boolean;
     outputHasHDKey(outputIndex: number, root: HDSigner): boolean;
     validateSignaturesOfAllInputs(validator: ValidateSigFunction): boolean;
-    validateSignaturesOfInput(inputIndex: number, validator: ValidateSigFunction, pubkey?: Buffer): boolean;
+    validateSignaturesOfInput(inputIndex: number, validator: ValidateSigFunction, pubkey?: PublicKey): boolean;
     signAllInputsHD(hdKeyPair: HDSigner, sighashTypes?: number[]): this;
     signAllInputsHDAsync(hdKeyPair: HDSigner | HDSignerAsync, sighashTypes?: number[]): Promise<void>;
     signInputHD(inputIndex: number, hdKeyPair: HDSigner, sighashTypes?: number[]): this;
     signInputHDAsync(inputIndex: number, hdKeyPair: HDSigner | HDSignerAsync, sighashTypes?: number[]): Promise<void>;
     signAllInputs(keyPair: Signer | SignerAlternative | BIP32Interface | ECPairInterface, sighashTypes?: number[]): this;
     signAllInputsAsync(keyPair: Signer | SignerAlternative | SignerAsync | BIP32Interface | ECPairInterface, sighashTypes?: number[]): Promise<void>;
-    signInput(inputIndex: number, keyPair: Signer | SignerAlternative | BIP32Interface | ECPairInterface, sighashTypes?: number[]): this;
-    signTaprootInput(inputIndex: number, keyPair: Signer | SignerAlternative | BIP32Interface | ECPairInterface, tapLeafHashToSign?: Buffer, sighashTypes?: number[]): this;
-    signInputAsync(inputIndex: number, keyPair: Signer | SignerAlternative | SignerAsync | BIP32Interface | ECPairInterface, sighashTypes?: number[]): Promise<void>;
-    signTaprootInputAsync(inputIndex: number, keyPair: Signer | SignerAlternative | SignerAsync | BIP32Interface | ECPairInterface, tapLeafHash?: Buffer, sighashTypes?: number[]): Promise<void>;
-    toBuffer(): Buffer;
+    signInput(inputIndex: number, keyPair: Signer | SignerAlternative | HDSigner | BIP32Interface | ECPairInterface, sighashTypes?: number[]): this;
+    signTaprootInput(inputIndex: number, keyPair: Signer | SignerAlternative | HDSigner | BIP32Interface | ECPairInterface, tapLeafHashToSign?: Uint8Array, sighashTypes?: number[]): this;
+    signInputAsync(inputIndex: number, keyPair: Signer | SignerAlternative | SignerAsync | HDSigner | HDSignerAsync | BIP32Interface | ECPairInterface, sighashTypes?: number[]): Promise<void>;
+    signTaprootInputAsync(inputIndex: number, keyPair: Signer | SignerAlternative | SignerAsync | HDSigner | HDSignerAsync | BIP32Interface | ECPairInterface, tapLeafHash?: Uint8Array, sighashTypes?: number[]): Promise<void>;
+    toBuffer(): Uint8Array;
     toHex(): string;
     toBase64(): string;
     updateGlobal(updateData: PsbtGlobalUpdate): this;
@@ -83,88 +118,17 @@ export declare class Psbt {
     addUnknownKeyValToInput(inputIndex: number, keyVal: KeyValue): this;
     addUnknownKeyValToOutput(outputIndex: number, keyVal: KeyValue): this;
     clearFinalizedInput(inputIndex: number): this;
-    checkTaprootHashesForSig(inputIndex: number, input: PsbtInput, keyPair: Signer | SignerAlternative | SignerAsync | BIP32Interface | ECPairInterface, tapLeafHashToSign?: Buffer, allowedSighashTypes?: number[]): {
-        hash: Buffer;
-        leafHash?: Buffer;
+    checkTaprootHashesForSig(inputIndex: number, input: PsbtInput, keyPair: Signer | SignerAlternative | SignerAsync | HDSigner | HDSignerAsync | TaprootHashCheckSigner | BIP32Interface | ECPairInterface, tapLeafHashToSign?: Uint8Array, allowedSighashTypes?: number[]): {
+        hash: Bytes32;
+        leafHash?: Bytes32;
     }[];
-    private _finalizeInput;
-    private _finalizeTaprootInput;
-    private _validateSignaturesOfInput;
-    private validateSignaturesOfTaprootInput;
-    private _signInput;
-    private _signTaprootInput;
-    private _signInputAsync;
-    private _signTaprootInputAsync;
-}
-export interface PsbtOptsOptional {
-    network?: Network;
-    maximumFeeRate?: number;
-    version?: 1 | 2 | 3;
-}
-export interface PsbtOpts {
-    network: Network;
-    maximumFeeRate: number;
-}
-export interface PsbtInputExtended extends PsbtInput, TransactionInput {
-    isPayToAnchor?: boolean;
-}
-export type PsbtOutputExtended = PsbtOutputExtendedAddress | PsbtOutputExtendedScript;
-export interface PsbtOutputExtendedAddress extends PsbtOutput {
-    address: string;
-    value: number;
 }
-export interface PsbtOutputExtendedScript extends PsbtOutput {
-    script: Buffer;
-    value: number;
-}
-interface HDSignerBase {
-    publicKey: Buffer;
-    fingerprint: Buffer;
-}
-export interface HDSigner extends HDSignerBase {
-    derivePath(path: string): HDSigner;
-    sign(hash: Buffer): Buffer;
-}
-export interface HDSignerAsync extends HDSignerBase {
-    derivePath(path: string): HDSignerAsync;
-    sign(hash: Buffer): Promise<Buffer>;
-}
-export interface SignerAlternative {
-    publicKey: Buffer;
-    lowR: boolean;
-    sign(hash: Buffer, lowR?: boolean): Buffer;
-    verify(hash: Buffer, signature: Buffer): boolean;
-    signSchnorr(hash: Buffer): Buffer;
-    verifySchnorr(hash: Buffer, signature: Buffer): boolean;
-}
-export interface Signer {
-    publicKey: Buffer;
-    network?: Network;
-    sign(hash: Buffer, lowR?: boolean): Buffer;
-    signSchnorr?(hash: Buffer): Buffer;
-    getPublicKey?(): Buffer;
-}
-export interface SignerAsync {
-    publicKey: Buffer;
-    network?: Network;
-    sign(hash: Buffer, lowR?: boolean): Promise<Buffer>;
-    signSchnorr?(hash: Buffer): Promise<Buffer>;
-    getPublicKey?(): Buffer;
-}
-type FinalScriptsFunc = (inputIndex: number, input: PsbtInput, script: Buffer, isSegwit: boolean, isP2SH: boolean, isP2WSH: boolean, canRunChecks: boolean) => {
-    finalScriptSig: Buffer | undefined;
-    finalScriptWitness: Buffer | undefined;
-};
-type FinalTaprootScriptsFunc = (inputIndex: number, input: PsbtInput, tapLeafHashToFinalize?: Buffer) => {
-    finalScriptWitness: Buffer | undefined;
-};
-export declare function getFinalScripts(inputIndex: number, input: PsbtInput, script: Buffer, isSegwit: boolean, isP2SH: boolean, isP2WSH: boolean, canRunChecks?: boolean, solution?: Buffer[]): {
-    finalScriptSig: Buffer | undefined;
-    finalScriptWitness: Buffer | undefined;
+export declare function getFinalScripts(inputIndex: number, input: PsbtInput, script: Script, isSegwit: boolean, isP2SH: boolean, isP2WSH: boolean, canRunChecks?: boolean, solution?: Uint8Array[]): {
+    finalScriptSig: Script | undefined;
+    finalScriptWitness: Uint8Array | undefined;
 };
-export declare function prepareFinalScripts(script: Buffer, scriptType: string, partialSig: PartialSig[], isSegwit: boolean, isP2SH: boolean, isP2WSH: boolean, solution?: Buffer[]): {
-    finalScriptSig: Buffer | undefined;
-    finalScriptWitness: Buffer | undefined;
+export declare function prepareFinalScripts(script: Uint8Array, scriptType: string, partialSig: PartialSig[], isSegwit: boolean, isP2SH: boolean, isP2WSH: boolean, solution?: Uint8Array[]): {
+    finalScriptSig: Script | undefined;
+    finalScriptWitness: Uint8Array | undefined;
 };
-type AllScriptType = 'witnesspubkeyhash' | 'pubkeyhash' | 'multisig' | 'pubkey' | 'nonstandard' | 'p2sh-witnesspubkeyhash' | 'p2sh-pubkeyhash' | 'p2sh-multisig' | 'p2sh-pubkey' | 'p2sh-nonstandard' | 'p2wsh-pubkeyhash' | 'p2wsh-multisig' | 'p2wsh-pubkey' | 'p2wsh-nonstandard' | 'p2sh-p2wsh-pubkeyhash' | 'p2sh-p2wsh-multisig' | 'p2sh-p2wsh-pubkey' | 'p2sh-p2wsh-nonstandard';
-export {};
+//# sourceMappingURL=psbt.d.ts.map

package/browser/psbt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"psbt.d.ts","sourceRoot":"","sources":["../src/psbt.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAER,QAAQ,EACR,UAAU,EACV,gBAAgB,EAChB,SAAS,EACT,eAAe,EAEf,gBAAgB,EAKnB,MAAM,QAAQ,CAAC;AAIhB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AAuC9C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,KAAK,EAER,OAAO,EACP,SAAS,EAGT,MAAM,EAGT,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EACR,aAAa,EACb,gBAAgB,EAChB,uBAAuB,EAEvB,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,SAAS,EACT,iBAAiB,EACjB,QAAQ,EACR,gBAAgB,EAChB,kBAAkB,EAElB,WAAW,EACX,YAAY,EACZ,MAAM,EACN,iBAAiB,EACjB,WAAW,EACX,sBAAsB,EAItB,mBAAmB,EACtB,MAAM,iBAAiB,CAAC;AAGzB,YAAY,EACR,gBAAgB,EAChB,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,mBAAmB,EACnB,gBAAgB,EAChB,gBAAgB,EAChB,QAAQ,EACR,iBAAiB,EACjB,kBAAkB,EAClB,yBAAyB,EACzB,wBAAwB,EACxB,QAAQ,EACR,aAAa,EACb,iBAAiB,EACjB,MAAM,EACN,WAAW,EACX,sBAAsB,EACtB,SAAS,EACT,gBAAgB,EAChB,UAAU,EACV,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,uBAAuB,GAC1B,MAAM,iBAAiB,CAAC;AAmBzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH;;GAEG;AACH,qBAAa,IAAI;;IAMF,IAAI,EAAE,gBAAgB;gBAD7B,IAAI,GAAE,gBAAqB,EACpB,IAAI,GAAE,gBAAsD;IAkBvE,sEAAsE;IACtE,IAAI,OAAO,IAAI,SAAS,CAEvB;IAED,sEAAsE;IACtE,IAAI,IAAI,IAAI,QAAQ,CAEnB;IAED,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,IAAI,OAAO,CAAC,OAAO,EAAE,MAAM,EAE1B;IAED,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED,IAAI,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAE5B;IAED,IAAI,QAAQ,IAAI,WAAW,EAAE,CAM5B;IAED,IAAI,SAAS,IAAI,YAAY,EAAE,CAY9B;IAED,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,gBAAqB,GAAG,IAAI;IAKlE,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,gBAAqB,GAAG,IAAI;IAK/D,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,GAAE,gBAAqB,GAAG,IAAI;IAgBxE,OAAO,CAAC,GAAG,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI;IAK/B,KAAK,IAAI,IAAI;IAMb,iBAAiB,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI;IAK/C,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IASjC,cAAc,IAAI,IAAI;IAItB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IASnC,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAY5D,SAAS,CAAC,UAAU,EAAE,iBAAiB,EAAE,EAAE,gBAAgB,GAAE,OAAc,GAAG,IAAI;IAKlF,QAAQ,CAAC,SAAS,EAAE,iBAAiB,EAAE,gBAAgB,GAAE,OAAc,GAAG,IAAI;IAgD9E,UAAU,CAAC,WAAW,EAAE,kBAAkB,EAAE,EAAE,gBAAgB,GAAE,OAAc,GAAG,IAAI;IAKrF;;;;;;;;;;OAUG;IACH,SAAS,CAAC,UAAU,EAAE,kBAAkB,EAAE,gBAAgB,GAAE,OAAc,GAAG,IAAI;IA6BjF,kBAAkB,CAAC,eAAe,CAAC,EAAE,OAAO,EAAE,mBAAmB,CAAC,EAAE,OAAO,GAAG,WAAW;IAkBzF,UAAU,CAAC,mBAAmB,GAAE,OAAe,GAAG,MAAM;IAUxD,MAAM,CAAC,mBAAmB,GAAE,OAAe,GAAG,MAAM;IAIpD,iBAAiB,IAAI,IAAI;IAMzB,aAAa,CACT,UAAU,EAAE,MAAM,EAClB,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,uBAAuB,EAC7D,YAAY,CAAC,EAAE,OAAO,GACvB,IAAI;IAkBP,oBAAoB,CAChB,UAAU,EAAE,MAAM,EAClB,qBAAqB,CAAC,EAAE,OAAO,EAC/B,gBAAgB,GAAE,uBAA4C,GAC/D,IAAI;IAYP,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,aAAa;IAe/C,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,OAAO;IAK9D,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,OAAO;IAM1D,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,OAAO;IAKhE,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,OAAO;IAM5D,6BAA6B,CAAC,SAAS,EAAE,mBAAmB,GAAG,OAAO;IAQtE,yBAAyB,CACrB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,mBAAmB,EAC9B,MAAM,CAAC,EAAE,SAAS,GACnB,OAAO;IAQV,eAAe,CAAC,SAAS,EAAE,QAAQ,EAAE,YAAY,GAAE,MAAM,EAA8B,GAAG,IAAI;IAoB9F,oBAAoB,CAChB,SAAS,EAAE,QAAQ,GAAG,aAAa,EACnC,YAAY,GAAE,MAAM,EAA8B,GACnD,OAAO,CAAC,IAAI,CAAC;IA6BhB,WAAW,CACP,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,QAAQ,EACnB,YAAY,GAAE,MAAM,EAA8B,GACnD,IAAI;IASP,gBAAgB,CACZ,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,QAAQ,GAAG,aAAa,EACnC,YAAY,GAAE,MAAM,EAA8B,GACnD,OAAO,CAAC,IAAI,CAAC;IAiBhB,aAAa,CACT,OAAO,EAAE,MAAM,GAAG,iBAAiB,GAAG,cAAc,GAAG,eAAe,EACtE,YAAY,CAAC,EAAE,MAAM,EAAE,GACxB,IAAI;IAqBP,kBAAkB,CACd,OAAO,EAAE,MAAM,GAAG,iBAAiB,GAAG,WAAW,GAAG,cAAc,GAAG,eAAe,EACpF,YAAY,CAAC,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,IAAI,CAAC;IA+BhB,SAAS,CACL,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,GAAG,iBAAiB,GAAG,QAAQ,GAAG,cAAc,GAAG,eAAe,EACjF,YAAY,CAAC,EAAE,MAAM,EAAE,GACxB,IAAI;IAaP,gBAAgB,CACZ,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,GAAG,iBAAiB,GAAG,QAAQ,GAAG,cAAc,GAAG,eAAe,EACjF,iBAAiB,CAAC,EAAE,UAAU,EAC9B,YAAY,CAAC,EAAE,MAAM,EAAE,GACxB,IAAI;IAmBP,cAAc,CACV,UAAU,EAAE,MAAM,EAClB,OAAO,EACD,MAAM,GACN,iBAAiB,GACjB,WAAW,GACX,QAAQ,GACR,aAAa,GACb,cAAc,GACd,eAAe,EACrB,YAAY,CAAC,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,IAAI,CAAC;IAkBhB,qBAAqB,CACjB,UAAU,EAAE,MAAM,EAClB,OAAO,EACD,MAAM,GACN,iBAAiB,GACjB,WAAW,GACX,QAAQ,GACR,aAAa,GACb,cAAc,GACd,eAAe,EACrB,WAAW,CAAC,EAAE,UAAU,EACxB,YAAY,CAAC,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,IAAI,CAAC;IAkBhB,QAAQ,IAAI,UAAU;IAKtB,KAAK,IAAI,MAAM;IAKf,QAAQ,IAAI,MAAM;IAKlB,YAAY,CAAC,UAAU,EAAE,gBAAgB,GAAG,IAAI;IAKhD,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,GAAG,IAAI;IAuBlE,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,gBAAgB,GAAG,IAAI;IAQrE,wBAAwB,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI;IAKhD,uBAAuB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAG,IAAI;IAKnE,wBAAwB,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAG,IAAI;IAKrE,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAK7C,wBAAwB,CACpB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,SAAS,EAChB,OAAO,EACD,MAAM,GACN,iBAAiB,GACjB,WAAW,GACX,QAAQ,GACR,aAAa,GACb,sBAAsB,GACtB,cAAc,GACd,eAAe,EACrB,iBAAiB,CAAC,EAAE,UAAU,EAC9B,mBAAmB,CAAC,EAAE,MAAM,EAAE,GAC/B;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,EAAE;CAqY7C;AAiKD,wBAAgB,eAAe,CAC3B,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,SAAS,EAChB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,OAAO,EACjB,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,OAAO,EAChB,YAAY,GAAE,OAAc,EAC5B,QAAQ,CAAC,EAAE,UAAU,EAAE,GACxB;IACC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,kBAAkB,EAAE,UAAU,GAAG,SAAS,CAAC;CAC9C,CAgBA;AAED,wBAAgB,mBAAmB,CAC/B,MAAM,EAAE,UAAU,EAClB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,UAAU,EAAE,EACxB,QAAQ,EAAE,OAAO,EACjB,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,OAAO,EAChB,QAAQ,CAAC,EAAE,UAAU,EAAE,GACxB;IACC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,kBAAkB,EAAE,UAAU,GAAG,SAAS,CAAC;CAC9C,CAsCA"}

package/browser/pubkey.d.ts

@@ -1,8 +1,29 @@
-export declare const toXOnly: (pubKey: Buffer | Uint8Array) => Buffer;
+import { PublicKey, XOnlyPublicKey } from './types.js';
+/**
+ * Converts a public key to x-only format (32 bytes).
+ * @param pubKey - The public key buffer (33 or 65 bytes)
+ * @returns The x-only public key (32 bytes)
+ */
+export declare const toXOnly: (pubKey: PublicKey | XOnlyPublicKey) => XOnlyPublicKey;
 export interface UncompressedPublicKey {
-    hybrid: Buffer;
-    uncompressed: Buffer;
+    hybrid: Uint8Array;
+    uncompressed: Uint8Array;
 }
-export declare function bigIntTo32Bytes(num: bigint): Buffer;
-export declare function decompressPublicKey(realPubKey: Uint8Array | Buffer): UncompressedPublicKey | undefined;
-export declare function pubkeysMatch(a: Buffer, b: Buffer): boolean;
+/**
+ * Converts bigint to 32-byte Uint8Array.
+ */
+export declare function bigIntTo32Bytes(num: bigint): Uint8Array;
+/**
+ * Converts an existing real Bitcoin public key (compressed or uncompressed)
+ * to its "hybrid" form (prefix 0x06/0x07), then derives a P2PKH address from it.
+ *
+ * @param realPubKey - 33-byte compressed (0x02/0x03) or 65-byte uncompressed (0x04) pubkey
+ * @returns UncompressedPublicKey | undefined
+ */
+export declare function decompressPublicKey(realPubKey: PublicKey): UncompressedPublicKey | undefined;
+/**
+ * Compare two potential pubkey Uint8Arrays, treating hybrid keys (0x06/0x07)
+ * as equivalent to uncompressed (0x04).
+ */
+export declare function pubkeysMatch(a: Uint8Array, b: Uint8Array): boolean;
+//# sourceMappingURL=pubkey.d.ts.map

package/browser/pubkey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pubkey.d.ts","sourceRoot":"","sources":["../src/pubkey.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5D;;;;GAIG;AACH,eAAO,MAAM,OAAO,GAAI,QAAQ,SAAS,GAAG,cAAc,KAAG,cAE5D,CAAC;AAEF,MAAM,WAAW,qBAAqB;IAClC,MAAM,EAAE,UAAU,CAAC;IACnB,YAAY,EAAE,UAAU,CAAC;CAC5B;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAOvD;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,SAAS,GAAG,qBAAqB,GAAG,SAAS,CAoC5F;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,GAAG,OAAO,CAclE"}

package/browser/push_data.d.ts

@@ -1,7 +1,29 @@
+/**
+ * Calculates the encoding length of a number used for push data in Bitcoin transactions.
+ * @param i The number to calculate the encoding length for.
+ * @returns The encoding length of the number.
+ */
 export declare function encodingLength(i: number): number;
-export declare function encode(buffer: Buffer, num: number, offset: number): number;
-export declare function decode(buffer: Buffer, offset: number): {
+/**
+ * Encodes a number into a buffer using a variable-length encoding scheme.
+ * The encoded buffer is written starting at the specified offset.
+ * Returns the size of the encoded buffer.
+ *
+ * @param buffer - The buffer to write the encoded data into.
+ * @param num - The number to encode.
+ * @param offset - The offset at which to start writing the encoded buffer.
+ * @returns The size of the encoded buffer.
+ */
+export declare function encode(buffer: Uint8Array, num: number, offset: number): number;
+/**
+ * Decodes a buffer and returns information about the opcode, number, and size.
+ * @param buffer - The buffer to decode.
+ * @param offset - The offset within the buffer to start decoding.
+ * @returns An object containing the opcode, number, and size, or null if decoding fails.
+ */
+export declare function decode(buffer: Uint8Array, offset: number): {
     opcode: number;
     number: number;
     size: number;
 } | null;
+//# sourceMappingURL=push_data.d.ts.map

package/browser/push_data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"push_data.d.ts","sourceRoot":"","sources":["../src/push_data.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED;;;;;;;;;GASG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAyB9E;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAClB,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,MAAM,GACf;IACC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CAChB,GAAG,IAAI,CAqCP"}

package/browser/script.d.ts

@@ -1,16 +1,41 @@
 import { opcodes } from './opcodes.js';
-import { Stack } from './types.js';
+import { Script, Stack } from './types.js';
 import * as scriptNumber from './script_number.js';
 import * as scriptSignature from './script_signature.js';
 export { opcodes };
 export declare function isPushOnly(value: Stack): boolean;
 export declare function countNonPushOnlyOPs(value: Stack): number;
-export declare function compile(chunks: Buffer | Stack): Buffer;
-export declare function decompile(buffer: Buffer | Array<number | Buffer>): Array<number | Buffer> | null;
-export declare function toASM(chunks: Buffer | Array<number | Buffer>): string;
-export declare function fromASM(asm: string): Buffer;
-export declare function toStack(chunks: Buffer | Array<number | Buffer>): Buffer[];
-export declare function isCanonicalPubKey(buffer: Buffer): boolean;
-export declare function isCanonicalScriptSignature(buffer: Buffer): boolean;
+/**
+ * Compiles an array of chunks into a Uint8Array.
+ *
+ * @param chunks - The array of chunks to compile.
+ * @returns The compiled Uint8Array.
+ * @throws Error if the compilation fails.
+ */
+export declare function compile(chunks: Uint8Array | Stack): Script;
+export declare function decompile(buffer: Uint8Array | Stack): Array<number | Uint8Array> | null;
+/**
+ * Converts the given chunks into an ASM (Assembly) string representation.
+ * If the chunks parameter is a Uint8Array, it will be decompiled into a Stack before conversion.
+ * @param chunks - The chunks to convert into ASM.
+ * @returns The ASM string representation of the chunks.
+ */
+export declare function toASM(chunks: Uint8Array | Stack): string;
+/**
+ * Converts an ASM string to a Uint8Array.
+ * @param asm The ASM string to convert.
+ * @returns The converted Uint8Array.
+ */
+export declare function fromASM(asm: string): Script;
+/**
+ * Converts the given chunks into a stack of Uint8Arrays.
+ *
+ * @param chunks - The chunks to convert.
+ * @returns The stack of Uint8Arrays.
+ */
+export declare function toStack(chunks: Uint8Array | Stack): Uint8Array[];
+export declare function isCanonicalPubKey(buffer: Uint8Array): boolean;
+export declare function isCanonicalScriptSignature(buffer: Uint8Array): boolean;
 export declare const number: typeof scriptNumber;
 export declare const signature: typeof scriptSignature;
+//# sourceMappingURL=script.d.ts.map

package/browser/script.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"script.d.ts","sourceRoot":"","sources":["../src/script.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,OAAO,EAAe,MAAM,cAAc,CAAC;AAEpD,OAAO,KAAK,YAAY,MAAM,oBAAoB,CAAC;AACnD,OAAO,KAAK,eAAe,MAAM,uBAAuB,CAAC;AAEzD,OAAO,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAIhD,OAAO,EAAE,OAAO,EAAE,CAAC;AAgBnB,wBAAgB,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAEhD;AAED,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAExD;AAsBD;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,UAAU,GAAG,KAAK,GAAG,MAAM,CAkD1D;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,UAAU,GAAG,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,UAAU,CAAC,GAAG,IAAI,CA6CvF;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,MAAM,EAAE,UAAU,GAAG,KAAK,GAAG,MAAM,CAwBxD;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAmB3C;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,UAAU,GAAG,KAAK,GAAG,UAAU,EAAE,CAYhE;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAE7D;AAED,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAKtE;AAED,eAAO,MAAM,MAAM,qBAAe,CAAC;AACnC,eAAO,MAAM,SAAS,wBAAkB,CAAC"}

package/browser/script_number.d.ts

@@ -1,2 +1,19 @@
+/**
+ * Decodes a script number from a buffer.
+ *
+ * @param buffer - The buffer containing the script number.
+ * @param maxLength - The maximum length of the script number. Defaults to 4.
+ * @param minimal - Whether the script number should be minimal. Defaults to true.
+ * @returns The decoded script number.
+ * @throws {TypeError} If the script number overflows the maximum length.
+ * @throws {Error} If the script number is not minimally encoded when minimal is true.
+ */
 export declare function decode(buffer: Buffer, maxLength?: number, minimal?: boolean): number;
+/**
+ * Encodes a number into a Buffer using a specific format.
+ *
+ * @param _number - The number to encode.
+ * @returns The encoded number as a Buffer.
+ */
 export declare function encode(_number: number): Buffer;
+//# sourceMappingURL=script_number.d.ts.map

package/browser/script_number.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"script_number.d.ts","sourceRoot":"","sources":["../src/script_number.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CA+BpF;AAMD;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAkB9C"}

package/browser/script_signature.d.ts

@@ -1,8 +1,26 @@
+/**
+ * Checks if a hash type is defined (valid for Bitcoin signatures).
+ * @param hashType - The hash type to check.
+ * @returns True if the hash type is valid, false otherwise.
+ */
 export declare function isDefinedHashType(hashType: number): boolean;
-interface ScriptSignature {
-    signature: Buffer;
+export interface ScriptSignature {
+    signature: Uint8Array;
     hashType: number;
 }
-export declare function decode(buffer: Buffer): ScriptSignature;
-export declare function encode(signature: Buffer, hashType: number): Buffer;
-export {};
+/**
+ * Decodes a Uint8Array into a ScriptSignature object.
+ * @param buffer - The Uint8Array to decode.
+ * @returns The decoded ScriptSignature object.
+ * @throws Error if the hashType is invalid.
+ */
+export declare function decode(buffer: Uint8Array): ScriptSignature;
+/**
+ * Encodes a signature and hash type into a Uint8Array.
+ * @param signature - The signature to encode.
+ * @param hashType - The hash type to encode.
+ * @returns The encoded Uint8Array.
+ * @throws Error if the hashType is invalid.
+ */
+export declare function encode(signature: Uint8Array, hashType: number): Uint8Array;
+//# sourceMappingURL=script_signature.d.ts.map

package/browser/script_signature.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"script_signature.d.ts","sourceRoot":"","sources":["../src/script_signature.ts"],"names":[],"mappings":"AAMA;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAG3D;AA+BD,MAAM,WAAW,eAAe;IAC5B,SAAS,EAAE,UAAU,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;CACpB;AAGD;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,eAAe,CAY1D;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,GAAG,UAAU,CAkB1E"}