Lorentz.Util.TH

Lorentz template-haskell and quasiquote utilities.

Documentation

entrypointDoc :: QuasiQuoter

QuasiQuote that helps generating ParameterHasEntrypoints instance.

Usage:

[entrypointDoc| Parameter <parameter-type> <optional-root-annotation> |]
[entrypointDoc| Parameter plain |]
[entrypointDoc| Parameter plain "root"|]

See this tutorial which includes this quasiquote.

errorDoc :: QuasiQuoter

Deprecated: errorDoc is deprecated, use errorDocArg with () argument instead

QuasiQuote that helps generating CustomErrorHasDoc instance.

Usage:

[errorDoc| <error-name> <error-type> <error-description> |]
[errorDoc| "errorName" exception "Error description" |]

This is equivalent to errorDocArg with () specified as error argument type.

errorDocArg :: QuasiQuoter

QuasiQuote that helps generating CustomErrorHasDoc instance.

Usage:

[errorDocArg| <error-name> <error-type> <error-description> [<error-arg-type>] |]
[errorDocArg| "errorName" exception "Error description" |]
[errorDocArg| "errorName" contract-internal "Error description" () |]
[errorDocArg| "errorName" bad-argument "Error description" Integer |]

The default argument type is NoErrorArg. Only a type name can be used, if you need complex type, define a type synonym.

See this tutorial which includes this quasiquote.

typeDoc :: QuasiQuoter

QuasiQuote that helps generating TypeHasDoc instance.

Usage:

[typeDoc| <type> <description> |]
[typeDoc| Storage "This is storage description"  |]

See this tutorial which includes this quasiquote.