Lorentz.UParam

Documentation

newtype UParam (entries :: [EntrypointKind])

Encapsulates parameter for one of entry points. It keeps entrypoint name and corresponding argument serialized.

In Haskell world, we keep an invariant of that contained value relates to one of entry points from entries list.

Constructors

UnsafeUParam (MText, ByteString)

Instances

SameEntries entries1 entries2 => CanCastTo (UParam entries1 :: Type) (UParam entries2 :: Type)

Allows casts only between UParam_ and UParam.

Defined in Lorentz.UParam

Methods

castDummy :: Proxy (UParam entries1) -> Proxy (UParam entries2) -> ()

Generic (UParam entries)

Defined in Lorentz.UParam

Associated Types

type Rep (UParam entries) :: Type -> Type

Methods

from :: UParam entries -> Rep (UParam entries) x

to :: Rep (UParam entries) x -> UParam entries

Show (UParam entries)

Defined in Lorentz.UParam

Methods

showsPrec :: Int -> UParam entries -> ShowS

show :: UParam entries -> String

showList :: [UParam entries] -> ShowS

Eq (UParam entries)

Defined in Lorentz.UParam

Methods

(==) :: UParam entries -> UParam entries -> Bool

(/=) :: UParam entries -> UParam entries -> Bool

HasAnnotation (UParam entries)

Defined in Lorentz.UParam

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (UParam entries))

annOptions :: Maybe AnnOptions

Unwrappable (UParam entries)

Defined in Lorentz.UParam

Associated Types

type Unwrappabled (UParam entries)

HasRPCRepr (UParam entries)

Defined in Lorentz.UParam

Associated Types

type AsRPC (UParam entries)

Typeable interface => TypeHasDoc (UParam interface)

Defined in Lorentz.UParam

Associated Types

type TypeDocFieldDescriptions (UParam interface) :: FieldDescriptions

Methods

typeDocName :: Proxy (UParam interface) -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy (UParam interface) -> WithinParens -> Markdown

typeDocDependencies :: Proxy (UParam interface) -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep (UParam interface)

typeDocMichelsonRep :: TypeDocMichelsonRep (UParam interface)

IsoValue (UParam entries)

Defined in Lorentz.UParam

Associated Types

type ToT (UParam entries) :: T

Methods

toVal :: UParam entries -> Value (ToT (UParam entries))

fromVal :: Value (ToT (UParam entries)) -> UParam entries

type Rep (UParam entries)

Defined in Lorentz.UParam

type Rep (UParam entries) = D1 ('MetaData "UParam" "Lorentz.UParam" "lorentz-0.16.0-inplace" 'True) (C1 ('MetaCons "UnsafeUParam" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (MText, ByteString))))

type Unwrappabled (UParam entries)

Defined in Lorentz.UParam

type Unwrappabled (UParam entries)

type AsRPC (UParam entries)

Defined in Lorentz.UParam

type AsRPC (UParam entries) = UParam entries

type TypeDocFieldDescriptions (UParam interface)

Defined in Lorentz.UParam

type TypeDocFieldDescriptions (UParam interface) = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

type ToT (UParam entries)

Defined in Lorentz.UParam

type ToT (UParam entries) = GValueType (GRep (UParam entries))

type EntrypointKind = (Symbol, Type)

An entrypoint is described by two types: its name and type of argument.

type (?:) (n :: Symbol) (a :: k) = '(n, a)

A convenient alias for type-level name-something pair.

Construction

mkUParam :: (NicePackedValue a, LookupEntrypoint name entries ~ a, RequireUniqueEntrypoints entries) => Label name -> a -> UParam entries

Construct a UParam safely.

Deconstruction

data ConstrainedSome (c :: Type -> Constraint) where

This type can store any value that satisfies a certain constraint.

Constructors

ConstrainedSome :: c a => a -> ConstrainedSome c

Instances

Show (ConstrainedSome Show)

Defined in Lorentz.UParam

Methods

showsPrec :: Int -> ConstrainedSome Show -> ShowS

show :: ConstrainedSome Show -> String

showList :: [ConstrainedSome Show] -> ShowS

Buildable (ConstrainedSome Buildable)

Defined in Lorentz.UParam

Methods

build :: ConstrainedSome Buildable -> Doc

buildList :: [ConstrainedSome Buildable] -> Doc

class UnpackUParam (c :: Type -> Constraint) entries

This class is needed to implement unpackUParam.

Minimal complete definition

unpackUParam

Instances

UnpackUParam c ('[] :: [EntrypointKind])

Defined in Lorentz.UParam

Methods

unpackUParam :: UParam '[] -> Either EntrypointLookupError (MText, ConstrainedSome c)

(KnownSymbol name, UnpackUParam c entries, NiceUnpackedValue arg, c arg) => UnpackUParam c ((name ?: arg) ': entries)

Defined in Lorentz.UParam

Methods

unpackUParam :: UParam ((name ?: arg) ': entries) -> Either EntrypointLookupError (MText, ConstrainedSome c)

unpackUParam :: UnpackUParam c entries => UParam entries -> Either EntrypointLookupError (MText, ConstrainedSome c)

Turn UParam into a Haskell value. Since we don't know its type in compile time, we have to erase it using ConstrainedSome. The user of this function can require arbitrary constraint to hold (depending on how they want to use the result).

Casting to homomorphic value

type SomeInterface = '['("SomeEntrypoints", Void)]

Pseudo value for UParam type variable.

type UParam_ = UParam SomeInterface

Homomorphic version of UParam, forgets the exact interface.

Pattern-matching

type EntrypointsImpl inp out entries = Rec (CaseClauseU inp out) entries

Implementations of some entry points.

Note that this thing inherits properties of Rec, e.g. you can Data.Vinyl.Core.rappend implementations for two entrypoint sets when assembling scattered parts of a contract.

type UParamFallback inp out = ((MText, ByteString) : inp) :-> out

An action invoked when user-provided entrypoint is not found.

data EntrypointLookupError

Constructors

NoSuchEntrypoint MText

ArgumentUnpackFailed

Instances

Generic EntrypointLookupError

Defined in Lorentz.UParam

Associated Types

type Rep EntrypointLookupError :: Type -> Type

Methods

from :: EntrypointLookupError -> Rep EntrypointLookupError x

to :: Rep EntrypointLookupError x -> EntrypointLookupError

Show EntrypointLookupError

Defined in Lorentz.UParam

Methods

showsPrec :: Int -> EntrypointLookupError -> ShowS

show :: EntrypointLookupError -> String

showList :: [EntrypointLookupError] -> ShowS

Eq EntrypointLookupError

Defined in Lorentz.UParam

Methods

(==) :: EntrypointLookupError -> EntrypointLookupError -> Bool

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

Buildable EntrypointLookupError

Defined in Lorentz.UParam

Methods

build :: EntrypointLookupError -> Doc

buildList :: [EntrypointLookupError] -> Doc

type Rep EntrypointLookupError

Defined in Lorentz.UParam

type Rep EntrypointLookupError = D1 ('MetaData "EntrypointLookupError" "Lorentz.UParam" "lorentz-0.16.0-inplace" 'False) (C1 ('MetaCons "NoSuchEntrypoint" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MText)) :+: C1 ('MetaCons "ArgumentUnpackFailed" 'PrefixI 'False) (U1 :: Type -> Type))

class CaseUParam (entries :: [EntrypointKind])

Make up a "case" over entry points.

Minimal complete definition

unsafeCaseUParam

Instances

CaseUParam ('[] :: [EntrypointKind])

Defined in Lorentz.UParam

Methods

unsafeCaseUParam :: forall (inp :: [Type]) (out :: [Type]). Rec (CaseClauseU inp out) '[] -> UParamFallback inp out -> (UParam '[] ': inp) :-> out

(KnownSymbol name, CaseUParam entries, Typeable entries, NiceUnpackedValue arg) => CaseUParam ((name ?: arg) ': entries)

Defined in Lorentz.UParam

Methods

unsafeCaseUParam :: forall (inp :: [Type]) (out :: [Type]). Rec (CaseClauseU inp out) ((name ?: arg) ': entries) -> UParamFallback inp out -> (UParam ((name ?: arg) ': entries) ': inp) :-> out

caseUParam :: (CaseUParam entries, RequireUniqueEntrypoints entries) => Rec (CaseClauseU inp out) entries -> UParamFallback inp out -> (UParam entries : inp) :-> out

Pattern-match on given UParam entries.

You have to provide all case branches and a fallback action on case when entrypoint is not found.

caseUParamT :: forall entries inp out clauses. (clauses ~ Rec (CaseClauseU inp out) entries, RecFromTuple clauses, CaseUParam entries) => IsoRecTuple clauses -> UParamFallback inp out -> (UParam entries : inp) :-> out

Like caseUParam, but accepts a tuple of clauses, not a Rec.

uparamFallbackFail :: UParamFallback inp out

Default implementation for UParamFallback, simply reports an error.

Constraints

type family LookupEntrypoint (name :: Symbol) (entries :: [EntrypointKind]) :: Type where ...

Get type of entrypoint argument by its name.

Equations

LookupEntrypoint name ('(name, a) ': _) = a

LookupEntrypoint name (_ ': entries) = LookupEntrypoint name entries

LookupEntrypoint name '[] = TypeError (('Text "Entry point " ':<>: 'ShowType name) ':<>: 'Text " in not in the entry points list")

type family RequireUniqueEntrypoints (entries :: [EntrypointKind]) :: Constraint where ...

Ensure that given entry points do no contain duplicated names.

Equations

RequireUniqueEntrypoints entries = RequireAllUnique "entrypoint" (Eval (Map Fst entries))

Conversion from ADT

uparamFromAdt :: UParamLinearize up => up -> UParam (UParamLinearized up)

Make up UParam from ADT sum.

Entry points template will consist of (constructorName, constructorFieldType) pairs. Each constructor is expected to have exactly one field.

Shows human-readable errors when up is stuck.

>>> data Foo = Foo ()
>>> uparamFromAdt $ Foo ()
...
... GHC.Generics.Rep Foo
... is stuck. Likely
... Generic Foo
... instance is missing or out of scope.
...

>>> data Foo = Foo () deriving Generic
>>> uparamFromAdt $ Foo ()
UnsafeUParam (UnsafeMText {unMText = "Foo"},"\ENQ\ETX\v")

type UParamLinearize p = (NiceGeneric p, GUParamLinearize (GRep p))

Constraint required by uparamFromAdt.

type UParamLinearized p = GUParamLinearized (GRep p)

Entry points template derived from given ADT sum.

Documentation

pbsUParam :: forall ctorName. KnownSymbol ctorName => ParamBuildingStep

Note that calling given entrypoints involves constructing UParam.

Internals used for entrypoint-wise migrations

unwrapUParam :: (UParam entries : s) :-> ((MText, ByteString) : s)

Helper instruction which extracts content of UParam.

Orphan instances

CustomErrorHasDoc "uparamArgumentUnpackFailed"

Methods

customErrDocMdCause :: Markdown

customErrDocMdCauseInEntrypoint :: Markdown

customErrClass :: ErrorClass

customErrArgumentSemantics :: Maybe Markdown

CustomErrorHasDoc "uparamNoSuchEntrypoint"

Methods

customErrDocMdCause :: Markdown

customErrDocMdCauseInEntrypoint :: Markdown

customErrClass :: ErrorClass

customErrArgumentSemantics :: Maybe Markdown

Buildable (CustomError "uparamArgumentUnpackFailed")

Methods

build :: CustomError "uparamArgumentUnpackFailed" -> Doc

buildList :: [CustomError "uparamArgumentUnpackFailed"] -> Doc

Buildable (CustomError "uparamNoSuchEntrypoint")

Methods

build :: CustomError "uparamNoSuchEntrypoint" -> Doc

buildList :: [CustomError "uparamNoSuchEntrypoint"] -> Doc