Michelson.Typed.EntryPoints

Utilities for lightweight entrypoints support.

Documentation

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.Typed.EntryPoints

Methods

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

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

Ord EpName

Defined in Michelson.Typed.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.Typed.EntryPoints

Methods

showsPrec :: Int -> EpName -> ShowS

show :: EpName -> String

showList :: [EpName] -> ShowS

Arbitrary FieldAnn => Arbitrary EpName

Defined in Michelson.Typed.EntryPoints

Methods

arbitrary :: Gen EpName

shrink :: EpName -> [EpName]

Default EpName

Defined in Michelson.Typed.EntryPoints

Methods

def :: EpName

Buildable EpName

Defined in Michelson.Typed.EntryPoints

Methods

build :: EpName -> Builder

pattern NoEpName :: 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.Typed.EntryPoints

Methods

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

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

Show EpNameFromRefAnnError

Defined in Michelson.Typed.EntryPoints

Methods

showsPrec :: Int -> EpNameFromRefAnnError -> ShowS

show :: EpNameFromRefAnnError -> String

showList :: [EpNameFromRefAnnError] -> ShowS

Buildable EpNameFromRefAnnError

Defined in Michelson.Typed.EntryPoints

Methods

build :: EpNameFromRefAnnError -> Builder

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

Arbitrary FieldAnn => Arbitrary EpAddress

Defined in Michelson.Typed.EntryPoints

Methods

arbitrary :: Gen EpAddress

shrink :: EpAddress -> [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

IsoCValue EpAddress

Defined in Michelson.Typed.Haskell.Value

Associated Types

type ToCT EpAddress :: CT

Methods

toCVal :: EpAddress -> CValue (ToCT EpAddress)

fromCVal :: CValue (ToCT EpAddress) -> EpAddress

TypeHasDoc EpAddress

Defined in Michelson.Typed.Haskell.Doc

Methods

typeDocName :: Proxy EpAddress -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy EpAddress -> WithinParens -> Markdown

typeDocDependencies :: Proxy EpAddress -> [SomeTypeWithDoc]

typeDocHaskellRep :: TypeDocHaskellRep EpAddress

typeDocMichelsonRep :: TypeDocMichelsonRep EpAddress

ToAddress EpAddress

Defined in Lorentz.Value

Methods

toAddress :: EpAddress -> Address

CompareOpHs EpAddress

Defined in Lorentz.Arith

FromContractRef cp EpAddress

Defined in Lorentz.Value

Methods

fromContractAddr :: ContractRef cp -> EpAddress

NiceParameter cp => ToContractRef cp EpAddress

Defined in Lorentz.Value

Methods

toContractRef :: EpAddress -> ContractRef cp

type ToT EpAddress

Defined in Michelson.Typed.Haskell.Value

type ToT EpAddress = Tc (ToCT EpAddress)

type ToCT EpAddress

Defined in Michelson.Typed.Haskell.Value

type ToCT EpAddress = CAddress

data ParseEpAddressError

Constructors

ParseEpAddressBadAddress ParseAddressError

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

Buildable ParseEpAddressError

Defined in Michelson.Typed.EntryPoints

Methods

build :: ParseEpAddressError -> Builder

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

newtype 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

• unParamNotes :: Notes t

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

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

Buildable ArmCoord

Defined in Michelson.Typed.EntryPoints

Methods

build :: ArmCoord -> Builder

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

Buildable ParamEpError

Defined in Michelson.Typed.EntryPoints

Methods

build :: ParamEpError -> Builder

mkParamNotes :: Notes t -> 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 :: EpLiftSequence arg subparam -> EpLiftSequence arg (TOr subparam r)

EplWrapRight :: 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

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

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

param ~ arg => Default (EntryPointCallT param arg)

Calls the default entrypoint.

Defined in Michelson.Typed.EntryPoints

Methods

def :: EntryPointCallT param arg

Buildable (EntryPointCallT param arg)

Defined in Michelson.Typed.EntryPoints

Methods

build :: EntryPointCallT param arg -> Builder

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

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

ParameterScope arg => Default (SomeEntryPointCallT arg)

Defined in Michelson.Typed.EntryPoints

Methods

def :: SomeEntryPointCallT arg

Buildable (SomeEntryPointCallT arg)

Defined in Michelson.Typed.EntryPoints

Methods

build :: SomeEntryPointCallT arg -> Builder

sepcName :: SomeEntryPointCallT arg -> EpName

mkEntryPointCall :: ParameterScope param => EpName -> (Sing param, Notes param) -> (forall arg. ParameterScope arg => (Notes arg, EntryPointCallT param arg) -> r) -> Maybe r

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, Notes TUnit)

For implicit account, which type its parameter seems to have from outside.