| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
PlutusLedgerApi.Common.Versions
Description
This module contains the code for handling the various kinds of version that we care about:
- Protocol versions
- Plutus ledger languages
- Plutus Core language versions
Synopsis
- newtype MajorProtocolVersion = MajorProtocolVersion {}
- shelleyPV :: MajorProtocolVersion
- allegraPV :: MajorProtocolVersion
- maryPV :: MajorProtocolVersion
- alonzoPV :: MajorProtocolVersion
- vasilPV :: MajorProtocolVersion
- valentinePV :: MajorProtocolVersion
- changPV :: MajorProtocolVersion
- plominPV :: MajorProtocolVersion
- vanRossemPV :: MajorProtocolVersion
- knownPVs :: [MajorProtocolVersion]
- newestPV :: MajorProtocolVersion
- futurePV :: MajorProtocolVersion
- data PlutusLedgerLanguage
- data Version = Version {}
- ledgerLanguageIntroducedIn :: PlutusLedgerLanguage -> MajorProtocolVersion
- ledgerLanguagesAvailableIn :: MajorProtocolVersion -> Set PlutusLedgerLanguage
- plcVersionsIntroducedIn :: PlutusLedgerLanguage -> Map MajorProtocolVersion (Set Version)
- plcVersionsAvailableIn :: PlutusLedgerLanguage -> MajorProtocolVersion -> Set Version
- builtinsIntroducedIn :: PlutusLedgerLanguage -> Map MajorProtocolVersion (Set DefaultFun)
- builtinsAvailableIn :: PlutusLedgerLanguage -> MajorProtocolVersion -> Set DefaultFun
- batch1 :: [DefaultFun]
- batch2 :: [DefaultFun]
- batch3 :: [DefaultFun]
- batch4a :: [DefaultFun]
- batch4b :: [DefaultFun]
- batch5 :: [DefaultFun]
- batch6 :: [DefaultFun]
Cardano Protocol versions
newtype MajorProtocolVersion Source #
This represents the major component of the Cardano protocol version. The ledger can only supply the major component of the protocol version, not the minor component, and Plutus should only need to care about the major component anyway. This relies on careful understanding between us and the ledger as to what this means.
Constructors
| MajorProtocolVersion | |
Fields | |
Instances
shelleyPV :: MajorProtocolVersion Source #
Shelley era was introduced in protocol version 2.0
allegraPV :: MajorProtocolVersion Source #
Allegra era was introduced in protocol version 3.0
maryPV :: MajorProtocolVersion Source #
Mary era was introduced in protocol version 4.0
alonzoPV :: MajorProtocolVersion Source #
Alonzo era was introduced in protocol version 5.0
vasilPV :: MajorProtocolVersion Source #
The Vasil HF introduced the Babbage era and Plutus V2
valentinePV :: MajorProtocolVersion Source #
Valentine was an intra-era HF where builtin functions VerifyEcdsaSecp256k1Signature and
VerifySchnorrSecp256k1Signature were enabled.
changPV :: MajorProtocolVersion Source #
The Chang HF introduced the Conway era and Plutus V3
plominPV :: MajorProtocolVersion Source #
The Plomin HF was an intra-era HF where some new builtin functions were introduced in Plutus V2 and V3.
vanRossemPV :: MajorProtocolVersion Source #
The van Rossem HF will be an intra-era HF.
knownPVs :: [MajorProtocolVersion] Source #
The set of protocol versions that are "known", i.e. that have been released and have actual differences associated with them. This is currently only used for testing, so efficiency is not parmount and a list is fine.
futurePV :: MajorProtocolVersion Source #
This is a placeholder for when we don't yet know what protocol version will be used for something. It's a very high protocol version that should never appear in reality.
We should not assign names to future protocol versions until it's confirmed that they are correct, otherwise we could accidentally associate something with the wrong protocol version.
Plutus ledger languages
data PlutusLedgerLanguage Source #
The Plutus ledger language. These are entirely different script languages from the ledger's perspective, which on our side are interpreted in very similar ways.
It is a simple enumerated datatype (there is no major and minor components as in protocol version) and the ordering of constructors is essential for deriving Enum,Ord,Bounded.
IMPORTANT: this is different from the Plutus Core language version, Version
Constructors
| PlutusV1 | introduced in Alonzo HF |
| PlutusV2 | introduced in Vasil HF |
| PlutusV3 | introduced in Chang HF |
Instances
| Bounded PlutusLedgerLanguage Source # | |||||
Defined in PlutusLedgerApi.Common.Versions | |||||
| Enum PlutusLedgerLanguage Source # | |||||
Defined in PlutusLedgerApi.Common.Versions Methods succ :: PlutusLedgerLanguage -> PlutusLedgerLanguage Source # pred :: PlutusLedgerLanguage -> PlutusLedgerLanguage Source # toEnum :: Int -> PlutusLedgerLanguage Source # fromEnum :: PlutusLedgerLanguage -> Int Source # enumFrom :: PlutusLedgerLanguage -> [PlutusLedgerLanguage] Source # enumFromThen :: PlutusLedgerLanguage -> PlutusLedgerLanguage -> [PlutusLedgerLanguage] Source # enumFromTo :: PlutusLedgerLanguage -> PlutusLedgerLanguage -> [PlutusLedgerLanguage] Source # enumFromThenTo :: PlutusLedgerLanguage -> PlutusLedgerLanguage -> PlutusLedgerLanguage -> [PlutusLedgerLanguage] Source # | |||||
| Generic PlutusLedgerLanguage Source # | |||||
Defined in PlutusLedgerApi.Common.Versions Associated Types
Methods from :: PlutusLedgerLanguage -> Rep PlutusLedgerLanguage x Source # to :: Rep PlutusLedgerLanguage x -> PlutusLedgerLanguage Source # | |||||
| Show PlutusLedgerLanguage Source # | |||||
Defined in PlutusLedgerApi.Common.Versions | |||||
| NFData PlutusLedgerLanguage Source # | |||||
Defined in PlutusLedgerApi.Common.Versions Methods rnf :: PlutusLedgerLanguage -> () Source # | |||||
| Eq PlutusLedgerLanguage Source # | |||||
Defined in PlutusLedgerApi.Common.Versions Methods (==) :: PlutusLedgerLanguage -> PlutusLedgerLanguage -> Bool Source # (/=) :: PlutusLedgerLanguage -> PlutusLedgerLanguage -> Bool Source # | |||||
| Ord PlutusLedgerLanguage Source # | |||||
Defined in PlutusLedgerApi.Common.Versions Methods compare :: PlutusLedgerLanguage -> PlutusLedgerLanguage -> Ordering Source # (<) :: PlutusLedgerLanguage -> PlutusLedgerLanguage -> Bool Source # (<=) :: PlutusLedgerLanguage -> PlutusLedgerLanguage -> Bool Source # (>) :: PlutusLedgerLanguage -> PlutusLedgerLanguage -> Bool Source # (>=) :: PlutusLedgerLanguage -> PlutusLedgerLanguage -> Bool Source # max :: PlutusLedgerLanguage -> PlutusLedgerLanguage -> PlutusLedgerLanguage Source # min :: PlutusLedgerLanguage -> PlutusLedgerLanguage -> PlutusLedgerLanguage Source # | |||||
| NoThunks PlutusLedgerLanguage Source # | |||||
Defined in PlutusLedgerApi.Common.Versions Methods noThunks :: Context -> PlutusLedgerLanguage -> IO (Maybe ThunkInfo) wNoThunks :: Context -> PlutusLedgerLanguage -> IO (Maybe ThunkInfo) | |||||
| Pretty PlutusLedgerLanguage Source # | |||||
Defined in PlutusLedgerApi.Common.Versions | |||||
| Serialise PlutusLedgerLanguage Source # | |||||
Defined in PlutusLedgerApi.Common.Versions Methods encode :: PlutusLedgerLanguage -> Encoding decode :: Decoder s PlutusLedgerLanguage encodeList :: [PlutusLedgerLanguage] -> Encoding decodeList :: Decoder s [PlutusLedgerLanguage] | |||||
| type Rep PlutusLedgerLanguage Source # | |||||
Defined in PlutusLedgerApi.Common.Versions type Rep PlutusLedgerLanguage = D1 ('MetaData "PlutusLedgerLanguage" "PlutusLedgerApi.Common.Versions" "plutus-ledger-api-1.60.0.0-G1HmqwHNllaA7AnJNjAfhP" '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))) | |||||
Plutus Core language versions
Constructors
| Version | |
Fields | |
Instances
| Generic Version | |||||
Defined in PlutusCore.Version Associated Types
| |||||
| Show Version | |||||
| NFData Version | |||||
Defined in PlutusCore.Version | |||||
| Eq Version | |||||
| Ord Version | |||||
Defined in PlutusCore.Version | |||||
| Hashable Version | |||||
Defined in PlutusCore.Version | |||||
| Pretty Version | |||||
Defined in PlutusCore.Version | |||||
| type Rep Version | |||||
Defined in PlutusCore.Version type Rep Version = D1 ('MetaData "Version" "PlutusCore.Version" "plutus-core-1.60.0.0-LXFqBsoUlXsJIEqLytHte7" 'False) (C1 ('MetaCons "Version" 'PrefixI 'True) (S1 ('MetaSel ('Just "_versionMajor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: (S1 ('MetaSel ('Just "_versionMinor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "_versionPatch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))) | |||||
Version-testing functions
ledgerLanguageIntroducedIn :: PlutusLedgerLanguage -> MajorProtocolVersion Source #
Query the protocol version that a specific Plutus ledger language was first introduced in.
ledgerLanguagesAvailableIn :: MajorProtocolVersion -> Set PlutusLedgerLanguage Source #
Which Plutus language versions are available in the given
MajorProtocolVersion? See Note [New builtins/language versions and protocol
versions]. This function (and others in this module) assumes that once a LL is
available it remains available in all later PVs and that if m <= n, PlutusVm is
introduced no later than PlutusVn.
plcVersionsIntroducedIn :: PlutusLedgerLanguage -> Map MajorProtocolVersion (Set Version) Source #
A map indicating which Plutus Core versions were introduced in which
MajorProtocolVersion and PlutusLedgerLanguage. Each version should appear at most once.
This must be updated when new versions are added.
See Note [New builtins/language versions and protocol versions]
plcVersionsAvailableIn :: PlutusLedgerLanguage -> MajorProtocolVersion -> Set Version Source #
Which Plutus Core language versions are available in the given PlutusLedgerLanguage
and MajorProtocolVersion?
builtinsIntroducedIn :: PlutusLedgerLanguage -> Map MajorProtocolVersion (Set DefaultFun) Source #
Given a ledger language, return a map indicating which builtin functions were
introduced in which MajorProtocolVersion. This must be updated when new
builtins are added. It is not necessary to add entries for protocol versions
where no new builtins are added. See Note [New builtins/language versions and
protocol versions]
builtinsAvailableIn :: PlutusLedgerLanguage -> MajorProtocolVersion -> Set DefaultFun Source #
Return a set containing the builtins which are available in a given LL in a
given PV. All builtins are available in all LLs from vanRossemPV onwards.