| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Cardano.Ledger.Shelley.UTxO
Contents
Synopsis
- class EraTx era ⇒ EraUTxO era where
- type ScriptsNeeded era = (r ∷ Type) | r → era
- getConsumedValue ∷ ∀ (t ∷ TxLevel). PParams era → (Credential 'Staking → Maybe Coin) → UTxO era → TxBody t era → Value era
- getProducedValue ∷ PParams era → (KeyHash 'StakePool → Bool) → TxBody 'TopTx era → Value era
- getScriptsProvided ∷ ∀ (t ∷ TxLevel). UTxO era → Tx t era → ScriptsProvided era
- getScriptsNeeded ∷ ∀ (t ∷ TxLevel). UTxO era → TxBody t era → ScriptsNeeded era
- getScriptsHashesNeeded ∷ ScriptsNeeded era → Set ScriptHash
- getWitsVKeyNeeded ∷ ∀ (t ∷ TxLevel). CertState era → UTxO era → TxBody t era → Set (KeyHash 'Witness)
- getMinFeeTxUtxo ∷ ∀ (t ∷ TxLevel). PParams era → Tx t era → UTxO era → Coin
- newtype ShelleyScriptsNeeded era = ShelleyScriptsNeeded (Set ScriptHash)
- getShelleyScriptsNeeded ∷ ∀ era (l ∷ TxLevel). EraTxBody era ⇒ UTxO era → TxBody l era → ShelleyScriptsNeeded era
- getConsumedCoin ∷ ∀ era (l ∷ TxLevel). EraTxBody era ⇒ PParams era → (Credential 'Staking → Maybe Coin) → UTxO era → TxBody l era → Coin
- shelleyProducedValue ∷ EraTxBody era ⇒ PParams era → (KeyHash 'StakePool → Bool) → TxBody 'TopTx era → Value era
- shelleyConsumed ∷ ∀ era (l ∷ TxLevel). (EraUTxO era, EraCertState era) ⇒ PParams era → Accounts era → UTxO era → TxBody l era → Value era
- produced ∷ EraUTxO era ⇒ PParams era → PState era → TxBody 'TopTx era → Value era
- getShelleyMinFeeTxUtxo ∷ ∀ era (l ∷ TxLevel). EraTx era ⇒ PParams era → Tx l era → Coin
- getShelleyWitsVKeyNeeded ∷ ∀ era (l ∷ TxLevel). (EraTx era, ShelleyEraTxBody era, EraCertState era, STxLevel l era ~ STxTopLevel l era) ⇒ CertState era → UTxO era → TxBody l era → Set (KeyHash 'Witness)
- getShelleyWitsVKeyNeededNoGov ∷ ∀ era (l ∷ TxLevel). EraTx era ⇒ UTxO era → TxBody l era → Set (KeyHash 'Witness)
- newtype UTxO era = UTxO {}
- class EraTx era ⇒ EraUTxO era where
- type ScriptsNeeded era = (r ∷ Type) | r → era
- getConsumedValue ∷ ∀ (t ∷ TxLevel). PParams era → (Credential 'Staking → Maybe Coin) → UTxO era → TxBody t era → Value era
- getProducedValue ∷ PParams era → (KeyHash 'StakePool → Bool) → TxBody 'TopTx era → Value era
- getScriptsProvided ∷ ∀ (t ∷ TxLevel). UTxO era → Tx t era → ScriptsProvided era
- getScriptsNeeded ∷ ∀ (t ∷ TxLevel). UTxO era → TxBody t era → ScriptsNeeded era
- getScriptsHashesNeeded ∷ ScriptsNeeded era → Set ScriptHash
- getWitsVKeyNeeded ∷ ∀ (t ∷ TxLevel). CertState era → UTxO era → TxBody t era → Set (KeyHash 'Witness)
- getMinFeeTxUtxo ∷ ∀ (t ∷ TxLevel). PParams era → Tx t era → UTxO era → Coin
- type family ScriptsNeeded era = (r ∷ Type) | r → era
- newtype ScriptsProvided era = ScriptsProvided {
- unScriptsProvided ∷ Map ScriptHash (Script era)
- class CanGetUTxO t ⇒ CanSetUTxO (t ∷ Type → Type) where
- class CanGetUTxO (t ∷ Type → Type) where
- utxoG ∷ SimpleGetter (t era) (UTxO era)
- txins ∷ ∀ era (t ∷ TxLevel). EraTxBody era ⇒ TxBody t era → Set TxIn
- txouts ∷ ∀ era (l ∷ TxLevel). EraTxBody era ⇒ TxBody l era → UTxO era
- txinLookup ∷ TxIn → UTxO era → Maybe (TxOut era)
- txInsFilter ∷ UTxO era → Set TxIn → UTxO era
- verifyWitVKey ∷ ∀ (kr ∷ KeyRole). Hash HASH EraIndependentTxBody → WitVKey kr → Bool
- sumUTxO ∷ EraTxOut era ⇒ UTxO era → Value era
- sumCoinUTxO ∷ EraTxOut era ⇒ UTxO era → Coin
- sumAllValue ∷ (EraTxOut era, Foldable f) ⇒ f (TxOut era) → Value era
- sumAllCoin ∷ (EraTxOut era, Foldable f) ⇒ f (TxOut era) → Coin
- areAllAdaOnly ∷ (EraTxOut era, Foldable f) ⇒ f (TxOut era) → Bool
- getScriptHash ∷ Addr → Maybe ScriptHash
Documentation
class EraTx era ⇒ EraUTxO era where Source #
Associated Types
type ScriptsNeeded era = (r ∷ Type) | r → era Source #
A customizable type on per era basis for the information required to find all scripts needed for the transaction.
Methods
Arguments
| ∷ ∀ (t ∷ TxLevel). PParams era | |
| → (Credential 'Staking → Maybe Coin) | Function that can lookup current delegation deposits |
| → UTxO era | |
| → TxBody t era | |
| → Value era |
Calculate all the value that is being consumed by the transaction.
Arguments
| ∷ PParams era | |
| → (KeyHash 'StakePool → Bool) | Check whether a pool with a supplied PoolStakeId is already registered. |
| → TxBody 'TopTx era | |
| → Value era |
Arguments
| ∷ ∀ (t ∷ TxLevel). UTxO era | For some era it is necessary to look into the UTxO to find all of the available scripts for the transaction |
| → Tx t era | |
| → ScriptsProvided era |
Initial eras will look into witness set to find all of the available scripts, but starting with Babbage we can look for available scripts in the UTxO using reference inputs.
getScriptsNeeded ∷ ∀ (t ∷ TxLevel). UTxO era → TxBody t era → ScriptsNeeded era Source #
Produce all the information required for figuring out which scripts are required for the transaction to be valid, once those scripts are evaluated
getScriptsHashesNeeded ∷ ScriptsNeeded era → Set ScriptHash Source #
Extract the set of all script hashes that are needed for script validation.
getWitsVKeyNeeded ∷ ∀ (t ∷ TxLevel). CertState era → UTxO era → TxBody t era → Set (KeyHash 'Witness) Source #
Extract all of the KeyHash witnesses that are required for validating the transaction
getMinFeeTxUtxo ∷ ∀ (t ∷ TxLevel). PParams era → Tx t era → UTxO era → Coin Source #
Minimum fee computation, excluding witnesses and including ref scripts size
Instances
| EraUTxO ShelleyEra Source # | |||||
Defined in Cardano.Ledger.Shelley.UTxO Associated Types
Methods getConsumedValue ∷ ∀ (t ∷ TxLevel). PParams ShelleyEra → (Credential 'Staking → Maybe Coin) → UTxO ShelleyEra → TxBody t ShelleyEra → Value ShelleyEra Source # getProducedValue ∷ PParams ShelleyEra → (KeyHash 'StakePool → Bool) → TxBody 'TopTx ShelleyEra → Value ShelleyEra Source # getScriptsProvided ∷ ∀ (t ∷ TxLevel). UTxO ShelleyEra → Tx t ShelleyEra → ScriptsProvided ShelleyEra Source # getScriptsNeeded ∷ ∀ (t ∷ TxLevel). UTxO ShelleyEra → TxBody t ShelleyEra → ScriptsNeeded ShelleyEra Source # getScriptsHashesNeeded ∷ ScriptsNeeded ShelleyEra → Set ScriptHash Source # getWitsVKeyNeeded ∷ ∀ (t ∷ TxLevel). CertState ShelleyEra → UTxO ShelleyEra → TxBody t ShelleyEra → Set (KeyHash 'Witness) Source # getMinFeeTxUtxo ∷ ∀ (t ∷ TxLevel). PParams ShelleyEra → Tx t ShelleyEra → UTxO ShelleyEra → Coin Source # | |||||
newtype ShelleyScriptsNeeded era Source #
Constructors
| ShelleyScriptsNeeded (Set ScriptHash) |
Instances
getShelleyScriptsNeeded ∷ ∀ era (l ∷ TxLevel). EraTxBody era ⇒ UTxO era → TxBody l era → ShelleyScriptsNeeded era Source #
getConsumedCoin ∷ ∀ era (l ∷ TxLevel). EraTxBody era ⇒ PParams era → (Credential 'Staking → Maybe Coin) → UTxO era → TxBody l era → Coin Source #
Compute the lovelace which are destroyed by the transaction. This implementation is suitable for Shelley and Allegra only.
shelleyConsumed ∷ ∀ era (l ∷ TxLevel). (EraUTxO era, EraCertState era) ⇒ PParams era → Accounts era → UTxO era → TxBody l era → Value era Source #
Shelley version of consumed will work for all eras, however, starting with Dijkstra era it becomes simpler, because it will no longer require access to Accounts.
produced ∷ EraUTxO era ⇒ PParams era → PState era → TxBody 'TopTx era → Value era Source #
Compute the lovelace which are created by the transaction For eras before Conway, VState is expected to have an empty Map for vsDReps, and so deposit summed up is zero.
getShelleyWitsVKeyNeeded ∷ ∀ era (l ∷ TxLevel). (EraTx era, ShelleyEraTxBody era, EraCertState era, STxLevel l era ~ STxTopLevel l era) ⇒ CertState era → UTxO era → TxBody l era → Set (KeyHash 'Witness) Source #
getShelleyWitsVKeyNeededNoGov ∷ ∀ era (l ∷ TxLevel). EraTx era ⇒ UTxO era → TxBody l era → Set (KeyHash 'Witness) Source #
Extract witnesses from UTxO and TxBody. Does not enforce witnesses for governance
related Keys, i.e. GenDelegs
The unspent transaction outputs.
Instances
| CanGetUTxO UTxO | |||||
Defined in Cardano.Ledger.State.UTxO | |||||
| CanSetUTxO UTxO | |||||
| ToJSON (TxOut era) ⇒ ToJSON (UTxO era) | |||||
| (Era era, DecShareCBOR (TxOut era), Share (TxOut era) ~ Interns (Credential 'Staking)) ⇒ FromCBOR (UTxO era) | |||||
| (Era era, EncCBOR (TxOut era)) ⇒ ToCBOR (UTxO era) | |||||
| (Era era, DecShareCBOR (TxOut era), Share (TxOut era) ~ Interns (Credential 'Staking)) ⇒ DecCBOR (UTxO era) | |||||
| (DecShareCBOR (TxOut era), Share (TxOut era) ~ Interns (Credential 'Staking)) ⇒ DecShareCBOR (UTxO era) | |||||
| (Era era, EncCBOR (TxOut era)) ⇒ EncCBOR (UTxO era) | |||||
| Default (UTxO era) | |||||
Defined in Cardano.Ledger.State.UTxO | |||||
| (Era era, NFData (TxOut era)) ⇒ NFData (UTxO era) | |||||
Defined in Cardano.Ledger.State.UTxO | |||||
| Era era ⇒ Monoid (UTxO era) | |||||
| Semigroup (UTxO era) | |||||
| Generic (UTxO era) | |||||
Defined in Cardano.Ledger.State.UTxO Associated Types
| |||||
| Show (TxOut era) ⇒ Show (UTxO era) | |||||
| (Era era, Eq (TxOut era)) ⇒ Eq (UTxO era) | |||||
| NoThunks (TxOut era) ⇒ NoThunks (UTxO era) | |||||
| type Share (UTxO era) | |||||
| type Rep (UTxO era) | |||||
Defined in Cardano.Ledger.State.UTxO | |||||
class EraTx era ⇒ EraUTxO era where Source #
Associated Types
type ScriptsNeeded era = (r ∷ Type) | r → era Source #
A customizable type on per era basis for the information required to find all scripts needed for the transaction.
Methods
Arguments
| ∷ ∀ (t ∷ TxLevel). PParams era | |
| → (Credential 'Staking → Maybe Coin) | Function that can lookup current delegation deposits |
| → UTxO era | |
| → TxBody t era | |
| → Value era |
Calculate all the value that is being consumed by the transaction.
Arguments
| ∷ PParams era | |
| → (KeyHash 'StakePool → Bool) | Check whether a pool with a supplied PoolStakeId is already registered. |
| → TxBody 'TopTx era | |
| → Value era |
Arguments
| ∷ ∀ (t ∷ TxLevel). UTxO era | For some era it is necessary to look into the UTxO to find all of the available scripts for the transaction |
| → Tx t era | |
| → ScriptsProvided era |
Initial eras will look into witness set to find all of the available scripts, but starting with Babbage we can look for available scripts in the UTxO using reference inputs.
getScriptsNeeded ∷ ∀ (t ∷ TxLevel). UTxO era → TxBody t era → ScriptsNeeded era Source #
Produce all the information required for figuring out which scripts are required for the transaction to be valid, once those scripts are evaluated
getScriptsHashesNeeded ∷ ScriptsNeeded era → Set ScriptHash Source #
Extract the set of all script hashes that are needed for script validation.
getWitsVKeyNeeded ∷ ∀ (t ∷ TxLevel). CertState era → UTxO era → TxBody t era → Set (KeyHash 'Witness) Source #
Extract all of the KeyHash witnesses that are required for validating the transaction
getMinFeeTxUtxo ∷ ∀ (t ∷ TxLevel). PParams era → Tx t era → UTxO era → Coin Source #
Minimum fee computation, excluding witnesses and including ref scripts size
Instances
| EraUTxO ShelleyEra Source # | |||||
Defined in Cardano.Ledger.Shelley.UTxO Associated Types
Methods getConsumedValue ∷ ∀ (t ∷ TxLevel). PParams ShelleyEra → (Credential 'Staking → Maybe Coin) → UTxO ShelleyEra → TxBody t ShelleyEra → Value ShelleyEra Source # getProducedValue ∷ PParams ShelleyEra → (KeyHash 'StakePool → Bool) → TxBody 'TopTx ShelleyEra → Value ShelleyEra Source # getScriptsProvided ∷ ∀ (t ∷ TxLevel). UTxO ShelleyEra → Tx t ShelleyEra → ScriptsProvided ShelleyEra Source # getScriptsNeeded ∷ ∀ (t ∷ TxLevel). UTxO ShelleyEra → TxBody t ShelleyEra → ScriptsNeeded ShelleyEra Source # getScriptsHashesNeeded ∷ ScriptsNeeded ShelleyEra → Set ScriptHash Source # getWitsVKeyNeeded ∷ ∀ (t ∷ TxLevel). CertState ShelleyEra → UTxO ShelleyEra → TxBody t ShelleyEra → Set (KeyHash 'Witness) Source # getMinFeeTxUtxo ∷ ∀ (t ∷ TxLevel). PParams ShelleyEra → Tx t ShelleyEra → UTxO ShelleyEra → Coin Source # | |||||
type family ScriptsNeeded era = (r ∷ Type) | r → era Source #
A customizable type on per era basis for the information required to find all scripts needed for the transaction.
Instances
| type ScriptsNeeded ShelleyEra Source # | |
Defined in Cardano.Ledger.Shelley.UTxO | |
newtype ScriptsProvided era Source #
The only reason it is a newtype instead of just a Map is because for later eras it is expensive to compute the actual map, so we want to use the type safety guidance to avoid redundant work.
Constructors
| ScriptsProvided | |
Fields
| |
Instances
| (Era era, NFData (Script era)) ⇒ NFData (ScriptsProvided era) | |||||
Defined in Cardano.Ledger.State.UTxO Methods rnf ∷ ScriptsProvided era → () # | |||||
| Generic (ScriptsProvided era) | |||||
Defined in Cardano.Ledger.State.UTxO Associated Types
Methods from ∷ ScriptsProvided era → Rep (ScriptsProvided era) x # to ∷ Rep (ScriptsProvided era) x → ScriptsProvided era # | |||||
| (Era era, Show (Script era)) ⇒ Show (ScriptsProvided era) | |||||
Defined in Cardano.Ledger.State.UTxO Methods showsPrec ∷ Int → ScriptsProvided era → ShowS # show ∷ ScriptsProvided era → String # showList ∷ [ScriptsProvided era] → ShowS # | |||||
| (Era era, Eq (Script era)) ⇒ Eq (ScriptsProvided era) | |||||
Defined in Cardano.Ledger.State.UTxO Methods (==) ∷ ScriptsProvided era → ScriptsProvided era → Bool # (/=) ∷ ScriptsProvided era → ScriptsProvided era → Bool # | |||||
| (Era era, Ord (Script era)) ⇒ Ord (ScriptsProvided era) | |||||
Defined in Cardano.Ledger.State.UTxO Methods compare ∷ ScriptsProvided era → ScriptsProvided era → Ordering # (<) ∷ ScriptsProvided era → ScriptsProvided era → Bool # (<=) ∷ ScriptsProvided era → ScriptsProvided era → Bool # (>) ∷ ScriptsProvided era → ScriptsProvided era → Bool # (>=) ∷ ScriptsProvided era → ScriptsProvided era → Bool # max ∷ ScriptsProvided era → ScriptsProvided era → ScriptsProvided era # min ∷ ScriptsProvided era → ScriptsProvided era → ScriptsProvided era # | |||||
| type Rep (ScriptsProvided era) | |||||
Defined in Cardano.Ledger.State.UTxO type Rep (ScriptsProvided era) = D1 ('MetaData "ScriptsProvided" "Cardano.Ledger.State.UTxO" "cardano-ledger-core-1.23.0.0-inplace" 'True) (C1 ('MetaCons "ScriptsProvided" 'PrefixI 'True) (S1 ('MetaSel ('Just "unScriptsProvided") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map ScriptHash (Script era))))) | |||||
class CanGetUTxO t ⇒ CanSetUTxO (t ∷ Type → Type) where Source #
Instances
class CanGetUTxO (t ∷ Type → Type) where Source #
Minimal complete definition
Nothing
Methods
utxoG ∷ SimpleGetter (t era) (UTxO era) Source #
default utxoG ∷ CanSetUTxO t ⇒ SimpleGetter (t era) (UTxO era) Source #
Instances
| CanGetUTxO UTxO | |
Defined in Cardano.Ledger.State.UTxO | |
| CanGetUTxO EpochState Source # | |
Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoG ∷ SimpleGetter (EpochState era) (UTxO era) Source # | |
| CanGetUTxO LedgerState Source # | |
Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoG ∷ SimpleGetter (LedgerState era) (UTxO era) Source # | |
| CanGetUTxO NewEpochState Source # | |
Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoG ∷ SimpleGetter (NewEpochState era) (UTxO era) Source # | |
| CanGetUTxO UTxOState Source # | |
Defined in Cardano.Ledger.Shelley.LedgerState.Types | |
txins ∷ ∀ era (t ∷ TxLevel). EraTxBody era ⇒ TxBody t era → Set TxIn Source #
Compute the UTxO inputs of a transaction. txins has the same problems as txouts, see notes below.
txouts ∷ ∀ era (l ∷ TxLevel). EraTxBody era ⇒ TxBody l era → UTxO era Source #
Compute the transaction outputs of a transaction.
Filter out TxIn's from the UTxO map
verifyWitVKey ∷ ∀ (kr ∷ KeyRole). Hash HASH EraIndependentTxBody → WitVKey kr → Bool Source #
Verify a transaction body witness
sumUTxO ∷ EraTxOut era ⇒ UTxO era → Value era Source #
Determine the total balance contained in the UTxO.
sumAllValue ∷ (EraTxOut era, Foldable f) ⇒ f (TxOut era) → Value era Source #
Sum all the value in any Foldable with TxOuts
areAllAdaOnly ∷ (EraTxOut era, Foldable f) ⇒ f (TxOut era) → Bool Source #
Check whether any of the supplied TxOuts contain any MultiAssets. Returns
True if non of them do.
getScriptHash ∷ Addr → Maybe ScriptHash Source #
Extract script hash from value address with script.
Orphan instances
| EraUTxO ShelleyEra Source # | |||||
Associated Types
Methods getConsumedValue ∷ ∀ (t ∷ TxLevel). PParams ShelleyEra → (Credential 'Staking → Maybe Coin) → UTxO ShelleyEra → TxBody t ShelleyEra → Value ShelleyEra Source # getProducedValue ∷ PParams ShelleyEra → (KeyHash 'StakePool → Bool) → TxBody 'TopTx ShelleyEra → Value ShelleyEra Source # getScriptsProvided ∷ ∀ (t ∷ TxLevel). UTxO ShelleyEra → Tx t ShelleyEra → ScriptsProvided ShelleyEra Source # getScriptsNeeded ∷ ∀ (t ∷ TxLevel). UTxO ShelleyEra → TxBody t ShelleyEra → ScriptsNeeded ShelleyEra Source # getScriptsHashesNeeded ∷ ScriptsNeeded ShelleyEra → Set ScriptHash Source # getWitsVKeyNeeded ∷ ∀ (t ∷ TxLevel). CertState ShelleyEra → UTxO ShelleyEra → TxBody t ShelleyEra → Set (KeyHash 'Witness) Source # getMinFeeTxUtxo ∷ ∀ (t ∷ TxLevel). PParams ShelleyEra → Tx t ShelleyEra → UTxO ShelleyEra → Coin Source # | |||||