Documentation

Errors that can arise during transaction generation

Errors that can be produced by the blockchain

This represents the specific events that should be logged when processing transactions. If a new kind of event arises, then a new constructor should be provided here.

This is the first layer of our blockchain, which provides the minimal subset of primitives required to perform balancing.

This is the second layer of our block, which provides all the other blockchain primitives not needed for balancing, except transaction validation. This layers is the one where Tweaks are plugged to.

The final layer of our blockchain, adding transaction validation to the mix. This is the only primitive that actually modifies the ledger state.

A newtype wrapper to be used with '-XDerivingVia' to derive instances of MonadBlockChain for any MonadTransControl.

For example, to derive 'MonadBlockChain m => MonadBlockChain (ReaderT r m)', you'd write

deriving via (AsTrans (ReaderT r) m) instance MonadBlockChain m => MonadBlockChain (ReaderT r m)

and avoid the trouble of defining all the class methods yourself.

Returns the closed ms interval corresponding to the current slot

Moves n slots fowards

Retrieves the ordered list of outputs of the given CardanoTx.

This is useful when writing endpoints and/or traces to fetch utxos of interest right from the start and avoid querying the chain for them afterwards using allUtxos or similar functions.

Like datumFromTxOutRef, but uses fromBuiltinData to attempt to deserialize this datum into a given type

Resolves an TxOutRef and extracts the value it contains

Extracts a potential OutputDatum from a given TxOutRef

Extracts a potential Datum from a given TxOutRef

Try to resolve the datum on the output: If there's an inline datum, take that; if there's a datum hash, look the corresponding datum up (with datumFromHash), returning Nothing if it can't be found; if there's no datum or hash at all, return Nothing.

Like resolveDatum, but also tries to use fromBuiltinData to extract a datum of the suitable type.

Tries to resolve the validator that owns an output: If the output is owned by a public key, or if the validator's hash is not known (i.e. if scriptFromHash returns Nothing) return Nothing.

Tries to resolve the reference script on an output: If the output has no reference script, or if the reference script's hash is not known (i.e. if scriptFromHash returns Nothing), this function will return Nothing.

Return the slot that contains the given time. See slotToTimeInterval for some satisfied equational properties.

Waits until the current slot becomes greater or equal to the slot containing the given POSIX time. Note that that it might not wait for anything if the current slot is large enough.

Wait a given number of ms from the lower bound of the current slot and returns the current slot after waiting.

Wait a given number of ms from the upper bound of the current slot and returns the current slot after waiting.

The infinite range of slots ending before or at the given time

The infinite range of slots starting after or at the given time

Returns the closed ms interval corresponding to the slot with the given number. It holds that

slotToTimeInterval (getEnclosingSlot t) == (a, b)    ==>   a <= t <= b

and

slotToTimeInterval n == (a, b)   ==>   getEnclosingSlot a == n && getEnclosingSlot b == n

and

slotToTimeInterval n == (a, b)   ==>   getEnclosingSlot (a-1) == n-1 && getEnclosingSlot (b+1) == n+1

Resolves all the inputs of a given TxSkel

Resolves all the reference inputs of a given TxSkel

Returns all validators which protect transaction inputs

look up the UTxOs the transaction consumes, and sum their values.

Looks up the data on UTxOs the transaction consumes and returns their hashes.

Go through all of the TxOutRefs in the list and look them up in the state of the blockchain, throwing an error if one of them cannot be resolved.

Validates a skeleton, and retuns the ordered list of produced output references

Validates a skeleton, and erases the outputs

Retrieves the total amount of lovelace deposited in proposals in this skeleton (equal to govActionDeposit times the number of proposals).

Retrieves the required deposit amount for issuing governance actions.

This creates a payment from an existing UTXO

A default version of txOutRefToTxSkelOut where we both include the datum in the transaction if it was hashed in the TxOut, and allow further ADA adjustment in case changes in the output require it.

Like define, but binds the result of a monadic computation instead