cardano-ledger-api-1.15.0.0: Public API for the cardano ledger codebase
Safe HaskellNone
LanguageHaskell2010

Cardano.Ledger.Api.UTxO

Synopsis

Documentation

newtype UTxO era Source #

The unspent transaction outputs.

Constructors

UTxO 

Fields

Instances

Instances details
CanGetUTxO UTxO 
Instance details

Defined in Cardano.Ledger.State.UTxO

Methods

utxoG ∷ SimpleGetter (UTxO era) (UTxO era) Source #

CanSetUTxO UTxO 
Instance details

Defined in Cardano.Ledger.State.UTxO

Methods

utxoL ∷ Lens' (UTxO era) (UTxO era) Source #

TranslateEra AllegraEra UTxO 
Instance details

Defined in Cardano.Ledger.Allegra.Translation

Associated Types

type TranslationError AllegraEra UTxO 
Instance details

Defined in Cardano.Ledger.Allegra.Translation

type TranslationError AllegraEra UTxO = Void

Methods

translateEra ∷ TranslationContext AllegraEra → UTxO (PreviousEra AllegraEra) → Except (TranslationError AllegraEra UTxO) (UTxO AllegraEra) Source #

TranslateEra AlonzoEra UTxO 
Instance details

Defined in Cardano.Ledger.Alonzo.Translation

Associated Types

type TranslationError AlonzoEra UTxO 
Instance details

Defined in Cardano.Ledger.Alonzo.Translation

type TranslationError AlonzoEra UTxO = Void

Methods

translateEra ∷ TranslationContext AlonzoEra → UTxO (PreviousEra AlonzoEra) → Except (TranslationError AlonzoEra UTxO) (UTxO AlonzoEra) Source #

TranslateEra BabbageEra UTxO 
Instance details

Defined in Cardano.Ledger.Babbage.Translation

Associated Types

type TranslationError BabbageEra UTxO 
Instance details

Defined in Cardano.Ledger.Babbage.Translation

type TranslationError BabbageEra UTxO = Void

Methods

translateEra ∷ TranslationContext BabbageEra → UTxO (PreviousEra BabbageEra) → Except (TranslationError BabbageEra UTxO) (UTxO BabbageEra) Source #

TranslateEra ConwayEra UTxO 
Instance details

Defined in Cardano.Ledger.Conway.Translation

Associated Types

type TranslationError ConwayEra UTxO 
Instance details

Defined in Cardano.Ledger.Conway.Translation

type TranslationError ConwayEra UTxO = Void

Methods

translateEra ∷ TranslationContext ConwayEra → UTxO (PreviousEra ConwayEra) → Except (TranslationError ConwayEra UTxO) (UTxO ConwayEra) Source #

TranslateEra DijkstraEra UTxO 
Instance details

Defined in Cardano.Ledger.Dijkstra.Translation

Associated Types

type TranslationError DijkstraEra UTxO 
Instance details

Defined in Cardano.Ledger.Dijkstra.Translation

type TranslationError DijkstraEra UTxO = Void

Methods

translateEra ∷ TranslationContext DijkstraEra → UTxO (PreviousEra DijkstraEra) → Except (TranslationError DijkstraEra UTxO) (UTxO DijkstraEra) Source #

TranslateEra MaryEra UTxO 
Instance details

Defined in Cardano.Ledger.Mary.Translation

Associated Types

type TranslationError MaryEra UTxO 
Instance details

Defined in Cardano.Ledger.Mary.Translation

type TranslationError MaryEra UTxO = Void

Methods

translateEra ∷ TranslationContext MaryEra → UTxO (PreviousEra MaryEra) → Except (TranslationError MaryEra UTxO) (UTxO MaryEra) Source #

ToJSON (TxOut era) ⇒ ToJSON (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

Methods

toJSON ∷ UTxO era → Value Source #

toEncoding ∷ UTxO era → Encoding Source #

toJSONList ∷ [UTxO era] → Value Source #

toEncodingList ∷ [UTxO era] → Encoding Source #

omitField ∷ UTxO era → Bool Source #

(Era era, DecShareCBOR (TxOut era), Share (TxOut era) ~ Interns (Credential 'Staking)) ⇒ FromCBOR (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

Methods

fromCBOR ∷ Decoder s (UTxO era) Source #

label ∷ Proxy (UTxO era) → Text Source #

(Era era, EncCBOR (TxOut era)) ⇒ ToCBOR (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

Methods

toCBOR ∷ UTxO era → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (UTxO era) → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [UTxO era] → Size Source #

(Era era, DecShareCBOR (TxOut era), Share (TxOut era) ~ Interns (Credential 'Staking)) ⇒ DecCBOR (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

Methods

decCBOR ∷ Decoder s (UTxO era) Source #

dropCBOR ∷ Proxy (UTxO era) → Decoder s () Source #

label ∷ Proxy (UTxO era) → Text Source #

(DecShareCBOR (TxOut era), Share (TxOut era) ~ Interns (Credential 'Staking)) ⇒ DecShareCBOR (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

Associated Types

type Share (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

type Share (UTxO era) = Interns (Credential 'Staking)

Methods

getShare ∷ UTxO era → Share (UTxO era) Source #

decShareCBOR ∷ Share (UTxO era) → Decoder s (UTxO era) Source #

decSharePlusCBOR ∷ StateT (Share (UTxO era)) (Decoder s) (UTxO era) Source #

(Era era, EncCBOR (TxOut era)) ⇒ EncCBOR (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

Methods

encCBOR ∷ UTxO era → Encoding Source #

Default (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

Methods

def ∷ UTxO era Source #

(Era era, NFData (TxOut era)) ⇒ NFData (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

Methods

rnf ∷ UTxO era → () #

Era era ⇒ Monoid (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

Methods

mempty ∷ UTxO era #

mappend ∷ UTxO era → UTxO era → UTxO era #

mconcat ∷ [UTxO era] → UTxO era #

Semigroup (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

Methods

(<>) ∷ UTxO era → UTxO era → UTxO era #

sconcat ∷ NonEmpty (UTxO era) → UTxO era #

stimes ∷ Integral b ⇒ b → UTxO era → UTxO era #

Generic (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

Associated Types

type Rep (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

type Rep (UTxO era) = D1 ('MetaData "UTxO" "Cardano.Ledger.State.UTxO" "cardano-ledger-core-1.22.0.0-inplace" 'True) (C1 ('MetaCons "UTxO" 'PrefixI 'True) (S1 ('MetaSel ('Just "unUTxO") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map TxIn (TxOut era)))))

Methods

from ∷ UTxO era → Rep (UTxO era) x #

to ∷ Rep (UTxO era) x → UTxO era #

Show (TxOut era) ⇒ Show (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

Methods

showsPrec ∷ Int → UTxO era → ShowS #

show ∷ UTxO era → String #

showList ∷ [UTxO era] → ShowS #

(Era era, Eq (TxOut era)) ⇒ Eq (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

Methods

(==) ∷ UTxO era → UTxO era → Bool #

(/=) ∷ UTxO era → UTxO era → Bool #

NoThunks (TxOut era) ⇒ NoThunks (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

Methods

noThunks ∷ Context → UTxO era → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → UTxO era → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (UTxO era) → String Source #

type TranslationError AllegraEra UTxO 
Instance details

Defined in Cardano.Ledger.Allegra.Translation

type TranslationError AllegraEra UTxO = Void
type TranslationError AlonzoEra UTxO 
Instance details

Defined in Cardano.Ledger.Alonzo.Translation

type TranslationError AlonzoEra UTxO = Void
type TranslationError BabbageEra UTxO 
Instance details

Defined in Cardano.Ledger.Babbage.Translation

type TranslationError BabbageEra UTxO = Void
type TranslationError ConwayEra UTxO 
Instance details

Defined in Cardano.Ledger.Conway.Translation

type TranslationError ConwayEra UTxO = Void
type TranslationError DijkstraEra UTxO 
Instance details

Defined in Cardano.Ledger.Dijkstra.Translation

type TranslationError DijkstraEra UTxO = Void
type TranslationError MaryEra UTxO 
Instance details

Defined in Cardano.Ledger.Mary.Translation

type TranslationError MaryEra UTxO = Void
type Share (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

type Share (UTxO era) = Interns (Credential 'Staking)
type Rep (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

type Rep (UTxO era) = D1 ('MetaData "UTxO" "Cardano.Ledger.State.UTxO" "cardano-ledger-core-1.22.0.0-inplace" 'True) (C1 ('MetaCons "UTxO" 'PrefixI 'True) (S1 ('MetaSel ('Just "unUTxO") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map TxIn (TxOut era)))))

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

getConsumedValue Source #

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.

getProducedValue Source #

Arguments

∷ PParams era 
→ (KeyHash 'StakePool → Bool)

Check whether a pool with a supplied PoolStakeId is already registered.

→ TxBody 'TopTx era 
→ Value era 

getScriptsProvided Source #

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

Instances details
EraUTxO AllegraEra 
Instance details

Defined in Cardano.Ledger.Allegra.UTxO

Associated Types

type ScriptsNeeded AllegraEra 
Instance details

Defined in Cardano.Ledger.Allegra.UTxO

type ScriptsNeeded AllegraEra = ShelleyScriptsNeeded AllegraEra

Methods

getConsumedValue ∷ ∀ (t ∷ TxLevel). PParams AllegraEra → (Credential 'Staking → Maybe Coin) → UTxO AllegraEra → TxBody t AllegraEra → Value AllegraEra Source #

getProducedValue ∷ PParams AllegraEra → (KeyHash 'StakePool → Bool) → TxBody 'TopTx AllegraEra → Value AllegraEra Source #

getScriptsProvided ∷ ∀ (t ∷ TxLevel). UTxO AllegraEra → Tx t AllegraEra → ScriptsProvided AllegraEra Source #

getScriptsNeeded ∷ ∀ (t ∷ TxLevel). UTxO AllegraEra → TxBody t AllegraEra → ScriptsNeeded AllegraEra Source #

getScriptsHashesNeeded ∷ ScriptsNeeded AllegraEra → Set ScriptHash Source #

getWitsVKeyNeeded ∷ ∀ (t ∷ TxLevel). CertState AllegraEra → UTxO AllegraEra → TxBody t AllegraEra → Set (KeyHash 'Witness) Source #

getMinFeeTxUtxo ∷ ∀ (t ∷ TxLevel). PParams AllegraEra → Tx t AllegraEra → UTxO AllegraEra → Coin Source #

EraUTxO AlonzoEra 
Instance details

Defined in Cardano.Ledger.Alonzo.UTxO

Associated Types

type ScriptsNeeded AlonzoEra 
Instance details

Defined in Cardano.Ledger.Alonzo.UTxO

type ScriptsNeeded AlonzoEra = AlonzoScriptsNeeded AlonzoEra

Methods

getConsumedValue ∷ ∀ (t ∷ TxLevel). PParams AlonzoEra → (Credential 'Staking → Maybe Coin) → UTxO AlonzoEra → TxBody t AlonzoEra → Value AlonzoEra Source #

getProducedValue ∷ PParams AlonzoEra → (KeyHash 'StakePool → Bool) → TxBody 'TopTx AlonzoEra → Value AlonzoEra Source #

getScriptsProvided ∷ ∀ (t ∷ TxLevel). UTxO AlonzoEra → Tx t AlonzoEra → ScriptsProvided AlonzoEra Source #

getScriptsNeeded ∷ ∀ (t ∷ TxLevel). UTxO AlonzoEra → TxBody t AlonzoEra → ScriptsNeeded AlonzoEra Source #

getScriptsHashesNeeded ∷ ScriptsNeeded AlonzoEra → Set ScriptHash Source #

getWitsVKeyNeeded ∷ ∀ (t ∷ TxLevel). CertState AlonzoEra → UTxO AlonzoEra → TxBody t AlonzoEra → Set (KeyHash 'Witness) Source #

getMinFeeTxUtxo ∷ ∀ (t ∷ TxLevel). PParams AlonzoEra → Tx t AlonzoEra → UTxO AlonzoEra → Coin Source #

EraUTxO BabbageEra 
Instance details

Defined in Cardano.Ledger.Babbage.UTxO

Associated Types

type ScriptsNeeded BabbageEra 
Instance details

Defined in Cardano.Ledger.Babbage.UTxO

type ScriptsNeeded BabbageEra = AlonzoScriptsNeeded BabbageEra

Methods

getConsumedValue ∷ ∀ (t ∷ TxLevel). PParams BabbageEra → (Credential 'Staking → Maybe Coin) → UTxO BabbageEra → TxBody t BabbageEra → Value BabbageEra Source #

getProducedValue ∷ PParams BabbageEra → (KeyHash 'StakePool → Bool) → TxBody 'TopTx BabbageEra → Value BabbageEra Source #

getScriptsProvided ∷ ∀ (t ∷ TxLevel). UTxO BabbageEra → Tx t BabbageEra → ScriptsProvided BabbageEra Source #

getScriptsNeeded ∷ ∀ (t ∷ TxLevel). UTxO BabbageEra → TxBody t BabbageEra → ScriptsNeeded BabbageEra Source #

getScriptsHashesNeeded ∷ ScriptsNeeded BabbageEra → Set ScriptHash Source #

getWitsVKeyNeeded ∷ ∀ (t ∷ TxLevel). CertState BabbageEra → UTxO BabbageEra → TxBody t BabbageEra → Set (KeyHash 'Witness) Source #

getMinFeeTxUtxo ∷ ∀ (t ∷ TxLevel). PParams BabbageEra → Tx t BabbageEra → UTxO BabbageEra → Coin Source #

EraUTxO ConwayEra 
Instance details

Defined in Cardano.Ledger.Conway.UTxO

Associated Types

type ScriptsNeeded ConwayEra 
Instance details

Defined in Cardano.Ledger.Conway.UTxO

type ScriptsNeeded ConwayEra = AlonzoScriptsNeeded ConwayEra

Methods

getConsumedValue ∷ ∀ (t ∷ TxLevel). PParams ConwayEra → (Credential 'Staking → Maybe Coin) → UTxO ConwayEra → TxBody t ConwayEra → Value ConwayEra Source #

getProducedValue ∷ PParams ConwayEra → (KeyHash 'StakePool → Bool) → TxBody 'TopTx ConwayEra → Value ConwayEra Source #

getScriptsProvided ∷ ∀ (t ∷ TxLevel). UTxO ConwayEra → Tx t ConwayEra → ScriptsProvided ConwayEra Source #

getScriptsNeeded ∷ ∀ (t ∷ TxLevel). UTxO ConwayEra → TxBody t ConwayEra → ScriptsNeeded ConwayEra Source #

getScriptsHashesNeeded ∷ ScriptsNeeded ConwayEra → Set ScriptHash Source #

getWitsVKeyNeeded ∷ ∀ (t ∷ TxLevel). CertState ConwayEra → UTxO ConwayEra → TxBody t ConwayEra → Set (KeyHash 'Witness) Source #

getMinFeeTxUtxo ∷ ∀ (t ∷ TxLevel). PParams ConwayEra → Tx t ConwayEra → UTxO ConwayEra → Coin Source #

EraUTxO DijkstraEra 
Instance details

Defined in Cardano.Ledger.Dijkstra.UTxO

Associated Types

type ScriptsNeeded DijkstraEra 
Instance details

Defined in Cardano.Ledger.Dijkstra.UTxO

type ScriptsNeeded DijkstraEra = AlonzoScriptsNeeded DijkstraEra

Methods

getConsumedValue ∷ ∀ (t ∷ TxLevel). PParams DijkstraEra → (Credential 'Staking → Maybe Coin) → UTxO DijkstraEra → TxBody t DijkstraEra → Value DijkstraEra Source #

getProducedValue ∷ PParams DijkstraEra → (KeyHash 'StakePool → Bool) → TxBody 'TopTx DijkstraEra → Value DijkstraEra Source #

getScriptsProvided ∷ ∀ (t ∷ TxLevel). UTxO DijkstraEra → Tx t DijkstraEra → ScriptsProvided DijkstraEra Source #

getScriptsNeeded ∷ ∀ (t ∷ TxLevel). UTxO DijkstraEra → TxBody t DijkstraEra → ScriptsNeeded DijkstraEra Source #

getScriptsHashesNeeded ∷ ScriptsNeeded DijkstraEra → Set ScriptHash Source #

getWitsVKeyNeeded ∷ ∀ (t ∷ TxLevel). CertState DijkstraEra → UTxO DijkstraEra → TxBody t DijkstraEra → Set (KeyHash 'Witness) Source #

getMinFeeTxUtxo ∷ ∀ (t ∷ TxLevel). PParams DijkstraEra → Tx t DijkstraEra → UTxO DijkstraEra → Coin Source #

EraUTxO MaryEra 
Instance details

Defined in Cardano.Ledger.Mary.UTxO

Associated Types

type ScriptsNeeded MaryEra 
Instance details

Defined in Cardano.Ledger.Mary.UTxO

type ScriptsNeeded MaryEra = ShelleyScriptsNeeded MaryEra

Methods

getConsumedValue ∷ ∀ (t ∷ TxLevel). PParams MaryEra → (Credential 'Staking → Maybe Coin) → UTxO MaryEra → TxBody t MaryEra → Value MaryEra Source #

getProducedValue ∷ PParams MaryEra → (KeyHash 'StakePool → Bool) → TxBody 'TopTx MaryEra → Value MaryEra Source #

getScriptsProvided ∷ ∀ (t ∷ TxLevel). UTxO MaryEra → Tx t MaryEra → ScriptsProvided MaryEra Source #

getScriptsNeeded ∷ ∀ (t ∷ TxLevel). UTxO MaryEra → TxBody t MaryEra → ScriptsNeeded MaryEra Source #

getScriptsHashesNeeded ∷ ScriptsNeeded MaryEra → Set ScriptHash Source #

getWitsVKeyNeeded ∷ ∀ (t ∷ TxLevel). CertState MaryEra → UTxO MaryEra → TxBody t MaryEra → Set (KeyHash 'Witness) Source #

getMinFeeTxUtxo ∷ ∀ (t ∷ TxLevel). PParams MaryEra → Tx t MaryEra → UTxO MaryEra → Coin Source #

EraUTxO ShelleyEra 
Instance details

Defined in Cardano.Ledger.Shelley.UTxO

Associated Types

type ScriptsNeeded ShelleyEra 
Instance details

Defined in Cardano.Ledger.Shelley.UTxO

type ScriptsNeeded ShelleyEra = ShelleyScriptsNeeded ShelleyEra

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 #