Safe Haskell	Safe-Inferred
Language	Haskell2010

Morley.Michelson.Runtime.GState

Contents

Auxiliary types
GState
More genesisAddresses which can be used in tests
Genesis secret keys
Operations on GState

Description

Global blockchain state (emulated).

Synopsis

data ContractState = forall cp st.(ParameterScope cp, StorageScope st) => ContractState {
- csBalance :: Mutez
- csContract :: Contract cp st
- csStorage :: Value st
- csDelegate :: Maybe KeyHash
}
newtype VotingPowers = VotingPowers (Map KeyHash Natural)
data ImplicitState = ImplicitState {
- isBalance :: Mutez
- isTickets :: HashMap TicketKey Natural
- isDelegate :: Maybe KeyHash
}
newtype TicketKey = TicketKey (Address, Value, Ty)
toTicketKey :: forall t. HasNoOp t => Value ('TTicket t) -> (TicketKey, Natural)
isBalanceL :: Lens' ImplicitState Mutez
isDelegateL :: Lens' ImplicitState (Maybe KeyHash)
isTicketsL :: Lens' ImplicitState (HashMap TicketKey Natural)
vpPick :: KeyHash -> VotingPowers -> Natural
vpTotal :: VotingPowers -> Natural
mkVotingPowers :: [(KeyHash, Natural)] -> VotingPowers
mkVotingPowersFromMap :: Map KeyHash Natural -> VotingPowers
dummyVotingPowers :: VotingPowers
newtype BigMapCounter = BigMapCounter {
- _bigMapCounter :: Natural
}
bigMapCounter :: Iso' BigMapCounter Natural
data GState = GState {
- gsChainId :: ChainId
- gsImplicitAddresses :: Map ImplicitAddress ImplicitState
- gsContractAddresses :: Map ContractAddress ContractState
- gsSmartRollupAddresses :: Map SmartRollupAddress ()
- gsVotingPowers :: VotingPowers
- gsCounter :: GlobalCounter
- gsBigMapCounter :: BigMapCounter
- gsImplicitAddressAliases :: Bimap ImplicitAlias ImplicitAddress
- gsContractAddressAliases :: Bimap ContractAlias ContractAddress
}
gsChainIdL :: Lens' GState ChainId
gsImplicitAddressesL :: Lens' GState (Map ImplicitAddress ImplicitState)
gsContractAddressesL :: Lens' GState (Map ContractAddress ContractState)
gsImplicitAddressAliasesL :: Lens' GState (Bimap ImplicitAlias ImplicitAddress)
gsContractAddressAliasesL :: Lens' GState (Bimap ContractAlias ContractAddress)
gsVotingPowersL :: Lens' GState VotingPowers
gsCounterL :: Lens' GState GlobalCounter
gsBigMapCounterL :: Lens' GState BigMapCounter
addressesL :: KindedAddress kind -> Lens' GState (Map (KindedAddress kind) (AddressStateFam kind))
genesisAddresses :: GenesisList ImplicitAddress
genesisKeyHashes :: GenesisList KeyHash
genesisAddress :: ImplicitAddress
genesisAddress1 :: ImplicitAddress
genesisAddress2 :: ImplicitAddress
genesisAddress3 :: ImplicitAddress
genesisAddressN :: forall n. (SingIPeano n, (ToPeano GenesisAddressesNum > ToPeano n) ~ 'True) => ImplicitAddress
genesisKeyHash :: KeyHash
genesisSecretKey :: SecretKey
genesisSecrets :: GenesisList SecretKey
initGState :: GState
readGState :: FilePath -> IO GState
writeGState :: FilePath -> GState -> IO ()
data GStateUpdate where
- GSAddImplicitAddress :: ImplicitAddress -> Mutez -> [(TicketKey, Natural)] -> GStateUpdate
- GSAddContractAddress :: ContractAddress -> ContractState -> GStateUpdate
- GSAddContractAddressAlias :: ContractAlias -> ContractAddress -> GStateUpdate
- GSSetStorageValue :: StorageScope st => ContractAddress -> Value st -> GStateUpdate
- GSSetBalance :: L1AddressKind kind => KindedAddress kind -> Mutez -> GStateUpdate
- GSAddTickets :: ImplicitAddress -> TicketKey -> Natural -> GStateUpdate
- GSRemoveTickets :: ImplicitAddress -> TicketKey -> Natural -> GStateUpdate
- GSIncrementCounter :: GStateUpdate
- GSUpdateCounter :: GlobalCounter -> GStateUpdate
- GSSetBigMapCounter :: BigMapCounter -> GStateUpdate
- GSSetDelegate :: L1AddressKind kind => KindedAddress kind -> Maybe KeyHash -> GStateUpdate
data GStateUpdateError
- = GStateAddressExists Address
- | GStateUnknownAddress Address
- | GStateStorageNotMatch ContractAddress
- | GStateNotDelegate ImplicitAddress
- | GStateCantDeleteDelegate ImplicitAddress
- | GStateNoBLSDelegate Address KeyHash
- | GStateAlreadySetDelegate L1Address (Maybe KeyHash)
- | GStateInsufficientTickets ImplicitAddress TicketKey ("needs" :! Natural) ("has" :! Natural)
applyUpdate :: GStateUpdate -> GState -> Either GStateUpdateError GState
applyUpdates :: [GStateUpdate] -> GState -> Either GStateUpdateError GState
extractAllContracts :: GState -> TcOriginatedContracts
lookupBalance :: forall kind. L1AddressKind kind => KindedAddress kind -> GState -> Maybe Mutez
type family AddressStateFam kind where ...

Auxiliary types

data ContractState Source #

State of a contract with code.

Constructors

forall cp st.(ParameterScope cp, StorageScope st) => ContractState
Fields csBalance :: Mutez Amount of mutez owned by this contract. csContract :: Contract cp st Contract itself. csStorage :: Value st Storage value associated with this contract. csDelegate :: Maybe KeyHash Delegate associated with this contract.

Instances

Instances details

FromJSON ContractState Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods parseJSON :: Value -> Parser ContractState # parseJSONList :: Value -> Parser [ContractState] #
ToJSON ContractState Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods toJSON :: ContractState -> Value # toEncoding :: ContractState -> Encoding # toJSONList :: [ContractState] -> Value # toEncodingList :: [ContractState] -> Encoding #
Show ContractState Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods showsPrec :: Int -> ContractState -> ShowS # show :: ContractState -> String # showList :: [ContractState] -> ShowS #
Buildable ContractState Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods build :: ContractState -> Builder #
Eq ContractState Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods (==) :: ContractState -> ContractState -> Bool # (/=) :: ContractState -> ContractState -> Bool #

newtype VotingPowers Source #

Distribution of voting power among the contracts.

Voting power reflects the ability of bakers to accept, deny or pass new proposals for protocol updates. I.e. each baker has its vote weight.

This datatype definition may change in future, so its internals are not exported.

Constructors

VotingPowers (Map KeyHash Natural)

Instances

Instances details

FromJSON VotingPowers Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods parseJSON :: Value -> Parser VotingPowers # parseJSONList :: Value -> Parser [VotingPowers] #
ToJSON VotingPowers Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods toJSON :: VotingPowers -> Value # toEncoding :: VotingPowers -> Encoding # toJSONList :: [VotingPowers] -> Value # toEncodingList :: [VotingPowers] -> Encoding #
Show VotingPowers Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods showsPrec :: Int -> VotingPowers -> ShowS # show :: VotingPowers -> String # showList :: [VotingPowers] -> ShowS #
Eq VotingPowers Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods (==) :: VotingPowers -> VotingPowers -> Bool # (/=) :: VotingPowers -> VotingPowers -> Bool #

data ImplicitState Source #

Constructors

ImplicitState

Fields

isBalance :: Mutez
Implicit address balance.
isTickets :: HashMap TicketKey Natural
Implicit account's ticket balances.
isDelegate :: Maybe KeyHash
Delegate, if set. Implicit address can have a delegate set to itself, then it's considered "registered delegate" and can be set as delegate for other addresses. It's impossible to "unregister" a delegate, so once delegate is set to the address itself, it can't be changed.

Instances

Instances details

FromJSON ImplicitState Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods parseJSON :: Value -> Parser ImplicitState # parseJSONList :: Value -> Parser [ImplicitState] #
ToJSON ImplicitState Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods toJSON :: ImplicitState -> Value # toEncoding :: ImplicitState -> Encoding # toJSONList :: [ImplicitState] -> Value # toEncodingList :: [ImplicitState] -> Encoding #
Show ImplicitState Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods showsPrec :: Int -> ImplicitState -> ShowS # show :: ImplicitState -> String # showList :: [ImplicitState] -> ShowS #
Buildable ImplicitState Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods build :: ImplicitState -> Builder #
Eq ImplicitState Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods (==) :: ImplicitState -> ImplicitState -> Bool # (/=) :: ImplicitState -> ImplicitState -> Bool #

newtype TicketKey Source #

A triple of ticketer, value and type, which uniquely defines a ticket.

Constructors

TicketKey (Address, Value, Ty)

Instances

Instances details

FromJSON TicketKey Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods parseJSON :: Value -> Parser TicketKey # parseJSONList :: Value -> Parser [TicketKey] #
FromJSONKey TicketKey Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods fromJSONKey :: FromJSONKeyFunction TicketKey # fromJSONKeyList :: FromJSONKeyFunction [TicketKey] #
ToJSON TicketKey Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods toJSON :: TicketKey -> Value # toEncoding :: TicketKey -> Encoding # toJSONList :: [TicketKey] -> Value # toEncodingList :: [TicketKey] -> Encoding #
ToJSONKey TicketKey Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods toJSONKey :: ToJSONKeyFunction TicketKey # toJSONKeyList :: ToJSONKeyFunction [TicketKey] #
Show TicketKey Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods showsPrec :: Int -> TicketKey -> ShowS # show :: TicketKey -> String # showList :: [TicketKey] -> ShowS #
Buildable TicketKey Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods build :: TicketKey -> Builder #
Eq TicketKey Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods (==) :: TicketKey -> TicketKey -> Bool # (/=) :: TicketKey -> TicketKey -> Bool #
Hashable TicketKey Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods hashWithSalt :: Int -> TicketKey -> Int # hash :: TicketKey -> Int #

toTicketKey :: forall t. HasNoOp t => Value ('TTicket t) -> (TicketKey, Natural) Source #

Convert a typed ticket value to TicketKey and amount.

isBalanceL :: Lens' ImplicitState Mutez Source #

isDelegateL :: Lens' ImplicitState (Maybe KeyHash) Source #

isTicketsL :: Lens' ImplicitState (HashMap TicketKey Natural) Source #

vpPick :: KeyHash -> VotingPowers -> Natural Source #

Get voting power of the given address.

vpTotal :: VotingPowers -> Natural Source #

Get total voting power.

mkVotingPowers :: [(KeyHash, Natural)] -> VotingPowers Source #

Create voting power distribution.

If some key is encountered multiple times, voting power will be summed up.

mkVotingPowersFromMap :: Map KeyHash Natural -> VotingPowers Source #

Create voting power distribution from map.

dummyVotingPowers :: VotingPowers Source #

Dummy VotingPowers. We give all the voting power to two genesis addresses as the addresses holding lot of money. Only two addresses are involved for simplicity.

newtype BigMapCounter Source #

All big_maps stored in a chain have a globally unique ID.

We use this counter to keep track of how many big_maps have been created so far, and to generate new IDs whenever a new big_map is created.

Constructors

BigMapCounter
Fields _bigMapCounter :: Natural

Instances

Instances details

FromJSON BigMapCounter Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods parseJSON :: Value -> Parser BigMapCounter # parseJSONList :: Value -> Parser [BigMapCounter] #
ToJSON BigMapCounter Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods toJSON :: BigMapCounter -> Value # toEncoding :: BigMapCounter -> Encoding # toJSONList :: [BigMapCounter] -> Value # toEncodingList :: [BigMapCounter] -> Encoding #
Generic BigMapCounter Source #
Instance details Defined in Morley.Michelson.Runtime.GState Associated Types type Rep BigMapCounter :: Type -> Type # Methods from :: BigMapCounter -> Rep BigMapCounter x # to :: Rep BigMapCounter x -> BigMapCounter #
Num BigMapCounter Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods (+) :: BigMapCounter -> BigMapCounter -> BigMapCounter # (-) :: BigMapCounter -> BigMapCounter -> BigMapCounter # (*) :: BigMapCounter -> BigMapCounter -> BigMapCounter # negate :: BigMapCounter -> BigMapCounter # abs :: BigMapCounter -> BigMapCounter # signum :: BigMapCounter -> BigMapCounter # fromInteger :: Integer -> BigMapCounter #
Show BigMapCounter Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods showsPrec :: Int -> BigMapCounter -> ShowS # show :: BigMapCounter -> String # showList :: [BigMapCounter] -> ShowS #
NFData BigMapCounter Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods rnf :: BigMapCounter -> () #
Buildable BigMapCounter Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods build :: BigMapCounter -> Builder #
Eq BigMapCounter Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods (==) :: BigMapCounter -> BigMapCounter -> Bool # (/=) :: BigMapCounter -> BigMapCounter -> Bool #
type Rep BigMapCounter Source #
Instance details Defined in Morley.Michelson.Runtime.GState type Rep BigMapCounter = D1 ('MetaData "BigMapCounter" "Morley.Michelson.Runtime.GState" "morley-1.19.1-inplace" 'True) (C1 ('MetaCons "BigMapCounter" 'PrefixI 'True) (S1 ('MetaSel ('Just "_bigMapCounter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

bigMapCounter :: Iso' BigMapCounter Natural Source #

GState

data GState Source #

Persistent data passed to Morley contracts which can be updated as result of contract execution.

Constructors

GState

Fields

gsChainId :: ChainId
Identifier of chain.
gsImplicitAddresses :: Map ImplicitAddress ImplicitState
All known implicit addresses and their state (i.e. balance)
gsContractAddresses :: Map ContractAddress ContractState
All known contract addresses and their state.
gsSmartRollupAddresses :: Map SmartRollupAddress ()
All known smart rollup addresses and their state.
gsVotingPowers :: VotingPowers
Voting power distribution.
gsCounter :: GlobalCounter
Ever increasing operation counter.
gsBigMapCounter :: BigMapCounter
gsImplicitAddressAliases :: Bimap ImplicitAlias ImplicitAddress
Implicit addresses with the associated aliases/names.
gsContractAddressAliases :: Bimap ContractAlias ContractAddress
Contract addresses with the associated aliases/names.

Instances

Instances details

FromJSON GState Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods parseJSON :: Value -> Parser GState # parseJSONList :: Value -> Parser [GState] #
ToJSON GState Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods toJSON :: GState -> Value # toEncoding :: GState -> Encoding # toJSONList :: [GState] -> Value # toEncodingList :: [GState] -> Encoding #
Show GState Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods showsPrec :: Int -> GState -> ShowS # show :: GState -> String # showList :: [GState] -> ShowS #
Eq GState Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods (==) :: GState -> GState -> Bool # (/=) :: GState -> GState -> Bool #

gsChainIdL :: Lens' GState ChainId Source #

gsImplicitAddressesL :: Lens' GState (Map ImplicitAddress ImplicitState) Source #

gsContractAddressesL :: Lens' GState (Map ContractAddress ContractState) Source #

gsImplicitAddressAliasesL :: Lens' GState (Bimap ImplicitAlias ImplicitAddress) Source #

gsContractAddressAliasesL :: Lens' GState (Bimap ContractAlias ContractAddress) Source #

gsVotingPowersL :: Lens' GState VotingPowers Source #

gsCounterL :: Lens' GState GlobalCounter Source #

gsBigMapCounterL :: Lens' GState BigMapCounter Source #

addressesL :: KindedAddress kind -> Lens' GState (Map (KindedAddress kind) (AddressStateFam kind)) Source #

genesisAddresses :: GenesisList ImplicitAddress Source #

Initially these addresses have a lot of money.

genesisKeyHashes :: GenesisList KeyHash Source #

KeyHash of genesis address.

genesisAddress :: ImplicitAddress Source #

One of genesis addresses.

More genesisAddresses which can be used in tests

genesisAddress1 :: ImplicitAddress Source #

More genesis addresses

genesisAddress2 :: ImplicitAddress Source #

More genesis addresses

genesisAddress3 :: ImplicitAddress Source #

More genesis addresses

genesisAddressN :: forall n. (SingIPeano n, (ToPeano GenesisAddressesNum > ToPeano n) ~ 'True) => ImplicitAddress Source #

More genesis addresses, via a type-level natural

genesisAddressN @7

Note that genesisAddress == genesisAddressN @0, genesisAddress1 == genesisAddressN @1, etc.

genesisKeyHash :: KeyHash Source #

One of genesis key hashes.

Genesis secret keys

genesisSecretKey :: SecretKey Source #

Secret key assotiated with genesisAddress.

genesisSecrets :: GenesisList SecretKey Source #

Secrets from which genesis addresses are derived from.

initGState :: GState Source #

Initial GState. It's supposed to be used if no GState is provided. It puts plenty of money on each genesis address.

readGState :: FilePath -> IO GState Source #

Read GState from a file.

writeGState :: FilePath -> GState -> IO () Source #

Write GState to a file.

Operations on GState

data GStateUpdate where Source #

Updates that can be applied to GState.

Constructors

GSAddImplicitAddress :: ImplicitAddress -> Mutez -> [(TicketKey, Natural)] -> GStateUpdate
GSAddContractAddress :: ContractAddress -> ContractState -> GStateUpdate
GSAddContractAddressAlias :: ContractAlias -> ContractAddress -> GStateUpdate
GSSetStorageValue :: StorageScope st => ContractAddress -> Value st -> GStateUpdate
GSSetBalance :: L1AddressKind kind => KindedAddress kind -> Mutez -> GStateUpdate
GSAddTickets :: ImplicitAddress -> TicketKey -> Natural -> GStateUpdate
GSRemoveTickets :: ImplicitAddress -> TicketKey -> Natural -> GStateUpdate
GSIncrementCounter :: GStateUpdate
GSUpdateCounter :: GlobalCounter -> GStateUpdate
GSSetBigMapCounter :: BigMapCounter -> GStateUpdate
GSSetDelegate :: L1AddressKind kind => KindedAddress kind -> Maybe KeyHash -> GStateUpdate

Instances

Instances details

Show GStateUpdate Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods showsPrec :: Int -> GStateUpdate -> ShowS # show :: GStateUpdate -> String # showList :: [GStateUpdate] -> ShowS #
Buildable GStateUpdate Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods build :: GStateUpdate -> Builder #

data GStateUpdateError Source #

Instances

Instances details

Show GStateUpdateError Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods showsPrec :: Int -> GStateUpdateError -> ShowS # show :: GStateUpdateError -> String # showList :: [GStateUpdateError] -> ShowS #
Buildable GStateUpdateError Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods build :: GStateUpdateError -> Builder #

applyUpdate :: GStateUpdate -> GState -> Either GStateUpdateError GState Source #

Apply GStateUpdate to GState.

applyUpdates :: [GStateUpdate] -> GState -> Either GStateUpdateError GState Source #

Apply a list of GStateUpdates to GState.

extractAllContracts :: GState -> TcOriginatedContracts Source #

Retrieve all contracts stored in GState

lookupBalance :: forall kind. L1AddressKind kind => KindedAddress kind -> GState -> Maybe Mutez Source #

type family AddressStateFam kind where ... Source #

Equations

AddressStateFam 'AddressKindImplicit = ImplicitState
AddressStateFam 'AddressKindContract = ContractState
AddressStateFam 'AddressKindSmartRollup = ()

GStateAddressExists Address
GStateUnknownAddress Address
GStateStorageNotMatch ContractAddress
GStateNotDelegate ImplicitAddress
GStateCantDeleteDelegate ImplicitAddress
GStateNoBLSDelegate Address KeyHash
GStateAlreadySetDelegate L1Address (Maybe KeyHash)
GStateInsufficientTickets ImplicitAddress TicketKey ("needs" :! Natural) ("has" :! Natural)