PaymentChannel.Types

Types used with the interface provided by PaymentChannel.

Shared senderreceiver typesfunctions

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 (zero-based index of funding output within list of transaction outputs)

• ftiOutValue :: NonDustyAmount

  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

Generic FundingTxInfo

Associated Types

type Rep FundingTxInfo :: * -> *

Methods

from :: FundingTxInfo -> Rep FundingTxInfo x

to :: Rep FundingTxInfo x -> FundingTxInfo

ToJSON FundingTxInfo

Methods

toJSON :: FundingTxInfo -> Value

toEncoding :: FundingTxInfo -> Encoding

toJSONList :: [FundingTxInfo] -> Value

toEncodingList :: [FundingTxInfo] -> Encoding

FromJSON FundingTxInfo

Methods

parseJSON :: Value -> Parser FundingTxInfo

parseJSONList :: Value -> Parser [FundingTxInfo]

Serialize FundingTxInfo

Methods

put :: Putter FundingTxInfo

get :: Get FundingTxInfo

type Rep FundingTxInfo

type Rep FundingTxInfo = D1 (MetaData "FundingTxInfo" "PaymentChannel.Internal.Types" "bitcoin-payment-channel-1.2.0.0-7YwDEKAOCp2BNoMt0JxEOM" False) (C1 (MetaCons "CFundingTxInfo" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "ftiHash") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TxHash)) ((:*:) (S1 (MetaSel (Just Symbol "ftiOutIndex") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word32)) (S1 (MetaSel (Just Symbol "ftiOutValue") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 NonDustyAmount)))))

data ChanParams

Defines channel: sender, receiver, and expiration date

Constructors

ChanParams

Fields

• cpSenderPubKey :: SendPubKey
• cpReceiverPubKey :: RecvPubKey
• cpLockTime :: LockTimeDate

  Channel expiration date/time

Instances

Eq ChanParams

Methods

(==) :: ChanParams -> ChanParams -> Bool

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

Show ChanParams

Methods

showsPrec :: Int -> ChanParams -> ShowS

show :: ChanParams -> String

showList :: [ChanParams] -> ShowS

Generic ChanParams

Associated Types

type Rep ChanParams :: * -> *

Methods

from :: ChanParams -> Rep ChanParams x

to :: Rep ChanParams x -> ChanParams

ToJSON ChanParams

Methods

toJSON :: ChanParams -> Value

toEncoding :: ChanParams -> Encoding

toJSONList :: [ChanParams] -> Value

toEncodingList :: [ChanParams] -> Encoding

FromJSON ChanParams

Methods

parseJSON :: Value -> Parser ChanParams

parseJSONList :: Value -> Parser [ChanParams]

Serialize ChanParams

Methods

put :: Putter ChanParams

get :: Get ChanParams

NFData ChanParams

Methods

rnf :: ChanParams -> ()

HasLockTimeDate ChanParams

Methods

getLockTimeDate :: ChanParams -> LockTimeDate

HasRecvPubKey ChanParams

Methods

getRecvPubKey :: ChanParams -> RecvPubKey

HasSendPubKey ChanParams

Methods

getSendPubKey :: ChanParams -> SendPubKey

DerivationSeed ChanParams

Methods

toDerivSeed :: ChanParams -> ByteString

HasUserParams ChanParams

Methods

getUserParams :: ChanParams -> UserParams

type Rep ChanParams

type Rep ChanParams = D1 (MetaData "ChanParams" "PaymentChannel.Internal.ChanScript" "bitcoin-payment-channel-1.2.0.0-7YwDEKAOCp2BNoMt0JxEOM" False) (C1 (MetaCons "ChanParams" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "cpSenderPubKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SendPubKey)) ((:*:) (S1 (MetaSel (Just Symbol "cpReceiverPubKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RecvPubKey)) (S1 (MetaSel (Just Symbol "cpLockTime") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 LockTimeDate)))))

class HasSignedPayChanState a => PaymentChannel a where

Get various information about an open payment channel.

Minimal complete definition

valueToMe, channelValueLeft, getStatePayment

Methods

valueToMe :: a -> BtcAmount

Get amount received by receiver/left for sender

channelValueLeft :: a -> BtcAmount

Remaining channel value

getStatePayment :: a -> SignedPayment

For internal use

Instances

PaymentChannel ClientPayChan

Methods

valueToMe :: ClientPayChan -> BtcAmount

channelValueLeft :: ClientPayChan -> BtcAmount

getStatePayment :: ClientPayChan -> SignedPayment

PaymentChannel (ServerPayChanI s)

Methods

valueToMe :: ServerPayChanI s -> BtcAmount

channelValueLeft :: ServerPayChanI s -> BtcAmount

getStatePayment :: ServerPayChanI s -> SignedPayment

class PaymentChannel a => PayChan a

Short-hand

class PaymentChannel a => PaymentChannelRecv a where

Payment channel state objects with metadata information

Minimal complete definition

clientTotalValueSent

Methods

clientTotalValueSent :: a -> BtcAmount

Get total amount (both settled and unsettled) sent by client

Instances

PaymentChannelRecv (ServerPayChanI (MetadataI a))

Methods

clientTotalValueSent :: ServerPayChanI (MetadataI a) -> BtcAmount

data SharedSecret :: *

Instances

Eq SharedSecret

Methods

(==) :: SharedSecret -> SharedSecret -> Bool

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

Show SharedSecret

Methods

showsPrec :: Int -> SharedSecret -> ShowS

show :: SharedSecret -> String

showList :: [SharedSecret] -> ShowS

Generic SharedSecret

Associated Types

type Rep SharedSecret :: * -> *

Methods

from :: SharedSecret -> Rep SharedSecret x

to :: Rep SharedSecret x -> SharedSecret

ToJSON SharedSecret

Methods

toJSON :: SharedSecret -> Value

toEncoding :: SharedSecret -> Encoding

toJSONList :: [SharedSecret] -> Value

toEncodingList :: [SharedSecret] -> Encoding

FromJSON SharedSecret

Methods

parseJSON :: Value -> Parser SharedSecret

parseJSONList :: Value -> Parser [SharedSecret]

Serialize SharedSecret

Methods

put :: Putter SharedSecret

get :: Get SharedSecret

NFData SharedSecret

Methods

rnf :: SharedSecret -> ()

ToHttpApiData SharedSecret

Methods

toUrlPiece :: SharedSecret -> Text

toEncodedUrlPiece :: SharedSecret -> Builder

toHeader :: SharedSecret -> ByteString

toQueryParam :: SharedSecret -> Text

FromHttpApiData SharedSecret

Methods

parseUrlPiece :: Text -> Either Text SharedSecret

parseHeader :: ByteString -> Either Text SharedSecret

parseQueryParam :: Text -> Either Text SharedSecret

type Rep SharedSecret

type Rep SharedSecret = D1 (MetaData "SharedSecret" "RBPCP.Types" "rbpcp-api-0.2.0.0-HjG8OZksaPrKuqAft2d0fv" True) (C1 (MetaCons "SharedSecret" PrefixI True) (S1 (MetaSel (Just Symbol "ssHash") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Hash256)))

class HasSharedSecret a where

Minimal complete definition

getSecret

Methods

getSecret :: a -> SharedSecret

Instances

HasSharedSecret ClientPayChan

Methods

getSecret :: ClientPayChan -> SharedSecret

HasSharedSecret (PayChanState a)

Methods

getSecret :: PayChanState a -> SharedSecret

HasSharedSecret (ServerPayChanG sd s)

Methods

getSecret :: ServerPayChanG sd s -> SharedSecret

fundingAddress :: HasPayChanState a => a -> Address

clientChangeAddress :: HasPayChanState a => a -> Address

getFundingAmount :: HasPayChanState a => a -> BtcAmount

Sender

data ClientPayChanI sigData

State object for the value sender

Constructors

MkClientPayChan

Fields

• spcState :: PayChanState sigData

  Internal state object

• spcPrvKey :: PrvKeyC

  Payment-signing private key

Instances

Show ClientPayChan

Methods

showsPrec :: Int -> ClientPayChan -> ShowS

show :: ClientPayChan -> String

showList :: [ClientPayChan] -> ShowS

HasSigData ClientPayChanI

Methods

mapSigData :: (a -> b) -> ClientPayChanI a -> ClientPayChanI b

SetClientChangeAddr ClientPayChanI

Methods

_setClientChangeAddr :: ClientPayChanI BtcSig -> Address -> ClientPayChanI InvalidSig

HasSharedSecret ClientPayChan

Methods

getSecret :: ClientPayChan -> SharedSecret

PaymentChannel ClientPayChan

Methods

valueToMe :: ClientPayChan -> BtcAmount

channelValueLeft :: ClientPayChan -> BtcAmount

getStatePayment :: ClientPayChan -> SignedPayment

Eq sigData => Eq (ClientPayChanI sigData)

Methods

(==) :: ClientPayChanI sigData -> ClientPayChanI sigData -> Bool

(/=) :: ClientPayChanI sigData -> ClientPayChanI sigData -> Bool

Generic (ClientPayChanI sigData)

Associated Types

type Rep (ClientPayChanI sigData) :: * -> *

Methods

from :: ClientPayChanI sigData -> Rep (ClientPayChanI sigData) x

to :: Rep (ClientPayChanI sigData) x -> ClientPayChanI sigData

NFData sigData => NFData (ClientPayChanI sigData)

Methods

rnf :: ClientPayChanI sigData -> ()

HasRecvPubKey (ClientPayChanI a)

Methods

getRecvPubKey :: ClientPayChanI a -> RecvPubKey

HasSendPubKey (ClientPayChanI a)

Methods

getSendPubKey :: ClientPayChanI a -> SendPubKey

type Rep (ClientPayChanI sigData)

type Rep (ClientPayChanI sigData) = D1 (MetaData "ClientPayChanI" "PaymentChannel.Internal.Types" "bitcoin-payment-channel-1.2.0.0-7YwDEKAOCp2BNoMt0JxEOM" False) (C1 (MetaCons "MkClientPayChan" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "spcState") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (PayChanState sigData))) (S1 (MetaSel (Just Symbol "spcPrvKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PrvKeyC))))

Receiver

type ServerPayChan = ServerPayChanI ()

ServerPayChan without receiver key metadata

data ServerPayChanG kd sd

State object for the value receiver. "kd" is used to store information about the receiver key(s) used for this state object.

Instances

ToJSON d => ToJSON (ServerPayChanI d)

Methods

toJSON :: ServerPayChanI d -> Value

toEncoding :: ServerPayChanI d -> Encoding

toJSONList :: [ServerPayChanI d] -> Value

toEncodingList :: [ServerPayChanI d] -> Encoding

FromJSON d => FromJSON (ServerPayChanI d)

Methods

parseJSON :: Value -> Parser (ServerPayChanI d)

parseJSONList :: Value -> Parser [ServerPayChanI d]

HasSigData (ServerPayChanG kd)

Methods

mapSigData :: (a -> b) -> ServerPayChanG kd a -> ServerPayChanG kd b

SetClientChangeAddr (ServerPayChanG kd)

Methods

_setClientChangeAddr :: ServerPayChanG kd BtcSig -> Address -> ServerPayChanG kd InvalidSig

PaymentChannelRecv (ServerPayChanI (MetadataI a))

Methods

clientTotalValueSent :: ServerPayChanI (MetadataI a) -> BtcAmount

PaymentChannel (ServerPayChanI s)

Methods

valueToMe :: ServerPayChanI s -> BtcAmount

channelValueLeft :: ServerPayChanI s -> BtcAmount

getStatePayment :: ServerPayChanI s -> SignedPayment

(Eq kd, Eq sd) => Eq (ServerPayChanG kd sd)

Methods

(==) :: ServerPayChanG kd sd -> ServerPayChanG kd sd -> Bool

(/=) :: ServerPayChanG kd sd -> ServerPayChanG kd sd -> Bool

(Show kd, Show sd) => Show (ServerPayChanG kd sd)

Methods

showsPrec :: Int -> ServerPayChanG kd sd -> ShowS

show :: ServerPayChanG kd sd -> String

showList :: [ServerPayChanG kd sd] -> ShowS

Generic (ServerPayChanG kd sd)

Associated Types

type Rep (ServerPayChanG kd sd) :: * -> *

Methods

from :: ServerPayChanG kd sd -> Rep (ServerPayChanG kd sd) x

to :: Rep (ServerPayChanG kd sd) x -> ServerPayChanG kd sd

(Serialize kd, Serialize sd) => Serialize (ServerPayChanG kd sd)

Methods

put :: Putter (ServerPayChanG kd sd)

get :: Get (ServerPayChanG kd sd)

(NFData kd, NFData sd) => NFData (ServerPayChanG kd sd)

Methods

rnf :: ServerPayChanG kd sd -> ()

HasLockTimeDate (ServerPayChanG kd sd)

Methods

getLockTimeDate :: ServerPayChanG kd sd -> LockTimeDate

HasRecvPubKey (ServerPayChanG kd sd)

Methods

getRecvPubKey :: ServerPayChanG kd sd -> RecvPubKey

HasSendPubKey (ServerPayChanG kd sd)

Methods

getSendPubKey :: ServerPayChanG kd sd -> SendPubKey

HasSharedSecret (ServerPayChanG sd s)

Methods

getSecret :: ServerPayChanG sd s -> SharedSecret

type Rep (ServerPayChanG kd sd)

type Rep (ServerPayChanG kd sd) = D1 (MetaData "ServerPayChanG" "PaymentChannel.Internal.Receiver.Types" "bitcoin-payment-channel-1.2.0.0-7YwDEKAOCp2BNoMt0JxEOM" False) (C1 (MetaCons "MkServerPayChan" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "rpcState") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (PayChanState sd))) (S1 (MetaSel (Just Symbol "rpcMetadata") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (MetadataI kd)))))

data PayChanStatus

Constructors

ReadyForPayment

PaymentInProgress

SettlementInProgress

ChannelClosed SignedPayment

The closing channel payment

Instances

Eq PayChanStatus

Methods

(==) :: PayChanStatus -> PayChanStatus -> Bool

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

Show PayChanStatus

Methods

showsPrec :: Int -> PayChanStatus -> ShowS

show :: PayChanStatus -> String

showList :: [PayChanStatus] -> ShowS

Generic PayChanStatus

Associated Types

type Rep PayChanStatus :: * -> *

Methods

from :: PayChanStatus -> Rep PayChanStatus x

to :: Rep PayChanStatus x -> PayChanStatus

ToJSON PayChanStatus

Methods

toJSON :: PayChanStatus -> Value

toEncoding :: PayChanStatus -> Encoding

toJSONList :: [PayChanStatus] -> Value

toEncodingList :: [PayChanStatus] -> Encoding

FromJSON PayChanStatus

Methods

parseJSON :: Value -> Parser PayChanStatus

parseJSONList :: Value -> Parser [PayChanStatus]

Serialize PayChanStatus

Methods

put :: Putter PayChanStatus

get :: Get PayChanStatus

NFData PayChanStatus

Methods

rnf :: PayChanStatus -> ()

type Rep PayChanStatus

type Rep PayChanStatus = D1 (MetaData "PayChanStatus" "PaymentChannel.Internal.Metadata.Types" "bitcoin-payment-channel-1.2.0.0-7YwDEKAOCp2BNoMt0JxEOM" False) ((:+:) ((:+:) (C1 (MetaCons "ReadyForPayment" PrefixI False) U1) (C1 (MetaCons "PaymentInProgress" PrefixI False) U1)) ((:+:) (C1 (MetaCons "SettlementInProgress" PrefixI False) U1) (C1 (MetaCons "ChannelClosed" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SignedPayment)))))

data MetadataI kd

Constructors

Metadata

Fields

• mdKeyData :: kd
• mdPayCount :: Word64
• mdSettledValue :: [SettleInfo]
• mdUnsettledValue :: BtcAmount
• mdChannelStatus :: PayChanStatus

Instances

Eq kd => Eq (MetadataI kd)

Methods

(==) :: MetadataI kd -> MetadataI kd -> Bool

(/=) :: MetadataI kd -> MetadataI kd -> Bool

Show kd => Show (MetadataI kd)

Methods

showsPrec :: Int -> MetadataI kd -> ShowS

show :: MetadataI kd -> String

showList :: [MetadataI kd] -> ShowS

Generic (MetadataI kd)

Associated Types

type Rep (MetadataI kd) :: * -> *

Methods

from :: MetadataI kd -> Rep (MetadataI kd) x

to :: Rep (MetadataI kd) x -> MetadataI kd

ToJSON a => ToJSON (MetadataI a)

Methods

toJSON :: MetadataI a -> Value

toEncoding :: MetadataI a -> Encoding

toJSONList :: [MetadataI a] -> Value

toEncodingList :: [MetadataI a] -> Encoding

FromJSON a => FromJSON (MetadataI a)

Methods

parseJSON :: Value -> Parser (MetadataI a)

parseJSONList :: Value -> Parser [MetadataI a]

Serialize a => Serialize (MetadataI a)

Methods

put :: Putter (MetadataI a)

get :: Get (MetadataI a)

NFData kd => NFData (MetadataI kd)

Methods

rnf :: MetadataI kd -> ()

PaymentChannelRecv (ServerPayChanI (MetadataI a))

Methods

clientTotalValueSent :: ServerPayChanI (MetadataI a) -> BtcAmount

type Rep (MetadataI kd)

type Rep (MetadataI kd)

data OpenError

Constructors

PickOutError (PickOutError ChanParams)

Incorrect output specified

ResourcePaymentMismatch Tx TxHash

FundingTxError ParseError

FundingTxDustOut BtcAmount

IncorrectInitialPaymentValue (ExpectFail BtcAmount)

InsufficientDuration Hour

Instances

Eq OpenError

Methods

(==) :: OpenError -> OpenError -> Bool

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

Show OpenError

Methods

showsPrec :: Int -> OpenError -> ShowS

show :: OpenError -> String

showList :: [OpenError] -> ShowS

Generic OpenError

Associated Types

type Rep OpenError :: * -> *

Methods

from :: OpenError -> Rep OpenError x

to :: Rep OpenError x -> OpenError

ToJSON OpenError

Methods

toJSON :: OpenError -> Value

toEncoding :: OpenError -> Encoding

toJSONList :: [OpenError] -> Value

toEncodingList :: [OpenError] -> Encoding

FromJSON OpenError

Methods

parseJSON :: Value -> Parser OpenError

parseJSONList :: Value -> Parser [OpenError]

Serialize OpenError

Methods

put :: Putter OpenError

get :: Get OpenError

NFData OpenError

Methods

rnf :: OpenError -> ()

IsPayChanError OpenError

Methods

mkChanErr :: OpenError -> PayChanError

type Rep OpenError

type Rep OpenError = D1 (MetaData "OpenError" "PaymentChannel.Internal.Receiver.Open" "bitcoin-payment-channel-1.2.0.0-7YwDEKAOCp2BNoMt0JxEOM" False) ((:+:) ((:+:) (C1 (MetaCons "PickOutError" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (PickOutError ChanParams)))) ((:+:) (C1 (MetaCons "ResourcePaymentMismatch" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Tx)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TxHash)))) (C1 (MetaCons "FundingTxError" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ParseError))))) ((:+:) (C1 (MetaCons "FundingTxDustOut" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BtcAmount))) ((:+:) (C1 (MetaCons "IncorrectInitialPaymentValue" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ExpectFail BtcAmount)))) (C1 (MetaCons "InsufficientDuration" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Hour))))))

getChannelStatus :: ServerPayChanG kd sd -> PayChanStatus

setChannelStatus :: PayChanStatus -> ServerPayChanG kd sd -> ServerPayChanG kd sd

markAsBusy :: ServerPayChanG kd sd -> ServerPayChanG kd sd

isReadyForPayment :: ServerPayChanG kd sd -> Bool

data ServerSettings

Various server-defined settings

Constructors

ServerSettings

Fields

• serverConfDustLimit :: BtcAmount

  The server will not accept a payment that leaves the client with less than this amount in change (unless it's exactly zero)

• serverConfSettlePeriod :: Hour

  The channel may be closed this number of hours *before* the in-blockchain expiration date

• serverConfMinDuration :: Hour

  Minimum duration of the payment channel

• serverConfOpenPrice :: BtcAmount

  Value of the initial payment needed to open the payment channel

Instances

Eq ServerSettings

Methods

(==) :: ServerSettings -> ServerSettings -> Bool

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

Show ServerSettings

Methods

showsPrec :: Int -> ServerSettings -> ShowS

show :: ServerSettings -> String

showList :: [ServerSettings] -> ShowS

Generic ServerSettings

Associated Types

type Rep ServerSettings :: * -> *

Methods

from :: ServerSettings -> Rep ServerSettings x

to :: Rep ServerSettings x -> ServerSettings

ToJSON ServerSettings

Methods

toJSON :: ServerSettings -> Value

toEncoding :: ServerSettings -> Encoding

toJSONList :: [ServerSettings] -> Value

toEncodingList :: [ServerSettings] -> Encoding

FromJSON ServerSettings

Methods

parseJSON :: Value -> Parser ServerSettings

parseJSONList :: Value -> Parser [ServerSettings]

Serialize ServerSettings

Methods

put :: Putter ServerSettings

get :: Get ServerSettings

NFData ServerSettings

Methods

rnf :: ServerSettings -> ()

MonadReader ServerSettings MonadConf

Methods

ask :: MonadConf ServerSettings

local :: (ServerSettings -> ServerSettings) -> MonadConf a -> MonadConf a

reader :: (ServerSettings -> a) -> MonadConf a

type Rep ServerSettings

type Rep ServerSettings = D1 (MetaData "ServerSettings" "PaymentChannel.Internal.Config" "bitcoin-payment-channel-1.2.0.0-7YwDEKAOCp2BNoMt0JxEOM" False) (C1 (MetaCons "ServerSettings" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "serverConfDustLimit") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BtcAmount)) (S1 (MetaSel (Just Symbol "serverConfSettlePeriod") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Hour))) ((:*:) (S1 (MetaSel (Just Symbol "serverConfMinDuration") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Hour)) (S1 (MetaSel (Just Symbol "serverConfOpenPrice") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BtcAmount)))))

newtype Hour

Constructors

MkHour

Fields

• numHours :: Word32

Instances

Enum Hour

Methods

succ :: Hour -> Hour

pred :: Hour -> Hour

toEnum :: Int -> Hour

fromEnum :: Hour -> Int

enumFrom :: Hour -> [Hour]

enumFromThen :: Hour -> Hour -> [Hour]

enumFromTo :: Hour -> Hour -> [Hour]

enumFromThenTo :: Hour -> Hour -> Hour -> [Hour]

Eq Hour

Methods

(==) :: Hour -> Hour -> Bool

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

Integral Hour

Methods

quot :: Hour -> Hour -> Hour

rem :: Hour -> Hour -> Hour

div :: Hour -> Hour -> Hour

mod :: Hour -> Hour -> Hour

quotRem :: Hour -> Hour -> (Hour, Hour)

divMod :: Hour -> Hour -> (Hour, Hour)

toInteger :: Hour -> Integer

Num Hour

Methods

(+) :: Hour -> Hour -> Hour

(-) :: Hour -> Hour -> Hour

(*) :: Hour -> Hour -> Hour

negate :: Hour -> Hour

abs :: Hour -> Hour

signum :: Hour -> Hour

fromInteger :: Integer -> Hour

Ord Hour

Methods

compare :: Hour -> Hour -> Ordering

(<) :: Hour -> Hour -> Bool

(<=) :: Hour -> Hour -> Bool

(>) :: Hour -> Hour -> Bool

(>=) :: Hour -> Hour -> Bool

max :: Hour -> Hour -> Hour

min :: Hour -> Hour -> Hour

Real Hour

Methods

toRational :: Hour -> Rational

Show Hour

Methods

showsPrec :: Int -> Hour -> ShowS

show :: Hour -> String

showList :: [Hour] -> ShowS

Generic Hour

Associated Types

type Rep Hour :: * -> *

Methods

from :: Hour -> Rep Hour x

to :: Rep Hour x -> Hour

ToJSON Hour

Methods

toJSON :: Hour -> Value

toEncoding :: Hour -> Encoding

toJSONList :: [Hour] -> Value

toEncodingList :: [Hour] -> Encoding

FromJSON Hour

Methods

parseJSON :: Value -> Parser Hour

parseJSONList :: Value -> Parser [Hour]

Serialize Hour

Methods

put :: Putter Hour

get :: Get Hour

NFData Hour

Methods

rnf :: Hour -> ()

type Rep Hour

type Rep Hour = D1 (MetaData "Hour" "PaymentChannel.Internal.Types.Hour" "bitcoin-payment-channel-1.2.0.0-7YwDEKAOCp2BNoMt0JxEOM" True) (C1 (MetaCons "MkHour" PrefixI True) (S1 (MetaSel (Just Symbol "numHours") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word32)))

Receiver state (with pubkey metadata)

type ServerPayChanX = ServerPayChanI ExtPub

ServerPayChan with BIP32, "extended key" index as metadata

mkExtendedDerivRpc :: RootPub -> ServerPayChanI kd -> Maybe ServerPayChanX

Add an ExtPub to a ServerPayChan that has been created with a server pubkey derived using deriveRecvPub

data UserParams

Constructors

UserParams

Fields

• upPubKey :: SendPubKey
• upLockTime :: LockTimeDate

Instances

DerivationSeed UserParams

Methods

toDerivSeed :: UserParams -> ByteString

HasUserParams UserParams

Methods

getUserParams :: UserParams -> UserParams

deriveRecvPub :: HasUserParams up => RootPub -> up -> (ChanParams, External ChildPub)

Deterministically derive a server public key from client pubkey+expiration date

Payment

type SignedPayment = Payment BtcSig

Receiver settlement

data ClosedServerChanI kd

Instances

Eq kd => Eq (ClosedServerChanI kd)

Methods

(==) :: ClosedServerChanI kd -> ClosedServerChanI kd -> Bool

(/=) :: ClosedServerChanI kd -> ClosedServerChanI kd -> Bool

Show kd => Show (ClosedServerChanI kd)

Methods

showsPrec :: Int -> ClosedServerChanI kd -> ShowS

show :: ClosedServerChanI kd -> String

showList :: [ClosedServerChanI kd] -> ShowS

Generic (ClosedServerChanI kd)

Associated Types

type Rep (ClosedServerChanI kd) :: * -> *

Methods

from :: ClosedServerChanI kd -> Rep (ClosedServerChanI kd) x

to :: Rep (ClosedServerChanI kd) x -> ClosedServerChanI kd

Serialize kd => Serialize (ClosedServerChanI kd)

Methods

put :: Putter (ClosedServerChanI kd)

get :: Get (ClosedServerChanI kd)

NFData kd => NFData (ClosedServerChanI kd)

Methods

rnf :: ClosedServerChanI kd -> ()

type Rep (ClosedServerChanI kd)

type Rep (ClosedServerChanI kd) = D1 (MetaData "ClosedServerChanI" "PaymentChannel.Internal.Receiver.Types" "bitcoin-payment-channel-1.2.0.0-7YwDEKAOCp2BNoMt0JxEOM" False) (C1 (MetaCons "MkClosedServerChan" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "cscState") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ServerPayChanG kd BtcSig))) (S1 (MetaSel (Just Symbol "cscClosingPayment") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SignedPayment))))

type ClosedServerChan = ClosedServerChanI ()

type ClosedServerChanX = ClosedServerChanI ExtPub

getClosedState :: ClosedServerChanI kd -> ServerPayChanI kd

cscClosingPayment :: ClosedServerChanI kd -> SignedPayment

type SettleTx = BtcTx P2SH ChanParams PaymentScriptSig

Error

data PayChanError

Constructors

SigVerifyFailed

Signature verification failed

LockTimeParseError LockTimeParseError

BadSigHashFlag SigHash SigHash

Unexpected SigHash flag. Expected: SIGHASH_SINGLE|ANYONECANPAY.

BadPaymentValue BtcAmount

Payment assigns less value to server than previous payment. Client change value is greater by the specified BtcAmount.

PaymentError (TxMismatch ChanParams)

ChannelExpired

Channel has expired or is too close to expiration date

StatusError HTTPError

Channel not ready for payment. 409=try again; 410=channel gone.

RBPCPError ParseError

Failed to parse RBPCP payment

OpenError OpenError

Channel-open error

Instances

Eq PayChanError

Methods

(==) :: PayChanError -> PayChanError -> Bool

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

Show PayChanError

Methods

showsPrec :: Int -> PayChanError -> ShowS

show :: PayChanError -> String

showList :: [PayChanError] -> ShowS

Generic PayChanError

Associated Types

type Rep PayChanError :: * -> *

Methods

from :: PayChanError -> Rep PayChanError x

to :: Rep PayChanError x -> PayChanError

ToJSON PayChanError

Methods

toJSON :: PayChanError -> Value

toEncoding :: PayChanError -> Encoding

toJSONList :: [PayChanError] -> Value

toEncodingList :: [PayChanError] -> Encoding

FromJSON PayChanError

Methods

parseJSON :: Value -> Parser PayChanError

parseJSONList :: Value -> Parser [PayChanError]

Exception PayChanError

Methods

toException :: PayChanError -> SomeException

fromException :: SomeException -> Maybe PayChanError

displayException :: PayChanError -> String

Serialize PayChanError

Methods

put :: Putter PayChanError

get :: Get PayChanError

NFData PayChanError

Methods

rnf :: PayChanError -> ()

type Rep PayChanError

type Rep PayChanError

class IsPayChanError e where

Minimal complete definition

mkChanErr

Methods

mkChanErr :: e -> PayChanError

Instances

IsPayChanError LockTimeParseError

Methods

mkChanErr :: LockTimeParseError -> PayChanError

IsPayChanError ParseError

Methods

mkChanErr :: ParseError -> PayChanError

IsPayChanError OpenError

Methods

mkChanErr :: OpenError -> PayChanError

Bitcoin

class HasFee a where

Objects from which a Bitcoin fee can be calculated, given a transaction

Minimal complete definition

absoluteFee

Methods

absoluteFee :: BtcAmount -> TxByteSize -> a -> BtcAmount

Instances

HasFee BtcAmount

Constant fee

Methods

absoluteFee :: BtcAmount -> TxByteSize -> BtcAmount -> BtcAmount

HasFee SatoshisPerByte

Methods

absoluteFee :: BtcAmount -> TxByteSize -> SatoshisPerByte -> BtcAmount

HasFee Constant

Methods

absoluteFee :: BtcAmount -> TxByteSize -> Constant -> BtcAmount

HasFee fee => HasFee (Capped fee)

Methods

absoluteFee :: BtcAmount -> TxByteSize -> Capped fee -> BtcAmount

(HasFee a, HasFee b) => HasFee (MaxFee a b)

Methods

absoluteFee :: BtcAmount -> TxByteSize -> MaxFee a b -> BtcAmount

newtype Constant

Constructors

Constant BtcAmount

Instances

Eq Constant

Methods

(==) :: Constant -> Constant -> Bool

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

Generic Constant

Associated Types

type Rep Constant :: * -> *

Methods

from :: Constant -> Rep Constant x

to :: Rep Constant x -> Constant

NFData Constant

Methods

rnf :: Constant -> ()

HasFee Constant

Methods

absoluteFee :: BtcAmount -> TxByteSize -> Constant -> BtcAmount

type Rep Constant

type Rep Constant = D1 (MetaData "Constant" "Bitcoin.Fee" "bitcoin-payment-channel-1.2.0.0-7YwDEKAOCp2BNoMt0JxEOM" True) (C1 (MetaCons "Constant" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BtcAmount)))

type TxByteSize = Word

newtype SatoshisPerByte

Specify a fee as satoshis per byte

Constructors

SatoshisPerByte BtcAmount

Fee in satoshis per byte

Instances

Enum SatoshisPerByte

Methods

succ :: SatoshisPerByte -> SatoshisPerByte

pred :: SatoshisPerByte -> SatoshisPerByte

toEnum :: Int -> SatoshisPerByte

fromEnum :: SatoshisPerByte -> Int

enumFrom :: SatoshisPerByte -> [SatoshisPerByte]

enumFromThen :: SatoshisPerByte -> SatoshisPerByte -> [SatoshisPerByte]

enumFromTo :: SatoshisPerByte -> SatoshisPerByte -> [SatoshisPerByte]

enumFromThenTo :: SatoshisPerByte -> SatoshisPerByte -> SatoshisPerByte -> [SatoshisPerByte]

Eq SatoshisPerByte

Methods

(==) :: SatoshisPerByte -> SatoshisPerByte -> Bool

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

Integral SatoshisPerByte

Methods

quot :: SatoshisPerByte -> SatoshisPerByte -> SatoshisPerByte

rem :: SatoshisPerByte -> SatoshisPerByte -> SatoshisPerByte

div :: SatoshisPerByte -> SatoshisPerByte -> SatoshisPerByte

mod :: SatoshisPerByte -> SatoshisPerByte -> SatoshisPerByte

quotRem :: SatoshisPerByte -> SatoshisPerByte -> (SatoshisPerByte, SatoshisPerByte)

divMod :: SatoshisPerByte -> SatoshisPerByte -> (SatoshisPerByte, SatoshisPerByte)

toInteger :: SatoshisPerByte -> Integer

Num SatoshisPerByte

Methods

(+) :: SatoshisPerByte -> SatoshisPerByte -> SatoshisPerByte

(-) :: SatoshisPerByte -> SatoshisPerByte -> SatoshisPerByte

(*) :: SatoshisPerByte -> SatoshisPerByte -> SatoshisPerByte

negate :: SatoshisPerByte -> SatoshisPerByte

abs :: SatoshisPerByte -> SatoshisPerByte

signum :: SatoshisPerByte -> SatoshisPerByte

fromInteger :: Integer -> SatoshisPerByte

Ord SatoshisPerByte

Methods

compare :: SatoshisPerByte -> SatoshisPerByte -> Ordering

(<) :: SatoshisPerByte -> SatoshisPerByte -> Bool

(<=) :: SatoshisPerByte -> SatoshisPerByte -> Bool

(>) :: SatoshisPerByte -> SatoshisPerByte -> Bool

(>=) :: SatoshisPerByte -> SatoshisPerByte -> Bool

max :: SatoshisPerByte -> SatoshisPerByte -> SatoshisPerByte

min :: SatoshisPerByte -> SatoshisPerByte -> SatoshisPerByte

Real SatoshisPerByte

Methods

toRational :: SatoshisPerByte -> Rational

Show SatoshisPerByte

Methods

showsPrec :: Int -> SatoshisPerByte -> ShowS

show :: SatoshisPerByte -> String

showList :: [SatoshisPerByte] -> ShowS

ToJSON SatoshisPerByte

Methods

toJSON :: SatoshisPerByte -> Value

toEncoding :: SatoshisPerByte -> Encoding

toJSONList :: [SatoshisPerByte] -> Value

toEncodingList :: [SatoshisPerByte] -> Encoding

FromJSON SatoshisPerByte

Methods

parseJSON :: Value -> Parser SatoshisPerByte

parseJSONList :: Value -> Parser [SatoshisPerByte]

Serialize SatoshisPerByte

Methods

put :: Putter SatoshisPerByte

get :: Get SatoshisPerByte

NFData SatoshisPerByte

Methods

rnf :: SatoshisPerByte -> ()

HasFee SatoshisPerByte

Methods

absoluteFee :: BtcAmount -> TxByteSize -> SatoshisPerByte -> BtcAmount

ToChangeOutFee SatoshisPerByte

Methods

mkChangeFee :: SatoshisPerByte -> TxFee

newtype MaxFee a b

A maximum fee of two fees. Whichever fee results in the largest absolute fee is chosen.

Constructors

MaxFee (a, b)

Instances

(Eq b, Eq a) => Eq (MaxFee a b)

Methods

(==) :: MaxFee a b -> MaxFee a b -> Bool

(/=) :: MaxFee a b -> MaxFee a b -> Bool

(Ord b, Ord a) => Ord (MaxFee a b)

Methods

compare :: MaxFee a b -> MaxFee a b -> Ordering

(<) :: MaxFee a b -> MaxFee a b -> Bool

(<=) :: MaxFee a b -> MaxFee a b -> Bool

(>) :: MaxFee a b -> MaxFee a b -> Bool

(>=) :: MaxFee a b -> MaxFee a b -> Bool

max :: MaxFee a b -> MaxFee a b -> MaxFee a b

min :: MaxFee a b -> MaxFee a b -> MaxFee a b

(Show b, Show a) => Show (MaxFee a b)

Methods

showsPrec :: Int -> MaxFee a b -> ShowS

show :: MaxFee a b -> String

showList :: [MaxFee a b] -> ShowS

(ToJSON b, ToJSON a) => ToJSON (MaxFee a b)

Methods

toJSON :: MaxFee a b -> Value

toEncoding :: MaxFee a b -> Encoding

toJSONList :: [MaxFee a b] -> Value

toEncodingList :: [MaxFee a b] -> Encoding

(FromJSON b, FromJSON a) => FromJSON (MaxFee a b)

Methods

parseJSON :: Value -> Parser (MaxFee a b)

parseJSONList :: Value -> Parser [MaxFee a b]

(Serialize b, Serialize a) => Serialize (MaxFee a b)

Methods

put :: Putter (MaxFee a b)

get :: Get (MaxFee a b)

(NFData b, NFData a) => NFData (MaxFee a b)

Methods

rnf :: MaxFee a b -> ()

(HasFee a, HasFee b) => HasFee (MaxFee a b)

Methods

absoluteFee :: BtcAmount -> TxByteSize -> MaxFee a b -> BtcAmount

newtype Capped val

At most the specified fee. Will not fail if the specified amount is more than is available.

Constructors

Capped val

Instances

HasFee fee => HasFee (Capped fee)

Methods

absoluteFee :: BtcAmount -> TxByteSize -> Capped fee -> BtcAmount

PaymentValueSpec (Capped BtcAmount)

Methods

paymentValue :: BtcAmount -> ServerSettings -> Capped BtcAmount -> BtcAmount

class PaymentValueSpec val where

Capped/non-capped amount-specifications (get value)

Minimal complete definition

paymentValue

Methods

paymentValue :: BtcAmount -> ServerSettings -> val -> BtcAmount

Instances

PaymentValueSpec BtcAmount

Methods

paymentValue :: BtcAmount -> ServerSettings -> BtcAmount -> BtcAmount

PaymentValueSpec (Capped BtcAmount)

Methods

paymentValue :: BtcAmount -> ServerSettings -> Capped BtcAmount -> BtcAmount

newtype Capped val

At most the specified fee. Will not fail if the specified amount is more than is available.

Constructors

Capped val

Instances

HasFee fee => HasFee (Capped fee)

Methods

absoluteFee :: BtcAmount -> TxByteSize -> Capped fee -> BtcAmount

PaymentValueSpec (Capped BtcAmount)

Methods

paymentValue :: BtcAmount -> ServerSettings -> Capped BtcAmount -> BtcAmount

Crypto

newtype SendPubKey

Wrapper for value sender's public key

Constructors

MkSendPubKey

Fields

• getSenderPK :: PubKeyC

Instances

Eq SendPubKey

Methods

(==) :: SendPubKey -> SendPubKey -> Bool

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

Show SendPubKey

Methods

showsPrec :: Int -> SendPubKey -> ShowS

show :: SendPubKey -> String

showList :: [SendPubKey] -> ShowS

Generic SendPubKey

Associated Types

type Rep SendPubKey :: * -> *

Methods

from :: SendPubKey -> Rep SendPubKey x

to :: Rep SendPubKey x -> SendPubKey

ToJSON SendPubKey

Methods

toJSON :: SendPubKey -> Value

toEncoding :: SendPubKey -> Encoding

toJSONList :: [SendPubKey] -> Value

toEncodingList :: [SendPubKey] -> Encoding

FromJSON SendPubKey

Methods

parseJSON :: Value -> Parser SendPubKey

parseJSONList :: Value -> Parser [SendPubKey]

Serialize SendPubKey

Methods

put :: Putter SendPubKey

get :: Get SendPubKey

NFData SendPubKey

Methods

rnf :: SendPubKey -> ()

IsPubKey SendPubKey

Methods

getPubKey :: SendPubKey -> PubKeyC

type Rep SendPubKey

type Rep SendPubKey = D1 (MetaData "SendPubKey" "PaymentChannel.Internal.Crypto.PubKey" "bitcoin-payment-channel-1.2.0.0-7YwDEKAOCp2BNoMt0JxEOM" True) (C1 (MetaCons "MkSendPubKey" PrefixI True) (S1 (MetaSel (Just Symbol "getSenderPK") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PubKeyC)))

newtype RecvPubKey

Wrapper for value receiver's public key

Constructors

MkRecvPubKey

Fields

• getReceiverPK :: PubKeyC

Instances

Eq RecvPubKey

Methods

(==) :: RecvPubKey -> RecvPubKey -> Bool

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

Show RecvPubKey

Methods

showsPrec :: Int -> RecvPubKey -> ShowS

show :: RecvPubKey -> String

showList :: [RecvPubKey] -> ShowS

Generic RecvPubKey

Associated Types

type Rep RecvPubKey :: * -> *

Methods

from :: RecvPubKey -> Rep RecvPubKey x

to :: Rep RecvPubKey x -> RecvPubKey

ToJSON RecvPubKey

Methods

toJSON :: RecvPubKey -> Value

toEncoding :: RecvPubKey -> Encoding

toJSONList :: [RecvPubKey] -> Value

toEncodingList :: [RecvPubKey] -> Encoding

FromJSON RecvPubKey

Methods

parseJSON :: Value -> Parser RecvPubKey

parseJSONList :: Value -> Parser [RecvPubKey]

Serialize RecvPubKey

Methods

put :: Putter RecvPubKey

get :: Get RecvPubKey

NFData RecvPubKey

Methods

rnf :: RecvPubKey -> ()

IsPubKey RecvPubKey

Methods

getPubKey :: RecvPubKey -> PubKeyC

type Rep RecvPubKey

type Rep RecvPubKey = D1 (MetaData "RecvPubKey" "PaymentChannel.Internal.Crypto.PubKey" "bitcoin-payment-channel-1.2.0.0-7YwDEKAOCp2BNoMt0JxEOM" True) (C1 (MetaCons "MkRecvPubKey" PrefixI True) (S1 (MetaSel (Just Symbol "getReceiverPK") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PubKeyC)))

class Serialize a => IsPubKey a where

Types which contain a pubkey

Minimal complete definition

getPubKey

Methods

getPubKey :: a -> PubKeyC

Instances

IsPubKey XPubKey

Methods

getPubKey :: XPubKey -> PubKeyC

IsPubKey PubKeyC

Methods

getPubKey :: PubKeyC -> PubKeyC

IsPubKey RecvPubKey

Methods

getPubKey :: RecvPubKey -> PubKeyC

IsPubKey SendPubKey

Methods

getPubKey :: SendPubKey -> PubKeyC

class HasSendPubKey a where

Types which contain a SendPubKey

Minimal complete definition

getSendPubKey

Methods

getSendPubKey :: a -> SendPubKey

Instances

HasSendPubKey ChanParams

Methods

getSendPubKey :: ChanParams -> SendPubKey

HasSendPubKey (ClientPayChanI a)

Methods

getSendPubKey :: ClientPayChanI a -> SendPubKey

HasSendPubKey (PayChanState a)

Methods

getSendPubKey :: PayChanState a -> SendPubKey

HasSendPubKey (ServerPayChanG kd sd)

Methods

getSendPubKey :: ServerPayChanG kd sd -> SendPubKey

class HasRecvPubKey a where

Minimal complete definition

getRecvPubKey

Methods

getRecvPubKey :: a -> RecvPubKey

Instances

HasRecvPubKey ChanParams

Methods

getRecvPubKey :: ChanParams -> RecvPubKey

HasRecvPubKey (ClientPayChanI a)

Methods

getRecvPubKey :: ClientPayChanI a -> RecvPubKey

HasRecvPubKey (PayChanState a)

Methods

getRecvPubKey :: PayChanState a -> RecvPubKey

HasRecvPubKey (ServerPayChanG kd sd)

Methods

getRecvPubKey :: ServerPayChanG kd sd -> RecvPubKey

Util

module Bitcoin.SpendCond.Util

fromDate :: UTCTime -> Maybe LockTimeDate

Convert a UTCTime to a LockTimeDate. Returns Nothing if the date is later than 2106-02-07 (or earlier than 1985-11-05).

getChanState :: HasSignedPayChanState a => a -> PayChanState BtcSig

clientChangeVal :: SigSinglePair t r a -> BtcAmount

toHaskoinTx :: SignatureScript r ss t => BtcTx t r ss -> Tx