bitcoin-payment-channel-1.0.0.0: src/PaymentChannel/Types.hs

{-|
Module      : PaymentChannel.Types
Copyright   : (c) Rune K. Svendsen, 2016
License     : PublicDomain
Maintainer  : runesvend@gmail.com

Types used with the interface provided by "PaymentChannel".

-}

{-# LANGUAGE RecordWildCards, TypeSynonymInstances, FlexibleInstances #-}

module PaymentChannel.Types
(
    -- *Shared sender/receiver types/functions
    FundingTxInfo(..)
  , ChanParams(..)
  , PaymentChannel(..), PayChan
  , PaymentChannelRecv(..)
--   , getChannelFunding
--   , getExpirationDate
--   , getFundingAmount
--   , getPaymentCount
  , fundingAddress
  , clientChangeAddress
  , availableChannelVal
--   , getNewestPayment
--   , getNewestSig
--   , senderChangeValue
--   , channelValueLeft
--   , chanIsExhausted
--   , expiresBefore
--   , getChannelState

    -- *Sender state
  , ClientPayChanI(..)

    -- *Receiver state
  , ServerPayChan, ServerPayChanI(rpcMetadata)
  , PayChanStatus(..)
  , S.getChannelStatus, S.setChannelStatus
  , S.markAsBusy, S.isReadyForPayment

    -- *Receiver state (with pubkey metadata)
  , ServerPayChanX
  , S.mkExtendedKeyRPC, S.metaKeyIndex

    -- *Payment
  , Payment
--   , paySignature,payClientChange
--   , FullPayment(..)
    -- **Error
  , PayChanError(..)

    -- *Bitcoin
  , BtcAmount
  , BtcLockTime(..)
  , module Bitcoin.Fee

    -- *Crypto
  , SendPubKey(..),RecvPubKey(..),IsPubKey(..),HasSendPubKey(..),HasRecvPubKey(..)

    -- *Util
  , fromDate
  , getChanState
--  , usesBlockHeight, dummyPayment

    -- *Config settings
  , getSettlePeriod, getDustLimit

)
where

import PaymentChannel.Internal.Types
import PaymentChannel.Internal.Receiver.Types
import PaymentChannel.Internal.Metadata.Util
import PaymentChannel.Internal.Serialization ()
import PaymentChannel.Internal.Class.Value     (HasValue(..))

import qualified PaymentChannel.Internal.Receiver.Util as S
import qualified PaymentChannel.Internal.ChanScript as Script
import PaymentChannel.Internal.Error (PayChanError(..))
import Bitcoin.Fee

import qualified  Network.Haskoin.Crypto as HC
import qualified  Network.Haskoin.Transaction as HT
import            Data.Word (Word64)


-- |Both sender and receiver state objects have a 'PaymentChannelState'
class HasPayChanState a where
    getPayChanState :: a -> PayChanState BtcSig

-- getChannelFunding :: HasPayChanState a => a -> HT.OutPoint
-- getChannelFunding = S.pcsFundingSource . getPayChanState
--
-- getExpirationDate :: HasPayChanState a => a -> BtcLockTime
-- getExpirationDate = S.pcsExpirationDate . getPayChanState
--
-- getFundingAmount  :: HasPayChanState a => a -> BtcAmount
-- getFundingAmount = S.pcsFundingValue . getPayChanState

-- getPaymentCount :: HasPayChanState a => a -> Word64
-- getPaymentCount = pcsPayCount . getPayChanState

fundingAddress :: HasPayChanState a => a -> HC.Address
fundingAddress = Script.getP2SHFundingAddress . pairRedeemScript . pcsPayment . getPayChanState

-- getNewestPayment :: HasPayChanState a => a -> Payment
-- getNewestPayment pcs = S.pcsGetPayment (getPayChanState pcs)

-- getNewestSig  :: HasPayChanState a => a -> HC.Signature
-- getNewestSig = bsSig . paySignature . getNewestPayment

-- senderChangeValue :: HasPayChanState a => a -> BtcAmount
-- senderChangeValue = pcsClientChangeVal . getPayChanState

clientChangeAddress :: HasPayChanState a => a -> HC.Address
clientChangeAddress = clientChangeAddr . pcsPayment . getPayChanState

-- | Channel value left to send (subtracts dust limit from total available amount)
availableChannelVal :: HasPayChanState a => a -> BtcAmount
availableChannelVal a = clientChangeVal (pcsPayment $ getPayChanState a) - configDustLimit

-- -- |Returns 'True' if all available channel value has been transferred, 'False' otherwise
-- chanIsExhausted  :: HasPayChanState a => a -> Bool
-- chanIsExhausted = S.channelIsExhausted . getPayChanState

-- -- |Return True if channel expires earlier than given expiration date
-- expiresBefore :: HasPayChanState a => BtcLockTime -> a -> Bool
-- expiresBefore expDate chan = getExpirationDate chan < expDate

-- | Legacy
getChanState :: HasPayChanState a => a -> PayChanState BtcSig
getChanState = getPayChanState

instance HasPayChanState ClientPayChan where
    getPayChanState = spcState

instance HasPayChanState (ServerPayChanI s) where
    getPayChanState = rpcState


-- |Get various information about an open payment channel.
class HasPayChanState a => PaymentChannel a where
    -- |Get amount received by receiver/left for sender
    valueToMe :: a -> BtcAmount
    -- |For internal use
    _setChannelState :: a -> PayChanState BtcSig -> a

-- clientChangeVal

instance PaymentChannel ClientPayChan where
    valueToMe = clientChangeVal . pcsPayment . spcState
    _setChannelState spc s = spc { spcState = s }

instance PaymentChannel (ServerPayChanI s) where
    valueToMe (MkServerPayChan s _) = valueOf s
    _setChannelState rpc s = rpc { rpcState = s }


-- |Payment channel state objects with metadata information
class PaymentChannel a => PaymentChannelRecv a where
    -- |Get total amount (both settled and unsettled) sent by client
    clientTotalValueSent :: a -> BtcAmount

instance PaymentChannelRecv (ServerPayChanI (MetadataI a)) where
    clientTotalValueSent = metaTotalValXfer . rpcMetadata



-- |Short-hand
class PaymentChannel a => PayChan a