cardano-ledger-api-1.13.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

utxoGSimpleGetter (UTxO era) (UTxO era) Source #

CanSetUTxO UTxO 
Instance details

Defined in Cardano.Ledger.State.UTxO

Methods

utxoLLens' (UTxO era) (UTxO era) Source #

TranslateEra AllegraEra UTxO 
Instance details

Defined in Cardano.Ledger.Allegra.Translation

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

TranslateEra BabbageEra UTxO 
Instance details

Defined in Cardano.Ledger.Babbage.Translation

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

TranslateEra DijkstraEra UTxO 
Instance details

Defined in Cardano.Ledger.Dijkstra.Translation

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

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

Defined in Cardano.Ledger.State.UTxO

Methods

toJSONUTxO era → Value Source #

toEncodingUTxO era → Encoding Source #

toJSONList ∷ [UTxO era] → Value Source #

toEncodingList ∷ [UTxO era] → Encoding Source #

omitFieldUTxO era → Bool Source #

(DecCBOR (TxOut era), Era era) ⇒ FromCBOR (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

Methods

fromCBORDecoder s (UTxO era) Source #

labelProxy (UTxO era) → Text Source #

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

Defined in Cardano.Ledger.State.UTxO

Methods

toCBORUTxO 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, DecCBOR (TxOut era)) ⇒ DecCBOR (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

Methods

decCBORDecoder s (UTxO era) Source #

dropCBORProxy (UTxO era) → Decoder s () Source #

labelProxy (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

Methods

getShareUTxO era → Share (UTxO era) Source #

decShareCBORShare (UTxO era) → Decoder s (UTxO era) Source #

decSharePlusCBORStateT (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

encCBORUTxO era → Encoding Source #

Default (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

Methods

defUTxO era Source #

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

Defined in Cardano.Ledger.State.UTxO

Methods

rnfUTxO era → () #

Era era ⇒ Monoid (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

Methods

memptyUTxO era #

mappendUTxO 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 #

sconcatNonEmpty (UTxO era) → UTxO era #

stimesIntegral 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.19.0.0-inplace" 'True) (C1 ('MetaCons "UTxO" 'PrefixI 'True) (S1 ('MetaSel ('Just "unUTxO") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map TxIn (TxOut era)))))

Methods

fromUTxO era → Rep (UTxO era) x #

toRep (UTxO era) x → UTxO era #

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

Defined in Cardano.Ledger.State.UTxO

Methods

showsPrecIntUTxO era → ShowS #

showUTxO 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

type TranslationError AllegraEra UTxO 
Instance details

Defined in Cardano.Ledger.Allegra.Translation

type TranslationError AlonzoEra UTxO 
Instance details

Defined in Cardano.Ledger.Alonzo.Translation

type TranslationError BabbageEra UTxO 
Instance details

Defined in Cardano.Ledger.Babbage.Translation

type TranslationError ConwayEra UTxO 
Instance details

Defined in Cardano.Ledger.Conway.Translation

type TranslationError DijkstraEra UTxO 
Instance details

Defined in Cardano.Ledger.Dijkstra.Translation

type TranslationError MaryEra UTxO 
Instance details

Defined in Cardano.Ledger.Mary.Translation

type Share (UTxO era) 
Instance details

Defined in Cardano.Ledger.State.UTxO

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.19.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

consumed ∷ ∀ (t ∷ TxLevel). PParams era → CertState era → UTxO era → TxBody t era → Value era Source #

getConsumedValue Source #

Arguments

∷ ∀ (t ∷ TxLevel). PParams era 
→ (Credential 'StakingMaybe Coin)

Function that can lookup current delegation deposits

→ (Credential 'DRepRoleMaybe Coin)

Function that can lookup current drep deposits

UTxO era 
TxBody t era 
Value era 

Calculate all the value that is being consumed by the transaction.

getProducedValue Source #

Arguments

∷ ∀ (t ∷ TxLevel). PParams era 
→ (KeyHash 'StakePoolBool)

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

TxBody t 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

getScriptsHashesNeededScriptsNeeded 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

EraUTxO AlonzoEra 
Instance details

Defined in Cardano.Ledger.Alonzo.UTxO

EraUTxO BabbageEra 
Instance details

Defined in Cardano.Ledger.Babbage.UTxO

EraUTxO ConwayEra 
Instance details

Defined in Cardano.Ledger.Conway.UTxO

EraUTxO DijkstraEra 
Instance details

Defined in Cardano.Ledger.Dijkstra.UTxO

EraUTxO MaryEra 
Instance details

Defined in Cardano.Ledger.Mary.UTxO

Associated Types

type ScriptsNeeded MaryEra 
Instance details

Defined in Cardano.Ledger.Mary.UTxO

EraUTxO ShelleyEra 
Instance details

Defined in Cardano.Ledger.Shelley.UTxO