Safe Haskell	None
Language	Haskell2010

Cardano.Wallet.Network.Light

Contents

Interface

Synopsis

data LightSyncSource m block addr txs = LightSyncSource {
- getHeader :: block -> BlockHeader
- getTip :: m BlockHeader
- getBlockHeaderAtHeight :: BlockHeight -> m ( Consensual BlockHeader )
- getNextBlockHeader :: BlockHeader -> m ( Consensual ( Maybe BlockHeader ))
- getBlockHeaderAt :: ChainPoint -> m ( Consensual BlockHeader )
- getNextBlocks :: ChainPoint -> m ( Consensual [block])
- getAddressTxs :: BlockHeader -> BlockHeader -> addr -> m txs
}
type LightBlocks m block addr txs = Either ( NonEmpty block) ( BlockSummary m addr txs)
hoistLightSyncSource :: ( forall a. m a -> n a) -> LightSyncSource m block addr txs -> LightSyncSource n block addr txs
lightSync :: MonadDelay m => Tracer m LightLayerLog -> LightSyncSource m block addr txs -> ChainFollower m ChainPoint BlockHeader ( LightBlocks m block addr txs) -> m Void
data Consensual a
- = NotConsensual
- | Consensual a
data LightLayerLog

Interface

data LightSyncSource m block addr txs Source #

Blockchain data source suitable for the implementation of lightSync .

Constructors

LightSyncSource

Fields

getHeader :: block -> BlockHeader

Get the BlockHeader of a given block .
getTip :: m BlockHeader

Latest tip of the chain.
getBlockHeaderAtHeight :: BlockHeight -> m ( Consensual BlockHeader )

Get the BlockHeader at a given block height.
getNextBlockHeader :: BlockHeader -> m ( Consensual ( Maybe BlockHeader ))

Get the next block header.
getBlockHeaderAt :: ChainPoint -> m ( Consensual BlockHeader )

Get the full BlockHeader belonging to a given ChainPoint . Return Nothing if the point is not consensus anymore.
getNextBlocks :: ChainPoint -> m ( Consensual [block])

Get several blocks immediately following the given Chainpoint .
getAddressTxs :: BlockHeader -> BlockHeader -> addr -> m txs

Transactions for a given address and point range.

type LightBlocks m block addr txs = Either ( NonEmpty block) ( BlockSummary m addr txs) Source #

hoistLightSyncSource :: ( forall a. m a -> n a) -> LightSyncSource m block addr txs -> LightSyncSource n block addr txs Source #

lightSync :: MonadDelay m => Tracer m LightLayerLog -> LightSyncSource m block addr txs -> ChainFollower m ChainPoint BlockHeader ( LightBlocks m block addr txs) -> m Void Source #

Drive a ChainFollower using a LightSyncSource . Never returns.

data Consensual a Source #

Consensual represents the result of query on the blockchain. Either the result is a value that is part of the consensus chain, or the result is an indication that the consensus had changed before the entire value could be retrieved.

Constructors

NotConsensual
Consensual a

Instances

Instances details

Functor Consensual Source #
Instance details Defined in Cardano.Wallet.Network.Light Methods fmap :: (a -> b) -> Consensual a -> Consensual b Source # (<$) :: a -> Consensual b -> Consensual a Source #
Foldable Consensual Source #
Instance details Defined in Cardano.Wallet.Network.Light Methods fold :: Monoid m => Consensual m -> m Source # foldMap :: Monoid m => (a -> m) -> Consensual a -> m Source # foldMap' :: Monoid m => (a -> m) -> Consensual a -> m Source # foldr :: (a -> b -> b) -> b -> Consensual a -> b Source # foldr' :: (a -> b -> b) -> b -> Consensual a -> b Source # foldl :: (b -> a -> b) -> b -> Consensual a -> b Source # foldl' :: (b -> a -> b) -> b -> Consensual a -> b Source # foldr1 :: (a -> a -> a) -> Consensual a -> a Source # foldl1 :: (a -> a -> a) -> Consensual a -> a Source # toList :: Consensual a -> [a] Source # null :: Consensual a -> Bool Source # length :: Consensual a -> Int Source # elem :: Eq a => a -> Consensual a -> Bool Source # maximum :: Ord a => Consensual a -> a Source # minimum :: Ord a => Consensual a -> a Source # sum :: Num a => Consensual a -> a Source # product :: Num a => Consensual a -> a Source #
Traversable Consensual Source #
Instance details Defined in Cardano.Wallet.Network.Light Methods traverse :: Applicative f => (a -> f b) -> Consensual a -> f ( Consensual b) Source # sequenceA :: Applicative f => Consensual (f a) -> f ( Consensual a) Source # mapM :: Monad m => (a -> m b) -> Consensual a -> m ( Consensual b) Source # sequence :: Monad m => Consensual (m a) -> m ( Consensual a) Source #
Eq a => Eq ( Consensual a) Source #
Instance details Defined in Cardano.Wallet.Network.Light Methods (==) :: Consensual a -> Consensual a -> Bool Source # (/=) :: Consensual a -> Consensual a -> Bool Source #
Show a => Show ( Consensual a) Source #
Instance details Defined in Cardano.Wallet.Network.Light Methods showsPrec :: Int -> Consensual a -> ShowS Source # show :: Consensual a -> String Source # showList :: [ Consensual a] -> ShowS Source #
Buildable a => Buildable ( Consensual a) Source #
Instance details Defined in Cardano.Wallet.Network.Light Methods build :: Consensual a -> Builder Source #

data LightLayerLog Source #

Constructors

MsgLightRollForward ChainPoint BlockHeader BlockHeader BlockHeader
MsgLightRolledForward BlockHeader
MsgLightRollBackward ChainPoint ChainPoint

Instances

Instances details

Eq LightLayerLog Source #
Instance details Defined in Cardano.Wallet.Network.Light Methods (==) :: LightLayerLog -> LightLayerLog -> Bool Source # (/=) :: LightLayerLog -> LightLayerLog -> Bool Source #
Show LightLayerLog Source #
Instance details Defined in Cardano.Wallet.Network.Light Methods showsPrec :: Int -> LightLayerLog -> ShowS Source # show :: LightLayerLog -> String Source # showList :: [ LightLayerLog ] -> ShowS Source #
Generic LightLayerLog Source #
Instance details Defined in Cardano.Wallet.Network.Light Associated Types type Rep LightLayerLog :: Type -> Type Source # Methods from :: LightLayerLog -> Rep LightLayerLog x Source # to :: Rep LightLayerLog x -> LightLayerLog Source #
ToText LightLayerLog Source #
Instance details Defined in Cardano.Wallet.Network.Light Methods toText :: LightLayerLog -> Text Source #
HasPrivacyAnnotation LightLayerLog Source #
Instance details Defined in Cardano.Wallet.Network.Light Methods getPrivacyAnnotation :: LightLayerLog -> PrivacyAnnotation
HasSeverityAnnotation LightLayerLog Source #
Instance details Defined in Cardano.Wallet.Network.Light Methods getSeverityAnnotation :: LightLayerLog -> Severity
type Rep LightLayerLog Source #
Instance details Defined in Cardano.Wallet.Network.Light type Rep LightLayerLog = D1 (' MetaData "LightLayerLog" "Cardano.Wallet.Network.Light" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "MsgLightRollForward" ' PrefixI ' False ) (( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ChainPoint ) :: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 BlockHeader )) :: ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 BlockHeader ) :: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 BlockHeader ))) :+: ( C1 (' MetaCons "MsgLightRolledForward" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 BlockHeader )) :+: C1 (' MetaCons "MsgLightRollBackward" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ChainPoint ) :: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ChainPoint ))))