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

GeniusYield.TxBuilder.Common

Description

Synopsis

data GYTxSkeleton (v ∷ PlutusVersion) = GYTxSkeleton {
- gytxIns ∷ ![GYTxIn v]
- gytxOuts ∷ ![GYTxOut v]
- gytxRefIns ∷ !(GYTxSkeletonRefIns v)
- gytxMint ∷ !(Map (GYBuildScript v) (Map GYTokenName Integer, GYRedeemer))
- gytxWdrls ∷ ![GYTxWdrl v]
- gytxSigs ∷ !(Set GYPubKeyHash)
- gytxCerts ∷ ![GYTxCert v]
- gytxInvalidBefore ∷ !(Maybe GYSlot)
- gytxInvalidAfter ∷ !(Maybe GYSlot)
- gytxMetadata ∷ !(Maybe GYTxMetadata)
- gytxVotingProcedures ∷ !(GYTxSkeletonVotingProcedures v)
- gytxProposalProcedures ∷ !(GYTxSkeletonProposalProcedures v)
}
data GYTxSkeletonRefIns ∷ PlutusVersion → Type where
- GYTxSkeletonRefIns ∷ !(Set GYTxOutRef) → GYTxSkeletonRefIns v
- GYTxSkeletonNoRefIns ∷ GYTxSkeletonRefIns v
data GYTxSkeletonVotingProcedures ∷ PlutusVersion → Type where
- GYTxSkeletonVotingProceduresNone ∷ GYTxSkeletonVotingProcedures v
- GYTxSkeletonVotingProcedures ∷ VersionIsGreaterOrEqual v 'PlutusV3 ⇒ !(GYTxVotingProcedures v) → GYTxSkeletonVotingProcedures v
data GYTxSkeletonProposalProcedures ∷ PlutusVersion → Type where
- GYTxSkeletonProposalProceduresNone ∷ GYTxSkeletonProposalProcedures v
- GYTxSkeletonProposalProcedures ∷ VersionIsGreaterOrEqual v 'PlutusV3 ⇒ ![(GYProposalProcedurePB, GYTxBuildWitness v)] → GYTxSkeletonProposalProcedures v
emptyGYTxSkeleton ∷ GYTxSkeleton v
gyTxSkeletonRefInsToList ∷ GYTxSkeletonRefIns v → [GYTxOutRef]
gyTxSkeletonRefInsSet ∷ GYTxSkeletonRefIns v → Set GYTxOutRef
data GYTxBuildResult
- = GYTxBuildSuccess !(NonEmpty GYTxBody)
- | GYTxBuildPartialSuccess !GYBalancingError !(NonEmpty GYTxBody)
- | GYTxBuildFailure !GYBalancingError
- | GYTxBuildNoInputs
buildTxCore ∷ ∀ m v. (GYTxQueryMonad m, MonadRandom m) ⇒ SystemStart → EraHistory → ApiProtocolParameters → Set PoolId → GYCoinSelectionStrategy → (GYTxBody → GYUTxOs → GYUTxOs) → [GYAddress] → GYAddress → Maybe GYUTxO → GYTxExtraConfiguration v → [GYTxSkeleton v] → m (Either GYBuildTxError GYTxBuildResult)
collateralLovelace ∷ Integer
collateralValue ∷ GYValue
maximumRequiredCollateralLovelace ∷ ApiProtocolParameters → Int → Integer
maximumRequiredCollateralValue ∷ ApiProtocolParameters → Int → GYValue

Documentation

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

gytxIns ∷ ![GYTxIn v]
gytxOuts ∷ ![GYTxOut v]
gytxRefIns ∷ !(GYTxSkeletonRefIns v)
gytxMint ∷ !(Map (GYBuildScript v) (Map GYTokenName Integer, GYRedeemer))
gytxWdrls ∷ ![GYTxWdrl v]
gytxSigs ∷ !(Set GYPubKeyHash)
gytxCerts ∷ ![GYTxCert v]
gytxInvalidBefore ∷ !(Maybe GYSlot)
gytxInvalidAfter ∷ !(Maybe GYSlot)
gytxMetadata ∷ !(Maybe GYTxMetadata)
gytxVotingProcedures ∷ !(GYTxSkeletonVotingProcedures v)
gytxProposalProcedures ∷ !(GYTxSkeletonProposalProcedures v)

Instances

Instances details

Monoid (GYTxSkeleton v) #
Instance details Defined in GeniusYield.TxBuilder.Common Methods mempty ∷ GYTxSkeleton v # mappend ∷ GYTxSkeleton v → GYTxSkeleton v → GYTxSkeleton v # mconcat ∷ [GYTxSkeleton v] → GYTxSkeleton v #
Semigroup (GYTxSkeleton v) #
Instance details Defined in GeniusYield.TxBuilder.Common Methods (<>) ∷ GYTxSkeleton v → GYTxSkeleton v → GYTxSkeleton v # sconcat ∷ NonEmpty (GYTxSkeleton v) → GYTxSkeleton v # stimes ∷ Integral b ⇒ b → GYTxSkeleton v → GYTxSkeleton v #
Show (GYTxSkeleton v) #
Instance details Defined in GeniusYield.TxBuilder.Common Methods showsPrec ∷ Int → GYTxSkeleton v → ShowS # show ∷ GYTxSkeleton v → String # showList ∷ [GYTxSkeleton v] → ShowS #

data GYTxSkeletonRefIns ∷ PlutusVersion → Type where #

Constructors

GYTxSkeletonRefIns ∷ !(Set GYTxOutRef) → GYTxSkeletonRefIns v
GYTxSkeletonNoRefIns ∷ GYTxSkeletonRefIns v

Instances

Instances details

Semigroup (GYTxSkeletonRefIns v) #
Instance details Defined in GeniusYield.TxBuilder.Common Methods (<>) ∷ GYTxSkeletonRefIns v → GYTxSkeletonRefIns v → GYTxSkeletonRefIns v # sconcat ∷ NonEmpty (GYTxSkeletonRefIns v) → GYTxSkeletonRefIns v # stimes ∷ Integral b ⇒ b → GYTxSkeletonRefIns v → GYTxSkeletonRefIns v #
Show (GYTxSkeletonRefIns v) #
Instance details Defined in GeniusYield.TxBuilder.Common Methods showsPrec ∷ Int → GYTxSkeletonRefIns v → ShowS # show ∷ GYTxSkeletonRefIns v → String # showList ∷ [GYTxSkeletonRefIns v] → ShowS #
Eq (GYTxSkeletonRefIns v) #
Instance details Defined in GeniusYield.TxBuilder.Common Methods (==) ∷ GYTxSkeletonRefIns v → GYTxSkeletonRefIns v → Bool # (/=) ∷ GYTxSkeletonRefIns v → GYTxSkeletonRefIns v → Bool #

data GYTxSkeletonVotingProcedures ∷ PlutusVersion → Type where #

Constructors

GYTxSkeletonVotingProceduresNone ∷ GYTxSkeletonVotingProcedures v
GYTxSkeletonVotingProcedures ∷ VersionIsGreaterOrEqual v 'PlutusV3 ⇒ !(GYTxVotingProcedures v) → GYTxSkeletonVotingProcedures v

Instances

Instances details

Semigroup (GYTxSkeletonVotingProcedures v) #
Instance details Defined in GeniusYield.TxBuilder.Common Methods (<>) ∷ GYTxSkeletonVotingProcedures v → GYTxSkeletonVotingProcedures v → GYTxSkeletonVotingProcedures v # sconcat ∷ NonEmpty (GYTxSkeletonVotingProcedures v) → GYTxSkeletonVotingProcedures v # stimes ∷ Integral b ⇒ b → GYTxSkeletonVotingProcedures v → GYTxSkeletonVotingProcedures v #
Show (GYTxSkeletonVotingProcedures v) #
Instance details Defined in GeniusYield.TxBuilder.Common Methods showsPrec ∷ Int → GYTxSkeletonVotingProcedures v → ShowS # show ∷ GYTxSkeletonVotingProcedures v → String # showList ∷ [GYTxSkeletonVotingProcedures v] → ShowS #
Eq (GYTxSkeletonVotingProcedures v) #
Instance details Defined in GeniusYield.TxBuilder.Common Methods (==) ∷ GYTxSkeletonVotingProcedures v → GYTxSkeletonVotingProcedures v → Bool # (/=) ∷ GYTxSkeletonVotingProcedures v → GYTxSkeletonVotingProcedures v → Bool #

data GYTxSkeletonProposalProcedures ∷ PlutusVersion → Type where #

Constructors

GYTxSkeletonProposalProceduresNone ∷ GYTxSkeletonProposalProcedures v
GYTxSkeletonProposalProcedures ∷ VersionIsGreaterOrEqual v 'PlutusV3 ⇒ ![(GYProposalProcedurePB, GYTxBuildWitness v)] → GYTxSkeletonProposalProcedures v

Instances

Instances details

Semigroup (GYTxSkeletonProposalProcedures v) #
Instance details Defined in GeniusYield.TxBuilder.Common Methods (<>) ∷ GYTxSkeletonProposalProcedures v → GYTxSkeletonProposalProcedures v → GYTxSkeletonProposalProcedures v # sconcat ∷ NonEmpty (GYTxSkeletonProposalProcedures v) → GYTxSkeletonProposalProcedures v # stimes ∷ Integral b ⇒ b → GYTxSkeletonProposalProcedures v → GYTxSkeletonProposalProcedures v #
Show (GYTxSkeletonProposalProcedures v) #
Instance details Defined in GeniusYield.TxBuilder.Common Methods showsPrec ∷ Int → GYTxSkeletonProposalProcedures v → ShowS # show ∷ GYTxSkeletonProposalProcedures v → String # showList ∷ [GYTxSkeletonProposalProcedures v] → ShowS #
Eq (GYTxSkeletonProposalProcedures v) #
Instance details Defined in GeniusYield.TxBuilder.Common Methods (==) ∷ GYTxSkeletonProposalProcedures v → GYTxSkeletonProposalProcedures v → Bool # (/=) ∷ GYTxSkeletonProposalProcedures v → GYTxSkeletonProposalProcedures v → Bool #

emptyGYTxSkeleton ∷ GYTxSkeleton v #

gyTxSkeletonRefInsToList ∷ GYTxSkeletonRefIns v → [GYTxOutRef] #

gyTxSkeletonRefInsSet ∷ GYTxSkeletonRefIns v → Set GYTxOutRef #

data GYTxBuildResult #

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 GYTxBody)	All given `GYTxSkeleton`s were successfully built.
GYTxBuildPartialSuccess !GYBalancingError !(NonEmpty GYTxBody)	Some of the given `GYTxSkeleton`s were successfully built, but the rest failed due to _insufficient funds_.
GYTxBuildFailure !GYBalancingError	None of the given `GYTxSkeleton`s could be built due to _insufficient funds_.
GYTxBuildNoInputs	Input did not contain any `GYTxSkeleton`s.

buildTxCore #

Arguments

∷ ∀ m v. (GYTxQueryMonad m, MonadRandom m)
⇒ SystemStart
→ EraHistory
→ ApiProtocolParameters
→ Set PoolId
→ GYCoinSelectionStrategy
→ (GYTxBody → GYUTxOs → GYUTxOs)
→ [GYAddress]
→ GYAddress
→ Maybe GYUTxO	Is `Nothing` if there was no 5 ada collateral returned by browser wallet.
→ GYTxExtraConfiguration v
→ [GYTxSkeleton v]
→ m (Either GYBuildTxError GYTxBuildResult)

The core implementation of GYTxQueryMonad for building GYTxBodys out of one or more GYTxSkeletons.

Peculiarly, this is parameterized on:

An "own utxo update" function, this is meant to govern how the set of known "own utxos" is updated after building a transaction skeleton.

If the user chooses not to update this set, based on the newly created GYTxBody, the same own utxos set will be used for the next transaction in the list (if any). Which may lead to the balancer choosing the same utxo inputs again - resulting in a transaction conflict.

The function recovers successfully built tx skeletons, in case the list contains several of them. See: GYTxBuildResult.

collateralLovelace ∷ Integer #

collateralValue ∷ GYValue #

maximumRequiredCollateralLovelace ∷ ApiProtocolParameters → Int → Integer #

What is the maximum possible collateral requirement as per current protocol parameters?

maximumRequiredCollateralValue ∷ ApiProtocolParameters → Int → GYValue #

See maximumRequiredCollateralLovelace.