Safe Haskell	None
Language	Haskell2010

Michelson.Untyped.EntryPoints

Synopsis

newtype EpName = EpNameUnsafe {
- unEpName :: Text
}
pattern DefEpName :: EpName
epNameFromParamAnn :: FieldAnn -> Maybe EpName
epNameToParamAnn :: EpName -> FieldAnn
epNameFromRefAnn :: FieldAnn -> Either EpNameFromRefAnnError EpName
epNameToRefAnn :: EpName -> FieldAnn
data EpNameFromRefAnnError = InEpNameBadAnnotation FieldAnn
buildEpName :: Text -> Either String EpName
unsafeBuildEpName :: Text -> EpName
mkEntrypointsMap :: Type -> Map EpName Type

Documentation

newtype EpName Source #

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

Instances details

Eq EpName Source #
Instance details Defined in Michelson.Untyped.EntryPoints Methods (==) :: EpName -> EpName -> Bool # (/=) :: EpName -> EpName -> Bool #
Ord EpName Source #
Instance details 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 Source #
Instance details Defined in Michelson.Untyped.EntryPoints Methods showsPrec :: Int -> EpName -> ShowS # show :: EpName -> String # showList :: [EpName] -> ShowS #
Generic EpName Source #
Instance details 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 Source #
Instance details Defined in Michelson.Untyped.EntryPoints Methods arbitrary :: Gen EpName # shrink :: EpName -> [EpName] #
NFData EpName Source #
Instance details Defined in Michelson.Untyped.EntryPoints Methods rnf :: EpName -> () #
ToJSON EpName Source #
Instance details Defined in Michelson.Untyped.EntryPoints Methods toJSON :: EpName -> Value # toEncoding :: EpName -> Encoding # toJSONList :: [EpName] -> Value # toEncodingList :: [EpName] -> Encoding #
FromJSON EpName Source #
Instance details Defined in Michelson.Untyped.EntryPoints Methods parseJSON :: Value -> Parser EpName # parseJSONList :: Value -> Parser [EpName] #
Default EpName Source #
Instance details Defined in Michelson.Untyped.EntryPoints Methods def :: EpName #
Buildable EpName Source #
Instance details Defined in Michelson.Untyped.EntryPoints Methods build :: EpName -> Builder #
HasCLReader EpName Source #
Instance details Defined in Michelson.Untyped.EntryPoints Methods getReader :: ReadM EpName Source # getMetavar :: String Source #
type Rep EpName Source #
Instance details 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 Source #

epNameFromParamAnn :: FieldAnn -> Maybe EpName Source #

Make up EpName from annotation in parameter type declaration.

Returns Nothing if no entrypoint is assigned here.

epNameToParamAnn :: EpName -> FieldAnn Source #

Turn entrypoint name into annotation for contract parameter declaration.

epNameFromRefAnn :: FieldAnn -> Either EpNameFromRefAnnError EpName Source #

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 Source #

Turn entrypoint name into annotation used as reference to entrypoint.

data EpNameFromRefAnnError Source #

Constructors

InEpNameBadAnnotation FieldAnn

Instances

Instances details

Eq EpNameFromRefAnnError Source #
Instance details Defined in Michelson.Untyped.EntryPoints Methods (==) :: EpNameFromRefAnnError -> EpNameFromRefAnnError -> Bool # (/=) :: EpNameFromRefAnnError -> EpNameFromRefAnnError -> Bool #
Show EpNameFromRefAnnError Source #
Instance details Defined in Michelson.Untyped.EntryPoints Methods showsPrec :: Int -> EpNameFromRefAnnError -> ShowS # show :: EpNameFromRefAnnError -> String # showList :: [EpNameFromRefAnnError] -> ShowS #
Generic EpNameFromRefAnnError Source #
Instance details 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 Source #
Instance details Defined in Michelson.Untyped.EntryPoints Methods rnf :: EpNameFromRefAnnError -> () #
Buildable EpNameFromRefAnnError Source #
Instance details Defined in Michelson.Untyped.EntryPoints Methods build :: EpNameFromRefAnnError -> Builder #
type Rep EpNameFromRefAnnError Source #
Instance details 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)))

buildEpName :: Text -> Either String EpName Source #

unsafeBuildEpName :: Text -> EpName Source #

mkEntrypointsMap :: Type -> Map EpName Type Source #

Given an untyped type, extract a map that maps entrypoint names to the their parameter types. If there are duplicate entrypoints in the given Type then the duplicate entrypoints at a deeper nesting level will get overwritten with the ones that are on top.