plutus-ledger-api-1.0.0.0.0.0.0.0.1: Interface to the Plutus ledger for the Cardano ledger.
Safe HaskellSafe-Inferred
LanguageHaskell2010

PlutusLedgerApi.Common.Versions

Synopsis

Documentation

data ProtocolVersion Source #

This represents the Cardano protocol version, with its major and minor components. This relies on careful understanding between us and the ledger as to what this means.

Constructors

ProtocolVersion 

Fields

Instances

Instances details
Generic ProtocolVersion Source # 
Instance details

Defined in PlutusLedgerApi.Common.ProtocolVersions

Associated Types

type Rep ProtocolVersion :: Type -> Type Source #

Methods

from :: ProtocolVersion -> Rep ProtocolVersion x Source #

to :: Rep ProtocolVersion x -> ProtocolVersion Source #

Show ProtocolVersion Source # 
Instance details

Defined in PlutusLedgerApi.Common.ProtocolVersions

Methods

showsPrec :: Int -> ProtocolVersion -> ShowS Source #

show :: ProtocolVersion -> String Source #

showList :: [ProtocolVersion] -> ShowS Source #

Eq ProtocolVersion Source # 
Instance details

Defined in PlutusLedgerApi.Common.ProtocolVersions

Methods

(==) :: ProtocolVersion -> ProtocolVersion -> Bool Source #

(/=) :: ProtocolVersion -> ProtocolVersion -> Bool Source #

Ord ProtocolVersion Source # 
Instance details

Defined in PlutusLedgerApi.Common.ProtocolVersions

Methods

compare :: ProtocolVersion -> ProtocolVersion -> Ordering Source #

(<) :: ProtocolVersion -> ProtocolVersion -> Bool Source #

(<=) :: ProtocolVersion -> ProtocolVersion -> Bool Source #

(>) :: ProtocolVersion -> ProtocolVersion -> Bool Source #

(>=) :: ProtocolVersion -> ProtocolVersion -> Bool Source #

max :: ProtocolVersion -> ProtocolVersion -> ProtocolVersion Source #

min :: ProtocolVersion -> ProtocolVersion -> ProtocolVersion Source #

Pretty ProtocolVersion Source # 
Instance details

Defined in PlutusLedgerApi.Common.ProtocolVersions

Methods

pretty :: ProtocolVersion -> Doc ann Source #

prettyList :: [ProtocolVersion] -> Doc ann Source #

Serialise ProtocolVersion Source # 
Instance details

Defined in PlutusLedgerApi.Common.ProtocolVersions

Methods

encode :: ProtocolVersion -> Encoding Source #

decode :: Decoder s ProtocolVersion Source #

encodeList :: [ProtocolVersion] -> Encoding Source #

decodeList :: Decoder s [ProtocolVersion] Source #

type Rep ProtocolVersion Source # 
Instance details

Defined in PlutusLedgerApi.Common.ProtocolVersions

type Rep ProtocolVersion = D1 ('MetaData "ProtocolVersion" "PlutusLedgerApi.Common.ProtocolVersions" "plutus-ledger-api-1.0.0.0.0.0.0.0.1-62zX2BmwjkDFan4zfGhQ4n" 'False) (C1 ('MetaCons "ProtocolVersion" 'PrefixI 'True) (S1 ('MetaSel ('Just "pvMajor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "pvMinor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

shelleyPV :: ProtocolVersion Source #

allegraPV :: ProtocolVersion Source #

maryPV :: ProtocolVersion Source #

alonzoPV :: ProtocolVersion Source #

vasilPV :: ProtocolVersion Source #

changPV :: ProtocolVersion Source #

data LedgerPlutusVersion Source #

The plutus language version as seen from the ledger's side. Note: the ordering of constructors matters for deriving Ord

Constructors

PlutusV1 
PlutusV2 
PlutusV3 

Instances

Instances details
Bounded LedgerPlutusVersion Source # 
Instance details

Defined in PlutusLedgerApi.Common.Versions

Methods

minBound :: LedgerPlutusVersion Source #

maxBound :: LedgerPlutusVersion Source #

Enum LedgerPlutusVersion Source # 
Instance details

Defined in PlutusLedgerApi.Common.Versions

Methods

succ :: LedgerPlutusVersion -> LedgerPlutusVersion Source #

pred :: LedgerPlutusVersion -> LedgerPlutusVersion Source #

toEnum :: Int -> LedgerPlutusVersion Source #

fromEnum :: LedgerPlutusVersion -> Int Source #

enumFrom :: LedgerPlutusVersion -> [LedgerPlutusVersion] Source #

enumFromThen :: LedgerPlutusVersion -> LedgerPlutusVersion -> [LedgerPlutusVersion] Source #

enumFromTo :: LedgerPlutusVersion -> LedgerPlutusVersion -> [LedgerPlutusVersion] Source #

enumFromThenTo :: LedgerPlutusVersion -> LedgerPlutusVersion -> LedgerPlutusVersion -> [LedgerPlutusVersion] Source #

Generic LedgerPlutusVersion Source # 
Instance details

Defined in PlutusLedgerApi.Common.Versions

Associated Types

type Rep LedgerPlutusVersion :: Type -> Type Source #

Methods

from :: LedgerPlutusVersion -> Rep LedgerPlutusVersion x Source #

to :: Rep LedgerPlutusVersion x -> LedgerPlutusVersion Source #

Show LedgerPlutusVersion Source # 
Instance details

Defined in PlutusLedgerApi.Common.Versions

Methods

showsPrec :: Int -> LedgerPlutusVersion -> ShowS Source #

show :: LedgerPlutusVersion -> String Source #

showList :: [LedgerPlutusVersion] -> ShowS Source #

Eq LedgerPlutusVersion Source # 
Instance details

Defined in PlutusLedgerApi.Common.Versions

Methods

(==) :: LedgerPlutusVersion -> LedgerPlutusVersion -> Bool Source #

(/=) :: LedgerPlutusVersion -> LedgerPlutusVersion -> Bool Source #

Ord LedgerPlutusVersion Source # 
Instance details

Defined in PlutusLedgerApi.Common.Versions

Methods

compare :: LedgerPlutusVersion -> LedgerPlutusVersion -> Ordering Source #

(<) :: LedgerPlutusVersion -> LedgerPlutusVersion -> Bool Source #

(<=) :: LedgerPlutusVersion -> LedgerPlutusVersion -> Bool Source #

(>) :: LedgerPlutusVersion -> LedgerPlutusVersion -> Bool Source #

(>=) :: LedgerPlutusVersion -> LedgerPlutusVersion -> Bool Source #

max :: LedgerPlutusVersion -> LedgerPlutusVersion -> LedgerPlutusVersion Source #

min :: LedgerPlutusVersion -> LedgerPlutusVersion -> LedgerPlutusVersion Source #

Pretty LedgerPlutusVersion Source # 
Instance details

Defined in PlutusLedgerApi.Common.Versions

Methods

pretty :: LedgerPlutusVersion -> Doc ann Source #

prettyList :: [LedgerPlutusVersion] -> Doc ann Source #

type Rep LedgerPlutusVersion Source # 
Instance details

Defined in PlutusLedgerApi.Common.Versions

type Rep LedgerPlutusVersion = D1 ('MetaData "LedgerPlutusVersion" "PlutusLedgerApi.Common.Versions" "plutus-ledger-api-1.0.0.0.0.0.0.0.1-62zX2BmwjkDFan4zfGhQ4n" 'False) (C1 ('MetaCons "PlutusV1" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PlutusV2" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PlutusV3" 'PrefixI 'False) (U1 :: Type -> Type)))

languageIntroducedIn :: LedgerPlutusVersion -> ProtocolVersion Source #

Query the protocol version that a specific ledger plutus version was first introduced in. Introduction in this context means the enablement/allowance of scripts of that language version to be executed on-chain.

languagesAvailableIn :: ProtocolVersion -> Set LedgerPlutusVersion Source #

Given a protocol version return a set of all available plutus languages that are enabled/allowed to run. Assumes that languages once introduced/enabled, will never be disabled in the future.

builtinsIntroducedIn :: Map (LedgerPlutusVersion, ProtocolVersion) (Set DefaultFun) Source #

A map indicating which builtin functions were introduced in which ProtocolVersion. Each builtin function should appear at most once.

This *must* be updated when new builtins are added. See Note [New builtins and protocol versions]

builtinsAvailableIn :: LedgerPlutusVersion -> ProtocolVersion -> Set DefaultFun Source #

Which builtin functions are available in the given ProtocolVersion?

See Note [New builtins and protocol versions]