Data.Bitcoin.PaymentChannel.Types

Types used with the interface provided by Data.Bitcoin.PaymentChannel.

Documentation

class PaymentChannel a where

Get various information about an open payment channel.

Minimal complete definition

valueToMe, getChannelState

Methods

valueToMe :: a -> BitcoinAmount

Get value sent to receiver/left for sender

getChannelState :: a -> PaymentChannelState

Retrieve internal state object

getChannelID :: a -> OutPoint

getExpirationDate :: a -> BitcoinLockTime

_setChannelState :: a -> PaymentChannelState -> a

For internal use

channelValueLeft :: a -> BitcoinAmount

channelIsExhausted :: a -> Bool

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

Instances

PaymentChannel ReceiverPaymentChannel

Methods

valueToMe :: ReceiverPaymentChannel -> BitcoinAmount

getChannelState :: ReceiverPaymentChannel -> PaymentChannelState

getChannelID :: ReceiverPaymentChannel -> OutPoint

getExpirationDate :: ReceiverPaymentChannel -> BitcoinLockTime

_setChannelState :: ReceiverPaymentChannel -> PaymentChannelState -> ReceiverPaymentChannel

channelValueLeft :: ReceiverPaymentChannel -> BitcoinAmount

channelIsExhausted :: ReceiverPaymentChannel -> Bool

PaymentChannel SenderPaymentChannel

Methods

valueToMe :: SenderPaymentChannel -> BitcoinAmount

getChannelState :: SenderPaymentChannel -> PaymentChannelState

getChannelID :: SenderPaymentChannel -> OutPoint

getExpirationDate :: SenderPaymentChannel -> BitcoinLockTime

_setChannelState :: SenderPaymentChannel -> PaymentChannelState -> SenderPaymentChannel

channelValueLeft :: SenderPaymentChannel -> BitcoinAmount

channelIsExhausted :: SenderPaymentChannel -> Bool

data SenderPaymentChannel

State object for the value sender

Constructors

CSenderPaymentChannel

Fields

• spcState :: PaymentChannelState

  Internal state object

• spcSignFunc :: Hash256 -> Signature

  Used to sign payments from sender. This function, when given a Hash256, produces a signature that verifies against cpSenderPubKey.

Instances

Show SenderPaymentChannel

Methods

showsPrec :: Int -> SenderPaymentChannel -> ShowS

show :: SenderPaymentChannel -> String

showList :: [SenderPaymentChannel] -> ShowS

PaymentChannel SenderPaymentChannel

Methods

valueToMe :: SenderPaymentChannel -> BitcoinAmount

getChannelState :: SenderPaymentChannel -> PaymentChannelState

getChannelID :: SenderPaymentChannel -> OutPoint

getExpirationDate :: SenderPaymentChannel -> BitcoinLockTime

_setChannelState :: SenderPaymentChannel -> PaymentChannelState -> SenderPaymentChannel

channelValueLeft :: SenderPaymentChannel -> BitcoinAmount

channelIsExhausted :: SenderPaymentChannel -> Bool

newtype ReceiverPaymentChannel

State object for the value receiver

Constructors

CReceiverPaymentChannel

Fields

• rpcState :: PaymentChannelState

  Internal state object

Instances

Eq ReceiverPaymentChannel

Methods

(==) :: ReceiverPaymentChannel -> ReceiverPaymentChannel -> Bool

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

Show ReceiverPaymentChannel

Methods

showsPrec :: Int -> ReceiverPaymentChannel -> ShowS

show :: ReceiverPaymentChannel -> String

showList :: [ReceiverPaymentChannel] -> ShowS

ToJSON ReceiverPaymentChannel

Methods

toJSON :: ReceiverPaymentChannel -> Value

toEncoding :: ReceiverPaymentChannel -> Encoding

FromJSON ReceiverPaymentChannel

Methods

parseJSON :: Value -> Parser ReceiverPaymentChannel

Binary ReceiverPaymentChannel

Methods

put :: ReceiverPaymentChannel -> Put

get :: Get ReceiverPaymentChannel

putList :: [ReceiverPaymentChannel] -> Put

PaymentChannel ReceiverPaymentChannel

Methods

valueToMe :: ReceiverPaymentChannel -> BitcoinAmount

getChannelState :: ReceiverPaymentChannel -> PaymentChannelState

getChannelID :: ReceiverPaymentChannel -> OutPoint

getExpirationDate :: ReceiverPaymentChannel -> BitcoinLockTime

_setChannelState :: ReceiverPaymentChannel -> PaymentChannelState -> ReceiverPaymentChannel

channelValueLeft :: ReceiverPaymentChannel -> BitcoinAmount

channelIsExhausted :: ReceiverPaymentChannel -> Bool

data Payment

Used to transfer value from sender to receiver.

Instances

Eq Payment

Methods

(==) :: Payment -> Payment -> Bool

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

data FundingTxInfo

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

• ftiOutValue :: BitcoinAmount

  Value of funding output (channel max value)

Instances

Eq FundingTxInfo

Methods

(==) :: FundingTxInfo -> FundingTxInfo -> Bool

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

Show FundingTxInfo

Methods

showsPrec :: Int -> FundingTxInfo -> ShowS

show :: FundingTxInfo -> String

showList :: [FundingTxInfo] -> ShowS

data ChannelParameters

Defines sender, receiver, and expiration date of the channel

Constructors

CChannelParameters

Fields

• cpSenderPubKey :: PubKey
• cpReceiverPubKey :: PubKey
• cpLockTime :: BitcoinLockTime

  Channel expiration date/time

Instances

Eq ChannelParameters

Methods

(==) :: ChannelParameters -> ChannelParameters -> Bool

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

Show ChannelParameters

Methods

showsPrec :: Int -> ChannelParameters -> ShowS

show :: ChannelParameters -> String

showList :: [ChannelParameters] -> ShowS

data PayChanError

Constructors

BadSignature

BadPaymentValue BitcoinAmount

NoValueTransferred

DustOutput

Instances

Show PayChanError

Methods

showsPrec :: Int -> PayChanError -> ShowS

show :: PayChanError -> String

showList :: [PayChanError] -> ShowS

data PaymentChannelState

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

Instances

Eq PaymentChannelState

Methods

(==) :: PaymentChannelState -> PaymentChannelState -> Bool

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

Show PaymentChannelState

Methods

showsPrec :: Int -> PaymentChannelState -> ShowS

show :: PaymentChannelState -> String

showList :: [PaymentChannelState] -> ShowS

data BitcoinAmount

Represents a bitcoin amount as number of satoshis. 1 satoshi = 1e-8 bitcoins. Integer operations will never over- or underflow with this type. Convert to a Word64 using toWord64, which caps the final amount.

Instances

Enum BitcoinAmount

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

Methods

(==) :: BitcoinAmount -> BitcoinAmount -> Bool

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

Integral BitcoinAmount

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

Methods

(+) :: BitcoinAmount -> BitcoinAmount -> BitcoinAmount

(-) :: BitcoinAmount -> BitcoinAmount -> BitcoinAmount

(*) :: BitcoinAmount -> BitcoinAmount -> BitcoinAmount

negate :: BitcoinAmount -> BitcoinAmount

abs :: BitcoinAmount -> BitcoinAmount

signum :: BitcoinAmount -> BitcoinAmount

fromInteger :: Integer -> BitcoinAmount

Ord BitcoinAmount

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

Methods

toRational :: BitcoinAmount -> Rational

Show BitcoinAmount

Methods

showsPrec :: Int -> BitcoinAmount -> ShowS

show :: BitcoinAmount -> String

showList :: [BitcoinAmount] -> ShowS

Binary BitcoinAmount

Methods

put :: BitcoinAmount -> Put

get :: Get BitcoinAmount

putList :: [BitcoinAmount] -> Put

Serialize BitcoinAmount

Methods

put :: Putter BitcoinAmount

get :: Get BitcoinAmount

toWord64 :: BitcoinAmount -> Word64

Convert to Word64, with zero as floor, UINT64_MAX as ceiling

data BitcoinLockTime

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

Constructors

LockTimeBlockHeight Word32

LockTimeDate UTCTime

Instances

Eq BitcoinLockTime

Methods

(==) :: BitcoinLockTime -> BitcoinLockTime -> Bool

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

Show BitcoinLockTime

Methods

showsPrec :: Int -> BitcoinLockTime -> ShowS

show :: BitcoinLockTime -> String

showList :: [BitcoinLockTime] -> ShowS

Binary BitcoinLockTime

Methods

put :: BitcoinLockTime -> Put

get :: Get BitcoinLockTime

putList :: [BitcoinLockTime] -> Put

fromDate :: UTCTime -> BitcoinLockTime

Convert a UTCTime to a BitcoinLockTime

b64Encode :: Binary a => a -> ByteString

dUST_LIMIT :: BitcoinAmount

mIN_CHANNEL_SIZE :: BitcoinAmount