org.bitcoinj.wallet

Class Protos.Key

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.bitcoinj.wallet.Protos.Key

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, Protos.KeyOrBuilder

Enclosing class:

Protos

public static final class Protos.Key
extends com.google.protobuf.GeneratedMessageV3
implements Protos.KeyOrBuilder

 A key used to control Bitcoin spending.
 Either the private key, the public key or both may be present.  It is recommended that
 if the private key is provided that the public key is provided too because deriving it is slow.
 If only the public key is provided, the key can only be used to watch the blockchain and verify
 transactions, and not for spending.
 

Protobuf type wallet.Key

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Protos.Key.Builder A key used to control Bitcoin spending.
static class	Protos.Key.OutputScriptType Protobuf enum wallet.Key.OutputScriptType
static class	Protos.Key.Type Protobuf enum wallet.Key.Type

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACCOUNT_PATH_FIELD_NUMBER
static int	CREATION_TIMESTAMP_FIELD_NUMBER
static int	DETERMINISTIC_KEY_FIELD_NUMBER
static int	DETERMINISTIC_SEED_FIELD_NUMBER
static int	ENCRYPTED_DATA_FIELD_NUMBER
static int	ENCRYPTED_DETERMINISTIC_SEED_FIELD_NUMBER
static int	LABEL_FIELD_NUMBER
static int	OUTPUT_SCRIPT_TYPE_FIELD_NUMBER
static com.google.protobuf.Parser<Protos.Key>	PARSER Deprecated.
static int	PUBLIC_KEY_FIELD_NUMBER
static int	SECRET_BYTES_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	getAccountPath(int index) The path to the root.
int	getAccountPathCount() The path to the root.
java.util.List<java.lang.Integer>	getAccountPathList() The path to the root.
long	getCreationTimestamp() Timestamp stored as millis since epoch.
static Protos.Key	getDefaultInstance()
Protos.Key	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Protos.DeterministicKey	getDeterministicKey() optional .wallet.DeterministicKey deterministic_key = 7;
Protos.DeterministicKeyOrBuilder	getDeterministicKeyOrBuilder() optional .wallet.DeterministicKey deterministic_key = 7;
com.google.protobuf.ByteString	getDeterministicSeed() The seed for a deterministic key hierarchy.
Protos.EncryptedData	getEncryptedData() If the secret data is encrypted, then secret_bytes is missing and this field is set.
Protos.EncryptedDataOrBuilder	getEncryptedDataOrBuilder() If the secret data is encrypted, then secret_bytes is missing and this field is set.
Protos.EncryptedData	getEncryptedDeterministicSeed() Encrypted version of the seed
Protos.EncryptedDataOrBuilder	getEncryptedDeterministicSeedOrBuilder() Encrypted version of the seed
java.lang.String	getLabel() User-provided label associated with the key.
com.google.protobuf.ByteString	getLabelBytes() User-provided label associated with the key.
Protos.Key.OutputScriptType	getOutputScriptType() Type of addresses (aka output scripts) to generate for receiving.
com.google.protobuf.Parser<Protos.Key>	getParserForType()
com.google.protobuf.ByteString	getPublicKey() The public EC key derived from the private key.
com.google.protobuf.ByteString	getSecretBytes() Either the private EC key bytes (without any ASN.1 wrapping), or the deterministic root seed.
int	getSerializedSize()
Protos.Key.Type	getType() required .wallet.Key.Type type = 1;
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasCreationTimestamp() Timestamp stored as millis since epoch.
boolean	hasDeterministicKey() optional .wallet.DeterministicKey deterministic_key = 7;
boolean	hasDeterministicSeed() The seed for a deterministic key hierarchy.
boolean	hasEncryptedData() If the secret data is encrypted, then secret_bytes is missing and this field is set.
boolean	hasEncryptedDeterministicSeed() Encrypted version of the seed
int	hashCode()
boolean	hasLabel() User-provided label associated with the key.
boolean	hasOutputScriptType() Type of addresses (aka output scripts) to generate for receiving.
boolean	hasPublicKey() The public EC key derived from the private key.
boolean	hasSecretBytes() Either the private EC key bytes (without any ASN.1 wrapping), or the deterministic root seed.
boolean	hasType() required .wallet.Key.Type type = 1;
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Protos.Key.Builder	newBuilder()
static Protos.Key.Builder	newBuilder(Protos.Key prototype)
Protos.Key.Builder	newBuilderForType()
protected Protos.Key.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Protos.Key	parseDelimitedFrom(java.io.InputStream input)
static Protos.Key	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.Key	parseFrom(byte[] data)
static Protos.Key	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.Key	parseFrom(java.nio.ByteBuffer data)
static Protos.Key	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.Key	parseFrom(com.google.protobuf.ByteString data)
static Protos.Key	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.Key	parseFrom(com.google.protobuf.CodedInputStream input)
static Protos.Key	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.Key	parseFrom(java.io.InputStream input)
static Protos.Key	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Protos.Key>	parser()
Protos.Key.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

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

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, 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, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

SECRET_BYTES_FIELD_NUMBER

public static final int SECRET_BYTES_FIELD_NUMBER

See Also:

Constant Field Values

ENCRYPTED_DATA_FIELD_NUMBER

public static final int ENCRYPTED_DATA_FIELD_NUMBER

See Also:

Constant Field Values

PUBLIC_KEY_FIELD_NUMBER

public static final int PUBLIC_KEY_FIELD_NUMBER

See Also:

Constant Field Values

LABEL_FIELD_NUMBER

public static final int LABEL_FIELD_NUMBER

See Also:

Constant Field Values

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER

See Also:

Constant Field Values

DETERMINISTIC_KEY_FIELD_NUMBER

public static final int DETERMINISTIC_KEY_FIELD_NUMBER

See Also:

Constant Field Values

DETERMINISTIC_SEED_FIELD_NUMBER

public static final int DETERMINISTIC_SEED_FIELD_NUMBER

See Also:

Constant Field Values

ENCRYPTED_DETERMINISTIC_SEED_FIELD_NUMBER

public static final int ENCRYPTED_DETERMINISTIC_SEED_FIELD_NUMBER

See Also:

Constant Field Values

ACCOUNT_PATH_FIELD_NUMBER

public static final int ACCOUNT_PATH_FIELD_NUMBER

See Also:

Constant Field Values

OUTPUT_SCRIPT_TYPE_FIELD_NUMBER

public static final int OUTPUT_SCRIPT_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<Protos.Key> PARSER

Deprecated.

Method Detail

getUnknownFields

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

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

hasType

public boolean hasType()

required .wallet.Key.Type type = 1;

Specified by:

hasType in interface Protos.KeyOrBuilder

getType

public Protos.Key.Type getType()

required .wallet.Key.Type type = 1;

Specified by:

getType in interface Protos.KeyOrBuilder

hasSecretBytes

public boolean hasSecretBytes()

 Either the private EC key bytes (without any ASN.1 wrapping), or the deterministic root seed.
 If the secret is encrypted, or this is a "watching entry" then this is missing.
 

optional bytes secret_bytes = 2;

Specified by:

hasSecretBytes in interface Protos.KeyOrBuilder

getSecretBytes

public com.google.protobuf.ByteString getSecretBytes()

 Either the private EC key bytes (without any ASN.1 wrapping), or the deterministic root seed.
 If the secret is encrypted, or this is a "watching entry" then this is missing.
 

optional bytes secret_bytes = 2;

Specified by:

getSecretBytes in interface Protos.KeyOrBuilder

hasEncryptedData

public boolean hasEncryptedData()

 If the secret data is encrypted, then secret_bytes is missing and this field is set.
 

optional .wallet.EncryptedData encrypted_data = 6;

Specified by:

hasEncryptedData in interface Protos.KeyOrBuilder

getEncryptedData

public Protos.EncryptedData getEncryptedData()

 If the secret data is encrypted, then secret_bytes is missing and this field is set.
 

optional .wallet.EncryptedData encrypted_data = 6;

Specified by:

getEncryptedData in interface Protos.KeyOrBuilder

getEncryptedDataOrBuilder

public Protos.EncryptedDataOrBuilder getEncryptedDataOrBuilder()

 If the secret data is encrypted, then secret_bytes is missing and this field is set.
 

optional .wallet.EncryptedData encrypted_data = 6;

Specified by:

getEncryptedDataOrBuilder in interface Protos.KeyOrBuilder

hasPublicKey

public boolean hasPublicKey()

 The public EC key derived from the private key. We allow both to be stored to avoid mobile clients having to
 do lots of slow EC math on startup. For DETERMINISTIC_MNEMONIC entries this is missing.
 

optional bytes public_key = 3;

Specified by:

hasPublicKey in interface Protos.KeyOrBuilder

getPublicKey

public com.google.protobuf.ByteString getPublicKey()

 The public EC key derived from the private key. We allow both to be stored to avoid mobile clients having to
 do lots of slow EC math on startup. For DETERMINISTIC_MNEMONIC entries this is missing.
 

optional bytes public_key = 3;

Specified by:

getPublicKey in interface Protos.KeyOrBuilder

hasLabel

public boolean hasLabel()

 User-provided label associated with the key.
 

optional string label = 4;

Specified by:

hasLabel in interface Protos.KeyOrBuilder

getLabel

public java.lang.String getLabel()

 User-provided label associated with the key.
 

optional string label = 4;

Specified by:

getLabel in interface Protos.KeyOrBuilder

getLabelBytes

public com.google.protobuf.ByteString getLabelBytes()

 User-provided label associated with the key.
 

optional string label = 4;

Specified by:

getLabelBytes in interface Protos.KeyOrBuilder

hasCreationTimestamp

public boolean hasCreationTimestamp()

 Timestamp stored as millis since epoch. Useful for skipping block bodies before this point. The reason it's
 optional is that keys derived from a parent don't have this data.
 

optional int64 creation_timestamp = 5;

Specified by:

hasCreationTimestamp in interface Protos.KeyOrBuilder

getCreationTimestamp

public long getCreationTimestamp()

 Timestamp stored as millis since epoch. Useful for skipping block bodies before this point. The reason it's
 optional is that keys derived from a parent don't have this data.
 

optional int64 creation_timestamp = 5;

Specified by:

getCreationTimestamp in interface Protos.KeyOrBuilder

hasDeterministicKey

public boolean hasDeterministicKey()

optional .wallet.DeterministicKey deterministic_key = 7;

Specified by:

hasDeterministicKey in interface Protos.KeyOrBuilder

getDeterministicKey

public Protos.DeterministicKey getDeterministicKey()

optional .wallet.DeterministicKey deterministic_key = 7;

Specified by:

getDeterministicKey in interface Protos.KeyOrBuilder

getDeterministicKeyOrBuilder

public Protos.DeterministicKeyOrBuilder getDeterministicKeyOrBuilder()

optional .wallet.DeterministicKey deterministic_key = 7;

Specified by:

getDeterministicKeyOrBuilder in interface Protos.KeyOrBuilder

hasDeterministicSeed

public boolean hasDeterministicSeed()

 The seed for a deterministic key hierarchy.  Derived from the mnemonic,
 but cached here for quick startup.  Only applicable to a DETERMINISTIC_MNEMONIC key entry.
 

optional bytes deterministic_seed = 8;

Specified by:

hasDeterministicSeed in interface Protos.KeyOrBuilder

getDeterministicSeed

public com.google.protobuf.ByteString getDeterministicSeed()

 The seed for a deterministic key hierarchy.  Derived from the mnemonic,
 but cached here for quick startup.  Only applicable to a DETERMINISTIC_MNEMONIC key entry.
 

optional bytes deterministic_seed = 8;

Specified by:

getDeterministicSeed in interface Protos.KeyOrBuilder

hasEncryptedDeterministicSeed

public boolean hasEncryptedDeterministicSeed()

 Encrypted version of the seed
 

optional .wallet.EncryptedData encrypted_deterministic_seed = 9;

Specified by:

hasEncryptedDeterministicSeed in interface Protos.KeyOrBuilder

getEncryptedDeterministicSeed

public Protos.EncryptedData getEncryptedDeterministicSeed()

 Encrypted version of the seed
 

optional .wallet.EncryptedData encrypted_deterministic_seed = 9;

Specified by:

getEncryptedDeterministicSeed in interface Protos.KeyOrBuilder

getEncryptedDeterministicSeedOrBuilder

public Protos.EncryptedDataOrBuilder getEncryptedDeterministicSeedOrBuilder()

 Encrypted version of the seed
 

optional .wallet.EncryptedData encrypted_deterministic_seed = 9;

Specified by:

getEncryptedDeterministicSeedOrBuilder in interface Protos.KeyOrBuilder

getAccountPathList

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

 The path to the root. Only applicable to a DETERMINISTIC_MNEMONIC key entry.
 

repeated uint32 account_path = 10 [packed = true];

Specified by:

getAccountPathList in interface Protos.KeyOrBuilder

getAccountPathCount

public int getAccountPathCount()

 The path to the root. Only applicable to a DETERMINISTIC_MNEMONIC key entry.
 

repeated uint32 account_path = 10 [packed = true];

Specified by:

getAccountPathCount in interface Protos.KeyOrBuilder

getAccountPath

public int getAccountPath(int index)

 The path to the root. Only applicable to a DETERMINISTIC_MNEMONIC key entry.
 

repeated uint32 account_path = 10 [packed = true];

Specified by:

getAccountPath in interface Protos.KeyOrBuilder

hasOutputScriptType

public boolean hasOutputScriptType()

 Type of addresses (aka output scripts) to generate for receiving.
 

optional .wallet.Key.OutputScriptType output_script_type = 11;

Specified by:

hasOutputScriptType in interface Protos.KeyOrBuilder

getOutputScriptType

public Protos.Key.OutputScriptType getOutputScriptType()

 Type of addresses (aka output scripts) to generate for receiving.
 

optional .wallet.Key.OutputScriptType output_script_type = 11;

Specified by:

getOutputScriptType in interface Protos.KeyOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

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

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Protos.Key parseFrom(java.nio.ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.Key parseFrom(java.nio.ByteBuffer data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.Key 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.Key parseFrom(byte[] data)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.Key parseFrom(java.io.InputStream input)
                            throws java.io.IOException

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

public static Protos.Key parseDelimitedFrom(java.io.InputStream input)
                                     throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

public static Protos.Key parseFrom(com.google.protobuf.CodedInputStream input)
                            throws java.io.IOException

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

newBuilderForType

public Protos.Key.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Protos.Key.Builder newBuilder()

newBuilder

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

toBuilder

public Protos.Key.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Protos.Key.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Protos.Key getDefaultInstance()

parser

public static com.google.protobuf.Parser<Protos.Key> parser()

getParserForType

public com.google.protobuf.Parser<Protos.Key> 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.GeneratedMessageV3

getDefaultInstanceForType

public Protos.Key getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder