Safe Haskell	Safe-Inferred
Language	Haskell2010

Haskoin.Store

Contents

Cache
Store Reader
Useful Fuctions

Synopsis

data Store = Store {
- peerMgr :: !PeerMgr
- chain :: !Chain
- block :: !BlockStore
- db :: !DatabaseReader
- cache :: !(Maybe CacheConfig)
- pub :: !(Publisher StoreEvent)
- net :: !Network
- ctx :: !Ctx
}
data StoreConfig = StoreConfig {
- maxPeers :: !Int
- initPeers :: ![String]
- discover :: !Bool
- db :: !FilePath
- net :: !Network
- redis :: !(Maybe String)
- ctx :: !Ctx
- initGap :: !Word32
- gap :: !Word32
- redisMinAddrs :: !Int
- redisMaxKeys :: !Integer
- noMempool :: !Bool
- wipeMempool :: !Bool
- syncMempool :: !Bool
- mempoolTimeout :: !Int
- peerTimeout :: !NominalDiffTime
- maxPeerLife :: !NominalDiffTime
- connect :: !(SockAddr -> WithConnection)
- stats :: !(Maybe Stats)
- redisSyncInterval :: !Int
- bloom :: !Bool
}
data StoreEvent
- = StoreBestBlock !BlockHash
- | StoreMempoolNew !TxHash
- | StoreMempoolDelete !TxHash
- | StorePeerConnected !Peer
- | StorePeerDisconnected !Peer
- | StorePeerPong !Peer !Word64
- | StoreTxAnnounce !Peer ![TxHash]
- | StoreTxReject !Peer !TxHash !RejectCode !ByteString
withStore :: (MonadLoggerIO m, MonadUnliftIO m) => StoreConfig -> (Store -> m a) -> m a
module Haskoin.Store.BlockStore
module Haskoin.Store.Web
module Haskoin.Store.Database.Reader
module Haskoin.Store.Database.Types
module Haskoin.Store.Data
data CacheConfig = CacheConfig {
- redis :: !Connection
- minAddrs :: !Int
- maxKeys :: !Integer
- chain :: !Chain
- metrics :: !(Maybe CacheMetrics)
}
type CacheT = ReaderT (Maybe CacheConfig)
data CacheError
- = RedisError Reply
- | RedisTxError !String
- | LogicError !String
withCache :: Maybe CacheConfig -> CacheT m a -> m a
connectRedis :: MonadIO m => String -> m Connection
isInCache :: MonadLoggerIO m => XPubSpec -> CacheT m Bool
class Monad m => StoreReadBase m where
- getNetwork :: m Network
- getCtx :: m Ctx
- getBestBlock :: m (Maybe BlockHash)
- getBlocksAtHeight :: BlockHeight -> m [BlockHash]
- getBlock :: BlockHash -> m (Maybe BlockData)
- getTxData :: TxHash -> m (Maybe TxData)
- getSpender :: OutPoint -> m (Maybe Spender)
- getBalance :: Address -> m (Maybe Balance)
- getUnspent :: OutPoint -> m (Maybe Unspent)
- getMempool :: m [(UnixTime, TxHash)]
class StoreReadBase m => StoreReadExtra m where
- getAddressesTxs :: [Address] -> Limits -> m [TxRef]
- getAddressesUnspents :: [Address] -> Limits -> m [Unspent]
- getInitialGap :: m Word32
- getMaxGap :: m Word32
- getNumTxData :: Word64 -> m [TxData]
- getBalances :: [Address] -> m [Balance]
- getAddressTxs :: Address -> Limits -> m [TxRef]
- getAddressUnspents :: Address -> Limits -> m [Unspent]
- xPubBals :: XPubSpec -> m [XPubBal]
- xPubUnspents :: XPubSpec -> [XPubBal] -> Limits -> m [XPubUnspent]
- xPubTxs :: XPubSpec -> [XPubBal] -> Limits -> m [TxRef]
- xPubTxCount :: XPubSpec -> [XPubBal] -> m Word32
data Limits = Limits {
- limit :: !Word32
- offset :: !Word32
- start :: !(Maybe Start)
}
data Start
- = AtTx !TxHash
- | AtBlock !BlockHeight
getTransaction :: StoreReadBase m => TxHash -> m (Maybe Transaction)
getDefaultBalance :: StoreReadBase m => Address -> m Balance
getActiveTxData :: StoreReadBase m => TxHash -> m (Maybe TxData)
blockAtOrBefore :: (MonadIO m, StoreReadExtra m) => Chain -> UnixTime -> m (Maybe BlockData)

Documentation

data Store Source #

Store mailboxes.

Constructors

Store
Fields peerMgr :: !PeerMgr chain :: !Chain block :: !BlockStore db :: !DatabaseReader cache :: !(Maybe CacheConfig) pub :: !(Publisher StoreEvent) net :: !Network ctx :: !Ctx

data StoreConfig Source #

Configuration for a Store.

Constructors

StoreConfig

Fields

maxPeers :: !Int
max peers to connect to
initPeers :: ![String]
static set of peers to connect to
discover :: !Bool
discover new peers
db :: !FilePath
RocksDB database path
net :: !Network
network constants
redis :: !(Maybe String)
Redis cache configuration
ctx :: !Ctx
Secp256k1 context
initGap :: !Word32
gap on extended public key with no transactions
gap :: !Word32
gap for extended public keys
redisMinAddrs :: !Int
cache xpubs with more than this many used addresses
redisMaxKeys :: !Integer
maximum number of keys in Redis cache
noMempool :: !Bool
do not index new mempool transactions
wipeMempool :: !Bool
wipe mempool when starting
syncMempool :: !Bool
sync mempool from peers
mempoolTimeout :: !Int
disconnect peer if message not received for this many seconds
peerTimeout :: !NominalDiffTime
delete mempool transactions older than this number of days
maxPeerLife :: !NominalDiffTime
disconnect peer if it has been connected this long
connect :: !(SockAddr -> WithConnection)
connect to peers using the function withConnection
stats :: !(Maybe Stats)
StatsD
redisSyncInterval :: !Int
sync mempool against cache every this many seconds
bloom :: !Bool
database Bloom filters

data StoreEvent Source #

Events that the store can generate.

withStore :: (MonadLoggerIO m, MonadUnliftIO m) => StoreConfig -> (Store -> m a) -> m a Source #

module Haskoin.Store.BlockStore

module Haskoin.Store.Web

module Haskoin.Store.Database.Reader

module Haskoin.Store.Database.Types

module Haskoin.Store.Data

Cache

data CacheConfig Source #

Constructors

CacheConfig
Fields redis :: !Connection minAddrs :: !Int maxKeys :: !Integer chain :: !Chain metrics :: !(Maybe CacheMetrics)

Instances

Instances details

StoreReadBase m => StoreReadBase (CacheT m) Source #
Instance details Defined in Haskoin.Store.Cache Methods getNetwork :: CacheT m Network Source # getCtx :: CacheT m Ctx Source # getBestBlock :: CacheT m (Maybe BlockHash) Source # getBlocksAtHeight :: BlockHeight -> CacheT m [BlockHash] Source # getBlock :: BlockHash -> CacheT m (Maybe BlockData) Source # getTxData :: TxHash -> CacheT m (Maybe TxData) Source # getSpender :: OutPoint -> CacheT m (Maybe Spender) Source # getBalance :: Address -> CacheT m (Maybe Balance) Source # getUnspent :: OutPoint -> CacheT m (Maybe Unspent) Source # getMempool :: CacheT m [(UnixTime, TxHash)] Source #
(MonadUnliftIO m, MonadLoggerIO m, StoreReadExtra m) => StoreReadExtra (CacheT m) Source #
Instance details Defined in Haskoin.Store.Cache Methods getAddressesTxs :: [Address] -> Limits -> CacheT m [TxRef] Source # getAddressesUnspents :: [Address] -> Limits -> CacheT m [Unspent] Source # getInitialGap :: CacheT m Word32 Source # getMaxGap :: CacheT m Word32 Source # getNumTxData :: Word64 -> CacheT m [TxData] Source # getBalances :: [Address] -> CacheT m [Balance] Source # getAddressTxs :: Address -> Limits -> CacheT m [TxRef] Source # getAddressUnspents :: Address -> Limits -> CacheT m [Unspent] Source # xPubBals :: XPubSpec -> CacheT m [XPubBal] Source # xPubUnspents :: XPubSpec -> [XPubBal] -> Limits -> CacheT m [XPubUnspent] Source # xPubTxs :: XPubSpec -> [XPubBal] -> Limits -> CacheT m [TxRef] Source # xPubTxCount :: XPubSpec -> [XPubBal] -> CacheT m Word32 Source #

type CacheT = ReaderT (Maybe CacheConfig) Source #

data CacheError Source #

Constructors

RedisError Reply
RedisTxError !String
LogicError !String

Instances

Instances details

Exception CacheError Source #
Instance details Defined in Haskoin.Store.Cache Methods toException :: CacheError -> SomeException # fromException :: SomeException -> Maybe CacheError # displayException :: CacheError -> String #
Generic CacheError Source #
Instance details Defined in Haskoin.Store.Cache Associated Types type Rep CacheError :: Type -> Type # Methods from :: CacheError -> Rep CacheError x # to :: Rep CacheError x -> CacheError #
Show CacheError Source #
Instance details Defined in Haskoin.Store.Cache Methods showsPrec :: Int -> CacheError -> ShowS # show :: CacheError -> String # showList :: [CacheError] -> ShowS #
NFData CacheError Source #
Instance details Defined in Haskoin.Store.Cache Methods rnf :: CacheError -> () #
Eq CacheError Source #
Instance details Defined in Haskoin.Store.Cache Methods (==) :: CacheError -> CacheError -> Bool # (/=) :: CacheError -> CacheError -> Bool #
type Rep CacheError Source #
Instance details Defined in Haskoin.Store.Cache type Rep CacheError = D1 ('MetaData "CacheError" "Haskoin.Store.Cache" "haskoin-store-1.5.14-FajwE6bbLJ1FVgw1ZfEXwb" 'False) (C1 ('MetaCons "RedisError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Reply)) :+: (C1 ('MetaCons "RedisTxError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 String)) :+: C1 ('MetaCons "LogicError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 String))))

withCache :: Maybe CacheConfig -> CacheT m a -> m a Source #

connectRedis :: MonadIO m => String -> m Connection Source #

isInCache :: MonadLoggerIO m => XPubSpec -> CacheT m Bool Source #

Store Reader

class Monad m => StoreReadBase m where Source #

Methods

getNetwork :: m Network Source #

getCtx :: m Ctx Source #

getBestBlock :: m (Maybe BlockHash) Source #

getBlocksAtHeight :: BlockHeight -> m [BlockHash] Source #

getBlock :: BlockHash -> m (Maybe BlockData) Source #

getTxData :: TxHash -> m (Maybe TxData) Source #

getSpender :: OutPoint -> m (Maybe Spender) Source #

getBalance :: Address -> m (Maybe Balance) Source #

getUnspent :: OutPoint -> m (Maybe Unspent) Source #

getMempool :: m [(UnixTime, TxHash)] Source #

Instances

Instances details

StoreReadBase m => StoreReadBase (CacheT m) Source #
Instance details Defined in Haskoin.Store.Cache Methods getNetwork :: CacheT m Network Source # getCtx :: CacheT m Ctx Source # getBestBlock :: CacheT m (Maybe BlockHash) Source # getBlocksAtHeight :: BlockHeight -> CacheT m [BlockHash] Source # getBlock :: BlockHash -> CacheT m (Maybe BlockData) Source # getTxData :: TxHash -> CacheT m (Maybe TxData) Source # getSpender :: OutPoint -> CacheT m (Maybe Spender) Source # getBalance :: Address -> CacheT m (Maybe Balance) Source # getUnspent :: OutPoint -> CacheT m (Maybe Unspent) Source # getMempool :: CacheT m [(UnixTime, TxHash)] Source #
MonadIO m => StoreReadBase (DatabaseReaderT m) Source #
Instance details Defined in Haskoin.Store.Database.Reader Methods getNetwork :: DatabaseReaderT m Network Source # getCtx :: DatabaseReaderT m Ctx Source # getBestBlock :: DatabaseReaderT m (Maybe BlockHash) Source # getBlocksAtHeight :: BlockHeight -> DatabaseReaderT m [BlockHash] Source # getBlock :: BlockHash -> DatabaseReaderT m (Maybe BlockData) Source # getTxData :: TxHash -> DatabaseReaderT m (Maybe TxData) Source # getSpender :: OutPoint -> DatabaseReaderT m (Maybe Spender) Source # getBalance :: Address -> DatabaseReaderT m (Maybe Balance) Source # getUnspent :: OutPoint -> DatabaseReaderT m (Maybe Unspent) Source # getMempool :: DatabaseReaderT m [(UnixTime, TxHash)] Source #
MonadIO m => StoreReadBase (WriterT m) Source #
Instance details Defined in Haskoin.Store.Database.Writer Methods getNetwork :: WriterT m Network Source # getCtx :: WriterT m Ctx Source # getBestBlock :: WriterT m (Maybe BlockHash) Source # getBlocksAtHeight :: BlockHeight -> WriterT m [BlockHash] Source # getBlock :: BlockHash -> WriterT m (Maybe BlockData) Source # getTxData :: TxHash -> WriterT m (Maybe TxData) Source # getSpender :: OutPoint -> WriterT m (Maybe Spender) Source # getBalance :: Address -> WriterT m (Maybe Balance) Source # getUnspent :: OutPoint -> WriterT m (Maybe Unspent) Source # getMempool :: WriterT m [(UnixTime, TxHash)] Source #

class StoreReadBase m => StoreReadExtra m where Source #

Methods

getAddressesTxs :: [Address] -> Limits -> m [TxRef] Source #

getAddressesUnspents :: [Address] -> Limits -> m [Unspent] Source #

getInitialGap :: m Word32 Source #

getMaxGap :: m Word32 Source #

getNumTxData :: Word64 -> m [TxData] Source #

getBalances :: [Address] -> m [Balance] Source #

getAddressTxs :: Address -> Limits -> m [TxRef] Source #

getAddressUnspents :: Address -> Limits -> m [Unspent] Source #

xPubBals :: XPubSpec -> m [XPubBal] Source #

xPubUnspents :: XPubSpec -> [XPubBal] -> Limits -> m [XPubUnspent] Source #

xPubTxs :: XPubSpec -> [XPubBal] -> Limits -> m [TxRef] Source #

xPubTxCount :: XPubSpec -> [XPubBal] -> m Word32 Source #

Instances

Instances details

(MonadUnliftIO m, MonadLoggerIO m, StoreReadExtra m) => StoreReadExtra (CacheT m) Source #
Instance details Defined in Haskoin.Store.Cache Methods getAddressesTxs :: [Address] -> Limits -> CacheT m [TxRef] Source # getAddressesUnspents :: [Address] -> Limits -> CacheT m [Unspent] Source # getInitialGap :: CacheT m Word32 Source # getMaxGap :: CacheT m Word32 Source # getNumTxData :: Word64 -> CacheT m [TxData] Source # getBalances :: [Address] -> CacheT m [Balance] Source # getAddressTxs :: Address -> Limits -> CacheT m [TxRef] Source # getAddressUnspents :: Address -> Limits -> CacheT m [Unspent] Source # xPubBals :: XPubSpec -> CacheT m [XPubBal] Source # xPubUnspents :: XPubSpec -> [XPubBal] -> Limits -> CacheT m [XPubUnspent] Source # xPubTxs :: XPubSpec -> [XPubBal] -> Limits -> CacheT m [TxRef] Source # xPubTxCount :: XPubSpec -> [XPubBal] -> CacheT m Word32 Source #
MonadUnliftIO m => StoreReadExtra (DatabaseReaderT m) Source #
Instance details Defined in Haskoin.Store.Database.Reader Methods getAddressesTxs :: [Address] -> Limits -> DatabaseReaderT m [TxRef] Source # getAddressesUnspents :: [Address] -> Limits -> DatabaseReaderT m [Unspent] Source # getInitialGap :: DatabaseReaderT m Word32 Source # getMaxGap :: DatabaseReaderT m Word32 Source # getNumTxData :: Word64 -> DatabaseReaderT m [TxData] Source # getBalances :: [Address] -> DatabaseReaderT m [Balance] Source # getAddressTxs :: Address -> Limits -> DatabaseReaderT m [TxRef] Source # getAddressUnspents :: Address -> Limits -> DatabaseReaderT m [Unspent] Source # xPubBals :: XPubSpec -> DatabaseReaderT m [XPubBal] Source # xPubUnspents :: XPubSpec -> [XPubBal] -> Limits -> DatabaseReaderT m [XPubUnspent] Source # xPubTxs :: XPubSpec -> [XPubBal] -> Limits -> DatabaseReaderT m [TxRef] Source # xPubTxCount :: XPubSpec -> [XPubBal] -> DatabaseReaderT m Word32 Source #

data Limits Source #

Constructors

Limits
Fields limit :: !Word32 offset :: !Word32 start :: !(Maybe Start)

Instances

Instances details

Show Limits Source #
Instance details Defined in Haskoin.Store.Common Methods showsPrec :: Int -> Limits -> ShowS # show :: Limits -> String # showList :: [Limits] -> ShowS #
Default Limits Source #
Instance details Defined in Haskoin.Store.Common Methods def :: Limits #
Eq Limits Source #
Instance details Defined in Haskoin.Store.Common Methods (==) :: Limits -> Limits -> Bool # (/=) :: Limits -> Limits -> Bool #

data Start Source #

Constructors

AtTx !TxHash
AtBlock !BlockHeight

Instances

Instances details

Show Start Source #
Instance details Defined in Haskoin.Store.Common Methods showsPrec :: Int -> Start -> ShowS # show :: Start -> String # showList :: [Start] -> ShowS #
Eq Start Source #
Instance details Defined in Haskoin.Store.Common Methods (==) :: Start -> Start -> Bool # (/=) :: Start -> Start -> Bool #

Useful Fuctions

getTransaction :: StoreReadBase m => TxHash -> m (Maybe Transaction) Source #

getDefaultBalance :: StoreReadBase m => Address -> m Balance Source #

getActiveTxData :: StoreReadBase m => TxHash -> m (Maybe TxData) Source #

blockAtOrBefore :: (MonadIO m, StoreReadExtra m) => Chain -> UnixTime -> m (Maybe BlockData) Source #

Key	Shortcut
s	Open this search box
esc	Close this search box
↓,ctrl + j	Move down in search results
↑,ctrl + k	Move up in search results
↵	Go to active search result

StoreBestBlock !BlockHash
StoreMempoolNew !TxHash
StoreMempoolDelete !TxHash
StorePeerConnected !Peer
StorePeerDisconnected !Peer
StorePeerPong !Peer !Word64
StoreTxAnnounce !Peer ![TxHash]
StoreTxReject !Peer !TxHash !RejectCode !ByteString