Safe Haskell	None
Language	Haskell2010

Michelson.Typed.EntryPoints

Contents

Re-exports

Description

Utilities for lightweight entrypoints support.

Synopsis

data EpAddress = EpAddress {
- eaAddress :: Address
- eaEntryPoint :: EpName
}
data ParseEpAddressError
- = ParseEpAddressBadAddress ParseAddressError
- | ParseEpAddressBadRefAnn Text
- | ParseEpAddressRefAnnError EpNameFromRefAnnError
formatEpAddress :: EpAddress -> Text
mformatEpAddress :: EpAddress -> MText
parseEpAddress :: Text -> Either ParseEpAddressError EpAddress
unsafeParseEpAddress :: HasCallStack => Text -> EpAddress
newtype ParamNotes (t :: T) = ParamNotesUnsafe {
- unParamNotes :: Notes t
}
pattern ParamNotes :: Notes t -> ParamNotes t
data ArmCoord
- = AcLeft
- | AcRight
type ArmCoords = [ArmCoord]
data ParamEpError
- = ParamEpDuplicatedNames (NonEmpty EpName)
- | ParamEpUncallableArm ArmCoords
mkParamNotes :: Notes t -> Either ParamEpError (ParamNotes t)
data EpLiftSequence (arg :: T) (param :: T) where
- EplArgHere :: EpLiftSequence arg arg
- EplWrapLeft :: EpLiftSequence arg subparam -> EpLiftSequence arg (TOr subparam r)
- EplWrapRight :: EpLiftSequence arg subparam -> EpLiftSequence arg (TOr l subparam)
data EntryPointCallT (param :: T) (arg :: T) = ParameterScope arg => EntryPointCall {
- epcName :: EpName
- epcParamProxy :: Proxy param
- epcLiftSequence :: EpLiftSequence arg param
}
epcPrimitive :: forall p. (ParameterScope p, ForbidOr p) => EntryPointCallT p p
epcCallRootUnsafe :: ParameterScope param => EntryPointCallT param param
data SomeEntryPointCallT (arg :: T) = ParameterScope param => SomeEpc (EntryPointCallT param arg)
sepcCallRootUnsafe :: ParameterScope param => SomeEntryPointCallT param
sepcPrimitive :: forall t. (ParameterScope t, ForbidOr t) => SomeEntryPointCallT t
sepcName :: SomeEntryPointCallT arg -> EpName
type family ForbidOr (t :: T) :: Constraint where ...
data MkEntryPointCallRes param where
- MkEntryPointCallRes :: ParameterScope arg => Notes arg -> EntryPointCallT param arg -> MkEntryPointCallRes param
mkEntryPointCall :: ParameterScope param => EpName -> (Sing param, ParamNotes param) -> Maybe (MkEntryPointCallRes param)
tyImplicitAccountParam :: (Sing TUnit, ParamNotes TUnit)
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

data EpAddress Source #

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 Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods (==) :: EpAddress -> EpAddress -> Bool # (/=) :: EpAddress -> EpAddress -> Bool #
Ord EpAddress Source #
Instance details 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 Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods showsPrec :: Int -> EpAddress -> ShowS # show :: EpAddress -> String # showList :: [EpAddress] -> ShowS #
Arbitrary FieldAnn => Arbitrary EpAddress Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods arbitrary :: Gen EpAddress # shrink :: EpAddress -> [EpAddress] #
Buildable EpAddress Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods build :: EpAddress -> Builder #
IsoValue EpAddress Source #
Instance details Defined in Michelson.Typed.Haskell.Value Associated Types type ToT EpAddress :: T Source # Methods toVal :: EpAddress -> Value (ToT EpAddress) Source # fromVal :: Value (ToT EpAddress) -> EpAddress Source #
IsoCValue EpAddress Source #
Instance details Defined in Michelson.Typed.Haskell.Value Associated Types type ToCT EpAddress :: CT Source # Methods toCVal :: EpAddress -> CValue (ToCT EpAddress) Source # fromCVal :: CValue (ToCT EpAddress) -> EpAddress Source #
TypeHasDoc EpAddress Source #
Instance details Defined in Michelson.Typed.Haskell.Doc Methods typeDocName :: Proxy EpAddress -> Text Source # typeDocMdDescription :: Markdown Source # typeDocMdReference :: Proxy EpAddress -> WithinParens -> Markdown Source # typeDocDependencies :: Proxy EpAddress -> [SomeTypeWithDoc] Source # typeDocHaskellRep :: TypeDocHaskellRep EpAddress Source # typeDocMichelsonRep :: TypeDocMichelsonRep EpAddress Source #
type ToT EpAddress Source #
Instance details Defined in Michelson.Typed.Haskell.Value type ToT EpAddress = Tc (ToCT EpAddress)
type ToCT EpAddress Source #
Instance details Defined in Michelson.Typed.Haskell.Value type ToCT EpAddress = CAddress

data ParseEpAddressError Source #

Constructors

ParseEpAddressBadAddress ParseAddressError
ParseEpAddressBadRefAnn Text
ParseEpAddressRefAnnError EpNameFromRefAnnError

Instances

Eq ParseEpAddressError Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods (==) :: ParseEpAddressError -> ParseEpAddressError -> Bool # (/=) :: ParseEpAddressError -> ParseEpAddressError -> Bool #
Show ParseEpAddressError Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods showsPrec :: Int -> ParseEpAddressError -> ShowS # show :: ParseEpAddressError -> String # showList :: [ParseEpAddressError] -> ShowS #
Buildable ParseEpAddressError Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods build :: ParseEpAddressError -> Builder #

formatEpAddress :: EpAddress -> Text Source #

mformatEpAddress :: EpAddress -> MText Source #

parseEpAddress :: Text -> Either ParseEpAddressError EpAddress Source #

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

unsafeParseEpAddress :: HasCallStack => Text -> EpAddress Source #

newtype ParamNotes (t :: T) Source #

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 unParamNotes :: Notes t

Instances

Eq (ParamNotes t) Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods (==) :: ParamNotes t -> ParamNotes t -> Bool # (/=) :: ParamNotes t -> ParamNotes t -> Bool #
Show (ParamNotes t) Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods showsPrec :: Int -> ParamNotes t -> ShowS # show :: ParamNotes t -> String # showList :: [ParamNotes t] -> ShowS #

pattern ParamNotes :: Notes t -> ParamNotes t Source #

data ArmCoord Source #

Constructors

AcLeft
AcRight

Instances

Eq ArmCoord Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods (==) :: ArmCoord -> ArmCoord -> Bool # (/=) :: ArmCoord -> ArmCoord -> Bool #
Show ArmCoord Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods showsPrec :: Int -> ArmCoord -> ShowS # show :: ArmCoord -> String # showList :: [ArmCoord] -> ShowS #
Buildable ArmCoord Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods build :: ArmCoord -> Builder #

type ArmCoords = [ArmCoord] Source #

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

data ParamEpError Source #

Errors specific to parameter type declaration (entrypoints).

Constructors

ParamEpDuplicatedNames (NonEmpty EpName)
ParamEpUncallableArm ArmCoords

Instances

Eq ParamEpError Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods (==) :: ParamEpError -> ParamEpError -> Bool # (/=) :: ParamEpError -> ParamEpError -> Bool #
Show ParamEpError Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods showsPrec :: Int -> ParamEpError -> ShowS # show :: ParamEpError -> String # showList :: [ParamEpError] -> ShowS #
Buildable ParamEpError Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods build :: ParamEpError -> Builder #

mkParamNotes :: Notes t -> Either ParamEpError (ParamNotes t) Source #

Construct ParamNotes performing all necessary checks.

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

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 :: EpLiftSequence arg subparam -> EpLiftSequence arg (TOr subparam r)
EplWrapRight :: EpLiftSequence arg subparam -> EpLiftSequence arg (TOr l subparam)

Instances

Eq (EpLiftSequence arg param) Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods (==) :: EpLiftSequence arg param -> EpLiftSequence arg param -> Bool # (/=) :: EpLiftSequence arg param -> EpLiftSequence arg param -> Bool #
Show (EpLiftSequence arg param) Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods showsPrec :: Int -> EpLiftSequence arg param -> ShowS # show :: EpLiftSequence arg param -> String # showList :: [EpLiftSequence arg param] -> ShowS #
Buildable (EpLiftSequence arg param) Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods build :: EpLiftSequence arg param -> Builder #

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

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) Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods (==) :: EntryPointCallT param arg -> EntryPointCallT param arg -> Bool # (/=) :: EntryPointCallT param arg -> EntryPointCallT param arg -> Bool #
Show (EntryPointCallT param arg) Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods showsPrec :: Int -> EntryPointCallT param arg -> ShowS # show :: EntryPointCallT param arg -> String # showList :: [EntryPointCallT param arg] -> ShowS #
Buildable (EntryPointCallT param arg) Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods build :: EntryPointCallT param arg -> Builder #

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

Call parameter which has no entrypoints, always safe.

epcCallRootUnsafe :: ParameterScope param => EntryPointCallT param param Source #

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

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

ParameterScope param => SomeEpc (EntryPointCallT param arg)

Instances

Eq (SomeEntryPointCallT arg) Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods (==) :: SomeEntryPointCallT arg -> SomeEntryPointCallT arg -> Bool # (/=) :: SomeEntryPointCallT arg -> SomeEntryPointCallT arg -> Bool #
Show (SomeEntryPointCallT arg) Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods showsPrec :: Int -> SomeEntryPointCallT arg -> ShowS # show :: SomeEntryPointCallT arg -> String # showList :: [SomeEntryPointCallT arg] -> ShowS #
Buildable (SomeEntryPointCallT arg) Source #
Instance details Defined in Michelson.Typed.EntryPoints Methods build :: SomeEntryPointCallT arg -> Builder #

sepcCallRootUnsafe :: ParameterScope param => SomeEntryPointCallT param Source #

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

Call parameter which has no entrypoints, always safe.

sepcName :: SomeEntryPointCallT arg -> EpName Source #

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

Equations

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

data MkEntryPointCallRes param where Source #

Constructors

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

mkEntryPointCall :: ParameterScope param => EpName -> (Sing param, ParamNotes param) -> Maybe (MkEntryPointCallRes param) Source #

Build EntryPointCallT.

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

Returns Nothing if entrypoint is not found.

tyImplicitAccountParam :: (Sing TUnit, ParamNotes TUnit) Source #

Parameter type of implicit account.

Re-exports

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 #