Package org.bitcoinj.protocols.channels

Micropayment channels allow for rapid tiny payments to be made to a third party once a channel has been set up, using some of the advanced features of the Bitcoin protocol.

See: Description

Interface Summary

Interface	Description
ClientState.StoredClientPaymentChannelOrBuilder
ClientState.StoredClientPaymentChannelsOrBuilder
IPaymentChannelClient	A class implementing this interface supports the basic operations of a payment channel.
IPaymentChannelClient.ClientConnection	Implements the connection between this client and the server, providing an interface which allows messages to be sent to the server, requests for the connection to the server to be closed, and a callback which occurs when the channel is fully open.
IPaymentChannelClient.Factory	An implementor of this interface creates payment channel clients that "talk back" with the given connection.
PaymentChannelServer.ServerConnection	Implements the connection between this server and the client, providing an interface which allows messages to be sent to the client, requests for the connection to the client to be closed, and callbacks which occur when the channel is fully open or the client completes a payment.
PaymentChannelServerListener.HandlerFactory	A factory which generates connection-specific event handlers.
ServerState.StoredServerPaymentChannelOrBuilder
ServerState.StoredServerPaymentChannelsOrBuilder

Class Summary

Class	Description
ClientState
ClientState.StoredClientPaymentChannel	Protobuf type paymentchannels.StoredClientPaymentChannel
ClientState.StoredClientPaymentChannel.Builder	Protobuf type paymentchannels.StoredClientPaymentChannel
ClientState.StoredClientPaymentChannels	Protobuf type paymentchannels.StoredClientPaymentChannels
ClientState.StoredClientPaymentChannels.Builder	Protobuf type paymentchannels.StoredClientPaymentChannels
PaymentChannelClient	A class which handles most of the complexity of creating a payment channel connection by providing a simple in/out interface which is provided with protobufs from the server and which generates protobufs which should be sent to the server.
PaymentChannelClientConnection	A simple utility class that runs the micropayment protocol over a raw TCP socket using NIO, standalone.
PaymentChannelClientState	A payment channel is a method of sending money to someone such that the amount of money you send can be adjusted after the fact, in an efficient manner that does not require broadcasting to the network.
PaymentChannelClientState.IncrementedPayment	Container for a signature and an amount that was sent.
PaymentChannelServer	A handler class which handles most of the complexity of creating a payment channel connection by providing a simple in/out interface which is provided with protobufs from the client and which generates protobufs which should be sent to the client.
PaymentChannelServerListener	Implements a listening TCP server that can accept connections from payment channel clients, and invokes the provided event listeners when new channels are opened or payments arrive.
PaymentChannelServerState	A payment channel is a method of sending money to someone such that the amount of money you send can be adjusted after the fact, in an efficient manner that does not require broadcasting to the network.
PaymentChannelV1ClientState	Version 1 of the payment channel state machine - uses time locked multisig contracts.
PaymentChannelV1ServerState	Version 1 of the payment channel server state object.
PaymentChannelV2ClientState	Version 2 of the payment channel state machine - uses CLTV opcode transactions instead of multisig transactions.
PaymentChannelV2ServerState	Version 2 of the payment channel state machine - uses CLTV opcode transactions instead of multisig transactions.
PaymentIncrementAck	An acknowledgement of a payment increase
ServerConnectionEventHandler	A connection-specific event handler that handles events generated by client connections on a PaymentChannelServerListener
ServerState
ServerState.StoredServerPaymentChannel	Protobuf type paymentchannels.StoredServerPaymentChannel
ServerState.StoredServerPaymentChannel.Builder	Protobuf type paymentchannels.StoredServerPaymentChannel
ServerState.StoredServerPaymentChannels	Protobuf type paymentchannels.StoredServerPaymentChannels
ServerState.StoredServerPaymentChannels.Builder	Protobuf type paymentchannels.StoredServerPaymentChannels
StateMachine<State extends Enum<State>>	A class representing a state machine, with limited transitions between states.
StoredPaymentChannelClientStates	This class maintains a set of StoredClientChannels, automatically (re)broadcasting the contract transaction and broadcasting the refund transaction over the given TransactionBroadcaster.
StoredPaymentChannelServerStates	Keeps track of a set of StoredServerChannels and expires them 2 hours before their refund transactions unlock.
StoredServerChannel	Represents the state of a channel once it has been opened in such a way that it can be stored and used to resume a channel which was interrupted (eg on connection failure) or settle the channel automatically as the channel expire time approaches.

Enum Summary

Enum	Description
PaymentChannelClient.VersionSelector
PaymentChannelClientState.State	The different logical states the channel can be in.
PaymentChannelCloseException.CloseReason
PaymentChannelServerState.State	The different logical states the channel can be in.

Exception Summary

Exception	Description
PaymentChannelCloseException	Used to indicate that a channel was closed before it was expected to be closed.
ValueOutOfRangeException	Used when a given value is either too large too afford or too small for the network to accept.

Package org.bitcoinj.protocols.channels Description

Micropayment channels allow for rapid tiny payments to be made to a third party once a channel has been set up, using some of the advanced features of the Bitcoin protocol.