org.bitcoinj.protocols.channels

Class PaymentChannelV2ServerState

java.lang.Object

org.bitcoinj.protocols.channels.PaymentChannelServerState

org.bitcoinj.protocols.channels.PaymentChannelV2ServerState

public class PaymentChannelV2ServerState
extends PaymentChannelServerState

Version 2 of the payment channel state machine - uses CLTV opcode transactions instead of multisig transactions.

Nested Class Summary

Nested classes/interfaces inherited from class org.bitcoinj.protocols.channels.PaymentChannelServerState

PaymentChannelServerState.State

Field Summary

Fields

Modifier and Type	Field and Description
protected ECKey	clientKey

Fields inherited from class org.bitcoinj.protocols.channels.PaymentChannelServerState

bestValueSignature, bestValueToMe, broadcaster, contract, minExpireTime, serverKey, stateMachine, storedServerChannel

Constructor Summary

Constructors

Constructor and Description
PaymentChannelV2ServerState(TransactionBroadcaster broadcaster, Wallet wallet, ECKey serverKey, long minExpireTime)

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<Transaction>	close(org.bouncycastle.crypto.params.KeyParameter userKey) Closes this channel and broadcasts the highest value payment transaction on the network.
protected Script	createOutputScript() Creates a P2SH script outputting to the client and server pubkeys
protected ECKey	getClientKey()
TransactionOutput	getClientOutput()
Coin	getFeePaid() Gets the fee paid in the final payment transaction (only available if settle() did not throw an exception)
int	getMajorVersion()
protected Script	getSignedScript() Gets the script that signatures should sign against.
com.google.common.collect.Multimap<PaymentChannelServerState.State,PaymentChannelServerState.State>	getStateTransitions()
void	provideClientKey(byte[] clientKey)
protected void	verifyContract(Transaction contract) Verifies that the given contract meets a set of extra requirements

Methods inherited from class org.bitcoinj.protocols.channels.PaymentChannelServerState

close, getBestValueToMe, getContract, getContractScript, getExpiryTime, getState, getTotalValue, incrementPayment, makeUnsignedChannelContract, provideContract, storeChannelInWallet, updateChannelInWallet

Methods inherited from class java.lang.Object

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

Field Detail

clientKey

protected ECKey clientKey

Constructor Detail

PaymentChannelV2ServerState

public PaymentChannelV2ServerState(TransactionBroadcaster broadcaster,
                                   Wallet wallet,
                                   ECKey serverKey,
                                   long minExpireTime)

Method Detail

getStateTransitions

public com.google.common.collect.Multimap<PaymentChannelServerState.State,PaymentChannelServerState.State> getStateTransitions()

Specified by:

getStateTransitions in class PaymentChannelServerState

getMajorVersion

public int getMajorVersion()

Specified by:

getMajorVersion in class PaymentChannelServerState

getClientOutput

public TransactionOutput getClientOutput()

Specified by:

getClientOutput in class PaymentChannelServerState

provideClientKey

public void provideClientKey(byte[] clientKey)

getFeePaid

public Coin getFeePaid()

Description copied from class: PaymentChannelServerState

Gets the fee paid in the final payment transaction (only available if settle() did not throw an exception)

Specified by:

getFeePaid in class PaymentChannelServerState

getSignedScript

protected Script getSignedScript()

Description copied from class: PaymentChannelServerState

Gets the script that signatures should sign against. This is never a P2SH script, rather the script that would be inside a P2SH script.

Specified by:

getSignedScript in class PaymentChannelServerState

Returns:

the script that signatures should sign against.

verifyContract

protected void verifyContract(Transaction contract)

Description copied from class: PaymentChannelServerState

Verifies that the given contract meets a set of extra requirements

Overrides:

verifyContract in class PaymentChannelServerState

createOutputScript

protected Script createOutputScript()

Creates a P2SH script outputting to the client and server pubkeys

Specified by:

createOutputScript in class PaymentChannelServerState

Returns:

a P2SH script.

getClientKey

protected ECKey getClientKey()

Specified by:

getClientKey in class PaymentChannelServerState

close

public com.google.common.util.concurrent.ListenableFuture<Transaction> close(@Nullable
                                                                             org.bouncycastle.crypto.params.KeyParameter userKey)
                                                                      throws InsufficientMoneyException

Description copied from class: PaymentChannelServerState

Closes this channel and broadcasts the highest value payment transaction on the network.

Specified by:

close in class PaymentChannelServerState

Parameters:

userKey - The AES key to use for decryption of the private key. If null then no decryption is required.

Returns:

a future which completes when the provided multisig contract successfully broadcasts, or throws if the broadcast fails for some reason. Note that if the network simply rejects the transaction, this future will never complete, a timeout should be used.

Throws:

InsufficientMoneyException - If the payment tx would have cost more in fees to spend than it is worth.