Copyright	(c) 2023 GYELD GMBH
License	Apache 2.0
Maintainer	[email protected]
Stability	develop
Safe Haskell	Safe-Inferred
Language	GHC2021

GeniusYield.TxBuilder.Node

Description

Synopsis

data GYTxMonadNode a
data GYTxBuildResult f
- = GYTxBuildSuccess !(NonEmpty (f GYTxBody))
- | GYTxBuildPartialSuccess !GYValue !(NonEmpty (f GYTxBody))
- | GYTxBuildFailure !GYValue
- | GYTxBuildNoInputs
runGYTxMonadNode ∷ GYNetworkId → GYProviders → [GYAddress] → GYAddress → Maybe (GYTxOutRef, Bool) → GYTxMonadNode (GYTxSkeleton v) → IO GYTxBody
runGYTxMonadNodeC ∷ ∀ a. GYNetworkId → GYProviders → [GYAddress] → GYAddress → Maybe (GYTxOutRef, Bool) → GYTxMonadNode a → IO a
runGYTxMonadNodeF ∷ ∀ f v. Traversable f ⇒ GYCoinSelectionStrategy → GYNetworkId → GYProviders → [GYAddress] → GYAddress → Maybe (GYTxOutRef, Bool) → GYTxMonadNode (f (GYTxSkeleton v)) → IO (f GYTxBody)
runGYTxMonadNodeParallel ∷ GYNetworkId → GYProviders → [GYAddress] → GYAddress → Maybe (GYTxOutRef, Bool) → GYTxMonadNode [GYTxSkeleton v] → IO (GYTxBuildResult Identity)
runGYTxMonadNodeParallelWithStrategy ∷ GYCoinSelectionStrategy → GYNetworkId → GYProviders → [GYAddress] → GYAddress → Maybe (GYTxOutRef, Bool) → GYTxMonadNode [GYTxSkeleton v] → IO (GYTxBuildResult Identity)
runGYTxMonadNodeParallelF ∷ Traversable f ⇒ GYCoinSelectionStrategy → GYNetworkId → GYProviders → [GYAddress] → GYAddress → Maybe (GYTxOutRef, Bool) → GYTxMonadNode [f (GYTxSkeleton v)] → IO (GYTxBuildResult f)
runGYTxMonadNodeChaining ∷ GYNetworkId → GYProviders → [GYAddress] → GYAddress → Maybe (GYTxOutRef, Bool) → GYTxMonadNode [GYTxSkeleton v] → IO (GYTxBuildResult Identity)
runGYTxMonadNodeChainingF ∷ Traversable f ⇒ GYCoinSelectionStrategy → GYNetworkId → GYProviders → [GYAddress] → GYAddress → Maybe (GYTxOutRef, Bool) → GYTxMonadNode [f (GYTxSkeleton v)] → IO (GYTxBuildResult f)

Documentation

data GYTxMonadNode a #

GYTxMonad interpretation run against real node.

Instances

Instances details

MonadRandom GYTxMonadNode #
Instance details Defined in GeniusYield.TxBuilder.Node Methods getRandomR ∷ Random a ⇒ (a, a) → GYTxMonadNode a Source # getRandom ∷ Random a ⇒ GYTxMonadNode a Source # getRandomRs ∷ Random a ⇒ (a, a) → GYTxMonadNode [a] Source # getRandoms ∷ Random a ⇒ GYTxMonadNode [a] Source #
GYTxMonad GYTxMonadNode #
Instance details Defined in GeniusYield.TxBuilder.Node Methods ownAddresses ∷ GYTxMonadNode [GYAddress] # availableUTxOs ∷ GYTxMonadNode GYUTxOs # someUTxO ∷ PlutusVersion → GYTxMonadNode GYTxOutRef # randSeed ∷ GYTxMonadNode Int #
GYTxQueryMonad GYTxMonadNode #
Instance details Defined in GeniusYield.TxBuilder.Node Methods networkId ∷ GYTxMonadNode GYNetworkId # lookupDatum ∷ GYDatumHash → GYTxMonadNode (Maybe GYDatum) # utxoAtTxOutRef ∷ GYTxOutRef → GYTxMonadNode (Maybe GYUTxO) # utxoAtTxOutRefWithDatum ∷ GYTxOutRef → GYTxMonadNode (Maybe (GYUTxO, Maybe GYDatum)) # utxosAtTxOutRefs ∷ [GYTxOutRef] → GYTxMonadNode GYUTxOs # utxosAtTxOutRefsWithDatums ∷ [GYTxOutRef] → GYTxMonadNode [(GYUTxO, Maybe GYDatum)] # utxosAtAddress ∷ GYAddress → Maybe GYAssetClass → GYTxMonadNode GYUTxOs # utxosAtAddressWithDatums ∷ GYAddress → Maybe GYAssetClass → GYTxMonadNode [(GYUTxO, Maybe GYDatum)] # utxosAtAddresses ∷ [GYAddress] → GYTxMonadNode GYUTxOs # utxosAtAddressesWithDatums ∷ [GYAddress] → GYTxMonadNode [(GYUTxO, Maybe GYDatum)] # utxoRefsAtAddress ∷ GYAddress → GYTxMonadNode [GYTxOutRef] # utxosAtPaymentCredential ∷ GYPaymentCredential → GYTxMonadNode GYUTxOs # utxosAtPaymentCredentialWithDatums ∷ GYPaymentCredential → GYTxMonadNode [(GYUTxO, Maybe GYDatum)] # slotConfig ∷ GYTxMonadNode GYSlotConfig # slotOfCurrentBlock ∷ GYTxMonadNode GYSlot # logMsg ∷ GYLogNamespace → GYLogSeverity → String → GYTxMonadNode () #
MonadIO GYTxMonadNode #
Instance details Defined in GeniusYield.TxBuilder.Node Methods liftIO ∷ IO a → GYTxMonadNode a Source #
Applicative GYTxMonadNode #
Instance details Defined in GeniusYield.TxBuilder.Node Methods pure ∷ a → GYTxMonadNode a Source # (<>) ∷ GYTxMonadNode (a → b) → GYTxMonadNode a → GYTxMonadNode b Source # liftA2 ∷ (a → b → c) → GYTxMonadNode a → GYTxMonadNode b → GYTxMonadNode c Source # (>) ∷ GYTxMonadNode a → GYTxMonadNode b → GYTxMonadNode b Source # (<*) ∷ GYTxMonadNode a → GYTxMonadNode b → GYTxMonadNode a Source #
Functor GYTxMonadNode #
Instance details Defined in GeniusYield.TxBuilder.Node Methods fmap ∷ (a → b) → GYTxMonadNode a → GYTxMonadNode b Source # (<$) ∷ a → GYTxMonadNode b → GYTxMonadNode a Source #
Monad GYTxMonadNode #
Instance details Defined in GeniusYield.TxBuilder.Node Methods (>>=) ∷ GYTxMonadNode a → (a → GYTxMonadNode b) → GYTxMonadNode b Source # (>>) ∷ GYTxMonadNode a → GYTxMonadNode b → GYTxMonadNode b Source # return ∷ a → GYTxMonadNode a Source #
MonadError GYTxMonadException GYTxMonadNode #
Instance details Defined in GeniusYield.TxBuilder.Node Methods throwError ∷ GYTxMonadException → GYTxMonadNode a Source # catchError ∷ GYTxMonadNode a → (GYTxMonadException → GYTxMonadNode a) → GYTxMonadNode a Source #

data GYTxBuildResult f #

Result of building GYTxBodys with the option of recovery from error.

Consider the act of building five GYTxSkeletons into GYTxBodys. If three out of the five succeed, but the next one fails due to insufficient funds - this type facilitates recovering the three rather than failing outright and discarding the results.

Constructors

GYTxBuildSuccess !(NonEmpty (f GYTxBody))	All given `GYTxSkeleton`s were successfully built.
GYTxBuildPartialSuccess !GYValue !(NonEmpty (f GYTxBody))	Some of the given `GYTxSkeleton`s were successfully built, but the rest failed due to _insufficient funds_.
GYTxBuildFailure !GYValue	None of the given `GYTxSkeleton`s could be built due to _insufficient funds_.
GYTxBuildNoInputs	Input did not contain any `GYTxSkeleton`s.

runGYTxMonadNode #

Arguments

∷ GYNetworkId	Network ID.
→ GYProviders	Provider.
→ [GYAddress]	Addresses belonging to wallet.
→ GYAddress	Change address.
→ Maybe (GYTxOutRef, Bool)	If `Nothing` is provided, framework would pick up a suitable UTxO as collateral and in such case is also free to spend it. If something is given with boolean being `False` then framework will use the given `GYTxOutRef` as collateral and would reserve it as well. But if boolean is `True`, framework would only use it as collateral and reserve it, if value in the given UTxO is exactly 5 ada.
→ GYTxMonadNode (GYTxSkeleton v)	Skeleton.
→ IO GYTxBody

runGYTxMonadNodeC #

Arguments

∷ ∀ a. GYNetworkId	Network ID.
→ GYProviders	Provider.
→ [GYAddress]	Addresses belonging to wallet.
→ GYAddress	Change address.
→ Maybe (GYTxOutRef, Bool)	If `Nothing` is provided, framework would pick up a suitable UTxO as collateral and in such case is also free to spend it. If something is given with boolean being `False` then framework will use the given `GYTxOutRef` as collateral and would reserve it as well. But if boolean is `True`, framework would only use it as collateral and reserve it, if value in the given UTxO is exactly 5 ada.
→ GYTxMonadNode a	When we don't want to build a skeleton.
→ IO a

runGYTxMonadNodeF #

Arguments

∷ ∀ f v. Traversable f
⇒ GYCoinSelectionStrategy	Coin selection strategy.
→ GYNetworkId	Network ID.
→ GYProviders	Provider.
→ [GYAddress]	Addresses belonging to wallet.
→ GYAddress	Change address.
→ Maybe (GYTxOutRef, Bool)	If `Nothing` is provided, framework would pick up a suitable UTxO as collateral and in such case is also free to spend it. If something is given with boolean being `False` then framework will use the given `GYTxOutRef` as collateral and would reserve it as well. But if boolean is `True`, framework would only use it as collateral and reserve it, if value in the given UTxO is exactly 5 ada.
→ GYTxMonadNode (f (GYTxSkeleton v))	Skeleton(s).
→ IO (f GYTxBody)

The most basic version of GYTxMonadNode interpreter over a generic Traversable.

NOTE ==

This is not meant to be used with structures containing _multiple_ GYTxSkeletons. As the balancer will end up using the same utxos across the different txs.

Consider using runGYTxMonadNodeParallel or runGYTxMonadNodeChaining instead.

runGYTxMonadNodeParallel #

Arguments

∷ GYNetworkId	Network ID.
→ GYProviders	Provider.
→ [GYAddress]	Addresses belonging to wallet.
→ GYAddress	Change address.
→ Maybe (GYTxOutRef, Bool)	If `Nothing` is provided, framework would pick up a suitable UTxO as collateral and in such case is also free to spend it. If something is given with boolean being `False` then framework will use the given `GYTxOutRef` as collateral and would reserve it as well. But if boolean is `True`, framework would only use it as collateral and reserve it, if value in the given UTxO is exactly 5 ada.
→ GYTxMonadNode [GYTxSkeleton v]	Skeleton(s).
→ IO (GYTxBuildResult Identity)

runGYTxMonadNodeParallelWithStrategy #

Arguments

∷ GYCoinSelectionStrategy	Coin selection strategy.
→ GYNetworkId	Network ID.
→ GYProviders	Provider.
→ [GYAddress]	Addresses belonging to wallet.
→ GYAddress	Change address.
→ Maybe (GYTxOutRef, Bool)	If `Nothing` is provided, framework would pick up a suitable UTxO as collateral and in such case is also free to spend it. If something is given with boolean being `False` then framework will use the given `GYTxOutRef` as collateral and would reserve it as well. But if boolean is `True`, framework would only use it as collateral and reserve it, if value in the given UTxO is exactly 5 ada.
→ GYTxMonadNode [GYTxSkeleton v]	Skeleton(s).
→ IO (GYTxBuildResult Identity)

runGYTxMonadNodeParallelF #

Arguments

∷ Traversable f
⇒ GYCoinSelectionStrategy	Coin selection strategy.
→ GYNetworkId	Network ID.
→ GYProviders	Provider.
→ [GYAddress]	Addresses belonging to wallet.
→ GYAddress	Change address.
→ Maybe (GYTxOutRef, Bool)	If `Nothing` is provided, framework would pick up a suitable UTxO as collateral and in such case is also free to spend it. If something is given with boolean being `False` then framework will use the given `GYTxOutRef` as collateral and would reserve it as well. But if boolean is `True`, framework would only use it as collateral and reserve it, if value in the given UTxO is exactly 5 ada.
→ GYTxMonadNode [f (GYTxSkeleton v)]	Skeleton(s).
→ IO (GYTxBuildResult f)

A multi transaction building GYTxMonadNode interpreter.

This does not perform chaining, i.e does not use utxos created by one of the given transactions in the next one. However, it does ensure that the balancer does not end up using the same own utxos when building multiple transactions at once.

This supports failure recovery by utilizing GYTxBuildResult.

runGYTxMonadNodeChaining #

Arguments

∷ GYNetworkId	Network ID.
→ GYProviders	Provider.
→ [GYAddress]	Addresses belonging to wallet.
→ GYAddress	Change address.
→ Maybe (GYTxOutRef, Bool)	If `Nothing` is provided, framework would pick up a suitable UTxO as collateral and in such case is also free to spend it. If something is given with boolean being `False` then framework will use the given `GYTxOutRef` as collateral and would reserve it as well. But if boolean is `True`, framework would only use it as collateral and reserve it, if value in the given UTxO is exactly 5 ada.
→ GYTxMonadNode [GYTxSkeleton v]	Skeleton(s).
→ IO (GYTxBuildResult Identity)

runGYTxMonadNodeChainingF #

Arguments

∷ Traversable f
⇒ GYCoinSelectionStrategy	Coin selection strategy.
→ GYNetworkId	Network ID.
→ GYProviders	Provider.
→ [GYAddress]	Addresses belonging to wallet.
→ GYAddress	Change address.
→ Maybe (GYTxOutRef, Bool)	If `Nothing` is provided, framework would pick up a suitable UTxO as collateral and in such case is also free to spend it. If something is given with boolean being `False` then framework will use the given `GYTxOutRef` as collateral and would reserve it as well. But if boolean is `True`, framework would only use it as collateral and reserve it, if value in the given UTxO is exactly 5 ada.
→ GYTxMonadNode [f (GYTxSkeleton v)]	Skeleton(s).
→ IO (GYTxBuildResult f)

A chaining transaction building GYTxMonadNode interpreter.

This will perform chaining, i.e it will use utxos created by one of the given transactions, when building the next one.

This supports failure recovery by utilizing GYTxBuildResult.

*EXPERIMENTAL**