| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
PlutusLedgerApi.Test.ScriptContextBuilder.Builder
Contents
Synopsis
- data UnitTestArgs = UnitTestArgs {}
- newtype InputBuilder = InputBuilder {
- runInputBuilder ∷ InputBuilderState → InputBuilderState
- newtype TxOutBuilder = TxOutBuilder {
- runTxOutBuilder ∷ TxOutBuilderState → TxOutBuilderState
- newtype ScriptContextBuilder = ScriptContextBuilder {}
- data ScriptContextBuilderState = ScriptContextBuilderState {
- scbInputs ∷ [TxInInfo]
- scbReferenceInputs ∷ [TxInInfo]
- scbOutputs ∷ [TxOut]
- scbFee ∷ Integer
- scbMint ∷ Value
- scbCerts ∷ [TxCert]
- scbWdrl ∷ Map Credential Lovelace
- scbValidRange ∷ POSIXTimeRange
- scbSignatories ∷ [PubKeyHash]
- scbRedeemers ∷ Map ScriptPurpose Redeemer
- scbTxId ∷ TxId
- scbScriptInfo ∷ ScriptInfo
- scbRedeemer ∷ BuiltinData
- buildScriptContext ∷ ScriptContextBuilder → ScriptContext
- withRedeemer ∷ BuiltinData → ScriptContextBuilder
- withFee ∷ Integer → ScriptContextBuilder
- withSigner ∷ PubKeyHash → ScriptContextBuilder
- withSigners ∷ [PubKeyHash] → ScriptContextBuilder
- withMint ∷ Value → BuiltinData → ScriptContextBuilder
- withMintingScript ∷ Value → BuiltinData → ScriptContextBuilder
- withSpendingScript ∷ BuiltinData → InputBuilder → ScriptContextBuilder
- withRewardingScript ∷ BuiltinData → Credential → Integer → ScriptContextBuilder
- withRewardingScriptWithBuilder ∷ (ScriptContextBuilderState → BuiltinData) → Credential → Integer → ScriptContextBuilder
- withOutput ∷ TxOutBuilder → ScriptContextBuilder
- withInput ∷ InputBuilder → ScriptContextBuilder
- withScriptInput ∷ BuiltinData → InputBuilder → ScriptContextBuilder
- withReferenceInput ∷ InputBuilder → ScriptContextBuilder
- withValue ∷ Value → InputBuilder
- withValidRange ∷ POSIXTimeRange → ScriptContextBuilder
- withOutRef ∷ TxOutRef → InputBuilder
- withInlineDatum ∷ BuiltinData → InputBuilder
- withReferenceScript ∷ ScriptHash → InputBuilder
- withAddress ∷ Address → InputBuilder
- withWithdrawal ∷ Credential → Integer → ScriptContextBuilder
- mkInput ∷ InputBuilder → TxInInfo
- addInput ∷ TxInInfo → ScriptContext → ScriptContext
- addMint ∷ ScriptContext → Value → BuiltinData → ScriptContext
- mkMintingScriptWithPurpose ∷ Value → BuiltinData → ScriptContext
- addChangeOutput ∷ PubKeyHash → ScriptContext → ScriptContext
- signAndAddChangeOutput ∷ PubKeyHash → ScriptContext → ScriptContext
- mkAdaValue ∷ Lovelace → Value
- mkTxOut ∷ TxOutBuilder → TxOut
- withTxOutReferenceScript ∷ ScriptHash → TxOutBuilder
- withTxOutInlineDatum ∷ BuiltinData → TxOutBuilder
- withTxOutValue ∷ Value → TxOutBuilder
- withTxOutAddress ∷ Address → TxOutBuilder
- addOutput ∷ TxOut → ScriptContext → ScriptContext
- addReferenceInput ∷ TxInInfo → ScriptContext → ScriptContext
- buildBalancedScriptContext ∷ ScriptContextBuilder → ScriptContext
- balanceWithChangeOutput ∷ ScriptContext → ScriptContext
- builderPlaceHolderTxOutRef ∷ TxOutRef
- currencySymbolFromHex ∷ String → CurrencySymbol
- singleCurrencySymbol ∷ Value → CurrencySymbol
Documentation
data UnitTestArgs Source #
Arguments for a unit test: a script context and additional parameters.
Constructors
| UnitTestArgs | |
Fields | |
Instances
| Generic UnitTestArgs Source # | |
Defined in PlutusLedgerApi.Test.ScriptContextBuilder.Builder Methods from ∷ UnitTestArgs → Rep UnitTestArgs x Source # to ∷ Rep UnitTestArgs x → UnitTestArgs Source # | |
| type Rep UnitTestArgs Source # | |
Defined in PlutusLedgerApi.Test.ScriptContextBuilder.Builder type Rep UnitTestArgs = D1 ('MetaData "UnitTestArgs" "PlutusLedgerApi.Test.ScriptContextBuilder.Builder" "plutus-ledger-api-1.70.0.0-inplace-plutus-ledger-api-testlib" 'False) (C1 ('MetaCons "UnitTestArgs" 'PrefixI 'True) (S1 ('MetaSel ('Just "utaScriptContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ScriptContext) :*: S1 ('MetaSel ('Just "utaParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [BuiltinData]))) | |
newtype InputBuilder Source #
A composable builder for constructing transaction inputs.
Constructors
| InputBuilder | |
Fields
| |
Instances
| Monoid InputBuilder Source # | |
Defined in PlutusLedgerApi.Test.ScriptContextBuilder.Builder Methods mempty ∷ InputBuilder Source # mappend ∷ InputBuilder → InputBuilder → InputBuilder Source # mconcat ∷ [InputBuilder] → InputBuilder Source # | |
| Semigroup InputBuilder Source # | |
Defined in PlutusLedgerApi.Test.ScriptContextBuilder.Builder Methods (<>) ∷ InputBuilder → InputBuilder → InputBuilder Source # sconcat ∷ NonEmpty InputBuilder → InputBuilder Source # stimes ∷ Integral b ⇒ b → InputBuilder → InputBuilder Source # | |
newtype TxOutBuilder Source #
A composable builder for constructing transaction outputs.
Constructors
| TxOutBuilder | |
Fields
| |
Instances
| Monoid TxOutBuilder Source # | |
Defined in PlutusLedgerApi.Test.ScriptContextBuilder.Builder Methods mempty ∷ TxOutBuilder Source # mappend ∷ TxOutBuilder → TxOutBuilder → TxOutBuilder Source # mconcat ∷ [TxOutBuilder] → TxOutBuilder Source # | |
| Semigroup TxOutBuilder Source # | |
Defined in PlutusLedgerApi.Test.ScriptContextBuilder.Builder Methods (<>) ∷ TxOutBuilder → TxOutBuilder → TxOutBuilder Source # sconcat ∷ NonEmpty TxOutBuilder → TxOutBuilder Source # stimes ∷ Integral b ⇒ b → TxOutBuilder → TxOutBuilder Source # | |
newtype ScriptContextBuilder Source #
A composable builder for constructing a ScriptContext.
Constructors
| ScriptContextBuilder | |
data ScriptContextBuilderState Source #
Accumulated state for ScriptContextBuilder.
Constructors
buildScriptContext ∷ ScriptContextBuilder → ScriptContext Source #
Build a ScriptContext from a ScriptContextBuilder.
withRedeemer ∷ BuiltinData → ScriptContextBuilder Source #
Set the top-level redeemer for the script context.
withFee ∷ Integer → ScriptContextBuilder Source #
Set the transaction fee.
withSigner ∷ PubKeyHash → ScriptContextBuilder Source #
Add a signatory to the transaction.
withSigners ∷ [PubKeyHash] → ScriptContextBuilder Source #
Add multiple signatories to the transaction.
withMint ∷ Value → BuiltinData → ScriptContextBuilder Source #
Add a minting entry with the given value and redeemer.
withMintingScript ∷ Value → BuiltinData → ScriptContextBuilder Source #
Set the script purpose to minting and add a mint entry.
withSpendingScript ∷ BuiltinData → InputBuilder → ScriptContextBuilder Source #
Set the script purpose to spending and add the script input.
withRewardingScript ∷ BuiltinData → Credential → Integer → ScriptContextBuilder Source #
Set the script purpose to rewarding with a fixed redeemer.
withRewardingScriptWithBuilder ∷ (ScriptContextBuilderState → BuiltinData) → Credential → Integer → ScriptContextBuilder Source #
Set the script purpose to rewarding with a redeemer computed from the builder state.
withOutput ∷ TxOutBuilder → ScriptContextBuilder Source #
Add a transaction output.
withInput ∷ InputBuilder → ScriptContextBuilder Source #
Add a public-key input. Errors if the address is a script address.
withScriptInput ∷ BuiltinData → InputBuilder → ScriptContextBuilder Source #
Add a script input with a redeemer. Errors if the address is not a script address.
withReferenceInput ∷ InputBuilder → ScriptContextBuilder Source #
Add a reference input (read-only, not spent).
withValue ∷ Value → InputBuilder Source #
Set the value for an input.
withValidRange ∷ POSIXTimeRange → ScriptContextBuilder Source #
Set the transaction validity time range.
withOutRef ∷ TxOutRef → InputBuilder Source #
Set the UTXO reference for an input.
withInlineDatum ∷ BuiltinData → InputBuilder Source #
Attach an inline datum to an input.
withReferenceScript ∷ ScriptHash → InputBuilder Source #
Attach a reference script to an input.
withAddress ∷ Address → InputBuilder Source #
Set the address for an input.
withWithdrawal ∷ Credential → Integer → ScriptContextBuilder Source #
Add a withdrawal entry for a credential and ADA amount.
mkInput ∷ InputBuilder → TxInInfo Source #
Finalize an InputBuilder into a TxInInfo.
addInput ∷ TxInInfo → ScriptContext → ScriptContext Source #
Add a transaction input to an existing ScriptContext, sorted by TxOutRef.
addMint ∷ ScriptContext → Value → BuiltinData → ScriptContext Source #
Add a minting entry to an existing ScriptContext.
mkMintingScriptWithPurpose ∷ Value → BuiltinData → ScriptContext Source #
Create a minimal ScriptContext for a minting script.
addChangeOutput ∷ PubKeyHash → ScriptContext → ScriptContext Source #
Compute and add a change output to the given public key hash.
signAndAddChangeOutput ∷ PubKeyHash → ScriptContext → ScriptContext Source #
Add a signatory and compute a change output for the same public key hash.
mkTxOut ∷ TxOutBuilder → TxOut Source #
Finalize a TxOutBuilder into a TxOut.
withTxOutReferenceScript ∷ ScriptHash → TxOutBuilder Source #
Attach a reference script to a transaction output.
withTxOutInlineDatum ∷ BuiltinData → TxOutBuilder Source #
Attach an inline datum to a transaction output.
withTxOutValue ∷ Value → TxOutBuilder Source #
Add value to a transaction output (accumulates with existing value).
withTxOutAddress ∷ Address → TxOutBuilder Source #
Set the address for a transaction output.
addOutput ∷ TxOut → ScriptContext → ScriptContext Source #
Prepend a transaction output to an existing ScriptContext.
addReferenceInput ∷ TxInInfo → ScriptContext → ScriptContext Source #
Add a reference input to an existing ScriptContext, sorted by TxOutRef.
buildBalancedScriptContext ∷ ScriptContextBuilder → ScriptContext Source #
Build a ScriptContext and automatically balance it with a change output.
balanceWithChangeOutput ∷ ScriptContext → ScriptContext Source #
Balance the transaction by adding a change output to the first public key input.
builderPlaceHolderTxOutRef ∷ TxOutRef Source #
Default placeholder TxOutRef used when none is specified.
Helpers
currencySymbolFromHex ∷ String → CurrencySymbol Source #
Convert a hex encoded Haskell String to a CurrencySymbol.
singleCurrencySymbol ∷ Value → CurrencySymbol Source #
Extract the single currency symbol from a Value. Errors if the value
contains zero or more than one currency symbol.
Orphan instances
| Eq ScriptPurpose Source # | |
Methods (==) ∷ ScriptPurpose → ScriptPurpose → Bool Source # | |