@xchainjs/xchain-bitcoincash/lib/bchaddrjs/index.d.ts

Custom bitcoincash client and utilities used by XChainJS clients

/**
 * General purpose Bitcoin Cash address detection and translation.<br />
 * Supports all major Bitcoin Cash address formats.<br />
 * Currently:
 * <ul>
 *    <li> Legacy format </li>
 *    <li> Bitpay format </li>
 *    <li> Cashaddr format </li>
 * </ul>
 * @module bchaddr
 */
/**
 * @static
 * Supported Bitcoin Cash address formats.
 */
declare const Format: any;
/**
 * @static
 * Supported networks.
 */
declare const Network: any;
/**
 * @static
 * Supported address types.
 */
declare const Type: any;
/**
 * Returns a boolean indicating whether the given input is a valid Bitcoin Cash address.
 * @static
 * @param {*} input - Any input to check for validity.
 * @returns {boolean}
 */
declare function isValidAddress(input: any): boolean;
/**
 * Detects what is the given address' format.
 * @static
 * @param {string} address - A valid Bitcoin Cash address in any format.
 * @return {string}
 * @throws {InvalidAddressError}
 */
declare function detectAddressFormat(address: any): any;
/**
 * Detects what is the given address' network.
 * @static
 * @param {string} address - A valid Bitcoin Cash address in any format.
 * @return {string}
 * @throws {InvalidAddressError}
 */
declare function detectAddressNetwork(address: any): any;
/**
 * Detects what is the given address' type.
 * @static
 * @param {string} address - A valid Bitcoin Cash address in any format.
 * @return {string}
 * @throws {InvalidAddressError}
 */
declare function detectAddressType(address: any): any;
/**
 * Translates the given address into legacy format.
 * @static
 * @param {string} address - A valid Bitcoin Cash address in any format.
 * @return {string}
 * @throws {InvalidAddressError}
 */
declare function toLegacyAddress(address: any): any;
/**
 * Translates the given address into bitpay format.
 * @static
 * @param {string} address - A valid Bitcoin Cash address in any format.
 * @return {string}
 * @throws {InvalidAddressError}
 */
declare function toBitpayAddress(address: any): any;
/**
 * Translates the given address into cashaddr format.
 * @static
 * @param {string} address - A valid Bitcoin Cash address in any format.
 * @return {string}
 * @throws {InvalidAddressError}
 */
declare function toCashAddress(address: any): string;
/**
 * Returns a boolean indicating whether the address is in legacy format.
 * @static
 * @param {string} address - A valid Bitcoin Cash address in any format.
 * @returns {boolean}
 * @throws {InvalidAddressError}
 */
declare function isLegacyAddress(address: any): boolean;
/**
 * Returns a boolean indicating whether the address is in bitpay format.
 * @static
 * @param {string} address - A valid Bitcoin Cash address in any format.
 * @returns {boolean}
 * @throws {InvalidAddressError}
 */
declare function isBitpayAddress(address: any): boolean;
/**
 * Returns a boolean indicating whether the address is in cashaddr format.
 * @static
 * @param {string} address - A valid Bitcoin Cash address in any format.
 * @returns {boolean}
 * @throws {InvalidAddressError}
 */
declare function isCashAddress(address: any): boolean;
/**
 * Returns a boolean indicating whether the address is a mainnet address.
 * @static
 * @param {string} address - A valid Bitcoin Cash address in any format.
 * @returns {boolean}
 * @throws {InvalidAddressError}
 */
declare function isMainnetAddress(address: any): boolean;
/**
 * Returns a boolean indicating whether the address is a testnet address.
 * @static
 * @param {string} address - A valid Bitcoin Cash address in any format.
 * @returns {boolean}
 * @throws {InvalidAddressError}
 */
declare function isTestnetAddress(address: any): boolean;
/**
 * Returns a boolean indicating whether the address is a p2pkh address.
 * @static
 * @param {string} address - A valid Bitcoin Cash address in any format.
 * @returns {boolean}
 * @throws {InvalidAddressError}
 */
declare function isP2PKHAddress(address: any): boolean;
/**
 * Returns a boolean indicating whether the address is a p2sh address.
 * @static
 * @param {string} address - A valid Bitcoin Cash address in any format.
 * @returns {boolean}
 * @throws {InvalidAddressError}
 */
declare function isP2SHAddress(address: any): boolean;
/**
 * Error thrown when the address given as input is not a valid Bitcoin Cash address.
 * @constructor
 * InvalidAddressError
 */
declare function InvalidAddressError(): void;
declare namespace InvalidAddressError {
    var prototype: any;
}
export { Format, Network, Type, isValidAddress, detectAddressFormat, detectAddressNetwork, detectAddressType, toLegacyAddress, toBitpayAddress, toCashAddress, isLegacyAddress, isBitpayAddress, isCashAddress, isMainnetAddress, isTestnetAddress, isP2PKHAddress, isP2SHAddress, InvalidAddressError, };