Safe Haskell	None
Language	Haskell2010

Cardano.Node.Emulator.Internal.Node.Chain

Synopsis

data ChainEvent
- = TxnValidation !ValidationResult
- | SlotAdd !Slot
chainEventOnChainTx :: ChainEvent -> Maybe OnChainTx
type TxPool = [CardanoTx]
data ChainState = ChainState {
- _chainNewestFirst :: !Blockchain
- _txPool :: !TxPool
- _index :: !UtxoIndex
- _chainCurrentSlot :: !Slot
}
txPool :: Lens' ChainState TxPool
index :: Lens' ChainState UtxoIndex
chainNewestFirst :: Lens' ChainState Blockchain
chainCurrentSlot :: Lens' ChainState Slot
emptyChainState :: ChainState
fromBlockchain :: Blockchain -> ChainState
data ChainControlEffect r where
- ProcessBlock :: ChainControlEffect Block
- ModifySlot :: (Slot -> Slot) -> ChainControlEffect Slot
data ChainEffect r where
- QueueTx :: CardanoTx -> ChainEffect ()
- GetCurrentSlot :: ChainEffect Slot
- GetParams :: ChainEffect Params
processBlock :: Member ChainControlEffect effs => Eff effs Block
modifySlot :: Member ChainControlEffect effs => (Slot -> Slot) -> Eff effs Slot
queueTx :: Member ChainEffect effs => CardanoTx -> Eff effs ()
getParams :: Member ChainEffect effs => Eff effs Params
getCurrentSlot :: Member ChainEffect effs => Eff effs Slot
type ChainEffs = '[State ChainState, LogMsg ChainEvent]
handleControlChain :: Members ChainEffs effs => Params -> ChainControlEffect ~> Eff effs
logEvent :: Member (LogMsg ChainEvent) effs => ChainEvent -> Eff effs ()
handleChain :: Members ChainEffs effs => Params -> ChainEffect ~> Eff effs
data ValidatedBlock = ValidatedBlock {
- vlbValid :: !Block
- vlbEvents :: ![ChainEvent]
- vlbIndex :: !UtxoIndex
}
data ValidationCtx = ValidationCtx {
- vctxIndex :: !UtxoIndex
- vctxParams :: !Params
}
validateBlock :: Params -> Slot -> UtxoIndex -> TxPool -> ValidatedBlock
canValidateNow :: Slot -> CardanoTx -> Bool
validateEm :: MonadState ValidationCtx m => Slot -> CardanoTx -> m ValidationResult
addBlock :: Block -> ChainState -> ChainState
addTxToPool :: CardanoTx -> ChainState -> ChainState
_SlotAdd :: Prism' ChainEvent Slot
_TxnValidation :: Prism' ChainEvent ValidationResult

Documentation

data ChainEvent Source #

Events produced by the blockchain emulator.

Constructors

TxnValidation !ValidationResult	A transaction has been validated and added to the blockchain.
SlotAdd !Slot

Instances

Instances details

Eq ChainEvent Source #
Instance details Defined in Cardano.Node.Emulator.Internal.Node.Chain Methods (==) :: ChainEvent -> ChainEvent -> Bool Source # (/=) :: ChainEvent -> ChainEvent -> Bool Source #
Show ChainEvent Source #
Instance details Defined in Cardano.Node.Emulator.Internal.Node.Chain Methods showsPrec :: Int -> ChainEvent -> ShowS Source # show :: ChainEvent -> String Source # showList :: [ChainEvent] -> ShowS Source #
Generic ChainEvent Source #
Instance details Defined in Cardano.Node.Emulator.Internal.Node.Chain Associated Types type Rep ChainEvent :: Type -> Type Source # Methods from :: ChainEvent -> Rep ChainEvent x Source # to :: Rep ChainEvent x -> ChainEvent Source #
FromJSON ChainEvent Source #
Instance details Defined in Cardano.Node.Emulator.Internal.Node.Chain Methods parseJSON :: Value -> Parser ChainEvent parseJSONList :: Value -> Parser [ChainEvent]
ToJSON ChainEvent Source #
Instance details Defined in Cardano.Node.Emulator.Internal.Node.Chain Methods toJSON :: ChainEvent -> Value toEncoding :: ChainEvent -> Encoding toJSONList :: [ChainEvent] -> Value toEncodingList :: [ChainEvent] -> Encoding
Pretty ChainEvent Source #
Instance details Defined in Cardano.Node.Emulator.Internal.Node.Chain Methods pretty :: ChainEvent -> Doc ann prettyList :: [ChainEvent] -> Doc ann
type Rep ChainEvent Source #
Instance details Defined in Cardano.Node.Emulator.Internal.Node.Chain type Rep ChainEvent = D1 ('MetaData "ChainEvent" "Cardano.Node.Emulator.Internal.Node.Chain" "cardano-node-emulator-1.2.0.0-1RjxyDmnwHSAn2KgGdAUXD" 'False) (C1 ('MetaCons "TxnValidation" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ValidationResult)) :+: C1 ('MetaCons "SlotAdd" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Slot)))

chainEventOnChainTx :: ChainEvent -> Maybe OnChainTx Source #

type TxPool = [CardanoTx] Source #

A pool of transactions which have yet to be validated.

data ChainState Source #

Constructors

ChainState
Fields _chainNewestFirst :: !Blockchain The current chain, with the newest transactions first in the list. _txPool :: !TxPool The pool of pending transactions. _index :: !UtxoIndex The UTxO index, used for validation. _chainCurrentSlot :: !Slot The current slot number

Instances

Instances details

Show ChainState Source #
Instance details Defined in Cardano.Node.Emulator.Internal.Node.Chain Methods showsPrec :: Int -> ChainState -> ShowS Source # show :: ChainState -> String Source # showList :: [ChainState] -> ShowS Source #
Generic ChainState Source #
Instance details Defined in Cardano.Node.Emulator.Internal.Node.Chain Associated Types type Rep ChainState :: Type -> Type Source # Methods from :: ChainState -> Rep ChainState x Source # to :: Rep ChainState x -> ChainState Source #
type Rep ChainState Source #
Instance details Defined in Cardano.Node.Emulator.Internal.Node.Chain type Rep ChainState = D1 ('MetaData "ChainState" "Cardano.Node.Emulator.Internal.Node.Chain" "cardano-node-emulator-1.2.0.0-1RjxyDmnwHSAn2KgGdAUXD" 'False) (C1 ('MetaCons "ChainState" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_chainNewestFirst") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Blockchain) :: S1 ('MetaSel ('Just "_txPool") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TxPool)) :: (S1 ('MetaSel ('Just "_index") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UtxoIndex) :*: S1 ('MetaSel ('Just "_chainCurrentSlot") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Slot))))

txPool :: Lens' ChainState TxPool Source #

index :: Lens' ChainState UtxoIndex Source #

chainNewestFirst :: Lens' ChainState Blockchain Source #

chainCurrentSlot :: Lens' ChainState Slot Source #

emptyChainState :: ChainState Source #

fromBlockchain :: Blockchain -> ChainState Source #

data ChainControlEffect r where Source #

Constructors

ProcessBlock :: ChainControlEffect Block
ModifySlot :: (Slot -> Slot) -> ChainControlEffect Slot

data ChainEffect r where Source #

Constructors

QueueTx :: CardanoTx -> ChainEffect ()
GetCurrentSlot :: ChainEffect Slot
GetParams :: ChainEffect Params

processBlock :: Member ChainControlEffect effs => Eff effs Block Source #

Make a new block

modifySlot :: Member ChainControlEffect effs => (Slot -> Slot) -> Eff effs Slot Source #

Adjust the current slot number, returning the new slot.

queueTx :: Member ChainEffect effs => CardanoTx -> Eff effs () Source #

getParams :: Member ChainEffect effs => Eff effs Params Source #

getCurrentSlot :: Member ChainEffect effs => Eff effs Slot Source #

type ChainEffs = '[State ChainState, LogMsg ChainEvent] Source #

handleControlChain :: Members ChainEffs effs => Params -> ChainControlEffect ~> Eff effs Source #

logEvent :: Member (LogMsg ChainEvent) effs => ChainEvent -> Eff effs () Source #

handleChain :: Members ChainEffs effs => Params -> ChainEffect ~> Eff effs Source #

data ValidatedBlock Source #

The result of validating a block.

Constructors

ValidatedBlock
Fields vlbValid :: !Block The transactions that have been validated in this block. vlbEvents :: ![ChainEvent] Transaction validation events for the transactions in this block. vlbIndex :: !UtxoIndex The updated UTxO index after processing the block

data ValidationCtx Source #

Constructors

ValidationCtx
Fields vctxIndex :: !UtxoIndex vctxParams :: !Params

validateBlock :: Params -> Slot -> UtxoIndex -> TxPool -> ValidatedBlock Source #

Validate a block given the current slot and UTxO index, returning the valid transactions, success/failure events and the updated UTxO set.

canValidateNow :: Slot -> CardanoTx -> Bool Source #

Check whether the given transaction can be validated in the given slot.

validateEm :: MonadState ValidationCtx m => Slot -> CardanoTx -> m ValidationResult Source #

Validate a transaction in the current emulator state.

addBlock :: Block -> ChainState -> ChainState Source #

Adds a block to ChainState, without validation.

addTxToPool :: CardanoTx -> ChainState -> ChainState Source #

_SlotAdd :: Prism' ChainEvent Slot Source #

_TxnValidation :: Prism' ChainEvent ValidationResult Source #