Ctl.Internal.BalanceTx.Constraints

newtype BalanceTxConstraints

Constructors

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

Instances

• Newtype BalanceTxConstraints _

newtype BalanceTxConstraintsBuilder

Constructors

• BalanceTxConstraintsBuilder (BalanceTxConstraints -> BalanceTxConstraints)

Instances

• Newtype BalanceTxConstraintsBuilder _
• Semigroup BalanceTxConstraintsBuilder
• Monoid BalanceTxConstraintsBuilder

buildBalanceTxConstraints :: BalanceTxConstraintsBuilder -> BalanceTxConstraints

mustGenChangeOutsWithMaxTokenQuantity :: BigInt -> BalanceTxConstraintsBuilder

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)

mustNotSpendUtxosWithOutRefs :: Set TransactionInput -> BalanceTxConstraintsBuilder

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

mustNotSpendUtxoWithOutRef :: TransactionInput -> BalanceTxConstraintsBuilder

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

mustSendChangeToAddress :: Address -> BalanceTxConstraintsBuilder

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.

mustSendChangeWithDatum :: OutputDatum -> BalanceTxConstraintsBuilder

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

mustUseAdditionalUtxos :: UtxoMap -> BalanceTxConstraintsBuilder

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).

mustUseCoinSelectionStrategy :: SelectionStrategy -> BalanceTxConstraintsBuilder

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

mustUseCollateralUtxos :: UtxoMap -> BalanceTxConstraintsBuilder

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

mustUseUtxosAtAddress :: Address -> BalanceTxConstraintsBuilder

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.

mustUseUtxosAtAddresses :: Array Address -> BalanceTxConstraintsBuilder

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.

_additionalUtxos :: Lens' BalanceTxConstraints UtxoMap

_collateralUtxos :: Lens' BalanceTxConstraints (Maybe UtxoMap)

_changeAddress :: Lens' BalanceTxConstraints (Maybe Address)

_changeDatum :: Lens' BalanceTxConstraints (Maybe OutputDatum)

_maxChangeOutputTokenQuantity :: Lens' BalanceTxConstraints (Maybe BigInt)

_nonSpendableInputs :: Lens' BalanceTxConstraints (Set TransactionInput)

_selectionStrategy :: Lens' BalanceTxConstraints SelectionStrategy

_srcAddresses :: Lens' BalanceTxConstraints (Maybe (Array Address))