Lorentz.Contracts.UpgradeableUnsafeLedger

UpgradeableUnsafeLedger demonstrates a real-world use case of an upgradeable contract. Its V1 contains a bug that makes it return an incorrect totalSupply. Fortunately, we can upgrade the contract and fix the bug. This contract does not use entrypoint-wise upgrades. Instead, it upgrades atomically in one transaction. For non-atomic upgrades please see the UpgradeableCounter example.

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

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

upgradeableUnsafeLedgerContract :: InitUpgradeableContract Permanent

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