EVM

Documentation

blankState :: FrameState

bytecode :: Getter Contract (Expr Buf)

An "external" view of a contract's bytecode, appropriate for e.g. EXTCODEHASH.

Data accessors

currentContract :: VM -> Maybe Contract

Data constructors

makeVm :: VMOpts -> VM

initialContract :: ContractCode -> Contract

Initialize empty contract with given code

Opcode dispatch (exec1)

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

Update program counter

exec1 :: EVM ()

Executes the EVM one step

transfer :: Addr -> Addr -> W256 -> EVM ()

callChecks :: (?op :: Word8) => Contract -> Word64 -> Addr -> Addr -> W256 -> W256 -> W256 -> W256 -> W256 -> [Expr EWord] -> (Word64 -> EVM ()) -> EVM ()

Checks a *CALL for failure; OOG, too many callframes, memory access etc.

precompiledContract :: (?op :: Word8) => Contract -> Word64 -> Addr -> Addr -> W256 -> W256 -> W256 -> W256 -> W256 -> [Expr EWord] -> EVM ()

executePrecompile :: (?op :: Word8) => Addr -> Word64 -> W256 -> W256 -> W256 -> W256 -> [Expr EWord] -> EVM ()

truncpadlit :: Int -> ByteString -> ByteString

lazySlice :: W256 -> W256 -> ByteString -> ByteString

parseModexpLength :: ByteString -> (W256, W256, W256)

isZero :: W256 -> W256 -> ByteString -> Bool

asInteger :: ByteString -> Integer

Opcode helper actions

noop :: Monad m => m ()

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

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

getCodeLocation :: VM -> CodeLocation

query :: Query -> EVM ()

choose :: Choose -> EVM ()

branch :: CodeLocation -> Expr EWord -> (Bool -> EVM ()) -> EVM ()

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

Construct RPC Query and halt execution until resolved

accessStorage :: Addr -> Expr EWord -> (Expr EWord -> EVM ()) -> EVM ()

accountExists :: Addr -> VM -> Bool

accountEmpty :: Contract -> Bool

How to finalize a transaction

finalize :: EVM ()

loadContract :: Addr -> EVM ()

Loads the selected contract as the current contract to execute

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

notStatic :: EVM () -> EVM ()

burn :: Word64 -> EVM () -> EVM ()

Burn gas, failing if insufficient gas is available

forceConcrete :: Expr EWord -> String -> (W256 -> EVM ()) -> EVM ()

forceConcrete2 :: (Expr EWord, Expr EWord) -> String -> ((W256, W256) -> EVM ()) -> EVM ()

forceConcrete3 :: (Expr EWord, Expr EWord, Expr EWord) -> String -> ((W256, W256, W256) -> EVM ()) -> EVM ()

forceConcrete4 :: (Expr EWord, Expr EWord, Expr EWord, Expr EWord) -> String -> ((W256, W256, W256, W256) -> EVM ()) -> EVM ()

forceConcrete5 :: (Expr EWord, Expr EWord, Expr EWord, Expr EWord, Expr EWord) -> String -> ((W256, W256, W256, W256, W256) -> EVM ()) -> EVM ()

forceConcrete6 :: (Expr EWord, Expr EWord, Expr EWord, Expr EWord, Expr EWord, Expr EWord) -> String -> ((W256, W256, W256, W256, W256, W256) -> EVM ()) -> EVM ()

forceConcreteBuf :: Expr Buf -> String -> (ByteString -> EVM ()) -> EVM ()

Substate manipulation

refund :: Word64 -> EVM ()

unRefund :: Word64 -> EVM ()

touchAccount :: Addr -> EVM ()

selfdestruct :: Addr -> EVM ()

accessAndBurn :: Addr -> EVM () -> EVM ()

accessAccountForGas :: Addr -> EVM Bool

returns a wrapped boolean- if true, this address has been touched before in the txn (warm gas cost as in EIP 2929) otherwise cold

accessStorageForGas :: Addr -> Expr EWord -> EVM Bool

returns a wrapped boolean- if true, this slot has been touched before in the txn (warm gas cost as in EIP 2929) otherwise cold

Cheat codes

cheatCode :: Addr

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

type CheatAction = Expr EWord -> Expr EWord -> Expr Buf -> EVM ()

cheatActions :: Map FunctionSelector CheatAction

General call implementation ("delegateCall")

delegateCall :: (?op :: Word8) => Contract -> Word64 -> Expr EWord -> Expr EWord -> W256 -> W256 -> W256 -> W256 -> W256 -> [Expr EWord] -> (Addr -> EVM ()) -> EVM ()

collision :: Maybe Contract -> Bool

create :: (?op :: Word8) => Addr -> Contract -> W256 -> Word64 -> W256 -> [Expr EWord] -> Addr -> Expr Buf -> EVM ()

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

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

replaceCodeOfSelf :: ContractCode -> EVM ()

resetState :: EVM ()

VM error implementation

vmError :: EvmError -> EVM ()

partial :: PartialExec -> EVM ()

wrap :: Typeable a => [Expr a] -> [SomeExpr]

underrun :: EVM ()

data FrameResult

A stack frame can be popped in three ways.

Constructors

FrameReturned (Expr Buf)

STOP, RETURN, or no more code

FrameReverted (Expr Buf)

REVERT

FrameErrored EvmError

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.

Memory helpers

accessUnboundedMemoryRange :: Word64 -> Word64 -> EVM () -> EVM ()

accessMemoryRange :: W256 -> W256 -> EVM () -> EVM ()

accessMemoryWord :: W256 -> EVM () -> EVM ()

copyBytesToMemory :: Expr Buf -> Expr EWord -> Expr EWord -> Expr EWord -> EVM ()

copyCallBytesToMemory :: Expr Buf -> Expr EWord -> Expr EWord -> Expr EWord -> EVM ()

readMemory :: Expr EWord -> Expr EWord -> VM -> Expr Buf

Tracing

withTraceLocation :: TraceData -> EVM Trace

pushTrace :: TraceData -> EVM ()

insertTrace :: TraceData -> EVM ()

popTrace :: EVM ()

zipperRootForest :: TreePos Empty a -> Forest a

traceForest :: VM -> Forest Trace

traceTopLog :: [Expr Log] -> EVM ()

Stack manipulation

push :: W256 -> EVM ()

pushSym :: Expr EWord -> EVM ()

stackOp1 :: (?op :: Word8) => Word64 -> (Expr EWord -> Expr EWord) -> EVM ()

stackOp2 :: (?op :: Word8) => Word64 -> ((Expr EWord, Expr EWord) -> Expr EWord) -> EVM ()

stackOp3 :: (?op :: Word8) => Word64 -> ((Expr EWord, Expr EWord, Expr EWord) -> Expr EWord) -> EVM ()

Bytecode data functions

use' :: (VM -> a) -> EVM a

checkJump :: Int -> [Expr EWord] -> EVM ()

isValidJumpDest :: VM -> Int -> Bool

opSize :: Word8 -> Int

mkOpIxMap :: ContractCode -> Vector Int

vmOp :: VM -> Maybe Op

vmOpIx :: VM -> Maybe Int

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

Gas cost calculation helpers

costOfCall :: FeeSchedule Word64 -> Bool -> W256 -> Word64 -> Word64 -> Addr -> EVM (Word64, Word64)

costOfCreate :: FeeSchedule Word64 -> Word64 -> W256 -> Bool -> (Word64, Word64)

concreteModexpGasFee :: ByteString -> Word64

costOfPrecompile :: FeeSchedule Word64 -> Addr -> Expr Buf -> Word64

memoryCost :: FeeSchedule Word64 -> Word64 -> Word64

hashcode :: ContractCode -> Expr EWord

opslen :: ContractCode -> Int

The length of the code ignoring any constructor args. This represents the region that can contain executable opcodes

codelen :: ContractCode -> Expr EWord

The length of the code including any constructor args. This can return an abstract value

toBuf :: ContractCode -> Expr Buf

codeloc :: EVM CodeLocation

Arithmetic

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

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

log2 :: FiniteBits b => b -> Int