Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Ledger.Binary.Version

Contents

Versioning
- Concrete era versions

Synopsis

data Version
getVersion ∷ Integral i ⇒ Version → i
type MinVersion = 0
type MaxVersion = 11
natVersion ∷ ∀ v. (KnownNat v, MinVersion <= v, v <= MaxVersion) ⇒ Version
natVersionProxy ∷ (KnownNat v, MinVersion <= v, v <= MaxVersion) ⇒ Proxy v → Version
succVersion ∷ MonadFail m ⇒ Version → m Version
mkVersion ∷ (Integral i, MonadFail m) ⇒ i → m Version
mkVersion64 ∷ MonadFail m ⇒ Word64 → m Version
getVersion64 ∷ Version → Word64
allVersions ∷ [Version]
byronProtVer ∷ Version
shelleyProtVer ∷ Version

Versioning

data Version Source #

Protocol version number that is used during encoding and decoding. All supported versions are in the range from MinVersion to MaxVersion.

Instances

Instances details

FromJSON Version Source #
Instance details Defined in Cardano.Ledger.Binary.Version Methods parseJSON ∷ Value → Parser Version Source # parseJSONList ∷ Value → Parser [Version] Source # omittedField ∷ Maybe Version Source #
ToJSON Version Source #
Instance details Defined in Cardano.Ledger.Binary.Version Methods toJSON ∷ Version → Value Source # toEncoding ∷ Version → Encoding Source # toJSONList ∷ [Version] → Value Source # toEncodingList ∷ [Version] → Encoding Source # omitField ∷ Version → Bool Source #
Bounded Version Source #
Instance details Defined in Cardano.Ledger.Binary.Version Methods minBound ∷ Version Source # maxBound ∷ Version Source #
Enum Version Source #
Instance details Defined in Cardano.Ledger.Binary.Version Methods succ ∷ Version → Version Source # pred ∷ Version → Version Source # toEnum ∷ Int → Version Source # fromEnum ∷ Version → Int Source # enumFrom ∷ Version → [Version] Source # enumFromThen ∷ Version → Version → [Version] Source # enumFromTo ∷ Version → Version → [Version] Source # enumFromThenTo ∷ Version → Version → Version → [Version] Source #
Show Version Source #
Instance details Defined in Cardano.Ledger.Binary.Version Methods showsPrec ∷ Int → Version → ShowS Source # show ∷ Version → String Source # showList ∷ [Version] → ShowS Source #
FromCBOR Version Source #
Instance details Defined in Cardano.Ledger.Binary.Version Methods fromCBOR ∷ Decoder s Version Source # label ∷ Proxy Version → Text Source #
ToCBOR Version Source #
Instance details Defined in Cardano.Ledger.Binary.Version Methods toCBOR ∷ Version → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy Version → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Version] → Size Source #
DecCBOR Version Source #
Instance details Defined in Cardano.Ledger.Binary.Decoding.DecCBOR Methods decCBOR ∷ Decoder s Version Source # dropCBOR ∷ Proxy Version → Decoder s () Source # label ∷ Proxy Version → Text Source #
EncCBOR Version Source #
Instance details Defined in Cardano.Ledger.Binary.Encoding.EncCBOR Methods encCBOR ∷ Version → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy Version → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [Version] → Size Source #
NFData Version Source #
Instance details Defined in Cardano.Ledger.Binary.Version Methods rnf ∷ Version → () Source #
Eq Version Source #
Instance details Defined in Cardano.Ledger.Binary.Version Methods (==) ∷ Version → Version → Bool Source # (/=) ∷ Version → Version → Bool Source #
Ord Version Source #
Instance details Defined in Cardano.Ledger.Binary.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 #
NoThunks Version Source #
Instance details Defined in Cardano.Ledger.Binary.Version Methods noThunks ∷ Context → Version → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Version → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy Version → String Source #

getVersion ∷ Integral i ⇒ Version → i Source #

Convert a Version to an Integral value.

Note - Version spans a fairly small range of non-negative numbers, so this should be safe even for smallest integral types.

type MinVersion = 0 Source #

Minimum supported version

type MaxVersion = 11 Source #

Maximum supported version. This is the major protocol version of the latest known protocol version that we want to support, including for development and testing.

natVersion ∷ ∀ v. (KnownNat v, MinVersion <= v, v <= MaxVersion) ⇒ Version Source #

Same as natVersionProxy, construct a version from a type level Nat, except it can be supplied through TypeApplications.

natVersionProxy ∷ (KnownNat v, MinVersion <= v, v <= MaxVersion) ⇒ Proxy v → Version Source #

Safely construct a Version from a type level Nat, which is supplied as a Proxy

succVersion ∷ MonadFail m ⇒ Version → m Version Source #

Increment version by 1.

mkVersion ∷ (Integral i, MonadFail m) ⇒ i → m Version Source #

Construct a Version and fail if the supplied value is not a supported version number.

mkVersion64 ∷ MonadFail m ⇒ Word64 → m Version Source #

Construct a Version and fail if the supplied value is not supported version number.

getVersion64 ∷ Version → Word64 Source #

Extract Word64 representation of the Version

allVersions ∷ [Version] Source #

Concrete era versions

byronProtVer ∷ Version Source #

shelleyProtVer ∷ Version Source #