Lorentz.Contracts.Upgradeable.Common.Contract

Template for upgradeable contract.

It provides the following features: 1. Contract with upgradeable storage format and entrypoints set. 2. Two way to upgrade the contract - one shot and entrypoint-wise.

Documentation

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)]))]

type UTAddress ver = TAddress (Parameter ver)

type UContractRef ver = ContractRef (Parameter ver)

type PermConstraint ver = (NiceParameterFull (VerPermanent ver), NoExplicitDefaultEntrypoint (VerPermanent ver), HasAnnotation (VerPermanent ver), RequireAllUniqueEntrypoints (Parameter ver), Typeable ver, Typeable (VerInterface ver), Typeable (VerUStoreTemplate ver))

Constraint on abstract set of permanent entrypoints.

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)]))]

type UpgradeableContract ver = Contract (Parameter ver) (Storage ver)

data PermanentImpl ver

Implementation of permanent entrypoints.

This will be injected into contract storage as one of fields, so make sure that code within does not exceed several instructions; an actual entrypoint logic can be put into UStore and called from within PermanentImpl only when necessary.

Regarding documentation - this have to provide code pieces wrapped into DEntrypoint with PermanentEntrypointsKind, so always use entryCase as implementation of this type or inject documentation of code which does so unless you know what you are doing.

Instances

Show (PermanentImpl ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Base

Methods

showsPrec :: Int -> PermanentImpl ver -> ShowS

show :: PermanentImpl ver -> String

showList :: [PermanentImpl ver] -> ShowS

Generic (PermanentImpl ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Base

Associated Types

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

Methods

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

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

Wrappable (PermanentImpl ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Base

Associated Types

type Unwrappable (PermanentImpl ver)

MapLorentzInstr (PermanentImpl ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Base

Methods

mapLorentzInstr :: (forall (i :: [Type]) (o :: [Type]). (i :-> o) -> i :-> o) -> PermanentImpl ver -> PermanentImpl ver

HasAnnotation (VerPermanent ver) => HasAnnotation (PermanentImpl ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Base

Methods

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

annOptions :: AnnOptions

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

Defined in Lorentz.Contracts.Upgradeable.Common.Base

Associated Types

type ToT (PermanentImpl ver) :: T

Methods

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

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

(Typeable ver, Typeable (VerUStoreTemplate ver), TypeHasDoc (VerUStore ver), TypeHasDoc (VerPermanent ver), KnownValue (VerPermanent ver)) => TypeHasDoc (PermanentImpl ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Base

Associated Types

type TypeDocFieldDescriptions (PermanentImpl ver) :: FieldDescriptions

Methods

typeDocName :: Proxy (PermanentImpl ver) -> Text

typeDocMdDescription :: Markdown

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

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

typeDocHaskellRep :: TypeDocHaskellRep (PermanentImpl ver)

typeDocMichelsonRep :: TypeDocMichelsonRep (PermanentImpl ver)

(CanCastTo (VerPermanent ver1) (VerPermanent ver2), CanCastTo (VerUStore ver1) (VerUStore ver2)) => CanCastTo (PermanentImpl ver1 :: Type) (PermanentImpl ver2 :: Type)

Defined in Lorentz.Contracts.Upgradeable.Common.Base

Methods

castDummy :: Proxy (PermanentImpl ver1) -> Proxy (PermanentImpl ver2) -> ()

type Rep (PermanentImpl ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Base

type Rep (PermanentImpl ver) = D1 ('MetaData "PermanentImpl" "Lorentz.Contracts.Upgradeable.Common.Base" "morley-upgradeable-0.3-inplace" 'True) (C1 ('MetaCons "PermanentImpl" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPermanentImpl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Entrypoint (VerPermanent ver) (VerUStore ver)))))

type Unwrappable (PermanentImpl ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Base

type Unwrappable (PermanentImpl ver) = GUnwrappable (Rep (PermanentImpl ver))

type ToT (PermanentImpl ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Base

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

type TypeDocFieldDescriptions (PermanentImpl ver)

Defined in Lorentz.Contracts.Upgradeable.Common.Base

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

type InitUpgradeableContract perm = UpgradeableContract (EmptyContractVersion perm)

type OneShotUpgradeParameters ver = ("currentVersion" :! Version, "newVersion" :! Version, "migrationScript" :! MigrationScriptFrom (VerUStoreTemplate ver), "newCode" :! Maybe SomeUContractRouter, "newPermCode" :! Maybe (SomePermanentImpl (VerPermanent ver)))

Parameters of one-shot upgrade.

Do not construct this value manually, consider using makeOneShotUpgradeParameters.

data DVersion

Specify version if given contract.

Constructors

DVersion Version

Instances

DocItem DVersion

Defined in Lorentz.Contracts.Upgradeable.Common.Contract

Associated Types

type DocItemPlacement DVersion :: DocItemPlacementKind

type DocItemReferenced DVersion :: DocItemReferencedKind

Methods

docItemPos :: Natural

docItemSectionName :: Maybe Text

docItemSectionDescription :: Maybe Markdown

docItemSectionNameStyle :: DocSectionNameStyle

docItemRef :: DVersion -> DocItemRef (DocItemPlacement DVersion) (DocItemReferenced DVersion)

docItemToMarkdown :: HeaderLevel -> DVersion -> Markdown

docItemToToc :: HeaderLevel -> DVersion -> Markdown

docItemDependencies :: DVersion -> [SomeDocDefinitionItem]

docItemsOrder :: [DVersion] -> [DVersion]

type DocItemPlacement DVersion

Defined in Lorentz.Contracts.Upgradeable.Common.Contract

type DocItemPlacement DVersion = 'DocItemInlined

type DocItemReferenced DVersion

Defined in Lorentz.Contracts.Upgradeable.Common.Contract

type DocItemReferenced DVersion = 'False

type NiceVersion ver = (Typeable (VerInterface ver), Typeable (VerUStoreTemplate ver), UStoreTemplateHasDoc (VerUStoreTemplate ver), TypeHasDoc (VerPermanent ver), KnownValue (VerPermanent ver), HasAnnotation (VerPermanent ver), Typeable ver, WellTypedIsoValue (VerPermanent ver))

upgradeableContract :: forall ver. (NiceVersion ver, NiceParameterFull (Parameter ver)) => UpgradeableContract ver

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

pbsContainedInRun :: ParamBuildingStep

Mentions that parameter should be wrapped into Run entry point.

pbsContainedInRunPerm :: ParamBuildingStep

Mentions that parameter should be wrapped into Run entry point.

Orphan instances

CustomErrorHasDoc "upgContractIsNotPaused"

Methods

customErrDocMdCause :: Markdown

customErrDocMdCauseInEntrypoint :: Markdown

customErrClass :: ErrorClass

customErrArgumentSemantics :: Maybe Markdown

CustomErrorHasDoc "upgContractIsPaused"

Methods

customErrDocMdCause :: Markdown

customErrDocMdCauseInEntrypoint :: Markdown

customErrClass :: ErrorClass

customErrArgumentSemantics :: Maybe Markdown

CustomErrorHasDoc "upgVersionMismatch"

Methods

customErrDocMdCause :: Markdown

customErrDocMdCauseInEntrypoint :: Markdown

customErrClass :: ErrorClass

customErrArgumentSemantics :: Maybe Markdown

Buildable (CustomError "upgContractIsNotPaused")

Methods

build :: CustomError "upgContractIsNotPaused" -> Builder

Buildable (CustomError "upgContractIsPaused")

Methods

build :: CustomError "upgContractIsPaused" -> Builder

Buildable (CustomError "upgVersionMismatch")

Methods

build :: CustomError "upgVersionMismatch" -> Builder