org.bitcoinj.wallet

Class Protos.DeterministicKey.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder<BuilderType>

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessage.Builder<Protos.DeterministicKey.Builder>

org.bitcoinj.wallet.Protos.DeterministicKey.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, Protos.DeterministicKeyOrBuilder

Enclosing class:

Protos.DeterministicKey

public static final class Protos.DeterministicKey.Builder
extends com.google.protobuf.GeneratedMessage.Builder<Protos.DeterministicKey.Builder>
implements Protos.DeterministicKeyOrBuilder

Protobuf type wallet.DeterministicKey

 Data attached to a Key message that defines the data needed by the BIP32 deterministic key hierarchy algorithm.
 

Method Summary

Modifier and Type	Method and Description
Protos.DeterministicKey.Builder	addAllPath(Iterable<? extends Integer> values) repeated uint32 path = 2;
Protos.DeterministicKey.Builder	addPath(int value) repeated uint32 path = 2;
Protos.DeterministicKey	build()
Protos.DeterministicKey	buildPartial()
Protos.DeterministicKey.Builder	clear()
Protos.DeterministicKey.Builder	clearChainCode() required bytes chain_code = 1;
Protos.DeterministicKey.Builder	clearIsFollowing() optional bool isFollowing = 5;
Protos.DeterministicKey.Builder	clearIssuedSubkeys() optional uint32 issued_subkeys = 3;
Protos.DeterministicKey.Builder	clearLookaheadSize() optional uint32 lookahead_size = 4;
Protos.DeterministicKey.Builder	clearPath() repeated uint32 path = 2;
Protos.DeterministicKey.Builder	clearSigsRequiredToSpend() optional uint32 sigsRequiredToSpend = 6 [default = 1];
Protos.DeterministicKey.Builder	clone()
com.google.protobuf.ByteString	getChainCode() required bytes chain_code = 1;
Protos.DeterministicKey	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getIsFollowing() optional bool isFollowing = 5;
int	getIssuedSubkeys() optional uint32 issued_subkeys = 3;
int	getLookaheadSize() optional uint32 lookahead_size = 4;
int	getPath(int index) repeated uint32 path = 2;
int	getPathCount() repeated uint32 path = 2;
List<Integer>	getPathList() repeated uint32 path = 2;
int	getSigsRequiredToSpend() optional uint32 sigsRequiredToSpend = 6 [default = 1];
boolean	hasChainCode() required bytes chain_code = 1;
boolean	hasIsFollowing() optional bool isFollowing = 5;
boolean	hasIssuedSubkeys() optional uint32 issued_subkeys = 3;
boolean	hasLookaheadSize() optional uint32 lookahead_size = 4;
boolean	hasSigsRequiredToSpend() optional uint32 sigsRequiredToSpend = 6 [default = 1];
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Protos.DeterministicKey.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Protos.DeterministicKey.Builder	mergeFrom(com.google.protobuf.Message other)
Protos.DeterministicKey.Builder	mergeFrom(Protos.DeterministicKey other)
Protos.DeterministicKey.Builder	setChainCode(com.google.protobuf.ByteString value) required bytes chain_code = 1;
Protos.DeterministicKey.Builder	setIsFollowing(boolean value) optional bool isFollowing = 5;
Protos.DeterministicKey.Builder	setIssuedSubkeys(int value) optional uint32 issued_subkeys = 3;
Protos.DeterministicKey.Builder	setLookaheadSize(int value) optional uint32 lookahead_size = 4;
Protos.DeterministicKey.Builder	setPath(int index, int value) repeated uint32 path = 2;
Protos.DeterministicKey.Builder	setSigsRequiredToSpend(int value) optional uint32 sigsRequiredToSpend = 6 [default = 1];

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, getAllFields, getField, getFieldBuilder, getParentForChildren, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, isClean, markClean, mergeUnknownFields, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, newUninitializedMessageException

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Protos.DeterministicKey.Builder>

clear

public Protos.DeterministicKey.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<Protos.DeterministicKey.Builder>

clone

public Protos.DeterministicKey.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessage.Builder<Protos.DeterministicKey.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Protos.DeterministicKey.Builder>

getDefaultInstanceForType

public Protos.DeterministicKey getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Protos.DeterministicKey build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Protos.DeterministicKey buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public Protos.DeterministicKey.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Protos.DeterministicKey.Builder>

mergeFrom

public Protos.DeterministicKey.Builder mergeFrom(Protos.DeterministicKey other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Protos.DeterministicKey.Builder>

mergeFrom

public Protos.DeterministicKey.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Protos.DeterministicKey.Builder>

Throws:

IOException

hasChainCode

public boolean hasChainCode()

required bytes chain_code = 1;

 Random data that allows us to extend a key. Without this, we can't figure out the next key in the chain and
 should just treat it as a regular ORIGINAL type key.
 

Specified by:

hasChainCode in interface Protos.DeterministicKeyOrBuilder

getChainCode

public com.google.protobuf.ByteString getChainCode()

required bytes chain_code = 1;

 Random data that allows us to extend a key. Without this, we can't figure out the next key in the chain and
 should just treat it as a regular ORIGINAL type key.
 

Specified by:

getChainCode in interface Protos.DeterministicKeyOrBuilder

setChainCode

public Protos.DeterministicKey.Builder setChainCode(com.google.protobuf.ByteString value)

required bytes chain_code = 1;

 Random data that allows us to extend a key. Without this, we can't figure out the next key in the chain and
 should just treat it as a regular ORIGINAL type key.
 

clearChainCode

public Protos.DeterministicKey.Builder clearChainCode()

required bytes chain_code = 1;

 Random data that allows us to extend a key. Without this, we can't figure out the next key in the chain and
 should just treat it as a regular ORIGINAL type key.
 

getPathList

public List<Integer> getPathList()

repeated uint32 path = 2;

 The path through the key tree. Each number is encoded in the standard form: high bit set for private derivation
 and high bit unset for public derivation.
 

Specified by:

getPathList in interface Protos.DeterministicKeyOrBuilder

getPathCount

public int getPathCount()

repeated uint32 path = 2;

 The path through the key tree. Each number is encoded in the standard form: high bit set for private derivation
 and high bit unset for public derivation.
 

Specified by:

getPathCount in interface Protos.DeterministicKeyOrBuilder

getPath

public int getPath(int index)

repeated uint32 path = 2;

 The path through the key tree. Each number is encoded in the standard form: high bit set for private derivation
 and high bit unset for public derivation.
 

Specified by:

getPath in interface Protos.DeterministicKeyOrBuilder

setPath

public Protos.DeterministicKey.Builder setPath(int index,
                                               int value)

repeated uint32 path = 2;

 The path through the key tree. Each number is encoded in the standard form: high bit set for private derivation
 and high bit unset for public derivation.
 

addPath

public Protos.DeterministicKey.Builder addPath(int value)

repeated uint32 path = 2;

 The path through the key tree. Each number is encoded in the standard form: high bit set for private derivation
 and high bit unset for public derivation.
 

addAllPath

public Protos.DeterministicKey.Builder addAllPath(Iterable<? extends Integer> values)

repeated uint32 path = 2;

 The path through the key tree. Each number is encoded in the standard form: high bit set for private derivation
 and high bit unset for public derivation.
 

clearPath

public Protos.DeterministicKey.Builder clearPath()

repeated uint32 path = 2;

 The path through the key tree. Each number is encoded in the standard form: high bit set for private derivation
 and high bit unset for public derivation.
 

hasIssuedSubkeys

public boolean hasIssuedSubkeys()

optional uint32 issued_subkeys = 3;

 How many children of this key have been issued, that is, given to the user when they requested a fresh key?
 For the parents of keys being handed out, this is always less than the true number of children: the difference is
 called the lookahead zone. These keys are put into Bloom filters so we can spot transactions made by clones of
 this wallet - for instance when restoring from backup or if the seed was shared between devices.

 If this field is missing it means we're not issuing subkeys of this key to users.
 

Specified by:

hasIssuedSubkeys in interface Protos.DeterministicKeyOrBuilder

getIssuedSubkeys

public int getIssuedSubkeys()

optional uint32 issued_subkeys = 3;

 How many children of this key have been issued, that is, given to the user when they requested a fresh key?
 For the parents of keys being handed out, this is always less than the true number of children: the difference is
 called the lookahead zone. These keys are put into Bloom filters so we can spot transactions made by clones of
 this wallet - for instance when restoring from backup or if the seed was shared between devices.

 If this field is missing it means we're not issuing subkeys of this key to users.
 

Specified by:

getIssuedSubkeys in interface Protos.DeterministicKeyOrBuilder

setIssuedSubkeys

public Protos.DeterministicKey.Builder setIssuedSubkeys(int value)

optional uint32 issued_subkeys = 3;

 How many children of this key have been issued, that is, given to the user when they requested a fresh key?
 For the parents of keys being handed out, this is always less than the true number of children: the difference is
 called the lookahead zone. These keys are put into Bloom filters so we can spot transactions made by clones of
 this wallet - for instance when restoring from backup or if the seed was shared between devices.

 If this field is missing it means we're not issuing subkeys of this key to users.
 

clearIssuedSubkeys

public Protos.DeterministicKey.Builder clearIssuedSubkeys()

optional uint32 issued_subkeys = 3;

 How many children of this key have been issued, that is, given to the user when they requested a fresh key?
 For the parents of keys being handed out, this is always less than the true number of children: the difference is
 called the lookahead zone. These keys are put into Bloom filters so we can spot transactions made by clones of
 this wallet - for instance when restoring from backup or if the seed was shared between devices.

 If this field is missing it means we're not issuing subkeys of this key to users.
 

hasLookaheadSize

public boolean hasLookaheadSize()

optional uint32 lookahead_size = 4;

Specified by:

hasLookaheadSize in interface Protos.DeterministicKeyOrBuilder

getLookaheadSize

public int getLookaheadSize()

optional uint32 lookahead_size = 4;

Specified by:

getLookaheadSize in interface Protos.DeterministicKeyOrBuilder

setLookaheadSize

public Protos.DeterministicKey.Builder setLookaheadSize(int value)

optional uint32 lookahead_size = 4;

clearLookaheadSize

public Protos.DeterministicKey.Builder clearLookaheadSize()

optional uint32 lookahead_size = 4;

hasIsFollowing

public boolean hasIsFollowing()

optional bool isFollowing = 5;

 Flag indicating that this key is a root of a following chain. This chain is following the next non-following chain.
 Following/followed chains concept is used for married keychains, where the set of keys combined together to produce
 a single P2SH multisignature address
 

Specified by:

hasIsFollowing in interface Protos.DeterministicKeyOrBuilder

getIsFollowing

public boolean getIsFollowing()

optional bool isFollowing = 5;

 Flag indicating that this key is a root of a following chain. This chain is following the next non-following chain.
 Following/followed chains concept is used for married keychains, where the set of keys combined together to produce
 a single P2SH multisignature address
 

Specified by:

getIsFollowing in interface Protos.DeterministicKeyOrBuilder

setIsFollowing

public Protos.DeterministicKey.Builder setIsFollowing(boolean value)

optional bool isFollowing = 5;

 Flag indicating that this key is a root of a following chain. This chain is following the next non-following chain.
 Following/followed chains concept is used for married keychains, where the set of keys combined together to produce
 a single P2SH multisignature address
 

clearIsFollowing

public Protos.DeterministicKey.Builder clearIsFollowing()

optional bool isFollowing = 5;

 Flag indicating that this key is a root of a following chain. This chain is following the next non-following chain.
 Following/followed chains concept is used for married keychains, where the set of keys combined together to produce
 a single P2SH multisignature address
 

hasSigsRequiredToSpend

public boolean hasSigsRequiredToSpend()

optional uint32 sigsRequiredToSpend = 6 [default = 1];

 Number of signatures required to spend. This field is needed only for married keychains to reconstruct KeyChain
 and represents the N value from N-of-M CHECKMULTISIG script. For regular single keychains it will always be 1.
 

Specified by:

hasSigsRequiredToSpend in interface Protos.DeterministicKeyOrBuilder

getSigsRequiredToSpend

public int getSigsRequiredToSpend()

optional uint32 sigsRequiredToSpend = 6 [default = 1];

 Number of signatures required to spend. This field is needed only for married keychains to reconstruct KeyChain
 and represents the N value from N-of-M CHECKMULTISIG script. For regular single keychains it will always be 1.
 

Specified by:

getSigsRequiredToSpend in interface Protos.DeterministicKeyOrBuilder

setSigsRequiredToSpend

public Protos.DeterministicKey.Builder setSigsRequiredToSpend(int value)

optional uint32 sigsRequiredToSpend = 6 [default = 1];

 Number of signatures required to spend. This field is needed only for married keychains to reconstruct KeyChain
 and represents the N value from N-of-M CHECKMULTISIG script. For regular single keychains it will always be 1.
 

clearSigsRequiredToSpend

public Protos.DeterministicKey.Builder clearSigsRequiredToSpend()

optional uint32 sigsRequiredToSpend = 6 [default = 1];

 Number of signatures required to spend. This field is needed only for married keychains to reconstruct KeyChain
 and represents the N value from N-of-M CHECKMULTISIG script. For regular single keychains it will always be 1.