org.bitcoin.paymentchannel

Class Protos.ProvideContract

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.bitcoin.paymentchannel.Protos.ProvideContract

All Implemented Interfaces:

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

Enclosing class:

Protos

public static final class Protos.ProvideContract
extends com.google.protobuf.GeneratedMessageV3
implements Protos.ProvideContractOrBuilder

 Sent from the primary to the secondary to complete initialization.
 

Protobuf type paymentchannels.ProvideContract

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Protos.ProvideContract.Builder Sent from the primary to the secondary to complete initialization.

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	CLIENT_KEY_FIELD_NUMBER
static int	INITIAL_PAYMENT_FIELD_NUMBER
static com.google.protobuf.Parser<Protos.ProvideContract>	PARSER Deprecated.
static int	TX_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)
com.google.protobuf.ByteString	getClientKey() This field is added in protocol version 2 to send the client public key to the server.
static Protos.ProvideContract	getDefaultInstance()
Protos.ProvideContract	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Protos.UpdatePayment	getInitialPayment() To open the channel, an initial payment of the server-specified dust limit value must be provided.
Protos.UpdatePaymentOrBuilder	getInitialPaymentOrBuilder() To open the channel, an initial payment of the server-specified dust limit value must be provided.
com.google.protobuf.Parser<Protos.ProvideContract>	getParserForType()
int	getSerializedSize()
com.google.protobuf.ByteString	getTx() The serialized bytes of the transaction in Satoshi format.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasClientKey() This field is added in protocol version 2 to send the client public key to the server.
int	hashCode()
boolean	hasInitialPayment() To open the channel, an initial payment of the server-specified dust limit value must be provided.
boolean	hasTx() The serialized bytes of the transaction in Satoshi format.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Protos.ProvideContract.Builder	newBuilder()
static Protos.ProvideContract.Builder	newBuilder(Protos.ProvideContract prototype)
Protos.ProvideContract.Builder	newBuilderForType()
protected Protos.ProvideContract.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Protos.ProvideContract	parseDelimitedFrom(java.io.InputStream input)
static Protos.ProvideContract	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.ProvideContract	parseFrom(byte[] data)
static Protos.ProvideContract	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.ProvideContract	parseFrom(java.nio.ByteBuffer data)
static Protos.ProvideContract	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.ProvideContract	parseFrom(com.google.protobuf.ByteString data)
static Protos.ProvideContract	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.ProvideContract	parseFrom(com.google.protobuf.CodedInputStream input)
static Protos.ProvideContract	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.ProvideContract	parseFrom(java.io.InputStream input)
static Protos.ProvideContract	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Protos.ProvideContract>	parser()
Protos.ProvideContract.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

TX_FIELD_NUMBER

public static final int TX_FIELD_NUMBER

See Also:

Constant Field Values

INITIAL_PAYMENT_FIELD_NUMBER

public static final int INITIAL_PAYMENT_FIELD_NUMBER

See Also:

Constant Field Values

CLIENT_KEY_FIELD_NUMBER

public static final int CLIENT_KEY_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<Protos.ProvideContract> 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

hasTx

public boolean hasTx()

 The serialized bytes of the transaction in Satoshi format.
 For version 1:
 * It must be signed and completely valid and ready for broadcast (ie it includes the
   necessary fees) TODO: tell the client how much fee it needs
 * Its first output must be a 2-of-2 multisig output with the first pubkey being the
   primary's and the second being the secondary's (ie the script must be exactly "OP_2
   ProvideRefund.multisig_key Initiate.multisig_key OP_2 OP_CHECKMULTISIG")
 For version 2:
 * It must be signed and completely valid and ready for broadcast (ie it includes the
   necessary fees) TODO: tell the client how much fee it needs
 * Its first output must be a CHECKLOCKTIMEVERIFY output with the first pubkey being the
   primary's and the second being the secondary's.
 

required bytes tx = 1;

Specified by:

hasTx in interface Protos.ProvideContractOrBuilder

getTx

public com.google.protobuf.ByteString getTx()

 The serialized bytes of the transaction in Satoshi format.
 For version 1:
 * It must be signed and completely valid and ready for broadcast (ie it includes the
   necessary fees) TODO: tell the client how much fee it needs
 * Its first output must be a 2-of-2 multisig output with the first pubkey being the
   primary's and the second being the secondary's (ie the script must be exactly "OP_2
   ProvideRefund.multisig_key Initiate.multisig_key OP_2 OP_CHECKMULTISIG")
 For version 2:
 * It must be signed and completely valid and ready for broadcast (ie it includes the
   necessary fees) TODO: tell the client how much fee it needs
 * Its first output must be a CHECKLOCKTIMEVERIFY output with the first pubkey being the
   primary's and the second being the secondary's.
 

required bytes tx = 1;

Specified by:

getTx in interface Protos.ProvideContractOrBuilder

hasInitialPayment

public boolean hasInitialPayment()

 To open the channel, an initial payment of the server-specified dust limit value must be
 provided. This ensures that the channel is never in an un-settleable state due to either
 no payment tx having been provided at all, or a payment that is smaller than the dust
 limit being provided.
 

required .paymentchannels.UpdatePayment initial_payment = 2;

Specified by:

hasInitialPayment in interface Protos.ProvideContractOrBuilder

getInitialPayment

public Protos.UpdatePayment getInitialPayment()

 To open the channel, an initial payment of the server-specified dust limit value must be
 provided. This ensures that the channel is never in an un-settleable state due to either
 no payment tx having been provided at all, or a payment that is smaller than the dust
 limit being provided.
 

required .paymentchannels.UpdatePayment initial_payment = 2;

Specified by:

getInitialPayment in interface Protos.ProvideContractOrBuilder

getInitialPaymentOrBuilder

public Protos.UpdatePaymentOrBuilder getInitialPaymentOrBuilder()

 To open the channel, an initial payment of the server-specified dust limit value must be
 provided. This ensures that the channel is never in an un-settleable state due to either
 no payment tx having been provided at all, or a payment that is smaller than the dust
 limit being provided.
 

required .paymentchannels.UpdatePayment initial_payment = 2;

Specified by:

getInitialPaymentOrBuilder in interface Protos.ProvideContractOrBuilder

hasClientKey

public boolean hasClientKey()

 This field is added in protocol version 2 to send the client public key to the server.
 In version 1 it isn't used.
 This must be a raw pubkey in regular ECDSA form. Both compressed and non-compressed forms
 are accepted.  It is only used in the creation of the multisig contract.
 

optional bytes client_key = 3;

Specified by:

hasClientKey in interface Protos.ProvideContractOrBuilder

getClientKey

public com.google.protobuf.ByteString getClientKey()

 This field is added in protocol version 2 to send the client public key to the server.
 In version 1 it isn't used.
 This must be a raw pubkey in regular ECDSA form. Both compressed and non-compressed forms
 are accepted.  It is only used in the creation of the multisig contract.
 

optional bytes client_key = 3;

Specified by:

getClientKey in interface Protos.ProvideContractOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

newBuilderForType

public Protos.ProvideContract.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Protos.ProvideContract.Builder newBuilder()

newBuilder

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

toBuilder

public Protos.ProvideContract.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Protos.ProvideContract getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder