org.bitcoinj.protocols.channels

Class PaymentChannelV2ClientState

java.lang.Object

org.bitcoinj.protocols.channels.PaymentChannelClientState

org.bitcoinj.protocols.channels.PaymentChannelV2ClientState

public class PaymentChannelV2ClientState
extends PaymentChannelClientState

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.PaymentChannelClientState

PaymentChannelClientState.IncrementedPayment, PaymentChannelClientState.State

Field Summary

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

stateMachine, storedChannel, valueToMe

Constructor Summary

Constructors

Constructor and Description
PaymentChannelV2ClientState(Wallet wallet, ECKey myKey, ECKey serverMultisigKey, Coin value, long expiryTimeInSeconds)

Method Summary

Modifier and Type	Method and Description
Transaction	getContract() Gets the contract which was used to initialize this channel
protected Transaction	getContractInternal() Gets the contract without changing the state machine
protected Script	getContractScript()
protected long	getExpiryTime()
int	getMajorVersion()
Coin	getRefundTxFees() Returns the fees that will be paid if the refund transaction has to be claimed because the server failed to settle the channel properly.
protected Script	getSignedScript() Gets the script that is signed.
protected Multimap<PaymentChannelClientState.State,PaymentChannelClientState.State>	getStateTransitions()
Coin	getTotalValue() Gets the total value of this channel (ie the maximum payment possible)
protected Coin	getValueToMe()
void	initiate(org.spongycastle.crypto.params.KeyParameter userKey) Creates the initial multisig contract and incomplete refund transaction which can be requested at the appropriate time using PaymentChannelV1ClientState.getIncompleteRefundTransaction() and PaymentChannelV1ClientState.getContract().

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

checkNotExpired, disconnectFromChannel, editContractSendRequest, getState, getValueRefunded, getValueSpent, incrementPaymentBy, initiate, initWalletListeners, isSettlementTransaction, storeChannelInWallet, updateChannelInWallet, watchCloseConfirmations

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentChannelV2ClientState

public PaymentChannelV2ClientState(Wallet wallet,
                                   ECKey myKey,
                                   ECKey serverMultisigKey,
                                   Coin value,
                                   long expiryTimeInSeconds)
                            throws VerificationException

Throws:

VerificationException

Method Detail

getStateTransitions

protected Multimap<PaymentChannelClientState.State,PaymentChannelClientState.State> getStateTransitions()

Specified by:

getStateTransitions in class PaymentChannelClientState

getMajorVersion

public int getMajorVersion()

Specified by:

getMajorVersion in class PaymentChannelClientState

initiate

public void initiate(@Nullable
                     org.spongycastle.crypto.params.KeyParameter userKey)
              throws ValueOutOfRangeException,
                     InsufficientMoneyException

Description copied from class: PaymentChannelClientState

Creates the initial multisig contract and incomplete refund transaction which can be requested at the appropriate time using PaymentChannelV1ClientState.getIncompleteRefundTransaction() and PaymentChannelV1ClientState.getContract(). The way the contract is crafted can be adjusted by overriding PaymentChannelV1ClientState#editContractSendRequest(org.bitcoinj.wallet.Wallet.SendRequest). By default unconfirmed coins are allowed to be used, as for micropayments the risk should be relatively low.

Specified by:

initiate in class PaymentChannelClientState

Parameters:

userKey - Key derived from a user password, needed for any signing when the wallet is encrypted. The wallet KeyCrypter is assumed.

Throws:

ValueOutOfRangeException - if the value being used is too small to be accepted by the network

InsufficientMoneyException - if the wallet doesn't contain enough balance to initiate

getValueToMe

protected Coin getValueToMe()

Specified by:

getValueToMe in class PaymentChannelClientState

getExpiryTime

protected long getExpiryTime()

Specified by:

getExpiryTime in class PaymentChannelClientState

getContract

public Transaction getContract()

Description copied from class: PaymentChannelClientState

Gets the contract which was used to initialize this channel

Specified by:

getContract in class PaymentChannelClientState

getContractInternal

protected Transaction getContractInternal()

Description copied from class: PaymentChannelClientState

Gets the contract without changing the state machine

Specified by:

getContractInternal in class PaymentChannelClientState

Returns:

getContractScript

protected Script getContractScript()

Specified by:

getContractScript in class PaymentChannelClientState

getSignedScript

protected Script getSignedScript()

Description copied from class: PaymentChannelClientState

Gets the script that is signed. In the case of a P2SH contract this is the script inside the P2SH script.

Specified by:

getSignedScript in class PaymentChannelClientState

Returns:

getRefundTxFees

public Coin getRefundTxFees()

Description copied from class: PaymentChannelClientState

Returns the fees that will be paid if the refund transaction has to be claimed because the server failed to settle the channel properly. May only be called after PaymentChannelClientState.initiate()

Specified by:

getRefundTxFees in class PaymentChannelClientState

getTotalValue

public Coin getTotalValue()

Description copied from class: PaymentChannelClientState

Gets the total value of this channel (ie the maximum payment possible)

Specified by:

getTotalValue in class PaymentChannelClientState