org.bitcoinj.wallet

Class Protos.Key

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

org.bitcoinj.wallet.Protos.Key

All Implemented Interfaces:

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

Enclosing class:

Protos

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

Protobuf type wallet.Key

 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.
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

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	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 com.google.protobuf.Parser<Protos.Key>	PARSER
static int	PUBLIC_KEY_FIELD_NUMBER
static int	SECRET_BYTES_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders

Method Summary

Modifier and Type	Method and Description
long	getCreationTimestamp() optional int64 creation_timestamp = 5;
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() optional bytes deterministic_seed = 8;
Protos.EncryptedData	getEncryptedData() optional .wallet.EncryptedData encrypted_data = 6;
Protos.EncryptedDataOrBuilder	getEncryptedDataOrBuilder() optional .wallet.EncryptedData encrypted_data = 6;
Protos.EncryptedData	getEncryptedDeterministicSeed() optional .wallet.EncryptedData encrypted_deterministic_seed = 9;
Protos.EncryptedDataOrBuilder	getEncryptedDeterministicSeedOrBuilder() optional .wallet.EncryptedData encrypted_deterministic_seed = 9;
String	getLabel() optional string label = 4;
com.google.protobuf.ByteString	getLabelBytes() optional string label = 4;
com.google.protobuf.Parser<Protos.Key>	getParserForType()
com.google.protobuf.ByteString	getPublicKey() optional bytes public_key = 3;
com.google.protobuf.ByteString	getSecretBytes() optional bytes secret_bytes = 2;
int	getSerializedSize()
Protos.Key.Type	getType() required .wallet.Key.Type type = 1;
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasCreationTimestamp() optional int64 creation_timestamp = 5;
boolean	hasDeterministicKey() optional .wallet.DeterministicKey deterministic_key = 7;
boolean	hasDeterministicSeed() optional bytes deterministic_seed = 8;
boolean	hasEncryptedData() optional .wallet.EncryptedData encrypted_data = 6;
boolean	hasEncryptedDeterministicSeed() optional .wallet.EncryptedData encrypted_deterministic_seed = 9;
boolean	hasLabel() optional string label = 4;
boolean	hasPublicKey() optional bytes public_key = 3;
boolean	hasSecretBytes() optional bytes secret_bytes = 2;
boolean	hasType() required .wallet.Key.Type type = 1;
protected com.google.protobuf.GeneratedMessage.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.GeneratedMessage.BuilderParent parent)
static Protos.Key	parseDelimitedFrom(InputStream input)
static Protos.Key	parseDelimitedFrom(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(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(InputStream input)
static Protos.Key	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Protos.Key.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.Key> PARSER

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

Method Detail

getDefaultInstance

public static Protos.Key getDefaultInstance()

getDefaultInstanceForType

public Protos.Key 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.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.GeneratedMessage

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

optional bytes secret_bytes = 2;

 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.
 

Specified by:

hasSecretBytes in interface Protos.KeyOrBuilder

getSecretBytes

public com.google.protobuf.ByteString getSecretBytes()

optional bytes secret_bytes = 2;

 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.
 

Specified by:

getSecretBytes in interface Protos.KeyOrBuilder

hasEncryptedData

public boolean hasEncryptedData()

optional .wallet.EncryptedData encrypted_data = 6;

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

Specified by:

hasEncryptedData in interface Protos.KeyOrBuilder

getEncryptedData

public Protos.EncryptedData getEncryptedData()

optional .wallet.EncryptedData encrypted_data = 6;

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

Specified by:

getEncryptedData in interface Protos.KeyOrBuilder

getEncryptedDataOrBuilder

public Protos.EncryptedDataOrBuilder getEncryptedDataOrBuilder()

optional .wallet.EncryptedData encrypted_data = 6;

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

Specified by:

getEncryptedDataOrBuilder in interface Protos.KeyOrBuilder

hasPublicKey

public boolean hasPublicKey()

optional bytes public_key = 3;

 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.
 

Specified by:

hasPublicKey in interface Protos.KeyOrBuilder

getPublicKey

public com.google.protobuf.ByteString getPublicKey()

optional bytes public_key = 3;

 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.
 

Specified by:

getPublicKey in interface Protos.KeyOrBuilder

hasLabel

public boolean hasLabel()

optional string label = 4;

 User-provided label associated with the key.
 

Specified by:

hasLabel in interface Protos.KeyOrBuilder

getLabel

public String getLabel()

optional string label = 4;

 User-provided label associated with the key.
 

Specified by:

getLabel in interface Protos.KeyOrBuilder

getLabelBytes

public com.google.protobuf.ByteString getLabelBytes()

optional string label = 4;

 User-provided label associated with the key.
 

Specified by:

getLabelBytes in interface Protos.KeyOrBuilder

hasCreationTimestamp

public boolean hasCreationTimestamp()

optional int64 creation_timestamp = 5;

 Timestamp stored as millis since epoch. Useful for skipping block bodies before this point. Only reason it's
 optional is that some very old wallets don't have this data.
 

Specified by:

hasCreationTimestamp in interface Protos.KeyOrBuilder

getCreationTimestamp

public long getCreationTimestamp()

optional int64 creation_timestamp = 5;

 Timestamp stored as millis since epoch. Useful for skipping block bodies before this point. Only reason it's
 optional is that some very old wallets don't have this data.
 

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

optional bytes deterministic_seed = 8;

 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.
 

Specified by:

hasDeterministicSeed in interface Protos.KeyOrBuilder

getDeterministicSeed

public com.google.protobuf.ByteString getDeterministicSeed()

optional bytes deterministic_seed = 8;

 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.
 

Specified by:

getDeterministicSeed in interface Protos.KeyOrBuilder

hasEncryptedDeterministicSeed

public boolean hasEncryptedDeterministicSeed()

optional .wallet.EncryptedData encrypted_deterministic_seed = 9;

 Encrypted version of the seed
 

Specified by:

hasEncryptedDeterministicSeed in interface Protos.KeyOrBuilder

getEncryptedDeterministicSeed

public Protos.EncryptedData getEncryptedDeterministicSeed()

optional .wallet.EncryptedData encrypted_deterministic_seed = 9;

 Encrypted version of the seed
 

Specified by:

getEncryptedDeterministicSeed in interface Protos.KeyOrBuilder

getEncryptedDeterministicSeedOrBuilder

public Protos.EncryptedDataOrBuilder getEncryptedDeterministicSeedOrBuilder()

optional .wallet.EncryptedData encrypted_deterministic_seed = 9;

 Encrypted version of the seed
 

Specified by:

getEncryptedDeterministicSeedOrBuilder 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.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.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(InputStream input)
                            throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilder

public static Protos.Key.Builder newBuilder()

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(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.GeneratedMessage.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessage