org.bitcoinj.wallet

Class Protos.DeterministicKey.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

com.google.protobuf.GeneratedMessageV3.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, java.lang.Cloneable, Protos.DeterministicKeyOrBuilder

Enclosing class:

Protos.DeterministicKey

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

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

Protobuf type wallet.DeterministicKey

Method Summary

Modifier and Type	Method and Description
Protos.DeterministicKey.Builder	addAllPath(java.lang.Iterable<? extends java.lang.Integer> values) The path through the key tree.
Protos.DeterministicKey.Builder	addPath(int value) The path through the key tree.
Protos.DeterministicKey.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Protos.DeterministicKey	build()
Protos.DeterministicKey	buildPartial()
Protos.DeterministicKey.Builder	clear()
Protos.DeterministicKey.Builder	clearChainCode() Random data that allows us to extend a key.
Protos.DeterministicKey.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Protos.DeterministicKey.Builder	clearIsFollowing() Flag indicating that this key is a root of a following chain.
Protos.DeterministicKey.Builder	clearIssuedSubkeys() 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.
Protos.DeterministicKey.Builder	clearLookaheadSize() optional uint32 lookahead_size = 4;
Protos.DeterministicKey.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Protos.DeterministicKey.Builder	clearPath() The path through the key tree.
Protos.DeterministicKey.Builder	clearSigsRequiredToSpend() Number of signatures required to spend.
Protos.DeterministicKey.Builder	clone()
com.google.protobuf.ByteString	getChainCode() Random data that allows us to extend a key.
Protos.DeterministicKey	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getIsFollowing() Flag indicating that this key is a root of a following chain.
int	getIssuedSubkeys() 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.
int	getLookaheadSize() optional uint32 lookahead_size = 4;
int	getPath(int index) The path through the key tree.
int	getPathCount() The path through the key tree.
java.util.List<java.lang.Integer>	getPathList() The path through the key tree.
int	getSigsRequiredToSpend() Number of signatures required to spend.
boolean	hasChainCode() Random data that allows us to extend a key.
boolean	hasIsFollowing() Flag indicating that this key is a root of a following chain.
boolean	hasIssuedSubkeys() 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.
boolean	hasLookaheadSize() optional uint32 lookahead_size = 4;
boolean	hasSigsRequiredToSpend() Number of signatures required to spend.
protected com.google.protobuf.GeneratedMessageV3.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	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Protos.DeterministicKey.Builder	setChainCode(com.google.protobuf.ByteString value) Random data that allows us to extend a key.
Protos.DeterministicKey.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Protos.DeterministicKey.Builder	setIsFollowing(boolean value) Flag indicating that this key is a root of a following chain.
Protos.DeterministicKey.Builder	setIssuedSubkeys(int value) 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.
Protos.DeterministicKey.Builder	setLookaheadSize(int value) optional uint32 lookahead_size = 4;
Protos.DeterministicKey.Builder	setPath(int index, int value) The path through the key tree.
Protos.DeterministicKey.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
Protos.DeterministicKey.Builder	setSigsRequiredToSpend(int value) Number of signatures required to spend.
Protos.DeterministicKey.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

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

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

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

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

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

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.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

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.GeneratedMessageV3.Builder<Protos.DeterministicKey.Builder>

setField

public Protos.DeterministicKey.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                java.lang.Object value)

Specified by:

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

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Protos.DeterministicKey.Builder>

clearField

public Protos.DeterministicKey.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

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

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Protos.DeterministicKey.Builder>

clearOneof

public Protos.DeterministicKey.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

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

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Protos.DeterministicKey.Builder>

setRepeatedField

public Protos.DeterministicKey.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        int index,
                                                        java.lang.Object value)

Specified by:

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

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Protos.DeterministicKey.Builder>

addRepeatedField

public Protos.DeterministicKey.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        java.lang.Object value)

Specified by:

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

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Protos.DeterministicKey.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.GeneratedMessageV3.Builder<Protos.DeterministicKey.Builder>

mergeFrom

public Protos.DeterministicKey.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws java.io.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:

java.io.IOException

hasChainCode

public boolean hasChainCode()

 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.
 

required bytes chain_code = 1;

Specified by:

hasChainCode in interface Protos.DeterministicKeyOrBuilder

getChainCode

public com.google.protobuf.ByteString getChainCode()

 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.
 

required bytes chain_code = 1;

Specified by:

getChainCode in interface Protos.DeterministicKeyOrBuilder

setChainCode

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

 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.
 

required bytes chain_code = 1;

clearChainCode

public Protos.DeterministicKey.Builder clearChainCode()

 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.
 

required bytes chain_code = 1;

getPathList

public java.util.List<java.lang.Integer> getPathList()

 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.
 

repeated uint32 path = 2;

Specified by:

getPathList in interface Protos.DeterministicKeyOrBuilder

getPathCount

public int getPathCount()

 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.
 

repeated uint32 path = 2;

Specified by:

getPathCount in interface Protos.DeterministicKeyOrBuilder

getPath

public int getPath(int index)

 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.
 

repeated uint32 path = 2;

Specified by:

getPath in interface Protos.DeterministicKeyOrBuilder

setPath

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

 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.
 

repeated uint32 path = 2;

addPath

public Protos.DeterministicKey.Builder addPath(int value)

 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.
 

repeated uint32 path = 2;

addAllPath

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

 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.
 

repeated uint32 path = 2;

clearPath

public Protos.DeterministicKey.Builder clearPath()

 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.
 

repeated uint32 path = 2;

hasIssuedSubkeys

public boolean hasIssuedSubkeys()

 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.
 

optional uint32 issued_subkeys = 3;

Specified by:

hasIssuedSubkeys in interface Protos.DeterministicKeyOrBuilder

getIssuedSubkeys

public int getIssuedSubkeys()

 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.
 

optional uint32 issued_subkeys = 3;

Specified by:

getIssuedSubkeys in interface Protos.DeterministicKeyOrBuilder

setIssuedSubkeys

public Protos.DeterministicKey.Builder setIssuedSubkeys(int value)

 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.
 

optional uint32 issued_subkeys = 3;

clearIssuedSubkeys

public Protos.DeterministicKey.Builder clearIssuedSubkeys()

 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.
 

optional uint32 issued_subkeys = 3;

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()

 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
 

optional bool isFollowing = 5;

Specified by:

hasIsFollowing in interface Protos.DeterministicKeyOrBuilder

getIsFollowing

public boolean getIsFollowing()

 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
 

optional bool isFollowing = 5;

Specified by:

getIsFollowing in interface Protos.DeterministicKeyOrBuilder

setIsFollowing

public Protos.DeterministicKey.Builder setIsFollowing(boolean value)

 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
 

optional bool isFollowing = 5;

clearIsFollowing

public Protos.DeterministicKey.Builder clearIsFollowing()

 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
 

optional bool isFollowing = 5;

hasSigsRequiredToSpend

public boolean hasSigsRequiredToSpend()

 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.
 

optional uint32 sigsRequiredToSpend = 6 [default = 1];

Specified by:

hasSigsRequiredToSpend in interface Protos.DeterministicKeyOrBuilder

getSigsRequiredToSpend

public int getSigsRequiredToSpend()

 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.
 

optional uint32 sigsRequiredToSpend = 6 [default = 1];

Specified by:

getSigsRequiredToSpend in interface Protos.DeterministicKeyOrBuilder

setSigsRequiredToSpend

public Protos.DeterministicKey.Builder setSigsRequiredToSpend(int value)

 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.
 

optional uint32 sigsRequiredToSpend = 6 [default = 1];

clearSigsRequiredToSpend

public Protos.DeterministicKey.Builder clearSigsRequiredToSpend()

 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.
 

optional uint32 sigsRequiredToSpend = 6 [default = 1];

setUnknownFields

public final Protos.DeterministicKey.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

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

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Protos.DeterministicKey.Builder>

mergeUnknownFields

public final Protos.DeterministicKey.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

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

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Protos.DeterministicKey.Builder>