Lorentz.Contracts.UpgradeableCounterSdu

UpgradeableCounterSdu demonstrates the implementation of a simple contract that has upgradeable storage, interface, and implementation and uses storage-driven upgrades. Aside from the latter, this contract is similar to UpgradeableCounter.

In the first version it stores a Natural and allows to add some value to it.

The second version changes the type of the stored value to Integer, and instead of providing Add Natural and Inc () endpoints, it just allows to increment or decrement the current value.

While the contract does not have any advanced functionality, it provides a birds-eye view on all the aspects of the upgradeable contracts concept and serves as an example on how to apply this concept.

Documentation

data CounterSduV (v :: Nat) :: VersionKind

Version identifier for this contract.

It a bit differs from how we do in other contracts - this type is supposed to be used in all versions of the contract, but it has type parameter which is supposed to designate contract version.

Instances

KnownContractVersion (CounterSduV 0)

Defined in Lorentz.Contracts.UpgradeableCounterSdu

Associated Types

type VerInterface (CounterSduV 0) :: [EntrypointKind]

type VerUStoreTemplate (CounterSduV 0)

type VerPermanent (CounterSduV 0)

Methods

contractVersion :: Proxy (CounterSduV 0) -> Version

KnownContractVersion (CounterSduV 1)

Defined in Lorentz.Contracts.UpgradeableCounterSdu.V1

Associated Types

type VerInterface (CounterSduV 1) :: [EntrypointKind]

type VerUStoreTemplate (CounterSduV 1)

type VerPermanent (CounterSduV 1)

Methods

contractVersion :: Proxy (CounterSduV 1) -> Version

KnownContractVersion (CounterSduV 2)

Defined in Lorentz.Contracts.UpgradeableCounterSdu.V2

Associated Types

type VerInterface (CounterSduV 2) :: [EntrypointKind]

type VerUStoreTemplate (CounterSduV 2)

type VerPermanent (CounterSduV 2)

Methods

contractVersion :: Proxy (CounterSduV 2) -> Version

type VerInterface (CounterSduV 0)

Defined in Lorentz.Contracts.UpgradeableCounterSdu

type VerInterface (CounterSduV 0) = VerInterface (EmptyContractVersion Permanent)

type VerInterface (CounterSduV 1)

Defined in Lorentz.Contracts.UpgradeableCounterSdu.V1

type VerInterface (CounterSduV 1)

type VerInterface (CounterSduV 2)

Defined in Lorentz.Contracts.UpgradeableCounterSdu.V2

type VerInterface (CounterSduV 2)

type VerUStoreTemplate (CounterSduV 0)

Defined in Lorentz.Contracts.UpgradeableCounterSdu

type VerUStoreTemplate (CounterSduV 0) = VerUStoreTemplate (EmptyContractVersion Permanent)

type VerUStoreTemplate (CounterSduV 1)

Defined in Lorentz.Contracts.UpgradeableCounterSdu.V1

type VerUStoreTemplate (CounterSduV 1)

type VerUStoreTemplate (CounterSduV 2)

Defined in Lorentz.Contracts.UpgradeableCounterSdu.V2

type VerUStoreTemplate (CounterSduV 2)

type VerPermanent (CounterSduV 0)

Defined in Lorentz.Contracts.UpgradeableCounterSdu

type VerPermanent (CounterSduV 0) = VerPermanent (EmptyContractVersion Permanent)

type VerPermanent (CounterSduV 1)

Defined in Lorentz.Contracts.UpgradeableCounterSdu.V1

type VerPermanent (CounterSduV 1) = Permanent

type VerPermanent (CounterSduV 2)

Defined in Lorentz.Contracts.UpgradeableCounterSdu.V2

type VerPermanent (CounterSduV 2) = Permanent

data Parameter (ver :: VersionKind)

Parameter of upgradeable contract. It contains, among others:

1. Entrypoint for running one of upgradeable entrypoints.
2. Entrypoint for running one of permanent entrypoints, suitable e.g. for implementing interfaces. 3a. Entrypoint for upgrade in a single call. 3b. Entrypoints for entrypoint-wise upgrade.

Constructors

Run (VerParam ver)

RunPerm (VerPermanent ver)

Upgrade (OneShotUpgradeParameters ver)

GetVersion (View () Version)

SetAdministrator Address

EpwBeginUpgrade ("current" :! Version, "new" :! Version)

EpwApplyMigration (MigrationScriptFrom (VerUStoreTemplate ver))

EpwSetCode SomeUContractRouter

EpwSetPermCode (SomePermanentImpl (VerPermanent ver))

EpwFinishUpgrade

Instances

(Show (VerParam ver), Show (VerPermanent ver)) => Show (Parameter ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Contract

Methods

showsPrec :: Int -> Parameter ver -> ShowS

show :: Parameter ver -> String

showList :: [Parameter ver] -> ShowS

Generic (Parameter ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Contract

Associated Types

type Rep (Parameter ver) :: Type -> Type

Methods

from :: Parameter ver -> Rep (Parameter ver) x

to :: Rep (Parameter ver) x -> Parameter ver

(interface ~ VerInterface ver, UnpackUParam Buildable interface, Buildable (VerPermanent ver)) => Buildable (Parameter ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Contract

Methods

build :: Parameter ver -> Builder

PermConstraint ver => ParameterHasEntrypoints (Parameter ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Contract

Associated Types

type ParameterEntrypointsDerivation (Parameter ver)

IsoValue (VerPermanent ver) => IsoValue (Parameter ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Contract

Associated Types

type ToT (Parameter ver) :: T

Methods

toVal :: Parameter ver -> Value (ToT (Parameter ver))

fromVal :: Value (ToT (Parameter ver)) -> Parameter ver

NiceVersion ver => TypeHasDoc (Parameter ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Contract

Associated Types

type TypeDocFieldDescriptions (Parameter ver) :: FieldDescriptions

Methods

typeDocName :: Proxy (Parameter ver) -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy (Parameter ver) -> WithinParens -> Markdown

typeDocDependencies :: Proxy (Parameter ver) -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep (Parameter ver)

typeDocMichelsonRep :: TypeDocMichelsonRep (Parameter ver)

type Rep (Parameter ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Contract

type Rep (Parameter ver) = D1 ('MetaData "Parameter" "Lorentz.Contracts.Upgradeable.Common.Contract" "morley-upgradeable-0.3-inplace" 'False) (((C1 ('MetaCons "Run" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (VerParam ver))) :+: C1 ('MetaCons "RunPerm" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (VerPermanent ver)))) :+: (C1 ('MetaCons "Upgrade" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (OneShotUpgradeParameters ver))) :+: (C1 ('MetaCons "GetVersion" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (View () Version))) :+: C1 ('MetaCons "SetAdministrator" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Address))))) :+: ((C1 ('MetaCons "EpwBeginUpgrade" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ("current" :! Version, "new" :! Version))) :+: C1 ('MetaCons "EpwApplyMigration" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (MigrationScriptFrom (VerUStoreTemplate ver))))) :+: (C1 ('MetaCons "EpwSetCode" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SomeUContractRouter)) :+: (C1 ('MetaCons "EpwSetPermCode" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (SomePermanentImpl (VerPermanent ver)))) :+: C1 ('MetaCons "EpwFinishUpgrade" 'PrefixI 'False) (U1 :: Type -> Type)))))

type ParameterEntrypointsDerivation (Parameter ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Contract

type ParameterEntrypointsDerivation (Parameter ver) = EpdDelegate

type ToT (Parameter ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Contract

type ToT (Parameter ver) = GValueType (Rep (Parameter ver))

type TypeDocFieldDescriptions (Parameter ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Contract

type TypeDocFieldDescriptions (Parameter ver) = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

data Storage (ver :: VersionKind)

Instances

Generic (Storage ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Contract

Associated Types

type Rep (Storage ver) :: Type -> Type

Methods

from :: Storage ver -> Rep (Storage ver) x

to :: Rep (Storage ver) x -> Storage ver

HasAnnotation (VerPermanent ver) => HasAnnotation (Storage ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Contract

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (Storage ver))

annOptions :: AnnOptions

WellTypedIsoValue (VerPermanent ver) => IsoValue (Storage ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Contract

Associated Types

type ToT (Storage ver) :: T

Methods

toVal :: Storage ver -> Value (ToT (Storage ver))

fromVal :: Value (ToT (Storage ver)) -> Storage ver

NiceVersion ver => TypeHasDoc (Storage ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Contract

Associated Types

type TypeDocFieldDescriptions (Storage ver) :: FieldDescriptions

Methods

typeDocName :: Proxy (Storage ver) -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy (Storage ver) -> WithinParens -> Markdown

typeDocDependencies :: Proxy (Storage ver) -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep (Storage ver)

typeDocMichelsonRep :: TypeDocMichelsonRep (Storage ver)

type Rep (Storage ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Contract

type Rep (Storage ver)

type ToT (Storage ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Contract

type ToT (Storage ver) = GValueType (Rep (Storage ver))

type TypeDocFieldDescriptions (Storage ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Contract

type TypeDocFieldDescriptions (Storage ver) = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

data Permanent

Constructors

GetCounter (Void_ () Integer)

GetNothing Empty

Instances

Generic Permanent

Defined in Lorentz.Contracts.UpgradeableCounterSdu

Associated Types

type Rep Permanent :: Type -> Type

Methods

from :: Permanent -> Rep Permanent x

to :: Rep Permanent x -> Permanent

ParameterHasEntrypoints Permanent

Defined in Lorentz.Contracts.UpgradeableCounterSdu

Associated Types

type ParameterEntrypointsDerivation Permanent

HasAnnotation Permanent

Defined in Lorentz.Contracts.UpgradeableCounterSdu

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT Permanent)

annOptions :: AnnOptions

IsoValue Permanent

Defined in Lorentz.Contracts.UpgradeableCounterSdu

Associated Types

type ToT Permanent :: T

Methods

toVal :: Permanent -> Value (ToT Permanent)

fromVal :: Value (ToT Permanent) -> Permanent

TypeHasDoc Permanent

Defined in Lorentz.Contracts.UpgradeableCounterSdu

Associated Types

type TypeDocFieldDescriptions Permanent :: FieldDescriptions

Methods

typeDocName :: Proxy Permanent -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy Permanent -> WithinParens -> Markdown

typeDocDependencies :: Proxy Permanent -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep Permanent

typeDocMichelsonRep :: TypeDocMichelsonRep Permanent

type Rep Permanent

Defined in Lorentz.Contracts.UpgradeableCounterSdu

type Rep Permanent = D1 ('MetaData "Permanent" "Lorentz.Contracts.UpgradeableCounterSdu" "morley-upgradeable-0.3-inplace" 'False) (C1 ('MetaCons "GetCounter" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Void_ () Integer))) :+: C1 ('MetaCons "GetNothing" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Empty)))

type ParameterEntrypointsDerivation Permanent

Defined in Lorentz.Contracts.UpgradeableCounterSdu

type ParameterEntrypointsDerivation Permanent = EpdPlain

type ToT Permanent

Defined in Lorentz.Contracts.UpgradeableCounterSdu

type ToT Permanent = GValueType (Rep Permanent)

type TypeDocFieldDescriptions Permanent

Defined in Lorentz.Contracts.UpgradeableCounterSdu

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

upgradeableCounterContractSdu :: UpgradeableContract (CounterSduV 0)

mkEmptyStorage :: (VerInterface ver ~ '[], VerUStoreTemplate ver ~ ()) => Address -> Storage ver