Module: address

This module provides validation messages related to addresses.

Source:

Methods

(static) validateAddress(address, network) → {string}

Validate a given bitcoin address.

Address must be a valid address on the given bitcoin network.

Parameters:
Name Type Description
address string

the address to validate

network module:networks.NETWORKS | string

bitcoin network

Source:
Returns:

empty if valid or corresponding validation message if not

Type
string
Example
import {MAINNET, TESTNET, validateAddress} from "unchained-bitcoin";
console.log(validateAddress('', MAINNET)); // "Address cannot be blank"
console.log(validateAddress('2Mx6Y8VRj8rmSdLfwrvnpBR7ctjctPLzpWs', MAINNET)); // "Address must start with either of 'bc1', '1' or '3' followed by letters or digits."
console.log(validateAddress('2Mx6Y8VRj8rmSdLfwrvnpBR7ctjctPLzpWs', TESTNET)); // ""