Copyright	© 2018-2020 IOHK
License	Apache-2.0
Safe Haskell	None
Language	Haskell2010

Cardano.Wallet.Transaction

Contents

Interface
Errors

Description

An extra interface for operation on transactions (e.g. creating witnesses, estimating size...). This makes it possible to decouple those operations from our wallet layer, keeping the implementation flexible to various backends.

Synopsis

data TransactionLayer k tx = TransactionLayer {
- mkTransaction :: AnyCardanoEra -> ( XPrv , Passphrase "encryption") -> ( Address -> Maybe (k ' AddressK XPrv , Passphrase "encryption")) -> ProtocolParameters -> TransactionCtx -> SelectionOf TxOut -> Either ErrMkTransaction ( Tx , tx)
- addVkWitnesses :: AnyCardanoEra -> ( XPrv , Passphrase "encryption") -> ( KeyHash , XPrv , Passphrase "encryption") -> ( Address -> Maybe (k ' AddressK XPrv , Passphrase "encryption")) -> ( TxIn -> Maybe Address ) -> tx -> tx
- mkUnsignedTransaction :: AnyCardanoEra -> XPub -> ProtocolParameters -> TransactionCtx -> SelectionOf TxOut -> Either ErrMkTransaction tx
- calcMinimumCost :: AnyCardanoEra -> ProtocolParameters -> TransactionCtx -> SelectionSkeleton -> Coin
- maxScriptExecutionCost :: ProtocolParameters -> [ Redeemer ] -> Coin
- evaluateMinimumFee :: forall era. IsShelleyBasedEra era => ProtocolParameters -> Tx era -> Coin
- estimateSignedTxSize :: forall era. IsShelleyBasedEra era => ProtocolParameters -> Tx era -> TxSize
- evaluateTransactionBalance :: forall era. IsShelleyBasedEra era => Tx era -> ProtocolParameters -> UTxO -> [( TxIn , TxOut , Maybe ( Hash "Datum"))] -> Value
- distributeSurplus :: FeePolicy -> Coin -> TxFeeAndChange [ TxOut ] -> Either ErrMoreSurplusNeeded ( TxFeeAndChange [ TxOut ])
- computeSelectionLimit :: AnyCardanoEra -> ProtocolParameters -> TransactionCtx -> [ TxOut ] -> SelectionLimit
- tokenBundleSizeAssessor :: TokenBundleMaxSize -> TokenBundleSizeAssessor
- constraints :: AnyCardanoEra -> ProtocolParameters -> TxConstraints
- decodeTx :: AnyCardanoEra -> tx -> ( Tx , TokenMapWithScripts , TokenMapWithScripts , [ Certificate ], Maybe ValidityIntervalExplicit )
- updateTx :: forall era. IsShelleyBasedEra era => Tx era -> TxUpdate -> Either ErrUpdateSealedTx ( Tx era)
- assignScriptRedeemers :: forall era. IsShelleyBasedEra era => ProtocolParameters -> TimeInterpreter ( Either PastHorizonException ) -> ( TxIn -> Maybe ( TxOut , Maybe ( Hash "Datum"))) -> [ Redeemer ] -> Tx era -> Either ErrAssignRedeemers ( Tx era)
}
data DelegationAction
- = RegisterKeyAndJoin PoolId
- | Join PoolId
- | Quit
data TransactionCtx = TransactionCtx {
- txWithdrawal :: Withdrawal
- txMetadata :: Maybe TxMetadata
- txValidityInterval :: ( Maybe SlotNo , SlotNo )
- txDelegationAction :: Maybe DelegationAction
- txPlutusScriptExecutionCost :: Coin
- txAssetsToMint :: ( TokenMap , Map AssetId ( Script KeyHash ))
- txAssetsToBurn :: ( TokenMap , Map AssetId ( Script KeyHash ))
- txCollateralRequirement :: SelectionCollateralRequirement
- txFeePadding :: ! Coin
}
defaultTransactionCtx :: TransactionCtx
data Withdrawal
- = WithdrawalSelf RewardAccount ( NonEmpty DerivationIndex ) Coin
- | WithdrawalExternal RewardAccount ( NonEmpty DerivationIndex ) Coin
- | NoWithdrawal
withdrawalToCoin :: Withdrawal -> Coin
data TxUpdate = TxUpdate {
- extraInputs :: [( TxIn , TxOut )]
- extraCollateral :: [ TxIn ]
- extraOutputs :: [ TxOut ]
- feeUpdate :: TxFeeUpdate
}
data TxFeeUpdate
- = UseOldTxFee
- | UseNewTxFee Coin
data TokenMapWithScripts = TokenMapWithScripts {
- txTokenMap :: ! TokenMap
- txScripts :: !( Map TokenPolicyId AnyScript )
}
emptyTokenMapWithScripts :: TokenMapWithScripts
data AnyScript
- = NativeScript !( Script KeyHash )
- | PlutusScript ! PlutusScriptInfo
newtype PlutusScriptInfo = PlutusScriptInfo {
- languageVersion :: PlutusVersion
}
data PlutusVersion
- = PlutusVersionV1
- | PlutusVersionV2
data TxFeeAndChange change = TxFeeAndChange {
- fee :: Coin
- change :: change
}
mapTxFeeAndChange :: ( Coin -> Coin ) -> (change1 -> change2) -> TxFeeAndChange change1 -> TxFeeAndChange change2
data ValidityIntervalExplicit = ValidityIntervalExplicit {
- invalidBefore :: !( Quantity "slot" Word64 )
- invalidHereafter :: !( Quantity "slot" Word64 )
}
data ErrSignTx
- = ErrSignTxAddressUnknown TxIn
- | ErrSignTxUnimplemented
data ErrMkTransaction
- = ErrMkTransactionNoSuchWallet WalletId
- | ErrMkTransactionTxBodyError Text
- | ErrMkTransactionInvalidEra AnyCardanoEra
- | ErrMkTransactionJoinStakePool ErrCannotJoin
- | ErrMkTransactionQuitStakePool ErrCannotQuit
- | ErrMkTransactionIncorrectTTL PastHorizonException
data ErrCannotJoin
- = ErrAlreadyDelegating PoolId
- | ErrNoSuchPool PoolId
data ErrCannotQuit
- = ErrNotDelegatingOrAboutTo
- | ErrNonNullRewards Coin
newtype ErrUpdateSealedTx = ErrExistingKeyWitnesses Int
data ErrAssignRedeemers
- = ErrAssignRedeemersScriptFailure Redeemer String
- | ErrAssignRedeemersTargetNotFound Redeemer
- | ErrAssignRedeemersInvalidData Redeemer String
- | ErrAssignRedeemersTranslationError ( TranslationError StandardCrypto )
newtype ErrMoreSurplusNeeded = ErrMoreSurplusNeeded Coin

Interface

data TransactionLayer k tx Source #

Constructors

TransactionLayer

Fields

mkTransaction :: AnyCardanoEra -> ( XPrv , Passphrase "encryption") -> ( Address -> Maybe (k ' AddressK XPrv , Passphrase "encryption")) -> ProtocolParameters -> TransactionCtx -> SelectionOf TxOut -> Either ErrMkTransaction ( Tx , tx)

Construct a standard transaction

" Standard " here refers to the fact that we do not deal with redemption, multisignature transactions, etc.

This expects as a first argument a mean to compute or lookup private key corresponding to a particular address.
addVkWitnesses :: AnyCardanoEra -> ( XPrv , Passphrase "encryption") -> ( KeyHash , XPrv , Passphrase "encryption") -> ( Address -> Maybe (k ' AddressK XPrv , Passphrase "encryption")) -> ( TxIn -> Maybe Address ) -> tx -> tx

Add Vk witnesses to a transaction for known inputs.

If inputs can't be resolved, they are simply skipped, hence why this function cannot fail.
mkUnsignedTransaction :: AnyCardanoEra -> XPub -> ProtocolParameters -> TransactionCtx -> SelectionOf TxOut -> Either ErrMkTransaction tx

Construct a standard unsigned transaction

" Standard " here refers to the fact that we do not deal with redemption, multisignature transactions, etc.

The function returns CBOR-ed transaction body to be signed in another step.
calcMinimumCost :: AnyCardanoEra -> ProtocolParameters -> TransactionCtx -> SelectionSkeleton -> Coin

Compute a minimal fee amount necessary to pay for a given selection This also includes necessary deposits.
maxScriptExecutionCost :: ProtocolParameters -> [ Redeemer ] -> Coin

Compute the maximum execution cost of scripts in a given transaction.
evaluateMinimumFee :: forall era. IsShelleyBasedEra era => ProtocolParameters -> Tx era -> Coin

Evaluate a minimal fee amount necessary to pay for a given tx using ledger's functionality

Will estimate how many witnesses there should be , so it works even for unsigned transactions.
estimateSignedTxSize :: forall era. IsShelleyBasedEra era => ProtocolParameters -> Tx era -> TxSize

Estimate the size of the transaction when fully signed.
evaluateTransactionBalance :: forall era. IsShelleyBasedEra era => Tx era -> ProtocolParameters -> UTxO -> [( TxIn , TxOut , Maybe ( Hash "Datum"))] -> Value

Evaluate the balance of a transaction using the ledger. The balance is defined as (value consumed by transaction) - (value produced by transaction) . For a transaction to be valid, it must have a balance of zero.

Note that the fee-field of the transaction affects the balance, and is not automatically the minimum fee.

The function takes two UTxOs of different types and merges them. The reason is to workaround a combination of: 1. The wallet UTxO type doesn't support Datum hashes 2. A 'UTxO -> Cardano.UTxO' conversion function is not available in the cardano-wallet-core package, only cardano-wallet. (This package boundary will soon hopefully go away, however)
distributeSurplus :: FeePolicy -> Coin -> TxFeeAndChange [ TxOut ] -> Either ErrMoreSurplusNeeded ( TxFeeAndChange [ TxOut ])
Distributes a surplus transaction balance between the given change outputs and the given fee. This function is aware of the fact that any increase in a Coin value could increase the size and fee requirement of a transaction.

When comparing the original fee and change outputs to the adjusted fee and change outputs, this function guarantees that:
- The number of the change outputs remains constant;
- The fee quantity either remains the same or increases.
- For each change output:
- the ada quantity either remains constant or increases.
- non-ada quantities remain the same.
- The surplus is conserved: The total increase in the fee and change ada quantities is exactly equal to the surplus.
- Any increase in cost is covered: If the total cost has increased by 𝛿c, then the fee value will have increased by at least 𝛿c.
If the cost of distributing the provided surplus is greater than the surplus itself, the function will return ErrMoreSurplusNeeded . If the provided surplus is greater or equal to maximumCostOfIncreasingCoin feePolicy , the function will always return Right .
computeSelectionLimit :: AnyCardanoEra -> ProtocolParameters -> TransactionCtx -> [ TxOut ] -> SelectionLimit
tokenBundleSizeAssessor :: TokenBundleMaxSize -> TokenBundleSizeAssessor

A function to assess the size of a token bundle.
constraints :: AnyCardanoEra -> ProtocolParameters -> TxConstraints
decodeTx :: AnyCardanoEra -> tx -> ( Tx , TokenMapWithScripts , TokenMapWithScripts , [ Certificate ], Maybe ValidityIntervalExplicit )

Decode an externally-created transaction.
updateTx :: forall era. IsShelleyBasedEra era => Tx era -> TxUpdate -> Either ErrUpdateSealedTx ( Tx era)

Update tx by adding additional inputs and outputs
assignScriptRedeemers :: forall era. IsShelleyBasedEra era => ProtocolParameters -> TimeInterpreter ( Either PastHorizonException ) -> ( TxIn -> Maybe ( TxOut , Maybe ( Hash "Datum"))) -> [ Redeemer ] -> Tx era -> Either ErrAssignRedeemers ( Tx era)

data DelegationAction Source #

Whether the user is attempting any particular delegation action.

Constructors

RegisterKeyAndJoin PoolId
Join PoolId
Quit

Instances

Instances details

Eq DelegationAction Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: DelegationAction -> DelegationAction -> Bool Source # (/=) :: DelegationAction -> DelegationAction -> Bool Source #
Show DelegationAction Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> DelegationAction -> ShowS Source # show :: DelegationAction -> String Source # showList :: [ DelegationAction ] -> ShowS Source #
Generic DelegationAction Source #
Instance details Defined in Cardano.Wallet.Transaction Associated Types type Rep DelegationAction :: Type -> Type Source # Methods from :: DelegationAction -> Rep DelegationAction x Source # to :: Rep DelegationAction x -> DelegationAction Source #
Buildable DelegationAction Source #
Instance details Defined in Cardano.Wallet.Transaction Methods build :: DelegationAction -> Builder Source #
type Rep DelegationAction Source #
Instance details Defined in Cardano.Wallet.Transaction type Rep DelegationAction = D1 (' MetaData "DelegationAction" "Cardano.Wallet.Transaction" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "RegisterKeyAndJoin" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 PoolId )) :+: ( C1 (' MetaCons "Join" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 PoolId )) :+: C1 (' MetaCons "Quit" ' PrefixI ' False ) ( U1 :: Type -> Type )))

data TransactionCtx Source #

Some additional context about a transaction. This typically contains details that are known upfront about the transaction and are used to construct it from inputs selected from the wallet's UTxO.

Constructors

TransactionCtx

Fields

txWithdrawal :: Withdrawal

Withdrawal amount from a reward account, can be zero.
txMetadata :: Maybe TxMetadata

User or application-defined metadata to embed in the transaction.
txValidityInterval :: ( Maybe SlotNo , SlotNo )

Transaction optional starting slot and expiry (TTL) slot for which the transaction is valid.
txDelegationAction :: Maybe DelegationAction

An additional delegation to take.
txPlutusScriptExecutionCost :: Coin

Total execution cost of plutus scripts, determined by their execution units and prices obtained from network.
txAssetsToMint :: ( TokenMap , Map AssetId ( Script KeyHash ))

The assets to mint.
txAssetsToBurn :: ( TokenMap , Map AssetId ( Script KeyHash ))

The assets to burn.
txCollateralRequirement :: SelectionCollateralRequirement

The collateral requirement.
txFeePadding :: ! Coin

Extra fees. Some parts of a transaction are not representable using cardano-wallet types, which makes it useful to account for them like this. For instance: datums.

Instances

Instances details

Eq TransactionCtx Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: TransactionCtx -> TransactionCtx -> Bool Source # (/=) :: TransactionCtx -> TransactionCtx -> Bool Source #
Show TransactionCtx Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> TransactionCtx -> ShowS Source # show :: TransactionCtx -> String Source # showList :: [ TransactionCtx ] -> ShowS Source #
Generic TransactionCtx Source #
Instance details Defined in Cardano.Wallet.Transaction Associated Types type Rep TransactionCtx :: Type -> Type Source # Methods from :: TransactionCtx -> Rep TransactionCtx x Source # to :: Rep TransactionCtx x -> TransactionCtx Source #
type Rep TransactionCtx Source #
Instance details Defined in Cardano.Wallet.Transaction type Rep TransactionCtx = D1 (' MetaData "TransactionCtx" "Cardano.Wallet.Transaction" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "TransactionCtx" ' PrefixI ' True ) ((( S1 (' MetaSel (' Just "txWithdrawal") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Withdrawal ) :: S1 (' MetaSel (' Just "txMetadata") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe TxMetadata ))) :: ( S1 (' MetaSel (' Just "txValidityInterval") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe SlotNo , SlotNo )) :: S1 (' MetaSel (' Just "txDelegationAction") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe DelegationAction )))) :: (( S1 (' MetaSel (' Just "txPlutusScriptExecutionCost") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Coin ) :: S1 (' MetaSel (' Just "txAssetsToMint") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( TokenMap , Map AssetId ( Script KeyHash )))) :: ( S1 (' MetaSel (' Just "txAssetsToBurn") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( TokenMap , Map AssetId ( Script KeyHash ))) :: ( S1 (' MetaSel (' Just "txCollateralRequirement") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 SelectionCollateralRequirement ) :: S1 (' MetaSel (' Just "txFeePadding") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Coin ))))))

defaultTransactionCtx :: TransactionCtx Source #

A default context with sensible placeholder. Can be used to reduce repetition for changing only sub-part of the default context.

data Withdrawal Source #

Constructors

WithdrawalSelf RewardAccount ( NonEmpty DerivationIndex ) Coin
WithdrawalExternal RewardAccount ( NonEmpty DerivationIndex ) Coin
NoWithdrawal

Instances

Instances details

Eq Withdrawal Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: Withdrawal -> Withdrawal -> Bool Source # (/=) :: Withdrawal -> Withdrawal -> Bool Source #
Show Withdrawal Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> Withdrawal -> ShowS Source # show :: Withdrawal -> String Source # showList :: [ Withdrawal ] -> ShowS Source #

withdrawalToCoin :: Withdrawal -> Coin Source #

data TxUpdate Source #

Describes modifications that can be made to a Tx using $sel:updateTx:TransactionLayer .

Constructors

TxUpdate
Fields extraInputs :: [( TxIn , TxOut )] extraCollateral :: [ TxIn ] Only used in the Alonzo era and later. Will be silently ignored in previous eras. extraOutputs :: [ TxOut ] feeUpdate :: TxFeeUpdate Set a new fee or use the old one.

data TxFeeUpdate Source #

Method to use when updating the fee of a transaction.

Constructors

UseOldTxFee	Instead of updating the fee, just use the old fee of the Tx (no-op for fee update).
UseNewTxFee Coin	Specify a new fee to use instead.

Instances

Instances details

Eq TxFeeUpdate Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: TxFeeUpdate -> TxFeeUpdate -> Bool Source # (/=) :: TxFeeUpdate -> TxFeeUpdate -> Bool Source #
Show TxFeeUpdate Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> TxFeeUpdate -> ShowS Source # show :: TxFeeUpdate -> String Source # showList :: [ TxFeeUpdate ] -> ShowS Source #

data TokenMapWithScripts Source #

Constructors

TokenMapWithScripts
Fields txTokenMap :: ! TokenMap txScripts :: !( Map TokenPolicyId AnyScript )

Instances

Instances details

Eq TokenMapWithScripts Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: TokenMapWithScripts -> TokenMapWithScripts -> Bool Source # (/=) :: TokenMapWithScripts -> TokenMapWithScripts -> Bool Source #
Show TokenMapWithScripts Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> TokenMapWithScripts -> ShowS Source # show :: TokenMapWithScripts -> String Source # showList :: [ TokenMapWithScripts ] -> ShowS Source #
Generic TokenMapWithScripts Source #
Instance details Defined in Cardano.Wallet.Transaction Associated Types type Rep TokenMapWithScripts :: Type -> Type Source # Methods from :: TokenMapWithScripts -> Rep TokenMapWithScripts x Source # to :: Rep TokenMapWithScripts x -> TokenMapWithScripts Source #
type Rep TokenMapWithScripts Source #
Instance details Defined in Cardano.Wallet.Transaction type Rep TokenMapWithScripts = D1 (' MetaData "TokenMapWithScripts" "Cardano.Wallet.Transaction" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "TokenMapWithScripts" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "txTokenMap") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 TokenMap ) :*: S1 (' MetaSel (' Just "txScripts") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Map TokenPolicyId AnyScript ))))

emptyTokenMapWithScripts :: TokenMapWithScripts Source #

data AnyScript Source #

Constructors

NativeScript !( Script KeyHash )
PlutusScript ! PlutusScriptInfo

Instances

Instances details

Eq AnyScript Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: AnyScript -> AnyScript -> Bool Source # (/=) :: AnyScript -> AnyScript -> Bool Source #
Show AnyScript Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> AnyScript -> ShowS Source # show :: AnyScript -> String Source # showList :: [ AnyScript ] -> ShowS Source #
Generic AnyScript Source #
Instance details Defined in Cardano.Wallet.Transaction Associated Types type Rep AnyScript :: Type -> Type Source # Methods from :: AnyScript -> Rep AnyScript x Source # to :: Rep AnyScript x -> AnyScript Source #
NFData AnyScript Source #
Instance details Defined in Cardano.Wallet.Transaction Methods rnf :: AnyScript -> () Source #
ToJSON ( ApiT AnyScript ) Source #
Instance details Defined in Cardano.Wallet.Api.Types Methods toJSON :: ApiT AnyScript -> Value Source # toEncoding :: ApiT AnyScript -> Encoding Source # toJSONList :: [ ApiT AnyScript ] -> Value Source # toEncodingList :: [ ApiT AnyScript ] -> Encoding Source #
FromJSON ( ApiT AnyScript ) Source #
Instance details Defined in Cardano.Wallet.Api.Types Methods parseJSON :: Value -> Parser ( ApiT AnyScript ) Source # parseJSONList :: Value -> Parser [ ApiT AnyScript ] Source #
type Rep AnyScript Source #
Instance details Defined in Cardano.Wallet.Transaction type Rep AnyScript = D1 (' MetaData "AnyScript" "Cardano.Wallet.Transaction" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "NativeScript" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Script KeyHash ))) :+: C1 (' MetaCons "PlutusScript" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 PlutusScriptInfo )))

newtype PlutusScriptInfo Source #

Constructors

PlutusScriptInfo
Fields languageVersion :: PlutusVersion

Instances

Instances details

Eq PlutusScriptInfo Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: PlutusScriptInfo -> PlutusScriptInfo -> Bool Source # (/=) :: PlutusScriptInfo -> PlutusScriptInfo -> Bool Source #
Show PlutusScriptInfo Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> PlutusScriptInfo -> ShowS Source # show :: PlutusScriptInfo -> String Source # showList :: [ PlutusScriptInfo ] -> ShowS Source #
Generic PlutusScriptInfo Source #
Instance details Defined in Cardano.Wallet.Transaction Associated Types type Rep PlutusScriptInfo :: Type -> Type Source # Methods from :: PlutusScriptInfo -> Rep PlutusScriptInfo x Source # to :: Rep PlutusScriptInfo x -> PlutusScriptInfo Source #
NFData PlutusScriptInfo Source #
Instance details Defined in Cardano.Wallet.Transaction Methods rnf :: PlutusScriptInfo -> () Source #
ToJSON PlutusScriptInfo Source #
Instance details Defined in Cardano.Wallet.Transaction Methods toJSON :: PlutusScriptInfo -> Value Source # toEncoding :: PlutusScriptInfo -> Encoding Source # toJSONList :: [ PlutusScriptInfo ] -> Value Source # toEncodingList :: [ PlutusScriptInfo ] -> Encoding Source #
FromJSON PlutusScriptInfo Source #
Instance details Defined in Cardano.Wallet.Transaction Methods parseJSON :: Value -> Parser PlutusScriptInfo Source # parseJSONList :: Value -> Parser [ PlutusScriptInfo ] Source #
type Rep PlutusScriptInfo Source #
Instance details Defined in Cardano.Wallet.Transaction type Rep PlutusScriptInfo = D1 (' MetaData "PlutusScriptInfo" "Cardano.Wallet.Transaction" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "PlutusScriptInfo" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "languageVersion") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 PlutusVersion )))

data PlutusVersion Source #

Constructors

PlutusVersionV1
PlutusVersionV2

Instances

Instances details

Eq PlutusVersion Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: PlutusVersion -> PlutusVersion -> Bool Source # (/=) :: PlutusVersion -> PlutusVersion -> Bool Source #
Show PlutusVersion Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> PlutusVersion -> ShowS Source # show :: PlutusVersion -> String Source # showList :: [ PlutusVersion ] -> ShowS Source #
Generic PlutusVersion Source #
Instance details Defined in Cardano.Wallet.Transaction Associated Types type Rep PlutusVersion :: Type -> Type Source # Methods from :: PlutusVersion -> Rep PlutusVersion x Source # to :: Rep PlutusVersion x -> PlutusVersion Source #
NFData PlutusVersion Source #
Instance details Defined in Cardano.Wallet.Transaction Methods rnf :: PlutusVersion -> () Source #
ToText PlutusVersion Source #
Instance details Defined in Cardano.Wallet.Transaction Methods toText :: PlutusVersion -> Text Source #
FromText PlutusVersion Source #
Instance details Defined in Cardano.Wallet.Transaction Methods fromText :: Text -> Either TextDecodingError PlutusVersion Source #
type Rep PlutusVersion Source #
Instance details Defined in Cardano.Wallet.Transaction type Rep PlutusVersion = D1 (' MetaData "PlutusVersion" "Cardano.Wallet.Transaction" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "PlutusVersionV1" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "PlutusVersionV2" ' PrefixI ' False ) ( U1 :: Type -> Type ))

data TxFeeAndChange change Source #

Small helper record to disambiguate between a fee and change Coin values. Used by $sel:distributeSurplus:TransactionLayer .

Constructors

TxFeeAndChange
Fields fee :: Coin change :: change

Instances

Instances details

Eq change => Eq ( TxFeeAndChange change) Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: TxFeeAndChange change -> TxFeeAndChange change -> Bool Source # (/=) :: TxFeeAndChange change -> TxFeeAndChange change -> Bool Source #
Show change => Show ( TxFeeAndChange change) Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> TxFeeAndChange change -> ShowS Source # show :: TxFeeAndChange change -> String Source # showList :: [ TxFeeAndChange change] -> ShowS Source #

mapTxFeeAndChange Source #

Arguments

:: ( Coin -> Coin )	A function to transform the fee
-> (change1 -> change2)	A function to transform the change
-> TxFeeAndChange change1	The original fee and change
-> TxFeeAndChange change2	The transformed fee and change

Manipulates a TxFeeAndChange value.

data ValidityIntervalExplicit Source #

Constructors

ValidityIntervalExplicit
Fields invalidBefore :: !( Quantity "slot" Word64 ) invalidHereafter :: !( Quantity "slot" Word64 )

Instances

Instances details

Eq ValidityIntervalExplicit Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: ValidityIntervalExplicit -> ValidityIntervalExplicit -> Bool Source # (/=) :: ValidityIntervalExplicit -> ValidityIntervalExplicit -> Bool Source #
Show ValidityIntervalExplicit Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> ValidityIntervalExplicit -> ShowS Source # show :: ValidityIntervalExplicit -> String Source # showList :: [ ValidityIntervalExplicit ] -> ShowS Source #
Generic ValidityIntervalExplicit Source #
Instance details Defined in Cardano.Wallet.Transaction Associated Types type Rep ValidityIntervalExplicit :: Type -> Type Source # Methods from :: ValidityIntervalExplicit -> Rep ValidityIntervalExplicit x Source # to :: Rep ValidityIntervalExplicit x -> ValidityIntervalExplicit Source #
NFData ValidityIntervalExplicit Source #
Instance details Defined in Cardano.Wallet.Transaction Methods rnf :: ValidityIntervalExplicit -> () Source #
ToJSON ValidityIntervalExplicit Source #
Instance details Defined in Cardano.Wallet.Transaction Methods toJSON :: ValidityIntervalExplicit -> Value Source # toEncoding :: ValidityIntervalExplicit -> Encoding Source # toJSONList :: [ ValidityIntervalExplicit ] -> Value Source # toEncodingList :: [ ValidityIntervalExplicit ] -> Encoding Source #
FromJSON ValidityIntervalExplicit Source #
Instance details Defined in Cardano.Wallet.Transaction Methods parseJSON :: Value -> Parser ValidityIntervalExplicit Source # parseJSONList :: Value -> Parser [ ValidityIntervalExplicit ] Source #
type Rep ValidityIntervalExplicit Source #
Instance details Defined in Cardano.Wallet.Transaction type Rep ValidityIntervalExplicit = D1 (' MetaData "ValidityIntervalExplicit" "Cardano.Wallet.Transaction" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "ValidityIntervalExplicit" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "invalidBefore") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Quantity "slot" Word64 )) :*: S1 (' MetaSel (' Just "invalidHereafter") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Quantity "slot" Word64 ))))

Errors

data ErrSignTx Source #

Possible signing error

Constructors

ErrSignTxAddressUnknown TxIn	We tried to sign a transaction with inputs that are unknown to us?
ErrSignTxUnimplemented	TODO: [ADP-919] Remove ErrSignTxUnimplemented

Instances

Instances details

Eq ErrSignTx Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: ErrSignTx -> ErrSignTx -> Bool Source # (/=) :: ErrSignTx -> ErrSignTx -> Bool Source #
Show ErrSignTx Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> ErrSignTx -> ShowS Source # show :: ErrSignTx -> String Source # showList :: [ ErrSignTx ] -> ShowS Source #
Generic ErrSignTx Source #
Instance details Defined in Cardano.Wallet.Transaction Associated Types type Rep ErrSignTx :: Type -> Type Source # Methods from :: ErrSignTx -> Rep ErrSignTx x Source # to :: Rep ErrSignTx x -> ErrSignTx Source #
IsServerError ErrSignTx Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrSignTx -> ServerError Source #
type Rep ErrSignTx Source #
Instance details Defined in Cardano.Wallet.Transaction type Rep ErrSignTx = D1 (' MetaData "ErrSignTx" "Cardano.Wallet.Transaction" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "ErrSignTxAddressUnknown" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 TxIn )) :+: C1 (' MetaCons "ErrSignTxUnimplemented" ' PrefixI ' False ) ( U1 :: Type -> Type ))

data ErrMkTransaction Source #

Constructors

ErrMkTransactionNoSuchWallet WalletId
ErrMkTransactionTxBodyError Text	We failed to construct a transaction for some reasons.
ErrMkTransactionInvalidEra AnyCardanoEra	Should never happen, means that that we have programmatically provided an invalid era.
ErrMkTransactionJoinStakePool ErrCannotJoin
ErrMkTransactionQuitStakePool ErrCannotQuit
ErrMkTransactionIncorrectTTL PastHorizonException

Instances

Instances details

Eq ErrMkTransaction Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: ErrMkTransaction -> ErrMkTransaction -> Bool Source # (/=) :: ErrMkTransaction -> ErrMkTransaction -> Bool Source #
Show ErrMkTransaction Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> ErrMkTransaction -> ShowS Source # show :: ErrMkTransaction -> String Source # showList :: [ ErrMkTransaction ] -> ShowS Source #
Generic ErrMkTransaction Source #
Instance details Defined in Cardano.Wallet.Transaction Associated Types type Rep ErrMkTransaction :: Type -> Type Source # Methods from :: ErrMkTransaction -> Rep ErrMkTransaction x Source # to :: Rep ErrMkTransaction x -> ErrMkTransaction Source #
IsServerError ErrMkTransaction Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrMkTransaction -> ServerError Source #
type Rep ErrMkTransaction Source #
Instance details Defined in Cardano.Wallet.Transaction type Rep ErrMkTransaction = D1 (' MetaData "ErrMkTransaction" "Cardano.Wallet.Transaction" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) (( C1 (' MetaCons "ErrMkTransactionNoSuchWallet" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 WalletId )) :+: ( C1 (' MetaCons "ErrMkTransactionTxBodyError" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Text )) :+: C1 (' MetaCons "ErrMkTransactionInvalidEra" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 AnyCardanoEra )))) :+: ( C1 (' MetaCons "ErrMkTransactionJoinStakePool" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ErrCannotJoin )) :+: ( C1 (' MetaCons "ErrMkTransactionQuitStakePool" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ErrCannotQuit )) :+: C1 (' MetaCons "ErrMkTransactionIncorrectTTL" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 PastHorizonException )))))

data ErrCannotJoin Source #

Constructors

ErrAlreadyDelegating PoolId
ErrNoSuchPool PoolId

Instances

Instances details

Eq ErrCannotJoin Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: ErrCannotJoin -> ErrCannotJoin -> Bool Source # (/=) :: ErrCannotJoin -> ErrCannotJoin -> Bool Source #
Show ErrCannotJoin Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> ErrCannotJoin -> ShowS Source # show :: ErrCannotJoin -> String Source # showList :: [ ErrCannotJoin ] -> ShowS Source #
Generic ErrCannotJoin Source #
Instance details Defined in Cardano.Wallet.Transaction Associated Types type Rep ErrCannotJoin :: Type -> Type Source # Methods from :: ErrCannotJoin -> Rep ErrCannotJoin x Source # to :: Rep ErrCannotJoin x -> ErrCannotJoin Source #
IsServerError ErrCannotJoin Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrCannotJoin -> ServerError Source #
type Rep ErrCannotJoin Source #
Instance details Defined in Cardano.Wallet.Transaction type Rep ErrCannotJoin = D1 (' MetaData "ErrCannotJoin" "Cardano.Wallet.Transaction" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "ErrAlreadyDelegating" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 PoolId )) :+: C1 (' MetaCons "ErrNoSuchPool" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 PoolId )))

data ErrCannotQuit Source #

Constructors

ErrNotDelegatingOrAboutTo
ErrNonNullRewards Coin

Instances

Instances details

Eq ErrCannotQuit Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: ErrCannotQuit -> ErrCannotQuit -> Bool Source # (/=) :: ErrCannotQuit -> ErrCannotQuit -> Bool Source #
Show ErrCannotQuit Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> ErrCannotQuit -> ShowS Source # show :: ErrCannotQuit -> String Source # showList :: [ ErrCannotQuit ] -> ShowS Source #
IsServerError ErrCannotQuit Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrCannotQuit -> ServerError Source #

newtype ErrUpdateSealedTx Source #

Constructors

ErrExistingKeyWitnesses Int

The SealedTx couldn't not be updated because the *n* existing key-witnesses would have been rendered invalid.

Instances

Instances details

Eq ErrUpdateSealedTx Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: ErrUpdateSealedTx -> ErrUpdateSealedTx -> Bool Source # (/=) :: ErrUpdateSealedTx -> ErrUpdateSealedTx -> Bool Source #
Show ErrUpdateSealedTx Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> ErrUpdateSealedTx -> ShowS Source # show :: ErrUpdateSealedTx -> String Source # showList :: [ ErrUpdateSealedTx ] -> ShowS Source #
Generic ErrUpdateSealedTx Source #
Instance details Defined in Cardano.Wallet.Transaction Associated Types type Rep ErrUpdateSealedTx :: Type -> Type Source # Methods from :: ErrUpdateSealedTx -> Rep ErrUpdateSealedTx x Source # to :: Rep ErrUpdateSealedTx x -> ErrUpdateSealedTx Source #
IsServerError ErrUpdateSealedTx Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrUpdateSealedTx -> ServerError Source #
type Rep ErrUpdateSealedTx Source #
Instance details Defined in Cardano.Wallet.Transaction type Rep ErrUpdateSealedTx = D1 (' MetaData "ErrUpdateSealedTx" "Cardano.Wallet.Transaction" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "ErrExistingKeyWitnesses" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Int )))

data ErrAssignRedeemers Source #

Constructors

ErrAssignRedeemersScriptFailure Redeemer String	Failed to assign execution units for a particular redeemer. The `String` indicates the reason of the failure. TODO: Refine this type to avoid the `String` and provides a better sum-type of possible errors.
ErrAssignRedeemersTargetNotFound Redeemer	The given redeemer target couldn't be located in the transaction.
ErrAssignRedeemersInvalidData Redeemer String	Redeemer's data isn't a valid Plutus' data.
ErrAssignRedeemersTranslationError ( TranslationError StandardCrypto )	Mistranslating of hashes, credentials, certificates etc.

Instances

Instances details

Eq ErrAssignRedeemers Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: ErrAssignRedeemers -> ErrAssignRedeemers -> Bool Source # (/=) :: ErrAssignRedeemers -> ErrAssignRedeemers -> Bool Source #
Show ErrAssignRedeemers Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> ErrAssignRedeemers -> ShowS Source # show :: ErrAssignRedeemers -> String Source # showList :: [ ErrAssignRedeemers ] -> ShowS Source #
Generic ErrAssignRedeemers Source #
Instance details Defined in Cardano.Wallet.Transaction Associated Types type Rep ErrAssignRedeemers :: Type -> Type Source # Methods from :: ErrAssignRedeemers -> Rep ErrAssignRedeemers x Source # to :: Rep ErrAssignRedeemers x -> ErrAssignRedeemers Source #
IsServerError ErrAssignRedeemers Source #
Instance details Defined in Cardano.Wallet.Api.Server Methods toServerError :: ErrAssignRedeemers -> ServerError Source #
type Rep ErrAssignRedeemers Source #
Instance details Defined in Cardano.Wallet.Transaction type Rep ErrAssignRedeemers = D1 (' MetaData "ErrAssignRedeemers" "Cardano.Wallet.Transaction" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) (( C1 (' MetaCons "ErrAssignRedeemersScriptFailure" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Redeemer ) :: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 String )) :+: C1 (' MetaCons "ErrAssignRedeemersTargetNotFound" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Redeemer ))) :+: ( C1 (' MetaCons "ErrAssignRedeemersInvalidData" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Redeemer ) :: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 String )) :+: C1 (' MetaCons "ErrAssignRedeemersTranslationError" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( TranslationError StandardCrypto )))))

newtype ErrMoreSurplusNeeded Source #

Error for when its impossible for $sel:distributeSurplus:TransactionLayer to distribute the surplus. As long as the surplus is larger than costOfIncreasingCoin , this should never happen.

Constructors

ErrMoreSurplusNeeded Coin

Instances

Instances details

Eq ErrMoreSurplusNeeded Source #
Instance details Defined in Cardano.Wallet.Transaction Methods (==) :: ErrMoreSurplusNeeded -> ErrMoreSurplusNeeded -> Bool Source # (/=) :: ErrMoreSurplusNeeded -> ErrMoreSurplusNeeded -> Bool Source #
Show ErrMoreSurplusNeeded Source #
Instance details Defined in Cardano.Wallet.Transaction Methods showsPrec :: Int -> ErrMoreSurplusNeeded -> ShowS Source # show :: ErrMoreSurplusNeeded -> String Source # showList :: [ ErrMoreSurplusNeeded ] -> ShowS Source #
Generic ErrMoreSurplusNeeded Source #
Instance details Defined in Cardano.Wallet.Transaction Associated Types type Rep ErrMoreSurplusNeeded :: Type -> Type Source # Methods from :: ErrMoreSurplusNeeded -> Rep ErrMoreSurplusNeeded x Source # to :: Rep ErrMoreSurplusNeeded x -> ErrMoreSurplusNeeded Source #
type Rep ErrMoreSurplusNeeded Source #
Instance details Defined in Cardano.Wallet.Transaction type Rep ErrMoreSurplusNeeded = D1 (' MetaData "ErrMoreSurplusNeeded" "Cardano.Wallet.Transaction" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "ErrMoreSurplusNeeded" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Coin )))