Haskoin.Store

Documentation

data Store

Store mailboxes.

Constructors

Store

Fields

• storeManager :: !PeerManager
• storeChain :: !Chain
• storeBlock :: !BlockStore
• storeDB :: !DatabaseReader
• storeCache :: !(Maybe CacheConfig)
• storePublisher :: !(Publisher StoreEvent)
• storeNetwork :: !Network

data StoreConfig

Configuration for a Store.

Constructors

StoreConfig

Fields

• storeConfMaxPeers :: !Int

  max peers to connect to

• storeConfInitPeers :: ![HostPort]

  static set of peers to connect to

• storeConfDiscover :: !Bool

  discover new peers

• storeConfDB :: !FilePath

  RocksDB database path

• storeConfNetwork :: !Network

  network constants

• storeConfCache :: !(Maybe String)

  Redis cache configuration

• storeConfInitialGap :: !Word32

  gap on extended public key with no transactions

• storeConfGap :: !Word32

  gap for extended public keys

• storeConfCacheMin :: !Int

  cache xpubs with more than this many used addresses

• storeConfMaxKeys :: !Integer

  maximum number of keys in Redis cache

• storeConfNoMempool :: !Bool

  do not index new mempool transactions

• storeConfWipeMempool :: !Bool

  wipe mempool when starting

• storeConfPeerTimeout :: !NominalDiffTime

  disconnect peer if message not received for this many seconds

• storeConfPeerMaxLife :: !NominalDiffTime

  disconnect peer if it has been connected this long

• storeConfConnect :: !(SockAddr -> WithConnection)

  connect to peers using the function withConnection

• storeConfCacheRefresh :: !Int

  refresh the cache this often (milliseconds)

data StoreEvent

Events that the store can generate.

Constructors

StoreBestBlock !BlockHash

StoreMempoolNew !TxHash

StorePeerConnected !Peer

StorePeerDisconnected !Peer

StorePeerPong !Peer !Word64

StoreTxAvailable !Peer ![TxHash]

StoreTxReject !Peer !TxHash !RejectCode !ByteString

block no longer head of main chain

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.Data

Cache

data CacheConfig

Constructors

CacheConfig

Fields

• cacheConn :: !Connection
• cacheMin :: !Int
• cacheMax :: !Integer
• cacheChain :: !Chain
• cacheRefresh :: !Int

Instances

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

Defined in Haskoin.Store.Cache

Methods

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

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

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

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

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

xPubBals :: XPubSpec -> CacheT m [XPubBal]

xPubSummary :: XPubSpec -> CacheT m XPubSummary

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

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

getMaxGap :: CacheT m Word32

getInitialGap :: CacheT m Word32

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

Defined in Haskoin.Store.Cache

Methods

getNetwork :: CacheT m Network

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

type CacheT = ReaderT (Maybe CacheConfig)

data CacheError

Constructors

RedisError Reply

RedisTxError !String

LogicError !String

Instances

Eq CacheError

Defined in Haskoin.Store.Cache

Methods

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

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

Show CacheError

Defined in Haskoin.Store.Cache

Methods

showsPrec :: Int -> CacheError -> ShowS

show :: CacheError -> String

showList :: [CacheError] -> ShowS

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

Exception CacheError

Defined in Haskoin.Store.Cache

Methods

toException :: CacheError -> SomeException

fromException :: SomeException -> Maybe CacheError

displayException :: CacheError -> String

NFData CacheError

Defined in Haskoin.Store.Cache

Methods

rnf :: CacheError -> ()

type Rep CacheError

Defined in Haskoin.Store.Cache

type Rep CacheError = D1 ('MetaData "CacheError" "Haskoin.Store.Cache" "haskoin-store-0.39.0-HOQtbkTEWACHcvuoLEQIiq" '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

evictFromCache :: (MonadUnliftIO m, MonadLoggerIO m, StoreReadBase m) => [XPubSpec] -> CacheT m ()

Store Reader

class Monad m => StoreReadBase m where

Methods

getNetwork :: m Network

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

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

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

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

(MonadUnliftIO m, MonadLoggerIO m) => StoreReadBase (ReaderT WebConfig m)

Defined in Haskoin.Store.Web

Methods

getNetwork :: ReaderT WebConfig m Network

getBestBlock :: ReaderT WebConfig m (Maybe BlockHash)

getBlocksAtHeight :: BlockHeight -> ReaderT WebConfig m [BlockHash]

getBlock :: BlockHash -> ReaderT WebConfig m (Maybe BlockData)

getTxData :: TxHash -> ReaderT WebConfig m (Maybe TxData)

getSpender :: OutPoint -> ReaderT WebConfig m (Maybe Spender)

getBalance :: Address -> ReaderT WebConfig m (Maybe Balance)

getUnspent :: OutPoint -> ReaderT WebConfig m (Maybe Unspent)

getMempool :: ReaderT WebConfig m [(UnixTime, TxHash)]

class StoreReadBase m => StoreReadExtra m where

Minimal complete definition

getAddressesTxs, getAddressesUnspents, getMaxGap, getInitialGap

Methods

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

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

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

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

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

xPubBals :: XPubSpec -> m [XPubBal]

xPubSummary :: XPubSpec -> m XPubSummary

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

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

getMaxGap :: m Word32

getInitialGap :: m Word32

Instances

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

Defined in Haskoin.Store.Cache

Methods

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

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

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

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

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

xPubBals :: XPubSpec -> CacheT m [XPubBal]

xPubSummary :: XPubSpec -> CacheT m XPubSummary

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

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

getMaxGap :: CacheT m Word32

getInitialGap :: CacheT m Word32

MonadIO m => StoreReadExtra (DatabaseReaderT m)

Defined in Haskoin.Store.Database.Reader

Methods

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

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

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

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

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

xPubBals :: XPubSpec -> DatabaseReaderT m [XPubBal]

xPubSummary :: XPubSpec -> DatabaseReaderT m XPubSummary

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

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

getMaxGap :: DatabaseReaderT m Word32

getInitialGap :: DatabaseReaderT m Word32

(MonadUnliftIO m, MonadLoggerIO m) => StoreReadExtra (ReaderT WebConfig m)

Defined in Haskoin.Store.Web

Methods

getBalances :: [Address] -> ReaderT WebConfig m [Balance]

getAddressesTxs :: [Address] -> Limits -> ReaderT WebConfig m [TxRef]

getAddressTxs :: Address -> Limits -> ReaderT WebConfig m [TxRef]

getAddressUnspents :: Address -> Limits -> ReaderT WebConfig m [Unspent]

getAddressesUnspents :: [Address] -> Limits -> ReaderT WebConfig m [Unspent]

xPubBals :: XPubSpec -> ReaderT WebConfig m [XPubBal]

xPubSummary :: XPubSpec -> ReaderT WebConfig m XPubSummary

xPubUnspents :: XPubSpec -> Limits -> ReaderT WebConfig m [XPubUnspent]

xPubTxs :: XPubSpec -> Limits -> ReaderT WebConfig m [TxRef]

getMaxGap :: ReaderT WebConfig m Word32

getInitialGap :: ReaderT WebConfig m Word32

data Limits

Constructors

Limits

Fields

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

Instances

Eq Limits

Defined in Haskoin.Store.Common

Methods

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

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

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

data Start

Constructors

AtTx

Fields

• atTxHash :: !TxHash

AtBlock

Fields

• atBlockHeight :: !BlockHeight

Instances

Eq Start

Defined in Haskoin.Store.Common

Methods

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

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

Show Start

Defined in Haskoin.Store.Common

Methods

showsPrec :: Int -> Start -> ShowS

show :: Start -> String

showList :: [Start] -> ShowS

Useful Fuctions

getTransaction :: (Monad m, StoreReadBase m) => TxHash -> m (Maybe Transaction)

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

getSpenders :: StoreReadBase m => TxHash -> m (IntMap Spender)

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

Eq PubExcept

Defined in Haskoin.Store.Common

Methods

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

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

Show PubExcept

Defined in Haskoin.Store.Common

Methods

showsPrec :: Int -> PubExcept -> ShowS

show :: PubExcept -> String

showList :: [PubExcept] -> ShowS

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

Exception PubExcept

Defined in Haskoin.Store.Common

Methods

toException :: PubExcept -> SomeException

fromException :: SomeException -> Maybe PubExcept

displayException :: PubExcept -> String

Serialize PubExcept

Defined in Haskoin.Store.Common

Methods

put :: Putter PubExcept

get :: Get PubExcept

NFData PubExcept

Defined in Haskoin.Store.Common

Methods

rnf :: PubExcept -> ()

type Rep PubExcept

Defined in Haskoin.Store.Common

type Rep PubExcept = D1 ('MetaData "PubExcept" "Haskoin.Store.Common" "haskoin-store-0.39.0-HOQtbkTEWACHcvuoLEQIiq" '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)))