Safe Haskell	Safe-Inferred
Language	Haskell2010

Convex.MockChain

Contents

State of the mockchain
Transaction validation
Plutus scripts
Mockchain implementation
- MockchainIO

Description

Minimal mockchain

Synopsis

type ERA = BabbageEra StandardCrypto
data MockChainState = MockChainState {
- mcsEnv ∷ MempoolEnv ERA
- mcsPoolState ∷ MempoolState ERA
- mcsTransactions ∷ [(Validated (Tx ERA), [ScriptContext ERA])]
- mcsDatums ∷ Map (Hash ScriptData) ScriptData
}
type InitialUTXOs = [(Wallet, Coin)]
initialState ∷ NodeParams → MockChainState
initialStateFor ∷ NodeParams → InitialUTXOs → MockChainState
genesisUTxO ∷ ∀ era capiEra. (EraCrypto era ~ StandardCrypto, EraTxOut era) ⇒ [(AddressInEra capiEra, Coin)] → UTxO era
env ∷ Lens' MockChainState (MempoolEnv ERA)
poolState ∷ Lens' MockChainState (MempoolState ERA)
transactions ∷ Lens' MockChainState [(Validated (Tx ERA), [ScriptContext ERA])]
utxoSet ∷ MonadMockchain m ⇒ m (UtxoSet CtxUTxO ())
datums ∷ Lens' MockChainState (Map (Hash ScriptData) ScriptData)
walletUtxo ∷ MonadMockchain m ⇒ Wallet → m (UtxoSet CtxUTxO ())
fromLedgerUTxO ∷ ShelleyLedgerEra era ~ ledgerera ⇒ EraCrypto ledgerera ~ StandardCrypto ⇒ ShelleyBasedEra era → UTxO ledgerera → UTxO era
data ExUnitsError
- = Phase1Error TransactionValidityError
- | Phase2Error ScriptExecutionError
_Phase1Error ∷ Prism' ExUnitsError TransactionValidityError
_Phase2Error ∷ Prism' ExUnitsError ScriptExecutionError
data ValidationError
- = VExUnits ExUnitsError
- | PredicateFailures [CollectError ERA]
- | ApplyTxFailure (ApplyTxError ERA)
_VExUnits ∷ Prism' ValidationError ExUnitsError
_PredicateFailures ∷ Prism' ValidationError [CollectError ERA]
_ApplyTxFailure ∷ Prism' ValidationError (ApplyTxError ERA)
getTxExUnits ∷ NodeParams → UTxO ERA → Tx BabbageEra → Either ExUnitsError (Map ScriptWitnessIndex ExecutionUnits)
evaluateTx ∷ NodeParams → SlotNo → UTxO ERA → Tx BabbageEra → Either ValidationError [ScriptContext ERA]
applyTransaction ∷ NodeParams → MockChainState → Tx BabbageEra → Either ValidationError (MockChainState, Validated (Tx ERA))
type ScriptContext era = (ShortByteString, Language, [Data era], ExUnits, CostModel)
fullyAppliedScript ∷ NodeParams → ScriptContext ERA → Either String (Program NamedDeBruijn DefaultUni DefaultFun ())
data MockchainError
- = MockchainValidationFailed ValidationError
- | FailWith String
newtype MockchainT m a = MockchainT (ReaderT NodeParams (StateT MockChainState (ExceptT MockchainError m)) a)
type Mockchain a = MockchainT Identity a
runMockchainT ∷ MockchainT m a → NodeParams → MockChainState → m (Either MockchainError (a, MockChainState))
runMockchain ∷ Mockchain a → NodeParams → MockChainState → Either MockchainError (a, MockChainState)
runMockchain0 ∷ InitialUTXOs → Mockchain a → Either MockchainError (a, MockChainState)
evalMockchainT ∷ Functor m ⇒ MockchainT m a → NodeParams → MockChainState → m (Either MockchainError a)
evalMockchain ∷ Mockchain a → NodeParams → MockChainState → Either MockchainError a
evalMockchain0 ∷ InitialUTXOs → Mockchain a → Either MockchainError a
execMockchain ∷ Mockchain a → NodeParams → MockChainState → Either MockchainError MockChainState
execMockchainT ∷ Functor m ⇒ MockchainT m a → NodeParams → MockChainState → m (Either MockchainError MockChainState)
execMockchain0 ∷ InitialUTXOs → Mockchain a → Either MockchainError MockChainState
type MockchainIO a = MockchainT IO a
runMockchainIO ∷ MockchainIO a → NodeParams → MockChainState → IO (Either MockchainError (a, MockChainState))
runMockchain0IO ∷ InitialUTXOs → MockchainIO a → IO (Either MockchainError (a, MockChainState))
runMockchain0IOWith ∷ InitialUTXOs → NodeParams → MockchainIO a → IO (Either MockchainError (a, MockChainState))
evalMockchainIO ∷ MockchainIO a → NodeParams → MockChainState → IO (Either MockchainError a)
evalMockchain0IO ∷ InitialUTXOs → MockchainIO a → IO (Either MockchainError a)
execMockchainIO ∷ MockchainIO a → NodeParams → MockChainState → IO (Either MockchainError MockChainState)
execMockchain0IO ∷ InitialUTXOs → MockchainIO a → IO (Either MockchainError MockChainState)

State of the mockchain

type ERA = BabbageEra StandardCrypto Source #

data MockChainState Source #

Constructors

MockChainState
Fields mcsEnv ∷ MempoolEnv ERA mcsPoolState ∷ MempoolState ERA mcsTransactions ∷ [(Validated (Tx ERA), [ScriptContext ERA])] mcsDatums ∷ Map (Hash ScriptData) ScriptData

type InitialUTXOs = [(Wallet, Coin)] Source #

initialState ∷ NodeParams → MockChainState Source #

initialStateFor ∷ NodeParams → InitialUTXOs → MockChainState Source #

Initialise the MockChainState with a list of UTxOs

genesisUTxO ∷ ∀ era capiEra. (EraCrypto era ~ StandardCrypto, EraTxOut era) ⇒ [(AddressInEra capiEra, Coin)] → UTxO era Source #

env ∷ Lens' MockChainState (MempoolEnv ERA) Source #

poolState ∷ Lens' MockChainState (MempoolState ERA) Source #

transactions ∷ Lens' MockChainState [(Validated (Tx ERA), [ScriptContext ERA])] Source #

utxoSet ∷ MonadMockchain m ⇒ m (UtxoSet CtxUTxO ()) Source #

All transaction outputs

datums ∷ Lens' MockChainState (Map (Hash ScriptData) ScriptData) Source #

walletUtxo ∷ MonadMockchain m ⇒ Wallet → m (UtxoSet CtxUTxO ()) Source #

The wallet's transaction outputs on the mockchain

fromLedgerUTxO ∷ ShelleyLedgerEra era ~ ledgerera ⇒ EraCrypto ledgerera ~ StandardCrypto ⇒ ShelleyBasedEra era → UTxO ledgerera → UTxO era Source #

Transaction validation

data ExUnitsError Source #

Constructors

Phase1Error TransactionValidityError
Phase2Error ScriptExecutionError

Instances

Instances details

Show ExUnitsError Source #
Instance details Defined in Convex.MockChain Methods showsPrec ∷ Int → ExUnitsError → ShowS Source # show ∷ ExUnitsError → String Source # showList ∷ [ExUnitsError] → ShowS Source #

_Phase1Error ∷ Prism' ExUnitsError TransactionValidityError Source #

_Phase2Error ∷ Prism' ExUnitsError ScriptExecutionError Source #

data ValidationError Source #

Constructors

VExUnits ExUnitsError
PredicateFailures [CollectError ERA]
ApplyTxFailure (ApplyTxError ERA)

Instances

Instances details

Show ValidationError Source #
Instance details Defined in Convex.MockChain Methods showsPrec ∷ Int → ValidationError → ShowS Source # show ∷ ValidationError → String Source # showList ∷ [ValidationError] → ShowS Source #

_VExUnits ∷ Prism' ValidationError ExUnitsError Source #

_PredicateFailures ∷ Prism' ValidationError [CollectError ERA] Source #

_ApplyTxFailure ∷ Prism' ValidationError (ApplyTxError ERA) Source #

getTxExUnits ∷ NodeParams → UTxO ERA → Tx BabbageEra → Either ExUnitsError (Map ScriptWitnessIndex ExecutionUnits) Source #

Compute the exunits of a transaction

evaluateTx ∷ NodeParams → SlotNo → UTxO ERA → Tx BabbageEra → Either ValidationError [ScriptContext ERA] Source #

Evaluate a transaction, returning all of its script contexts.

applyTransaction ∷ NodeParams → MockChainState → Tx BabbageEra → Either ValidationError (MockChainState, Validated (Tx ERA)) Source #

Plutus scripts

type ScriptContext era = (ShortByteString, Language, [Data era], ExUnits, CostModel) Source #

All the information needed to evaluate a Plutus script: The script itself, the script language, redeemers and datums, execution units required, and the cost model.

fullyAppliedScript ∷ NodeParams → ScriptContext ERA → Either String (Program NamedDeBruijn DefaultUni DefaultFun ()) Source #

Apply the plutus script to all its arguments and return a plutus program

Mockchain implementation

data MockchainError Source #

Constructors

MockchainValidationFailed ValidationError
FailWith String

Instances

Instances details

Show MockchainError Source #
Instance details Defined in Convex.MockChain Methods showsPrec ∷ Int → MockchainError → ShowS Source # show ∷ MockchainError → String Source # showList ∷ [MockchainError] → ShowS Source #

newtype MockchainT m a Source #

Constructors

MockchainT (ReaderT NodeParams (StateT MockChainState (ExceptT MockchainError m)) a)

Instances

Instances details

MonadTrans MockchainT Source #
Instance details Defined in Convex.MockChain Methods lift ∷ Monad m ⇒ m a → MockchainT m a Source #
Monad m ⇒ MonadFail (MockchainT m) Source #
Instance details Defined in Convex.MockChain Methods fail ∷ String → MockchainT m a Source #
MonadIO m ⇒ MonadIO (MockchainT m) Source #
Instance details Defined in Convex.MockChain Methods liftIO ∷ IO a → MockchainT m a Source #
Monad m ⇒ Applicative (MockchainT m) Source #
Instance details Defined in Convex.MockChain Methods pure ∷ a → MockchainT m a Source # (<>) ∷ MockchainT m (a → b) → MockchainT m a → MockchainT m b Source # liftA2 ∷ (a → b → c) → MockchainT m a → MockchainT m b → MockchainT m c Source # (>) ∷ MockchainT m a → MockchainT m b → MockchainT m b Source # (<*) ∷ MockchainT m a → MockchainT m b → MockchainT m a Source #
Functor m ⇒ Functor (MockchainT m) Source #
Instance details Defined in Convex.MockChain Methods fmap ∷ (a → b) → MockchainT m a → MockchainT m b Source # (<$) ∷ a → MockchainT m b → MockchainT m a Source #
Monad m ⇒ Monad (MockchainT m) Source #
Instance details Defined in Convex.MockChain Methods (>>=) ∷ MockchainT m a → (a → MockchainT m b) → MockchainT m b Source # (>>) ∷ MockchainT m a → MockchainT m b → MockchainT m b Source # return ∷ a → MockchainT m a Source #
Monad m ⇒ MonadBlockchain (MockchainT m) Source #
Instance details Defined in Convex.MockChain Methods sendTx ∷ Tx BabbageEra → MockchainT m TxId Source # utxoByTxIn ∷ Set TxIn → MockchainT m (UTxO BabbageEra) Source # queryProtocolParameters ∷ MockchainT m (BundledProtocolParameters BabbageEra) Source # queryStakePools ∷ MockchainT m (Set PoolId) Source # querySystemStart ∷ MockchainT m SystemStart Source # queryEraHistory ∷ MockchainT m (EraHistory CardanoMode) Source # querySlotNo ∷ MockchainT m (SlotNo, SlotLength, UTCTime) Source # networkId ∷ MockchainT m NetworkId Source #
Monad m ⇒ MonadMockchain (MockchainT m) Source #
Instance details Defined in Convex.MockChain Methods modifySlot ∷ (SlotNo → (SlotNo, a)) → MockchainT m a Source # modifyUtxo ∷ (UTxO ERA → (UTxO ERA, a)) → MockchainT m a Source # resolveDatumHash ∷ Hash ScriptData → MockchainT m (Maybe ScriptData) Source #
MonadLog m ⇒ MonadLog (MockchainT m) Source #
Instance details Defined in Convex.MockChain Methods logInfo' ∷ Doc Void → MockchainT m () Source # logWarn' ∷ Doc Void → MockchainT m () Source # logDebug' ∷ Doc Void → MockchainT m () Source #