Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Ledger.Api.Tx.Out

Contents

Value
Address
Size
Shelley, Allegra and Mary Era
Alonzo Era
Babbage Era

Description

This module is used for building and inspecting transaction outputs.

You'll find some examples below.

Let's start by defining the GHC extensions and imports.

>>> :set -XTypeApplications
>>> import Cardano.Ledger.Api.Era (Babbage)
>>> import Lens.Micro
>>> import Test.Cardano.Ledger.Babbage.Serialisation.Generators () -- Neded for doctests only
>>> import Test.QuickCheck -- Needed for doctests only

Here's an example on how to build a very basic Babbage era transaction output with a random address and value, and without any datum or reference script.

>>> :{
quickCheck $ \addr val ->
    let
        -- Defining a Babbage era transaction output with some random address and value.
        txOut = mkBasicTxOut @Babbage addr val
     in
        -- We verify that the transaction output contains our random address and value.
        txOut ^. addrTxOutL == addr && txOut ^. valueTxOutL == val
:}
+++ OK, passed 100 tests.

Synopsis

module Cardano.Ledger.Api.Tx.Address
class (Val (Value era), ToJSON (TxOut era), DecCBOR (Value era), DecCBOR (CompactForm (Value era)), EncCBOR (Value era), ToCBOR (TxOut era), EncCBOR (TxOut era), DecCBOR (TxOut era), DecShareCBOR (TxOut era), Share (TxOut era) ~ Interns (Credential 'Staking), NoThunks (TxOut era), NFData (TxOut era), Show (TxOut era), Eq (TxOut era), EraPParams era) ⇒ EraTxOut era where
- type TxOut era = (r ∷ Type) | r → era
mkBasicTxOut ∷ EraTxOut era ⇒ Addr → Value era → TxOut era
upgradeTxOut ∷ EraTxOut era ⇒ TxOut (PreviousEra era) → TxOut era
valueTxOutL ∷ EraTxOut era ⇒ Lens' (TxOut era) (Value era)
coinTxOutL ∷ (HasCallStack, EraTxOut era) ⇒ Lens' (TxOut era) Coin
isAdaOnlyTxOutF ∷ EraTxOut era ⇒ SimpleGetter (TxOut era) Bool
addrTxOutL ∷ EraTxOut era ⇒ Lens' (TxOut era) Addr
bootAddrTxOutF ∷ EraTxOut era ⇒ SimpleGetter (TxOut era) (Maybe BootstrapAddress)
getMinCoinTxOut ∷ EraTxOut era ⇒ PParams era → TxOut era → Coin
setMinCoinTxOut ∷ EraTxOut era ⇒ PParams era → TxOut era → TxOut era
getMinCoinSizedTxOut ∷ EraTxOut era ⇒ PParams era → Sized (TxOut era) → Coin
setMinCoinSizedTxOut ∷ ∀ era. EraTxOut era ⇒ PParams era → Sized (TxOut era) → Sized (TxOut era)
ensureMinCoinTxOut ∷ EraTxOut era ⇒ PParams era → TxOut era → TxOut era
ensureMinCoinSizedTxOut ∷ ∀ era. EraTxOut era ⇒ PParams era → Sized (TxOut era) → Sized (TxOut era)
class (AlonzoEraPParams era, EraTxOut era) ⇒ AlonzoEraTxOut era
dataHashTxOutL ∷ AlonzoEraTxOut era ⇒ Lens' (TxOut era) (StrictMaybe DataHash)
type DataHash = SafeHash EraIndependentData
datumTxOutF ∷ AlonzoEraTxOut era ⇒ SimpleGetter (TxOut era) (Datum era)
class (AlonzoEraTxOut era, AlonzoEraScript era) ⇒ BabbageEraTxOut era
dataTxOutL ∷ BabbageEraTxOut era ⇒ Lens' (TxOut era) (StrictMaybe (Data era))
data Data era where
- pattern Data ∷ Era era ⇒ Data → Data era
datumTxOutL ∷ BabbageEraTxOut era ⇒ Lens' (TxOut era) (Datum era)
data Datum era
- = NoDatum
- | DatumHash !DataHash
- | Datum !(BinaryData era)
referenceScriptTxOutL ∷ BabbageEraTxOut era ⇒ Lens' (TxOut era) (StrictMaybe (Script era))

Documentation

module Cardano.Ledger.Api.Tx.Address

class (Val (Value era), ToJSON (TxOut era), DecCBOR (Value era), DecCBOR (CompactForm (Value era)), EncCBOR (Value era), ToCBOR (TxOut era), EncCBOR (TxOut era), DecCBOR (TxOut era), DecShareCBOR (TxOut era), Share (TxOut era) ~ Interns (Credential 'Staking), NoThunks (TxOut era), NFData (TxOut era), Show (TxOut era), Eq (TxOut era), EraPParams era) ⇒ EraTxOut era Source #

Abstract interface into specific fields of a TxOut

Minimal complete definition

mkBasicTxOut, upgradeTxOut, valueEitherTxOutL, addrEitherTxOutL, (getMinCoinSizedTxOut | getMinCoinTxOut)

Associated Types

type TxOut era = (r ∷ Type) | r → era Source #

The output of a UTxO for a particular era

mkBasicTxOut ∷ EraTxOut era ⇒ Addr → Value era → TxOut era Source #

upgradeTxOut ∷ EraTxOut era ⇒ TxOut (PreviousEra era) → TxOut era Source #

Every era, except Shelley, must be able to upgrade a TxOut from a previous era.

Value

valueTxOutL ∷ EraTxOut era ⇒ Lens' (TxOut era) (Value era) Source #

coinTxOutL ∷ (HasCallStack, EraTxOut era) ⇒ Lens' (TxOut era) Coin Source #

isAdaOnlyTxOutF ∷ EraTxOut era ⇒ SimpleGetter (TxOut era) Bool Source #

This is a getter that implements an efficient way to check whether TxOut contains ADA only.

Address

addrTxOutL ∷ EraTxOut era ⇒ Lens' (TxOut era) Addr Source #

bootAddrTxOutF ∷ EraTxOut era ⇒ SimpleGetter (TxOut era) (Maybe BootstrapAddress) Source #

Size

getMinCoinTxOut ∷ EraTxOut era ⇒ PParams era → TxOut era → Coin Source #

Same as getMinCoinSizedTxOut, except information about the size of TxOut will be computed by serializing the TxOut. If the size turns out to be not needed, then serialization will have no overhead, since it is computed lazily.

setMinCoinTxOut ∷ EraTxOut era ⇒ PParams era → TxOut era → TxOut era Source #

Same as setMinCoinSizedTxOut, except it doesn't require the size of the TxOut and will recompute it if needed. Initial amount is not important.

getMinCoinSizedTxOut ∷ EraTxOut era ⇒ PParams era → Sized (TxOut era) → Coin Source #

Produce the minimum lovelace that a given transaction output must contain. Information about the size of the TxOut is required in some eras. Use getMinCoinTxOut if you don't have the size readily available to you.

setMinCoinSizedTxOut ∷ ∀ era. EraTxOut era ⇒ PParams era → Sized (TxOut era) → Sized (TxOut era) Source #

This function will adjust the output's Coin value to the smallest amount allowed by the UTXO rule. Initial amount is not important.

ensureMinCoinTxOut ∷ EraTxOut era ⇒ PParams era → TxOut era → TxOut era Source #

Similar to setMinCoinTxOut it will guarantee that the minimum requirement for the output amount is satisified, however it makes it possible to set a higher amount than the minimaly required.

> ensureMinCoinTxOut pp (txOut & coinTxOutL .~ zero) == setMinCoinTxOut pp (txOut & coinTxOutL .~ zero)
> (ensureMinCoinTxOut pp txOut ^. coinTxOutL) >= (setMinCoinTxOut pp txOut ^. coinTxOutL)

ensureMinCoinSizedTxOut ∷ ∀ era. EraTxOut era ⇒ PParams era → Sized (TxOut era) → Sized (TxOut era) Source #

Similar to setMinCoinSizedTxOut it will guarantee that the minimum requirement for the output amount is satisified, however it makes it possible to set a higher amount than the minimaly required.

ensureMinCoinSizedTxOut relates to setMinCoinSizedTxOut in the same way that ensureMinCoinTxOut relates to setMinCoinTxOut.

Shelley, Allegra and Mary Era

Alonzo Era

class (AlonzoEraPParams era, EraTxOut era) ⇒ AlonzoEraTxOut era Source #

Minimal complete definition

dataHashTxOutL, datumTxOutF

Instances

Instances details

AlonzoEraTxOut AlonzoEra
Instance details Defined in Cardano.Ledger.Alonzo.TxOut Methods dataHashTxOutL ∷ Lens' (TxOut AlonzoEra) (StrictMaybe DataHash) Source # datumTxOutF ∷ SimpleGetter (TxOut AlonzoEra) (Datum AlonzoEra) Source #

dataHashTxOutL ∷ AlonzoEraTxOut era ⇒ Lens' (TxOut era) (StrictMaybe DataHash) Source #

type DataHash = SafeHash EraIndependentData Source #

datumTxOutF ∷ AlonzoEraTxOut era ⇒ SimpleGetter (TxOut era) (Datum era) Source #

Babbage Era

class (AlonzoEraTxOut era, AlonzoEraScript era) ⇒ BabbageEraTxOut era Source #

Minimal complete definition

referenceScriptTxOutL, dataTxOutL, datumTxOutL

Instances

Instances details

BabbageEraTxOut BabbageEra
Instance details Defined in Cardano.Ledger.Babbage.TxOut Methods referenceScriptTxOutL ∷ Lens' (TxOut BabbageEra) (StrictMaybe (Script BabbageEra)) Source # dataTxOutL ∷ Lens' (TxOut BabbageEra) (StrictMaybe (Data BabbageEra)) Source # datumTxOutL ∷ Lens' (TxOut BabbageEra) (Datum BabbageEra) Source #

dataTxOutL ∷ BabbageEraTxOut era ⇒ Lens' (TxOut era) (StrictMaybe (Data era)) Source #

data Data era where Source #

Bundled Patterns

pattern Data ∷ Era era ⇒ Data → Data era

Instances

Instances details

Memoized Data
Instance details Defined in Cardano.Ledger.Plutus.Data Associated Types type RawType Data = (r ∷ Type → Type) Source # Methods getMemoBytes ∷ Data era → MemoBytes (RawType Data) era wrapMemoBytes ∷ MemoBytes (RawType Data) era → Data era
Generic (Data era)
Instance details Defined in Cardano.Ledger.Plutus.Data Associated Types type Rep (Data era) ∷ Type → Type Source # Methods from ∷ Data era → Rep (Data era) x Source # to ∷ Rep (Data era) x → Data era Source #
Show (Data era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods showsPrec ∷ Int → Data era → ShowS Source # show ∷ Data era → String Source # showList ∷ [Data era] → ShowS Source #
Typeable era ⇒ ToCBOR (Data era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods toCBOR ∷ Data era → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (Data era) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Data era] → Size Source #
Era era ⇒ DecCBOR (Annotator (Data era))
Instance details Defined in Cardano.Ledger.Plutus.Data Methods decCBOR ∷ Decoder s (Annotator (Data era)) Source # dropCBOR ∷ Proxy (Annotator (Data era)) → Decoder s () Source # label ∷ Proxy (Annotator (Data era)) → Text Source #
Typeable era ⇒ EncCBOR (Data era)	Encodes memoized bytes created upon construction.
Instance details Defined in Cardano.Ledger.Plutus.Data Methods encCBOR ∷ Data era → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (Data era) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [Data era] → Size Source #
SafeToHash (Data era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods originalBytes ∷ Data era → ByteString Source # originalBytesSize ∷ Data era → Int Source # makeHashWithExplicitProxys ∷ Proxy i → Data era → SafeHash i Source #
NFData (Data era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods rnf ∷ Data era → () Source #
Eq (Data era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods (==) ∷ Data era → Data era → Bool Source # (/=) ∷ Data era → Data era → Bool Source #
Typeable era ⇒ NoThunks (Data era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods noThunks ∷ Context → Data era → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Data era → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (Data era) → String Source #
HashAnnotated (Data era) EraIndependentData
Instance details Defined in Cardano.Ledger.Plutus.Data Methods hashAnnotated ∷ Data era → SafeHash EraIndependentData Source #
type RawType Data
Instance details Defined in Cardano.Ledger.Plutus.Data type RawType Data = PlutusData
type Rep (Data era)
Instance details Defined in Cardano.Ledger.Plutus.Data type Rep (Data era) = D1 ('MetaData "Data" "Cardano.Ledger.Plutus.Data" "cardano-ledger-core-1.17.0.0-inplace" 'True) (C1 ('MetaCons "DataConstr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (MemoBytes PlutusData era))))

datumTxOutL ∷ BabbageEraTxOut era ⇒ Lens' (TxOut era) (Datum era) Source #

data Datum era Source #

Datum can be described by a either a data hash or binary data, but not both. It can also be neither one of them.

Constructors

NoDatum
DatumHash !DataHash
Datum !(BinaryData era)

Instances

Instances details

Era era ⇒ ToJSON (Datum era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods toJSON ∷ Datum era → Value Source # toEncoding ∷ Datum era → Encoding Source # toJSONList ∷ [Datum era] → Value Source # toEncodingList ∷ [Datum era] → Encoding Source # omitField ∷ Datum era → Bool Source #
Generic (Datum era)
Instance details Defined in Cardano.Ledger.Plutus.Data Associated Types type Rep (Datum era) ∷ Type → Type Source # Methods from ∷ Datum era → Rep (Datum era) x Source # to ∷ Rep (Datum era) x → Datum era Source #
Show (Datum era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods showsPrec ∷ Int → Datum era → ShowS Source # show ∷ Datum era → String Source # showList ∷ [Datum era] → ShowS Source #
Era era ⇒ DecCBOR (Datum era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods decCBOR ∷ Decoder s (Datum era) Source # dropCBOR ∷ Proxy (Datum era) → Decoder s () Source # label ∷ Proxy (Datum era) → Text Source #
Era era ⇒ EncCBOR (Datum era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods encCBOR ∷ Datum era → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (Datum era) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [Datum era] → Size Source #
Eq (Datum era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods (==) ∷ Datum era → Datum era → Bool Source # (/=) ∷ Datum era → Datum era → Bool Source #
Ord (Datum era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods compare ∷ Datum era → Datum era → Ordering Source # (<) ∷ Datum era → Datum era → Bool Source # (<=) ∷ Datum era → Datum era → Bool Source # (>) ∷ Datum era → Datum era → Bool Source # (>=) ∷ Datum era → Datum era → Bool Source # max ∷ Datum era → Datum era → Datum era Source # min ∷ Datum era → Datum era → Datum era Source #
NoThunks (Datum era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods noThunks ∷ Context → Datum era → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Datum era → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (Datum era) → String Source #
type Rep (Datum era)
Instance details Defined in Cardano.Ledger.Plutus.Data type Rep (Datum era) = D1 ('MetaData "Datum" "Cardano.Ledger.Plutus.Data" "cardano-ledger-core-1.17.0.0-inplace" 'False) (C1 ('MetaCons "NoDatum" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "DatumHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DataHash)) :+: C1 ('MetaCons "Datum" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 (BinaryData era)))))

referenceScriptTxOutL ∷ BabbageEraTxOut era ⇒ Lens' (TxOut era) (StrictMaybe (Script era)) Source #