Lorentz.UStore.Types

UStore definition and common type-level stuff.

UStore and related type definitions

newtype UStore (a :: Type)

Gathers multple fields and BigMaps under one object.

Type argument of this datatype stands for a "store template" - a datatype with one constructor and multiple fields, each containing an object of type UStoreField or |~> and corresponding to single virtual field or BigMap respectively. It's also possible to parameterize it with a larger type which is a product of types satisfying the above property.

Constructors

UStore

Fields

• unUStore :: BigMap ByteString ByteString

Instances

HasUField fname ftype templ => StoreHasField (UStore templ) (fname :: Symbol) ftype

Defined in Lorentz.UStore.Instances

Methods

storeFieldOps :: StoreFieldOps (UStore templ) fname ftype

HasUStore mname key value templ => StoreHasSubmap (UStore templ) (mname :: Symbol) key value

Defined in Lorentz.UStore.Instances

Methods

storeSubmapOps :: StoreSubmapOps (UStore templ) mname key value

Eq (UStore a)

Defined in Lorentz.UStore.Types

Methods

(==) :: UStore a -> UStore a -> Bool

(/=) :: UStore a -> UStore a -> Bool

Show (UStore a)

Defined in Lorentz.UStore.Types

Methods

showsPrec :: Int -> UStore a -> ShowS

show :: UStore a -> String

showList :: [UStore a] -> ShowS

Generic (UStore a)

Defined in Lorentz.UStore.Types

Associated Types

type Rep (UStore a) :: Type -> Type

Methods

from :: UStore a -> Rep (UStore a) x

to :: Rep (UStore a) x -> UStore a

Semigroup (UStore a)

Defined in Lorentz.UStore.Types

Methods

(<>) :: UStore a -> UStore a -> UStore a

sconcat :: NonEmpty (UStore a) -> UStore a

stimes :: Integral b => b -> UStore a -> UStore a

Monoid (UStore a)

Defined in Lorentz.UStore.Types

Methods

mempty :: UStore a

mappend :: UStore a -> UStore a -> UStore a

mconcat :: [UStore a] -> UStore a

Default (UStore a)

Defined in Lorentz.UStore.Types

Methods

def :: UStore a

Wrappable (UStore a)

Defined in Lorentz.UStore.Types

Associated Types

type Unwrappable (UStore a)

MemOpHs (UStore a)

Defined in Lorentz.UStore.Types

Associated Types

type MemOpKeyHs (UStore a)

UpdOpHs (UStore a)

Defined in Lorentz.UStore.Types

Associated Types

type UpdOpKeyHs (UStore a)

type UpdOpParamsHs (UStore a)

GetOpHs (UStore a)

Defined in Lorentz.UStore.Types

Associated Types

type GetOpKeyHs (UStore a)

type GetOpValHs (UStore a)

HasAnnotation (UStore a)

Defined in Lorentz.UStore.Types

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (UStore a))

annOptions :: AnnOptions

IsoValue (UStore a)

Defined in Lorentz.UStore.Types

Associated Types

type ToT (UStore a) :: T

Methods

toVal :: UStore a -> Value (ToT (UStore a))

fromVal :: Value (ToT (UStore a)) -> UStore a

UStoreTemplateHasDoc template => TypeHasDoc (UStore template)

Defined in Lorentz.UStore.Doc

Associated Types

type TypeDocFieldDescriptions (UStore template) :: FieldDescriptions

Methods

typeDocName :: Proxy (UStore template) -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy (UStore template) -> WithinParens -> Markdown

typeDocDependencies :: Proxy (UStore template) -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep (UStore template)

typeDocMichelsonRep :: TypeDocMichelsonRep (UStore template)

CastableUStoreTemplate template1 template2 => CanCastTo (UStore template1 :: Type) (UStore template2 :: Type)

We allow casting between UStore_ and UStore freely.

Defined in Lorentz.UStore.Migration.Base

Methods

castDummy :: Proxy (UStore template1) -> Proxy (UStore template2) -> ()

type Rep (UStore a)

Defined in Lorentz.UStore.Types

type Rep (UStore a) = D1 ('MetaData "UStore" "Lorentz.UStore.Types" "morley-upgradeable-0.3-inplace" 'True) (C1 ('MetaCons "UStore" 'PrefixI 'True) (S1 ('MetaSel ('Just "unUStore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (BigMap ByteString ByteString))))

type Unwrappable (UStore a)

Defined in Lorentz.UStore.Types

type Unwrappable (UStore a) = GUnwrappable (Rep (UStore a))

type MemOpKeyHs (UStore a)

Defined in Lorentz.UStore.Types

type MemOpKeyHs (UStore a) = MemOpKeyHs (BigMap ByteString ByteString)

type UpdOpParamsHs (UStore a)

Defined in Lorentz.UStore.Types

type UpdOpParamsHs (UStore a) = UpdOpParamsHs (BigMap ByteString ByteString)

type UpdOpKeyHs (UStore a)

Defined in Lorentz.UStore.Types

type UpdOpKeyHs (UStore a) = UpdOpKeyHs (BigMap ByteString ByteString)

type GetOpValHs (UStore a)

Defined in Lorentz.UStore.Types

type GetOpValHs (UStore a) = GetOpValHs (BigMap ByteString ByteString)

type GetOpKeyHs (UStore a)

Defined in Lorentz.UStore.Types

type GetOpKeyHs (UStore a) = GetOpKeyHs (BigMap ByteString ByteString)

type ToT (UStore a)

Defined in Lorentz.UStore.Types

type ToT (UStore a) = ToT (BigMap ByteString ByteString)

type TypeDocFieldDescriptions (UStore template)

Defined in Lorentz.UStore.Doc

type TypeDocFieldDescriptions (UStore template) = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

newtype k |~> v

Describes one virtual big map in the storage.

Constructors

UStoreSubMap

Fields

• unUStoreSubMap :: Map k v

Instances

(CanCastTo k1 k2, CanCastTo v1 v2) => CanCastTo (k1 |~> v1 :: Type) (k2 |~> v2 :: Type)

Defined in Lorentz.UStore.Types

Methods

castDummy :: Proxy (k1 |~> v1) -> Proxy (k2 |~> v2) -> ()

(Eq k, Eq v) => Eq (k |~> v)

Defined in Lorentz.UStore.Types

Methods

(==) :: (k |~> v) -> (k |~> v) -> Bool

(/=) :: (k |~> v) -> (k |~> v) -> Bool

(Show k, Show v) => Show (k |~> v)

Defined in Lorentz.UStore.Types

Methods

showsPrec :: Int -> (k |~> v) -> ShowS

show :: (k |~> v) -> String

showList :: [k |~> v] -> ShowS

Default (k |~> v)

Defined in Lorentz.UStore.Types

Methods

def :: k |~> v

newtype UStoreFieldExt (m :: UStoreMarkerType) (v :: Type)

Describes plain field in the storage.

Constructors

UStoreField

Fields

• unUStoreField :: v

Instances

(m1 ~ m2, CanCastTo a1 a2) => CanCastTo (UStoreFieldExt m1 a1 :: Type) (UStoreFieldExt m2 a2 :: Type)

Defined in Lorentz.UStore.Types

Methods

castDummy :: Proxy (UStoreFieldExt m1 a1) -> Proxy (UStoreFieldExt m2 a2) -> ()

Eq v => Eq (UStoreFieldExt m v)

Defined in Lorentz.UStore.Types

Methods

(==) :: UStoreFieldExt m v -> UStoreFieldExt m v -> Bool

(/=) :: UStoreFieldExt m v -> UStoreFieldExt m v -> Bool

Show v => Show (UStoreFieldExt m v)

Defined in Lorentz.UStore.Types

Methods

showsPrec :: Int -> UStoreFieldExt m v -> ShowS

show :: UStoreFieldExt m v -> String

showList :: [UStoreFieldExt m v] -> ShowS

type UStoreField = UStoreFieldExt UMarkerPlainField

Just a plain field used as data.

type UStoreMarkerType = UStoreMarker -> Type

Specific kind used to designate markers for UStoreFieldExt.

We suggest that fields may serve different purposes and so annotated with special markers accordingly, which influences translation to Michelson. See example below.

This Haskell kind is implemented like that because we want markers to differ from all other types in kind; herewith UStoreMarkerType is still an open kind (has potentially infinite number of inhabitants).

data UMarkerPlainField :: UStoreMarkerType

Instances

KnownUStoreMarker UMarkerPlainField

Defined in Lorentz.UStore.Types

Associated Types

type ShowUStoreField UMarkerPlainField v :: ErrorMessage

Methods

mkFieldMarkerUKey :: MText -> ByteString

UStoreMarkerHasDoc UMarkerPlainField

Defined in Lorentz.UStore.Doc

Methods

ustoreMarkerKeyEncoding :: Text -> Text

type ShowUStoreField UMarkerPlainField v

Defined in Lorentz.UStore.Types

type ShowUStoreField UMarkerPlainField v = 'Text "field of type " :<>: 'ShowType v

Extras

class KnownUStoreMarker (marker :: UStoreMarkerType) where

Allows to specify format of key under which fields of this type are stored. Useful to avoid collisions.

Minimal complete definition

Nothing

Associated Types

type ShowUStoreField marker v :: ErrorMessage

Display type-level information about UStore field with given marker and field value type. Used for error messages.

type ShowUStoreField _ v = 'Text "field of type " :<>: 'ShowType v

Methods

mkFieldMarkerUKey :: MText -> ByteString

By field name derive key under which field should be stored.

default mkFieldMarkerUKey :: MText -> ByteString

Instances

KnownUStoreMarker UMarkerPlainField

Defined in Lorentz.UStore.Types

Associated Types

type ShowUStoreField UMarkerPlainField v :: ErrorMessage

Methods

mkFieldMarkerUKey :: MText -> ByteString

KnownUStoreMarker UMarkerEntrypoint

Defined in Lorentz.Contracts.Upgradeable.StorageDriven

Associated Types

type ShowUStoreField UMarkerEntrypoint v :: ErrorMessage

Methods

mkFieldMarkerUKey :: MText -> ByteString

mkFieldMarkerUKeyL :: forall marker field. KnownUStoreMarker marker => Label field -> ByteString

Version of mkFieldMarkerUKey which accepts label.

mkFieldUKey :: forall (store :: Type) field. KnownUStoreMarker (GetUStoreFieldMarker store field) => Label field -> ByteString

Shortcut for mkFieldMarkerUKey which accepts not marker but store template and name of entry.

type UStoreSubmapKey k = (MText, k)

What do we serialize when constructing big_map key for accessing an UStore submap.

type UStoreSubmapKeyT k = 'TPair (ToT MText) k

Type-lookup-by-name

type GetUStoreKey store name = MSKey (GetUStore name store)

Get type of submap key.

type GetUStoreValue store name = MSValue (GetUStore name store)

Get type of submap value.

type GetUStoreField store name = FSValue (GetUStore name store)

Get type of plain field. This ignores marker with field type.

type GetUStoreFieldMarker store name = FSMarker (GetUStore name store)

Get kind of field.

Marked fields

type PickMarkedFields marker template = GPickMarkedFields marker (Rep template)

Collect all fields with the given marker.

Internals

data ElemSignature

What was found on lookup by constructor name.

This keeps either type arguments of |~> or UStoreField.

Constructors

MapSignature Type Type

FieldSignature UStoreMarkerType Type

type GetUStore name a = MERequireFound name a (GLookupStore name (Rep a))

Get map signature from the constructor with a given name.

type family MSKey (ms :: ElemSignature) :: Type where ...

Equations

MSKey ('MapSignature k _) = k

MSKey ('FieldSignature _ _) = TypeError ('Text "Expected UStore submap, but field was referred")

type family MSValue (ms :: ElemSignature) :: Type where ...

Equations

MSValue ('MapSignature _ v) = v

MSValue ('FieldSignature _ _) = TypeError ('Text "Expected UStore submap, but field was referred")

type family FSValue (ms :: ElemSignature) :: Type where ...

Equations

FSValue ('FieldSignature _ v) = v

FSValue ('MapSignature _ _) = TypeError ('Text "Expected UStore field, but submap was referred")

type family FSMarker (ms :: ElemSignature) :: UStoreMarkerType where ...

Equations

FSMarker ('FieldSignature m _) = m

FSMarker ('MapSignature _ _) = TypeError ('Text "Expected UStore field, but submap was referred")