UNPKG

bip322-js

Version:

A Javascript library that provides utility functions related to the BIP-322 signature scheme

github.com/ACken2/bip322-js

ACken2/bip322-js

98 lines (97 loc) • 4.97 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/// <reference types="node" /> import * as bitcoin from 'bitcoinjs-lib'; /** * Class that implement address-related utility functions. */ declare class Address { /** * Check if a given Bitcoin address is a pay-to-public-key-hash (p2pkh) address. * @param address Bitcoin address to be checked * @returns True if the provided address correspond to a valid P2PKH address, false if otherwise */ static isP2PKH(address: string): boolean; /** * Check if a given Bitcoin address is a pay-to-script-hash (P2SH) address. * @param address Bitcoin address to be checked * @returns True if the provided address correspond to a valid P2SH address, false if otherwise */ static isP2SH(address: string): boolean; /** * Check if a given Bitcoin address is a pay-to-witness-public-key-hash (P2WPKH) address. * @param address Bitcoin address to be checked * @returns True if the provided address correspond to a valid P2WPKH address, false if otherwise */ static isP2WPKH(address: string): boolean; /** * Check if a given Bitcoin address is a taproot address. * @param address Bitcoin address to be checked * @returns True if the provided address is a taproot address, false if otherwise */ static isP2TR(address: string): boolean; /** * Check if a given witness stack corresponds to a P2WPKH address. * @param witness Witness data associated with the toSign BIP-322 transaction * @returns True if the provided witness stack correspond to a valid P2WPKH address, false if otherwise */ static isP2WPKHWitness(witness: Buffer[]): boolean; /** * Check if a given witness stack corresponds to a single-key-spend P2TR address. * @param witness Witness data associated with the toSign BIP-322 transaction * @returns True if the provided address and witness stack correspond to a valid single-key-spend P2TR address, false if otherwise */ static isSingleKeyP2TRWitness(witness: Buffer[]): boolean; /** * Determine network type by checking addresses prefixes * Reference: https://en.bitcoin.it/wiki/List_of_address_prefixes * * Adopted from https://github.com/ACken2/bip322-js/pull/6 by Czino * * @param address Bitcoin address * @returns Network type * @throws If the address type is not recognized */ static getNetworkFromAddess(address: string): bitcoin.networks.Network; /** * Convert a given Bitcoin address into its corresponding script public key. * Reference: https://github.com/buidl-bitcoin/buidl-python/blob/d79e9808e8ca60975d315be41293cb40d968626d/buidl/script.py#L607 * @param address Bitcoin address * @returns Script public key of the given Bitcoin address * @throws Error when the provided address is not a valid Bitcoin address */ static convertAdressToScriptPubkey(address: string): Buffer; /** * Convert a given public key into a corresponding Bitcoin address. * @param publicKey Public key for deriving the address, or internal public key for deriving taproot address * @param addressType Bitcoin address type to be derived, must be either 'p2pkh', 'p2sh-p2wpkh', 'p2wpkh', or 'p2tr' * @returns Bitcoin address that correspond to the given public key in both mainnet and testnet */ static convertPubKeyIntoAddress(publicKey: Buffer, addressType: 'p2pkh' | 'p2sh-p2wpkh' | 'p2wpkh' | 'p2tr'): { mainnet: string; testnet: string; regtest: string; }; /** * Validates a given Bitcoin address. * This method checks if the provided Bitcoin address is valid by attempting to decode it * for different Bitcoin networks: mainnet, testnet, and regtest. The method uses the * bitcoinjs-lib's address module for decoding. * * The process is as follows: * 1. Attempt to decode the address for the Bitcoin mainnet. If decoding succeeds, * the method returns true, indicating the address is valid for mainnet. * 2. If the first step fails, catch the resulting error and attempt to decode the * address for the Bitcoin testnet. If decoding succeeds, the method returns true, * indicating the address is valid for testnet. * 3. If the second step fails, catch the resulting error and attempt to decode the * address for the Bitcoin regtest network. If decoding succeeds, the method returns * true, indicating the address is valid for regtest. * 4. If all attempts fail, the method returns false, indicating the address is not valid * for any of the checked networks. * * @param address The Bitcoin address to validate. * @return boolean Returns true if the address is valid for any of the Bitcoin networks, * otherwise returns false. */ static isValidBitcoinAddress(address: string): boolean; } export default Address;