Data.Bitcoin.PaymentChannel.Internal.State

Documentation

pcsChannelTotalValue :: PaymentChannelState -> BitcoinAmount

pcsValueTransferred :: PaymentChannelState -> BitcoinAmount

pcsChannelValueLeft :: PaymentChannelState -> BitcoinAmount

pcsClientPubKey :: PaymentChannelState -> SendPubKey

pcsServerPubKey :: PaymentChannelState -> RecvPubKey

pcsDustLimit :: PaymentChannelState -> BitcoinAmount

pcsExpirationDate :: PaymentChannelState -> BitcoinLockTime

pcsClientChangeAddress :: PaymentChannelState -> Address

pcsClientChangeScriptPubKey :: PaymentChannelState -> ByteString

pcsLockTime :: PaymentChannelState -> BitcoinLockTime

pcsPrevOut :: PaymentChannelState -> OutPoint

pcsChannelFundingSource :: PaymentChannelState -> OutPoint

pcsGetPayment :: PaymentChannelState -> Payment

setClientChangeAddress :: PaymentChannelState -> Address -> PaymentChannelState

Set new client/sender change address. Use this function if the client wishes to change its change address. First set the new change address using this function, then accept the payment which uses this new change address.

setFundingSource :: PaymentChannelState -> FundingTxInfo -> PaymentChannelState

channelValueLeft :: PaymentChannelState -> BitcoinAmount

We subtract the specified "dust" limit from the total available value. This avoids creating a Bitcoin transaction that won't circulate in the Bitcoin P2P network.

channelIsExhausted :: PaymentChannelState -> Bool

Returns True if all available channel value has been transferred, False otherwise

newPaymentChannelState :: Config -> ChannelParameters -> FundingTxInfo -> PaymentTxConfig -> PaymentSignature -> PaymentChannelState

updatePaymentChannelState :: PaymentChannelState -> FullPayment -> Either PayChanError PaymentChannelState

Update state with verified payment.

checkDustLimit :: Config -> Payment -> Either PayChanError Payment

isPastLockTimeDate :: UTCTime -> Config -> ChannelParameters -> Bool