Lorentz.Contracts.UserUpgradeable.V2

The second version of a minimal user-upgradeable ledger. This version is not designed to be upgraded further — it lacks InitiateMigration and MigrateMyTokens entrypoints. However, it has MigrateFrom (callable from V1), and mints new tokens when a user calls V1.MigrateMyTokens. Other functions (either upgradeability-related or standard Transfer/GetTotalSupply may be added if deemed desirable).

Note that the naming in this module is different from Lorentz.Contracts.Upgradeable: by "migration" here we mean the process of transferring the value from an old contract to the new one rather than applying a transformation to storage. Thus, MigrationScript here is a lambda that forges an operation to migrate user's funds rather than a function that upgrades storage in-place.

Documentation

data Parameter

Constructors

MigrateFrom (Address, Natural)

When called by V1, mints new tokens to Address

GetBalance (View Address Natural)

Returns the balance of a holder.

Instances

Generic Parameter

Defined in Lorentz.Contracts.UserUpgradeable.V2

Associated Types

type Rep Parameter :: Type -> Type

Methods

from :: Parameter -> Rep Parameter x

to :: Rep Parameter x -> Parameter

ParameterHasEntrypoints Parameter

Defined in Lorentz.Contracts.UserUpgradeable.V2

Associated Types

type ParameterEntrypointsDerivation Parameter

IsoValue Parameter

Defined in Lorentz.Contracts.UserUpgradeable.V2

Associated Types

type ToT Parameter :: T

Methods

toVal :: Parameter -> Value (ToT Parameter)

fromVal :: Value (ToT Parameter) -> Parameter

type Rep Parameter

Defined in Lorentz.Contracts.UserUpgradeable.V2

type Rep Parameter = D1 ('MetaData "Parameter" "Lorentz.Contracts.UserUpgradeable.V2" "morley-upgradeable-0.3-inplace" 'False) (C1 ('MetaCons "MigrateFrom" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Address, Natural))) :+: C1 ('MetaCons "GetBalance" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (View Address Natural))))

type ParameterEntrypointsDerivation Parameter

Defined in Lorentz.Contracts.UserUpgradeable.V2

type ParameterEntrypointsDerivation Parameter = EpdPlain

type ToT Parameter

Defined in Lorentz.Contracts.UserUpgradeable.V2

type ToT Parameter = GValueType (Rep Parameter)

data Storage

Constructors

Storage

Fields

• ledger :: Map Address Natural

  We use a Map instead of a BigMap to simplify the implementation a bit.

• previousVersion :: Maybe (TAddress Parameter)
• migrationTarget :: Maybe MigrationTarget

Instances

Generic Storage

Defined in Lorentz.Contracts.UserUpgradeable.V2

Associated Types

type Rep Storage :: Type -> Type

Methods

from :: Storage -> Rep Storage x

to :: Rep Storage x -> Storage

HasAnnotation Storage

Defined in Lorentz.Contracts.UserUpgradeable.V2

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT Storage)

annOptions :: AnnOptions

IsoValue Storage

Defined in Lorentz.Contracts.UserUpgradeable.V2

Associated Types

type ToT Storage :: T

Methods

toVal :: Storage -> Value (ToT Storage)

fromVal :: Value (ToT Storage) -> Storage

type Rep Storage

Defined in Lorentz.Contracts.UserUpgradeable.V2

type Rep Storage = D1 ('MetaData "Storage" "Lorentz.Contracts.UserUpgradeable.V2" "morley-upgradeable-0.3-inplace" 'False) (C1 ('MetaCons "Storage" 'PrefixI 'True) (S1 ('MetaSel ('Just "ledger") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Map Address Natural)) :*: (S1 ('MetaSel ('Just "previousVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (TAddress Parameter))) :*: S1 ('MetaSel ('Just "migrationTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MigrationTarget)))))

type ToT Storage

Defined in Lorentz.Contracts.UserUpgradeable.V2

type ToT Storage = GValueType (Rep Storage)

mkStorage :: TAddress Parameter -> Storage

userUpgradeableContract :: Contract Parameter Storage

Orphan instances

CustomErrorHasDoc "userUpgradable'unauthorizedMigrateFrom"

Methods

customErrDocMdCause :: Markdown

customErrDocMdCauseInEntrypoint :: Markdown

customErrClass :: ErrorClass

customErrArgumentSemantics :: Maybe Markdown