Morley.Michelson.Runtime.GState

Global blockchain state (emulated).

Auxiliary types

data ContractState

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

FromJSON ContractState

Defined in Morley.Michelson.Runtime.GState

Methods

parseJSON :: Value -> Parser ContractState

parseJSONList :: Value -> Parser [ContractState]

ToJSON ContractState

Defined in Morley.Michelson.Runtime.GState

Methods

toJSON :: ContractState -> Value

toEncoding :: ContractState -> Encoding

toJSONList :: [ContractState] -> Value

toEncodingList :: [ContractState] -> Encoding

Show ContractState

Defined in Morley.Michelson.Runtime.GState

Methods

showsPrec :: Int -> ContractState -> ShowS

show :: ContractState -> String

showList :: [ContractState] -> ShowS

Eq ContractState

Defined in Morley.Michelson.Runtime.GState

Methods

(==) :: ContractState -> ContractState -> Bool

(/=) :: ContractState -> ContractState -> Bool

Buildable ContractState

Defined in Morley.Michelson.Runtime.GState

Methods

build :: ContractState -> Doc

buildList :: [ContractState] -> Doc

newtype VotingPowers

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

FromJSON VotingPowers

Defined in Morley.Michelson.Runtime.GState

Methods

parseJSON :: Value -> Parser VotingPowers

parseJSONList :: Value -> Parser [VotingPowers]

ToJSON VotingPowers

Defined in Morley.Michelson.Runtime.GState

Methods

toJSON :: VotingPowers -> Value

toEncoding :: VotingPowers -> Encoding

toJSONList :: [VotingPowers] -> Value

toEncodingList :: [VotingPowers] -> Encoding

Show VotingPowers

Defined in Morley.Michelson.Runtime.GState

Methods

showsPrec :: Int -> VotingPowers -> ShowS

show :: VotingPowers -> String

showList :: [VotingPowers] -> ShowS

Eq VotingPowers

Defined in Morley.Michelson.Runtime.GState

Methods

(==) :: VotingPowers -> VotingPowers -> Bool

(/=) :: VotingPowers -> VotingPowers -> Bool

data ImplicitState

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

FromJSON ImplicitState

Defined in Morley.Michelson.Runtime.GState

Methods

parseJSON :: Value -> Parser ImplicitState

parseJSONList :: Value -> Parser [ImplicitState]

ToJSON ImplicitState

Defined in Morley.Michelson.Runtime.GState

Methods

toJSON :: ImplicitState -> Value

toEncoding :: ImplicitState -> Encoding

toJSONList :: [ImplicitState] -> Value

toEncodingList :: [ImplicitState] -> Encoding

Show ImplicitState

Defined in Morley.Michelson.Runtime.GState

Methods

showsPrec :: Int -> ImplicitState -> ShowS

show :: ImplicitState -> String

showList :: [ImplicitState] -> ShowS

Eq ImplicitState

Defined in Morley.Michelson.Runtime.GState

Methods

(==) :: ImplicitState -> ImplicitState -> Bool

(/=) :: ImplicitState -> ImplicitState -> Bool

Buildable ImplicitState

Defined in Morley.Michelson.Runtime.GState

Methods

build :: ImplicitState -> Doc

buildList :: [ImplicitState] -> Doc

newtype TicketKey

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

Constructors

TicketKey (Address, Value, Ty)

Instances

FromJSON TicketKey

Defined in Morley.Michelson.Runtime.GState

Methods

parseJSON :: Value -> Parser TicketKey

parseJSONList :: Value -> Parser [TicketKey]

FromJSONKey TicketKey

Defined in Morley.Michelson.Runtime.GState

Methods

fromJSONKey :: FromJSONKeyFunction TicketKey

fromJSONKeyList :: FromJSONKeyFunction [TicketKey]

ToJSON TicketKey

Defined in Morley.Michelson.Runtime.GState

Methods

toJSON :: TicketKey -> Value

toEncoding :: TicketKey -> Encoding

toJSONList :: [TicketKey] -> Value

toEncodingList :: [TicketKey] -> Encoding

ToJSONKey TicketKey

Defined in Morley.Michelson.Runtime.GState

Methods

toJSONKey :: ToJSONKeyFunction TicketKey

toJSONKeyList :: ToJSONKeyFunction [TicketKey]

Show TicketKey

Defined in Morley.Michelson.Runtime.GState

Methods

showsPrec :: Int -> TicketKey -> ShowS

show :: TicketKey -> String

showList :: [TicketKey] -> ShowS

Eq TicketKey

Defined in Morley.Michelson.Runtime.GState

Methods

(==) :: TicketKey -> TicketKey -> Bool

(/=) :: TicketKey -> TicketKey -> Bool

Hashable TicketKey

Defined in Morley.Michelson.Runtime.GState

Methods

hashWithSalt :: Int -> TicketKey -> Int

hash :: TicketKey -> Int

Buildable TicketKey

Defined in Morley.Michelson.Runtime.GState

Methods

build :: TicketKey -> Doc

buildList :: [TicketKey] -> Doc

toTicketKey :: forall t. Value ('TTicket t) -> (TicketKey, Natural)

Convert a typed ticket value to TicketKey and amount.

isBalanceL :: Lens' ImplicitState Mutez

isDelegateL :: Lens' ImplicitState (Maybe KeyHash)

isTicketsL :: Lens' ImplicitState (HashMap TicketKey Natural)

vpPick :: KeyHash -> VotingPowers -> Natural

Get voting power of the given address.

vpTotal :: VotingPowers -> Natural

Get total voting power.

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

Create voting power distribution.

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

mkVotingPowersFromMap :: Map KeyHash Natural -> VotingPowers

Create voting power distribution from map.

dummyVotingPowers :: VotingPowers

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

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

FromJSON BigMapCounter

Defined in Morley.Michelson.Runtime.GState

Methods

parseJSON :: Value -> Parser BigMapCounter

parseJSONList :: Value -> Parser [BigMapCounter]

ToJSON BigMapCounter

Defined in Morley.Michelson.Runtime.GState

Methods

toJSON :: BigMapCounter -> Value

toEncoding :: BigMapCounter -> Encoding

toJSONList :: [BigMapCounter] -> Value

toEncodingList :: [BigMapCounter] -> Encoding

Generic BigMapCounter

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

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

Defined in Morley.Michelson.Runtime.GState

Methods

showsPrec :: Int -> BigMapCounter -> ShowS

show :: BigMapCounter -> String

showList :: [BigMapCounter] -> ShowS

NFData BigMapCounter

Defined in Morley.Michelson.Runtime.GState

Methods

rnf :: BigMapCounter -> ()

Eq BigMapCounter

Defined in Morley.Michelson.Runtime.GState

Methods

(==) :: BigMapCounter -> BigMapCounter -> Bool

(/=) :: BigMapCounter -> BigMapCounter -> Bool

Buildable BigMapCounter

Defined in Morley.Michelson.Runtime.GState

Methods

build :: BigMapCounter -> Doc

buildList :: [BigMapCounter] -> Doc

type Rep BigMapCounter

Defined in Morley.Michelson.Runtime.GState

type Rep BigMapCounter = D1 ('MetaData "BigMapCounter" "Morley.Michelson.Runtime.GState" "morley-1.20.0-inplace" 'True) (C1 ('MetaCons "BigMapCounter" 'PrefixI 'True) (S1 ('MetaSel ('Just "_bigMapCounter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

bigMapCounter :: Iso' BigMapCounter Natural

GState

data GState

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

FromJSON GState

Defined in Morley.Michelson.Runtime.GState

Methods

parseJSON :: Value -> Parser GState

parseJSONList :: Value -> Parser [GState]

ToJSON GState

Defined in Morley.Michelson.Runtime.GState

Methods

toJSON :: GState -> Value

toEncoding :: GState -> Encoding

toJSONList :: [GState] -> Value

toEncodingList :: [GState] -> Encoding

Show GState

Defined in Morley.Michelson.Runtime.GState

Methods

showsPrec :: Int -> GState -> ShowS

show :: GState -> String

showList :: [GState] -> ShowS

Eq GState

Defined in Morley.Michelson.Runtime.GState

Methods

(==) :: GState -> GState -> Bool

(/=) :: GState -> GState -> Bool

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

Initially these addresses have a lot of money.

genesisKeyHashes :: GenesisList KeyHash

KeyHash of genesis address.

genesisAddress :: ImplicitAddress

One of genesis addresses.

More genesisAddresses which can be used in tests

genesisAddress1 :: ImplicitAddress

More genesis addresses

genesisAddress2 :: ImplicitAddress

More genesis addresses

genesisAddress3 :: ImplicitAddress

More genesis addresses

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

More genesis addresses, via a type-level natural

genesisAddressN @7

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

genesisKeyHash :: KeyHash

One of genesis key hashes.

Genesis secret keys

genesisSecretKey :: SecretKey

Secret key assotiated with genesisAddress.

genesisSecrets :: GenesisList SecretKey

Secrets from which genesis addresses are derived from.

initGState :: GState

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

Read GState from a file.

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

Write GState to a file.

Operations on GState

data GStateUpdate where

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

Show GStateUpdate

Defined in Morley.Michelson.Runtime.GState

Methods

showsPrec :: Int -> GStateUpdate -> ShowS

show :: GStateUpdate -> String

showList :: [GStateUpdate] -> ShowS

Buildable GStateUpdate

Defined in Morley.Michelson.Runtime.GState

Methods

build :: GStateUpdate -> Doc

buildList :: [GStateUpdate] -> Doc

data GStateUpdateError

Constructors

GStateAddressExists Address

GStateUnknownAddress Address

GStateStorageNotMatch ContractAddress

GStateNotDelegate ImplicitAddress

GStateCantDeleteDelegate ImplicitAddress

GStateNoBLSDelegate Address KeyHash

GStateAlreadySetDelegate L1Address (Maybe KeyHash)

GStateInsufficientTickets ImplicitAddress TicketKey ("needs" :! Natural) ("has" :! Natural)

Instances

Show GStateUpdateError

Defined in Morley.Michelson.Runtime.GState

Methods

showsPrec :: Int -> GStateUpdateError -> ShowS

show :: GStateUpdateError -> String

showList :: [GStateUpdateError] -> ShowS

Buildable GStateUpdateError

Defined in Morley.Michelson.Runtime.GState

Methods

build :: GStateUpdateError -> Doc

buildList :: [GStateUpdateError] -> Doc

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

Apply GStateUpdate to GState.

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

Apply a list of GStateUpdates to GState.

extractAllContracts :: GState -> TcOriginatedContracts

Retrieve all contracts stored in GState

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

type family AddressStateFam kind where ...

Equations

AddressStateFam 'AddressKindImplicit = ImplicitState

AddressStateFam 'AddressKindContract = ContractState

AddressStateFam 'AddressKindSmartRollup = ()