Safe Haskell	Safe-Inferred
Language	Haskell2010

PlutusLedgerApi.Common.Versions

Contents

Cardano Protocol versions
- Protocol Version aliases
Plutus ledger languages
Plutus Core language versions
Version-testing functions

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 {
- getMajorProtocolVersion :: Int
}
shelleyPV :: MajorProtocolVersion
allegraPV :: MajorProtocolVersion
maryPV :: MajorProtocolVersion
alonzoPV :: MajorProtocolVersion
vasilPV :: MajorProtocolVersion
valentinePV :: MajorProtocolVersion
conwayPV :: MajorProtocolVersion
conwayPlus1PV :: MajorProtocolVersion
knownPVs :: Set MajorProtocolVersion
futurePV :: MajorProtocolVersion
data PlutusLedgerLanguage
- = PlutusV1
- | PlutusV2
- | PlutusV3
data Version = Version {
- _versionMajor :: Natural
- _versionMinor :: Natural
- _versionPatch :: Natural
}
ledgerLanguageIntroducedIn :: PlutusLedgerLanguage -> MajorProtocolVersion
ledgerLanguagesAvailableIn :: MajorProtocolVersion -> Set PlutusLedgerLanguage
plcVersionsIntroducedIn :: Map (PlutusLedgerLanguage, MajorProtocolVersion) (Set Version)
plcVersionsAvailableIn :: PlutusLedgerLanguage -> MajorProtocolVersion -> Set Version
builtinsIntroducedIn :: Map (PlutusLedgerLanguage, MajorProtocolVersion) (Set DefaultFun)
builtinsAvailableIn :: PlutusLedgerLanguage -> MajorProtocolVersion -> Set 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 getMajorProtocolVersion :: Int

Instances

Instances details

Generic MajorProtocolVersion Source #
Instance details Defined in PlutusLedgerApi.Common.ProtocolVersions Associated Types type Rep MajorProtocolVersion :: Type -> Type Source # Methods from :: MajorProtocolVersion -> Rep MajorProtocolVersion x Source # to :: Rep MajorProtocolVersion x -> MajorProtocolVersion Source #
Show MajorProtocolVersion Source #
Instance details Defined in PlutusLedgerApi.Common.ProtocolVersions Methods showsPrec :: Int -> MajorProtocolVersion -> ShowS Source # show :: MajorProtocolVersion -> String Source # showList :: [MajorProtocolVersion] -> ShowS Source #
Eq MajorProtocolVersion Source #
Instance details Defined in PlutusLedgerApi.Common.ProtocolVersions Methods (==) :: MajorProtocolVersion -> MajorProtocolVersion -> Bool Source # (/=) :: MajorProtocolVersion -> MajorProtocolVersion -> Bool Source #
Ord MajorProtocolVersion Source #
Instance details Defined in PlutusLedgerApi.Common.ProtocolVersions Methods compare :: MajorProtocolVersion -> MajorProtocolVersion -> Ordering Source # (<) :: MajorProtocolVersion -> MajorProtocolVersion -> Bool Source # (<=) :: MajorProtocolVersion -> MajorProtocolVersion -> Bool Source # (>) :: MajorProtocolVersion -> MajorProtocolVersion -> Bool Source # (>=) :: MajorProtocolVersion -> MajorProtocolVersion -> Bool Source # max :: MajorProtocolVersion -> MajorProtocolVersion -> MajorProtocolVersion Source # min :: MajorProtocolVersion -> MajorProtocolVersion -> MajorProtocolVersion Source #
Pretty MajorProtocolVersion Source #
Instance details Defined in PlutusLedgerApi.Common.ProtocolVersions Methods pretty :: MajorProtocolVersion -> Doc ann prettyList :: [MajorProtocolVersion] -> Doc ann
Serialise MajorProtocolVersion Source #
Instance details Defined in PlutusLedgerApi.Common.ProtocolVersions Methods encode :: MajorProtocolVersion -> Encoding decode :: Decoder s MajorProtocolVersion encodeList :: [MajorProtocolVersion] -> Encoding decodeList :: Decoder s [MajorProtocolVersion]
type Rep MajorProtocolVersion Source #
Instance details Defined in PlutusLedgerApi.Common.ProtocolVersions type Rep MajorProtocolVersion = D1 ('MetaData "MajorProtocolVersion" "PlutusLedgerApi.Common.ProtocolVersions" "plutus-ledger-api-1.30.0.0-AeqdHlc23KHCP4Mgl3sbFx" 'True) (C1 ('MetaCons "MajorProtocolVersion" 'PrefixI 'True) (S1 ('MetaSel ('Just "getMajorProtocolVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

Protocol Version aliases

Based on https://github.com/IntersectMBO/cardano-ledger/wiki/First-Block-of-Each-Era

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 #

Vasil era was introduced in protocol version 7.0

valentinePV :: MajorProtocolVersion Source #

Protocol version 8.0 was the Valentine intra-era HF

conwayPV :: MajorProtocolVersion Source #

Conway era was introduced in protocol version 9.0

conwayPlus1PV :: MajorProtocolVersion Source #

The next HF after Conway. It doesn't yet have a name, and it's not yet known whether it will be an intra-era HF or introduce a new era.

knownPVs :: Set MajorProtocolVersion Source #

The set of protocol versions that are "known", i.e. that have been released and have actual differences associated with them.

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. New builtins should always be given this protocol version until they've been finalised.

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 shelley era
PlutusV2	introduced in vasil era
PlutusV3	not yet enabled

Instances

Instances details

Bounded PlutusLedgerLanguage Source #
Instance details Defined in PlutusLedgerApi.Common.Versions Methods minBound :: PlutusLedgerLanguage Source # maxBound :: PlutusLedgerLanguage Source #
Enum PlutusLedgerLanguage Source #
Instance details 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 #
Instance details Defined in PlutusLedgerApi.Common.Versions Associated Types type Rep PlutusLedgerLanguage :: Type -> Type Source # Methods from :: PlutusLedgerLanguage -> Rep PlutusLedgerLanguage x Source # to :: Rep PlutusLedgerLanguage x -> PlutusLedgerLanguage Source #
Show PlutusLedgerLanguage Source #
Instance details Defined in PlutusLedgerApi.Common.Versions Methods showsPrec :: Int -> PlutusLedgerLanguage -> ShowS Source # show :: PlutusLedgerLanguage -> String Source # showList :: [PlutusLedgerLanguage] -> ShowS Source #
NFData PlutusLedgerLanguage Source #
Instance details Defined in PlutusLedgerApi.Common.Versions Methods rnf :: PlutusLedgerLanguage -> () Source #
Eq PlutusLedgerLanguage Source #
Instance details Defined in PlutusLedgerApi.Common.Versions Methods (==) :: PlutusLedgerLanguage -> PlutusLedgerLanguage -> Bool Source # (/=) :: PlutusLedgerLanguage -> PlutusLedgerLanguage -> Bool Source #
Ord PlutusLedgerLanguage Source #
Instance details 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 #
Instance details Defined in PlutusLedgerApi.Common.Versions Methods noThunks :: Context -> PlutusLedgerLanguage -> IO (Maybe ThunkInfo) wNoThunks :: Context -> PlutusLedgerLanguage -> IO (Maybe ThunkInfo) showTypeOf :: Proxy PlutusLedgerLanguage -> String
Pretty PlutusLedgerLanguage Source #
Instance details Defined in PlutusLedgerApi.Common.Versions Methods pretty :: PlutusLedgerLanguage -> Doc ann prettyList :: [PlutusLedgerLanguage] -> Doc ann
type Rep PlutusLedgerLanguage Source #
Instance details Defined in PlutusLedgerApi.Common.Versions type Rep PlutusLedgerLanguage = D1 ('MetaData "PlutusLedgerLanguage" "PlutusLedgerApi.Common.Versions" "plutus-ledger-api-1.30.0.0-AeqdHlc23KHCP4Mgl3sbFx" '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

data Version #

Constructors

Version
Fields _versionMajor :: Natural _versionMinor :: Natural _versionPatch :: Natural

Instances

Instances details

Generic Version
Instance details Defined in PlutusCore.Version Associated Types type Rep Version :: Type -> Type Source # Methods from :: Version -> Rep Version x Source # to :: Rep Version x -> Version Source #
Show Version
Instance details Defined in PlutusCore.Version Methods showsPrec :: Int -> Version -> ShowS Source # show :: Version -> String Source # showList :: [Version] -> ShowS Source #
NFData Version
Instance details Defined in PlutusCore.Version Methods rnf :: Version -> () Source #
Eq Version
Instance details Defined in PlutusCore.Version Methods (==) :: Version -> Version -> Bool Source # (/=) :: Version -> Version -> Bool Source #
Ord Version
Instance details Defined in PlutusCore.Version Methods compare :: Version -> Version -> Ordering Source # (<) :: Version -> Version -> Bool Source # (<=) :: Version -> Version -> Bool Source # (>) :: Version -> Version -> Bool Source # (>=) :: Version -> Version -> Bool Source # max :: Version -> Version -> Version Source # min :: Version -> Version -> Version Source #
Hashable Version
Instance details Defined in PlutusCore.Version Methods hashWithSalt :: Int -> Version -> Int hash :: Version -> Int
Pretty Version
Instance details Defined in PlutusCore.Version Methods pretty :: Version -> Doc ann prettyList :: [Version] -> Doc ann
type Rep Version
Instance details Defined in PlutusCore.Version type Rep Version = D1 ('MetaData "Version" "PlutusCore.Version" "plutus-core-1.30.0.0-Brmv4OxgBsXE3Q8WMR2zgg" '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]

plcVersionsIntroducedIn :: Map (PlutusLedgerLanguage, 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?

See Note [New builtins/language versions and protocol versions]

builtinsIntroducedIn :: Map (PlutusLedgerLanguage, MajorProtocolVersion) (Set DefaultFun) Source #

A map indicating which builtin functions were introduced in which MajorProtocolVersion.

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

builtinsAvailableIn :: PlutusLedgerLanguage -> MajorProtocolVersion -> Set DefaultFun Source #

Which builtin functions are available in the given given PlutusLedgerLanguage and MajorProtocolVersion?

See Note [New builtins/language versions and protocol versions]