bitcore Class: Address

new Address(data, network, type) → {Address}

Instantiate an address from an address String or Buffer, a public key or script hash Buffer, or an instance of PublicKey or Script.

This is an immutable class, and if the first parameter provided to this constructor is an Address instance, the same argument will be returned.

An address has two key properties: network and type. The type is either Address.PayToPublicKeyHash (value is the 'pubkeyhash' string) or Address.PayToScriptHash (the string 'scripthash'). The network is an instance of Network.

Parameters:

Name	Type	Argument	Description
`data`	*		The encoded data in various formats
`network`	Network \| String \| number	<optional>	The network: 'livenet' or 'testnet'
`type`	String	<optional>	The type of address: 'script' or 'pubkey'

Source:

address.js, line 39

Returns:

A new valid and frozen instance of an Address

Type: Address

Example

// validate that an input field is valid
var error = Address.getValidationError(input, 'testnet');
if (!error) {
  var address = Address(input, 'testnet');
} else {
  // invalid network or checksum (typo?)
  var message = error.messsage;
}

// get an address from a public key
var address = Address(publicKey, 'testnet').toString();

Members

<static> PayToPublicKeyHash

Source:

address.js, line 99

<static> PayToScriptHash

Source:

address.js, line 104

Methods

<private, static> _classifyFromVersion(buffer) → {Object}

Internal function to discover the network and type

Parameters:

Name	Type	Description
`buffer`	Buffer	An instance of a hex encoded address Buffer

Source:

address.js, line 132

Returns:

An object with keys: network and type

Type: Object

<private, static> _transformBuffer(buffer, network, type) → {Object}

Internal function to transform a bitcoin address buffer

Parameters:

Name	Type	Argument	Description
`buffer`	Buffer		An instance of a hex encoded address Buffer
`network`	String	<optional>	The network: 'livenet' or 'testnet'
`type`	String	<optional>	The type: 'pubkeyhash' or 'scripthash'

Source:

address.js, line 167

Returns:

An object with keys: hashBuffer, network and type

Type: Object

<private, static> _transformHash(hash) → {Object}

Internal function to transform a hash buffer

Parameters:

Name	Type	Description
`hash`	Buffer	An instance of a hash Buffer

Source:

address.js, line 113

Returns:

An object with keys: hashBuffer

Type: Object

<private, static> _transformPublicKey(pubkey) → {Object}

Internal function to transform a PublicKey

Parameters:

Name	Type	Description
`pubkey`	PublicKey	An instance of PublicKey

Source:

address.js, line 200

Returns:

An object with keys: hashBuffer, type

Type: Object

<private, static> _transformScript(script) → {Object}

Internal function to transform a Script

Parameters:

Name	Type	Description
`script`	Script	An instance of Script

Source:

address.js, line 217

Returns:

An object with keys: hashBuffer, type

Type: Object

<private, static> _transformString(data, network, type) → {Object}

Internal function to transform a bitcoin address string

Parameters:

Name	Type	Argument	Description
`data`	String		An instance of PublicKey
`network`	String	<optional>	The network: 'livenet' or 'testnet'
`type`	String	<optional>	The type: 'pubkeyhash' or 'scripthash'

Source:

address.js, line 237

Returns:

An object with keys: hashBuffer, network and type

Type: Object

<static> fromBuffer(buffer, network, type) → {Address}

Instantiate an address from a buffer of the address

Parameters:

Name	Type	Argument	Description
`buffer`	Buffer		An instance of buffer of the address
`network`	String	<optional>	The network: 'livenet' or 'testnet'
`type`	String	<optional>	The type of address: 'script' or 'pubkey'

Source:

address.js, line 303

Returns:

A new valid and frozen instance of an Address

Type: Address

<static> fromJSON(json) → {Address}

Instantiate an address from JSON

Parameters:

Name	Type	Description
`json`	String	An JSON string or Object with keys: hash, network and type

Source:

address.js, line 327

Returns:

A new valid instance of an Address

Type: Address

<static> fromPublicKey(data, network) → {Address}

Instantiate an address from a PublicKey instance

Parameters:

Name	Type	Description
`data`	PublicKey	An instance of PublicKey
`network`	String	The network: 'livenet' or 'testnet'

Source:

address.js, line 253

Returns:

A new valid and frozen instance of an Address

Type: Address

<static> fromPublicKeyHash(hash, network) → {Address}

Instantiate an address from a ripemd160 public key hash

Parameters:

Name	Type	Description
`hash`	Buffer	An instance of buffer of the hash
`network`	String	The network: 'livenet' or 'testnet'

Source:

address.js, line 266

Returns:

A new valid and frozen instance of an Address

Type: Address

<static> fromScript(script, network) → {Address}

Instantiate an address from a Script

Parameters:

Name	Type	Description
`script`	Script	An instance of Script
`network`	String	The network: 'livenet' or 'testnet'

Source:

address.js, line 290

Returns:

A new valid and frozen instance of an Address

Type: Address

<static> fromScriptHash(hash, network) → {Address}

Instantiate an address from a ripemd160 script hash

Parameters:

Name	Type	Description
`hash`	Buffer	An instance of buffer of the hash
`network`	String	The network: 'livenet' or 'testnet'

Source:

address.js, line 278

Returns:

A new valid and frozen instance of an Address

Type: Address

<static> fromString(str, network, type) → {Address}

Instantiate an address from an address string

Parameters:

Name	Type	Argument	Description
`str`	String		An string of the bitcoin address
`network`	String	<optional>	The network: 'livenet' or 'testnet'
`type`	String	<optional>	The type of address: 'script' or 'pubkey'

Source:

address.js, line 316

Returns:

A new valid and frozen instance of an Address

Type: Address

<static> getValidationError(data, network, type) → {null|Error}

Will return a validation error if exists

Parameters:

Name	Type	Description
`data`	String	The encoded data
`network`	String	The network: 'livenet' or 'testnet'
`type`	String	The type of address: 'script' or 'pubkey'

Source:

address.js, line 352

Returns:

The corresponding error message

Type: null | Error

Example

var error = Address.getValidationError('15vkcKf7gB23wLAnZLmbVuMiiVDc1Nm4a2', 'testnet');
// a network mismatch error

<static> isValid(data, network, type) → {boolean}

Will return a boolean if an address is valid

Parameters:

Name	Type	Description
`data`	String	The encoded data
`network`	String	The network: 'livenet' or 'testnet'
`type`	String	The type of address: 'script' or 'pubkey'

Source:

address.js, line 375

Returns:

The corresponding error message

Type: boolean

Example

var valid = Address.isValid('15vkcKf7gB23wLAnZLmbVuMiiVDc1Nm4a2', 'livenet');
// true

inspect() → {String}

Will return a string formatted for the console

Source:

address.js, line 438

Returns:

Bitcoin address

Type: String

isPayToPublicKeyHash()

Returns true if an address is of pay to public key hash type

Source:

address.js, line 383

Returns:

boolean

isPayToScriptHash()

Returns true if an address is of pay to script hash type

Source:

address.js, line 391

Returns:

boolean

toBuffer() → {Buffer}

Will return a buffer representation of the address

Source:

address.js, line 400

Returns:

Bitcoin address buffer

Type: Buffer

toJSON() → {Object}

Source:

address.js, line 420

Returns:

An object of the address

Type: Object

toObject() → {Object}

Source:

address.js, line 409

Returns:

An object of the address

Type: Object

toString() → {String}

Will return a the string representation of the address

Source:

address.js, line 429

Returns:

Bitcoin address

Type: String