org.bitcoinj.wallet

Class DeterministicKeyChain.Builder<T extends DeterministicKeyChain.Builder<T>>

java.lang.Object

org.bitcoinj.wallet.DeterministicKeyChain.Builder<T>

Direct Known Subclasses:

MarriedKeyChain.Builder

Enclosing class:

DeterministicKeyChain

public static class DeterministicKeyChain.Builder<T extends DeterministicKeyChain.Builder<T>>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected int	bits
protected byte[]	entropy
protected String	passphrase
protected SecureRandom	random
protected DeterministicSeed	seed
protected long	seedCreationTimeSecs
protected DeterministicKey	watchingKey

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder()

Method Summary

Modifier and Type	Method and Description
DeterministicKeyChain	build()
T	entropy(byte[] entropy) Creates a deterministic key chain starting from the given entropy.
protected String	getPassphrase()
T	passphrase(String passphrase) The passphrase to use with the generated mnemonic, or null if you would like to use the default empty string.
T	random(SecureRandom random) Generates a new key chain with 128 bits of entropy selected randomly from the given SecureRandom object.
T	random(SecureRandom random, int bits) Generates a new key chain with entropy selected randomly from the given SecureRandom object and of the requested size in bits.
T	seed(DeterministicSeed seed) Creates a deterministic key chain starting from the given seed.
T	seedCreationTimeSecs(long seedCreationTimeSecs)
protected T	self()
T	watchingKey(DeterministicKey watchingKey)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

random

protected SecureRandom random

bits

protected int bits

passphrase

protected String passphrase

seedCreationTimeSecs

protected long seedCreationTimeSecs

entropy

protected byte[] entropy

seed

protected DeterministicSeed seed

watchingKey

protected DeterministicKey watchingKey

Constructor Detail

Builder

protected Builder()

Method Detail

self

protected T self()

entropy

public T entropy(byte[] entropy)

Creates a deterministic key chain starting from the given entropy. All keys yielded by this chain will be the same if the starting entropy is the same. You should provide the creation time in seconds since the UNIX epoch for the seed: this lets us know from what part of the chain we can expect to see derived keys appear.

seed

public T seed(DeterministicSeed seed)

Creates a deterministic key chain starting from the given seed. All keys yielded by this chain will be the same if the starting seed is the same.

random

public T random(SecureRandom random,
                int bits)

Generates a new key chain with entropy selected randomly from the given SecureRandom object and of the requested size in bits. The derived seed is further protected with a user selected passphrase (see BIP 39).

Parameters:

random - the random number generator - use new SecureRandom().

bits - The number of bits of entropy to use when generating entropy. Either 128 (default), 192 or 256.

random

public T random(SecureRandom random)

Generates a new key chain with 128 bits of entropy selected randomly from the given SecureRandom object. The derived seed is further protected with a user selected passphrase (see BIP 39).

Parameters:

random - the random number generator - use new SecureRandom().

watchingKey

public T watchingKey(DeterministicKey watchingKey)

seedCreationTimeSecs

public T seedCreationTimeSecs(long seedCreationTimeSecs)

passphrase

public T passphrase(String passphrase)

The passphrase to use with the generated mnemonic, or null if you would like to use the default empty string. Currently must be the empty string.

build

public DeterministicKeyChain build()

getPassphrase

protected String getPassphrase()