ouroboros-network:sim-tests-lib

Safe Haskell	None
Language	Haskell2010

Test.Ouroboros.Network.Testnet.Node.Kernel

Contents

Common types
Node kernel

Description

Node kernel which does chain selection and block production.

Synopsis

type NtNAddr = TestAddress NtNAddr_
data NtNAddr_
- = EphemeralIPv4Addr Natural
- | EphemeralIPv6Addr Natural
- | IPAddr IP PortNumber
encodeNtNAddr :: NtNAddr -> Encoding
decodeNtNAddr :: Decoder s NtNAddr
ntnAddrToRelayAccessPoint :: NtNAddr -> Maybe RelayAccessPoint
type NtNVersion = UnversionedProtocol
data NtNVersionData = NtNVersionData {
- ntnDiffusionMode :: DiffusionMode
- ntnPeerSharing :: PeerSharing
}
type NtCAddr = TestAddress Int
type NtCVersion = UnversionedProtocol
type NtCVersionData = UnversionedProtocolData
data BlockGeneratorArgs block s = BlockGeneratorArgs {
- bgaSlotDuration :: DiffTime
- bgaBlockGenerator :: s -> Anchor block -> SlotNo -> (Maybe block, s)
- bgaSeed :: s
}
relayBlockGenerationArgs :: DiffTime -> seed -> BlockGeneratorArgs block seed
randomBlockGenerationArgs :: DiffTime -> StdGen -> Int -> BlockGeneratorArgs Block StdGen
data NodeKernel header block s (m :: Type -> Type) = NodeKernel {
- nkClientChains :: StrictTVar m (Map NtNAddr (StrictTVar m (Chain header)))
- nkChainProducerState :: StrictTVar m (ChainProducerState block)
- nkFetchClientRegistry :: FetchClientRegistry NtNAddr header block m
- nkPeerSharingRegistry :: PeerSharingRegistry NtNAddr m
- nkChainDB :: ChainDB block m
- nkPeerSharingAPI :: PeerSharingAPI NtNAddr s m
- nkPublicPeerSelectionVar :: StrictTVar m (PublicPeerSelectionState NtNAddr)
}
newNodeKernel :: MonadSTM m => s -> m (NodeKernel header block s m)
registerClientChains :: MonadSTM m => NodeKernel header block s m -> NtNAddr -> m (StrictTVar m (Chain header))
unregisterClientChains :: MonadSTM m => NodeKernel header block s m -> NtNAddr -> m ()
withNodeKernelThread :: forall block header m seed a. (Alternative (STM m), MonadAsync m, MonadDelay m, MonadThrow m, MonadThrow (STM m), HasFullHeader block, RandomGen seed) => BlockGeneratorArgs block seed -> (NodeKernel header block seed m -> Async m Void -> m a) -> m a
data NodeKernelError = UnexpectedSlot !SlotNo !SlotNo

Common types

type NtNAddr = TestAddress NtNAddr_ Source #

data NtNAddr_ Source #

Node-to-node address type.

Constructors

EphemeralIPv4Addr Natural
EphemeralIPv6Addr Natural
IPAddr IP PortNumber

Instances

Instances details

Arbitrary NtNAddr_ Source #

Instance details

Defined in Test.Ouroboros.Network.Testnet.Node.Kernel

Methods

arbitrary :: Gen NtNAddr_ #

shrink :: NtNAddr_ -> [NtNAddr_] #

NFData NtNAddr_ Source #

Instance details

Defined in Test.Ouroboros.Network.Testnet.Node.Kernel

Methods

rnf :: NtNAddr_ -> () #

Generic NtNAddr_ Source #

Instance details

Defined in Test.Ouroboros.Network.Testnet.Node.Kernel

Associated Types

type Rep NtNAddr_

Instance details

Defined in Test.Ouroboros.Network.Testnet.Node.Kernel

type Rep NtNAddr_ = D1 ('MetaData "NtNAddr_" "Test.Ouroboros.Network.Testnet.Node.Kernel" "ouroboros-network-0.18.0.0-inplace-sim-tests-lib" 'False) (C1 ('MetaCons "EphemeralIPv4Addr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)) :+: (C1 ('MetaCons "EphemeralIPv6Addr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)) :+: C1 ('MetaCons "IPAddr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IP) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PortNumber))))

Methods

from :: NtNAddr_ -> Rep NtNAddr_ x #

to :: Rep NtNAddr_ x -> NtNAddr_ #

Show NtNAddr_ Source #

Instance details

Defined in Test.Ouroboros.Network.Testnet.Node.Kernel

Methods

showsPrec :: Int -> NtNAddr_ -> ShowS #

show :: NtNAddr_ -> String #

showList :: [NtNAddr_] -> ShowS #

Eq NtNAddr_ Source #

Instance details

Defined in Test.Ouroboros.Network.Testnet.Node.Kernel

Methods

(==) :: NtNAddr_ -> NtNAddr_ -> Bool #

(/=) :: NtNAddr_ -> NtNAddr_ -> Bool #

Ord NtNAddr_ Source #

Instance details

Defined in Test.Ouroboros.Network.Testnet.Node.Kernel

Methods

compare :: NtNAddr_ -> NtNAddr_ -> Ordering #

(<) :: NtNAddr_ -> NtNAddr_ -> Bool #

(<=) :: NtNAddr_ -> NtNAddr_ -> Bool #

(>) :: NtNAddr_ -> NtNAddr_ -> Bool #

(>=) :: NtNAddr_ -> NtNAddr_ -> Bool #

max :: NtNAddr_ -> NtNAddr_ -> NtNAddr_ #

min :: NtNAddr_ -> NtNAddr_ -> NtNAddr_ #

Hashable NtNAddr_ Source #

Instance details

Defined in Test.Ouroboros.Network.Testnet.Node.Kernel

Methods

hashWithSalt :: Int -> NtNAddr_ -> Int #

hash :: NtNAddr_ -> Int #

GlobalAddressScheme NtNAddr_ Source #

Instance details

Defined in Test.Ouroboros.Network.Testnet.Node.Kernel

Methods

getAddressType :: TestAddress NtNAddr_ -> AddressType #

ephemeralAddress :: AddressType -> Natural -> TestAddress NtNAddr_ #

type Rep NtNAddr_ Source #

Instance details

Defined in Test.Ouroboros.Network.Testnet.Node.Kernel

type Rep NtNAddr_ = D1 ('MetaData "NtNAddr_" "Test.Ouroboros.Network.Testnet.Node.Kernel" "ouroboros-network-0.18.0.0-inplace-sim-tests-lib" 'False) (C1 ('MetaCons "EphemeralIPv4Addr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)) :+: (C1 ('MetaCons "EphemeralIPv6Addr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)) :+: C1 ('MetaCons "IPAddr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IP) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PortNumber))))

encodeNtNAddr :: NtNAddr -> Encoding Source #

decodeNtNAddr :: Decoder s NtNAddr Source #

ntnAddrToRelayAccessPoint :: NtNAddr -> Maybe RelayAccessPoint Source #

type NtNVersion = UnversionedProtocol Source #

data NtNVersionData Source #

Constructors

NtNVersionData
Fields ntnDiffusionMode :: DiffusionMode ntnPeerSharing :: PeerSharing

Instances

Instances details

Show NtNVersionData Source #
Instance details Defined in Test.Ouroboros.Network.Testnet.Node.Kernel Methods showsPrec :: Int -> NtNVersionData -> ShowS # show :: NtNVersionData -> String # showList :: [NtNVersionData] -> ShowS #

type NtCAddr = TestAddress Int Source #

type NtCVersion = UnversionedProtocol Source #

type NtCVersionData = UnversionedProtocolData Source #

Node kernel

data BlockGeneratorArgs block s Source #

Constructors

BlockGeneratorArgs
Fields bgaSlotDuration :: DiffTime slot duration bgaBlockGenerator :: s -> Anchor block -> SlotNo -> (Maybe block, s) block generator bgaSeed :: s

relayBlockGenerationArgs :: DiffTime -> seed -> BlockGeneratorArgs block seed Source #

Do not generate blocks.

randomBlockGenerationArgs :: DiffTime -> StdGen -> Int -> BlockGeneratorArgs Block StdGen Source #

Generate a block according to given probability.

data NodeKernel header block s (m :: Type -> Type) Source #

Constructors

Fields

nkClientChains :: StrictTVar m (Map NtNAddr (StrictTVar m (Chain header)))
upstream chains
nkChainProducerState :: StrictTVar m (ChainProducerState block)
chain producer state
nkFetchClientRegistry :: FetchClientRegistry NtNAddr header block m
nkPeerSharingRegistry :: PeerSharingRegistry NtNAddr m
nkChainDB :: ChainDB block m
nkPeerSharingAPI :: PeerSharingAPI NtNAddr s m
nkPublicPeerSelectionVar :: StrictTVar m (PublicPeerSelectionState NtNAddr)

newNodeKernel :: MonadSTM m => s -> m (NodeKernel header block s m) Source #

registerClientChains :: MonadSTM m => NodeKernel header block s m -> NtNAddr -> m (StrictTVar m (Chain header)) Source #

Register a new upstream chain-sync client.

unregisterClientChains :: MonadSTM m => NodeKernel header block s m -> NtNAddr -> m () Source #

Unregister an upstream chain-sync client.

withNodeKernelThread Source #

Arguments

:: forall block header m seed a. (Alternative (STM m), MonadAsync m, MonadDelay m, MonadThrow m, MonadThrow (STM m), HasFullHeader block, RandomGen seed)
=> BlockGeneratorArgs block seed
-> (NodeKernel header block seed m -> Async m Void -> m a)	The continuation which has a handle to the chain selection / block production thread. The thread might throw an exception.
-> m a

Run chain selection / block production thread.

data NodeKernelError Source #

Node kernel erros.

Constructors

UnexpectedSlot !SlotNo !SlotNo

Instances

Instances details

Exception NodeKernelError Source #
Instance details Defined in Test.Ouroboros.Network.Testnet.Node.Kernel Methods toException :: NodeKernelError -> SomeException # fromException :: SomeException -> Maybe NodeKernelError # displayException :: NodeKernelError -> String # backtraceDesired :: NodeKernelError -> Bool #
Show NodeKernelError Source #
Instance details Defined in Test.Ouroboros.Network.Testnet.Node.Kernel Methods showsPrec :: Int -> NodeKernelError -> ShowS # show :: NodeKernelError -> String # showList :: [NodeKernelError] -> ShowS #