Safe Haskell	None
Language	Haskell2010

Lorentz.UStore.Haskell

Description

Conversion between UStore in Haskell and Michelson representation.

Synopsis

mkUStore :: UStoreTraversable MkUStoreTW template => template -> UStore template
data MkUStoreTW
ustoreDecompose :: forall template. UStoreTraversable DecomposeUStoreTW template => UStore template -> Either Text (UStoreContent, template)
ustoreDecomposeFull :: forall template. UStoreTraversable DecomposeUStoreTW template => UStore template -> Either Text template
data DecomposeUStoreTW
fillUStore :: UStoreTraversable FillUStoreTW template => template -> UStoreMigration () template
migrateFillUStore :: (UStoreTraversable FillUStoreTW template, allFieldsExp ~ AllUStoreFieldsF template, newDiff ~ FillingNewDiff template diff, newTouched ~ FillingNewTouched template touched, PatternMatchL newDiff, PatternMatchL newTouched) => template -> Lambda (MUStore oldTempl newTempl diff touched) (MUStore oldTempl newTempl newDiff newTouched)
fillUStoreMigrationBlock :: (UStoreTraversable FillUStoreTW template, allFieldsExp ~ AllUStoreFieldsF template, newDiff ~ FillingNewDiff template diff, newTouched ~ FillingNewTouched template touched, PatternMatchL newDiff, PatternMatchL newTouched) => template -> MigrationBlocks oldTempl newTempl diff touched newDiff newTouched
data FillUStoreTW

Documentation

mkUStore :: UStoreTraversable MkUStoreTW template => template -> UStore template Source #

Make UStore from separate big_maps and fields.

data MkUStoreTW Source #

Declares handlers for UStore creation from template.

Instances

Instances details

UStoreTraversalWay MkUStoreTW Source #
Instance details Defined in Lorentz.UStore.Haskell Associated Types type UStoreTraversalArgumentWrapper MkUStoreTW :: Type -> Type Source # type UStoreTraversalMonad MkUStoreTW :: Type -> Type Source #
(NicePackedValue k, NicePackedValue v) => UStoreTraversalSubmapHandler MkUStoreTW k v Source #
Instance details Defined in Lorentz.UStore.Haskell Methods ustoreTraversalSubmapHandler :: forall (name :: Symbol). MkUStoreTW -> Label name -> UStoreTraversalArgumentWrapper MkUStoreTW (Map k v) -> UStoreTraversalMonad MkUStoreTW (Map k v) Source #
NicePackedValue val => UStoreTraversalFieldHandler MkUStoreTW marker val Source #
Instance details Defined in Lorentz.UStore.Haskell Methods ustoreTraversalFieldHandler :: forall (name :: Symbol). KnownUStoreMarker marker => MkUStoreTW -> Label name -> UStoreTraversalArgumentWrapper MkUStoreTW val -> UStoreTraversalMonad MkUStoreTW val Source #
type UStoreTraversalArgumentWrapper MkUStoreTW Source #
Instance details Defined in Lorentz.UStore.Haskell type UStoreTraversalArgumentWrapper MkUStoreTW = Identity
type UStoreTraversalMonad MkUStoreTW Source #
Instance details Defined in Lorentz.UStore.Haskell type UStoreTraversalMonad MkUStoreTW = Const (Map ByteString ByteString) :: Type -> Type

ustoreDecompose :: forall template. UStoreTraversable DecomposeUStoreTW template => UStore template -> Either Text (UStoreContent, template) Source #

Decompose UStore into separate big_maps and fields.

Since this function needs to UNPACK content of UStore to actual keys and values, you have to provide UnpackEnv.

Along with resulting value, you get a list of UStore entries which were not recognized as belonging to any submap or field according to UStore's template - this should be empty unless UStore invariants were violated.

ustoreDecomposeFull :: forall template. UStoreTraversable DecomposeUStoreTW template => UStore template -> Either Text template Source #

Like ustoreDecompose, but requires all entries from UStore to be recognized.

data DecomposeUStoreTW Source #

Declares handlers for UStore conversion to template.

Instances

Instances details

UStoreTraversalWay DecomposeUStoreTW Source #
Instance details Defined in Lorentz.UStore.Haskell Associated Types type UStoreTraversalArgumentWrapper DecomposeUStoreTW :: Type -> Type Source # type UStoreTraversalMonad DecomposeUStoreTW :: Type -> Type Source #
(Ord k, NiceUnpackedValue k, NiceUnpackedValue v) => UStoreTraversalSubmapHandler DecomposeUStoreTW k v Source #
Instance details Defined in Lorentz.UStore.Haskell Methods ustoreTraversalSubmapHandler :: forall (name :: Symbol). DecomposeUStoreTW -> Label name -> UStoreTraversalArgumentWrapper DecomposeUStoreTW (Map k v) -> UStoreTraversalMonad DecomposeUStoreTW (Map k v) Source #
NiceUnpackedValue val => UStoreTraversalFieldHandler DecomposeUStoreTW marker val Source #
Instance details Defined in Lorentz.UStore.Haskell Methods ustoreTraversalFieldHandler :: forall (name :: Symbol). KnownUStoreMarker marker => DecomposeUStoreTW -> Label name -> UStoreTraversalArgumentWrapper DecomposeUStoreTW val -> UStoreTraversalMonad DecomposeUStoreTW val Source #
type UStoreTraversalArgumentWrapper DecomposeUStoreTW Source #
Instance details Defined in Lorentz.UStore.Haskell type UStoreTraversalArgumentWrapper DecomposeUStoreTW = Const () :: Type -> Type
type UStoreTraversalMonad DecomposeUStoreTW Source #
Instance details Defined in Lorentz.UStore.Haskell type UStoreTraversalMonad DecomposeUStoreTW

fillUStore :: UStoreTraversable FillUStoreTW template => template -> UStoreMigration () template Source #

Make migration script which initializes UStore from scratch.

migrateFillUStore :: (UStoreTraversable FillUStoreTW template, allFieldsExp ~ AllUStoreFieldsF template, newDiff ~ FillingNewDiff template diff, newTouched ~ FillingNewTouched template touched, PatternMatchL newDiff, PatternMatchL newTouched) => template -> Lambda (MUStore oldTempl newTempl diff touched) (MUStore oldTempl newTempl newDiff newTouched) Source #

Fill UStore with entries from the given template as part of simple migration.

Sometimes you already have some fields initialized and fillUStore does not suit, then in case if your UStore template is a nested structure you can use sub-templates to initialize the corresponding parts of UStore.

For batched migrations see fillUStoreMigrationBlock.

fillUStoreMigrationBlock :: (UStoreTraversable FillUStoreTW template, allFieldsExp ~ AllUStoreFieldsF template, newDiff ~ FillingNewDiff template diff, newTouched ~ FillingNewTouched template touched, PatternMatchL newDiff, PatternMatchL newTouched) => template -> MigrationBlocks oldTempl newTempl diff touched newDiff newTouched Source #

Version of migrateFillUStore for batched migrations.

Each field write will be placed to a separate batch.

data FillUStoreTW Source #

Declares handlers for UStore filling via lambda.

Instances

Instances details

UStoreTraversalWay FillUStoreTW Source #
Instance details Defined in Lorentz.UStore.Haskell Associated Types type UStoreTraversalArgumentWrapper FillUStoreTW :: Type -> Type Source # type UStoreTraversalMonad FillUStoreTW :: Type -> Type Source #
(NiceConstant k, NiceConstant v) => UStoreTraversalSubmapHandler FillUStoreTW k v Source #
Instance details Defined in Lorentz.UStore.Haskell Methods ustoreTraversalSubmapHandler :: forall (name :: Symbol). FillUStoreTW -> Label name -> UStoreTraversalArgumentWrapper FillUStoreTW (Map k v) -> UStoreTraversalMonad FillUStoreTW (Map k v) Source #
NiceConstant v => UStoreTraversalFieldHandler FillUStoreTW marker v Source #
Instance details Defined in Lorentz.UStore.Haskell Methods ustoreTraversalFieldHandler :: forall (name :: Symbol). KnownUStoreMarker marker => FillUStoreTW -> Label name -> UStoreTraversalArgumentWrapper FillUStoreTW v -> UStoreTraversalMonad FillUStoreTW v Source #
type UStoreTraversalArgumentWrapper FillUStoreTW Source #
Instance details Defined in Lorentz.UStore.Haskell type UStoreTraversalArgumentWrapper FillUStoreTW = Identity
type UStoreTraversalMonad FillUStoreTW Source #
Instance details Defined in Lorentz.UStore.Haskell type UStoreTraversalMonad FillUStoreTW = Const (Endo [MigrationAtom]) :: Type -> Type