Contract.BalanceTxConstraints

type UtxoPredicate = TransactionInput -> TransactionOutput -> Boolean

newtype BalancerConstraints

Constructors

• BalancerConstraints (BalancerConfig -> BalancerConfig)

Instances

• Newtype BalancerConstraints _
• Semigroup BalancerConstraints
• Monoid BalancerConstraints

newtype BalancerConfig

Constructors

• BalancerConfig { additionalUtxos :: UtxoMap, changeAddress :: Maybe Address, changeDatum :: Maybe OutputDatum, collateralUtxos :: Maybe UtxoMap, maxChangeOutputTokenQuantity :: Maybe BigInt, nonSpendableInputs :: Set TransactionInput, nonSpendableInputsPredicates :: Array UtxoPredicate, selectionStrategy :: SelectionStrategy, srcAddresses :: Maybe (Array Address) }

Instances

• Newtype BalancerConfig _

type BalanceTxConstraintsBuilder = BalancerConstraints

mustUseUtxosAtAddresses :: Array Address -> BalancerConstraints

Tells the balancer to use UTxO's at given addresses. If this constraint is not set, then the default addresses owned by the wallet are used.

NOTE: Setting mustUseUtxosAtAddresses or mustUseUtxosAtAddress does NOT have any effect on which address will be used as a change address.

mustUseUtxosAtAddress :: Address -> BalancerConstraints

Tells the balancer to use UTxO's at a given address. If this constraint is not set, then the default addresses owned by the wallet are used.

NOTE: Setting mustUseUtxosAtAddresses or mustUseUtxosAtAddress does NOT have any effect on which address will be used as a change address.

mustUseCollateralUtxos :: UtxoMap -> BalancerConstraints

Tells the balancer to select from the provided UTxO set when choosing collateral UTxOs, instead of UTxOs provided by the browser wallet.

Note that:

1. Locked utxos, utxos marked as non-spendable, utxos used as reference (read-only) inputs, or otherwise non-spendable utxos will be excluded from collateral selection, even when specified via this constraint.

2. Any utxos specified by this constraint will not be considered during balancing to cover transaction outputs.

mustUseCoinSelectionStrategy :: SelectionStrategy -> BalancerConstraints

Tells the balancer to use the given strategy for coin selection.

mustUseAdditionalUtxos :: UtxoMap -> BalancerConstraints

Tells the balancer to use the provided UTxO set when evaluating script execution units (sets additionalUtxoSet of Ogmios EvaluateTx). Note that you need to use unspentOutputs lookup to make these UTxO's spendable by the transaction (see Examples.TxChaining for reference).

mustSendChangeWithDatum :: OutputDatum -> BalancerConstraints

Tells the balancer to include the datum in each change UTxO. Useful when balancing a transactions for script owned UTxOs.

mustSendChangeToAddress :: Address -> BalancerConstraints

Tells the balancer to send all generated change to a given address. If this constraint is not set, then the default change address owned by the wallet is used.

NOTE: Setting mustUseUtxosAtAddresses or mustUseUtxosAtAddress does NOT have any effect on which address will be used as a change address.

mustNotSpendUtxosWithOutRefs :: Set TransactionInput -> BalancerConstraints

Tells the balancer not to spend UTxO's with the specified output references.

mustNotSpendUtxosWhere :: UtxoPredicate -> BalanceTxConstraintsBuilder

Tells the balancer not to spend UTxO's based on the given predicate. Note that mustNotSpendUtxosWhere constraints are stacked when specified multiple times, and utxos are tested against each predicate. The order of specifying multiple mustNotSpendUtxosWhere constraints does NOT affect the resulting set.

mustNotSpendUtxoWithOutRef :: TransactionInput -> BalancerConstraints

Tells the balancer not to spend a UTxO with the specified output reference.

mustGenChangeOutsWithMaxTokenQuantity :: BigInt -> BalancerConstraints

Tells the balancer to split change outputs and equipartition change Value between them if the total change Value contains token quantities exceeding the specified upper bound. (See Cardano.Types.Value.equipartitionValueWithTokenQuantityUpperBound)