Ctl.Internal.Types.TxConstraints

data DatumPresence

DatumPresence describes how datum should be stored in the transaction when paying to a script.

Constructors

• DatumInline

  DatumInline asserts the datum should be stored in the TransactionOutput as an inline datum.

• DatumWitness

  DatumWitness asserts the datum's hash be stored in the TransactionOutput, and the datum added to the transactions witnesses.

Instances

• Eq DatumPresence
• Generic DatumPresence _
• Show DatumPresence

newtype InputConstraint

Constructors

• InputConstraint { redeemer :: PlutusData, txOutRef :: TransactionInput }

Instances

• Generic InputConstraint _
• Newtype InputConstraint _
• Eq InputConstraint
• Show InputConstraint

data InputWithScriptRef

InputWithScriptRef specifies whether the underlying utxo with the reference script should be included in the transaction as a reference input.

Constructors

• RefInput TransactionUnspentOutput

  RefInput asserts the utxo containing the reference script should be used as a reference input and therefore cannot be spent.

• SpendInput TransactionUnspentOutput

  SpendInput asserts the utxo containing the reference script should be used as a regular input and therefore can be spent.

Instances

• Eq InputWithScriptRef
• Generic InputWithScriptRef _
• Show InputWithScriptRef

newtype OutputConstraint

Constructors

• OutputConstraint { datum :: PlutusData, value :: Value }

Instances

• Generic OutputConstraint _
• Newtype OutputConstraint _
• Eq OutputConstraint
• Show OutputConstraint

data TxConstraint

Constraints on transactions that want to spend script outputs

Constructors

• MustIncludeDatum PlutusData
• MustValidateIn POSIXTimeRange
• MustBeSignedBy PaymentPubKeyHash
• MustSpendAtLeast Value
• MustProduceAtLeast Value
• MustSpendPubKeyOutput TransactionInput
• MustSpendNativeScriptOutput TransactionInput NativeScript
• MustSpendScriptOutput TransactionInput RedeemerDatum (Maybe InputWithScriptRef)
• MustReferenceOutput TransactionInput
• MustMintValue ScriptHash RedeemerDatum AssetName Int (Maybe InputWithScriptRef)
• MustMintValueUsingNativeScript NativeScript AssetName Int
• MustPayToPubKeyAddress PaymentPubKeyHash (Maybe StakePubKeyHash) (Maybe (PlutusData /\ DatumPresence)) (Maybe ScriptRef) Value
• MustPayToNativeScript ScriptHash (Maybe Credential) Value
• MustPayToScript ScriptHash (Maybe Credential) PlutusData DatumPresence (Maybe ScriptRef) Value
• MustHashDatum DataHash PlutusData
• MustRegisterStakePubKey StakePubKeyHash
• MustDeregisterStakePubKey StakePubKeyHash
• MustRegisterStakeScript ScriptHash
• MustDeregisterStakePlutusScript PlutusScript RedeemerDatum
• MustDeregisterStakeNativeScript NativeScript
• MustRegisterPool PoolParams
• MustRetirePool PoolPubKeyHash Epoch
• MustDelegateStakePubKey StakePubKeyHash PoolPubKeyHash
• MustDelegateStakePlutusScript PlutusScript RedeemerDatum PoolPubKeyHash
• MustDelegateStakeNativeScript NativeScript PoolPubKeyHash
• MustWithdrawStakePubKey StakePubKeyHash
• MustWithdrawStakePlutusScript PlutusScript RedeemerDatum
• MustWithdrawStakeNativeScript NativeScript
• MustSatisfyAnyOf (Array (Array TxConstraint))
• MustNotBeValid

Instances

• Eq TxConstraint
• Generic TxConstraint _
• Show TxConstraint

newtype TxConstraints

Restrictions placed on the allocation of funds to outputs of transactions.

Constructors

• TxConstraints { constraints :: Array TxConstraint }

Instances

• Generic TxConstraints _
• Newtype TxConstraints _
• Eq TxConstraints
• Semigroup TxConstraints
• Monoid TxConstraints
• Show TxConstraints

mustBeSignedBy :: PaymentPubKeyHash -> TxConstraints

Require the transaction to be signed by the public key.

mustDelegateStakeNativeScript :: forall (i :: Type) (o :: Type). NativeScript -> PoolPubKeyHash -> TxConstraints

mustDelegateStakePlutusScript :: forall (i :: Type) (o :: Type). PlutusScript -> RedeemerDatum -> PoolPubKeyHash -> TxConstraints

mustDelegateStakePubKey :: forall (i :: Type) (o :: Type). StakePubKeyHash -> PoolPubKeyHash -> TxConstraints

mustDeregisterStakeNativeScript :: forall (i :: Type) (o :: Type). NativeScript -> TxConstraints

mustDeregisterStakePlutusScript :: forall (i :: Type) (o :: Type). PlutusScript -> RedeemerDatum -> TxConstraints

mustDeregisterStakePubKey :: StakePubKeyHash -> TxConstraints

mustHashDatum :: DataHash -> PlutusData -> TxConstraints

mustIncludeDatum :: PlutusData -> TxConstraints

Require the transaction to include a datum.

mustMintCurrency :: ScriptHash -> AssetName -> Int -> TxConstraints

Create the given amount of the currency. The amount to mint must not be zero.

mustMintCurrencyUsingNativeScript :: forall (i :: Type) (o :: Type). NativeScript -> AssetName -> Int -> TxConstraints

mustMintCurrencyUsingScriptRef :: ScriptHash -> AssetName -> Int -> InputWithScriptRef -> TxConstraints

Create the given amount of the currency using a reference minting policy. The amount to mint must not be zero.

mustMintCurrencyWithRedeemer :: ScriptHash -> RedeemerDatum -> AssetName -> Int -> TxConstraints

Create the given amount of the currency. The amount to mint must not be zero.

mustMintCurrencyWithRedeemerUsingScriptRef :: ScriptHash -> RedeemerDatum -> AssetName -> Int -> InputWithScriptRef -> TxConstraints

Create the given amount of the currency using a reference minting policy. The amount to mint must not be zero.

mustMintValue :: Mint -> TxConstraints

Mint the given Value The amount to mint must not be zero.

mustMintValueWithRedeemer :: forall (i :: Type) (o :: Type). RedeemerDatum -> Mint -> TxConstraints

Mint the given Value by accessing non-Ada assets. The amount to mint must not be zero.

mustNotBeValid :: TxConstraints

Marks the transaction as invalid, requiring at least one script execution to fail. Despite failure, the transaction can still be submitted into the chain and collateral will be lost.

mustPayToNativeScript :: forall (i :: Type) (o :: Type). ScriptHash -> Value -> TxConstraints

mustPayToNativeScriptAddress :: forall (i :: Type) (o :: Type). ScriptHash -> Credential -> Value -> TxConstraints

mustPayToPubKey :: Warn (Text "Some wallets may not recognize addresses without a staking key component. Consider using mustPayToPubKeyAddress") => PaymentPubKeyHash -> Value -> TxConstraints

Lock the value with a public key. (Enterprise Address)

mustPayToPubKeyAddress :: PaymentPubKeyHash -> StakePubKeyHash -> Value -> TxConstraints

Lock the value with a public key address. (Base Address)

mustPayToPubKeyAddressWithDatum :: PaymentPubKeyHash -> StakePubKeyHash -> PlutusData -> DatumPresence -> Value -> TxConstraints

Lock the value and datum with a public key address.

mustPayToPubKeyAddressWithDatumAndScriptRef :: PaymentPubKeyHash -> StakePubKeyHash -> PlutusData -> DatumPresence -> ScriptRef -> Value -> TxConstraints

Lock the value, datum and reference script with a public key address.

mustPayToPubKeyAddressWithScriptRef :: PaymentPubKeyHash -> StakePubKeyHash -> ScriptRef -> Value -> TxConstraints

Lock the value and reference script with a public key address.

mustPayToPubKeyWithDatum :: PaymentPubKeyHash -> PlutusData -> DatumPresence -> Value -> TxConstraints

Lock the value and datum with a payment public key hash.

mustPayToPubKeyWithDatumAndScriptRef :: PaymentPubKeyHash -> PlutusData -> DatumPresence -> ScriptRef -> Value -> TxConstraints

Lock the value, datum and reference script with a payment public key hash.

mustPayToPubKeyWithScriptRef :: PaymentPubKeyHash -> ScriptRef -> Value -> TxConstraints

Lock the value and reference script with a payment public key hash.

mustPayToScript :: ScriptHash -> PlutusData -> DatumPresence -> Value -> TxConstraints

Note that CTL does not have explicit equivalents of Plutus' mustPayToTheScript or mustPayToOtherScript, as we have no notion of a "current" script. Thus, we have the single constraint mustPayToScript, and all scripts must be explicitly provided to build the transaction.

mustPayToScriptAddress :: ScriptHash -> Credential -> PlutusData -> DatumPresence -> Value -> TxConstraints

mustPayToScriptAddressWithScriptRef :: forall (i :: Type) (o :: Type). ScriptHash -> Credential -> PlutusData -> DatumPresence -> ScriptRef -> Value -> TxConstraints

Lock the value, datum and reference script with a script. Note that the provided reference script does not necessarily need to control the spending of the output, i.e. both scripts can be different.

mustPayToScriptWithScriptRef :: ScriptHash -> PlutusData -> DatumPresence -> ScriptRef -> Value -> TxConstraints

Lock the value, datum and reference script with a script. Note that the provided reference script does not necessarily need to control the spending of the output, i.e. both scripts can be different.

mustProduceAtLeast :: Value -> TxConstraints

Requirement to produce outputs with at least the given value

mustReferenceOutput :: TransactionInput -> TxConstraints

Require the transaction to reference (not spend!) the given unspent transaction output.

mustRegisterPool :: PoolParams -> TxConstraints

mustRegisterStakePubKey :: StakePubKeyHash -> TxConstraints

mustRegisterStakeScript :: ScriptHash -> TxConstraints

mustRetirePool :: forall (i :: Type) (o :: Type). PoolPubKeyHash -> Epoch -> TxConstraints

mustSatisfyAnyOf :: forall (f :: Type -> Type) (i :: Type) (o :: Type). Foldable f => f (TxConstraints) -> TxConstraints

Attempts to solve, in order, a sequence of constraints until the first successful try. mustSatisfyaAnyOf is just a way to define a chain of try-catch expressions in a declarative manner. It does not do any analysis of the constraints' semantics.

mustSpendAtLeast :: Value -> TxConstraints

Requirement to spend inputs with at least the given value

mustSpendNativeScriptOutput :: TransactionInput -> NativeScript -> TxConstraints

mustSpendPubKeyOutput :: TransactionInput -> TxConstraints

Spend the given unspent transaction public key output.

mustSpendScriptOutput :: TransactionInput -> RedeemerDatum -> TxConstraints

Spend the given unspent transaction script output.

mustSpendScriptOutputUsingScriptRef :: TransactionInput -> RedeemerDatum -> InputWithScriptRef -> TxConstraints

Spend the given unspent transaction script output, using a reference script to satisfy the script witnessing requirement.

mustValidateIn :: POSIXTimeRange -> TxConstraints

mustValidateIn r requires the transaction's time range to be contained in r.

mustWithdrawStakeNativeScript :: forall (i :: Type) (o :: Type). NativeScript -> TxConstraints

mustWithdrawStakePlutusScript :: forall (i :: Type) (o :: Type). PlutusScript -> RedeemerDatum -> TxConstraints

mustWithdrawStakePubKey :: StakePubKeyHash -> TxConstraints

singleton :: TxConstraint -> TxConstraints

utxoWithScriptRef :: InputWithScriptRef -> Map TransactionInput TransactionOutput