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

package/build/payments/p2pkh.d.ts

@@ -1,2 +1,186 @@
-import { P2PKHPayment, PaymentOpts } from './types.js';
+/**
+ * Pay-to-Public-Key-Hash (P2PKH) payment class.
+ *
+ * P2PKH is the most common legacy Bitcoin payment type. The output script
+ * contains the hash of a public key, and spending requires the full public key
+ * and a valid signature.
+ *
+ * @packageDocumentation
+ */
+import { type Network } from '../networks.js';
+import { type Bytes20, type PublicKey, type Script, type Signature } from '../types.js';
+import { PaymentType, type P2PKHPayment, type PaymentOpts } from './types.js';
+/**
+ * Pay-to-Public-Key-Hash (P2PKH) payment class.
+ *
+ * Creates locking scripts of the form:
+ * `OP_DUP OP_HASH160 {hash160(pubkey)} OP_EQUALVERIFY OP_CHECKSIG`
+ *
+ * Spending requires providing: `{signature} {pubkey}`
+ *
+ * @example
+ * ```typescript
+ * import { P2PKH } from '@btc-vision/bitcoin';
+ *
+ * // Create from public key
+ * const payment = P2PKH.fromPubkey(pubkey);
+ * console.log(payment.address); // Bitcoin address
+ * console.log(payment.output); // scriptPubKey
+ *
+ * // Create from address
+ * const fromAddr = P2PKH.fromAddress('1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2');
+ * console.log(fromAddr.hash); // 20-byte pubkey hash
+ *
+ * // Create from hash
+ * const fromHash = P2PKH.fromHash(hash160);
+ * console.log(fromHash.address);
+ * ```
+ */
+export declare class P2PKH {
+    #private;
+    static readonly NAME: "p2pkh";
+    /**
+     * Creates a new P2PKH payment instance.
+     *
+     * @param params - Payment parameters
+     * @param params.address - Base58Check encoded address
+     * @param params.hash - 20-byte pubkey hash (RIPEMD160(SHA256(pubkey)))
+     * @param params.pubkey - The public key (33 or 65 bytes)
+     * @param params.signature - DER-encoded signature
+     * @param params.output - The scriptPubKey
+     * @param params.input - The scriptSig
+     * @param params.network - Network parameters (defaults to mainnet)
+     * @param opts - Payment options
+     * @param opts.validate - Whether to validate inputs (default: true)
+     *
+     * @throws {TypeError} If validation is enabled and data is invalid
+     */
+    constructor(params: {
+        address?: string | undefined;
+        hash?: Uint8Array | undefined;
+        pubkey?: Uint8Array | undefined;
+        signature?: Uint8Array | undefined;
+        output?: Uint8Array | undefined;
+        input?: Uint8Array | undefined;
+        network?: Network | undefined;
+        useHybrid?: boolean | undefined;
+        useUncompressed?: boolean | undefined;
+    }, opts?: PaymentOpts);
+    /**
+     * Payment type discriminant.
+     */
+    get name(): typeof PaymentType.P2PKH;
+    /**
+     * Network parameters.
+     */
+    get network(): Network;
+    /**
+     * Base58Check encoded Bitcoin address.
+     */
+    get address(): string | undefined;
+    /**
+     * 20-byte pubkey hash (RIPEMD160(SHA256(pubkey))).
+     */
+    get hash(): Bytes20 | undefined;
+    /**
+     * The public key (33 or 65 bytes).
+     */
+    get pubkey(): PublicKey | undefined;
+    /**
+     * The DER-encoded signature.
+     */
+    get signature(): Signature | undefined;
+    /**
+     * The scriptPubKey:
+     * `OP_DUP OP_HASH160 {hash} OP_EQUALVERIFY OP_CHECKSIG`
+     */
+    get output(): Script | undefined;
+    /**
+     * The scriptSig: `{signature} {pubkey}`
+     */
+    get input(): Script | undefined;
+    /**
+     * Witness stack (empty for P2PKH as it's not a SegWit type).
+     */
+    get witness(): Uint8Array[] | undefined;
+    /**
+     * Creates a P2PKH payment from a public key.
+     *
+     * @param pubkey - The public key (33 or 65 bytes)
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new P2PKH payment instance
+     *
+     * @example
+     * ```typescript
+     * const payment = P2PKH.fromPubkey(pubkey);
+     * const address = payment.address;
+     * ```
+     */
+    static fromPubkey(pubkey: PublicKey, network?: Network): P2PKH;
+    /**
+     * Creates a P2PKH payment from a Base58Check address.
+     *
+     * @param address - Base58Check encoded address
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new P2PKH payment instance
+     *
+     * @example
+     * ```typescript
+     * const payment = P2PKH.fromAddress('1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2');
+     * const hash = payment.hash;
+     * ```
+     */
+    static fromAddress(address: string, network?: Network): P2PKH;
+    /**
+     * Creates a P2PKH payment from a 20-byte pubkey hash.
+     *
+     * @param hash - 20-byte pubkey hash
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new P2PKH payment instance
+     *
+     * @example
+     * ```typescript
+     * const payment = P2PKH.fromHash(hash160);
+     * const address = payment.address;
+     * ```
+     */
+    static fromHash(hash: Bytes20, network?: Network): P2PKH;
+    /**
+     * Creates a P2PKH payment from a scriptPubKey.
+     *
+     * @param output - The scriptPubKey
+     * @param network - Network parameters (defaults to mainnet)
+     * @returns A new P2PKH payment instance
+     */
+    static fromOutput(output: Uint8Array, network?: Network): P2PKH;
+    /**
+     * Converts to a plain P2PKHPayment object for backwards compatibility.
+     *
+     * @returns A P2PKHPayment object
+     */
+    toPayment(): P2PKHPayment;
+}
+/**
+ * Creates a Pay-to-Public-Key-Hash (P2PKH) payment object.
+ *
+ * This is the legacy factory function for backwards compatibility.
+ * For new code, prefer using the P2PKH class directly.
+ *
+ * @param a - The payment object containing the necessary data
+ * @param opts - Optional payment options
+ * @returns The P2PKH payment object
+ * @throws {TypeError} If the required data is not provided or if the data is invalid
+ *
+ * @example
+ * ```typescript
+ * import { p2pkh } from '@btc-vision/bitcoin';
+ *
+ * // Create from public key
+ * const payment = p2pkh({ pubkey });
+ *
+ * // Create from address
+ * const fromAddr = p2pkh({ address: '1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2' });
+ * ```
+ */
 export declare function p2pkh(a: Omit<P2PKHPayment, 'name'>, opts?: PaymentOpts): P2PKHPayment;
+//# sourceMappingURL=p2pkh.d.ts.map

package/build/payments/p2pkh.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"p2pkh.d.ts","sourceRoot":"","sources":["../../src/payments/p2pkh.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,EAA8B,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAG1E,OAAO,EAAW,KAAK,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,MAAM,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAEjG,OAAO,EAAE,WAAW,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,MAAM,YAAY,CAAC;AAI9E;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,KAAK;;IAEd,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAqB;IA4CzC;;;;;;;;;;;;;;;OAeG;gBAEC,MAAM,EAAE;QACJ,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;QAC9B,MAAM,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;QAChC,SAAS,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;QACnC,MAAM,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;QAChC,KAAK,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;QAC/B,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;QAC9B,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;QAChC,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KACzC,EACD,IAAI,CAAC,EAAE,WAAW;IA0BtB;;OAEG;IACH,IAAI,IAAI,IAAI,OAAO,WAAW,CAAC,KAAK,CAEnC;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,MAAM,GAAG,SAAS,CAMhC;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,OAAO,GAAG,SAAS,CAM9B;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,SAAS,GAAG,SAAS,CAMlC;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,SAAS,GAAG,SAAS,CAMrC;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAM/B;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,MAAM,GAAG,SAAS,CAM9B;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,UAAU,EAAE,GAAG,SAAS,CAMtC;IAID;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,KAAK;IAI9D;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,KAAK;IAI7D;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,KAAK;IAIxD;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,KAAK;IAoP/D;;;;OAIG;IACH,SAAS,IAAI,YAAY;CAa5B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,YAAY,CAsBrF"}