Class: RiseIdentity

new RiseIdentity(entropyopt, solutionopt, saltopt)

Rise private identity bundle. This is the primary interface for using this module. Allows to generate new identities and use them as the context for protected operations.

Parameters:

Name	Type	Attributes	Default	Description
`entropy`	Uint8Array \| buffer	<optional>		Private key (secp256k1). If absent a new one will be created.
`solution`	RiseSolution	<optional>		Equihash solution corresponding to the given private key.
`salt`	Uint8Array \| buffer	<optional>	module:rise~RiseSolution~SALT	Salt used for local pbkdf2 operations locking/unlocking this identity.

Source: index.js, line 107

Members

fingerprint :buffer

160 bit solution hash.

Type:

buffer

Source: index.js, line 136

mnemonic :string

BIP39 recovery words.

Type:

string

Source: index.js, line 119

salt :Uint8Array|buffer

Used for local PBKDF2.

Type:

Uint8Array | buffer

Source: index.js, line 114

secret :module:rise~RiseSecret

Underlying secret key.

Type:

module:rise~RiseSecret

Source: index.js, line 124

solution :module:rise~RiseSolution

Underlying equihash solution.

Type:

module:rise~RiseSolution

Source: index.js, line 129

(static) K

Equihash K parameter (length).

Source: index.js, line 63

(static) MAGIC

Rise magic number. Used as message terminator and protocol identitifier.

Source: index.js, line 77

(static) N

Equihash N parameter (width in bits).

Source: index.js, line 49

(static) SALT

Rise default salt for pbkdf2 operations.

Source: index.js, line 91

(static) TEST_K

Lowered length for testing.

Source: index.js, line 70

(static) TEST_MAGIC

Magic number to segment test network.

Source: index.js, line 84

(static) TEST_N

Lowered width for testing.

Source: index.js, line 56

(static) TEST_Z

Lowered difficulty for testing.

Source: index.js, line 42

(static) Z

Default difficuly setting. Require this many leading zeroes in solution proofs.

Source: index.js, line 35

Methods

lock(password) → {buffer}

Creates an encrypted blob representation of this identity, suitable for persistance to disk.

Parameters:

Name	Type	Description
`password`	string	User provided passphrase used to encrypt this identity.

Source: index.js, line 186

Returns:

Type:: buffer

message(toPublicKey, bodyopt, headopt) → {module:rise~SignedRiseMessage}

Constructs an encrypted and signed module:rise~RiseMessage for the given public key.

Parameters:

Name	Type	Attributes	Description
`toPublicKey`	Uint8Array \| buffer		Recipient identity for encryption.
`body`	Object.<string, string>	<optional>	Key-value pairs to serialize in the message.
`head`	Object.<string, string>	<optional>	Custom headers to include. Headers are NOT ENCRYPTED. Only information that is necessary for routing should be included here.

Source: index.js, line 208

Returns:

Type:: module:rise~SignedRiseMessage

solve(nopt, kopt, epochopt) → {Promise.<module:rise~RiseSolution>}

Creates a new RiseSolution for this identity. This method updates the internal state and will overwrite any previous solution performed in this context.

Parameters:

Name	Type	Attributes	Default	Description
`n`	number	<optional>	module:rise~RiseIdentity~N	Width in bits.
`k`	number	<optional>	module:rise~RiseIdentity~K	Solution length.
`epoch`	buffer	<optional>	module:rise~RiseIdentity~MAGIC	Prepended to public key before hashing. This can be used to segment protocol versions by changing this value which would render solutions generated with a previous or otherwise different value invalid and require a new solution.

Source: index.js, line 152

Returns:

Type:: Promise.<module:rise~RiseSolution>

toJSON() → {object}

Returns a plain object representation of this identity, serializable to JSON.

Source: index.js, line 168

Returns:

Type:: object

(static) generate(zeroesopt, nopt, kopt, epochopt) → {module:rise~RiseIdentity}

"Mines" a new module:rise~RiseIdentity and iteratively generates module:rise~RiseSolutions until one is found that satisfies the stated difficulty.

Parameters:

Name	Type	Attributes	Default	Description
`zeroes`	number	<optional>	module:rise~RiseIdentity~Z	Difficulty level expressed in number of leading zero bits.
`n`	number	<optional>	module:rise~RiseIdentity~N	Width in bits.
`k`	number	<optional>	module:rise~RiseIdentity~K	Solution length.
`epoch`	buffer	<optional>	module:rise~RiseIdentity~MAGIC	Network magic number.

Source: index.js, line 249

Returns:

Type:: module:rise~RiseIdentity

(static) unlock(password, data, saltopt) → {modulex:rise~RiseIdentity}

Decrypts the blob given the password and creates a new instance.

Parameters:

Name	Type	Attributes	Default	Description
`password`	string			User supplied passphrase for decryption.
`data`	buffer			Binary blob of encrypted identity.
`salt`	buffer	<optional>	module:rise~RiseIdentity~SALT	Salt for pbkdf2.

Source: index.js, line 221

Returns:

Type:: modulex:rise~RiseIdentity