Safe Haskell	None
Language	Haskell2010

Cardano.Api.Network

Contents

Network types
network reexports
Internal conversion functions

Synopsis

data NetworkId
- = Mainnet
- | Testnet !NetworkMagic
newtype NetworkMagic = NetworkMagic {
- unNetworkMagic :: Word32
}
fromNetworkMagic :: NetworkMagic -> NetworkId
toNetworkMagic :: NetworkId -> NetworkMagic
mainnetNetworkMagic :: NetworkMagic
data LedgerPeerSnapshot (a :: LedgerPeersKind) where
- LedgerPeerSnapshotV2 :: (WithOrigin SlotNo, [(AccPoolStake, (PoolStake, NonEmpty LedgerRelayAccessPoint))]) -> LedgerPeerSnapshot 'BigLedgerPeers
- LedgerBigPeerSnapshotV23 :: !(Point RawBlockHash) -> !NetworkMagic -> ![(AccPoolStake, (PoolStake, NonEmpty LedgerRelayAccessPoint))] -> LedgerPeerSnapshot 'BigLedgerPeers
- LedgerAllPeerSnapshotV23 :: !(Point RawBlockHash) -> !NetworkMagic -> ![(PoolStake, NonEmpty LedgerRelayAccessPoint)] -> LedgerPeerSnapshot 'AllLedgerPeers
data SomeLedgerPeerSnapshot = SomeLedgerPeerSnapshot !(LedgerPeerSnapshot k)
data LedgerPeersKind
- = AllLedgerPeers
- | BigLedgerPeers
data SingLedgerPeersKind (k :: LedgerPeersKind) where
- SingAllLedgerPeers :: SingLedgerPeersKind 'AllLedgerPeers
- SingBigLedgerPeers :: SingLedgerPeersKind 'BigLedgerPeers
data Target point
- = VolatileTip
- | SpecificPoint point
- | ImmutableTip
newtype Serialised (a :: k) = Serialised {
- unSerialised :: ByteString
}
data SubmitResult reason
- = SubmitSuccess
- | SubmitFail reason
toByronProtocolMagicId :: NetworkId -> ProtocolMagicId
toByronNetworkMagic :: NetworkId -> NetworkMagic
toByronRequiresNetworkMagic :: NetworkId -> RequiresNetworkMagic
toShelleyNetwork :: NetworkId -> Network
fromShelleyNetwork :: Network -> NetworkMagic -> NetworkId

Network types

data NetworkId Source #

Constructors

Mainnet
Testnet !NetworkMagic

Instances

Instances details

Eq NetworkId Source #
Instance details Defined in Cardano.Api.Network.Internal.NetworkId Methods (==) :: NetworkId -> NetworkId -> Bool Source # (/=) :: NetworkId -> NetworkId -> Bool Source #
Show NetworkId Source #
Instance details Defined in Cardano.Api.Network.Internal.NetworkId Methods showsPrec :: Int -> NetworkId -> ShowS Source # show :: NetworkId -> String Source # showList :: [NetworkId] -> ShowS Source #

newtype NetworkMagic #

Constructors

NetworkMagic
Fields unNetworkMagic :: Word32

Instances

Instances details

NFData NetworkMagic #

Instance details

Defined in Ouroboros.Network.Magic

Methods

rnf :: NetworkMagic -> () Source #

Eq NetworkMagic #

Instance details

Defined in Ouroboros.Network.Magic

Methods

(==) :: NetworkMagic -> NetworkMagic -> Bool Source #

(/=) :: NetworkMagic -> NetworkMagic -> Bool Source #

Generic NetworkMagic #

Instance details

Defined in Ouroboros.Network.Magic

Associated Types

type Rep NetworkMagic
Instance details Defined in Ouroboros.Network.Magic type Rep NetworkMagic = D1 ('MetaData "NetworkMagic" "Ouroboros.Network.Magic" "ouroboros-network-1.1.0.0-l-api-1804fedea85e7a3360b5b8c61844084bb856c2cc0fb7bdb2bfb606d9691b892b" 'True) (C1 ('MetaCons "NetworkMagic" 'PrefixI 'True) (S1 ('MetaSel ('Just "unNetworkMagic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))

Methods

from :: NetworkMagic -> Rep NetworkMagic x Source #

to :: Rep NetworkMagic x -> NetworkMagic Source #

Show NetworkMagic #

Instance details

Defined in Ouroboros.Network.Magic

Methods

showsPrec :: Int -> NetworkMagic -> ShowS Source #

show :: NetworkMagic -> String Source #

showList :: [NetworkMagic] -> ShowS Source #

NoThunks NetworkMagic #

Instance details

Defined in Ouroboros.Network.Magic

Methods

noThunks :: Context -> NetworkMagic -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> NetworkMagic -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy NetworkMagic -> String #

type Rep NetworkMagic #

Instance details

Defined in Ouroboros.Network.Magic

type Rep NetworkMagic = D1 ('MetaData "NetworkMagic" "Ouroboros.Network.Magic" "ouroboros-network-1.1.0.0-l-api-1804fedea85e7a3360b5b8c61844084bb856c2cc0fb7bdb2bfb606d9691b892b" 'True) (C1 ('MetaCons "NetworkMagic" 'PrefixI 'True) (S1 ('MetaSel ('Just "unNetworkMagic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))

fromNetworkMagic :: NetworkMagic -> NetworkId Source #

toNetworkMagic :: NetworkId -> NetworkMagic Source #

mainnetNetworkMagic :: NetworkMagic Source #

`network` reexports

data LedgerPeerSnapshot (a :: LedgerPeersKind) where #

Constructors

LedgerPeerSnapshotV2 :: (WithOrigin SlotNo, [(AccPoolStake, (PoolStake, NonEmpty LedgerRelayAccessPoint))]) -> LedgerPeerSnapshot 'BigLedgerPeers
LedgerBigPeerSnapshotV23 :: !(Point RawBlockHash) -> !NetworkMagic -> ![(AccPoolStake, (PoolStake, NonEmpty LedgerRelayAccessPoint))] -> LedgerPeerSnapshot 'BigLedgerPeers
LedgerAllPeerSnapshotV23 :: !(Point RawBlockHash) -> !NetworkMagic -> ![(PoolStake, NonEmpty LedgerRelayAccessPoint)] -> LedgerPeerSnapshot 'AllLedgerPeers

Instances

Instances details

FromJSON (LedgerPeerSnapshot 'AllLedgerPeers) #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods parseJSON :: Value -> Parser (LedgerPeerSnapshot 'AllLedgerPeers) # parseJSONList :: Value -> Parser [LedgerPeerSnapshot 'AllLedgerPeers] # omittedField :: Maybe (LedgerPeerSnapshot 'AllLedgerPeers) #
FromJSON (LedgerPeerSnapshot 'BigLedgerPeers) #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods parseJSON :: Value -> Parser (LedgerPeerSnapshot 'BigLedgerPeers) # parseJSONList :: Value -> Parser [LedgerPeerSnapshot 'BigLedgerPeers] # omittedField :: Maybe (LedgerPeerSnapshot 'BigLedgerPeers) #
ToJSON (LedgerPeerSnapshot a) #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods toJSON :: LedgerPeerSnapshot a -> Value # toEncoding :: LedgerPeerSnapshot a -> Encoding # toJSONList :: [LedgerPeerSnapshot a] -> Value # toEncodingList :: [LedgerPeerSnapshot a] -> Encoding # omitField :: LedgerPeerSnapshot a -> Bool #
Eq (LedgerPeerSnapshot a) #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (==) :: LedgerPeerSnapshot a -> LedgerPeerSnapshot a -> Bool Source # (/=) :: LedgerPeerSnapshot a -> LedgerPeerSnapshot a -> Bool Source #
Show (LedgerPeerSnapshot a) #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods showsPrec :: Int -> LedgerPeerSnapshot a -> ShowS Source # show :: LedgerPeerSnapshot a -> String Source # showList :: [LedgerPeerSnapshot a] -> ShowS Source #

data SomeLedgerPeerSnapshot #

Constructors

SomeLedgerPeerSnapshot !(LedgerPeerSnapshot k)

Instances

Instances details

Eq SomeLedgerPeerSnapshot #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (==) :: SomeLedgerPeerSnapshot -> SomeLedgerPeerSnapshot -> Bool Source # (/=) :: SomeLedgerPeerSnapshot -> SomeLedgerPeerSnapshot -> Bool Source #
Show SomeLedgerPeerSnapshot #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods showsPrec :: Int -> SomeLedgerPeerSnapshot -> ShowS Source # show :: SomeLedgerPeerSnapshot -> String Source # showList :: [SomeLedgerPeerSnapshot] -> ShowS Source #

data LedgerPeersKind #

Constructors

AllLedgerPeers
BigLedgerPeers

data SingLedgerPeersKind (k :: LedgerPeersKind) where #

Constructors

SingAllLedgerPeers :: SingLedgerPeersKind 'AllLedgerPeers
SingBigLedgerPeers :: SingLedgerPeersKind 'BigLedgerPeers

Instances

Instances details

Eq (SingLedgerPeersKind k) #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (==) :: SingLedgerPeersKind k -> SingLedgerPeersKind k -> Bool Source # (/=) :: SingLedgerPeersKind k -> SingLedgerPeersKind k -> Bool Source #
Show (SingLedgerPeersKind k) #
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods showsPrec :: Int -> SingLedgerPeersKind k -> ShowS Source # show :: SingLedgerPeersKind k -> String Source # showList :: [SingLedgerPeersKind k] -> ShowS Source #

data Target point #

Constructors

VolatileTip
SpecificPoint point
ImmutableTip

Instances

Instances details

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 #

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 #

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 #

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-1.1.0.0-l-protocols-eea6fd64d997294f0e6ca3ec561d56d3f5494af8f274c965364aa04e42de9e0b" '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 #

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-1.1.0.0-l-protocols-eea6fd64d997294f0e6ca3ec561d56d3f5494af8f274c965364aa04e42de9e0b" '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)))

newtype Serialised (a :: k) #

Constructors

Serialised
Fields unSerialised :: ByteString

Instances

Instances details

SerialiseNodeToClient ByronBlock (Serialised ByronBlock) #
Instance details Defined in Ouroboros.Consensus.Byron.Node.Serialisation Methods encodeNodeToClient :: CodecConfig ByronBlock -> BlockNodeToClientVersion ByronBlock -> Serialised ByronBlock -> Encoding Source # decodeNodeToClient :: CodecConfig ByronBlock -> BlockNodeToClientVersion ByronBlock -> forall s. Decoder s (Serialised ByronBlock) Source #
SerialiseNodeToNode ByronBlock (Serialised ByronBlock) #
Instance details Defined in Ouroboros.Consensus.Byron.Node.Serialisation Methods encodeNodeToNode :: CodecConfig ByronBlock -> BlockNodeToNodeVersion ByronBlock -> Serialised ByronBlock -> Encoding Source # decodeNodeToNode :: CodecConfig ByronBlock -> BlockNodeToNodeVersion ByronBlock -> forall s. Decoder s (Serialised ByronBlock) 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 #
DecodeDiskDepIx f blk => DecodeDisk blk (GenDepPair (Serialised :: Type -> Type) (f blk)) Source #
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)) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Serialisation Methods encodeDisk :: CodecConfig blk -> GenDepPair (Serialised :: Type -> Type) (f blk) -> Encoding Source #
SerialiseHFC xs => SerialiseNodeToClient (HardForkBlock xs) (Serialised (HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToClient Methods encodeNodeToClient :: CodecConfig (HardForkBlock xs) -> BlockNodeToClientVersion (HardForkBlock xs) -> Serialised (HardForkBlock xs) -> Encoding Source # decodeNodeToClient :: CodecConfig (HardForkBlock xs) -> BlockNodeToClientVersion (HardForkBlock xs) -> forall s. Decoder s (Serialised (HardForkBlock xs)) Source #
SerialiseHFC xs => SerialiseNodeToNode (HardForkBlock xs) (Serialised (HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToNode Methods encodeNodeToNode :: CodecConfig (HardForkBlock xs) -> BlockNodeToNodeVersion (HardForkBlock xs) -> Serialised (HardForkBlock xs) -> Encoding Source # decodeNodeToNode :: CodecConfig (HardForkBlock xs) -> BlockNodeToNodeVersion (HardForkBlock xs) -> forall s. Decoder s (Serialised (HardForkBlock xs)) Source #
Eq (Serialised a) #
Instance details Defined in Ouroboros.Network.Block Methods (==) :: Serialised a -> Serialised a -> Bool Source # (/=) :: Serialised a -> Serialised a -> Bool 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 #
Serialise (Serialised a) #
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]
SerialiseNodeToClient (ShelleyBlock proto era) (Serialised (ShelleyBlock proto era)) #
Instance details Defined in Ouroboros.Consensus.Shelley.Node.Serialisation Methods encodeNodeToClient :: CodecConfig (ShelleyBlock proto era) -> BlockNodeToClientVersion (ShelleyBlock proto era) -> Serialised (ShelleyBlock proto era) -> Encoding Source # decodeNodeToClient :: CodecConfig (ShelleyBlock proto era) -> BlockNodeToClientVersion (ShelleyBlock proto era) -> forall s. Decoder s (Serialised (ShelleyBlock proto era)) Source #
SerialiseNodeToNode (ShelleyBlock proto era) (Serialised (ShelleyBlock proto era)) #
Instance details Defined in Ouroboros.Consensus.Shelley.Node.Serialisation Methods encodeNodeToNode :: CodecConfig (ShelleyBlock proto era) -> BlockNodeToNodeVersion (ShelleyBlock proto era) -> Serialised (ShelleyBlock proto era) -> Encoding Source # decodeNodeToNode :: CodecConfig (ShelleyBlock proto era) -> BlockNodeToNodeVersion (ShelleyBlock proto era) -> forall s. Decoder s (Serialised (ShelleyBlock proto era)) Source #
type HeaderHash (Serialised block :: Type) #
Instance details Defined in Ouroboros.Network.Block type HeaderHash (Serialised block :: Type) = HeaderHash block

data SubmitResult reason #

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 #

NFData reason => NFData (SubmitResult reason) #

Instance details

Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type

Methods

rnf :: SubmitResult reason -> () 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 #

Generic (SubmitResult reason) #

Instance details

Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type

Associated Types

type Rep (SubmitResult reason)

Instance details

Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type

type Rep (SubmitResult reason) = D1 ('MetaData "SubmitResult" "Ouroboros.Network.Protocol.LocalTxSubmission.Type" "ouroboros-network-1.1.0.0-l-protocols-eea6fd64d997294f0e6ca3ec561d56d3f5494af8f274c965364aa04e42de9e0b" 'False) (C1 ('MetaCons "SubmitSuccess" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SubmitFail" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 reason)))

Methods

from :: SubmitResult reason -> Rep (SubmitResult reason) x Source #

to :: Rep (SubmitResult reason) x -> SubmitResult reason Source #

Show a => Show (SubmitResult a) Source #

Instance details

Defined in Cardano.Api.Internal.Orphans.Serialisation

Methods

showsPrec :: Int -> SubmitResult a -> ShowS Source #

show :: SubmitResult a -> String Source #

showList :: [SubmitResult a] -> ShowS Source #

type Rep (SubmitResult reason) #

Instance details

Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type

type Rep (SubmitResult reason) = D1 ('MetaData "SubmitResult" "Ouroboros.Network.Protocol.LocalTxSubmission.Type" "ouroboros-network-1.1.0.0-l-protocols-eea6fd64d997294f0e6ca3ec561d56d3f5494af8f274c965364aa04e42de9e0b" 'False) (C1 ('MetaCons "SubmitSuccess" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SubmitFail" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 reason)))