| Copyright | (c) Rune K. Svendsen, 2016 |
|---|---|
| License | PublicDomain |
| Maintainer | runesvend@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Data.Bitcoin.PaymentChannel.Types
Description
Types used with the interface provided by Data.Bitcoin.PaymentChannel.
- class PaymentChannel a where
- data SenderPaymentChannel = CSenderPaymentChannel {}
- newtype ReceiverPaymentChannel = CReceiverPaymentChannel {}
- data Payment
- data FundingTxInfo = CFundingTxInfo {}
- data ChannelParameters = CChannelParameters {}
- data PayChanError
- data PaymentChannelState
- newtype SendPubKey = MkSendPubKey {}
- newtype RecvPubKey = MkRecvPubKey {}
- class IsPubKey a where
- data BitcoinAmount
- toWord64 :: BitcoinAmount -> Word64
- data BitcoinLockTime
- fromDate :: UTCTime -> BitcoinLockTime
- usesBlockHeight :: BitcoinLockTime -> Bool
- b64Encode :: Binary a => a -> ByteString
- dUST_LIMIT :: BitcoinAmount
- mIN_CHANNEL_SIZE :: BitcoinAmount
Documentation
class PaymentChannel a where Source #
Get various information about an open payment channel.
Minimal complete definition
Methods
valueToMe :: a -> BitcoinAmount Source #
Get value sent to receiver/left for sender
getChannelState :: a -> PaymentChannelState Source #
Retrieve internal state object
getChannelID :: a -> OutPoint Source #
getExpirationDate :: a -> BitcoinLockTime Source #
getNewestPayment :: a -> Payment Source #
expiresBefore :: BitcoinLockTime -> a -> Bool Source #
Return True if channel expires earlier than given expiration date
_setChannelState :: a -> PaymentChannelState -> a Source #
For internal use
channelValueLeft :: a -> BitcoinAmount Source #
channelIsExhausted :: a -> Bool Source #
data SenderPaymentChannel Source #
State object for the value sender
Constructors
| CSenderPaymentChannel | |
Fields
| |
newtype ReceiverPaymentChannel Source #
State object for the value receiver
Constructors
| CReceiverPaymentChannel | |
Fields
| |
data FundingTxInfo Source #
Holds information about the Bitcoin transaction used to fund the channel
Constructors
| CFundingTxInfo | |
Fields
| |
Instances
data ChannelParameters Source #
Defines channel: sender, receiver, and expiration date
Constructors
| CChannelParameters | |
Fields
| |
Instances
data PayChanError Source #
Constructors
| BadSignature | |
| BadPaymentValue BitcoinAmount | |
| NoValueTransferred | |
| DustOutput | |
| InternalError String |
Instances
data PaymentChannelState Source #
Shared state object used by both value sender and value receiver.
Instances
data BitcoinAmount Source #
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.
toWord64 :: BitcoinAmount -> Word64 Source #
Convert to Word64, with zero as floor, UINT64_MAX as ceiling
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 accuraccy |
fromDate :: UTCTime -> BitcoinLockTime Source #
Convert a UTCTime to a BitcoinLockTime
b64Encode :: Binary a => a -> ByteString Source #