JSDoc: Class: Address

new Address(optsopt)

Create a new Bitmessage address object.

Parameters:

Name Type Attributes Description

opts

Object

Address options

Properties

Name	Type	Description
`version`	number	Version number (4 by default)
`stream`	number	Stream number (1 by default)
`behavior`	Object	Pubkey features (`DOES_ACK` by default)
`signPrivateKey`	Buffer	Signing private key
`signPublicKey`	Buffer	Signing public key
`encPrivateKey`	Buffer	Encryption private key
`encPublicKey`	Buffer	Encryption public key
`ripe`	Buffer	Keys RIPEMD hash

Source:

address.js, line 46

Methods

(static) decode(str) → {Address}

Parse Bitmessage address into address object.

Parameters:

Name	Type	Description
`str`	string	Address string (with or without `BM-` prefix)

Source:

address.js, line 87

Returns:

Decoded address object.

Type: Address

(static) fromPassphrase(opts) → {Address}

Create a new Bitmessage address from passphrase.

Parameters:

Name Type Description

opts

string | Object

Passphrase or address options

Properties

Name	Type	Attributes	Description
`passphrase`	string		Passphrase to generate address from
`ripeLength`	number	<optional>	Required length of the short RIPEMD hash (19 by default)
`version`	number	<optional>	Version number (4 by default)
`stream`	number	<optional>	Stream number (1 by default)
`behavior`	Object	<optional>	Pubkey features (`DOES_ACK` by default)

Source:

address.js, line 298

Returns:

New address object.

Type: Address

(static) fromRandom(optsopt) → {Address}

Create a new Bitmessage address with random encryption and signing private keys.

Parameters:

Name Type Attributes Description

opts

Object

Address options

Properties

Name	Type	Description
`ripeLength`	number	Required length of the short RIPEMD hash (19 by default)
`version`	number	Version number (4 by default)
`stream`	number	Stream number (1 by default)
`behavior`	Object	Pubkey features (`DOES_ACK` by default)

Source:

address.js, line 260

Returns:

New address object.

Type: Address

(static) isAddress(obj) → {boolean}

Test if the given object is an Address instance.
NOTE: Implementation is just simple instanceof but it improves readability and consistent with isArray, isBuffer, etc.

Parameters:

Name	Type	Description
`obj`	Object	Given object

Source:

address.js, line 78

Returns:

Type: boolean

clone() → {Address}

Create a copy of the address object.

Source:

address.js, line 67

Returns:

Cloned address.

Type: Address

encode() → {string}

Encode Bitmessage address object into address string.

Source:

address.js, line 239

Returns:

Address string.

Type: string

getBroadcastPrivateKey() → {Buffer}

Calculate the encryption key used to encrypt/decrypt broadcast objects.

Source:

address.js, line 164

Returns:

A 32-byte private key.

Type: Buffer

getBroadcastPublicKey() → {Buffer}

Calculate the corresponding public key for encryption key used to encrypt/decrypt broadcast objects.

Source:

address.js, line 178

Returns:

A 65-byte public key.

Type: Buffer

getPubkeyPrivateKey() → {Buffer}

Calculate the encryption key used to encrypt/decrypt pubkey objects.

Source:

address.js, line 145

Returns:

A 32-byte private key.

Type: Buffer

getPubkeyPublicKey() → {Buffer}

Calculate the corresponding public key for encryption key used to encrypt/decrypt pubkey objects.

Source:

address.js, line 155

Returns:

A 65-byte public key.

Type: Buffer

getShortRipe() → {Buffer}

Get the RIPEMD hash of the address keys without prefix nulls.

Source:

address.js, line 126

Returns:

A short RIPEMD hash.

Type: Buffer

getTag() → {Buffer}

Calculate the address tag.

Source:

address.js, line 186

Returns:

A 32-byte address tag.

Type: Buffer