| 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 Config = Config {
- cDustLimit :: BitcoinAmount
- cSettlementPeriod :: Hour
- defaultConfig :: Config
- data Payment
- cpSignature :: Payment -> PaymentSignature
- data FullPayment = CFullPayment {}
- data FundingTxInfo = CFundingTxInfo {}
- data ChannelParameters = CChannelParameters {}
- data PayChanError
- data PaymentChannelState
- newtype SendPubKey = MkSendPubKey {}
- newtype RecvPubKey = MkRecvPubKey {}
- class IsPubKey a where
- data BitcoinAmount
- data BitcoinLockTime
- fromDate :: UTCTime -> BitcoinLockTime
- usesBlockHeight :: BitcoinLockTime -> Bool
Documentation
class PaymentChannel a where Source #
Get various information about an open payment channel.
Minimal complete definition
Methods
valueToMe :: a -> BitcoinAmount Source #
Get amount received by receiver/left for sender
getChannelState :: a -> PaymentChannelState Source #
Retrieve internal state object
getChannelFunding :: a -> OutPoint Source #
getExpirationDate :: a -> BitcoinLockTime Source #
getSenderPubKey :: a -> SendPubKey Source #
getFundingAmount :: a -> BitcoinAmount Source #
getPaymentCount :: a -> Word64 Source #
fundingAddress :: a -> Address Source #
getNewestPayment :: a -> Payment Source #
getNewestSig :: a -> Signature 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 #
senderChangeValue :: 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
| |
Miscellaneous configuration options
Constructors
| Config | |
Fields
| |
Contains the bare minimum of information to transfer value from sender to receiver.
cpSignature :: Payment -> PaymentSignature Source #
Payment signature
data FullPayment Source #
Contains all information required to construct the payment transaction
Constructors
| CFullPayment | |
Fields
| |
Instances
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
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 bitcoin.
Only natural numbers (>= 0) can be represented (fromInteger caps to a Word64).
It is thus not possible to construct a negative BitcoinAmount which, when added to
another BitcoinAmount, subtracts from its value. So we avoid the problem of being
able to invert subtraction/addition by supplying a negative value as one of the
arguments.
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 |
fromDate :: UTCTime -> BitcoinLockTime Source #
Convert a UTCTime to a BitcoinLockTime