Haskoin.Store

Documentation

data Store

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

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

• peerTimeout :: !NominalDiffTime

  disconnect peer if message not received for this many seconds

• maxPeerLife :: !NominalDiffTime

  disconnect peer if it has been connected this long

• connect :: !(SockAddr -> WithConnection)

  connect to peers using the function withConnection

• statsStore :: !(Maybe Store)

  stats store

• redisSyncInterval :: !Int

  sync mempool against cache every this many seconds

data StoreEvent

Events that the store can generate.

Constructors

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

Cache

data CacheConfig

Constructors

CacheConfig

Fields

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

Instances

(MonadUnliftIO m, MonadLoggerIO m, StoreReadBase m) => StoreReadBase (CacheT m)

Defined in Haskoin.Store.Cache

Methods

getNetwork :: CacheT m Network

getCtx :: CacheT m Ctx

getBestBlock :: CacheT m (Maybe BlockHash)

getBlocksAtHeight :: BlockHeight -> CacheT m [BlockHash]

getBlock :: BlockHash -> CacheT m (Maybe BlockData)

getTxData :: TxHash -> CacheT m (Maybe TxData)

getSpender :: OutPoint -> CacheT m (Maybe Spender)

getBalance :: Address -> CacheT m (Maybe Balance)

getUnspent :: OutPoint -> CacheT m (Maybe Unspent)

getMempool :: CacheT m [(UnixTime, TxHash)]

(MonadUnliftIO m, MonadLoggerIO m, StoreReadExtra m) => StoreReadExtra (CacheT m)

Defined in Haskoin.Store.Cache

Methods

getAddressesTxs :: [Address] -> Limits -> CacheT m [TxRef]

getAddressesUnspents :: [Address] -> Limits -> CacheT m [Unspent]

getInitialGap :: CacheT m Word32

getMaxGap :: CacheT m Word32

getNumTxData :: Word64 -> CacheT m [TxData]

getBalances :: [Address] -> CacheT m [Balance]

getAddressTxs :: Address -> Limits -> CacheT m [TxRef]

getAddressUnspents :: Address -> Limits -> CacheT m [Unspent]

xPubBals :: XPubSpec -> CacheT m [XPubBal]

xPubUnspents :: XPubSpec -> [XPubBal] -> Limits -> CacheT m [XPubUnspent]

xPubTxs :: XPubSpec -> [XPubBal] -> Limits -> CacheT m [TxRef]

xPubTxCount :: XPubSpec -> [XPubBal] -> CacheT m Word32

type CacheT = ReaderT (Maybe CacheConfig)

data CacheError

Constructors

RedisError Reply

RedisTxError !String

LogicError !String

Instances

Exception CacheError

Defined in Haskoin.Store.Cache

Methods

toException :: CacheError -> SomeException

fromException :: SomeException -> Maybe CacheError

displayException :: CacheError -> String

Generic CacheError

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

Defined in Haskoin.Store.Cache

Methods

showsPrec :: Int -> CacheError -> ShowS

show :: CacheError -> String

showList :: [CacheError] -> ShowS

NFData CacheError

Defined in Haskoin.Store.Cache

Methods

rnf :: CacheError -> ()

Eq CacheError

Defined in Haskoin.Store.Cache

Methods

(==) :: CacheError -> CacheError -> Bool

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

type Rep CacheError

Defined in Haskoin.Store.Cache

type Rep CacheError = D1 ('MetaData "CacheError" "Haskoin.Store.Cache" "haskoin-store-1.0.0-inplace" '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 :: StoreReadBase m => Maybe CacheConfig -> CacheT m a -> m a

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

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

Store Reader

class Monad m => StoreReadBase m where

Methods

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)]

Instances

(MonadUnliftIO m, MonadLoggerIO m, StoreReadBase m) => StoreReadBase (CacheT m)

Defined in Haskoin.Store.Cache

Methods

getNetwork :: CacheT m Network

getCtx :: CacheT m Ctx

getBestBlock :: CacheT m (Maybe BlockHash)

getBlocksAtHeight :: BlockHeight -> CacheT m [BlockHash]

getBlock :: BlockHash -> CacheT m (Maybe BlockData)

getTxData :: TxHash -> CacheT m (Maybe TxData)

getSpender :: OutPoint -> CacheT m (Maybe Spender)

getBalance :: Address -> CacheT m (Maybe Balance)

getUnspent :: OutPoint -> CacheT m (Maybe Unspent)

getMempool :: CacheT m [(UnixTime, TxHash)]

MonadIO m => StoreReadBase (DatabaseReaderT m)

Defined in Haskoin.Store.Database.Reader

Methods

getNetwork :: DatabaseReaderT m Network

getCtx :: DatabaseReaderT m Ctx

getBestBlock :: DatabaseReaderT m (Maybe BlockHash)

getBlocksAtHeight :: BlockHeight -> DatabaseReaderT m [BlockHash]

getBlock :: BlockHash -> DatabaseReaderT m (Maybe BlockData)

getTxData :: TxHash -> DatabaseReaderT m (Maybe TxData)

getSpender :: OutPoint -> DatabaseReaderT m (Maybe Spender)

getBalance :: Address -> DatabaseReaderT m (Maybe Balance)

getUnspent :: OutPoint -> DatabaseReaderT m (Maybe Unspent)

getMempool :: DatabaseReaderT m [(UnixTime, TxHash)]

MonadIO m => StoreReadBase (WriterT m)

Defined in Haskoin.Store.Database.Writer

Methods

getNetwork :: WriterT m Network

getCtx :: WriterT m Ctx

getBestBlock :: WriterT m (Maybe BlockHash)

getBlocksAtHeight :: BlockHeight -> WriterT m [BlockHash]

getBlock :: BlockHash -> WriterT m (Maybe BlockData)

getTxData :: TxHash -> WriterT m (Maybe TxData)

getSpender :: OutPoint -> WriterT m (Maybe Spender)

getBalance :: Address -> WriterT m (Maybe Balance)

getUnspent :: OutPoint -> WriterT m (Maybe Unspent)

getMempool :: WriterT m [(UnixTime, TxHash)]

class StoreReadBase m => StoreReadExtra m where

Methods

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

Instances

(MonadUnliftIO m, MonadLoggerIO m, StoreReadExtra m) => StoreReadExtra (CacheT m)

Defined in Haskoin.Store.Cache

Methods

getAddressesTxs :: [Address] -> Limits -> CacheT m [TxRef]

getAddressesUnspents :: [Address] -> Limits -> CacheT m [Unspent]

getInitialGap :: CacheT m Word32

getMaxGap :: CacheT m Word32

getNumTxData :: Word64 -> CacheT m [TxData]

getBalances :: [Address] -> CacheT m [Balance]

getAddressTxs :: Address -> Limits -> CacheT m [TxRef]

getAddressUnspents :: Address -> Limits -> CacheT m [Unspent]

xPubBals :: XPubSpec -> CacheT m [XPubBal]

xPubUnspents :: XPubSpec -> [XPubBal] -> Limits -> CacheT m [XPubUnspent]

xPubTxs :: XPubSpec -> [XPubBal] -> Limits -> CacheT m [TxRef]

xPubTxCount :: XPubSpec -> [XPubBal] -> CacheT m Word32

MonadUnliftIO m => StoreReadExtra (DatabaseReaderT m)

Defined in Haskoin.Store.Database.Reader

Methods

getAddressesTxs :: [Address] -> Limits -> DatabaseReaderT m [TxRef]

getAddressesUnspents :: [Address] -> Limits -> DatabaseReaderT m [Unspent]

getInitialGap :: DatabaseReaderT m Word32

getMaxGap :: DatabaseReaderT m Word32

getNumTxData :: Word64 -> DatabaseReaderT m [TxData]

getBalances :: [Address] -> DatabaseReaderT m [Balance]

getAddressTxs :: Address -> Limits -> DatabaseReaderT m [TxRef]

getAddressUnspents :: Address -> Limits -> DatabaseReaderT m [Unspent]

xPubBals :: XPubSpec -> DatabaseReaderT m [XPubBal]

xPubUnspents :: XPubSpec -> [XPubBal] -> Limits -> DatabaseReaderT m [XPubUnspent]

xPubTxs :: XPubSpec -> [XPubBal] -> Limits -> DatabaseReaderT m [TxRef]

xPubTxCount :: XPubSpec -> [XPubBal] -> DatabaseReaderT m Word32

data Limits

Constructors

Limits

Fields

• limit :: !Word32
• offset :: !Word32
• start :: !(Maybe Start)

Instances

Show Limits

Defined in Haskoin.Store.Common

Methods

showsPrec :: Int -> Limits -> ShowS

show :: Limits -> String

showList :: [Limits] -> ShowS

Default Limits

Defined in Haskoin.Store.Common

Methods

def :: Limits

Eq Limits

Defined in Haskoin.Store.Common

Methods

(==) :: Limits -> Limits -> Bool

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

data Start

Constructors

AtTx

Fields

• atTxHash :: !TxHash

AtBlock

Fields

• atBlockHeight :: !BlockHeight

Instances

Show Start

Defined in Haskoin.Store.Common

Methods

showsPrec :: Int -> Start -> ShowS

show :: Start -> String

showList :: [Start] -> ShowS

Eq Start

Defined in Haskoin.Store.Common

Methods

(==) :: Start -> Start -> Bool

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

Useful Fuctions

getTransaction :: (Monad m, 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)

Other Data

data PubExcept

Constructors

PubNoPeers

PubReject RejectCode

PubTimeout

PubPeerDisconnected

Instances

Exception PubExcept

Defined in Haskoin.Store.Common

Methods

toException :: PubExcept -> SomeException

fromException :: SomeException -> Maybe PubExcept

displayException :: PubExcept -> String

Generic PubExcept

Defined in Haskoin.Store.Common

Associated Types

type Rep PubExcept :: Type -> Type

Methods

from :: PubExcept -> Rep PubExcept x

to :: Rep PubExcept x -> PubExcept

Show PubExcept

Defined in Haskoin.Store.Common

Methods

showsPrec :: Int -> PubExcept -> ShowS

show :: PubExcept -> String

showList :: [PubExcept] -> ShowS

Serialize PubExcept

Defined in Haskoin.Store.Common

Methods

put :: Putter PubExcept

get :: Get PubExcept

NFData PubExcept

Defined in Haskoin.Store.Common

Methods

rnf :: PubExcept -> ()

Eq PubExcept

Defined in Haskoin.Store.Common

Methods

(==) :: PubExcept -> PubExcept -> Bool

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

type Rep PubExcept

Defined in Haskoin.Store.Common

type Rep PubExcept = D1 ('MetaData "PubExcept" "Haskoin.Store.Common" "haskoin-store-1.0.0-inplace" 'False) ((C1 ('MetaCons "PubNoPeers" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PubReject" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RejectCode))) :+: (C1 ('MetaCons "PubTimeout" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PubPeerDisconnected" 'PrefixI 'False) (U1 :: Type -> Type)))