Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Cooked.Skeleton.Option
Synopsis
- data BalanceOutputPolicy
- data FeePolicy
- data BalancingPolicy
- data BalancingUtxos
- newtype RawModTx = RawModTx (Tx ConwayEra -> Tx ConwayEra)
- newtype EmulatorParamsModification = EmulatorParamsModification (Params -> Params)
- data CollateralUtxos
- data AnchorResolution
- applyEmulatorParamsModification :: Maybe EmulatorParamsModification -> Params -> Params
- applyRawModOnBalancedTx :: [RawModTx] -> Tx ConwayEra -> Tx ConwayEra
- data TxOpts = TxOpts {
- txOptAutoSlotIncrease :: Bool
- txOptUnsafeModTx :: [RawModTx]
- txOptBalancingPolicy :: BalancingPolicy
- txOptFeePolicy :: FeePolicy
- txOptBalanceOutputPolicy :: BalanceOutputPolicy
- txOptBalancingUtxos :: BalancingUtxos
- txOptEmulatorParamsModification :: Maybe EmulatorParamsModification
- txOptCollateralUtxos :: CollateralUtxos
- txOptAnchorResolution :: AnchorResolution
- txOptAutoReferenceScripts :: Bool
- txOptUnsafeModTxL :: Lens' TxOpts [RawModTx]
- txOptAutoSlotIncreaseL :: Lens' TxOpts Bool
- txOptBalancingPolicyL :: Lens' TxOpts BalancingPolicy
- txOptBalanceOutputPolicyL :: Lens' TxOpts BalanceOutputPolicy
- txOptFeePolicyL :: Lens' TxOpts FeePolicy
- txOptBalancingUtxosL :: Lens' TxOpts BalancingUtxos
- txOptEmulatorParamsModificationL :: Lens' TxOpts (Maybe EmulatorParamsModification)
- txOptCollateralUtxosL :: Lens' TxOpts CollateralUtxos
- txOptAnchorResolutionL :: Lens' TxOpts AnchorResolution
- txOptAutoReferenceScriptsL :: Lens' TxOpts Bool
Documentation
data BalanceOutputPolicy Source #
Whether to adjust a potentially existing output to the balancing wallet with the change during transaction balancing.
Constructors
AdjustExistingOutput | Try to adjust an existing public key output with the change. If no suitable output can be found, create a new change output. |
DontAdjustExistingOutput | Do not change the existing outputs, always create a new change output. |
Instances
What fee policy to use in the transaction.
Constructors
AutoFeeComputation | Use automatic fee computation. If balancing is activated, an optimal fee will be computed based on the transaction and existing utxos in the balancing wallet. Otherwise, the maximum transaction fee will be applied. |
ManualFee Integer | Provide a fee to the transaction. If the autobalancing is activated, it will be attempted around this fee, which might lead to failure if it is too low, otherwise, this fee will be given to transaction generation. |
Instances
Show FeePolicy Source # | |
Default FeePolicy Source # | |
Defined in Cooked.Skeleton.Option | |
Eq FeePolicy Source # | |
Ord FeePolicy Source # | |
data BalancingPolicy Source #
Whether to balance the transaction or not, and which wallet to use to provide outputs for balancing.
Constructors
BalanceWithFirstSigner | Balance with the first signer of the list of signers |
BalanceWith Wallet | Balance using a given wallet |
DoNotBalance | Do not perform balancing at all |
Instances
Show BalancingPolicy Source # | |
Defined in Cooked.Skeleton.Option Methods showsPrec :: Int -> BalancingPolicy -> ShowS # show :: BalancingPolicy -> String # showList :: [BalancingPolicy] -> ShowS # | |
Default BalancingPolicy Source # | |
Defined in Cooked.Skeleton.Option Methods def :: BalancingPolicy # | |
Eq BalancingPolicy Source # | |
Defined in Cooked.Skeleton.Option Methods (==) :: BalancingPolicy -> BalancingPolicy -> Bool # (/=) :: BalancingPolicy -> BalancingPolicy -> Bool # | |
Ord BalancingPolicy Source # | |
Defined in Cooked.Skeleton.Option Methods compare :: BalancingPolicy -> BalancingPolicy -> Ordering # (<) :: BalancingPolicy -> BalancingPolicy -> Bool # (<=) :: BalancingPolicy -> BalancingPolicy -> Bool # (>) :: BalancingPolicy -> BalancingPolicy -> Bool # (>=) :: BalancingPolicy -> BalancingPolicy -> Bool # max :: BalancingPolicy -> BalancingPolicy -> BalancingPolicy # min :: BalancingPolicy -> BalancingPolicy -> BalancingPolicy # |
data BalancingUtxos Source #
Which UTxOs to use when balancing. Note that utxos that are already known
by the skeleton being balanced (in the sense of txSkelKnownTxOutRefs
,
i.e. inputs and reference inputs) will be filtered out during balancing.
Constructors
BalancingUtxosFromBalancingWallet | Use all UTxOs containing only a Value (no datum, no staking credential, and no reference script) belonging to the balancing wallet. |
BalancingUtxosFromSet (Set TxOutRef) | Use the provided UTxOs. UTxOs belonging to scripts will be filtered out |
Instances
Show BalancingUtxos Source # | |
Defined in Cooked.Skeleton.Option Methods showsPrec :: Int -> BalancingUtxos -> ShowS # show :: BalancingUtxos -> String # showList :: [BalancingUtxos] -> ShowS # | |
Default BalancingUtxos Source # | |
Defined in Cooked.Skeleton.Option Methods def :: BalancingUtxos # | |
Eq BalancingUtxos Source # | |
Defined in Cooked.Skeleton.Option Methods (==) :: BalancingUtxos -> BalancingUtxos -> Bool # (/=) :: BalancingUtxos -> BalancingUtxos -> Bool # | |
Ord BalancingUtxos Source # | |
Defined in Cooked.Skeleton.Option Methods compare :: BalancingUtxos -> BalancingUtxos -> Ordering # (<) :: BalancingUtxos -> BalancingUtxos -> Bool # (<=) :: BalancingUtxos -> BalancingUtxos -> Bool # (>) :: BalancingUtxos -> BalancingUtxos -> Bool # (>=) :: BalancingUtxos -> BalancingUtxos -> Bool # max :: BalancingUtxos -> BalancingUtxos -> BalancingUtxos # min :: BalancingUtxos -> BalancingUtxos -> BalancingUtxos # |
Wraps a function that will be applied to a Cardano transaction after it has been generated from this skeleton (and thus, after balancing has been performed since it operates on skeletons).
newtype EmulatorParamsModification Source #
Wraps a function that will temporarily change the emulator parameters for the transaction's balancing and submission.
Constructors
EmulatorParamsModification (Params -> Params) |
Instances
Show EmulatorParamsModification Source # | |
Defined in Cooked.Skeleton.Option Methods showsPrec :: Int -> EmulatorParamsModification -> ShowS # show :: EmulatorParamsModification -> String # showList :: [EmulatorParamsModification] -> ShowS # | |
Eq EmulatorParamsModification Source # | |
Defined in Cooked.Skeleton.Option Methods (==) :: EmulatorParamsModification -> EmulatorParamsModification -> Bool # (/=) :: EmulatorParamsModification -> EmulatorParamsModification -> Bool # |
data CollateralUtxos Source #
Describe which UTxOs to use as collaterals
Constructors
CollateralUtxosFromBalancingWallet | Rely on automated computation with only-value UTxOs from the balancing wallet. Return collaterals will be sent to this wallet. |
CollateralUtxosFromWallet Wallet | Rely on automated computation with only-value UTxOs from a given wallet. Return collaterals will be sent to this wallet. |
CollateralUtxosFromSet (Set TxOutRef) Wallet | Manually provide a set of candidate UTxOs to be used as collaterals alongside a wallet to send return collaterals back to. |
Instances
Show CollateralUtxos Source # | |
Defined in Cooked.Skeleton.Option Methods showsPrec :: Int -> CollateralUtxos -> ShowS # show :: CollateralUtxos -> String # showList :: [CollateralUtxos] -> ShowS # | |
Default CollateralUtxos Source # | |
Defined in Cooked.Skeleton.Option Methods def :: CollateralUtxos # | |
Eq CollateralUtxos Source # | |
Defined in Cooked.Skeleton.Option Methods (==) :: CollateralUtxos -> CollateralUtxos -> Bool # (/=) :: CollateralUtxos -> CollateralUtxos -> Bool # |
data AnchorResolution Source #
Describes how to resolve anchors in proposal procedures
Constructors
AnchorResolutionLocal (Map String ByteString) | Provide a map between urls and page content as Bytestring |
AnchorResolutionHttp | Allow online fetch of pages from a given URL. Important note: using this option is unsafe, as it requires a web connection and inherently prevents guarantees of reproducibily. Use at your own discretion. |
Instances
Show AnchorResolution Source # | |
Defined in Cooked.Skeleton.Option Methods showsPrec :: Int -> AnchorResolution -> ShowS # show :: AnchorResolution -> String # showList :: [AnchorResolution] -> ShowS # | |
Default AnchorResolution Source # | |
Defined in Cooked.Skeleton.Option Methods def :: AnchorResolution # | |
Eq AnchorResolution Source # | |
Defined in Cooked.Skeleton.Option Methods (==) :: AnchorResolution -> AnchorResolution -> Bool # (/=) :: AnchorResolution -> AnchorResolution -> Bool # |
applyRawModOnBalancedTx :: [RawModTx] -> Tx ConwayEra -> Tx ConwayEra Source #
Applies a list of modifications right before the transaction is submitted. The leftmost function in the argument list is applied first.
Set of options to modify the behavior of generating and validating some transaction.
Constructors
TxOpts | |
Fields
|