EVM

Data types

data Error

Constructors

BalanceTooLow Word Word

UnrecognizedOpcode Word8

SelfDestruction

StackUnderrun

BadJumpDestination

Revert ByteString

NoSuchContract Addr

OutOfGas Word Word

BadCheatCode Word32

StackLimitExceeded

IllegalOverflow

Query Query

PrecompiledContractError Int

StateChangeWhileStatic

Instances

Show Error

Defined in EVM

Methods

showsPrec :: Int -> Error -> ShowS

show :: Error -> String

showList :: [Error] -> ShowS

data VMResult

The possible result states of a VM

Constructors

VMFailure Error

An operation failed

VMSuccess ByteString

Reached STOP, RETURN, or end-of-code

Instances

Show VMResult

Defined in EVM

Methods

showsPrec :: Int -> VMResult -> ShowS

show :: VMResult -> String

showList :: [VMResult] -> ShowS

SDisplay VMResult

Defined in EVM.Emacs

Methods

sexp :: VMResult -> SExpr Text

data VM

The state of a stepwise EVM execution

Constructors

VM

Fields

• _result :: Maybe VMResult
• _state :: FrameState
• _frames :: [Frame]
• _env :: Env
• _block :: Block
• _tx :: TxState
• _logs :: Seq Log
• _traces :: TreePos Empty Trace
• _cache :: Cache
• _execMode :: ExecMode
• _burned :: Word

Instances

SDisplay VM

Defined in EVM.Emacs

Methods

sexp :: VM -> SExpr Text

data Trace

Constructors

Trace

Fields

• _traceCodehash :: W256
• _traceOpIx :: Int
• _traceData :: TraceData

data TraceData

Constructors

EventTrace Log

FrameTrace FrameContext

QueryTrace Query

ErrorTrace Error

EntryTrace Text

ReturnTrace ByteString FrameContext

data ExecMode

Constructors

ExecuteNormally

ExecuteAsVMTest

data Query where

Constructors

PleaseFetchContract :: Addr -> (Contract -> EVM ()) -> Query

PleaseFetchSlot :: Addr -> Word -> (Word -> EVM ()) -> Query

Instances

Show Query

Defined in EVM

Methods

showsPrec :: Int -> Query -> ShowS

show :: Query -> String

showList :: [Query] -> ShowS

type EVM a = State VM a

Alias for the type of e.g. exec1.

data Cache

The cache is data that can be persisted for efficiency: any expensive query that is constant at least within a block.

Constructors

Cache

Fields

• _fetched :: Map Addr Contract

Instances

Semigroup Cache

Defined in EVM

Methods

(<>) :: Cache -> Cache -> Cache

sconcat :: NonEmpty Cache -> Cache

stimes :: Integral b => b -> Cache -> Cache

Monoid Cache

Defined in EVM

Methods

mempty :: Cache

mappend :: Cache -> Cache -> Cache

mconcat :: [Cache] -> Cache

data VMOpts

A way to specify an initial VM state

Constructors

VMOpts

Fields

• vmoptCode :: ByteString
• vmoptCalldata :: ByteString
• vmoptValue :: W256
• vmoptAddress :: Addr
• vmoptCaller :: Addr
• vmoptOrigin :: Addr
• vmoptGas :: W256
• vmoptNumber :: W256
• vmoptTimestamp :: W256
• vmoptCoinbase :: Addr
• vmoptDifficulty :: W256
• vmoptGaslimit :: W256
• vmoptGasprice :: W256
• vmoptSchedule :: FeeSchedule Word

Instances

Show VMOpts

Defined in EVM

Methods

showsPrec :: Int -> VMOpts -> ShowS

show :: VMOpts -> String

showList :: [VMOpts] -> ShowS

data Log

A log entry

Constructors

Log Addr ByteString [Word]

data Frame

An entry in the VM's "call/create stack"

Constructors

Frame

Fields

• _frameContext :: FrameContext
• _frameState :: FrameState

Instances

SDisplay Frame

Defined in EVM.Emacs

Methods

sexp :: Frame -> SExpr Text

data FrameContext

Call/create info

Constructors

CreationContext

Fields

• creationContextCodehash :: W256

CallContext

Fields

• callContextOffset :: Word
• callContextSize :: Word
• callContextCodehash :: W256
• callContextAbi :: Maybe Word
• callContextData :: ByteString
• callContextReversion :: Map Addr Contract

Instances

SDisplay FrameContext

Defined in EVM.Emacs

Methods

sexp :: FrameContext -> SExpr Text

data FrameState

The "registers" of the VM along with memory and data stack

Constructors

FrameState

Fields

• _contract :: Addr
• _codeContract :: Addr
• _code :: ByteString
• _pc :: Int
• _stack :: [Word]
• _memory :: ByteString
• _memorySize :: Int
• _calldata :: ByteString
• _callvalue :: Word
• _caller :: Addr
• _gas :: Word
• _returndata :: ByteString
• _static :: Bool

Instances

SDisplay FrameState

Defined in EVM.Emacs

Methods

sexp :: FrameState -> SExpr Text

data TxState

The state that spans a whole transaction

Constructors

TxState

Fields

• _selfdestructs :: [Addr]
• _refunds :: [(Addr, Word)]

data Contract

The state of a contract

Constructors

Contract

Fields

• _bytecode :: ByteString
• _storage :: Map Word Word
• _balance :: Word
• _nonce :: Word
• _codehash :: W256
• _codesize :: Int
• _opIxMap :: Vector Int
• _codeOps :: Vector (Int, Op)
• _external :: Bool

Instances

Eq Contract

Defined in EVM

Methods

(==) :: Contract -> Contract -> Bool

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

Show Contract

Defined in EVM

Methods

showsPrec :: Int -> Contract -> ShowS

show :: Contract -> String

showList :: [Contract] -> ShowS

SDisplay Contract

Defined in EVM.Emacs

Methods

sexp :: Contract -> SExpr Text

data Env

Various environmental data

Constructors

Env

Fields

• _contracts :: Map Addr Contract
• _sha3Crack :: Map Word ByteString
• _origin :: Addr

data Block

Data about the block

Constructors

Block

Fields

• _coinbase :: Addr
• _timestamp :: Word
• _number :: Word
• _difficulty :: Word
• _gaslimit :: Word
• _gasprice :: Word
• _schedule :: FeeSchedule Word

blankState :: FrameState

static :: Lens' FrameState Bool

stack :: Lens' FrameState [Word]

returndata :: Lens' FrameState ByteString

pc :: Lens' FrameState Int

memorySize :: Lens' FrameState Int

memory :: Lens' FrameState ByteString

gas :: Lens' FrameState Word

contract :: Lens' FrameState Addr

codeContract :: Lens' FrameState Addr

code :: Lens' FrameState ByteString

callvalue :: Lens' FrameState Word

caller :: Lens' FrameState Addr

calldata :: Lens' FrameState ByteString

frameState :: Lens' Frame FrameState

frameContext :: Lens' Frame FrameContext

timestamp :: Lens' Block Word

schedule :: Lens' Block (FeeSchedule Word)

number :: Lens' Block Word

gasprice :: Lens' Block Word

gaslimit :: Lens' Block Word

difficulty :: Lens' Block Word

coinbase :: Lens' Block Addr

selfdestructs :: Lens' TxState [Addr]

refunds :: Lens' TxState [(Addr, Word)]

storage :: Lens' Contract (Map Word Word)

opIxMap :: Lens' Contract (Vector Int)

nonce :: Lens' Contract Word

external :: Lens' Contract Bool

codesize :: Lens' Contract Int

codehash :: Lens' Contract W256

codeOps :: Lens' Contract (Vector (Int, Op))

bytecode :: Lens' Contract ByteString

balance :: Lens' Contract Word

sha3Crack :: Lens' Env (Map Word ByteString)

origin :: Lens' Env Addr

contracts :: Lens' Env (Map Addr Contract)

fetched :: Iso' Cache (Map Addr Contract)

traceOpIx :: Lens' Trace Int

traceData :: Lens' Trace TraceData

traceCodehash :: Lens' Trace W256

tx :: Lens' VM TxState

traces :: Lens' VM (TreePos Empty Trace)

state :: Lens' VM FrameState

result :: Lens' VM (Maybe VMResult)

logs :: Lens' VM (Seq Log)

frames :: Lens' VM [Frame]

execMode :: Lens' VM ExecMode

env :: Lens' VM Env

cache :: Lens' VM Cache

burned :: Lens' VM Word

block :: Lens' VM Block

Data accessors

currentContract :: VM -> Maybe Contract

Data constructors

makeVm :: VMOpts -> VM

initialContract :: ByteString -> Contract

Opcode dispatch (exec1)

next :: (?op :: Word8) => EVM ()

exec1 :: EVM ()

precompiledContract :: (?op :: Word8) => EVM ()

Opcode helper actions

noop :: Monad m => m ()

pushTo :: MonadState s m => ASetter s s [a] [a] -> a -> m ()

pushToSequence :: MonadState s m => ASetter s s (Seq a) (Seq a) -> a -> m ()

touchAccount :: Addr -> (Contract -> EVM ()) -> EVM ()

accessStorage

Arguments

:: Addr

Contract address

-> Word

Storage slot key

-> (Word -> EVM ())

Continuation

-> EVM ()

replaceCode :: Addr -> ByteString -> EVM ()

Replace a contract's code, like when CREATE returns from the constructor code.

replaceCodeOfSelf :: ByteString -> EVM ()

resetState :: EVM ()

finalize :: EVM ()

loadContract :: Addr -> EVM ()

limitStack :: Int -> EVM () -> EVM ()

notStatic :: EVM () -> EVM ()

burn :: Word -> EVM () -> EVM ()

refund :: Word -> EVM ()

Cheat codes

cheatCode :: Addr

cheat :: (?op :: Word8) => (Word, Word) -> (Word, Word) -> EVM ()

type CheatAction = ([AbiType], [AbiValue] -> EVM (Maybe AbiValue))

cheatActions :: Map Word32 CheatAction

General call implementation ("delegateCall")

delegateCall :: (?op :: Word8) => FeeSchedule Word -> Word -> Addr -> Word -> Word -> Word -> Word -> [Word] -> EVM () -> EVM ()

VM error implementation

underrun :: EVM ()

data FrameResult

A stack frame can be popped in three ways.

Constructors

FrameReturned ByteString

STOP, RETURN, or no more code

FrameReverted ByteString

REVERT

FrameErrored Error

Any other error

Instances

Show FrameResult

Defined in EVM

Methods

showsPrec :: Int -> FrameResult -> ShowS

show :: FrameResult -> String

showList :: [FrameResult] -> ShowS

finishFrame :: FrameResult -> EVM ()

This function defines how to pop the current stack frame in either of the ways specified by FrameResult.

It also handles the case when the current stack frame is the only one; in this case, we set the final _result of the VM execution.

vmError :: Error -> EVM ()

Memory helpers

accessMemoryRange :: FeeSchedule Word -> Word -> Word -> EVM () -> EVM ()

accessMemoryWord :: FeeSchedule Word -> Word -> EVM () -> EVM ()

copyBytesToMemory :: ByteString -> Word -> Word -> Word -> EVM ()

readMemory :: Word -> Word -> VM -> ByteString

word256At :: Functor f => Word -> (Word -> f Word) -> ByteString -> f ByteString

Tracing

withTraceLocation :: MonadState VM m => TraceData -> m Trace

pushTrace :: TraceData -> EVM ()

insertTrace :: TraceData -> EVM ()

popTrace :: EVM ()

zipperRootForest :: TreePos Empty a -> Forest a

traceForest :: VM -> Forest Trace

traceLog :: MonadState VM m => Log -> m ()

Stack manipulation

push :: Word -> EVM ()

stackOp1 :: (?op :: Word8) => (Word -> Word) -> (Word -> Word) -> EVM ()

stackOp2 :: (?op :: Word8) => ((Word, Word) -> Word) -> ((Word, Word) -> Word) -> EVM ()

stackOp3 :: (?op :: Word8) => ((Word, Word, Word) -> Word) -> ((Word, Word, Word) -> Word) -> EVM ()

Bytecode data functions

checkJump :: Integral n => n -> [Word] -> EVM ()

insidePushData :: Int -> EVM Bool

opSize :: Word8 -> Int

mkOpIxMap :: ByteString -> Vector Int

vmOp :: VM -> Maybe Op

vmOpIx :: VM -> Maybe Int

opParams :: VM -> Map String Word

readOp :: Word8 -> ByteString -> Op

mkCodeOps :: ByteString -> Vector (Int, Op)

Gas cost calculation helpers

costOfCall :: FeeSchedule Word -> Maybe a -> Word -> Word -> Word -> (Word, Word)

memoryCost :: FeeSchedule Word -> Word -> Word

Arithmetic

ceilDiv :: (Num a, Integral a) => a -> a -> a

allButOne64th :: (Num a, Integral a) => a -> a

log2 :: FiniteBits b => b -> Int

Emacs setup