Safe Haskell	None
Language	Haskell2010

Ledger.Tx.Constraints.OffChain

Contents

Lookups
Constraints resolution

Synopsis

data ScriptLookups a = ScriptLookups {
- slTxOutputs :: Map TxOutRef DecoratedTxOut
- slOtherScripts :: Map ScriptHash (Versioned Script)
- slOtherData :: Map DatumHash Datum
- slPaymentPubKeyHashes :: Set PaymentPubKeyHash
- slTypedValidator :: Maybe (TypedValidator a)
- slOwnPaymentPubKeyHash :: Maybe PaymentPubKeyHash
- slOwnStakingCredential :: Maybe StakingCredential
}
typedValidatorLookups :: TypedValidator a -> ScriptLookups a
generalise :: ScriptLookups a -> ScriptLookups Any
unspentOutputs :: Map TxOutRef DecoratedTxOut -> ScriptLookups a
mintingPolicy :: Versioned MintingPolicy -> ScriptLookups a
plutusV1MintingPolicy :: MintingPolicy -> ScriptLookups a
plutusV2MintingPolicy :: MintingPolicy -> ScriptLookups a
otherScript :: Versioned Validator -> ScriptLookups a
plutusV1OtherScript :: Validator -> ScriptLookups a
plutusV2OtherScript :: Validator -> ScriptLookups a
otherData :: Datum -> ScriptLookups a
ownPaymentPubKeyHash :: PaymentPubKeyHash -> ScriptLookups a
ownStakingCredential :: StakingCredential -> ScriptLookups a
paymentPubKey :: PaymentPubKey -> ScriptLookups a
paymentPubKeyHash :: PaymentPubKeyHash -> ScriptLookups a
data SomeLookupsAndConstraints where
- SomeLookupsAndConstraints :: forall a. (FromData (DatumType a), ToData (DatumType a), ToData (RedeemerType a)) => ScriptLookups a -> TxConstraints (RedeemerType a) (DatumType a) -> SomeLookupsAndConstraints
data UnbalancedTx
- = UnbalancedEmulatorTx {
  }
- | UnbalancedCardanoTx {
  - unBalancedCardanoBuildTx :: CardanoBuildTx
  - unBalancedTxUtxoIndex :: Map TxOutRef TxOut
  }
unBalancedTxTx :: UnbalancedTx -> Either CardanoBuildTx Tx
tx :: Traversal' UnbalancedTx CardanoBuildTx
txValidityRange :: Lens' CardanoBuildTx (TxValidityLowerBound BabbageEra, TxValidityUpperBound BabbageEra)
txOuts :: Lens' CardanoBuildTx [TxOut CtxTx BabbageEra]
utxoIndex :: Lens' UnbalancedTx (Map TxOutRef TxOut)
emptyUnbalancedTx :: Params -> UnbalancedTx
adjustUnbalancedTx :: PParams -> UnbalancedTx -> Either ToCardanoError ([Ada], UnbalancedTx)
data MkTxError
- = ToCardanoError ToCardanoError
- | LedgerMkTxError MkTxError
mkTx :: (FromData (DatumType a), ToData (DatumType a), ToData (RedeemerType a)) => Params -> ScriptLookups a -> TxConstraints (RedeemerType a) (DatumType a) -> Either MkTxError UnbalancedTx
mkSomeTx :: Params -> [SomeLookupsAndConstraints] -> Either MkTxError UnbalancedTx

Lookups

data ScriptLookups a Source #

Constructors

ScriptLookups

Fields

slTxOutputs :: Map TxOutRef DecoratedTxOut
Unspent outputs that the script may want to spend
slOtherScripts :: Map ScriptHash (Versioned Script)
Scripts other than "our script"
slOtherData :: Map DatumHash Datum
Datums that we might need
slPaymentPubKeyHashes :: Set PaymentPubKeyHash
Public keys that we might need
slTypedValidator :: Maybe (TypedValidator a)
The script instance with the typed validator hash & actual compiled program
slOwnPaymentPubKeyHash :: Maybe PaymentPubKeyHash
The contract's payment public key hash, used for depositing tokens etc.
slOwnStakingCredential :: Maybe StakingCredential
The contract's staking credentials (optional)

Instances

Instances details

Show (ScriptLookups a)
Instance details Defined in Ledger.Constraints.OffChain Methods showsPrec :: Int -> ScriptLookups a -> ShowS Source # show :: ScriptLookups a -> String Source # showList :: [ScriptLookups a] -> ShowS Source #
Generic (ScriptLookups a)
Instance details Defined in Ledger.Constraints.OffChain Associated Types type Rep (ScriptLookups a) :: Type -> Type Source # Methods from :: ScriptLookups a -> Rep (ScriptLookups a) x Source # to :: Rep (ScriptLookups a) x -> ScriptLookups a Source #
Semigroup (ScriptLookups a)
Instance details Defined in Ledger.Constraints.OffChain Methods (<>) :: ScriptLookups a -> ScriptLookups a -> ScriptLookups a Source # sconcat :: NonEmpty (ScriptLookups a) -> ScriptLookups a Source # stimes :: Integral b => b -> ScriptLookups a -> ScriptLookups a Source #
Monoid (ScriptLookups a)
Instance details Defined in Ledger.Constraints.OffChain Methods mempty :: ScriptLookups a Source # mappend :: ScriptLookups a -> ScriptLookups a -> ScriptLookups a Source # mconcat :: [ScriptLookups a] -> ScriptLookups a Source #
ToJSON (ScriptLookups a)
Instance details Defined in Ledger.Constraints.OffChain Methods toJSON :: ScriptLookups a -> Value Source # toEncoding :: ScriptLookups a -> Encoding Source # toJSONList :: [ScriptLookups a] -> Value Source # toEncodingList :: [ScriptLookups a] -> Encoding Source #
FromJSON (ScriptLookups a)
Instance details Defined in Ledger.Constraints.OffChain Methods parseJSON :: Value -> Parser (ScriptLookups a) Source # parseJSONList :: Value -> Parser [ScriptLookups a] Source #
type Rep (ScriptLookups a)
Instance details Defined in Ledger.Constraints.OffChain type Rep (ScriptLookups a) = D1 ('MetaData "ScriptLookups" "Ledger.Constraints.OffChain" "plutus-ledger-constraints-1.1.0.0-2F6ljas7ShDIbSk2Pv4wJR" 'False) (C1 ('MetaCons "ScriptLookups" 'PrefixI 'True) ((S1 ('MetaSel ('Just "slTxOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map TxOutRef DecoratedTxOut)) :: (S1 ('MetaSel ('Just "slOtherScripts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map ScriptHash (Versioned Script))) :: S1 ('MetaSel ('Just "slOtherData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map DatumHash Datum)))) :: ((S1 ('MetaSel ('Just "slPaymentPubKeyHashes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set PaymentPubKeyHash)) :: S1 ('MetaSel ('Just "slTypedValidator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (TypedValidator a)))) :: (S1 ('MetaSel ('Just "slOwnPaymentPubKeyHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe PaymentPubKeyHash)) :: S1 ('MetaSel ('Just "slOwnStakingCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe StakingCredential))))))

typedValidatorLookups :: TypedValidator a -> ScriptLookups a Source #

A script lookups value with a script instance. For convenience this also includes the minting policy script that forwards all checks to the instance's validator.

If called multiple times, only the first typed validator is kept:

typedValidatorLookups tv1 <> typedValidatorLookups tv2 <> ...
    == typedValidatorLookups tv1

generalise :: ScriptLookups a -> ScriptLookups Any Source #

unspentOutputs :: Map TxOutRef DecoratedTxOut -> ScriptLookups a Source #

A script lookups value that uses the map of unspent outputs to resolve input constraints.

mintingPolicy :: Versioned MintingPolicy -> ScriptLookups a Source #

A script lookups value with a versioned minting policy script.

plutusV1MintingPolicy :: MintingPolicy -> ScriptLookups a Source #

A script lookups value with a PlutusV1 minting policy script.

plutusV2MintingPolicy :: MintingPolicy -> ScriptLookups a Source #

A script lookups value with a PlutusV2 minting policy script.

otherScript :: Versioned Validator -> ScriptLookups a Source #

A script lookups value with a versioned validator script.

plutusV1OtherScript :: Validator -> ScriptLookups a Source #

A script lookups value with a PlutusV1 validator script.

plutusV2OtherScript :: Validator -> ScriptLookups a Source #

A script lookups value with a PlutusV2 validator script.

otherData :: Datum -> ScriptLookups a Source #

A script lookups value with a datum.

ownPaymentPubKeyHash :: PaymentPubKeyHash -> ScriptLookups a Source #

A script lookups value with a payment public key hash.

If called multiple times, only the first payment public key hash is kept:

ownPaymentPubKeyHash pkh1 <> ownPaymentPubKeyHash pkh2 <> ...
    == ownPaymentPubKeyHash pkh1

ownStakingCredential :: StakingCredential -> ScriptLookups a Source #

A script lookups value with staking credentials.

If called multiple times, only the first staking credential is kept:

ownStakingCredential skh1 <> ownStakingCredential skh2 <> ...
    == ownStakingCredential skh1

paymentPubKey :: PaymentPubKey -> ScriptLookups a Source #

A script lookups value with a payment public key

paymentPubKeyHash :: PaymentPubKeyHash -> ScriptLookups a Source #

A script lookups value with a payment public key

Constraints resolution

data SomeLookupsAndConstraints where Source #

Some typed TxConstraints and the ScriptLookups needed to turn them into an UnbalancedTx.

Constructors

SomeLookupsAndConstraints :: forall a. (FromData (DatumType a), ToData (DatumType a), ToData (RedeemerType a)) => ScriptLookups a -> TxConstraints (RedeemerType a) (DatumType a) -> SomeLookupsAndConstraints

data UnbalancedTx Source #

An unbalanced transaction. It needs to be balanced and signed before it can be submitted to the ledger. See note [Submitting transactions from Plutus contracts] in Wallet.

Constructors

UnbalancedEmulatorTx
Fields unBalancedEmulatorTx :: Tx unBalancedTxRequiredSignatories :: Set PaymentPubKeyHash These are all the payment public keys that should be used to request the signatories from the user's wallet. The signatories are what is required to sign the transaction before submitting it to the blockchain. Transaction validation will fail if the transaction is not signed by the required wallet. unBalancedTxUtxoIndex :: Map TxOutRef TxOut Utxo lookups that are used for adding inputs to the `UnbalancedTx`. Simply refers to `slTxOutputs` of `ScriptLookups`.
UnbalancedCardanoTx
Fields unBalancedCardanoBuildTx :: CardanoBuildTx unBalancedTxUtxoIndex :: Map TxOutRef TxOut Utxo lookups that are used for adding inputs to the `UnbalancedTx`. Simply refers to `slTxOutputs` of `ScriptLookups`.

Instances

Instances details

Eq UnbalancedTx
Instance details Defined in Ledger.Constraints.OffChain Methods (==) :: UnbalancedTx -> UnbalancedTx -> Bool Source # (/=) :: UnbalancedTx -> UnbalancedTx -> Bool Source #
Show UnbalancedTx
Instance details Defined in Ledger.Constraints.OffChain Methods showsPrec :: Int -> UnbalancedTx -> ShowS Source # show :: UnbalancedTx -> String Source # showList :: [UnbalancedTx] -> ShowS Source #
Generic UnbalancedTx
Instance details Defined in Ledger.Constraints.OffChain Associated Types type Rep UnbalancedTx :: Type -> Type Source # Methods from :: UnbalancedTx -> Rep UnbalancedTx x Source # to :: Rep UnbalancedTx x -> UnbalancedTx Source #
ToJSON UnbalancedTx
Instance details Defined in Ledger.Constraints.OffChain Methods toJSON :: UnbalancedTx -> Value Source # toEncoding :: UnbalancedTx -> Encoding Source # toJSONList :: [UnbalancedTx] -> Value Source # toEncodingList :: [UnbalancedTx] -> Encoding Source #
FromJSON UnbalancedTx
Instance details Defined in Ledger.Constraints.OffChain Methods parseJSON :: Value -> Parser UnbalancedTx Source # parseJSONList :: Value -> Parser [UnbalancedTx] Source #
ToSchema UnbalancedTx
Instance details Defined in Ledger.Constraints.OffChain Methods declareNamedSchema :: Proxy UnbalancedTx -> Declare (Definitions Schema) NamedSchema Source #
Pretty UnbalancedTx
Instance details Defined in Ledger.Constraints.OffChain Methods pretty :: UnbalancedTx -> Doc ann Source # prettyList :: [UnbalancedTx] -> Doc ann Source #
type Rep UnbalancedTx
Instance details Defined in Ledger.Constraints.OffChain type Rep UnbalancedTx = D1 ('MetaData "UnbalancedTx" "Ledger.Constraints.OffChain" "plutus-ledger-constraints-1.1.0.0-2F6ljas7ShDIbSk2Pv4wJR" 'False) (C1 ('MetaCons "UnbalancedEmulatorTx" 'PrefixI 'True) (S1 ('MetaSel ('Just "unBalancedEmulatorTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Tx) :: (S1 ('MetaSel ('Just "unBalancedTxRequiredSignatories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set PaymentPubKeyHash)) :: S1 ('MetaSel ('Just "unBalancedTxUtxoIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map TxOutRef TxOut)))) :+: C1 ('MetaCons "UnbalancedCardanoTx" 'PrefixI 'True) (S1 ('MetaSel ('Just "unBalancedCardanoBuildTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CardanoBuildTx) :*: S1 ('MetaSel ('Just "unBalancedTxUtxoIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map TxOutRef TxOut))))

unBalancedTxTx :: UnbalancedTx -> Either CardanoBuildTx Tx Source #

tx :: Traversal' UnbalancedTx CardanoBuildTx Source #

txValidityRange :: Lens' CardanoBuildTx (TxValidityLowerBound BabbageEra, TxValidityUpperBound BabbageEra) Source #

txOuts :: Lens' CardanoBuildTx [TxOut CtxTx BabbageEra] Source #

utxoIndex :: Lens' UnbalancedTx (Map TxOutRef TxOut) Source #

emptyUnbalancedTx :: Params -> UnbalancedTx Source #

adjustUnbalancedTx :: PParams -> UnbalancedTx -> Either ToCardanoError ([Ada], UnbalancedTx) Source #

Each transaction output should contain a minimum amount of Ada (this is a restriction on the real Cardano network).

data MkTxError Source #

Constructors

ToCardanoError ToCardanoError
LedgerMkTxError MkTxError

Instances

Instances details

Eq MkTxError Source #
Instance details Defined in Ledger.Tx.Constraints.OffChain Methods (==) :: MkTxError -> MkTxError -> Bool Source # (/=) :: MkTxError -> MkTxError -> Bool Source #
Show MkTxError Source #
Instance details Defined in Ledger.Tx.Constraints.OffChain Methods showsPrec :: Int -> MkTxError -> ShowS Source # show :: MkTxError -> String Source # showList :: [MkTxError] -> ShowS Source #
Generic MkTxError Source #
Instance details Defined in Ledger.Tx.Constraints.OffChain Associated Types type Rep MkTxError :: Type -> Type Source # Methods from :: MkTxError -> Rep MkTxError x Source # to :: Rep MkTxError x -> MkTxError Source #
ToJSON MkTxError Source #
Instance details Defined in Ledger.Tx.Constraints.OffChain Methods toJSON :: MkTxError -> Value Source # toEncoding :: MkTxError -> Encoding Source # toJSONList :: [MkTxError] -> Value Source # toEncodingList :: [MkTxError] -> Encoding Source #
FromJSON MkTxError Source #
Instance details Defined in Ledger.Tx.Constraints.OffChain Methods parseJSON :: Value -> Parser MkTxError Source # parseJSONList :: Value -> Parser [MkTxError] Source #
Pretty MkTxError Source #
Instance details Defined in Ledger.Tx.Constraints.OffChain Methods pretty :: MkTxError -> Doc ann Source # prettyList :: [MkTxError] -> Doc ann Source #
type Rep MkTxError Source #
Instance details Defined in Ledger.Tx.Constraints.OffChain type Rep MkTxError = D1 ('MetaData "MkTxError" "Ledger.Tx.Constraints.OffChain" "plutus-tx-constraints-1.1.0.0-G6OZg6WZdhpF1XLKYvmpKR" 'False) (C1 ('MetaCons "ToCardanoError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ToCardanoError)) :+: C1 ('MetaCons "LedgerMkTxError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MkTxError)))

mkTx :: (FromData (DatumType a), ToData (DatumType a), ToData (RedeemerType a)) => Params -> ScriptLookups a -> TxConstraints (RedeemerType a) (DatumType a) -> Either MkTxError UnbalancedTx Source #

Turn a TxConstraints value into an unbalanced transaction that satisfies the constraints. To use this in a contract, see submitTxConstraints and related functions.

mkSomeTx :: Params -> [SomeLookupsAndConstraints] -> Either MkTxError UnbalancedTx Source #

Given a list of SomeLookupsAndConstraints describing the constraints for several scripts, build a single transaction that runs all the scripts.