Safe Haskell	Safe-Inferred
Language	Haskell2010

Cooked.MockChain.State

Contents

MockChainState and associated optics
Helpers to add or remove outputs from a MockChainState
UtxoState: A simplified, address-focused view on a MockChainState
Querying the assets owned by a given address
Transforming a MockChainState into an UtxoState

Description

This module exposes the internal state in which our direct simulation is run (MockChainState), as well as a restricted and simplified version (UtxoState). The latter only consists of Utxos with a focus on who owns those Utxos. You can see this as having some sort of an "account" view of the ledger state, which typically does not exist in Cardano. This is useful for two reasons:

For printing purposes, where it is much more convient to see the available assets as "who owns what" rather than as a set of mixed Utxos.
For testings purposes, when querying the final state of a run is needed. For instance, properties such as "does Alice indeed owns 3 XXX tokens at the end of this run?" become much easier to express.

Synopsis

data MockChainState where
- MockChainState :: {..} -> MockChainState
mcstParamsL :: Lens' MockChainState Params
mcstLedgerStateL :: Lens' MockChainState EmulatedLedgerState
mcstOutputsL :: Lens' MockChainState (Map TxOutRef (TxSkelOut, Bool))
mcstConstitutionL :: Lens' MockChainState (Maybe VScript)
mcstMOutputL :: TxOutRef -> Lens' MockChainState (Maybe TxSkelOut)
addOutput :: TxOutRef -> TxSkelOut -> MockChainState -> MockChainState
removeOutput :: TxOutRef -> MockChainState -> MockChainState
data UtxoPayloadDatum where
- NoUtxoPayloadDatum :: UtxoPayloadDatum
- SomeUtxoPayloadDatum :: DatumConstrs dat => dat -> Bool -> UtxoPayloadDatum
utxoPayloadDatumKindAT :: AffineTraversal' UtxoPayloadDatum Bool
utxoPayloadDatumTypedAT :: (DatumConstrs a, DatumConstrs b) => AffineTraversal UtxoPayloadDatum UtxoPayloadDatum a b
data UtxoPayload where
- UtxoPayload :: {..} -> UtxoPayload
utxoPayloadTxOutRefL :: Lens' UtxoPayload TxOutRef
utxoPayloadValueL :: Lens' UtxoPayload Value
utxoPayloadDatumL :: Lens' UtxoPayload UtxoPayloadDatum
utxoPayloadMReferenceScriptHashL :: Lens' UtxoPayload (Maybe ScriptHash)
utxoPayloadReferenceScriptHashAT :: AffineTraversal' UtxoPayload ScriptHash
newtype UtxoPayloadSet = UtxoPayloadSet {
- utxoPayloadSet :: [UtxoPayload]
}
utxoPayloadSetListI :: Iso' UtxoPayloadSet [UtxoPayload]
data UtxoState where
- UtxoState :: {..} -> UtxoState
availableUtxosL :: Lens' UtxoState (Map Address UtxoPayloadSet)
consumedUtxosL :: Lens' UtxoState (Map Address UtxoPayloadSet)
holdsInState :: ToAddress a => a -> UtxoState -> Value
mcstToUtxoState :: MockChainState -> UtxoState

`MockChainState` and associated optics

data MockChainState where Source #

The state used to run the simulation in Direct

Constructors

MockChainState

Fields

:: { mcstParams :: Params
The parameters of the emulated blockchain
, mcstLedgerState :: EmulatedLedgerState
The ledger state of the emulated blockchain
, mcstOutputs :: Map TxOutRef (TxSkelOut, Bool)
Associates to each TxOutRef the TxSkelOut that produced it, alongside a boolean to state whether this UTxO is still present in the index (True) or has already been consumed (False).
, mcstConstitution :: Maybe VScript
The constitution script to be used with proposals
} -> MockChainState

Instances

Instances details

Show MockChainState Source #
Instance details Defined in Cooked.MockChain.State Methods showsPrec :: Int -> MockChainState -> ShowS # show :: MockChainState -> String # showList :: [MockChainState] -> ShowS #
RunnableMockChain FullEffs Source #
Instance details Defined in Cooked.MockChain.Instances Methods runMockChain :: MockChainState -> Sem FullEffs a -> [RawMockChainReturn a] Source #
Default MockChainState Source #
Instance details Defined in Cooked.MockChain.State Methods def :: MockChainState #

mcstParamsL :: Lens' MockChainState Params Source #

Focuses on the parameters of a MockChainState

mcstLedgerStateL :: Lens' MockChainState EmulatedLedgerState Source #

Focuses on the ledger state of a MockChainState

mcstOutputsL :: Lens' MockChainState (Map TxOutRef (TxSkelOut, Bool)) Source #

Focuses on the outputs of a MockChainState

mcstConstitutionL :: Lens' MockChainState (Maybe VScript) Source #

Focuses on the constitution script of a MockChainState

mcstMOutputL :: TxOutRef -> Lens' MockChainState (Maybe TxSkelOut) Source #

Accesses a given available Utxo from a MockChainState

Helpers to add or remove outputs from a `MockChainState`

addOutput :: TxOutRef -> TxSkelOut -> MockChainState -> MockChainState Source #

Stores an output in a MockChainState

removeOutput :: TxOutRef -> MockChainState -> MockChainState Source #

Removes an output from the MockChainState. This does not actually remove it from the map, but instead marks its availability to False

`UtxoState`: A simplified, address-focused view on a `MockChainState`

data UtxoPayloadDatum where Source #

A simplified version of a TxSkelOutDatum which only stores the actual datum and whether it is hashed (True) or inline (False). The only difference is that whether the datum was resolved in the transaction creating it on the ledger is absent, which makes sense after the fact.

Constructors

NoUtxoPayloadDatum :: UtxoPayloadDatum
SomeUtxoPayloadDatum :: DatumConstrs dat => dat -> Bool -> UtxoPayloadDatum

Instances

Instances details

Show UtxoPayloadDatum Source #
Instance details Defined in Cooked.MockChain.State Methods showsPrec :: Int -> UtxoPayloadDatum -> ShowS # show :: UtxoPayloadDatum -> String # showList :: [UtxoPayloadDatum] -> ShowS #
Eq UtxoPayloadDatum Source #
Instance details Defined in Cooked.MockChain.State Methods (==) :: UtxoPayloadDatum -> UtxoPayloadDatum -> Bool # (/=) :: UtxoPayloadDatum -> UtxoPayloadDatum -> Bool #
Ord UtxoPayloadDatum Source #
Instance details Defined in Cooked.MockChain.State Methods compare :: UtxoPayloadDatum -> UtxoPayloadDatum -> Ordering # (<) :: UtxoPayloadDatum -> UtxoPayloadDatum -> Bool # (<=) :: UtxoPayloadDatum -> UtxoPayloadDatum -> Bool # (>) :: UtxoPayloadDatum -> UtxoPayloadDatum -> Bool # (>=) :: UtxoPayloadDatum -> UtxoPayloadDatum -> Bool # max :: UtxoPayloadDatum -> UtxoPayloadDatum -> UtxoPayloadDatum # min :: UtxoPayloadDatum -> UtxoPayloadDatum -> UtxoPayloadDatum #

utxoPayloadDatumKindAT :: AffineTraversal' UtxoPayloadDatum Bool Source #

Focuses on the optional hashed flag of a UtxoPayloadDatum

utxoPayloadDatumTypedAT :: (DatumConstrs a, DatumConstrs b) => AffineTraversal UtxoPayloadDatum UtxoPayloadDatum a b Source #

Extracts, or sets, the typed datum of a UtxoPayloadDatum following the same rules as txSkelOutDatumTypedAT

data UtxoPayload where Source #

A convenient wrapping of the interesting information of a UTxO.

Constructors

UtxoPayload
Fields :: { utxoPayloadTxOutRef :: TxOutRef The reference of this UTxO , utxoPayloadValue :: Value The value stored in this UTxO , utxoPayloadDatum :: UtxoPayloadDatum The optional datum stored in this UTxO , utxoPayloadReferenceScriptHash :: Maybe ScriptHash The hash of the optional reference script stored in this UTxO } -> UtxoPayload

Instances

Instances details

Show UtxoPayload Source #
Instance details Defined in Cooked.MockChain.State Methods showsPrec :: Int -> UtxoPayload -> ShowS # show :: UtxoPayload -> String # showList :: [UtxoPayload] -> ShowS #
Eq UtxoPayload Source #
Instance details Defined in Cooked.MockChain.State Methods (==) :: UtxoPayload -> UtxoPayload -> Bool # (/=) :: UtxoPayload -> UtxoPayload -> Bool #

utxoPayloadTxOutRefL :: Lens' UtxoPayload TxOutRef Source #

Focuses on the UTxO reference of a UtxoPayload

utxoPayloadValueL :: Lens' UtxoPayload Value Source #

Focuses on the value of a UtxoPayload

utxoPayloadDatumL :: Lens' UtxoPayload UtxoPayloadDatum Source #

Focuses on the datum of a UtxoPayload

utxoPayloadMReferenceScriptHashL :: Lens' UtxoPayload (Maybe ScriptHash) Source #

Focuses on the optional reference script hash of a UtxoPayload

utxoPayloadReferenceScriptHashAT :: AffineTraversal' UtxoPayload ScriptHash Source #

Focuses on the optional reference script hash of a UtxoPayload

newtype UtxoPayloadSet Source #

Represents a set of payloads.

Constructors

UtxoPayloadSet
Fields utxoPayloadSet :: [UtxoPayload] List of UTxOs contained in this `UtxoPayloadSet`

Instances

Instances details

Monoid UtxoPayloadSet Source #
Instance details Defined in Cooked.MockChain.State Methods mempty :: UtxoPayloadSet # mappend :: UtxoPayloadSet -> UtxoPayloadSet -> UtxoPayloadSet # mconcat :: [UtxoPayloadSet] -> UtxoPayloadSet #
Semigroup UtxoPayloadSet Source #
Instance details Defined in Cooked.MockChain.State Methods (<>) :: UtxoPayloadSet -> UtxoPayloadSet -> UtxoPayloadSet # sconcat :: NonEmpty UtxoPayloadSet -> UtxoPayloadSet # stimes :: Integral b => b -> UtxoPayloadSet -> UtxoPayloadSet #
Show UtxoPayloadSet Source #
Instance details Defined in Cooked.MockChain.State Methods showsPrec :: Int -> UtxoPayloadSet -> ShowS # show :: UtxoPayloadSet -> String # showList :: [UtxoPayloadSet] -> ShowS #
PrettyCookedList UtxoPayloadSet Source #	Pretty prints the state of an address, that is the list of UTxOs (including value and datum), grouped
Instance details Defined in Cooked.Pretty.MockChain Methods prettyCookedOptList :: PrettyCookedOpts -> UtxoPayloadSet -> [DocCooked] Source # prettyCookedOptListMaybe :: PrettyCookedOpts -> UtxoPayloadSet -> [Maybe DocCooked] Source # prettyCookedListMaybe :: UtxoPayloadSet -> [Maybe DocCooked] Source # prettyCookedList :: UtxoPayloadSet -> [DocCooked] Source #
Eq UtxoPayloadSet Source #
Instance details Defined in Cooked.MockChain.State Methods (==) :: UtxoPayloadSet -> UtxoPayloadSet -> Bool # (/=) :: UtxoPayloadSet -> UtxoPayloadSet -> Bool #
PrettyCooked (Map Address UtxoPayloadSet) Source #	Pretty print a `UtxoState`. Print the known wallets first, then unknown pubkeys, then scripts.
Instance details Defined in Cooked.Pretty.MockChain Methods prettyCookedOpt :: PrettyCookedOpts -> Map Address UtxoPayloadSet -> DocCooked Source # prettyCooked :: Map Address UtxoPayloadSet -> DocCooked Source #

utxoPayloadSetListI :: Iso' UtxoPayloadSet [UtxoPayload] Source #

An isomorphism between a UtxoPayloadSet and a list of UtxoPayload

data UtxoState where Source #

A description of who owns what in a blockchain. Owners are addresses and they each own a UtxoPayloadSet.

Constructors

UtxoState
Fields :: { availableUtxos :: Map Address UtxoPayloadSet Utxos available to be consumed , consumedUtxos :: Map Address UtxoPayloadSet Utxos already consumed } -> UtxoState

Instances

Instances details

Monoid UtxoState Source #
Instance details Defined in Cooked.MockChain.State Methods mempty :: UtxoState # mappend :: UtxoState -> UtxoState -> UtxoState # mconcat :: [UtxoState] -> UtxoState #
Semigroup UtxoState Source #
Instance details Defined in Cooked.MockChain.State Methods (<>) :: UtxoState -> UtxoState -> UtxoState # sconcat :: NonEmpty UtxoState -> UtxoState # stimes :: Integral b => b -> UtxoState -> UtxoState #
Eq UtxoState Source #
Instance details Defined in Cooked.MockChain.State Methods (==) :: UtxoState -> UtxoState -> Bool # (/=) :: UtxoState -> UtxoState -> Bool #