Lorentz.Entrypoints.Core

Primitives supplying entrypoints declarations and lookup.

Documentation

type family CanHaveEntrypoints (p :: Type) :: Bool where ...

Used to understand whether a type can potentially declare any entrypoints.

Equations

CanHaveEntrypoints (ShouldHaveEntrypoints _) = 'True

CanHaveEntrypoints p = CanHaveEntrypointsT (ToT p)

class EntrypointsDerivation deriv cp where

Defines a generalized way to declare entrypoints for various parameter types.

When defining instances of this typeclass, set concrete deriv argument and leave variable cp argument. Also keep in mind, that in presence of explicit default entrypoint, all other Or arms should be callable, though you can put this burden on user if very necessary.

Methods of this typeclass aim to better type-safety when making up an implementation and they may be not too convenient to use; users should exploit their counterparts.

Associated Types

type EpdAllEntrypoints deriv cp :: [(Symbol, Type)]

Name and argument of each entrypoint. This may include intermediate ones, even root if necessary.

Touching this type family is costly (O(N^2)), don't use it often.

Note [order of entrypoints children]: If this contains entrypoints referring to indermediate nodes (not leaves) in or tree, then each such entrypoint should be mentioned eariler than all of its children.

type EpdLookupEntrypoint deriv cp :: Symbol -> Exp (Maybe Type)

Get entrypoint argument by name.

Methods

epdNotes :: Notes (ToT cp)

Construct parameter annotations corresponding to expected entrypoints set.

This method is implementation detail, for actual notes construction use parameterEntrypointsToNotes.

TODO [#35]: Should also return field annotation

epdCall :: ParameterScope (ToT cp) => Label name -> EpConstructionRes (ToT cp) (Eval (EpdLookupEntrypoint deriv cp name))

Construct entrypoint caller.

This does not treat calls to default entrypoint in a special way.

This method is implementation detail, for actual entrypoint lookup use parameterEntrypointCall.

epdDescs :: Rec EpCallingDesc (EpdAllEntrypoints deriv cp)

Description of how each of the entrypoints is constructed.

Instances

HasAnnotation cp => EntrypointsDerivation EpdNone cp

Defined in Lorentz.Entrypoints.Core

Associated Types

type EpdAllEntrypoints EpdNone cp :: [(Symbol, Type)]

type EpdLookupEntrypoint EpdNone cp :: Symbol -> Exp (Maybe Type)

Methods

epdNotes :: Notes (ToT cp)

epdCall :: forall (name :: Symbol). ParameterScope (ToT cp) => Label name -> EpConstructionRes (ToT cp) (Eval (EpdLookupEntrypoint EpdNone cp name))

epdDescs :: Rec EpCallingDesc (EpdAllEntrypoints EpdNone cp)

PlainEntrypointsC EpdDelegate cp => EntrypointsDerivation EpdDelegate cp

Defined in Lorentz.Entrypoints.Impl

Associated Types

type EpdAllEntrypoints EpdDelegate cp :: [(Symbol, Type)]

type EpdLookupEntrypoint EpdDelegate cp :: Symbol -> Exp (Maybe Type)

Methods

epdNotes :: Notes (ToT cp)

epdCall :: forall (name :: Symbol). ParameterScope (ToT cp) => Label name -> EpConstructionRes (ToT cp) (Eval (EpdLookupEntrypoint EpdDelegate cp name))

epdDescs :: Rec EpCallingDesc (EpdAllEntrypoints EpdDelegate cp)

PlainEntrypointsC EpdRecursive cp => EntrypointsDerivation EpdRecursive cp

Defined in Lorentz.Entrypoints.Impl

Associated Types

type EpdAllEntrypoints EpdRecursive cp :: [(Symbol, Type)]

type EpdLookupEntrypoint EpdRecursive cp :: Symbol -> Exp (Maybe Type)

Methods

epdNotes :: Notes (ToT cp)

epdCall :: forall (name :: Symbol). ParameterScope (ToT cp) => Label name -> EpConstructionRes (ToT cp) (Eval (EpdLookupEntrypoint EpdRecursive cp name))

epdDescs :: Rec EpCallingDesc (EpdAllEntrypoints EpdRecursive cp)

PlainEntrypointsC EpdPlain cp => EntrypointsDerivation EpdPlain cp

Defined in Lorentz.Entrypoints.Impl

Associated Types

type EpdAllEntrypoints EpdPlain cp :: [(Symbol, Type)]

type EpdLookupEntrypoint EpdPlain cp :: Symbol -> Exp (Maybe Type)

Methods

epdNotes :: Notes (ToT cp)

epdCall :: forall (name :: Symbol). ParameterScope (ToT cp) => Label name -> EpConstructionRes (ToT cp) (Eval (EpdLookupEntrypoint EpdPlain cp name))

epdDescs :: Rec EpCallingDesc (EpdAllEntrypoints EpdPlain cp)

data EpConstructionRes (param :: T) (marg :: Maybe Type) where

Result of entrypoint lookup at term level.

Constructors

EpConstructed :: ParameterScope (ToT arg) => EpLiftSequence (ToT arg) param -> EpConstructionRes param ('Just arg)

EpConstructionFailed :: EpConstructionRes param 'Nothing

data EpCallingDesc (info :: (Symbol, Type)) where

How one of the entrypoints is called.

Type arguments are name of the constructor which eventually gave name to the entrypoint and this entrypoint's argument.

Constructors

EpCallingDesc

Fields

• :: { epcdArg :: Proxy (arg :: Type)

  Entrypoint argument type.

•    , epcdEntrypoint :: EpName

  Name of assigned entrypoint.

•    , epcdSteps :: [EpCallingStep]

  If we emulated entrypoints calling via just wrapping an argument into constructors until getting the full parameter, how would it look like. Steps are enlisted in reversed order - top-level constructors go last.

•    } -> EpCallingDesc '(name, arg)

Instances

Show (EpCallingDesc info)

Defined in Lorentz.Entrypoints.Core

Methods

showsPrec :: Int -> EpCallingDesc info -> ShowS

show :: EpCallingDesc info -> String

showList :: [EpCallingDesc info] -> ShowS

data EpCallingStep

Constructors

EpsWrapIn Text

Wrap into constructor with given name.

Instances

Eq EpCallingStep

Defined in Lorentz.Entrypoints.Core

Methods

(==) :: EpCallingStep -> EpCallingStep -> Bool

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

Show EpCallingStep

Defined in Lorentz.Entrypoints.Core

Methods

showsPrec :: Int -> EpCallingStep -> ShowS

show :: EpCallingStep -> String

showList :: [EpCallingStep] -> ShowS

type RequireAllUniqueEntrypoints cp = RequireAllUniqueEntrypoints' (ParameterEntrypointsDerivation cp) cp

Ensure that all declared entrypoints are unique.

class (EntrypointsDerivation (ParameterEntrypointsDerivation cp) cp, RequireAllUniqueEntrypoints cp) => ParameterHasEntrypoints cp

Which entrypoints given parameter declares.

Note that usually this function should not be used as constraint, use ParameterDeclaresEntrypoints for this purpose.

Associated Types

type ParameterEntrypointsDerivation cp :: Type

Instances

(NiceParameter cp, EntrypointsDerivation epd cp, RequireAllUniqueEntrypoints' epd cp) => ParameterHasEntrypoints (ParameterWrapper epd cp)

Defined in Lorentz.Entrypoints.Manual

Associated Types

type ParameterEntrypointsDerivation (ParameterWrapper epd cp)

type ParameterDeclaresEntrypoints cp = (If (CanHaveEntrypoints cp) (ParameterHasEntrypoints cp) (() :: Constraint), NiceParameter cp, EntrypointsDerivation (GetParameterEpDerivation cp) cp)

Parameter declares some entrypoints.

This is a version of ParameterHasEntrypoints which we actually use in constraints. When given type is a sum type or newtype, we refer to ParameterHasEntrypoints instance, otherwise this instance is not necessary.

type GetParameterEpDerivation cp = If (CanHaveEntrypoints cp) (ParameterEntrypointsDerivation cp) EpdNone

Version of ParameterEntrypointsDerivation which we actually use in function signatures. When given type is sum type or newtype, we refer to ParameterEntrypointsDerivation, otherwise we suppose that no entrypoints are declared.

pepNotes :: forall cp. ParameterDeclaresEntrypoints cp => Notes (ToT cp)

Version of epdNotes which we actually use in code. It hides derivations stuff inside, and treats primitive types specially like GetParameterEpDerivation does.

pepCall :: forall cp name. (ParameterDeclaresEntrypoints cp, ParameterScope (ToT cp)) => Label name -> EpConstructionRes (ToT cp) (Eval (LookupParameterEntrypoint cp name))

Version of epdCall which we actually use in code. It hides derivations stuff inside, and treats primitive types specially like GetParameterEpDerivation does.

pepDescs :: forall cp. ParameterDeclaresEntrypoints cp => Rec EpCallingDesc (AllParameterEntrypoints cp)

Version of epdDescs which we actually use in code. It hides derivations stuff inside, and treats primitive types specially like GetParameterEpDerivation does.

pepDescsWithDef :: forall cp. ParameterDeclaresEntrypoints cp => [Some1 EpCallingDesc]

Descriptions of how each of the entrypoints is constructed.

Similar to pepDescs, but includes default entrypoint disregard whether it is explicit or not, while pepDescs includes it only if it is explicit. Also this returns list, not Rec, for simplicity.

Note that [order of entrypoints children] property still holds here.

type family AllParameterEntrypoints (cp :: Type) :: [(Symbol, Type)] where ...

Get all entrypoints declared for parameter.

Equations

AllParameterEntrypoints cp = EpdAllEntrypoints (GetParameterEpDerivation cp) cp

type family LookupParameterEntrypoint (cp :: Type) :: Symbol -> Exp (Maybe Type) where ...

Lookup for entrypoint type by name.

Does not treat default entrypoints in a special way.

Equations

LookupParameterEntrypoint cp = EpdLookupEntrypoint (GetParameterEpDerivation cp) cp

parameterEntrypointsToNotes :: forall cp. ParameterDeclaresEntrypoints cp => ParamNotes (ToT cp)

Derive annotations for given parameter.

type GetEntrypointArg cp name = Eval (LiftM2 FromMaybe (TError (('Text "Entrypoint not found: " :<>: 'ShowType name) :$$: (('Text "In contract parameter `" :<>: 'ShowType cp) :<>: 'Text "`"))) (LookupParameterEntrypoint cp name))

Get type of entrypoint with given name, fail if not found.

parameterEntrypointCall :: forall cp name. ParameterDeclaresEntrypoints cp => Label name -> EntrypointCall cp (GetEntrypointArg cp name)

Prepare call to given entrypoint.

This does not treat calls to default entrypoint in a special way. To call default entrypoint properly use parameterEntrypointCallDefault.

type GetDefaultEntrypointArg cp = Eval (LiftM2 FromMaybe (Pure cp) (LookupParameterEntrypoint cp DefaultEpName))

Get type of entrypoint with given name, fail if not found.

parameterEntrypointCallDefault :: forall cp. ParameterDeclaresEntrypoints cp => EntrypointCall cp (GetDefaultEntrypointArg cp)

Call the default entrypoint.

type ForbidExplicitDefaultEntrypoint cp = Eval (LiftM3 UnMaybe (Pure (Pure (() :: Constraint))) (TError ('Text "Parameter used here must have no explicit \"default\" entrypoint" :$$: (('Text "In parameter type `" :<>: 'ShowType cp) :<>: 'Text "`"))) (LookupParameterEntrypoint cp DefaultEpName))

Ensure that there is no explicit "default" entrypoint.

type NoExplicitDefaultEntrypoint cp = Eval (LookupParameterEntrypoint cp DefaultEpName) ~ 'Nothing

Similar to ForbidExplicitDefaultEntrypoint, but in a version which the compiler can work with (and which produces errors confusing for users :/)

sepcCallRootChecked :: forall cp. (NiceParameter cp, ForbidExplicitDefaultEntrypoint cp) => SomeEntrypointCall cp

Call root entrypoint safely.

data EntrypointRef (mname :: Maybe Symbol) where

Which entrypoint to call.

We intentionally distinguish default and non-default cases because this makes API more details-agnostic.

Constructors

CallDefault :: EntrypointRef 'Nothing

Call the default entrypoint, or root if no explicit default is assigned.

Call :: NiceEntrypointName name => EntrypointRef ('Just name)

Call the given entrypoint; calling default is not treated specially. You have to provide entrypoint name via passing it as type argument.

Unfortunatelly, here we cannot accept a label because in most cases our entrypoints begin from capital letter (being derived from constructor name), while labels must start from a lower-case letter, and there is no way to make a conversion at type-level.

Instances

(GetEntrypointArgCustom cp mname ~ arg, ParameterDeclaresEntrypoints cp) => HasEntrypointArg (cp :: Type) (EntrypointRef mname) arg

Defined in Lorentz.Entrypoints.Core

Methods

useHasEntrypointArg :: EntrypointRef mname -> (Dict (ParameterScope (ToT arg)), EpName)

type NiceEntrypointName name = (KnownSymbol name, ForbidDefaultName name)

Constraint on type-level entrypoint name specifier.

eprName :: forall mname. EntrypointRef mname -> EpName

type family GetEntrypointArgCustom cp mname :: Type where ...

Universal entrypoint lookup.

Equations

GetEntrypointArgCustom cp 'Nothing = GetDefaultEntrypointArg cp

GetEntrypointArgCustom cp ('Just name) = GetEntrypointArg cp name

newtype TrustEpName

This wrapper allows to pass untyped EpName and bypass checking that entrypoint with given name and type exists.

Constructors

TrustEpName EpName

Instances

NiceParameter arg => HasEntrypointArg (cp :: k) TrustEpName arg

Defined in Lorentz.Entrypoints.Core

Methods

useHasEntrypointArg :: TrustEpName -> (Dict (ParameterScope (ToT arg)), EpName)

class HasEntrypointArg cp name arg where

When we call a Lorentz contract we should pass entrypoint name and corresponding argument. Ideally we want to statically check that parameter has entrypoint with given name and argument. Constraint defined by this type class holds for contract with parameter cp that have entrypoint matching name with type arg.

In order to check this property statically, we need to know entrypoint name in compile time, EntrypointRef type serves this purpose. If entrypoint name is not known, one can use TrustEpName wrapper to take responsibility for presence of this entrypoint.

If you want to call a function which has this constraint, you have two options: 1. Pass contract parameter cp using type application, pass EntrypointRef as a value and pass entrypoint argument. Type system will check that cp has an entrypoint with given reference and type. 2. Pass EpName wrapped into TrustEpName and entrypoint argument. In this case passing contract parameter is not necessary, you do not even have to know it.

Methods

useHasEntrypointArg :: name -> (Dict (ParameterScope (ToT arg)), EpName)

Data returned by this method may look somewhat arbitrary. EpName is obviously needed because name can be EntrypointRef or TrustEpName. Dict is returned because in EntrypointRef case we get this evidence for free and don't want to use it. We seem to always need it anyway.

Instances

NiceParameter arg => HasEntrypointArg (cp :: k) TrustEpName arg

Defined in Lorentz.Entrypoints.Core

Methods

useHasEntrypointArg :: TrustEpName -> (Dict (ParameterScope (ToT arg)), EpName)

(GetEntrypointArgCustom cp mname ~ arg, ParameterDeclaresEntrypoints cp) => HasEntrypointArg (cp :: Type) (EntrypointRef mname) arg

Defined in Lorentz.Entrypoints.Core

Methods

useHasEntrypointArg :: EntrypointRef mname -> (Dict (ParameterScope (ToT arg)), EpName)

type HasDefEntrypointArg cp defEpName defArg = (defEpName ~ EntrypointRef 'Nothing, HasEntrypointArg cp defEpName defArg)

HasEntrypointArg constraint specialized to default entrypoint.

type HasEntrypointOfType param con exp = (GetEntrypointArgCustom param ('Just con) ~ exp, ParameterDeclaresEntrypoints param)

Checks that the given parameter consists of some specific entrypoint. Similar as HasEntrypointArg but ensures that the argument matches the following datatype.

type family ParameterContainsEntrypoints param (fields :: [NamedEp]) :: Constraint where ...

Check that the given entrypoint has some fields inside. This interface allows for an abstraction of contract parameter so that it requires some *minimal* specification, but not a concrete one.

Equations

ParameterContainsEntrypoints _ '[] = ()

ParameterContainsEntrypoints param ((n :> ty) ': rest) = (HasEntrypointOfType param n ty, ParameterContainsEntrypoints param rest)

parameterEntrypointCallCustom :: forall cp mname. ParameterDeclaresEntrypoints cp => EntrypointRef mname -> EntrypointCall cp (GetEntrypointArgCustom cp mname)

Universal entrypoint calling.

data EpdNone

No entrypoints declared, parameter type will serve as argument type of the only existing entrypoint (default one).

Instances

HasAnnotation cp => EntrypointsDerivation EpdNone cp

Defined in Lorentz.Entrypoints.Core

Associated Types

type EpdAllEntrypoints EpdNone cp :: [(Symbol, Type)]

type EpdLookupEntrypoint EpdNone cp :: Symbol -> Exp (Maybe Type)

Methods

epdNotes :: Notes (ToT cp)

epdCall :: forall (name :: Symbol). ParameterScope (ToT cp) => Label name -> EpConstructionRes (ToT cp) (Eval (EpdLookupEntrypoint EpdNone cp name))

epdDescs :: Rec EpCallingDesc (EpdAllEntrypoints EpdNone cp)

type EpdAllEntrypoints EpdNone cp

Defined in Lorentz.Entrypoints.Core

type EpdAllEntrypoints EpdNone cp = '[] :: [(Symbol, Type)]

type EpdLookupEntrypoint EpdNone cp

Defined in Lorentz.Entrypoints.Core

type EpdLookupEntrypoint EpdNone cp = ConstFn ('Nothing :: Maybe Type) :: Symbol -> Maybe Type -> Type

type (:>) n ty = 'NamedEp n ty infixr 0

Internals

type RequireAllUniqueEntrypoints' deriv cp = RequireAllUnique "entrypoint name" (Eval (Map Fst $ EpdAllEntrypoints deriv cp))