PaymentChannel.RBPCP.Parse

Documentation

fromPaymentData :: HasConfDustLimit m => BtcAmount -> PaymentData -> m (Either ParseError (Payment BtcSig))

toPaymentData :: Payment BtcSig -> PaymentData

data PaymentData :: *

A payment comprises a signature over a Bitcoin transaction with a decremented client change value. The Bitcoin transaction redeems the outpoint specified by 'funding_txid' and 'funding_vout' (a P2SH output governed by 'redeem_script'), and pays 'change_value' to 'change_address'.

Constructors

PaymentData

Fields

• paymentDataRedeemScript :: JsonHex BtcScript

  The funds sent to the funding address are bound by this contract (Bitcoin script). The data is needed to construct the payment signature. Hex-encoded data.

• paymentDataFundingTxid :: BtcTxId

  The transaction ID of the Bitcoin transaction paying to the channel funding address.

• paymentDataFundingVout :: Vout

  The output index/"vout" of the output (in the transaction) payingto the channel funding address.

• paymentDataSignatureData :: JsonHex Signature

  DER-encoded ECDSA signature (in hex). This is a SIGHASH_SINGLE|ANYONECANPAY signature over the the "payment transaction", which is a Bitcoin transaction that: redeems the outpoint specified by funding_txid and funding_vout using the redeem script defined in redeem_script, with an output which sends change_value to change_address.

• paymentDataChangeValue :: Word64

  The value sent back to the client in the payment transaction. The total amount transferred to the server is this amount subtracted from the value sent to the channel funding address.

• paymentDataChangeAddress :: Address

  The client change address as used in the only output of the payment transaction.

• paymentDataSighashFlag :: JsonHex SigHash

  Specifies which parts of the payment Bitcoin transaction are signed. Hex-encoded, single byte; in both v1 and v2 always equal to "83" (0x83), which is **SIGHASH_SINGLE|ANYONECANPAY**, meaning the client only signs its own output, and also allowing more to be added.

Instances

Eq PaymentData

Methods

(==) :: PaymentData -> PaymentData -> Bool

(/=) :: PaymentData -> PaymentData -> Bool

Show PaymentData

Methods

showsPrec :: Int -> PaymentData -> ShowS

show :: PaymentData -> String

showList :: [PaymentData] -> ShowS

Generic PaymentData

Associated Types

type Rep PaymentData :: * -> *

Methods

from :: PaymentData -> Rep PaymentData x

to :: Rep PaymentData x -> PaymentData

ToJSON PaymentData

Methods

toJSON :: PaymentData -> Value

toEncoding :: PaymentData -> Encoding

toJSONList :: [PaymentData] -> Value

toEncodingList :: [PaymentData] -> Encoding

FromJSON PaymentData

Methods

parseJSON :: Value -> Parser PaymentData

parseJSONList :: Value -> Parser [PaymentData]

Serialize PaymentData

Methods

put :: Putter PaymentData

get :: Get PaymentData

type Rep PaymentData

type Rep PaymentData = D1 (MetaData "PaymentData" "RBPCP.Types" "rbpcp-api-0.2.0.0-HjG8OZksaPrKuqAft2d0fv" False) (C1 (MetaCons "PaymentData" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "paymentDataRedeemScript") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (JsonHex BtcScript))) ((:*:) (S1 (MetaSel (Just Symbol "paymentDataFundingTxid") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BtcTxId)) (S1 (MetaSel (Just Symbol "paymentDataFundingVout") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Vout)))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "paymentDataSignatureData") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (JsonHex Signature))) (S1 (MetaSel (Just Symbol "paymentDataChangeValue") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word64))) ((:*:) (S1 (MetaSel (Just Symbol "paymentDataChangeAddress") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Address)) (S1 (MetaSel (Just Symbol "paymentDataSighashFlag") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (JsonHex SigHash)))))))

data ParseError

Constructors

BadRedeemScript String

BtcError BtcError

Instances

Eq ParseError

Methods

(==) :: ParseError -> ParseError -> Bool

(/=) :: ParseError -> ParseError -> Bool

Show ParseError

Methods

showsPrec :: Int -> ParseError -> ShowS

show :: ParseError -> String

showList :: [ParseError] -> ShowS

Generic ParseError

Associated Types

type Rep ParseError :: * -> *

Methods

from :: ParseError -> Rep ParseError x

to :: Rep ParseError x -> ParseError

ToJSON ParseError

Methods

toJSON :: ParseError -> Value

toEncoding :: ParseError -> Encoding

toJSONList :: [ParseError] -> Value

toEncodingList :: [ParseError] -> Encoding

FromJSON ParseError

Methods

parseJSON :: Value -> Parser ParseError

parseJSONList :: Value -> Parser [ParseError]

Serialize ParseError

Methods

put :: Putter ParseError

get :: Get ParseError

NFData ParseError

Methods

rnf :: ParseError -> ()

IsPayChanError ParseError

Methods

mkChanErr :: ParseError -> PayChanError

type Rep ParseError

type Rep ParseError = D1 (MetaData "ParseError" "PaymentChannel.RBPCP.Parse" "bitcoin-payment-channel-1.2.0.0-7YwDEKAOCp2BNoMt0JxEOM" False) ((:+:) (C1 (MetaCons "BadRedeemScript" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))) (C1 (MetaCons "BtcError" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BtcError))))

parseRedeemScript :: PaymentData -> Either ParseError ChanParams