org.lightningj.lnd.signer.proto

Class SignerOuterClass.SignDescriptor

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.lightningj.lnd.signer.proto.SignerOuterClass.SignDescriptor

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, SignerOuterClass.SignDescriptorOrBuilder

Enclosing class:

SignerOuterClass

public static final class SignerOuterClass.SignDescriptor
extends com.google.protobuf.GeneratedMessageV3
implements SignerOuterClass.SignDescriptorOrBuilder

Protobuf type signrpc.SignDescriptor

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SignerOuterClass.SignDescriptor.Builder Protobuf type signrpc.SignDescriptor

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DOUBLE_TWEAK_FIELD_NUMBER
static int	INPUT_INDEX_FIELD_NUMBER
static int	KEY_DESC_FIELD_NUMBER
static int	OUTPUT_FIELD_NUMBER
static int	SIGHASH_FIELD_NUMBER
static int	SIGN_METHOD_FIELD_NUMBER
static int	SINGLE_TWEAK_FIELD_NUMBER
static int	TAP_TWEAK_FIELD_NUMBER
static int	WITNESS_SCRIPT_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)
static SignerOuterClass.SignDescriptor	getDefaultInstance()
SignerOuterClass.SignDescriptor	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.ByteString	getDoubleTweak() A private key that will be used in combination with its corresponding private key to derive the private key that is to be used to sign the target input.
int	getInputIndex() The target input within the transaction that should be signed.
SignerOuterClass.KeyDescriptor	getKeyDesc() A descriptor that precisely describes *which* key to use for signing.
SignerOuterClass.KeyDescriptorOrBuilder	getKeyDescOrBuilder() A descriptor that precisely describes *which* key to use for signing.
SignerOuterClass.TxOut	getOutput() A description of the output being spent.
SignerOuterClass.TxOutOrBuilder	getOutputOrBuilder() A description of the output being spent.
com.google.protobuf.Parser<SignerOuterClass.SignDescriptor>	getParserForType()
int	getSerializedSize()
int	getSighash() The target sighash type that should be used when generating the final sighash, and signature.
SignerOuterClass.SignMethod	getSignMethod() The sign method specifies how the input should be signed.
int	getSignMethodValue() The sign method specifies how the input should be signed.
com.google.protobuf.ByteString	getSingleTweak() A scalar value that will be added to the private key corresponding to the above public key to obtain the private key to be used to sign this input.
com.google.protobuf.ByteString	getTapTweak() The 32 byte input to the taproot tweak derivation that is used to derive the output key from an internal key: outputKey = internalKey + tagged_hash("tapTweak", internalKey || tapTweak).
com.google.protobuf.ByteString	getWitnessScript() The full script required to properly redeem the output.
int	hashCode()
boolean	hasKeyDesc() A descriptor that precisely describes *which* key to use for signing.
boolean	hasOutput() A description of the output being spent.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SignerOuterClass.SignDescriptor.Builder	newBuilder()
static SignerOuterClass.SignDescriptor.Builder	newBuilder(SignerOuterClass.SignDescriptor prototype)
SignerOuterClass.SignDescriptor.Builder	newBuilderForType()
protected SignerOuterClass.SignDescriptor.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SignerOuterClass.SignDescriptor	parseDelimitedFrom(java.io.InputStream input)
static SignerOuterClass.SignDescriptor	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SignerOuterClass.SignDescriptor	parseFrom(byte[] data)
static SignerOuterClass.SignDescriptor	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SignerOuterClass.SignDescriptor	parseFrom(java.nio.ByteBuffer data)
static SignerOuterClass.SignDescriptor	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SignerOuterClass.SignDescriptor	parseFrom(com.google.protobuf.ByteString data)
static SignerOuterClass.SignDescriptor	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SignerOuterClass.SignDescriptor	parseFrom(com.google.protobuf.CodedInputStream input)
static SignerOuterClass.SignDescriptor	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SignerOuterClass.SignDescriptor	parseFrom(java.io.InputStream input)
static SignerOuterClass.SignDescriptor	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SignerOuterClass.SignDescriptor>	parser()
SignerOuterClass.SignDescriptor.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

KEY_DESC_FIELD_NUMBER

public static final int KEY_DESC_FIELD_NUMBER

See Also:

Constant Field Values

SINGLE_TWEAK_FIELD_NUMBER

public static final int SINGLE_TWEAK_FIELD_NUMBER

See Also:

Constant Field Values

DOUBLE_TWEAK_FIELD_NUMBER

public static final int DOUBLE_TWEAK_FIELD_NUMBER

See Also:

Constant Field Values

TAP_TWEAK_FIELD_NUMBER

public static final int TAP_TWEAK_FIELD_NUMBER

See Also:

Constant Field Values

WITNESS_SCRIPT_FIELD_NUMBER

public static final int WITNESS_SCRIPT_FIELD_NUMBER

See Also:

Constant Field Values

OUTPUT_FIELD_NUMBER

public static final int OUTPUT_FIELD_NUMBER

See Also:

Constant Field Values

SIGHASH_FIELD_NUMBER

public static final int SIGHASH_FIELD_NUMBER

See Also:

Constant Field Values

INPUT_INDEX_FIELD_NUMBER

public static final int INPUT_INDEX_FIELD_NUMBER

See Also:

Constant Field Values

SIGN_METHOD_FIELD_NUMBER

public static final int SIGN_METHOD_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance 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

hasKeyDesc

public boolean hasKeyDesc()

A descriptor that precisely describes *which* key to use for signing. This
may provide the raw public key directly, or require the Signer to re-derive
the key according to the populated derivation path.

Note that if the key descriptor was obtained through walletrpc.DeriveKey,
then the key locator MUST always be provided, since the derived keys are not
persisted unlike with DeriveNextKey.
 

.signrpc.KeyDescriptor key_desc = 1;

Specified by:

hasKeyDesc in interface SignerOuterClass.SignDescriptorOrBuilder

Returns:

Whether the keyDesc field is set.

getKeyDesc

public SignerOuterClass.KeyDescriptor getKeyDesc()

A descriptor that precisely describes *which* key to use for signing. This
may provide the raw public key directly, or require the Signer to re-derive
the key according to the populated derivation path.

Note that if the key descriptor was obtained through walletrpc.DeriveKey,
then the key locator MUST always be provided, since the derived keys are not
persisted unlike with DeriveNextKey.
 

.signrpc.KeyDescriptor key_desc = 1;

Specified by:

getKeyDesc in interface SignerOuterClass.SignDescriptorOrBuilder

Returns:

The keyDesc.

getKeyDescOrBuilder

public SignerOuterClass.KeyDescriptorOrBuilder getKeyDescOrBuilder()

A descriptor that precisely describes *which* key to use for signing. This
may provide the raw public key directly, or require the Signer to re-derive
the key according to the populated derivation path.

Note that if the key descriptor was obtained through walletrpc.DeriveKey,
then the key locator MUST always be provided, since the derived keys are not
persisted unlike with DeriveNextKey.
 

.signrpc.KeyDescriptor key_desc = 1;

Specified by:

getKeyDescOrBuilder in interface SignerOuterClass.SignDescriptorOrBuilder

getSingleTweak

public com.google.protobuf.ByteString getSingleTweak()

A scalar value that will be added to the private key corresponding to the
above public key to obtain the private key to be used to sign this input.
This value is typically derived via the following computation:

 derivedKey = privkey + sha256(perCommitmentPoint || pubKey) mod N
 

bytes single_tweak = 2;

Specified by:

getSingleTweak in interface SignerOuterClass.SignDescriptorOrBuilder

Returns:

The singleTweak.

getDoubleTweak

public com.google.protobuf.ByteString getDoubleTweak()

A private key that will be used in combination with its corresponding
private key to derive the private key that is to be used to sign the target
input. Within the Lightning protocol, this value is typically the
commitment secret from a previously revoked commitment transaction. This
value is in combination with two hash values, and the original private key
to derive the private key to be used when signing.

 k = (privKey*sha256(pubKey || tweakPub) +
tweakPriv*sha256(tweakPub || pubKey)) mod N
 

bytes double_tweak = 3;

Specified by:

getDoubleTweak in interface SignerOuterClass.SignDescriptorOrBuilder

Returns:

The doubleTweak.

getTapTweak

public com.google.protobuf.ByteString getTapTweak()

The 32 byte input to the taproot tweak derivation that is used to derive
the output key from an internal key: outputKey = internalKey +
tagged_hash("tapTweak", internalKey || tapTweak).

When doing a BIP 86 spend, this field can be an empty byte slice.

When doing a normal key path spend, with the output key committing to an
actual script root, then this field should be: the tapscript root hash.
 

bytes tap_tweak = 10;

Specified by:

getTapTweak in interface SignerOuterClass.SignDescriptorOrBuilder

Returns:

The tapTweak.

getWitnessScript

public com.google.protobuf.ByteString getWitnessScript()

The full script required to properly redeem the output. This field will
only be populated if a p2tr, p2wsh or a p2sh output is being signed. If a
taproot script path spend is being attempted, then this should be the raw
leaf script.
 

bytes witness_script = 4;

Specified by:

getWitnessScript in interface SignerOuterClass.SignDescriptorOrBuilder

Returns:

The witnessScript.

hasOutput

public boolean hasOutput()

A description of the output being spent. The value and script MUST be
provided.
 

.signrpc.TxOut output = 5;

Specified by:

hasOutput in interface SignerOuterClass.SignDescriptorOrBuilder

Returns:

Whether the output field is set.

getOutput

public SignerOuterClass.TxOut getOutput()

A description of the output being spent. The value and script MUST be
provided.
 

.signrpc.TxOut output = 5;

Specified by:

getOutput in interface SignerOuterClass.SignDescriptorOrBuilder

Returns:

The output.

getOutputOrBuilder

public SignerOuterClass.TxOutOrBuilder getOutputOrBuilder()

A description of the output being spent. The value and script MUST be
provided.
 

.signrpc.TxOut output = 5;

Specified by:

getOutputOrBuilder in interface SignerOuterClass.SignDescriptorOrBuilder

getSighash

public int getSighash()

The target sighash type that should be used when generating the final
sighash, and signature.
 

uint32 sighash = 7;

Specified by:

getSighash in interface SignerOuterClass.SignDescriptorOrBuilder

Returns:

The sighash.

getInputIndex

public int getInputIndex()

The target input within the transaction that should be signed.
 

int32 input_index = 8;

Specified by:

getInputIndex in interface SignerOuterClass.SignDescriptorOrBuilder

Returns:

The inputIndex.

getSignMethodValue

public int getSignMethodValue()

The sign method specifies how the input should be signed. Depending on the
method, either the tap_tweak, witness_script or both need to be specified.
Defaults to SegWit v0 signing to be backward compatible with older RPC
clients.
 

.signrpc.SignMethod sign_method = 9;

Specified by:

getSignMethodValue in interface SignerOuterClass.SignDescriptorOrBuilder

Returns:

The enum numeric value on the wire for signMethod.

getSignMethod

public SignerOuterClass.SignMethod getSignMethod()

The sign method specifies how the input should be signed. Depending on the
method, either the tap_tweak, witness_script or both need to be specified.
Defaults to SegWit v0 signing to be backward compatible with older RPC
clients.
 

.signrpc.SignMethod sign_method = 9;

Specified by:

getSignMethod in interface SignerOuterClass.SignDescriptorOrBuilder

Returns:

The signMethod.

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 SignerOuterClass.SignDescriptor parseFrom(java.nio.ByteBuffer data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SignerOuterClass.SignDescriptor parseFrom(com.google.protobuf.ByteString data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SignerOuterClass.SignDescriptor parseFrom(byte[] data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SignerOuterClass.SignDescriptor parseFrom(java.io.InputStream input)
                                                 throws java.io.IOException

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

public static SignerOuterClass.SignDescriptor parseDelimitedFrom(java.io.InputStream input)
                                                          throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

public static SignerOuterClass.SignDescriptor parseFrom(com.google.protobuf.CodedInputStream input)
                                                 throws java.io.IOException

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

newBuilderForType

public SignerOuterClass.SignDescriptor.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SignerOuterClass.SignDescriptor.Builder newBuilder()

newBuilder

public static SignerOuterClass.SignDescriptor.Builder newBuilder(SignerOuterClass.SignDescriptor prototype)

toBuilder

public SignerOuterClass.SignDescriptor.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SignerOuterClass.SignDescriptor.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SignerOuterClass.SignDescriptor getDefaultInstance()

parser

public static com.google.protobuf.Parser<SignerOuterClass.SignDescriptor> parser()

getParserForType

public com.google.protobuf.Parser<SignerOuterClass.SignDescriptor> 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 SignerOuterClass.SignDescriptor getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder