Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Tx.ContestationPeriod

Synopsis

newtype ContestationPeriod = UnsafeContestationPeriod Natural
fromNominalDiffTime :: MonadFail m => NominalDiffTime -> m ContestationPeriod
toNominalDiffTime :: ContestationPeriod -> NominalDiffTime
toChain :: ContestationPeriod -> ContestationPeriod
fromChain :: ContestationPeriod -> ContestationPeriod

Documentation

newtype ContestationPeriod Source #

A positive, non-zero number of seconds. Use fromInteger on positive literals, fromEnum via [1..] syntax or fromNominalDiffTime to create values of unknown sign.

Constructors

UnsafeContestationPeriod Natural

Instances

Instances details

Arbitrary ContestationPeriod Source #
Instance details Defined in Hydra.Tx.ContestationPeriod Methods arbitrary :: Gen ContestationPeriod shrink :: ContestationPeriod -> [ContestationPeriod]
FromJSON ContestationPeriod Source #
Instance details Defined in Hydra.Tx.ContestationPeriod Methods parseJSON :: Value -> Parser ContestationPeriod parseJSONList :: Value -> Parser [ContestationPeriod] omittedField :: Maybe ContestationPeriod
ToJSON ContestationPeriod Source #
Instance details Defined in Hydra.Tx.ContestationPeriod Methods toJSON :: ContestationPeriod -> Value toEncoding :: ContestationPeriod -> Encoding toJSONList :: [ContestationPeriod] -> Value toEncodingList :: [ContestationPeriod] -> Encoding omitField :: ContestationPeriod -> Bool
Enum ContestationPeriod Source #
Instance details Defined in Hydra.Tx.ContestationPeriod Methods succ :: ContestationPeriod -> ContestationPeriod Source # pred :: ContestationPeriod -> ContestationPeriod Source # toEnum :: Int -> ContestationPeriod Source # fromEnum :: ContestationPeriod -> Int Source # enumFrom :: ContestationPeriod -> [ContestationPeriod] Source # enumFromThen :: ContestationPeriod -> ContestationPeriod -> [ContestationPeriod] Source # enumFromTo :: ContestationPeriod -> ContestationPeriod -> [ContestationPeriod] Source # enumFromThenTo :: ContestationPeriod -> ContestationPeriod -> ContestationPeriod -> [ContestationPeriod] Source #
Num ContestationPeriod Source #
Instance details Defined in Hydra.Tx.ContestationPeriod Methods (+) :: ContestationPeriod -> ContestationPeriod -> ContestationPeriod Source # (-) :: ContestationPeriod -> ContestationPeriod -> ContestationPeriod Source # (*) :: ContestationPeriod -> ContestationPeriod -> ContestationPeriod Source # negate :: ContestationPeriod -> ContestationPeriod Source # abs :: ContestationPeriod -> ContestationPeriod Source # signum :: ContestationPeriod -> ContestationPeriod Source # fromInteger :: Integer -> ContestationPeriod Source #
Integral ContestationPeriod Source #
Instance details Defined in Hydra.Tx.ContestationPeriod Methods quot :: ContestationPeriod -> ContestationPeriod -> ContestationPeriod Source # rem :: ContestationPeriod -> ContestationPeriod -> ContestationPeriod Source # div :: ContestationPeriod -> ContestationPeriod -> ContestationPeriod Source # mod :: ContestationPeriod -> ContestationPeriod -> ContestationPeriod Source # quotRem :: ContestationPeriod -> ContestationPeriod -> (ContestationPeriod, ContestationPeriod) Source # divMod :: ContestationPeriod -> ContestationPeriod -> (ContestationPeriod, ContestationPeriod) Source # toInteger :: ContestationPeriod -> Integer Source #
Real ContestationPeriod Source #
Instance details Defined in Hydra.Tx.ContestationPeriod Methods toRational :: ContestationPeriod -> Rational Source #
Show ContestationPeriod Source #
Instance details Defined in Hydra.Tx.ContestationPeriod Methods showsPrec :: Int -> ContestationPeriod -> ShowS Source # show :: ContestationPeriod -> String Source # showList :: [ContestationPeriod] -> ShowS Source #
Eq ContestationPeriod Source #
Instance details Defined in Hydra.Tx.ContestationPeriod Methods (==) :: ContestationPeriod -> ContestationPeriod -> Bool Source # (/=) :: ContestationPeriod -> ContestationPeriod -> Bool Source #
Ord ContestationPeriod Source #
Instance details Defined in Hydra.Tx.ContestationPeriod Methods compare :: ContestationPeriod -> ContestationPeriod -> Ordering Source # (<) :: ContestationPeriod -> ContestationPeriod -> Bool Source # (<=) :: ContestationPeriod -> ContestationPeriod -> Bool Source # (>) :: ContestationPeriod -> ContestationPeriod -> Bool Source # (>=) :: ContestationPeriod -> ContestationPeriod -> Bool Source # max :: ContestationPeriod -> ContestationPeriod -> ContestationPeriod Source # min :: ContestationPeriod -> ContestationPeriod -> ContestationPeriod Source #

fromNominalDiffTime :: MonadFail m => NominalDiffTime -> m ContestationPeriod Source #

Create a ContestationPeriod from a NominalDiffTime. This will fail if a negative NominalDiffTime is provided and truncates to 1s if values < 1s are given.

toNominalDiffTime :: ContestationPeriod -> NominalDiffTime Source #

toChain :: ContestationPeriod -> ContestationPeriod Source #

Convert an off-chain contestation period to its on-chain representation.

fromChain :: ContestationPeriod -> ContestationPeriod Source #

Convert an on-chain contestation period to its off-chain representation. NOTE: Does truncate to whole seconds.