Safe Haskell	None
Language	Haskell2010

Cardano.Node.Emulator.Chain

Synopsis

data ChainEvent
- = TxnValidate TxId CardanoTx [Text]
- | TxnValidationFail ValidationPhase TxId CardanoTx ValidationError Value [Text]
- | SlotAdd Slot
type TxPool = [CardanoTx]
data ChainState = ChainState {
- _chainNewestFirst :: Blockchain
- _txPool :: TxPool
- _index :: UtxoIndex
- _chainCurrentSlot :: Slot
}
emptyChainState :: ChainState
txPool :: Lens' ChainState TxPool
index :: Lens' ChainState UtxoIndex
chainNewestFirst :: Lens' ChainState Blockchain
chainCurrentSlot :: Lens' ChainState Slot
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
getCollateral :: UtxoIndex -> CardanoTx -> Value
canValidateNow :: Slot -> CardanoTx -> Bool
mkValidationEvent :: UtxoIndex -> CardanoTx -> Either ValidationErrorInPhase ValidationSuccess -> ChainEvent
validateEm :: MonadState ValidationCtx m => Slot -> CardanoTx -> m (Either ValidationErrorInPhase ValidationSuccess)
addBlock :: Block -> ChainState -> ChainState
addTxToPool :: CardanoTx -> TxPool -> TxPool
_SlotAdd :: Prism' ChainEvent Slot
_TxnValidationFail :: Prism' ChainEvent (ValidationPhase, TxId, CardanoTx, ValidationError, Value, [Text])
_TxnValidate :: Prism' ChainEvent (TxId, CardanoTx, [Text])

Documentation

data ChainEvent Source #

Events produced by the blockchain emulator.

Constructors

TxnValidate TxId CardanoTx [Text]	A transaction has been validated and added to the blockchain.
TxnValidationFail ValidationPhase TxId CardanoTx ValidationError Value [Text]	A transaction failed to validate. The `Value` indicates the amount of collateral stored in the transaction.
SlotAdd Slot

Instances

Instances details

Eq ChainEvent Source #
Instance details Defined in Cardano.Node.Emulator.Chain Methods (==) :: ChainEvent -> ChainEvent -> Bool Source # (/=) :: ChainEvent -> ChainEvent -> Bool Source #
Show ChainEvent Source #
Instance details Defined in Cardano.Node.Emulator.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.Chain Associated Types type Rep ChainEvent :: Type -> Type Source # Methods from :: ChainEvent -> Rep ChainEvent x Source # to :: Rep ChainEvent x -> ChainEvent Source #
ToJSON ChainEvent Source #
Instance details Defined in Cardano.Node.Emulator.Chain Methods toJSON :: ChainEvent -> Value Source # toEncoding :: ChainEvent -> Encoding Source # toJSONList :: [ChainEvent] -> Value Source # toEncodingList :: [ChainEvent] -> Encoding Source #
FromJSON ChainEvent Source #
Instance details Defined in Cardano.Node.Emulator.Chain Methods parseJSON :: Value -> Parser ChainEvent Source # parseJSONList :: Value -> Parser [ChainEvent] Source #
Pretty ChainEvent Source #
Instance details Defined in Cardano.Node.Emulator.Chain Methods pretty :: ChainEvent -> Doc ann Source # prettyList :: [ChainEvent] -> Doc ann Source #
type Rep ChainEvent Source #
Instance details Defined in Cardano.Node.Emulator.Chain type Rep ChainEvent = D1 ('MetaData "ChainEvent" "Cardano.Node.Emulator.Chain" "cardano-node-emulator-1.1.0.0-86RbaXcxDhk56O3Y8j0lgb" 'False) (C1 ('MetaCons "TxnValidate" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxId) :: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CardanoTx) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text]))) :+: (C1 ('MetaCons "TxnValidationFail" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ValidationPhase) :: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxId) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CardanoTx))) :: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ValidationError) :: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))) :+: C1 ('MetaCons "SlotAdd" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Slot))))

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.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.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.Chain type Rep ChainState = D1 ('MetaData "ChainState" "Cardano.Node.Emulator.Chain" "cardano-node-emulator-1.1.0.0-86RbaXcxDhk56O3Y8j0lgb" 'False) (C1 ('MetaCons "ChainState" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_chainNewestFirst") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Blockchain) :: S1 ('MetaSel ('Just "_txPool") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxPool)) :: (S1 ('MetaSel ('Just "_index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UtxoIndex) :*: S1 ('MetaSel ('Just "_chainCurrentSlot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Slot))))

emptyChainState :: ChainState Source #

txPool :: Lens' ChainState TxPool Source #

index :: Lens' ChainState UtxoIndex Source #

chainNewestFirst :: Lens' ChainState Blockchain Source #

chainCurrentSlot :: Lens' ChainState Slot 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.

getCollateral :: UtxoIndex -> CardanoTx -> Value Source #

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

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

mkValidationEvent :: UtxoIndex -> CardanoTx -> Either ValidationErrorInPhase ValidationSuccess -> ChainEvent Source #

validateEm :: MonadState ValidationCtx m => Slot -> CardanoTx -> m (Either ValidationErrorInPhase ValidationSuccess) Source #

Validate a transaction in the current emulator state.

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

Adds a block to ChainState, without validation.

addTxToPool :: CardanoTx -> TxPool -> TxPool Source #

_SlotAdd :: Prism' ChainEvent Slot Source #

_TxnValidationFail :: Prism' ChainEvent (ValidationPhase, TxId, CardanoTx, ValidationError, Value, [Text]) Source #

_TxnValidate :: Prism' ChainEvent (TxId, CardanoTx, [Text]) Source #