org.bitcoin.paymentchannel

Class Protos.ProvideContract.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<Protos.ProvideContract.Builder>

org.bitcoin.paymentchannel.Protos.ProvideContract.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable, Protos.ProvideContractOrBuilder

Enclosing class:

Protos.ProvideContract

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

 Sent from the primary to the secondary to complete initialization.
 

Protobuf type paymentchannels.ProvideContract

Method Summary

Modifier and Type	Method and Description
Protos.ProvideContract.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Protos.ProvideContract	build()
Protos.ProvideContract	buildPartial()
Protos.ProvideContract.Builder	clear()
Protos.ProvideContract.Builder	clearClientKey() This field is added in protocol version 2 to send the client public key to the server.
Protos.ProvideContract.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Protos.ProvideContract.Builder	clearInitialPayment() To open the channel, an initial payment of the server-specified dust limit value must be provided.
Protos.ProvideContract.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Protos.ProvideContract.Builder	clearTx() The serialized bytes of the transaction in Satoshi format.
Protos.ProvideContract.Builder	clone()
com.google.protobuf.ByteString	getClientKey() This field is added in protocol version 2 to send the client public key to the server.
Protos.ProvideContract	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
Protos.UpdatePayment	getInitialPayment() To open the channel, an initial payment of the server-specified dust limit value must be provided.
Protos.UpdatePayment.Builder	getInitialPaymentBuilder() 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.ByteString	getTx() The serialized bytes of the transaction in Satoshi format.
boolean	hasClientKey() This field is added in protocol version 2 to send the client public key to the server.
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()
Protos.ProvideContract.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Protos.ProvideContract.Builder	mergeFrom(com.google.protobuf.Message other)
Protos.ProvideContract.Builder	mergeFrom(Protos.ProvideContract other)
Protos.ProvideContract.Builder	mergeInitialPayment(Protos.UpdatePayment value) To open the channel, an initial payment of the server-specified dust limit value must be provided.
Protos.ProvideContract.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Protos.ProvideContract.Builder	setClientKey(com.google.protobuf.ByteString value) This field is added in protocol version 2 to send the client public key to the server.
Protos.ProvideContract.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Protos.ProvideContract.Builder	setInitialPayment(Protos.UpdatePayment.Builder builderForValue) To open the channel, an initial payment of the server-specified dust limit value must be provided.
Protos.ProvideContract.Builder	setInitialPayment(Protos.UpdatePayment value) To open the channel, an initial payment of the server-specified dust limit value must be provided.
Protos.ProvideContract.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
Protos.ProvideContract.Builder	setTx(com.google.protobuf.ByteString value) The serialized bytes of the transaction in Satoshi format.
Protos.ProvideContract.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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.Builder<Protos.ProvideContract.Builder>

clear

public Protos.ProvideContract.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Protos.ProvideContract.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Protos.ProvideContract.Builder>

getDefaultInstanceForType

public Protos.ProvideContract getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Protos.ProvideContract build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Protos.ProvideContract buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Protos.ProvideContract.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Protos.ProvideContract.Builder>

setField

public Protos.ProvideContract.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               java.lang.Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Protos.ProvideContract.Builder>

clearField

public Protos.ProvideContract.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Protos.ProvideContract.Builder>

clearOneof

public Protos.ProvideContract.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Protos.ProvideContract.Builder>

setRepeatedField

public Protos.ProvideContract.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       int index,
                                                       java.lang.Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Protos.ProvideContract.Builder>

addRepeatedField

public Protos.ProvideContract.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       java.lang.Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Protos.ProvideContract.Builder>

mergeFrom

public Protos.ProvideContract.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Protos.ProvideContract.Builder>

mergeFrom

public Protos.ProvideContract.Builder mergeFrom(Protos.ProvideContract other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Protos.ProvideContract.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Protos.ProvideContract.Builder>

Throws:

java.io.IOException

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

setTx

public Protos.ProvideContract.Builder setTx(com.google.protobuf.ByteString value)

 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;

clearTx

public Protos.ProvideContract.Builder clearTx()

 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;

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

setInitialPayment

public Protos.ProvideContract.Builder setInitialPayment(Protos.UpdatePayment value)

 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;

setInitialPayment

public Protos.ProvideContract.Builder setInitialPayment(Protos.UpdatePayment.Builder builderForValue)

 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;

mergeInitialPayment

public Protos.ProvideContract.Builder mergeInitialPayment(Protos.UpdatePayment value)

 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;

clearInitialPayment

public Protos.ProvideContract.Builder clearInitialPayment()

 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;

getInitialPaymentBuilder

public Protos.UpdatePayment.Builder getInitialPaymentBuilder()

 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;

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

setClientKey

public Protos.ProvideContract.Builder setClientKey(com.google.protobuf.ByteString value)

 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;

clearClientKey

public Protos.ProvideContract.Builder clearClientKey()

 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;

setUnknownFields

public final Protos.ProvideContract.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Protos.ProvideContract.Builder>

mergeUnknownFields

public final Protos.ProvideContract.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Protos.ProvideContract.Builder>