org.bitcoinj.wallet

Class Protos.DeterministicKey

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

org.bitcoinj.wallet.Protos.DeterministicKey

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Protos.DeterministicKeyOrBuilder

Enclosing class:

Protos

public static final class Protos.DeterministicKey
extends com.google.protobuf.GeneratedMessage
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.
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Protos.DeterministicKey.Builder Protobuf type wallet.DeterministicKey

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.BuilderParent, com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessage.ExtendableBuilder>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingType extends com.google.protobuf.Message,Type>

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHAIN_CODE_FIELD_NUMBER
static int	ISFOLLOWING_FIELD_NUMBER
static int	ISSUED_SUBKEYS_FIELD_NUMBER
static int	LOOKAHEAD_SIZE_FIELD_NUMBER
static com.google.protobuf.Parser<Protos.DeterministicKey>	PARSER
static int	PATH_FIELD_NUMBER
static int	SIGSREQUIREDTOSPEND_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.ByteString	getChainCode() required bytes chain_code = 1;
static Protos.DeterministicKey	getDefaultInstance()
Protos.DeterministicKey	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getIsFollowing() optional bool isFollowing = 5;
int	getIssuedSubkeys() optional uint32 issued_subkeys = 3;
int	getLookaheadSize() optional uint32 lookahead_size = 4;
com.google.protobuf.Parser<Protos.DeterministicKey>	getParserForType()
int	getPath(int index) repeated uint32 path = 2;
int	getPathCount() repeated uint32 path = 2;
List<Integer>	getPathList() repeated uint32 path = 2;
int	getSerializedSize()
int	getSigsRequiredToSpend() optional uint32 sigsRequiredToSpend = 6 [default = 1];
com.google.protobuf.UnknownFieldSet	getUnknownFields()
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()
static Protos.DeterministicKey.Builder	newBuilder()
static Protos.DeterministicKey.Builder	newBuilder(Protos.DeterministicKey prototype)
Protos.DeterministicKey.Builder	newBuilderForType()
protected Protos.DeterministicKey.Builder	newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent)
static Protos.DeterministicKey	parseDelimitedFrom(InputStream input)
static Protos.DeterministicKey	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.DeterministicKey	parseFrom(byte[] data)
static Protos.DeterministicKey	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.DeterministicKey	parseFrom(com.google.protobuf.ByteString data)
static Protos.DeterministicKey	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.DeterministicKey	parseFrom(com.google.protobuf.CodedInputStream input)
static Protos.DeterministicKey	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.DeterministicKey	parseFrom(InputStream input)
static Protos.DeterministicKey	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Protos.DeterministicKey.Builder	toBuilder()
protected Object	writeReplace()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

getAllFields, getDescriptorForType, getField, getRepeatedField, getRepeatedFieldCount, hasField, makeExtensionsImmutable, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, parseUnknownField

Methods inherited from class com.google.protobuf.AbstractMessage

equals, findInitializationErrors, getInitializationErrorString, hashBoolean, hashCode, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARSER

public static com.google.protobuf.Parser<Protos.DeterministicKey> PARSER

CHAIN_CODE_FIELD_NUMBER

public static final int CHAIN_CODE_FIELD_NUMBER

See Also:

Constant Field Values

PATH_FIELD_NUMBER

public static final int PATH_FIELD_NUMBER

See Also:

Constant Field Values

ISSUED_SUBKEYS_FIELD_NUMBER

public static final int ISSUED_SUBKEYS_FIELD_NUMBER

See Also:

Constant Field Values

LOOKAHEAD_SIZE_FIELD_NUMBER

public static final int LOOKAHEAD_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

ISFOLLOWING_FIELD_NUMBER

public static final int ISFOLLOWING_FIELD_NUMBER

See Also:

Constant Field Values

SIGSREQUIREDTOSPEND_FIELD_NUMBER

public static final int SIGSREQUIREDTOSPEND_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDefaultInstance

public static Protos.DeterministicKey getDefaultInstance()

getDefaultInstanceForType

public Protos.DeterministicKey getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessage

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

getParserForType

public com.google.protobuf.Parser<Protos.DeterministicKey> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

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

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

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

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

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

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.AbstractMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.AbstractMessage

writeReplace

protected Object writeReplace()
                       throws ObjectStreamException

Overrides:

writeReplace in class com.google.protobuf.GeneratedMessage

Throws:

ObjectStreamException

parseFrom

public static Protos.DeterministicKey parseFrom(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.DeterministicKey parseFrom(com.google.protobuf.ByteString data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.DeterministicKey parseFrom(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.DeterministicKey parseFrom(byte[] data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.DeterministicKey parseFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static Protos.DeterministicKey parseFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static Protos.DeterministicKey parseDelimitedFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static Protos.DeterministicKey parseDelimitedFrom(InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

parseFrom

public static Protos.DeterministicKey parseFrom(com.google.protobuf.CodedInputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilder

public static Protos.DeterministicKey.Builder newBuilder()

newBuilderForType

public Protos.DeterministicKey.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Protos.DeterministicKey.Builder newBuilder(Protos.DeterministicKey prototype)

toBuilder

public Protos.DeterministicKey.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Protos.DeterministicKey.Builder newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessage