@t402/btc 2.7.0

package/dist/cjs/index.d.ts

@@ -0,0 +1,179 @@
+export { BtcClientConfig, ExactBtcScheme, registerExactBtcScheme as registerExactBtcClientScheme } from './exact/client/index.js';
+export { LightningClientConfig, LightningScheme, registerLightningScheme as registerLightningClientScheme } from './lightning/client/index.js';
+export { BtcResourceServerConfig, ExactBtcSchemeConfig, registerExactBtcScheme as registerExactBtcServerScheme } from './exact/server/index.js';
+export { BtcFacilitatorConfig, FacilitatorBtcSigner, registerExactBtcScheme as registerExactBtcFacilitatorScheme } from './exact/facilitator/index.js';
+export { InvoiceGenerator, LightningResourceServerConfig, LightningSchemeConfig, registerLightningScheme as registerLightningServerScheme } from './lightning/server/index.js';
+export { FacilitatorLightningSigner, LightningFacilitatorConfig, registerLightningScheme as registerLightningFacilitatorScheme } from './lightning/facilitator/index.js';
+export { C as ClientBtcSigner, a as ClientLightningSigner } from './signer-B_Z4WGLa.js';
+import '@t402/core/types';
+import '@t402/core/client';
+import '@t402/core/server';
+import '@t402/core/facilitator';
+
+/**
+ * Bitcoin & Lightning Network Payment Payload Types
+ *
+ * Defines the payload structures for BTC on-chain and Lightning payments
+ * in the t402 protocol.
+ */
+/**
+ * Bitcoin on-chain payment payload for the exact scheme (V2)
+ * Contains a signed PSBT (Partially Signed Bitcoin Transaction)
+ */
+type BtcOnchainPayload = {
+    /**
+     * Base64-encoded signed PSBT
+     * Contains the complete transaction ready for finalization and broadcast
+     */
+    signedPsbt: string;
+    /**
+     * Optional transaction ID (available after broadcast)
+     */
+    txId?: string;
+};
+/**
+ * Lightning Network payment payload
+ * Contains proof of payment via preimage
+ */
+type LightningPayload = {
+    /**
+     * SHA-256 payment hash (hex-encoded)
+     * Identifies the payment on the Lightning Network
+     */
+    paymentHash: string;
+    /**
+     * Payment preimage (hex-encoded)
+     * Proof that the payment was completed (SHA-256(preimage) === paymentHash)
+     */
+    preimage: string;
+    /**
+     * BOLT11 invoice string that was paid
+     */
+    bolt11Invoice: string;
+};
+
+/**
+ * Bitcoin & Lightning Network Constants
+ *
+ * CAIP-2 network identifiers, dust limits, and fee constants.
+ */
+/**
+ * CAIP-2 Network Identifiers for Bitcoin
+ * Uses BIP-122 chain genesis block hashes
+ */
+declare const BTC_MAINNET = "bip122:000000000019d6689c085ae165831e93";
+declare const BTC_TESTNET = "bip122:000000000933ea01ad0ee984209779ba";
+/**
+ * CAIP-2 Network Identifiers for Lightning Network
+ */
+declare const LIGHTNING_MAINNET = "lightning:mainnet";
+declare const LIGHTNING_TESTNET = "lightning:testnet";
+/**
+ * All supported BTC on-chain networks
+ */
+declare const BTC_NETWORKS: readonly ["bip122:000000000019d6689c085ae165831e93", "bip122:000000000933ea01ad0ee984209779ba"];
+/**
+ * All supported Lightning networks
+ */
+declare const LIGHTNING_NETWORKS: readonly ["lightning:mainnet", "lightning:testnet"];
+/**
+ * All supported networks (on-chain + Lightning)
+ */
+declare const ALL_NETWORKS: readonly ["bip122:000000000019d6689c085ae165831e93", "bip122:000000000933ea01ad0ee984209779ba", "lightning:mainnet", "lightning:testnet"];
+type BtcNetwork = (typeof BTC_NETWORKS)[number];
+type LightningNetwork = (typeof LIGHTNING_NETWORKS)[number];
+/**
+ * Dust limit in satoshis - minimum viable output value
+ * Outputs below this threshold are rejected by Bitcoin nodes
+ */
+declare const DUST_LIMIT = 546;
+/**
+ * Minimum relay fee in satoshis
+ * Transactions with fees below this are not relayed by default
+ */
+declare const MIN_RELAY_FEE = 1000;
+/**
+ * Satoshis per BTC
+ */
+declare const SATS_PER_BTC = 100000000;
+/**
+ * Scheme identifiers
+ */
+declare const SCHEME_EXACT = "exact";
+/**
+ * Default timeout for payment validity (in seconds)
+ */
+declare const DEFAULT_VALIDITY_DURATION = 3600;
+/**
+ * Bitcoin address prefixes for basic validation
+ */
+declare const MAINNET_ADDRESS_PREFIXES: string[];
+declare const TESTNET_ADDRESS_PREFIXES: string[];
+
+/**
+ * Bitcoin & Lightning Utility Functions
+ *
+ * Helper functions for address validation, unit conversion,
+ * and invoice validation.
+ */
+/**
+ * Convert satoshis to BTC
+ *
+ * @param sats - Amount in satoshis
+ * @returns Amount in BTC as string (to avoid floating point issues)
+ */
+declare function satoshisToBtc(sats: bigint | number | string): string;
+/**
+ * Convert BTC to satoshis
+ *
+ * @param btc - Amount in BTC (string or number)
+ * @returns Amount in satoshis as bigint
+ */
+declare function btcToSatoshis(btc: string | number): bigint;
+/**
+ * Validate a Bitcoin address (basic format validation)
+ *
+ * Checks address prefix against known formats:
+ * - Mainnet: bc1 (bech32), 1 (P2PKH), 3 (P2SH)
+ * - Testnet: tb1 (bech32), m/n (P2PKH), 2 (P2SH)
+ *
+ * @param address - Bitcoin address to validate
+ * @returns true if the address has a valid format
+ */
+declare function validateBitcoinAddress(address: string): boolean;
+/**
+ * Check if a Bitcoin address is for mainnet
+ *
+ * @param address - Bitcoin address
+ * @returns true if mainnet address
+ */
+declare function isMainnetAddress(address: string): boolean;
+/**
+ * Check if a Bitcoin address is for testnet
+ *
+ * @param address - Bitcoin address
+ * @returns true if testnet address
+ */
+declare function isTestnetAddress(address: string): boolean;
+/**
+ * Validate a BOLT11 Lightning invoice (basic format validation)
+ *
+ * BOLT11 invoices follow the format:
+ * - lnbc... for mainnet
+ * - lntb... for testnet
+ * - lnbcrt... for regtest
+ *
+ * @param invoice - BOLT11 invoice string
+ * @returns true if the invoice has a valid format
+ */
+declare function validateBolt11Invoice(invoice: string): boolean;
+/**
+ * Validate a hex-encoded string
+ *
+ * @param hex - String to validate
+ * @param expectedLength - Expected byte length (hex length / 2)
+ * @returns true if valid hex of expected length
+ */
+declare function isValidHex(hex: string, expectedLength?: number): boolean;
+
+export { ALL_NETWORKS, BTC_MAINNET, BTC_NETWORKS, BTC_TESTNET, type BtcNetwork, type BtcOnchainPayload, DEFAULT_VALIDITY_DURATION, DUST_LIMIT, LIGHTNING_MAINNET, LIGHTNING_NETWORKS, LIGHTNING_TESTNET, type LightningNetwork, type LightningPayload, MAINNET_ADDRESS_PREFIXES, MIN_RELAY_FEE, SATS_PER_BTC, SCHEME_EXACT, TESTNET_ADDRESS_PREFIXES, btcToSatoshis, isMainnetAddress, isTestnetAddress, isValidHex, satoshisToBtc, validateBitcoinAddress, validateBolt11Invoice };