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

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

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 #
Arbitrary FieldAnn => Arbitrary EpName Source #
Instance details Defined in Michelson.Untyped.EntryPoints Methods arbitrary :: Gen EpName # shrink :: EpName -> [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 #

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

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 #
Buildable EpNameFromRefAnnError Source #
Instance details Defined in Michelson.Untyped.EntryPoints Methods build :: EpNameFromRefAnnError -> Builder #