Safe Haskell	None
Language	Haskell2010

Tezos.Core

Contents

Mutez
Timestamp
ChainId

Description

Core primitive Tezos types.

Synopsis

data Mutez
mkMutez :: Word64 -> Maybe Mutez
unsafeMkMutez :: HasCallStack => Word64 -> Mutez
toMutez :: Word32 -> Mutez
addMutez :: Mutez -> Mutez -> Maybe Mutez
unsafeAddMutez :: HasCallStack => Mutez -> Mutez -> Mutez
subMutez :: Mutez -> Mutez -> Maybe Mutez
unsafeSubMutez :: HasCallStack => Mutez -> Mutez -> Mutez
mulMutez :: Integral a => Mutez -> a -> Maybe Mutez
divModMutez :: Mutez -> Mutez -> Maybe (Word64, Mutez)
divModMutezInt :: Integral a => Mutez -> a -> Maybe (Mutez, Mutez)
zeroMutez :: Mutez
oneMutez :: Mutez
newtype Timestamp = Timestamp {
- unTimestamp :: POSIXTime
}
timestampToSeconds :: Integral a => Timestamp -> a
timestampFromSeconds :: Integer -> Timestamp
timestampFromUTCTime :: UTCTime -> Timestamp
timestampPlusSeconds :: Timestamp -> Integer -> Timestamp
formatTimestamp :: Timestamp -> Text
parseTimestamp :: Text -> Maybe Timestamp
timestampQuote :: QuasiQuoter
getCurrentTime :: IO Timestamp
farFuture :: Timestamp
farPast :: Timestamp
newtype ChainId = ChainIdUnsafe {
- unChainId :: ByteString
}
mkChainId :: ByteString -> Maybe ChainId
mkChainIdUnsafe :: HasCallStack => ByteString -> ChainId
dummyChainId :: ChainId
formatChainId :: ChainId -> Text
mformatChainId :: ChainId -> MText
parseChainId :: Text -> Either ParseChainIdError ChainId
chainIdLength :: Int

Mutez

data Mutez Source #

Mutez is a wrapper over integer data type. 1 mutez is 1 token (μTz).

Instances

Instances details

Bounded Mutez Source #
Instance details Defined in Tezos.Core Methods minBound :: Mutez # maxBound :: Mutez #
Enum Mutez Source #
Instance details Defined in Tezos.Core Methods succ :: Mutez -> Mutez # pred :: Mutez -> Mutez # toEnum :: Int -> Mutez # fromEnum :: Mutez -> Int # enumFrom :: Mutez -> [Mutez] # enumFromThen :: Mutez -> Mutez -> [Mutez] # enumFromTo :: Mutez -> Mutez -> [Mutez] # enumFromThenTo :: Mutez -> Mutez -> Mutez -> [Mutez] #
Eq Mutez Source #
Instance details Defined in Tezos.Core Methods (==) :: Mutez -> Mutez -> Bool # (/=) :: Mutez -> Mutez -> Bool #
Data Mutez Source #
Instance details Defined in Tezos.Core Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Mutez -> c Mutez # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Mutez # toConstr :: Mutez -> Constr # dataTypeOf :: Mutez -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Mutez) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Mutez) # gmapT :: (forall b. Data b => b -> b) -> Mutez -> Mutez # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Mutez -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Mutez -> r # gmapQ :: (forall d. Data d => d -> u) -> Mutez -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Mutez -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Mutez -> m Mutez # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Mutez -> m Mutez # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Mutez -> m Mutez #
Ord Mutez Source #
Instance details Defined in Tezos.Core Methods compare :: Mutez -> Mutez -> Ordering # (<) :: Mutez -> Mutez -> Bool # (<=) :: Mutez -> Mutez -> Bool # (>) :: Mutez -> Mutez -> Bool # (>=) :: Mutez -> Mutez -> Bool # max :: Mutez -> Mutez -> Mutez # min :: Mutez -> Mutez -> Mutez #
Show Mutez Source #
Instance details Defined in Tezos.Core Methods showsPrec :: Int -> Mutez -> ShowS # show :: Mutez -> String # showList :: [Mutez] -> ShowS #
Generic Mutez Source #
Instance details Defined in Tezos.Core Associated Types type Rep Mutez :: Type -> Type # Methods from :: Mutez -> Rep Mutez x # to :: Rep Mutez x -> Mutez #
ToJSON Mutez Source #
Instance details Defined in Tezos.Core Methods toJSON :: Mutez -> Value # toEncoding :: Mutez -> Encoding # toJSONList :: [Mutez] -> Value # toEncodingList :: [Mutez] -> Encoding #
FromJSON Mutez Source #
Instance details Defined in Tezos.Core Methods parseJSON :: Value -> Parser Mutez # parseJSONList :: Value -> Parser [Mutez] #
NFData Mutez Source #
Instance details Defined in Tezos.Core Methods rnf :: Mutez -> () #
Buildable Mutez Source #
Instance details Defined in Tezos.Core Methods build :: Mutez -> Builder #
ToADTArbitrary Mutez Source #
Instance details Defined in Util.Test.Arbitrary Methods toADTArbitrarySingleton :: Proxy Mutez -> Gen (ADTArbitrarySingleton Mutez) # toADTArbitrary :: Proxy Mutez -> Gen (ADTArbitrary Mutez) #
HasCLReader Mutez Source #
Instance details Defined in Tezos.Core Methods getReader :: ReadM Mutez Source # getMetavar :: String Source #
IsoValue Mutez Source #
Instance details Defined in Michelson.Typed.Haskell.Value Associated Types type ToT Mutez :: T Source # Methods toVal :: Mutez -> Value (ToT Mutez) Source # fromVal :: Value (ToT Mutez) -> Mutez Source #
TypeHasDoc Mutez Source #
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions Mutez :: FieldDescriptions Source # Methods typeDocName :: Proxy Mutez -> Text Source # typeDocMdDescription :: Markdown Source # typeDocMdReference :: Proxy Mutez -> WithinParens -> Markdown Source # typeDocDependencies :: Proxy Mutez -> [SomeDocDefinitionItem] Source # typeDocHaskellRep :: TypeDocHaskellRep Mutez Source # typeDocMichelsonRep :: TypeDocMichelsonRep Mutez Source #
type Rep Mutez Source #
Instance details Defined in Tezos.Core type Rep Mutez = D1 ('MetaData "Mutez" "Tezos.Core" "morley-1.7.0-inplace" 'True) (C1 ('MetaCons "Mutez" 'PrefixI 'True) (S1 ('MetaSel ('Just "unMutez") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))
type ToT Mutez Source #
Instance details Defined in Michelson.Typed.Haskell.Value type ToT Mutez = 'TMutez
type TypeDocFieldDescriptions Mutez Source #
Instance details Defined in Michelson.Typed.Haskell.Doc type TypeDocFieldDescriptions Mutez = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

mkMutez :: Word64 -> Maybe Mutez Source #

Safely create Mutez checking for overflow.

unsafeMkMutez :: HasCallStack => Word64 -> Mutez Source #

Partial function for Mutez creation, it's pre-condition is that the argument must not exceed the maximal Mutez value.

toMutez :: Word32 -> Mutez Source #

Safely create Mutez.

This is recommended way to create Mutez from a numeric literal; you can't construct all valid Mutez values using this function but for small values it works neat.

Warnings displayed when trying to construct invalid Natural or Word literal are hardcoded for these types in GHC implementation, so we can only exploit these existing rules.

addMutez :: Mutez -> Mutez -> Maybe Mutez Source #

Addition of Mutez values. Returns Nothing in case of overflow.

unsafeAddMutez :: HasCallStack => Mutez -> Mutez -> Mutez Source #

Partial addition of Mutez, should be used only if you're sure there'll be no overflow.

subMutez :: Mutez -> Mutez -> Maybe Mutez Source #

Subtraction of Mutez values. Returns Nothing when the subtrahend is greater than the minuend, and Just otherwise.

unsafeSubMutez :: HasCallStack => Mutez -> Mutez -> Mutez Source #

Partial subtraction of Mutez, should be used only if you're sure there'll be no underflow.

mulMutez :: Integral a => Mutez -> a -> Maybe Mutez Source #

Multiplication of Mutez and an integral number. Returns Nothing in case of overflow.

divModMutez :: Mutez -> Mutez -> Maybe (Word64, Mutez) Source #

Euclidian division of two Mutez values.

divModMutezInt :: Integral a => Mutez -> a -> Maybe (Mutez, Mutez) Source #

Euclidian division of Mutez and a number.

zeroMutez :: Mutez Source #

oneMutez :: Mutez Source #

Timestamp

newtype Timestamp Source #

Time in the real world. Use the functions below to convert it to/from Unix time in seconds.

Constructors

Timestamp
Fields unTimestamp :: POSIXTime

Instances

Instances details

Eq Timestamp Source #
Instance details Defined in Tezos.Core Methods (==) :: Timestamp -> Timestamp -> Bool # (/=) :: Timestamp -> Timestamp -> Bool #
Data Timestamp Source #
Instance details Defined in Tezos.Core Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Timestamp -> c Timestamp # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Timestamp # toConstr :: Timestamp -> Constr # dataTypeOf :: Timestamp -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Timestamp) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Timestamp) # gmapT :: (forall b. Data b => b -> b) -> Timestamp -> Timestamp # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Timestamp -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Timestamp -> r # gmapQ :: (forall d. Data d => d -> u) -> Timestamp -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Timestamp -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Timestamp -> m Timestamp # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Timestamp -> m Timestamp # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Timestamp -> m Timestamp #
Ord Timestamp Source #
Instance details Defined in Tezos.Core Methods compare :: Timestamp -> Timestamp -> Ordering # (<) :: Timestamp -> Timestamp -> Bool # (<=) :: Timestamp -> Timestamp -> Bool # (>) :: Timestamp -> Timestamp -> Bool # (>=) :: Timestamp -> Timestamp -> Bool # max :: Timestamp -> Timestamp -> Timestamp # min :: Timestamp -> Timestamp -> Timestamp #
Show Timestamp Source #
Instance details Defined in Tezos.Core Methods showsPrec :: Int -> Timestamp -> ShowS # show :: Timestamp -> String # showList :: [Timestamp] -> ShowS #
Generic Timestamp Source #
Instance details Defined in Tezos.Core Associated Types type Rep Timestamp :: Type -> Type # Methods from :: Timestamp -> Rep Timestamp x # to :: Rep Timestamp x -> Timestamp #
ToJSON Timestamp Source #
Instance details Defined in Tezos.Core Methods toJSON :: Timestamp -> Value # toEncoding :: Timestamp -> Encoding # toJSONList :: [Timestamp] -> Value # toEncodingList :: [Timestamp] -> Encoding #
FromJSON Timestamp Source #
Instance details Defined in Tezos.Core Methods parseJSON :: Value -> Parser Timestamp # parseJSONList :: Value -> Parser [Timestamp] #
NFData Timestamp Source #
Instance details Defined in Tezos.Core Methods rnf :: Timestamp -> () #
Buildable Timestamp Source #
Instance details Defined in Tezos.Core Methods build :: Timestamp -> Builder #
IsoValue Timestamp Source #
Instance details Defined in Michelson.Typed.Haskell.Value Associated Types type ToT Timestamp :: T Source # Methods toVal :: Timestamp -> Value (ToT Timestamp) Source # fromVal :: Value (ToT Timestamp) -> Timestamp Source #
TypeHasDoc Timestamp Source #
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions Timestamp :: FieldDescriptions Source # Methods typeDocName :: Proxy Timestamp -> Text Source # typeDocMdDescription :: Markdown Source # typeDocMdReference :: Proxy Timestamp -> WithinParens -> Markdown Source # typeDocDependencies :: Proxy Timestamp -> [SomeDocDefinitionItem] Source # typeDocHaskellRep :: TypeDocHaskellRep Timestamp Source # typeDocMichelsonRep :: TypeDocMichelsonRep Timestamp Source #
type Rep Timestamp Source #
Instance details Defined in Tezos.Core type Rep Timestamp = D1 ('MetaData "Timestamp" "Tezos.Core" "morley-1.7.0-inplace" 'True) (C1 ('MetaCons "Timestamp" 'PrefixI 'True) (S1 ('MetaSel ('Just "unTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime)))
type ToT Timestamp Source #
Instance details Defined in Michelson.Typed.Haskell.Value type ToT Timestamp = 'TTimestamp
type TypeDocFieldDescriptions Timestamp Source #
Instance details Defined in Michelson.Typed.Haskell.Doc type TypeDocFieldDescriptions Timestamp = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

timestampToSeconds :: Integral a => Timestamp -> a Source #

timestampFromSeconds :: Integer -> Timestamp Source #

timestampFromUTCTime :: UTCTime -> Timestamp Source #

timestampPlusSeconds :: Timestamp -> Integer -> Timestamp Source #

Add given amount of seconds to a Timestamp.

formatTimestamp :: Timestamp -> Text Source #

Display timestamp in human-readable way as used by Michelson. Uses UTC timezone, though maybe we should take it as an argument.

NB: this will render timestamp with up to seconds precision.

parseTimestamp :: Text -> Maybe Timestamp Source #

Parse textual representation of Timestamp.

timestampQuote :: QuasiQuoter Source #

Quote a value of type Timestamp in yyyy-mm-ddThh:mm:ss[.sss]Z format.

>>> formatTimestamp [timestampQuote| 2019-02-21T16:54:12.2344523Z |]
"2019-02-21T16:54:12Z"

Inspired by 'time-quote' library.

getCurrentTime :: IO Timestamp Source #

Return current time as Timestamp.

farFuture :: Timestamp Source #

Timestamp which is always greater than result of getCurrentTime.

farPast :: Timestamp Source #

Timestamp which is always less than result of getCurrentTime.

ChainId

newtype ChainId Source #

Identifier of a network (babylonnet, mainnet, test network or other). Evaluated as hash of the genesis block.

The only operation supported for this type is packing. Use case: multisig contract, for instance, now includes chain ID into signed data "in order to add extra replay protection between the main chain and the test chain".

Constructors

ChainIdUnsafe
Fields unChainId :: ByteString

Instances

Instances details

Eq ChainId Source #
Instance details Defined in Tezos.Core Methods (==) :: ChainId -> ChainId -> Bool # (/=) :: ChainId -> ChainId -> Bool #
Show ChainId Source #
Instance details Defined in Tezos.Core Methods showsPrec :: Int -> ChainId -> ShowS # show :: ChainId -> String # showList :: [ChainId] -> ShowS #
Generic ChainId Source #
Instance details Defined in Tezos.Core Associated Types type Rep ChainId :: Type -> Type # Methods from :: ChainId -> Rep ChainId x # to :: Rep ChainId x -> ChainId #
Arbitrary ChainId Source #
Instance details Defined in Tezos.Core Methods arbitrary :: Gen ChainId # shrink :: ChainId -> [ChainId] #
ToJSON ChainId Source #
Instance details Defined in Tezos.Core Methods toJSON :: ChainId -> Value # toEncoding :: ChainId -> Encoding # toJSONList :: [ChainId] -> Value # toEncodingList :: [ChainId] -> Encoding #
FromJSON ChainId Source #
Instance details Defined in Tezos.Core Methods parseJSON :: Value -> Parser ChainId # parseJSONList :: Value -> Parser [ChainId] #
NFData ChainId Source #
Instance details Defined in Tezos.Core Methods rnf :: ChainId -> () #
Buildable ChainId Source #
Instance details Defined in Tezos.Core Methods build :: ChainId -> Builder #
IsoValue ChainId Source #
Instance details Defined in Michelson.Typed.Haskell.Value Associated Types type ToT ChainId :: T Source # Methods toVal :: ChainId -> Value (ToT ChainId) Source # fromVal :: Value (ToT ChainId) -> ChainId Source #
type Rep ChainId Source #
Instance details Defined in Tezos.Core type Rep ChainId = D1 ('MetaData "ChainId" "Tezos.Core" "morley-1.7.0-inplace" 'True) (C1 ('MetaCons "ChainIdUnsafe" 'PrefixI 'True) (S1 ('MetaSel ('Just "unChainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))
type ToT ChainId Source #
Instance details Defined in Michelson.Typed.Haskell.Value type ToT ChainId = 'TChainId

mkChainId :: ByteString -> Maybe ChainId Source #

Construct chain ID from raw bytes.

mkChainIdUnsafe :: HasCallStack => ByteString -> ChainId Source #

Construct chain ID from raw bytes or fail otherwise. Expects exactly 4 bytes.

dummyChainId :: ChainId Source #

Identifier of a pseudo network.

formatChainId :: ChainId -> Text Source #

Pretty print ChainId as it is displayed e.g. in ./babylonnet.sh head call.

Example of produced value: NetXUdfLh6Gm88t.

mformatChainId :: ChainId -> MText Source #

parseChainId :: Text -> Either ParseChainIdError ChainId Source #

chainIdLength :: Int Source #