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

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.

Result of entrypoint lookup at term level.

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.

Ensure that all declared entrypoints are unique.

Which entrypoints given parameter declares.

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

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.

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.

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

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

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

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.

Get all entrypoints declared for parameter.

Lookup for entrypoint type by name.

Does not treat default entrypoints in a special way.

Derive annotations for given parameter.

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

Prepare call to given entrypoint.

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

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

Call the default entrypoint.

Ensure that there is no explicit "default" entrypoint.

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

Call root entrypoint safely.

Which entrypoint to call.

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

Constraint on type-level entrypoint name specifier.

Universal entrypoint lookup.

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

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.

HasEntrypointArg constraint specialized to default entrypoint.

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

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.

Universal entrypoint calling.

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