Safe Haskell | None |
---|---|
Language | Haskell2010 |
Synopsis
- data ApiConfig = ApiConfig {
- configNetwork :: !Network
- configHost :: !String
- apiCall :: (ApiResource a b, MonadIO m, MonadError Except m) => ApiConfig -> a -> m b
- apiBatch :: (Batchable a b, MonadIO m, MonadError Except m) => Natural -> ApiConfig -> a -> m b
- data GetBlock = GetBlock !BlockHash !NoTx
- data GetBlocks = GetBlocks ![BlockHash] !NoTx
- newtype GetBlockRaw = GetBlockRaw BlockHash
- newtype GetBlockBest = GetBlockBest NoTx
- data GetBlockBestRaw = GetBlockBestRaw
- newtype GetBlockLatest = GetBlockLatest NoTx
- data GetBlockHeight = GetBlockHeight !HeightParam !NoTx
- data GetBlockHeights = GetBlockHeights !HeightsParam !NoTx
- newtype GetBlockHeightRaw = GetBlockHeightRaw HeightParam
- data GetBlockTime = GetBlockTime !TimeParam !NoTx
- newtype GetBlockTimeRaw = GetBlockTimeRaw TimeParam
- newtype GetTx = GetTx TxHash
- newtype GetTxs = GetTxs [TxHash]
- newtype GetTxRaw = GetTxRaw TxHash
- newtype GetTxsRaw = GetTxsRaw [TxHash]
- newtype GetTxsBlock = GetTxsBlock BlockHash
- newtype GetTxsBlockRaw = GetTxsBlockRaw BlockHash
- data GetTxAfter = GetTxAfter !TxHash !HeightParam
- newtype PostTx = PostTx Tx
- data GetMempool = GetMempool !(Maybe LimitParam) !OffsetParam
- data GetEvents = GetEvents
- data GetAddrTxs = GetAddrTxs !Address !LimitsParam
- data GetAddrsTxs = GetAddrsTxs ![Address] !LimitsParam
- data GetAddrTxsFull = GetAddrTxsFull !Address !LimitsParam
- data GetAddrsTxsFull = GetAddrsTxsFull ![Address] !LimitsParam
- newtype GetAddrBalance = GetAddrBalance Address
- newtype GetAddrsBalance = GetAddrsBalance [Address]
- data GetAddrUnspent = GetAddrUnspent !Address !LimitsParam
- data GetAddrsUnspent = GetAddrsUnspent ![Address] !LimitsParam
- data GetXPub = GetXPub !XPubKey !DeriveType !NoCache
- data GetXPubTxs = GetXPubTxs !XPubKey !DeriveType !LimitsParam !NoCache
- data GetXPubTxsFull = GetXPubTxsFull !XPubKey !DeriveType !LimitsParam !NoCache
- data GetXPubBalances = GetXPubBalances !XPubKey !DeriveType !NoCache
- data GetXPubUnspent = GetXPubUnspent !XPubKey !DeriveType !LimitsParam !NoCache
- data DelCachedXPub = DelCachedXPub !XPubKey !DeriveType
- data GetPeers = GetPeers
- data GetHealth = GetHealth
- data StartParam
- = StartParamHash { }
- | StartParamHeight { }
- | StartParamTime { }
- newtype OffsetParam = OffsetParam {}
- newtype LimitParam = LimitParam {}
- data LimitsParam = LimitsParam {}
- newtype HeightParam = HeightParam {}
- newtype HeightsParam = HeightsParam {
- getHeightsParam :: [Natural]
- data DeriveType
- newtype NoCache = NoCache {
- getNoCache :: Bool
- newtype NoTx = NoTx {}
Documentation
Configuration specifying the Network and the Host for API calls. Default instance:
ApiConfig { configNetwork = bch , configHost = "https://api.haskoin.com/" }
ApiConfig | |
|
apiCall :: (ApiResource a b, MonadIO m, MonadError Except m) => ApiConfig -> a -> m b Source #
Make a call to the haskoin-store API.
Usage (default options):
apiCall def $ GetAddrsTxs addrs def
With options:
apiCall def $ GetAddrsUnspent addrs def{ paramLimit = Just 10 }
apiBatch :: (Batchable a b, MonadIO m, MonadError Except m) => Natural -> ApiConfig -> a -> m b Source #
Batch commands that have a large list of arguments:
apiBatch 20 def (GetAddrsTxs addrs def)
Instances
ApiResource GetBlock BlockData Source # | |
Defined in Haskoin.Store.WebCommon |
Instances
ApiResource GetBlocks (SerialList BlockData) Source # | |
Defined in Haskoin.Store.WebCommon |
newtype GetBlockRaw Source #
Instances
ApiResource GetBlockRaw (RawResult Block) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetBlockRaw -> StdMethod Source # resourcePath :: Proxy GetBlockRaw -> [Text] -> Text Source # queryParams :: GetBlockRaw -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetBlockRaw -> [ProxyBox] Source # resourceBody :: GetBlockRaw -> Maybe PostBox Source # |
newtype GetBlockBest Source #
Instances
ApiResource GetBlockBest BlockData Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetBlockBest -> StdMethod Source # resourcePath :: Proxy GetBlockBest -> [Text] -> Text Source # queryParams :: GetBlockBest -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetBlockBest -> [ProxyBox] Source # resourceBody :: GetBlockBest -> Maybe PostBox Source # |
data GetBlockBestRaw Source #
Instances
ApiResource GetBlockBestRaw (RawResult Block) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetBlockBestRaw -> StdMethod Source # resourcePath :: Proxy GetBlockBestRaw -> [Text] -> Text Source # queryParams :: GetBlockBestRaw -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetBlockBestRaw -> [ProxyBox] Source # |
newtype GetBlockLatest Source #
Instances
ApiResource GetBlockLatest (SerialList BlockData) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetBlockLatest -> StdMethod Source # resourcePath :: Proxy GetBlockLatest -> [Text] -> Text Source # queryParams :: GetBlockLatest -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetBlockLatest -> [ProxyBox] Source # |
data GetBlockHeight Source #
Instances
ApiResource GetBlockHeight (SerialList BlockData) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetBlockHeight -> StdMethod Source # resourcePath :: Proxy GetBlockHeight -> [Text] -> Text Source # queryParams :: GetBlockHeight -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetBlockHeight -> [ProxyBox] Source # |
data GetBlockHeights Source #
Instances
ApiResource GetBlockHeights (SerialList BlockData) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetBlockHeights -> StdMethod Source # resourcePath :: Proxy GetBlockHeights -> [Text] -> Text Source # queryParams :: GetBlockHeights -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetBlockHeights -> [ProxyBox] Source # |
newtype GetBlockHeightRaw Source #
Instances
ApiResource GetBlockHeightRaw (RawResultList Block) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetBlockHeightRaw -> StdMethod Source # resourcePath :: Proxy GetBlockHeightRaw -> [Text] -> Text Source # queryParams :: GetBlockHeightRaw -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetBlockHeightRaw -> [ProxyBox] Source # |
data GetBlockTime Source #
Instances
ApiResource GetBlockTime BlockData Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetBlockTime -> StdMethod Source # resourcePath :: Proxy GetBlockTime -> [Text] -> Text Source # queryParams :: GetBlockTime -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetBlockTime -> [ProxyBox] Source # resourceBody :: GetBlockTime -> Maybe PostBox Source # |
newtype GetBlockTimeRaw Source #
Instances
ApiResource GetBlockTimeRaw (RawResult Block) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetBlockTimeRaw -> StdMethod Source # resourcePath :: Proxy GetBlockTimeRaw -> [Text] -> Text Source # queryParams :: GetBlockTimeRaw -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetBlockTimeRaw -> [ProxyBox] Source # |
Instances
Instances
ApiResource GetTxs (SerialList Transaction) Source # | |
Defined in Haskoin.Store.WebCommon |
Instances
ApiResource GetTxRaw (RawResult Tx) Source # | |
Defined in Haskoin.Store.WebCommon |
Instances
ApiResource GetTxsRaw (RawResultList Tx) Source # | |
Defined in Haskoin.Store.WebCommon |
newtype GetTxsBlock Source #
Instances
ApiResource GetTxsBlock (SerialList Transaction) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetTxsBlock -> StdMethod Source # resourcePath :: Proxy GetTxsBlock -> [Text] -> Text Source # queryParams :: GetTxsBlock -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetTxsBlock -> [ProxyBox] Source # resourceBody :: GetTxsBlock -> Maybe PostBox Source # |
newtype GetTxsBlockRaw Source #
Instances
ApiResource GetTxsBlockRaw (RawResultList Tx) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetTxsBlockRaw -> StdMethod Source # resourcePath :: Proxy GetTxsBlockRaw -> [Text] -> Text Source # queryParams :: GetTxsBlockRaw -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetTxsBlockRaw -> [ProxyBox] Source # |
data GetTxAfter Source #
Instances
ApiResource GetTxAfter (GenericResult (Maybe Bool)) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetTxAfter -> StdMethod Source # resourcePath :: Proxy GetTxAfter -> [Text] -> Text Source # queryParams :: GetTxAfter -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetTxAfter -> [ProxyBox] Source # resourceBody :: GetTxAfter -> Maybe PostBox Source # |
Instances
ApiResource PostTx TxId Source # | |
Defined in Haskoin.Store.WebCommon |
data GetMempool Source #
Instances
ApiResource GetMempool (SerialList TxHash) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetMempool -> StdMethod Source # resourcePath :: Proxy GetMempool -> [Text] -> Text Source # queryParams :: GetMempool -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetMempool -> [ProxyBox] Source # resourceBody :: GetMempool -> Maybe PostBox Source # |
Instances
ApiResource GetEvents (SerialList Event) Source # | |
Defined in Haskoin.Store.WebCommon |
data GetAddrTxs Source #
Instances
ApiResource GetAddrTxs (SerialList TxRef) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetAddrTxs -> StdMethod Source # resourcePath :: Proxy GetAddrTxs -> [Text] -> Text Source # queryParams :: GetAddrTxs -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetAddrTxs -> [ProxyBox] Source # resourceBody :: GetAddrTxs -> Maybe PostBox Source # |
data GetAddrsTxs Source #
Instances
ApiResource GetAddrsTxs (SerialList TxRef) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetAddrsTxs -> StdMethod Source # resourcePath :: Proxy GetAddrsTxs -> [Text] -> Text Source # queryParams :: GetAddrsTxs -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetAddrsTxs -> [ProxyBox] Source # resourceBody :: GetAddrsTxs -> Maybe PostBox Source # |
data GetAddrTxsFull Source #
Instances
ApiResource GetAddrTxsFull (SerialList Transaction) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetAddrTxsFull -> StdMethod Source # resourcePath :: Proxy GetAddrTxsFull -> [Text] -> Text Source # queryParams :: GetAddrTxsFull -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetAddrTxsFull -> [ProxyBox] Source # |
data GetAddrsTxsFull Source #
Instances
ApiResource GetAddrsTxsFull (SerialList Transaction) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetAddrsTxsFull -> StdMethod Source # resourcePath :: Proxy GetAddrsTxsFull -> [Text] -> Text Source # queryParams :: GetAddrsTxsFull -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetAddrsTxsFull -> [ProxyBox] Source # |
newtype GetAddrBalance Source #
Instances
ApiResource GetAddrBalance Balance Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetAddrBalance -> StdMethod Source # resourcePath :: Proxy GetAddrBalance -> [Text] -> Text Source # queryParams :: GetAddrBalance -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetAddrBalance -> [ProxyBox] Source # |
newtype GetAddrsBalance Source #
Instances
ApiResource GetAddrsBalance (SerialList Balance) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetAddrsBalance -> StdMethod Source # resourcePath :: Proxy GetAddrsBalance -> [Text] -> Text Source # queryParams :: GetAddrsBalance -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetAddrsBalance -> [ProxyBox] Source # |
data GetAddrUnspent Source #
Instances
ApiResource GetAddrUnspent (SerialList Unspent) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetAddrUnspent -> StdMethod Source # resourcePath :: Proxy GetAddrUnspent -> [Text] -> Text Source # queryParams :: GetAddrUnspent -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetAddrUnspent -> [ProxyBox] Source # |
data GetAddrsUnspent Source #
Instances
ApiResource GetAddrsUnspent (SerialList Unspent) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetAddrsUnspent -> StdMethod Source # resourcePath :: Proxy GetAddrsUnspent -> [Text] -> Text Source # queryParams :: GetAddrsUnspent -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetAddrsUnspent -> [ProxyBox] Source # |
Instances
ApiResource GetXPub XPubSummary Source # | |
Defined in Haskoin.Store.WebCommon |
data GetXPubTxs Source #
Instances
ApiResource GetXPubTxs (SerialList TxRef) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetXPubTxs -> StdMethod Source # resourcePath :: Proxy GetXPubTxs -> [Text] -> Text Source # queryParams :: GetXPubTxs -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetXPubTxs -> [ProxyBox] Source # resourceBody :: GetXPubTxs -> Maybe PostBox Source # |
data GetXPubTxsFull Source #
Instances
ApiResource GetXPubTxsFull (SerialList Transaction) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetXPubTxsFull -> StdMethod Source # resourcePath :: Proxy GetXPubTxsFull -> [Text] -> Text Source # queryParams :: GetXPubTxsFull -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetXPubTxsFull -> [ProxyBox] Source # |
data GetXPubBalances Source #
Instances
ApiResource GetXPubBalances (SerialList XPubBal) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetXPubBalances -> StdMethod Source # resourcePath :: Proxy GetXPubBalances -> [Text] -> Text Source # queryParams :: GetXPubBalances -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetXPubBalances -> [ProxyBox] Source # |
data GetXPubUnspent Source #
Instances
ApiResource GetXPubUnspent (SerialList XPubUnspent) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy GetXPubUnspent -> StdMethod Source # resourcePath :: Proxy GetXPubUnspent -> [Text] -> Text Source # queryParams :: GetXPubUnspent -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy GetXPubUnspent -> [ProxyBox] Source # |
data DelCachedXPub Source #
Instances
ApiResource DelCachedXPub (GenericResult Bool) Source # | |
Defined in Haskoin.Store.WebCommon resourceMethod :: Proxy DelCachedXPub -> StdMethod Source # resourcePath :: Proxy DelCachedXPub -> [Text] -> Text Source # queryParams :: DelCachedXPub -> ([ParamBox], [ParamBox]) Source # captureParams :: Proxy DelCachedXPub -> [ProxyBox] Source # resourceBody :: DelCachedXPub -> Maybe PostBox Source # |
Instances
ApiResource GetPeers (SerialList PeerInformation) Source # | |
Defined in Haskoin.Store.WebCommon |
Instances
ApiResource GetHealth HealthCheck Source # | |
Defined in Haskoin.Store.WebCommon |
data StartParam Source #
Instances
Eq StartParam Source # | |
Defined in Haskoin.Store.WebCommon (==) :: StartParam -> StartParam -> Bool # (/=) :: StartParam -> StartParam -> Bool # | |
Show StartParam Source # | |
Defined in Haskoin.Store.WebCommon showsPrec :: Int -> StartParam -> ShowS # show :: StartParam -> String # showList :: [StartParam] -> ShowS # | |
Param StartParam Source # | |
Defined in Haskoin.Store.WebCommon proxyLabel :: Proxy StartParam -> Text Source # encodeParam :: Network -> StartParam -> Maybe [Text] Source # parseParam :: Network -> [Text] -> Maybe StartParam Source # |
newtype OffsetParam Source #
Instances
newtype LimitParam Source #
Instances
data LimitsParam Source #
Instances
Eq LimitsParam Source # | |
Defined in Haskoin.Store.WebCommon (==) :: LimitsParam -> LimitsParam -> Bool # (/=) :: LimitsParam -> LimitsParam -> Bool # | |
Show LimitsParam Source # | |
Defined in Haskoin.Store.WebCommon showsPrec :: Int -> LimitsParam -> ShowS # show :: LimitsParam -> String # showList :: [LimitsParam] -> ShowS # | |
Default LimitsParam Source # | |
Defined in Haskoin.Store.WebCommon def :: LimitsParam # |
newtype HeightParam Source #
Instances
newtype HeightsParam Source #
Instances
Eq HeightsParam Source # | |
Defined in Haskoin.Store.WebCommon (==) :: HeightsParam -> HeightsParam -> Bool # (/=) :: HeightsParam -> HeightsParam -> Bool # | |
Read HeightsParam Source # | |
Defined in Haskoin.Store.WebCommon readsPrec :: Int -> ReadS HeightsParam # readList :: ReadS [HeightsParam] # | |
Show HeightsParam Source # | |
Defined in Haskoin.Store.WebCommon showsPrec :: Int -> HeightsParam -> ShowS # show :: HeightsParam -> String # showList :: [HeightsParam] -> ShowS # | |
Param HeightsParam Source # | |
Defined in Haskoin.Store.WebCommon proxyLabel :: Proxy HeightsParam -> Text Source # encodeParam :: Network -> HeightsParam -> Maybe [Text] Source # parseParam :: Network -> [Text] -> Maybe HeightsParam Source # |
data DeriveType Source #