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

GeniusYield.Transaction.CoinSelection

Description

Synopsis

data GYBalancedTx v = GYBalancedTx {
- gybtxIns ∷ ![GYTxInDetailed v]
- gybtxCollaterals ∷ !GYUTxOs
- gybtxOuts ∷ ![GYTxOut v]
- gybtxMint ∷ !(Maybe (GYValue, [(GYMintScript v, GYRedeemer)]))
- gybtxWdrls ∷ ![GYTxWdrl v]
- gybtxCerts ∷ ![GYTxCert' v]
- gybtxInvalidBefore ∷ !(Maybe GYSlot)
- gybtxInvalidAfter ∷ !(Maybe GYSlot)
- gybtxSigners ∷ !(Set GYPubKeyHash)
- gybtxRefIns ∷ !GYUTxOs
- gybtxMetadata ∷ !(Maybe GYTxMetadata)
}
data GYTxInDetailed v = GYTxInDetailed {
- gyTxInDet ∷ !(GYTxIn v)
- gyTxInDetAddress ∷ !GYAddress
- gyTxInDetValue ∷ !GYValue
- gyTxInDetDatum ∷ !GYOutDatum
- gyTxInDetScriptRef ∷ !(Maybe GYAnyScript)
}
data GYCoinSelectionEnv v = GYCoinSelectionEnv {
- existingInputs ∷ ![GYTxInDetailed v]
- requiredOutputs ∷ ![(GYAddress, GYValue)]
- mintValue ∷ !GYValue
- changeAddr ∷ GYAddress
- ownUtxos ∷ !GYUTxOs
- extraLovelace ∷ !Natural
- minimumUTxOF ∷ GYTxOut v → Natural
- maxValueSize ∷ Natural
- adaSource ∷ Natural
- adaSink ∷ Natural
}
data GYCoinSelectionStrategy
selectInputs ∷ ∀ m v. MonadRandom m ⇒ GYCoinSelectionEnv v → GYCoinSelectionStrategy → ExceptT GYBalancingError m ([GYTxInDetailed v], [GYTxOut v])

Documentation

data GYBalancedTx v #

An *almost* finalized Tx.

This is fully balanced _except_ potentially missing an ada change output, and missing the exact fee. Both of these will be set by finalizeGYBalancedTx.

Constructors

GYBalancedTx

Fields

gybtxIns ∷ ![GYTxInDetailed v]
gybtxCollaterals ∷ !GYUTxOs
gybtxOuts ∷ ![GYTxOut v]
gybtxMint ∷ !(Maybe (GYValue, [(GYMintScript v, GYRedeemer)]))
gybtxWdrls ∷ ![GYTxWdrl v]
gybtxCerts ∷ ![GYTxCert' v]
gybtxInvalidBefore ∷ !(Maybe GYSlot)
gybtxInvalidAfter ∷ !(Maybe GYSlot)
gybtxSigners ∷ !(Set GYPubKeyHash)
gybtxRefIns ∷ !GYUTxOs
gybtxMetadata ∷ !(Maybe GYTxMetadata)

data GYTxInDetailed v #

A further detailed version of GYTxIn, containing all information about a UTxO.

Constructors

GYTxInDetailed
Fields gyTxInDet ∷ !(GYTxIn v) gyTxInDetAddress ∷ !GYAddress gyTxInDetValue ∷ !GYValue gyTxInDetDatum ∷ !GYOutDatum gyTxInDetScriptRef ∷ !(Maybe GYAnyScript)

Instances

Instances details

Show (GYTxInDetailed v) #
Instance details Defined in GeniusYield.Transaction.Common Methods showsPrec ∷ Int → GYTxInDetailed v → ShowS # show ∷ GYTxInDetailed v → String # showList ∷ [GYTxInDetailed v] → ShowS #
Eq (GYTxInDetailed v) #
Instance details Defined in GeniusYield.Transaction.Common Methods (==) ∷ GYTxInDetailed v → GYTxInDetailed v → Bool # (/=) ∷ GYTxInDetailed v → GYTxInDetailed v → Bool #

data GYCoinSelectionEnv v #

Constructors

GYCoinSelectionEnv

Fields

existingInputs ∷ ![GYTxInDetailed v]
List of existing inputs that must be used.
requiredOutputs ∷ ![(GYAddress, GYValue)]
Outputs to pay for.
mintValue ∷ !GYValue
Value minted in the transaction.
changeAddr ∷ GYAddress
Address where change outputs will be sent to.
ownUtxos ∷ !GYUTxOs
Set of own utxos to select additional inputs from.
extraLovelace ∷ !Natural
Extra lovelace to look for on top of outputs, mainly for fee and any remaining would be given as change output by makeTransactionBodyAutoBalance, thus amount remaining besides fees, should satisfy minimum ada requirement else we would have to increase extraLovelace parameter.
minimumUTxOF ∷ GYTxOut v → Natural
maxValueSize ∷ Natural
adaSource ∷ Natural
adaSink ∷ Natural

data GYCoinSelectionStrategy #

Constructors

GYLargestFirstMultiAsset
GYRandomImproveMultiAsset
GYLegacy

Instances

Instances details

Bounded GYCoinSelectionStrategy #
Instance details Defined in GeniusYield.Transaction.CoinSelection Methods minBound ∷ GYCoinSelectionStrategy # maxBound ∷ GYCoinSelectionStrategy #
Enum GYCoinSelectionStrategy #
Instance details Defined in GeniusYield.Transaction.CoinSelection Methods succ ∷ GYCoinSelectionStrategy → GYCoinSelectionStrategy # pred ∷ GYCoinSelectionStrategy → GYCoinSelectionStrategy # toEnum ∷ Int → GYCoinSelectionStrategy # fromEnum ∷ GYCoinSelectionStrategy → Int # enumFrom ∷ GYCoinSelectionStrategy → [GYCoinSelectionStrategy] # enumFromThen ∷ GYCoinSelectionStrategy → GYCoinSelectionStrategy → [GYCoinSelectionStrategy] # enumFromTo ∷ GYCoinSelectionStrategy → GYCoinSelectionStrategy → [GYCoinSelectionStrategy] # enumFromThenTo ∷ GYCoinSelectionStrategy → GYCoinSelectionStrategy → GYCoinSelectionStrategy → [GYCoinSelectionStrategy] #
Show GYCoinSelectionStrategy #
Instance details Defined in GeniusYield.Transaction.CoinSelection Methods showsPrec ∷ Int → GYCoinSelectionStrategy → ShowS # show ∷ GYCoinSelectionStrategy → String # showList ∷ [GYCoinSelectionStrategy] → ShowS #
Default GYCoinSelectionStrategy #
Instance details Defined in GeniusYield.Transaction.CoinSelection Methods def ∷ GYCoinSelectionStrategy #
Eq GYCoinSelectionStrategy #
Instance details Defined in GeniusYield.Transaction.CoinSelection Methods (==) ∷ GYCoinSelectionStrategy → GYCoinSelectionStrategy → Bool # (/=) ∷ GYCoinSelectionStrategy → GYCoinSelectionStrategy → Bool #

selectInputs ∷ ∀ m v. MonadRandom m ⇒ GYCoinSelectionEnv v → GYCoinSelectionStrategy → ExceptT GYBalancingError m ([GYTxInDetailed v], [GYTxOut v]) #

Select additional inputs from the set of own utxos given, such that when combined with given existing inputs, they cover for all the given outputs, as well as extraLovelace.

Return the list of additional inputs chosen and the change outputs created.

Invariant ==

The ownUtxos and requiredOutputs arguments passed must contain non negative GYValues, with each one containing a positive amount of ada.