Safe Haskell	None
Language	Haskell2010

Data.Bitcoin.PaymentChannel.Test

Contents

Orphan instances

Synopsis

Documentation

nowishTimestamp :: UTCTime Source #

mIN_CHANNEL_SIZE :: BitcoinAmount Source #

data ArbChannelPair Source #

Constructors

ArbChannelPair SenderPaymentChannel ReceiverPaymentChannel [BitcoinAmount] [BitcoinAmount] (Hash256 -> Signature)

Instances

Show ArbChannelPair Source #
Methods showsPrec :: Int -> ArbChannelPair -> ShowS # show :: ArbChannelPair -> String # showList :: [ArbChannelPair] -> ShowS #
Arbitrary ArbChannelPair Source #
Methods arbitrary :: Gen ArbChannelPair # shrink :: ArbChannelPair -> [ArbChannelPair] #

doPayment :: ArbChannelPair -> BitcoinAmount -> ArbChannelPair Source #

mkChanParams :: Gen (ChannelParameters, (PrvKeyC, PrvKeyC)) Source #

mkChanPair :: Gen (ArbChannelPair, FullPayment) Source #

module Data.Bitcoin.PaymentChannel

module Data.Bitcoin.PaymentChannel.Types

data PaymentChannelState Source #

Shared state object used by both value sender and value receiver.

Constructors

CPaymentChannelState

Fields

pcsConfig :: Config
Holds various optional configuration options
pcsParameters :: ChannelParameters
Defined by the sender and receiver
pcsFundingTxInfo :: FundingTxInfo
Retrieved by looking at the in-blockchain funding transaction
pcsPaymentConfig :: PaymentTxConfig
pcsPaymentCount :: Word64
pcsClientChangeVal :: BitcoinAmount
Client change value
pcsPaymentSignature :: PaymentSignature
Signature over payment transaction of value pcsValueLeft

Instances

Eq PaymentChannelState Source #
Methods (==) :: PaymentChannelState -> PaymentChannelState -> Bool # (/=) :: PaymentChannelState -> PaymentChannelState -> Bool #
Show PaymentChannelState Source #
Methods showsPrec :: Int -> PaymentChannelState -> ShowS # show :: PaymentChannelState -> String # showList :: [PaymentChannelState] -> ShowS #

data ChannelParameters Source #

Defines channel: sender, receiver, and expiration date

Constructors

CChannelParameters
Fields cpSenderPubKey :: SendPubKey cpReceiverPubKey :: RecvPubKey cpLockTime :: BitcoinLockTime Channel expiration date/time

Instances

Eq ChannelParameters Source #
Methods (==) :: ChannelParameters -> ChannelParameters -> Bool # (/=) :: ChannelParameters -> ChannelParameters -> Bool #
Show ChannelParameters Source #
Methods showsPrec :: Int -> ChannelParameters -> ShowS # show :: ChannelParameters -> String # showList :: [ChannelParameters] -> ShowS #

data FundingTxInfo Source #

Holds information about the Bitcoin transaction used to fund the channel

Constructors

CFundingTxInfo
Fields ftiHash :: TxHash Hash of funding transaction. ftiOutIndex :: Word32 Index/"vout" of funding output (zero-based index of funding output within list of transaction outputs) ftiOutValue :: BitcoinAmount Value of funding output (channel max value).

Instances

Eq FundingTxInfo Source #
Methods (==) :: FundingTxInfo -> FundingTxInfo -> Bool # (/=) :: FundingTxInfo -> FundingTxInfo -> Bool #
Show FundingTxInfo Source #
Methods showsPrec :: Int -> FundingTxInfo -> ShowS # show :: FundingTxInfo -> String # showList :: [FundingTxInfo] -> ShowS #

data PaymentTxConfig Source #

Holds information about how to construct the payment transaction

Constructors

CPaymentTxConfig
Fields ptcSenderChangeAddress :: Address Value sender change address

Instances

Eq PaymentTxConfig Source #
Methods (==) :: PaymentTxConfig -> PaymentTxConfig -> Bool # (/=) :: PaymentTxConfig -> PaymentTxConfig -> Bool #
Show PaymentTxConfig Source #
Methods showsPrec :: Int -> PaymentTxConfig -> ShowS # show :: PaymentTxConfig -> String # showList :: [PaymentTxConfig] -> ShowS #

data Config Source #

Miscellaneous configuration options

Constructors

Config
Fields cDustLimit :: BitcoinAmount Refuse to accept/produce payments with a client change value less than this amount. cSettlementPeriod :: Hour This many hours before the channel expiration date, consider the channel closed. This gives the receiver time to publish the settlement transaction, before the refund transaction becomes valid.

Instances

Eq Config Source #
Methods (==) :: Config -> Config -> Bool # (/=) :: Config -> Config -> Bool #
Show Config Source #
Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #

data Payment Source #

Contains the bare minimum of information to transfer value from sender to receiver.

Constructors

CPayment
Fields cpClientChange :: BitcoinAmount Channel value remaining (`pcsValueLeft` of the state from which this payment was made) cpSignature :: PaymentSignature Get payment signature from payment

Instances

Eq Payment Source #
Methods (==) :: Payment -> Payment -> Bool # (/=) :: Payment -> Payment -> Bool #

data FullPayment Source #

Contains all information required to construct the payment transaction

Constructors

CFullPayment
Fields fpPayment :: Payment fpOutPoint :: OutPoint The payment transaction redeems this outpoint fpRedeemScript :: Script Using this redeemScript fpChangeAddr :: Address Paying this amount to the client/sender change output

Instances

Eq FullPayment Source #
Methods (==) :: FullPayment -> FullPayment -> Bool # (/=) :: FullPayment -> FullPayment -> Bool #

data PaymentSignature Source #

Contains payment signature plus sig hash flag byte

Constructors

CPaymentSignature
Fields psSig :: Signature psSigHash :: SigHash SigHash flag. Always "SigSingle True".

Instances

Eq PaymentSignature Source #
Methods (==) :: PaymentSignature -> PaymentSignature -> Bool # (/=) :: PaymentSignature -> PaymentSignature -> Bool #
Show PaymentSignature Source #
Methods showsPrec :: Int -> PaymentSignature -> ShowS # show :: PaymentSignature -> String # showList :: [PaymentSignature] -> ShowS #

newtype ChanScript Source #

Wraps a Network.Haskoin.Script.Script

Constructors

ChanScript
Fields getScript :: Script

Instances

Eq ChanScript Source #
Methods (==) :: ChanScript -> ChanScript -> Bool # (/=) :: ChanScript -> ChanScript -> Bool #
Show ChanScript Source #
Methods showsPrec :: Int -> ChanScript -> ShowS # show :: ChanScript -> String # showList :: [ChanScript] -> ShowS #

type PayChanState = PaymentChannelState Source #

type ChanParams = ChannelParameters Source #

type ReceiverPaymentChannel = ReceiverPaymentChannelI () Source #

ReceiverPaymentChannel without public key metadata

type ReceiverPaymentChannelX = ReceiverPaymentChannelI XPubKey Source #

ReceiverPaymentChannel with BIP32 , "extended" public key metadata

data ReceiverPaymentChannelI pkInfo Source #

State object for the value receiver. pkInfo holds optional, extra data associated with the receiver public key

Constructors

CReceiverPaymentChannel
Fields rpcState :: PaymentChannelState Internal state object rpcPubKeyInfo :: pkInfo

Instances

Show ReceiverPaymentChannelX Source #
Methods showsPrec :: Int -> ReceiverPaymentChannelX -> ShowS # show :: ReceiverPaymentChannelX -> String # showList :: [ReceiverPaymentChannelX] -> ShowS #
Show ReceiverPaymentChannel Source #
Methods showsPrec :: Int -> ReceiverPaymentChannel -> ShowS # show :: ReceiverPaymentChannel -> String # showList :: [ReceiverPaymentChannel] -> ShowS #
PaymentChannel ReceiverPaymentChannel Source #
Methods valueToMe :: ReceiverPaymentChannel -> BitcoinAmount Source # getChannelState :: ReceiverPaymentChannel -> PaymentChannelState Source # getChannelFunding :: ReceiverPaymentChannel -> OutPoint Source # getExpirationDate :: ReceiverPaymentChannel -> BitcoinLockTime Source # getSenderPubKey :: ReceiverPaymentChannel -> SendPubKey Source # getFundingAmount :: ReceiverPaymentChannel -> BitcoinAmount Source # getPaymentCount :: ReceiverPaymentChannel -> Word64 Source # fundingAddress :: ReceiverPaymentChannel -> Address Source # getNewestPayment :: ReceiverPaymentChannel -> Payment Source # getNewestSig :: ReceiverPaymentChannel -> Signature Source # expiresBefore :: BitcoinLockTime -> ReceiverPaymentChannel -> Bool Source # _setChannelState :: ReceiverPaymentChannel -> PaymentChannelState -> ReceiverPaymentChannel Source # channelValueLeft :: ReceiverPaymentChannel -> BitcoinAmount Source # senderChangeValue :: ReceiverPaymentChannel -> BitcoinAmount Source # channelIsExhausted :: ReceiverPaymentChannel -> Bool Source #
Eq pkInfo => Eq (ReceiverPaymentChannelI pkInfo) Source #
Methods (==) :: ReceiverPaymentChannelI pkInfo -> ReceiverPaymentChannelI pkInfo -> Bool # (/=) :: ReceiverPaymentChannelI pkInfo -> ReceiverPaymentChannelI pkInfo -> Bool #

rpcGetXPub :: ReceiverPaymentChannelI pkInfo -> pkInfo Source #

type Hour = Tagged "Hour" Word32 Source #

toSeconds :: Hour -> Integer Source #

defaultConfig :: Config Source #

defaultDustLimit :: BitcoinAmount Source #

defaultSettlementPeriod :: Hour Source #

newtype BitcoinAmount Source #

Represents a bitcoin amount as number of satoshis. 1 satoshi = 1e-8 bitcoin. 1e8 satohis = 1 bitcoin. Only amounts >= 0 can be represented, and fromInteger caps to a Word64. It is thus not possible to eg. construct a negative BitcoinAmount which, when added to another BitcoinAmount, subtracts from its value. Adding two large amounts together will never overflow, nor will subtraction underflow.

Constructors

BitcoinAmount Integer

Instances

Bounded BitcoinAmount Source #
Methods minBound :: BitcoinAmount # maxBound :: BitcoinAmount #
Enum BitcoinAmount Source #
Methods succ :: BitcoinAmount -> BitcoinAmount # pred :: BitcoinAmount -> BitcoinAmount # toEnum :: Int -> BitcoinAmount # fromEnum :: BitcoinAmount -> Int # enumFrom :: BitcoinAmount -> [BitcoinAmount] # enumFromThen :: BitcoinAmount -> BitcoinAmount -> [BitcoinAmount] # enumFromTo :: BitcoinAmount -> BitcoinAmount -> [BitcoinAmount] # enumFromThenTo :: BitcoinAmount -> BitcoinAmount -> BitcoinAmount -> [BitcoinAmount] #
Eq BitcoinAmount Source #
Methods (==) :: BitcoinAmount -> BitcoinAmount -> Bool # (/=) :: BitcoinAmount -> BitcoinAmount -> Bool #
Integral BitcoinAmount Source #
Methods quot :: BitcoinAmount -> BitcoinAmount -> BitcoinAmount # rem :: BitcoinAmount -> BitcoinAmount -> BitcoinAmount # div :: BitcoinAmount -> BitcoinAmount -> BitcoinAmount # mod :: BitcoinAmount -> BitcoinAmount -> BitcoinAmount # quotRem :: BitcoinAmount -> BitcoinAmount -> (BitcoinAmount, BitcoinAmount) # divMod :: BitcoinAmount -> BitcoinAmount -> (BitcoinAmount, BitcoinAmount) # toInteger :: BitcoinAmount -> Integer #
Num BitcoinAmount Source #
Methods (+) :: BitcoinAmount -> BitcoinAmount -> BitcoinAmount # (-) :: BitcoinAmount -> BitcoinAmount -> BitcoinAmount # (*) :: BitcoinAmount -> BitcoinAmount -> BitcoinAmount # negate :: BitcoinAmount -> BitcoinAmount # abs :: BitcoinAmount -> BitcoinAmount # signum :: BitcoinAmount -> BitcoinAmount # fromInteger :: Integer -> BitcoinAmount #
Ord BitcoinAmount Source #
Methods compare :: BitcoinAmount -> BitcoinAmount -> Ordering # (<) :: BitcoinAmount -> BitcoinAmount -> Bool # (<=) :: BitcoinAmount -> BitcoinAmount -> Bool # (>) :: BitcoinAmount -> BitcoinAmount -> Bool # (>=) :: BitcoinAmount -> BitcoinAmount -> Bool # max :: BitcoinAmount -> BitcoinAmount -> BitcoinAmount # min :: BitcoinAmount -> BitcoinAmount -> BitcoinAmount #
Real BitcoinAmount Source #
Methods toRational :: BitcoinAmount -> Rational #
Show BitcoinAmount Source #
Methods showsPrec :: Int -> BitcoinAmount -> ShowS # show :: BitcoinAmount -> String # showList :: [BitcoinAmount] -> ShowS #
Serialize BitcoinAmount Source #
Methods put :: Putter BitcoinAmount # get :: Get BitcoinAmount #
HasFee BitcoinAmount Source #	For compatibility
Methods absoluteFee :: TxByteSize -> BitcoinAmount -> BitcoinAmount Source #

capTo21Mill :: Integer -> Word64 Source #

Convert to 21 million, zero as floor

data BitcoinLockTime Source #

Data type representing a Bitcoin LockTime, which specifies a point in time. Derive a BitcoinLockTime from a UTCTime using fromDate.

Constructors

LockTimeBlockHeight Word32	A value of "n" represents the point in time at which Bitcoin block number "n" appears
LockTimeDate UTCTime	Specifies a point in time using a timestamp with 1-second accuracy

Instances

Eq BitcoinLockTime Source #
Methods (==) :: BitcoinLockTime -> BitcoinLockTime -> Bool # (/=) :: BitcoinLockTime -> BitcoinLockTime -> Bool #
Ord BitcoinLockTime Source #
Methods compare :: BitcoinLockTime -> BitcoinLockTime -> Ordering # (<) :: BitcoinLockTime -> BitcoinLockTime -> Bool # (<=) :: BitcoinLockTime -> BitcoinLockTime -> Bool # (>) :: BitcoinLockTime -> BitcoinLockTime -> Bool # (>=) :: BitcoinLockTime -> BitcoinLockTime -> Bool # max :: BitcoinLockTime -> BitcoinLockTime -> BitcoinLockTime # min :: BitcoinLockTime -> BitcoinLockTime -> BitcoinLockTime #
Show BitcoinLockTime Source #
Methods showsPrec :: Int -> BitcoinLockTime -> ShowS # show :: BitcoinLockTime -> String # showList :: [BitcoinLockTime] -> ShowS #
Serialize BitcoinLockTime Source #
Methods put :: Putter BitcoinLockTime # get :: Get BitcoinLockTime #

parseBitcoinLocktime :: Word32 -> BitcoinLockTime Source #

Convert from Bitcoin format (Word32)

toWord32 :: BitcoinLockTime -> Word32 Source #

Convert to Bitcoin format (uint32 UNIX timestamp)

fromDate :: UTCTime -> BitcoinLockTime Source #

Convert a UTCTime to a BitcoinLockTime

usesBlockHeight :: BitcoinLockTime -> Bool Source #

class Serialize a => IsPubKey a where Source #

Types which contain a pubkey

Minimal complete definition

getPubKey

Methods

getPubKey :: a -> PubKeyC Source #

Instances

IsPubKey XPubKey Source #
Methods getPubKey :: XPubKey -> PubKeyC Source #
IsPubKey RecvPubKey Source #
Methods getPubKey :: RecvPubKey -> PubKeyC Source #
IsPubKey SendPubKey Source #
Methods getPubKey :: SendPubKey -> PubKeyC Source #

newtype SendPubKey Source #

Wrapper for value sender's public key

Constructors

MkSendPubKey
Fields getSenderPK :: PubKeyC

Instances

Eq SendPubKey Source #
Methods (==) :: SendPubKey -> SendPubKey -> Bool # (/=) :: SendPubKey -> SendPubKey -> Bool #
Show SendPubKey Source #
Methods showsPrec :: Int -> SendPubKey -> ShowS # show :: SendPubKey -> String # showList :: [SendPubKey] -> ShowS #
Serialize SendPubKey Source #
Methods put :: Putter SendPubKey # get :: Get SendPubKey #
IsPubKey SendPubKey Source #
Methods getPubKey :: SendPubKey -> PubKeyC Source #

newtype RecvPubKey Source #

Wrapper for value receiver's public key

Constructors

MkRecvPubKey
Fields getReceiverPK :: PubKeyC

Instances

Eq RecvPubKey Source #
Methods (==) :: RecvPubKey -> RecvPubKey -> Bool # (/=) :: RecvPubKey -> RecvPubKey -> Bool #
Show RecvPubKey Source #
Methods showsPrec :: Int -> RecvPubKey -> ShowS # show :: RecvPubKey -> String # showList :: [RecvPubKey] -> ShowS #
Serialize RecvPubKey Source #
Methods put :: Putter RecvPubKey # get :: Get RecvPubKey #
IsPubKey RecvPubKey Source #
Methods getPubKey :: RecvPubKey -> PubKeyC Source #

module Network.Haskoin.Transaction

module Network.Haskoin.Crypto

module Network.Haskoin.Script

pcsChannelTotalValue :: PaymentChannelState -> BitcoinAmount Source #

pcsValueTransferred :: PaymentChannelState -> BitcoinAmount Source #

pcsChannelValueLeft :: PaymentChannelState -> BitcoinAmount Source #

pcsClientPubKey :: PaymentChannelState -> SendPubKey Source #

pcsServerPubKey :: PaymentChannelState -> RecvPubKey Source #

pcsDustLimit :: PaymentChannelState -> BitcoinAmount Source #

pcsExpirationDate :: PaymentChannelState -> BitcoinLockTime Source #

pcsClientChangeAddress :: PaymentChannelState -> Address Source #

pcsClientChangeScriptPubKey :: PaymentChannelState -> ByteString Source #

pcsLockTime :: PaymentChannelState -> BitcoinLockTime Source #

pcsPrevOut :: PaymentChannelState -> OutPoint Source #

pcsChannelFundingSource :: PaymentChannelState -> OutPoint Source #

pcsGetPayment :: PaymentChannelState -> Payment Source #

setClientChangeAddress :: PaymentChannelState -> Address -> PaymentChannelState Source #

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 Source #

channelValueLeft :: PaymentChannelState -> BitcoinAmount Source #

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 Source #

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

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

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

Update state with verified payment.

mkExtendedKeyRPC :: ReceiverPaymentChannel -> XPubKey -> Maybe ReceiverPaymentChannelX Source #

Create a ReceiverPaymentChannelX, which has an associated XPubKey, from a ReceiverPaymentChannel

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

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

Orphan instances

Arbitrary BitcoinAmount Source #
Methods arbitrary :: Gen BitcoinAmount # shrink :: BitcoinAmount -> [BitcoinAmount] #
Arbitrary ChanScript Source #
Methods arbitrary :: Gen ChanScript # shrink :: ChanScript -> [ChanScript] #
Arbitrary FullPayment Source #
Methods arbitrary :: Gen FullPayment # shrink :: FullPayment -> [FullPayment] #
Arbitrary FundingTxInfo Source #
Methods arbitrary :: Gen FundingTxInfo # shrink :: FundingTxInfo -> [FundingTxInfo] #
Arbitrary ChannelParameters Source #
Methods arbitrary :: Gen ChannelParameters # shrink :: ChannelParameters -> [ChannelParameters] #
Arbitrary PaymentChannelState Source #
Methods arbitrary :: Gen PaymentChannelState # shrink :: PaymentChannelState -> [PaymentChannelState] #