Tezos.Core

Core primitive Tezos types.

Mutez

data Mutez

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

Instances

Bounded Mutez

Defined in Tezos.Core

Methods

minBound :: Mutez

maxBound :: Mutez

Enum Mutez

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

Defined in Tezos.Core

Methods

(==) :: Mutez -> Mutez -> Bool

(/=) :: Mutez -> Mutez -> Bool

Data Mutez

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

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

Defined in Tezos.Core

Methods

showsPrec :: Int -> Mutez -> ShowS

show :: Mutez -> String

showList :: [Mutez] -> ShowS

Generic Mutez

Defined in Tezos.Core

Associated Types

type Rep Mutez :: Type -> Type

Methods

from :: Mutez -> Rep Mutez x

to :: Rep Mutez x -> Mutez

ToJSON Mutez

Defined in Tezos.Core

Methods

toJSON :: Mutez -> Value

toEncoding :: Mutez -> Encoding

toJSONList :: [Mutez] -> Value

toEncodingList :: [Mutez] -> Encoding

FromJSON Mutez

Defined in Tezos.Core

Methods

parseJSON :: Value -> Parser Mutez

parseJSONList :: Value -> Parser [Mutez]

NFData Mutez

Defined in Tezos.Core

Methods

rnf :: Mutez -> ()

Buildable Mutez

Defined in Tezos.Core

Methods

build :: Mutez -> Builder

HasCLReader Mutez

Defined in Tezos.Core

Methods

getReader :: ReadM Mutez

getMetavar :: String

IsoValue Mutez

Defined in Michelson.Typed.Haskell.Value

Associated Types

type ToT Mutez :: T

Methods

toVal :: Mutez -> Value (ToT Mutez)

fromVal :: Value (ToT Mutez) -> Mutez

TypeHasDoc Mutez

Defined in Michelson.Typed.Haskell.Doc

Associated Types

type TypeDocFieldDescriptions Mutez :: FieldDescriptions

Methods

typeDocName :: Proxy Mutez -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy Mutez -> WithinParens -> Markdown

typeDocDependencies :: Proxy Mutez -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep Mutez

typeDocMichelsonRep :: TypeDocMichelsonRep Mutez

type Rep Mutez

Defined in Tezos.Core

type Rep Mutez = D1 ('MetaData "Mutez" "Tezos.Core" "morley-1.12.0-inplace" 'True) (C1 ('MetaCons "Mutez" 'PrefixI 'True) (S1 ('MetaSel ('Just "unMutez") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

type ToT Mutez

Defined in Michelson.Typed.Haskell.Value

type ToT Mutez = 'TMutez

type TypeDocFieldDescriptions Mutez

Defined in Michelson.Typed.Haskell.Doc

type TypeDocFieldDescriptions Mutez = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

mkMutez :: Word64 -> Maybe Mutez

Safely create Mutez checking for overflow.

mkMutez' :: Integral i => i -> Either Text Mutez

Version of mkMutez that accepts a number of any type.

unsafeMkMutez :: HasCallStack => Word64 -> Mutez

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

toMutez :: Word32 -> Mutez

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

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

unsafeAddMutez :: HasCallStack => Mutez -> Mutez -> Mutez

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

subMutez :: Mutez -> Mutez -> Maybe Mutez

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

unsafeSubMutez :: HasCallStack => Mutez -> Mutez -> Mutez

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

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

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

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

Euclidian division of two Mutez values.

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

Euclidian division of Mutez and a number.

mutezToInt64 :: Mutez -> Int64

Convert mutez to signed number.

TODO [#423]: try to provide a generic safe conversion method

zeroMutez :: Mutez

oneMutez :: Mutez

prettyTez :: Mutez -> Text

>>> prettyTez (toMutez 420)
"0.00042 ꜩ"
>>> prettyTez (toMutez 42000000)
"42 ꜩ"

Timestamp

newtype Timestamp

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

Constructors

Timestamp

Fields

• unTimestamp :: POSIXTime

Instances

Eq Timestamp

Defined in Tezos.Core

Methods

(==) :: Timestamp -> Timestamp -> Bool

(/=) :: Timestamp -> Timestamp -> Bool

Data Timestamp

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

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

Defined in Tezos.Core

Methods

showsPrec :: Int -> Timestamp -> ShowS

show :: Timestamp -> String

showList :: [Timestamp] -> ShowS

Generic Timestamp

Defined in Tezos.Core

Associated Types

type Rep Timestamp :: Type -> Type

Methods

from :: Timestamp -> Rep Timestamp x

to :: Rep Timestamp x -> Timestamp

ToJSON Timestamp

Defined in Tezos.Core

Methods

toJSON :: Timestamp -> Value

toEncoding :: Timestamp -> Encoding

toJSONList :: [Timestamp] -> Value

toEncodingList :: [Timestamp] -> Encoding

FromJSON Timestamp

Defined in Tezos.Core

Methods

parseJSON :: Value -> Parser Timestamp

parseJSONList :: Value -> Parser [Timestamp]

NFData Timestamp

Defined in Tezos.Core

Methods

rnf :: Timestamp -> ()

Buildable Timestamp

Defined in Tezos.Core

Methods

build :: Timestamp -> Builder

IsoValue Timestamp

Defined in Michelson.Typed.Haskell.Value

Associated Types

type ToT Timestamp :: T

Methods

toVal :: Timestamp -> Value (ToT Timestamp)

fromVal :: Value (ToT Timestamp) -> Timestamp

TypeHasDoc Timestamp

Defined in Michelson.Typed.Haskell.Doc

Associated Types

type TypeDocFieldDescriptions Timestamp :: FieldDescriptions

Methods

typeDocName :: Proxy Timestamp -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy Timestamp -> WithinParens -> Markdown

typeDocDependencies :: Proxy Timestamp -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep Timestamp

typeDocMichelsonRep :: TypeDocMichelsonRep Timestamp

type Rep Timestamp

Defined in Tezos.Core

type Rep Timestamp = D1 ('MetaData "Timestamp" "Tezos.Core" "morley-1.12.0-inplace" 'True) (C1 ('MetaCons "Timestamp" 'PrefixI 'True) (S1 ('MetaSel ('Just "unTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime)))

type ToT Timestamp

Defined in Michelson.Typed.Haskell.Value

type ToT Timestamp = 'TTimestamp

type TypeDocFieldDescriptions Timestamp

Defined in Michelson.Typed.Haskell.Doc

type TypeDocFieldDescriptions Timestamp = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

timestampToSeconds :: Integral a => Timestamp -> a

timestampFromSeconds :: Integer -> Timestamp

timestampFromUTCTime :: UTCTime -> Timestamp

timestampToUTCTime :: Timestamp -> UTCTime

timestampPlusSeconds :: Timestamp -> Integer -> Timestamp

Add given amount of seconds to a Timestamp.

formatTimestamp :: Timestamp -> Text

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

Parse textual representation of Timestamp.

timestampQuote :: QuasiQuoter

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

Return current time as Timestamp.

farFuture :: Timestamp

Timestamp which is always greater than result of getCurrentTime.

farPast :: Timestamp

Timestamp which is always less than result of getCurrentTime.

ChainId

newtype ChainId

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

Eq ChainId

Defined in Tezos.Core

Methods

(==) :: ChainId -> ChainId -> Bool

(/=) :: ChainId -> ChainId -> Bool

Show ChainId

Defined in Tezos.Core

Methods

showsPrec :: Int -> ChainId -> ShowS

show :: ChainId -> String

showList :: [ChainId] -> ShowS

Generic ChainId

Defined in Tezos.Core

Associated Types

type Rep ChainId :: Type -> Type

Methods

from :: ChainId -> Rep ChainId x

to :: Rep ChainId x -> ChainId

ToJSON ChainId

Defined in Tezos.Core

Methods

toJSON :: ChainId -> Value

toEncoding :: ChainId -> Encoding

toJSONList :: [ChainId] -> Value

toEncodingList :: [ChainId] -> Encoding

FromJSON ChainId

Defined in Tezos.Core

Methods

parseJSON :: Value -> Parser ChainId

parseJSONList :: Value -> Parser [ChainId]

NFData ChainId

Defined in Tezos.Core

Methods

rnf :: ChainId -> ()

Buildable ChainId

Defined in Tezos.Core

Methods

build :: ChainId -> Builder

IsoValue ChainId

Defined in Michelson.Typed.Haskell.Value

Associated Types

type ToT ChainId :: T

Methods

toVal :: ChainId -> Value (ToT ChainId)

fromVal :: Value (ToT ChainId) -> ChainId

TypeHasDoc ChainId

Defined in Michelson.Typed.Haskell.Doc

Associated Types

type TypeDocFieldDescriptions ChainId :: FieldDescriptions

Methods

typeDocName :: Proxy ChainId -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy ChainId -> WithinParens -> Markdown

typeDocDependencies :: Proxy ChainId -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep ChainId

typeDocMichelsonRep :: TypeDocMichelsonRep ChainId

type Rep ChainId

Defined in Tezos.Core

type Rep ChainId = D1 ('MetaData "ChainId" "Tezos.Core" "morley-1.12.0-inplace" 'True) (C1 ('MetaCons "ChainIdUnsafe" 'PrefixI 'True) (S1 ('MetaSel ('Just "unChainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

type ToT ChainId

Defined in Michelson.Typed.Haskell.Value

type ToT ChainId = 'TChainId

type TypeDocFieldDescriptions ChainId

Defined in Michelson.Typed.Haskell.Doc

type TypeDocFieldDescriptions ChainId = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

mkChainId :: ByteString -> Maybe ChainId

Construct chain ID from raw bytes.

mkChainIdUnsafe :: HasCallStack => ByteString -> ChainId

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

dummyChainId :: ChainId

Identifier of a pseudo network.

formatChainId :: ChainId -> Text

Pretty print ChainId as it is displayed e.g. in tezos-client rpc get chainsmain/chain_id call.

Example of produced value: NetXUdfLh6Gm88t.

mformatChainId :: ChainId -> MText

parseChainId :: Text -> Either ParseChainIdError ChainId

chainIdLength :: Int