Safe Haskell	None
Language	Haskell2010

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
}
data AddressState
- = ASSimple Mutez
- | ASContract ContractState
asBalance :: AddressState -> Mutez
data GState = GState {
- gsChainId :: ChainId
- gsAddresses :: Map Address AddressState
- gsCounter :: GlobalCounter
}
gsChainIdL :: Lens' GState ChainId
gsAddressesL :: Lens' GState (Map Address AddressState)
gsCounterL :: Lens' GState GlobalCounter
genesisAddresses :: NonEmpty Address
genesisKeyHashes :: NonEmpty KeyHash
genesisAddress :: Address
genesisAddress1 :: Address
genesisAddress2 :: Address
genesisAddress3 :: Address
genesisAddress4 :: Address
genesisAddress5 :: Address
genesisAddress6 :: Address
genesisKeyHash :: KeyHash
genesisSecretKey :: SecretKey
genesisSecrets :: NonEmpty SecretKey
initGState :: GState
readGState :: FilePath -> IO GState
writeGState :: FilePath -> GState -> IO ()
data GStateUpdate where
- GSAddAddress :: Address -> AddressState -> GStateUpdate
- GSSetStorageValue :: StorageScope st => Address -> Value st -> GStateUpdate
- GSSetBalance :: Address -> Mutez -> GStateUpdate
- GSIncrementCounter :: GStateUpdate
data GStateUpdateError
- = GStateAddressExists Address
- | GStateUnknownAddress Address
- | GStateNotContract Address
- | GStateStorageNotMatch Address
applyUpdate :: GStateUpdate -> GState -> Either GStateUpdateError GState
applyUpdates :: [GStateUpdate] -> GState -> Either GStateUpdateError GState
extractAllContracts :: GState -> TcOriginatedContracts

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.

Instances

Instances details

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

data AddressState Source #

State of an arbitrary address.

Constructors

ASSimple Mutez	For contracts without code we store only its balance.
ASContract ContractState	For contracts with code we store more state represented by `ContractState`.

Instances

Instances details

Show AddressState Source #
Instance details Defined in Michelson.Runtime.GState Methods showsPrec :: Int -> AddressState -> ShowS # show :: AddressState -> String # showList :: [AddressState] -> ShowS #
Generic AddressState Source #
Instance details Defined in Michelson.Runtime.GState Associated Types type Rep AddressState :: Type -> Type # Methods from :: AddressState -> Rep AddressState x # to :: Rep AddressState x -> AddressState #
ToJSON AddressState Source #
Instance details Defined in Michelson.Runtime.GState Methods toJSON :: AddressState -> Value # toEncoding :: AddressState -> Encoding # toJSONList :: [AddressState] -> Value # toEncodingList :: [AddressState] -> Encoding #
FromJSON AddressState Source #
Instance details Defined in Michelson.Runtime.GState Methods parseJSON :: Value -> Parser AddressState # parseJSONList :: Value -> Parser [AddressState] #
Buildable AddressState Source #
Instance details Defined in Michelson.Runtime.GState Methods build :: AddressState -> Builder #
type Rep AddressState Source #
Instance details Defined in Michelson.Runtime.GState type Rep AddressState = D1 ('MetaData "AddressState" "Michelson.Runtime.GState" "morley-1.7.0-inplace" 'False) (C1 ('MetaCons "ASSimple" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Mutez)) :+: C1 ('MetaCons "ASContract" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ContractState)))

asBalance :: AddressState -> Mutez Source #

Extract balance from AddressState.

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. gsAddresses :: Map Address AddressState All known addresses and their state. gsCounter :: GlobalCounter Ever increasing operation counter.

Instances

Instances details

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

gsChainIdL :: Lens' GState ChainId Source #

gsAddressesL :: Lens' GState (Map Address AddressState) Source #

gsCounterL :: Lens' GState GlobalCounter Source #

genesisAddresses :: NonEmpty Address Source #

Initially these addresses have a lot of money.

genesisKeyHashes :: NonEmpty KeyHash Source #

KeyHash of genesis address.

genesisAddress :: Address Source #

One of genesis addresses.

More genesisAddresses which can be used in tests

genesisAddress1 :: Address Source #

More genesis addresses

We know size of genesisAddresses, so it is safe to use !!

genesisAddress2 :: Address Source #

More genesis addresses

We know size of genesisAddresses, so it is safe to use !!

genesisAddress3 :: Address Source #

More genesis addresses

We know size of genesisAddresses, so it is safe to use !!

genesisAddress4 :: Address Source #

genesisAddress5 :: Address Source #

genesisAddress6 :: Address Source #

genesisKeyHash :: KeyHash Source #

One of genesis key hashes.

Genesis secret keys

genesisSecretKey :: SecretKey Source #

Secret key assotiated with genesisAddress.

genesisSecrets :: NonEmpty 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

GSAddAddress :: Address -> AddressState -> GStateUpdate
GSSetStorageValue :: StorageScope st => Address -> Value st -> GStateUpdate
GSSetBalance :: Address -> Mutez -> GStateUpdate
GSIncrementCounter :: GStateUpdate

Instances

Instances details

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

data GStateUpdateError Source #

Constructors

GStateAddressExists Address
GStateUnknownAddress Address
GStateNotContract Address
GStateStorageNotMatch Address

Instances

Instances details

Show GStateUpdateError Source #
Instance details Defined in Michelson.Runtime.GState Methods showsPrec :: Int -> GStateUpdateError -> ShowS # show :: GStateUpdateError -> String # showList :: [GStateUpdateError] -> ShowS #
Buildable GStateUpdateError Source #
Instance details Defined in 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 #

Retrive all contracts stored in GState