Safe Haskell	None
Language	Haskell2010

Michelson.Runtime.GState

Contents

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

Description

Global blockchain state (emulated).

Synopsis

data ContractState = ContractState {
- csBalance :: Mutez
- csStorage :: Value
- csContract :: Contract
- csTypedContract :: Maybe SomeContract
- csTypedStorage :: Maybe SomeValue
}
getTypedContract :: GState -> ContractState -> Either TCError SomeContract
getTypedStorage :: GState -> ContractState -> Either TCError SomeValue
data SomeContractAndStorage = (ParameterScope cp, StorageScope st) => SomeContractAndStorage {
- scsContract :: FullContract cp st
- scsStorage :: Value st
}
getTypedContractAndStorage :: (TCError -> err) -> (TCError -> err) -> GState -> ContractState -> Either err SomeContractAndStorage
data AddressState
- = ASSimple Mutez
- | ASContract ContractState
asBalance :: AddressState -> Mutez
data GState = GState {
- gsChainId :: ChainId
- gsAddresses :: Map Address AddressState
}
gsChainIdL :: Lens' GState ChainId
gsAddressesL :: Lens' GState (Map Address AddressState)
genesisAddresses :: NonEmpty Address
genesisKeyHashes :: NonEmpty KeyHash
genesisAddress :: Address
genesisAddress1 :: Address
genesisAddress2 :: Address
genesisAddress3 :: Address
genesisAddress4 :: Address
genesisAddress5 :: Address
genesisAddress6 :: Address
genesisKeyHash :: KeyHash
initGState :: GState
readGState :: FilePath -> IO GState
writeGState :: FilePath -> GState -> IO ()
data GStateUpdate
- = GSAddAddress Address AddressState
- | GSSetStorageValue Address Value SomeValue
- | GSSetBalance Address Mutez
data GStateUpdateError
- = GStateAddressExists Address
- | GStateUnknownAddress Address
- | GStateNotContract 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

ContractState

Fields

csBalance :: Mutez
Amount of mutez owned by this contract.
csStorage :: Value
Storage value associated with this contract.
csContract :: Contract
Contract itself (untyped).
csTypedContract :: Maybe SomeContract
csTypedStorage :: Maybe SomeValue
We keep typed representation of contract code and storage in form, that hides their actual type in order to simplify the rest of the code (e.g. avoid type parameters for ContractState and so on). They are made optional in order to perform safe parsing from JSON (we simply return Nothing in this parser and use getTypedStorage or getTypedContract that optionally typecheck storage or contract code).

Instances

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 #

getTypedContract :: GState -> ContractState -> Either TCError SomeContract Source #

getTypedStorage :: GState -> ContractState -> Either TCError SomeValue Source #

data SomeContractAndStorage Source #

Constructors

(ParameterScope cp, StorageScope st) => SomeContractAndStorage
Fields scsContract :: FullContract cp st scsStorage :: Value st

getTypedContractAndStorage :: (TCError -> err) -> (TCError -> err) -> GState -> ContractState -> Either err SomeContractAndStorage Source #

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

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-0.7.0-LSdrRUk5DEH474ZZZf5NDz" 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.

Instances

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 #

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.

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 Source #

Updates that can be applied to GState.

Constructors

GSAddAddress Address AddressState
GSSetStorageValue Address Value SomeValue
GSSetBalance Address Mutez

Instances

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

Instances

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