| Copyright | (c) 2023 GYELD GMBH |
|---|---|
| License | Apache 2.0 |
| Maintainer | [email protected] |
| Stability | develop |
| Safe Haskell | Safe-Inferred |
| Language | GHC2021 |
GeniusYield.TxBuilder.Class
Description
Synopsis
- class Monad m ⇒ MonadError e (m ∷ Type → Type) | m → e where
- throwError ∷ e → m a
- catchError ∷ m a → (e → m a) → m a
- class Monad m ⇒ MonadRandom (m ∷ Type → Type) where
- getRandomR ∷ Random a ⇒ (a, a) → m a
- getRandom ∷ Random a ⇒ m a
- getRandomRs ∷ Random a ⇒ (a, a) → m [a]
- getRandoms ∷ Random a ⇒ m [a]
- class GYTxQueryMonad m ⇒ GYTxMonad m where
- ownAddresses ∷ m [GYAddress]
- availableUTxOs ∷ m GYUTxOs
- someUTxO ∷ PlutusVersion → m GYTxOutRef
- randSeed ∷ m Int
- class MonadError GYTxMonadException m ⇒ GYTxQueryMonad m where
- networkId ∷ m GYNetworkId
- lookupDatum ∷ GYDatumHash → m (Maybe GYDatum)
- utxoAtTxOutRef ∷ GYTxOutRef → m (Maybe GYUTxO)
- utxoAtTxOutRefWithDatum ∷ GYTxOutRef → m (Maybe (GYUTxO, Maybe GYDatum))
- utxosAtTxOutRefs ∷ [GYTxOutRef] → m GYUTxOs
- utxosAtTxOutRefsWithDatums ∷ [GYTxOutRef] → m [(GYUTxO, Maybe GYDatum)]
- utxosAtAddress ∷ GYAddress → m GYUTxOs
- utxosAtAddresses ∷ [GYAddress] → m GYUTxOs
- utxosAtAddressesWithDatums ∷ [GYAddress] → m [(GYUTxO, Maybe GYDatum)]
- utxoRefsAtAddress ∷ GYAddress → m [GYTxOutRef]
- utxosAtPaymentCredential ∷ GYPaymentCredential → m GYUTxOs
- slotConfig ∷ m GYSlotConfig
- slotOfCurrentBlock ∷ m GYSlot
- logMsg ∷ HasCallStack ⇒ GYLogNamespace → GYLogSeverity → String → m ()
- data GYTxSkeleton (v ∷ PlutusVersion) = GYTxSkeleton {
- gytxIns ∷ ![GYTxIn v]
- gytxOuts ∷ ![GYTxOut v]
- gytxRefIns ∷ !(GYTxSkeletonRefIns v)
- gytxMint ∷ !(Map (GYMintScript v) (Map GYTokenName Integer, GYRedeemer))
- gytxSigs ∷ !(Set GYPubKeyHash)
- gytxInvalidBefore ∷ !(Maybe GYSlot)
- gytxInvalidAfter ∷ !(Maybe GYSlot)
- data GYTxSkeletonRefIns ∷ PlutusVersion → Type where
- gyTxSkeletonRefInsToList ∷ GYTxSkeletonRefIns v → [GYTxOutRef]
- gyTxSkeletonRefInsSet ∷ GYTxSkeletonRefIns v → Set GYTxOutRef
- data RandT g (m ∷ Type → Type) a
- lookupDatum' ∷ GYTxQueryMonad m ⇒ GYDatumHash → m GYDatum
- utxoAtTxOutRef' ∷ GYTxQueryMonad m ⇒ GYTxOutRef → m GYUTxO
- utxoAtTxOutRefWithDatum' ∷ GYTxQueryMonad m ⇒ GYTxOutRef → m (GYUTxO, Maybe GYDatum)
- someUTxOWithoutRefScript ∷ GYTxMonad m ⇒ m GYTxOutRef
- slotToBeginTime ∷ GYTxQueryMonad f ⇒ GYSlot → f GYTime
- slotToEndTime ∷ GYTxQueryMonad f ⇒ GYSlot → f GYTime
- enclosingSlotFromTime ∷ GYTxQueryMonad f ⇒ GYTime → f (Maybe GYSlot)
- enclosingSlotFromTime' ∷ GYTxQueryMonad m ⇒ GYTime → m GYSlot
- scriptAddress ∷ GYTxQueryMonad m ⇒ GYValidator v → m GYAddress
- scriptAddress' ∷ GYTxQueryMonad m ⇒ GYValidatorHash → m GYAddress
- addressFromText' ∷ MonadError GYTxMonadException m ⇒ Text → m GYAddress
- addressFromPlutusM ∷ GYTxQueryMonad m ⇒ Address → m (Either PlutusToCardanoError GYAddress)
- addressFromPlutusHushedM ∷ GYTxQueryMonad m ⇒ Address → m (Maybe GYAddress)
- addressFromPlutus' ∷ GYTxQueryMonad m ⇒ Address → m GYAddress
- addressToPubKeyHash' ∷ MonadError GYTxMonadException m ⇒ GYAddress → m GYPubKeyHash
- addressToPubKeyHashIO ∷ GYAddress → IO GYPubKeyHash
- addressToValidatorHash' ∷ MonadError GYTxMonadException m ⇒ GYAddress → m GYValidatorHash
- addressToValidatorHashIO ∷ GYAddress → IO GYValidatorHash
- valueFromPlutus' ∷ MonadError GYTxMonadException m ⇒ Value → m GYValue
- valueFromPlutusIO ∷ Value → IO GYValue
- makeAssetClass' ∷ MonadError GYTxMonadException m ⇒ Text → Text → m GYAssetClass
- makeAssetClassIO ∷ Text → Text → IO GYAssetClass
- assetClassFromPlutus' ∷ MonadError GYTxMonadException m ⇒ AssetClass → m GYAssetClass
- tokenNameFromPlutus' ∷ MonadError GYTxMonadException m ⇒ TokenName → m GYTokenName
- txOutRefFromPlutus' ∷ MonadError GYTxMonadException m ⇒ TxOutRef → m GYTxOutRef
- datumHashFromPlutus' ∷ MonadError GYTxMonadException m ⇒ DatumHash → m GYDatumHash
- pubKeyHashFromPlutus' ∷ MonadError GYTxMonadException m ⇒ PubKeyHash → m GYPubKeyHash
- advanceSlot' ∷ MonadError GYTxMonadException m ⇒ GYSlot → Natural → m GYSlot
- utxosDatums ∷ ∀ m a. (GYTxQueryMonad m, FromData a) ⇒ GYUTxOs → m (Map GYTxOutRef (GYAddress, GYValue, a))
- utxosDatumsPure ∷ FromData a ⇒ [(GYUTxO, Maybe GYDatum)] → Map GYTxOutRef (GYAddress, GYValue, a)
- utxoDatum ∷ (GYTxQueryMonad m, FromData a) ⇒ GYUTxO → m (Either GYQueryDatumError (GYAddress, GYValue, a))
- utxoDatumHushed ∷ (GYTxQueryMonad m, FromData a) ⇒ GYUTxO → m (Maybe (GYAddress, GYValue, a))
- utxoDatumPureHushed ∷ FromData a ⇒ (GYUTxO, Maybe GYDatum) → Maybe (GYTxOutRef, (GYAddress, GYValue, a))
- utxoDatum' ∷ (GYTxQueryMonad m, FromData a) ⇒ GYUTxO → m (GYAddress, GYValue, a)
- mustHaveInput ∷ GYTxIn v → GYTxSkeleton v
- mustHaveRefInput ∷ VersionIsGreaterOrEqual v 'PlutusV2 ⇒ GYTxOutRef → GYTxSkeleton v
- mustHaveOutput ∷ GYTxOut v → GYTxSkeleton v
- mustHaveOptionalOutput ∷ Maybe (GYTxOut v) → GYTxSkeleton v
- mustMint ∷ GYMintScript v → GYRedeemer → GYTokenName → Integer → GYTxSkeleton v
- mustBeSignedBy ∷ GYPubKeyHash → GYTxSkeleton v
- isInvalidBefore ∷ GYSlot → GYTxSkeleton v
- isInvalidAfter ∷ GYSlot → GYTxSkeleton v
- gyLogDebug' ∷ GYTxQueryMonad m ⇒ GYLogNamespace → String → m ()
- gyLogInfo' ∷ GYTxQueryMonad m ⇒ GYLogNamespace → String → m ()
- gyLogWarning' ∷ GYTxQueryMonad m ⇒ GYLogNamespace → String → m ()
- gyLogError' ∷ GYTxQueryMonad m ⇒ GYLogNamespace → String → m ()
- skeletonToRefScriptsORefs ∷ GYTxSkeleton v → [GYTxOutRef]
Documentation
class Monad m ⇒ MonadError e (m ∷ Type → Type) | m → e where Source #
The strategy of combining computations that can throw exceptions by bypassing bound functions from the point an exception is thrown to the point that it is handled.
Is parameterized over the type of error information and
the monad type constructor.
It is common to use Either StringMonadError class.
You can also define your own error type and/or use a monad type constructor
other than Either StringEither IOErrorMonadError
class.
(If you are using the deprecated Control.Monad.Error or
Control.Monad.Trans.Error, you may also have to define an Error instance.)
Methods
throwError ∷ e → m a Source #
Is used within a monadic computation to begin exception processing.
catchError ∷ m a → (e → m a) → m a Source #
A handler function to handle previous errors and return to normal execution. A common idiom is:
do { action1; action2; action3 } `catchError` handlerwhere the action functions can call throwError.
Note that handler and the do-block must have the same return type.
Instances
class Monad m ⇒ MonadRandom (m ∷ Type → Type) where Source #
With a source of random number supply in hand, the MonadRandom class
allows the programmer to extract random values of a variety of types.
Methods
getRandomR ∷ Random a ⇒ (a, a) → m a Source #
Takes a range (lo,hi) and a random number generator g, and returns a computation that returns a random value uniformly distributed in the closed interval [lo,hi], together with a new generator. It is unspecified what happens if lo>hi. For continuous types there is no requirement that the values lo and hi are ever produced, but they may be, depending on the implementation and the interval.
See randomR for details.
getRandom ∷ Random a ⇒ m a Source #
The same as getRandomR, but using a default range determined by the type:
- For bounded types (instances of
Bounded, such asChar), the range is normally the whole type. - For fractional types, the range is normally the semi-closed interval
[0,1). - For
Integer, the range is (arbitrarily) the range ofInt.
See random for details.
getRandomRs ∷ Random a ⇒ (a, a) → m [a] Source #
Plural variant of getRandomR, producing an infinite list of
random values instead of returning a new generator.
See randomRs for details.
getRandoms ∷ Random a ⇒ m [a] Source #
Instances
class GYTxQueryMonad m ⇒ GYTxMonad m where #
Class of monads for querying monads as a user.
Methods
ownAddresses ∷ m [GYAddress] #
Get your own address(es).
availableUTxOs ∷ m GYUTxOs #
Get available UTxOs that can be operated upon.
someUTxO ∷ PlutusVersion → m GYTxOutRef #
Return some unspend transaction output translatable to the given language corresponding to the script in question.
Note: may or may not return the same value
A seed to inject non-determinism.
Instances
| GYTxMonad GYTxMonadNode # | |
Defined in GeniusYield.TxBuilder.Node | |
| GYTxMonad GYTxMonadRun # | |
Defined in GeniusYield.TxBuilder.Run | |
| GYTxMonad m ⇒ GYTxMonad (RandT g m) # | |
Defined in GeniusYield.TxBuilder.Class Methods ownAddresses ∷ RandT g m [GYAddress] # availableUTxOs ∷ RandT g m GYUTxOs # someUTxO ∷ PlutusVersion → RandT g m GYTxOutRef # | |
| GYTxMonad m ⇒ GYTxMonad (ExceptT GYTxMonadException m) # | |
Defined in GeniusYield.TxBuilder.Class | |
| GYTxMonad m ⇒ GYTxMonad (ReaderT g m) # | |
Defined in GeniusYield.TxBuilder.Class Methods ownAddresses ∷ ReaderT g m [GYAddress] # availableUTxOs ∷ ReaderT g m GYUTxOs # someUTxO ∷ PlutusVersion → ReaderT g m GYTxOutRef # | |
class MonadError GYTxMonadException m ⇒ GYTxQueryMonad m where #
Class of monads for querying chain data.
Minimal complete definition
networkId, lookupDatum, (utxoAtTxOutRef | utxosAtTxOutRefs), (utxosAtAddress | utxosAtAddresses), utxosAtPaymentCredential, slotConfig, slotOfCurrentBlock, logMsg
Methods
networkId ∷ m GYNetworkId #
Get the network id
lookupDatum ∷ GYDatumHash → m (Maybe GYDatum) #
Lookup datum by its hash.
utxoAtTxOutRef ∷ GYTxOutRef → m (Maybe GYUTxO) #
Lookup GYUTxO at GYTxOutRef.
utxoAtTxOutRefWithDatum ∷ GYTxOutRef → m (Maybe (GYUTxO, Maybe GYDatum)) #
Lookup UTxO at GYTxOutRef with an attempt to resolve for datum.
utxosAtTxOutRefs ∷ [GYTxOutRef] → m GYUTxOs #
Lookup GYUTxOs at multiple GYTxOutRefs at once
utxosAtTxOutRefsWithDatums ∷ [GYTxOutRef] → m [(GYUTxO, Maybe GYDatum)] #
Lookup UTxOs at zero or more GYTxOutRef with their datums. This has a default implementation using utxosAtTxOutRefs and lookupDatum but should be overridden for efficiency if provider provides suitable option.
utxosAtAddress ∷ GYAddress → m GYUTxOs #
utxosAtAddresses ∷ [GYAddress] → m GYUTxOs #
utxosAtAddressesWithDatums ∷ [GYAddress] → m [(GYUTxO, Maybe GYDatum)] #
Lookup UTxOs at zero or more GYAddress with their datums. This has a default implementation using utxosAtAddresses and lookupDatum but should be overridden for efficiency if provider provides suitable option.
utxoRefsAtAddress ∷ GYAddress → m [GYTxOutRef] #
Lookup the `[GYTxOutRef]`s at a GYAddress
utxosAtPaymentCredential ∷ GYPaymentCredential → m GYUTxOs #
slotConfig ∷ m GYSlotConfig #
Obtain the slot config for the network.
Implementations using era history to create slot config may raise GYEraSummariesToSlotConfigError.
slotOfCurrentBlock ∷ m GYSlot #
This is expected to give the slot of the latest block. We say "expected" as we cache the result for 5 seconds, that is to say, suppose slot was cached at time T, now if query for current block's slot comes within time duration (T, T + 5), then we'll return the cached slot but if say, query happened at time (T + 5, T + 21) where 21 was taken as an arbitrary number above 5, then we'll query the chain tip and get the slot of the latest block seen by the provider and then store it in our cache, thus new cached value would be served for requests coming within time interval of (T + 21, T + 26).
NOTE: It's behaviour is slightly different, solely for our plutus simple model provider where it actually returns the value of the currentSlot variable maintained inside plutus simple model library.
logMsg ∷ HasCallStack ⇒ GYLogNamespace → GYLogSeverity → String → m () #
Log a message with specified namespace and severity.
Instances
data GYTxSkeleton (v ∷ PlutusVersion) #
Transaction skeleton
Note: let's add fields as we need them.
The parameter v indicates the minimum version of scripts allowed
as inputs.
Constructors
| GYTxSkeleton | |
Fields
| |
Instances
| Monoid (GYTxSkeleton v) # | |
Defined in GeniusYield.TxBuilder.Class Methods mempty ∷ GYTxSkeleton v Source # mappend ∷ GYTxSkeleton v → GYTxSkeleton v → GYTxSkeleton v Source # mconcat ∷ [GYTxSkeleton v] → GYTxSkeleton v Source # | |
| Semigroup (GYTxSkeleton v) # | |
Defined in GeniusYield.TxBuilder.Class Methods (<>) ∷ GYTxSkeleton v → GYTxSkeleton v → GYTxSkeleton v Source # sconcat ∷ NonEmpty (GYTxSkeleton v) → GYTxSkeleton v Source # stimes ∷ Integral b ⇒ b → GYTxSkeleton v → GYTxSkeleton v Source # | |
| Show (GYTxSkeleton v) # | |
Defined in GeniusYield.TxBuilder.Class | |
data GYTxSkeletonRefIns ∷ PlutusVersion → Type where #
Constructors
| GYTxSkeletonRefIns ∷ VersionIsGreaterOrEqual v 'PlutusV2 ⇒ !(Set GYTxOutRef) → GYTxSkeletonRefIns v | |
| GYTxSkeletonNoRefIns ∷ GYTxSkeletonRefIns v |
Instances
| Semigroup (GYTxSkeletonRefIns v) # | |
Defined in GeniusYield.TxBuilder.Class Methods (<>) ∷ GYTxSkeletonRefIns v → GYTxSkeletonRefIns v → GYTxSkeletonRefIns v Source # sconcat ∷ NonEmpty (GYTxSkeletonRefIns v) → GYTxSkeletonRefIns v Source # stimes ∷ Integral b ⇒ b → GYTxSkeletonRefIns v → GYTxSkeletonRefIns v Source # | |
| Show (GYTxSkeletonRefIns v) # | |
Defined in GeniusYield.TxBuilder.Class | |
| Eq (GYTxSkeletonRefIns v) # | |
Defined in GeniusYield.TxBuilder.Class Methods (==) ∷ GYTxSkeletonRefIns v → GYTxSkeletonRefIns v → Bool Source # (/=) ∷ GYTxSkeletonRefIns v → GYTxSkeletonRefIns v → Bool Source # | |
data RandT g (m ∷ Type → Type) a Source #
A random transformer monad parameterized by:
g- The generator.m- The inner monad.
The return function leaves the generator unchanged, while >>= uses the
final generator of the first computation as the initial generator of the
second.
Instances
lookupDatum' ∷ GYTxQueryMonad m ⇒ GYDatumHash → m GYDatum #
A version of lookupDatum that raises GYNoDatumForHash if the datum is not found.
utxoAtTxOutRef' ∷ GYTxQueryMonad m ⇒ GYTxOutRef → m GYUTxO #
A version of utxoAtTxOutRef that raises GYNoUtxoAtRef if the utxo is not found.
utxoAtTxOutRefWithDatum' ∷ GYTxQueryMonad m ⇒ GYTxOutRef → m (GYUTxO, Maybe GYDatum) #
A version of utxoAtTxOutRefWithDatum that raises GYNoUtxoAtRef if the utxo is not found.
someUTxOWithoutRefScript ∷ GYTxMonad m ⇒ m GYTxOutRef #
Returns some UTxO present in wallet which doesn't have reference script.
slotToBeginTime ∷ GYTxQueryMonad f ⇒ GYSlot → f GYTime #
slotToEndTime ∷ GYTxQueryMonad f ⇒ GYSlot → f GYTime #
enclosingSlotFromTime ∷ GYTxQueryMonad f ⇒ GYTime → f (Maybe GYSlot) #
enclosingSlotFromTime' ∷ GYTxQueryMonad m ⇒ GYTime → m GYSlot #
Partial version of enclosingSlotFromTime.
Raises GYTimeUnderflowException if given time is before known system start.
scriptAddress ∷ GYTxQueryMonad m ⇒ GYValidator v → m GYAddress #
Calculate script's address.
scriptAddress' ∷ GYTxQueryMonad m ⇒ GYValidatorHash → m GYAddress #
Calculate script's address.
addressFromText' ∷ MonadError GYTxMonadException m ⇒ Text → m GYAddress #
Parse the bech32 representation of an address into GYAddress in GYTxMonad.
Throw GYConversionException if parsing fails.
addressFromPlutusHushedM ∷ GYTxQueryMonad m ⇒ Address → m (Maybe GYAddress) #
hushed version of addressFromPlutusM.
addressFromPlutus' ∷ GYTxQueryMonad m ⇒ Address → m GYAddress #
Convert a Address to GYAddress in GYTxMonad.
Throw GYConversionException if conversion fails.
addressToPubKeyHash' ∷ MonadError GYTxMonadException m ⇒ GYAddress → m GYPubKeyHash #
Convert GYAddress to GYPubKeyHash in GYTxMonad.
Throw GYConversionException if address is not key-hash one.
addressToValidatorHash' ∷ MonadError GYTxMonadException m ⇒ GYAddress → m GYValidatorHash #
Convert GYAddress to GYValidatorHash in GYTxMonad.
Throw GYConversionException if address is not script-hash one.
valueFromPlutus' ∷ MonadError GYTxMonadException m ⇒ Value → m GYValue #
Convert a Value to GYValue in GYTxMonad.
Throw GYConversionException if conversion fails.
valueFromPlutusIO ∷ Value → IO GYValue #
Convert a Value to GYValue in IO.
Throw GYConversionException if conversion fails.
makeAssetClass' ∷ MonadError GYTxMonadException m ⇒ Text → Text → m GYAssetClass #
Create a GYAssetClass from the textual representation of currency symbol and token name in GYTxMonad.
Throw GYConversionException if conversion fails.
makeAssetClassIO ∷ Text → Text → IO GYAssetClass #
makeAssetClass' in the IO monad.
Throw GYConversionException if conversion fails.
assetClassFromPlutus' ∷ MonadError GYTxMonadException m ⇒ AssetClass → m GYAssetClass #
Convert a AssetClass to GYAssetClass in GYTxMonad.
Throw GYConversionException if conversion fails.
tokenNameFromPlutus' ∷ MonadError GYTxMonadException m ⇒ TokenName → m GYTokenName #
Convert a TokenName to GYTokenName in GYTxMonad.
Throw GYConversionException if conversion fails.
txOutRefFromPlutus' ∷ MonadError GYTxMonadException m ⇒ TxOutRef → m GYTxOutRef #
Convert a TxOutRef to GYTxOutRef in GYTxMonad.
Throw GYConversionException if conversion fails.
datumHashFromPlutus' ∷ MonadError GYTxMonadException m ⇒ DatumHash → m GYDatumHash #
Convert a DatumHash to GYDatumHash in GYTxMonad.
Throw GYConversionException if conversion fails.
pubKeyHashFromPlutus' ∷ MonadError GYTxMonadException m ⇒ PubKeyHash → m GYPubKeyHash #
Convert a PubKeyHash to GYPubKeyHash in GYTxMonad.
Throw GYConversionException if conversion fails.
advanceSlot' ∷ MonadError GYTxMonadException m ⇒ GYSlot → Natural → m GYSlot #
Advance GYSlot forward in GYTxMonad. If slot value overflows, throw GYSlotOverflowException.
utxosDatums ∷ ∀ m a. (GYTxQueryMonad m, FromData a) ⇒ GYUTxOs → m (Map GYTxOutRef (GYAddress, GYValue, a)) #
utxosDatumsPure ∷ FromData a ⇒ [(GYUTxO, Maybe GYDatum)] → Map GYTxOutRef (GYAddress, GYValue, a) #
Pure variant of utxosDatums.
utxoDatum ∷ (GYTxQueryMonad m, FromData a) ⇒ GYUTxO → m (Either GYQueryDatumError (GYAddress, GYValue, a)) #
utxoDatumHushed ∷ (GYTxQueryMonad m, FromData a) ⇒ GYUTxO → m (Maybe (GYAddress, GYValue, a)) #
utxoDatumPureHushed ∷ FromData a ⇒ (GYUTxO, Maybe GYDatum) → Maybe (GYTxOutRef, (GYAddress, GYValue, a)) #
Obtain original datum representation of an UTxO.
utxoDatum' ∷ (GYTxQueryMonad m, FromData a) ⇒ GYUTxO → m (GYAddress, GYValue, a) #
Version of utxoDatum that throws GYTxMonadException.
mustHaveInput ∷ GYTxIn v → GYTxSkeleton v #
mustHaveOutput ∷ GYTxOut v → GYTxSkeleton v #
mustHaveOptionalOutput ∷ Maybe (GYTxOut v) → GYTxSkeleton v #
mustMint ∷ GYMintScript v → GYRedeemer → GYTokenName → Integer → GYTxSkeleton v #
isInvalidBefore ∷ GYSlot → GYTxSkeleton v #
isInvalidAfter ∷ GYSlot → GYTxSkeleton v #
gyLogDebug' ∷ GYTxQueryMonad m ⇒ GYLogNamespace → String → m () #
gyLogInfo' ∷ GYTxQueryMonad m ⇒ GYLogNamespace → String → m () #
gyLogWarning' ∷ GYTxQueryMonad m ⇒ GYLogNamespace → String → m () #
gyLogError' ∷ GYTxQueryMonad m ⇒ GYLogNamespace → String → m () #
skeletonToRefScriptsORefs ∷ GYTxSkeleton v → [GYTxOutRef] #
Given a skeleton, returns a list of reference to reference script UTxOs which are present as witness.