Michelson.Typed.EntryPoints

Utilities for lightweight entrypoints support.

Documentation

data EpAddress

Address with optional entrypoint name attached to it. TODO: come up with better name?

Constructors

EpAddress

Fields

• eaAddress :: Address

  Address itself

• eaEntryPoint :: EpName

  Entrypoint name (might be empty)

Instances

Eq EpAddress

Defined in Michelson.Typed.EntryPoints

Methods

(==) :: EpAddress -> EpAddress -> Bool

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

Ord EpAddress

Defined in Michelson.Typed.EntryPoints

Methods

compare :: EpAddress -> EpAddress -> Ordering

(<) :: EpAddress -> EpAddress -> Bool

(<=) :: EpAddress -> EpAddress -> Bool

(>) :: EpAddress -> EpAddress -> Bool

(>=) :: EpAddress -> EpAddress -> Bool

max :: EpAddress -> EpAddress -> EpAddress

min :: EpAddress -> EpAddress -> EpAddress

Show EpAddress

Defined in Michelson.Typed.EntryPoints

Methods

showsPrec :: Int -> EpAddress -> ShowS

show :: EpAddress -> String

showList :: [EpAddress] -> ShowS

Generic EpAddress

Defined in Michelson.Typed.EntryPoints

Associated Types

type Rep EpAddress :: Type -> Type

Methods

from :: EpAddress -> Rep EpAddress x

to :: Rep EpAddress x -> EpAddress

Arbitrary FieldAnn => Arbitrary EpAddress

Defined in Michelson.Typed.EntryPoints

Methods

arbitrary :: Gen EpAddress

shrink :: EpAddress -> [EpAddress]

NFData EpAddress

Defined in Michelson.Typed.EntryPoints

Methods

rnf :: EpAddress -> ()

Buildable EpAddress

Defined in Michelson.Typed.EntryPoints

Methods

build :: EpAddress -> Builder

IsoValue EpAddress

Defined in Michelson.Typed.Haskell.Value

Associated Types

type ToT EpAddress :: T

Methods

toVal :: EpAddress -> Value (ToT EpAddress)

fromVal :: Value (ToT EpAddress) -> EpAddress

TypeHasDoc EpAddress

Defined in Michelson.Typed.Haskell.Doc

Associated Types

type TypeDocFieldDescriptions EpAddress :: FieldDescriptions

Methods

typeDocName :: Proxy EpAddress -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy EpAddress -> WithinParens -> Markdown

typeDocDependencies :: Proxy EpAddress -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep EpAddress

typeDocMichelsonRep :: TypeDocMichelsonRep EpAddress

type Rep EpAddress

Defined in Michelson.Typed.EntryPoints

type Rep EpAddress = D1 ('MetaData "EpAddress" "Michelson.Typed.EntryPoints" "morley-1.4.0-FPgS4VJ0cLmB07ubDf4i8P" 'False) (C1 ('MetaCons "EpAddress" 'PrefixI 'True) (S1 ('MetaSel ('Just "eaAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Address) :*: S1 ('MetaSel ('Just "eaEntryPoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EpName)))

type ToT EpAddress

Defined in Michelson.Typed.Haskell.Value

type ToT EpAddress = 'TAddress

type TypeDocFieldDescriptions EpAddress

Defined in Michelson.Typed.Haskell.Doc

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

data ParseEpAddressError

Constructors

ParseEpAddressBadAddress ParseAddressError

ParseEpAddressBadRefAnn Text

ParseEpAddressRefAnnError EpNameFromRefAnnError

Instances

Eq ParseEpAddressError

Defined in Michelson.Typed.EntryPoints

Methods

(==) :: ParseEpAddressError -> ParseEpAddressError -> Bool

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

Show ParseEpAddressError

Defined in Michelson.Typed.EntryPoints

Methods

showsPrec :: Int -> ParseEpAddressError -> ShowS

show :: ParseEpAddressError -> String

showList :: [ParseEpAddressError] -> ShowS

Generic ParseEpAddressError

Defined in Michelson.Typed.EntryPoints

Associated Types

type Rep ParseEpAddressError :: Type -> Type

Methods

from :: ParseEpAddressError -> Rep ParseEpAddressError x

to :: Rep ParseEpAddressError x -> ParseEpAddressError

NFData ParseEpAddressError

Defined in Michelson.Typed.EntryPoints

Methods

rnf :: ParseEpAddressError -> ()

Buildable ParseEpAddressError

Defined in Michelson.Typed.EntryPoints

Methods

build :: ParseEpAddressError -> Builder

type Rep ParseEpAddressError

Defined in Michelson.Typed.EntryPoints

type Rep ParseEpAddressError = D1 ('MetaData "ParseEpAddressError" "Michelson.Typed.EntryPoints" "morley-1.4.0-FPgS4VJ0cLmB07ubDf4i8P" 'False) (C1 ('MetaCons "ParseEpAddressBadAddress" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ParseAddressError)) :+: (C1 ('MetaCons "ParseEpAddressBadRefAnn" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :+: C1 ('MetaCons "ParseEpAddressRefAnnError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EpNameFromRefAnnError))))

formatEpAddress :: EpAddress -> Text

mformatEpAddress :: EpAddress -> MText

parseEpAddress :: Text -> Either ParseEpAddressError EpAddress

Parse an address which can be suffixed with entrypoint name (e.g. "tz1faswCTDciRzE4oJ9jn2Vm2dvjeyA9fUzU%entrypoint").

unsafeParseEpAddress :: HasCallStack => Text -> EpAddress

genEpAddress :: (MonadGen m, GenBase m ~ Identity) => m EpAddress

data ParamNotes (t :: T)

Annotations for contract parameter declaration.

Following the Michelson specification, this type has the following invariants: 1. No entrypoint name is duplicated. 2. If default entrypoint is explicitly assigned, no "arm" remains uncallable.

Constructors

ParamNotesUnsafe

Fields

• pnNotes :: Notes t
• pnRootAnn :: RootAnn

Instances

Eq (ParamNotes t)

Defined in Michelson.Typed.EntryPoints

Methods

(==) :: ParamNotes t -> ParamNotes t -> Bool

(/=) :: ParamNotes t -> ParamNotes t -> Bool

Show (ParamNotes t)

Defined in Michelson.Typed.EntryPoints

Methods

showsPrec :: Int -> ParamNotes t -> ShowS

show :: ParamNotes t -> String

showList :: [ParamNotes t] -> ShowS

Generic (ParamNotes t)

Defined in Michelson.Typed.EntryPoints

Associated Types

type Rep (ParamNotes t) :: Type -> Type

Methods

from :: ParamNotes t -> Rep (ParamNotes t) x

to :: Rep (ParamNotes t) x -> ParamNotes t

NFData (ParamNotes t)

Defined in Michelson.Typed.EntryPoints

Methods

rnf :: ParamNotes t -> ()

type Rep (ParamNotes t)

Defined in Michelson.Typed.EntryPoints

type Rep (ParamNotes t) = D1 ('MetaData "ParamNotes" "Michelson.Typed.EntryPoints" "morley-1.4.0-FPgS4VJ0cLmB07ubDf4i8P" 'False) (C1 ('MetaCons "ParamNotesUnsafe" 'PrefixI 'True) (S1 ('MetaSel ('Just "pnNotes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Notes t)) :*: S1 ('MetaSel ('Just "pnRootAnn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RootAnn)))

pattern ParamNotes :: Notes t -> RootAnn -> ParamNotes t

starParamNotes :: SingI t => ParamNotes t

Parameter without annotations.

data ArmCoord

Constructors

AcLeft

AcRight

Instances

Eq ArmCoord

Defined in Michelson.Typed.EntryPoints

Methods

(==) :: ArmCoord -> ArmCoord -> Bool

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

Show ArmCoord

Defined in Michelson.Typed.EntryPoints

Methods

showsPrec :: Int -> ArmCoord -> ShowS

show :: ArmCoord -> String

showList :: [ArmCoord] -> ShowS

Generic ArmCoord

Defined in Michelson.Typed.EntryPoints

Associated Types

type Rep ArmCoord :: Type -> Type

Methods

from :: ArmCoord -> Rep ArmCoord x

to :: Rep ArmCoord x -> ArmCoord

NFData ArmCoord

Defined in Michelson.Typed.EntryPoints

Methods

rnf :: ArmCoord -> ()

Buildable ArmCoord

Defined in Michelson.Typed.EntryPoints

Methods

build :: ArmCoord -> Builder

type Rep ArmCoord

Defined in Michelson.Typed.EntryPoints

type Rep ArmCoord = D1 ('MetaData "ArmCoord" "Michelson.Typed.EntryPoints" "morley-1.4.0-FPgS4VJ0cLmB07ubDf4i8P" 'False) (C1 ('MetaCons "AcLeft" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AcRight" 'PrefixI 'False) (U1 :: Type -> Type))

type ArmCoords = [ArmCoord]

Coordinates of "arm" in Or tree, used solely in error messages.

data ParamEpError

Errors specific to parameter type declaration (entrypoints).

Constructors

ParamEpDuplicatedNames (NonEmpty EpName)

ParamEpUncallableArm ArmCoords

Instances

Eq ParamEpError

Defined in Michelson.Typed.EntryPoints

Methods

(==) :: ParamEpError -> ParamEpError -> Bool

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

Show ParamEpError

Defined in Michelson.Typed.EntryPoints

Methods

showsPrec :: Int -> ParamEpError -> ShowS

show :: ParamEpError -> String

showList :: [ParamEpError] -> ShowS

Generic ParamEpError

Defined in Michelson.Typed.EntryPoints

Associated Types

type Rep ParamEpError :: Type -> Type

Methods

from :: ParamEpError -> Rep ParamEpError x

to :: Rep ParamEpError x -> ParamEpError

NFData ParamEpError

Defined in Michelson.Typed.EntryPoints

Methods

rnf :: ParamEpError -> ()

Buildable ParamEpError

Defined in Michelson.Typed.EntryPoints

Methods

build :: ParamEpError -> Builder

type Rep ParamEpError

Defined in Michelson.Typed.EntryPoints

type Rep ParamEpError = D1 ('MetaData "ParamEpError" "Michelson.Typed.EntryPoints" "morley-1.4.0-FPgS4VJ0cLmB07ubDf4i8P" 'False) (C1 ('MetaCons "ParamEpDuplicatedNames" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty EpName))) :+: C1 ('MetaCons "ParamEpUncallableArm" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ArmCoords)))

mkParamNotes :: Notes t -> RootAnn -> Either ParamEpError (ParamNotes t)

Construct ParamNotes performing all necessary checks.

data EpLiftSequence (arg :: T) (param :: T) where

Describes how to construct full contract parameter from given entrypoint argument.

This could be just wrapper over Value arg -> Value param, but we cannot use Value type in this module easily.

Constructors

EplArgHere :: EpLiftSequence arg arg

EplWrapLeft :: (KnownT subparam, KnownT r) => EpLiftSequence arg subparam -> EpLiftSequence arg ('TOr subparam r)

EplWrapRight :: (KnownT l, KnownT subparam) => EpLiftSequence arg subparam -> EpLiftSequence arg ('TOr l subparam)

Instances

Eq (EpLiftSequence arg param)

Defined in Michelson.Typed.EntryPoints

Methods

(==) :: EpLiftSequence arg param -> EpLiftSequence arg param -> Bool

(/=) :: EpLiftSequence arg param -> EpLiftSequence arg param -> Bool

Show (EpLiftSequence arg param)

Defined in Michelson.Typed.EntryPoints

Methods

showsPrec :: Int -> EpLiftSequence arg param -> ShowS

show :: EpLiftSequence arg param -> String

showList :: [EpLiftSequence arg param] -> ShowS

NFData (EpLiftSequence param arg)

Defined in Michelson.Typed.EntryPoints

Methods

rnf :: EpLiftSequence param arg -> ()

Buildable (EpLiftSequence arg param)

Defined in Michelson.Typed.EntryPoints

Methods

build :: EpLiftSequence arg param -> Builder

data EntryPointCallT (param :: T) (arg :: T)

Reference for calling a specific entrypoint of type arg.

Constructors

ParameterScope arg => EntryPointCall

Fields

• epcName :: EpName

  Name of entrypoint.

• epcParamProxy :: Proxy param

  Proxy of parameter, to make parameter type more easily fetchable.

• epcLiftSequence :: EpLiftSequence arg param

  How to call this entrypoint in the corresponding contract.

Instances

Eq (EntryPointCallT param arg)

Defined in Michelson.Typed.EntryPoints

Methods

(==) :: EntryPointCallT param arg -> EntryPointCallT param arg -> Bool

(/=) :: EntryPointCallT param arg -> EntryPointCallT param arg -> Bool

Show (EntryPointCallT param arg)

Defined in Michelson.Typed.EntryPoints

Methods

showsPrec :: Int -> EntryPointCallT param arg -> ShowS

show :: EntryPointCallT param arg -> String

showList :: [EntryPointCallT param arg] -> ShowS

NFData (EntryPointCallT param arg)

Defined in Michelson.Typed.EntryPoints

Methods

rnf :: EntryPointCallT param arg -> ()

Buildable (EntryPointCallT param arg)

Defined in Michelson.Typed.EntryPoints

Methods

build :: EntryPointCallT param arg -> Builder

epcPrimitive :: forall p. (ParameterScope p, ForbidOr p) => EntryPointCallT p p

Call parameter which has no entrypoints, always safe.

epcCallRootUnsafe :: ParameterScope param => EntryPointCallT param param

Construct EntryPointCallT which calls no entrypoint and assumes that there is no explicit "default" one.

Validity of such operation is not ensured.

data SomeEntryPointCallT (arg :: T)

EntryPointCallT with hidden parameter type.

This requires argument to satisfy ParameterScope constraint. Strictly speaking, entrypoint argument may one day start having different set of constraints comparing to ones applied to parameter, but this seems unlikely.

Constructors

forall param.ParameterScope param => SomeEpc (EntryPointCallT param arg)

Instances

Eq (SomeEntryPointCallT arg)

Defined in Michelson.Typed.EntryPoints

Methods

(==) :: SomeEntryPointCallT arg -> SomeEntryPointCallT arg -> Bool

(/=) :: SomeEntryPointCallT arg -> SomeEntryPointCallT arg -> Bool

Show (SomeEntryPointCallT arg)

Defined in Michelson.Typed.EntryPoints

Methods

showsPrec :: Int -> SomeEntryPointCallT arg -> ShowS

show :: SomeEntryPointCallT arg -> String

showList :: [SomeEntryPointCallT arg] -> ShowS

NFData (SomeEntryPointCallT arg)

Defined in Michelson.Typed.EntryPoints

Methods

rnf :: SomeEntryPointCallT arg -> ()

Buildable (SomeEntryPointCallT arg)

Defined in Michelson.Typed.EntryPoints

Methods

build :: SomeEntryPointCallT arg -> Builder

sepcCallRootUnsafe :: ParameterScope param => SomeEntryPointCallT param

Construct SomeEntryPointCallT which calls no entrypoint and assumes that there is no explicit "default" one.

Validity of such operation is not ensured.

sepcPrimitive :: forall t. (ParameterScope t, ForbidOr t) => SomeEntryPointCallT t

Call parameter which has no entrypoints, always safe.

sepcName :: SomeEntryPointCallT arg -> EpName

type family ForbidOr (t :: T) :: Constraint where ...

Equations

ForbidOr ('TOr l r) = TypeError ('Text "Cannot apply to sum type parameter " :<>: 'ShowType ('TOr l r))

ForbidOr _ = ()

data MkEntryPointCallRes param where

Constructors

MkEntryPointCallRes :: ParameterScope arg => Notes arg -> EntryPointCallT param arg -> MkEntryPointCallRes param

mkEntryPointCall :: ParameterScope param => EpName -> ParamNotes param -> Maybe (MkEntryPointCallRes param)

Build EntryPointCallT.

Here we accept entrypoint name and type information for the parameter of target contract.

Returns Nothing if entrypoint is not found.

tyImplicitAccountParam :: ParamNotes 'TUnit

Parameter type of implicit account.

flattenEntryPoints :: SingI t => ParamNotes t -> Map EpName Type

Flatten a provided list of notes to a map of its entrypoints and its corresponding utype. Please refer to mkEntrypointsMap in regards to how duplicate entrypoints are handled.

Re-exports

newtype EpName

Entrypoint name.

Empty if this entrypoint is default one. Cannot be equal to "default", the reference implementation forbids that. Also, set of allowed characters should be the same as in annotations.

Constructors

EpNameUnsafe

Fields

• unEpName :: Text

Instances

Eq EpName

Defined in Michelson.Untyped.EntryPoints

Methods

(==) :: EpName -> EpName -> Bool

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

Ord EpName

Defined in Michelson.Untyped.EntryPoints

Methods

compare :: EpName -> EpName -> Ordering

(<) :: EpName -> EpName -> Bool

(<=) :: EpName -> EpName -> Bool

(>) :: EpName -> EpName -> Bool

(>=) :: EpName -> EpName -> Bool

max :: EpName -> EpName -> EpName

min :: EpName -> EpName -> EpName

Show EpName

Defined in Michelson.Untyped.EntryPoints

Methods

showsPrec :: Int -> EpName -> ShowS

show :: EpName -> String

showList :: [EpName] -> ShowS

Generic EpName

Defined in Michelson.Untyped.EntryPoints

Associated Types

type Rep EpName :: Type -> Type

Methods

from :: EpName -> Rep EpName x

to :: Rep EpName x -> EpName

Arbitrary FieldAnn => Arbitrary EpName

Defined in Michelson.Untyped.EntryPoints

Methods

arbitrary :: Gen EpName

shrink :: EpName -> [EpName]

NFData EpName

Defined in Michelson.Untyped.EntryPoints

Methods

rnf :: EpName -> ()

ToJSON EpName

Defined in Michelson.Untyped.EntryPoints

Methods

toJSON :: EpName -> Value

toEncoding :: EpName -> Encoding

toJSONList :: [EpName] -> Value

toEncodingList :: [EpName] -> Encoding

FromJSON EpName

Defined in Michelson.Untyped.EntryPoints

Methods

parseJSON :: Value -> Parser EpName

parseJSONList :: Value -> Parser [EpName]

Default EpName

Defined in Michelson.Untyped.EntryPoints

Methods

def :: EpName

Buildable EpName

Defined in Michelson.Untyped.EntryPoints

Methods

build :: EpName -> Builder

HasCLReader EpName

Defined in Michelson.Untyped.EntryPoints

Methods

getReader :: ReadM EpName

getMetavar :: String

type Rep EpName

Defined in Michelson.Untyped.EntryPoints

type Rep EpName = D1 ('MetaData "EpName" "Michelson.Untyped.EntryPoints" "morley-1.4.0-FPgS4VJ0cLmB07ubDf4i8P" 'True) (C1 ('MetaCons "EpNameUnsafe" 'PrefixI 'True) (S1 ('MetaSel ('Just "unEpName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

pattern DefEpName :: EpName

epNameFromParamAnn :: FieldAnn -> Maybe EpName

Make up EpName from annotation in parameter type declaration.

Returns Nothing if no entrypoint is assigned here.

epNameToParamAnn :: EpName -> FieldAnn

Turn entrypoint name into annotation for contract parameter declaration.

epNameFromRefAnn :: FieldAnn -> Either EpNameFromRefAnnError EpName

Make up EpName from annotation which is reference to an entrypoint (e.g. annotation in CONTRACT instruction).

Fails if annotation is invalid.

epNameToRefAnn :: EpName -> FieldAnn

Turn entrypoint name into annotation used as reference to entrypoint.

data EpNameFromRefAnnError

Constructors

InEpNameBadAnnotation FieldAnn

Instances

Eq EpNameFromRefAnnError

Defined in Michelson.Untyped.EntryPoints

Methods

(==) :: EpNameFromRefAnnError -> EpNameFromRefAnnError -> Bool

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

Show EpNameFromRefAnnError

Defined in Michelson.Untyped.EntryPoints

Methods

showsPrec :: Int -> EpNameFromRefAnnError -> ShowS

show :: EpNameFromRefAnnError -> String

showList :: [EpNameFromRefAnnError] -> ShowS

Generic EpNameFromRefAnnError

Defined in Michelson.Untyped.EntryPoints

Associated Types

type Rep EpNameFromRefAnnError :: Type -> Type

Methods

from :: EpNameFromRefAnnError -> Rep EpNameFromRefAnnError x

to :: Rep EpNameFromRefAnnError x -> EpNameFromRefAnnError

NFData EpNameFromRefAnnError

Defined in Michelson.Untyped.EntryPoints

Methods

rnf :: EpNameFromRefAnnError -> ()

Buildable EpNameFromRefAnnError

Defined in Michelson.Untyped.EntryPoints

Methods

build :: EpNameFromRefAnnError -> Builder

type Rep EpNameFromRefAnnError

Defined in Michelson.Untyped.EntryPoints

type Rep EpNameFromRefAnnError = D1 ('MetaData "EpNameFromRefAnnError" "Michelson.Untyped.EntryPoints" "morley-1.4.0-FPgS4VJ0cLmB07ubDf4i8P" 'False) (C1 ('MetaCons "InEpNameBadAnnotation" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FieldAnn)))