Safe Haskell	None
Language	Haskell2010

Cardano.Api.Network

Synopsis

newtype Serialised (a :: k) = Serialised {
- unSerialised :: ByteString
}
data LedgerPeerSnapshot where
- LedgerPeerSnapshotV1 (WithOrigin SlotNo, [(AccPoolStake, (PoolStake, NonEmpty RelayAccessPoint))])
- pattern LedgerPeerSnapshot :: (WithOrigin SlotNo, [(AccPoolStake, (PoolStake, NonEmpty RelayAccessPoint))]) -> LedgerPeerSnapshot
data Target point
- = VolatileTip
- | SpecificPoint point
- | ImmutableTip
data SubmitResult reason
- = SubmitSuccess
- | SubmitFail reason

Documentation

newtype Serialised (a :: k) Source #

An already serialised value

When streaming blocks/header from disk to the network, there is often no need to deserialise them, as we'll just end up serialising them again when putting them on the wire.

Constructors

Serialised
Fields unSerialised :: ByteString

Instances

Instances details

DecodeDiskDepIx f blk => DecodeDisk blk (GenDepPair (Serialised :: Type -> Type) (f blk))
Instance details Defined in Ouroboros.Consensus.Storage.Serialisation Methods decodeDisk :: CodecConfig blk -> forall s. Decoder s (GenDepPair (Serialised :: Type -> Type) (f blk)) Source #
EncodeDiskDepIx f blk => EncodeDisk blk (GenDepPair (Serialised :: Type -> Type) (f blk))
Instance details Defined in Ouroboros.Consensus.Storage.Serialisation Methods encodeDisk :: CodecConfig blk -> GenDepPair (Serialised :: Type -> Type) (f blk) -> Encoding Source #
StandardHash block => StandardHash (Serialised block :: Type)
Instance details Defined in Ouroboros.Network.Block
ShowProxy a => ShowProxy (Serialised a :: Type)
Instance details Defined in Ouroboros.Network.Block Methods showProxy :: Proxy (Serialised a) -> String Source #
Show (Serialised a)
Instance details Defined in Ouroboros.Network.Block Methods showsPrec :: Int -> Serialised a -> ShowS Source # show :: Serialised a -> String Source # showList :: [Serialised a] -> ShowS Source #
Eq (Serialised a)
Instance details Defined in Ouroboros.Network.Block Methods (==) :: Serialised a -> Serialised a -> Bool Source # (/=) :: Serialised a -> Serialised a -> Bool Source #
Serialise (Serialised a)	CBOR-in-CBOR TODO: replace with encodeEmbeddedCBOR from cborg-0.2.4 once it is available, since that will be faster. TODO: Avoid converting to a strict ByteString, as that requires copying O(n) in case the lazy ByteString consists of more than one chunks.
Instance details Defined in Ouroboros.Network.Block Methods encode :: Serialised a -> Encoding decode :: Decoder s (Serialised a) encodeList :: [Serialised a] -> Encoding decodeList :: Decoder s [Serialised a]
type HeaderHash (Serialised block :: Type)
Instance details Defined in Ouroboros.Network.Block type HeaderHash (Serialised block :: Type) = HeaderHash block

data LedgerPeerSnapshot Source #

The type of big ledger peers that is serialised or later provided by node configuration for the networking layer to connect to when syncing.

Constructors

LedgerPeerSnapshotV1 (WithOrigin SlotNo, [(AccPoolStake, (PoolStake, NonEmpty RelayAccessPoint))])

Internal use for version 1, use pattern synonym for public API

Bundled Patterns

pattern LedgerPeerSnapshot :: (WithOrigin SlotNo, [(AccPoolStake, (PoolStake, NonEmpty RelayAccessPoint))]) -> LedgerPeerSnapshot

Public API to access snapshot data. Currently access to only most recent version is available. Nonetheless, serialisation from the node into JSON is supported for older versions via internal api so that newer CLI can still support older node formats.

Instances

Instances details

FromJSON LedgerPeerSnapshot
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods parseJSON :: Value -> Parser LedgerPeerSnapshot parseJSONList :: Value -> Parser [LedgerPeerSnapshot] omittedField :: Maybe LedgerPeerSnapshot
ToJSON LedgerPeerSnapshot
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods toJSON :: LedgerPeerSnapshot -> Value toEncoding :: LedgerPeerSnapshot -> Encoding toJSONList :: [LedgerPeerSnapshot] -> Value toEncodingList :: [LedgerPeerSnapshot] -> Encoding omitField :: LedgerPeerSnapshot -> Bool
Show LedgerPeerSnapshot
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods showsPrec :: Int -> LedgerPeerSnapshot -> ShowS Source # show :: LedgerPeerSnapshot -> String Source # showList :: [LedgerPeerSnapshot] -> ShowS Source #
FromCBOR LedgerPeerSnapshot
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods fromCBOR :: Decoder s LedgerPeerSnapshot Source # label :: Proxy LedgerPeerSnapshot -> Text Source #
ToCBOR LedgerPeerSnapshot
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods toCBOR :: LedgerPeerSnapshot -> Encoding Source # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy LedgerPeerSnapshot -> Size Source # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [LedgerPeerSnapshot] -> Size Source #
Eq LedgerPeerSnapshot
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (==) :: LedgerPeerSnapshot -> LedgerPeerSnapshot -> Bool Source # (/=) :: LedgerPeerSnapshot -> LedgerPeerSnapshot -> Bool Source #

data Target point Source #

Constructors

VolatileTip

The tip of the volatile chain

Cannot fail to be acquired.

SpecificPoint point

A specified point

Fails to be acquired if the point is not between VolatileTip and ImmutableTip (inclusive).

ImmutableTip

The tip of the immutable chain

Cannot fail to be acquired.

Requires at least NodeToClientV_16.

Instances

Instances details

Foldable Target

Instance details

Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type

Methods

fold :: Monoid m => Target m -> m Source #

foldMap :: Monoid m => (a -> m) -> Target a -> m Source #

foldMap' :: Monoid m => (a -> m) -> Target a -> m Source #

foldr :: (a -> b -> b) -> b -> Target a -> b Source #

foldr' :: (a -> b -> b) -> b -> Target a -> b Source #

foldl :: (b -> a -> b) -> b -> Target a -> b Source #

foldl' :: (b -> a -> b) -> b -> Target a -> b Source #

foldr1 :: (a -> a -> a) -> Target a -> a Source #

foldl1 :: (a -> a -> a) -> Target a -> a Source #

toList :: Target a -> [a] Source #

null :: Target a -> Bool Source #

length :: Target a -> Int Source #

elem :: Eq a => a -> Target a -> Bool Source #

maximum :: Ord a => Target a -> a Source #

minimum :: Ord a => Target a -> a Source #

sum :: Num a => Target a -> a Source #

product :: Num a => Target a -> a Source #

Traversable Target

Instance details

Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type

Methods

traverse :: Applicative f => (a -> f b) -> Target a -> f (Target b) Source #

sequenceA :: Applicative f => Target (f a) -> f (Target a) Source #

mapM :: Monad m => (a -> m b) -> Target a -> m (Target b) Source #

sequence :: Monad m => Target (m a) -> m (Target a) Source #

Functor Target

Instance details

Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type

Methods

fmap :: (a -> b) -> Target a -> Target b Source #

(<$) :: a -> Target b -> Target a Source #

Generic (Target point)

Instance details

Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type

Associated Types

type Rep (Target point)

Instance details

Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type

type Rep (Target point) = D1 ('MetaData "Target" "Ouroboros.Network.Protocol.LocalStateQuery.Type" "ouroboros-network-protocols-0.13.0.0-04b0dc50877c5554ceb48e37f58db7020bbe3a714835ecb357ef86341a189fca" 'False) (C1 ('MetaCons "VolatileTip" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "SpecificPoint" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 point)) :+: C1 ('MetaCons "ImmutableTip" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: Target point -> Rep (Target point) x Source #

to :: Rep (Target point) x -> Target point Source #

Show point => Show (Target point)

Instance details

Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type

Methods

showsPrec :: Int -> Target point -> ShowS Source #

show :: Target point -> String Source #

showList :: [Target point] -> ShowS Source #

NFData point => NFData (Target point)

Instance details

Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type

Methods

rnf :: Target point -> () Source #

Eq point => Eq (Target point)

Instance details

Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type

Methods

(==) :: Target point -> Target point -> Bool Source #

(/=) :: Target point -> Target point -> Bool Source #

Ord point => Ord (Target point)

Instance details

Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type

Methods

compare :: Target point -> Target point -> Ordering Source #

(<) :: Target point -> Target point -> Bool Source #

(<=) :: Target point -> Target point -> Bool Source #

(>) :: Target point -> Target point -> Bool Source #

(>=) :: Target point -> Target point -> Bool Source #

max :: Target point -> Target point -> Target point Source #

min :: Target point -> Target point -> Target point Source #

type Rep (Target point)

Instance details

Defined in Ouroboros.Network.Protocol.LocalStateQuery.Type

type Rep (Target point) = D1 ('MetaData "Target" "Ouroboros.Network.Protocol.LocalStateQuery.Type" "ouroboros-network-protocols-0.13.0.0-04b0dc50877c5554ceb48e37f58db7020bbe3a714835ecb357ef86341a189fca" 'False) (C1 ('MetaCons "VolatileTip" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "SpecificPoint" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 point)) :+: C1 ('MetaCons "ImmutableTip" 'PrefixI 'False) (U1 :: Type -> Type)))

data SubmitResult reason Source #

Isomorphic with Maybe but with a name that better describes its purpose and usage.

Constructors

SubmitSuccess
SubmitFail reason

Instances

Instances details

Functor SubmitResult
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type Methods fmap :: (a -> b) -> SubmitResult a -> SubmitResult b Source # (<$) :: a -> SubmitResult b -> SubmitResult a Source #
Eq reason => Eq (SubmitResult reason)
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type Methods (==) :: SubmitResult reason -> SubmitResult reason -> Bool Source # (/=) :: SubmitResult reason -> SubmitResult reason -> Bool Source #