Safe Haskell	None
Language	Haskell2010

EVM

Contents

Data types
Data accessors
Data constructors
Opcode dispatch (exec1)
Opcode helper actions
Cheat codes
General call implementation ("delegateCall")
VM error implementation
Memory helpers
Tracing
Stack manipulation
Bytecode data functions
Gas cost calculation helpers
Arithmetic
Emacs setup

Synopsis

data Error
- = BalanceTooLow Word Word
- | UnrecognizedOpcode Word8
- | SelfDestruction
- | StackUnderrun
- | BadJumpDestination
- | Revert ByteString
- | NoSuchContract Addr
- | OutOfGas Word Word
- | BadCheatCode Word32
- | StackLimitExceeded
- | IllegalOverflow
- | Query Query
- | PrecompiledContractError Int
- | StateChangeWhileStatic
data VMResult
- = VMFailure Error
- | VMSuccess ByteString
data VM = VM {
- _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
}
data Trace = Trace {
- _traceCodehash :: W256
- _traceOpIx :: Int
- _traceData :: TraceData
}
data TraceData
- = EventTrace Log
- | FrameTrace FrameContext
- | QueryTrace Query
- | ErrorTrace Error
- | EntryTrace Text
- | ReturnTrace ByteString FrameContext
data ExecMode
- = ExecuteNormally
- | ExecuteAsVMTest
data Query where
- PleaseFetchContract :: Addr -> (Contract -> EVM ()) -> Query
- PleaseFetchSlot :: Addr -> Word -> (Word -> EVM ()) -> Query
type EVM a = State VM a
data Cache = Cache {
- _fetched :: Map Addr Contract
}
data VMOpts = VMOpts {
- 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
}
data Log = Log Addr ByteString [Word]
data Frame = Frame {
- _frameContext :: FrameContext
- _frameState :: FrameState
}
data FrameContext
- = CreationContext {
  - creationContextCodehash :: W256
  }
- | CallContext {
  - callContextOffset :: Word
  - callContextSize :: Word
  - callContextCodehash :: W256
  - callContextAbi :: Maybe Word
  - callContextData :: ByteString
  - callContextReversion :: Map Addr Contract
  }
data FrameState = FrameState {
- _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
}
data TxState = TxState {
- _selfdestructs :: [Addr]
- _refunds :: [(Addr, Word)]
}
data Contract = Contract {
- _bytecode :: ByteString
- _storage :: Map Word Word
- _balance :: Word
- _nonce :: Word
- _codehash :: W256
- _codesize :: Int
- _opIxMap :: Vector Int
- _codeOps :: Vector (Int, Op)
- _external :: Bool
}
data Env = Env {
- _contracts :: Map Addr Contract
- _sha3Crack :: Map Word ByteString
- _origin :: Addr
}
data Block = Block {
- _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
currentContract :: VM -> Maybe Contract
makeVm :: VMOpts -> VM
initialContract :: ByteString -> Contract
next :: (?op :: Word8) => EVM ()
exec1 :: EVM ()
precompiledContract :: (?op :: Word8) => EVM ()
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 :: Addr -> Word -> (Word -> EVM ()) -> EVM ()
replaceCode :: Addr -> ByteString -> EVM ()
replaceCodeOfSelf :: ByteString -> EVM ()
resetState :: EVM ()
finalize :: EVM ()
loadContract :: Addr -> EVM ()
limitStack :: Int -> EVM () -> EVM ()
notStatic :: EVM () -> EVM ()
burn :: Word -> EVM () -> EVM ()
refund :: Word -> EVM ()
cheatCode :: Addr
cheat :: (?op :: Word8) => (Word, Word) -> (Word, Word) -> EVM ()
type CheatAction = ([AbiType], [AbiValue] -> EVM (Maybe AbiValue))
cheatActions :: Map Word32 CheatAction
delegateCall :: (?op :: Word8) => FeeSchedule Word -> Word -> Addr -> Word -> Word -> Word -> Word -> [Word] -> EVM () -> EVM ()
underrun :: EVM ()
data FrameResult
- = FrameReturned ByteString
- | FrameReverted ByteString
- | FrameErrored Error
finishFrame :: FrameResult -> EVM ()
vmError :: Error -> EVM ()
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
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 ()
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 ()
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)
costOfCall :: FeeSchedule Word -> Maybe a -> Word -> Word -> Word -> (Word, Word)
memoryCost :: FeeSchedule Word -> Word -> Word
ceilDiv :: (Num a, Integral a) => a -> a -> a
allButOne64th :: (Num a, Integral a) => a -> a
log2 :: FiniteBits b => b -> Int

Data types

data Error Source #

Instances

Show Error Source #
Instance details Defined in EVM Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #

data VMResult Source #

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 Source #
Instance details Defined in EVM Methods showsPrec :: Int -> VMResult -> ShowS # show :: VMResult -> String # showList :: [VMResult] -> ShowS #
SDisplay VMResult Source #
Instance details Defined in EVM.Emacs Methods sexp :: VMResult -> SExpr Text Source #

data VM Source #

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 Source #
Instance details Defined in EVM.Emacs Methods sexp :: VM -> SExpr Text Source #

data Trace Source #

Constructors

Trace
Fields _traceCodehash :: W256 _traceOpIx :: Int _traceData :: TraceData

data TraceData Source #

Constructors

EventTrace Log
FrameTrace FrameContext
QueryTrace Query
ErrorTrace Error
EntryTrace Text
ReturnTrace ByteString FrameContext

data ExecMode Source #

Constructors

ExecuteNormally
ExecuteAsVMTest

data Query where Source #

Constructors

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

Instances

Show Query Source #
Instance details Defined in EVM Methods showsPrec :: Int -> Query -> ShowS # show :: Query -> String # showList :: [Query] -> ShowS #

type EVM a = State VM a Source #

Alias for the type of e.g. exec1.

data Cache Source #

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 Source #
Instance details Defined in EVM Methods (<>) :: Cache -> Cache -> Cache # sconcat :: NonEmpty Cache -> Cache # stimes :: Integral b => b -> Cache -> Cache #
Monoid Cache Source #
Instance details Defined in EVM Methods mempty :: Cache # mappend :: Cache -> Cache -> Cache # mconcat :: [Cache] -> Cache #

data VMOpts Source #

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 Source #
Instance details Defined in EVM Methods showsPrec :: Int -> VMOpts -> ShowS # show :: VMOpts -> String # showList :: [VMOpts] -> ShowS #

data Log Source #

A log entry

Constructors

Log Addr ByteString [Word]

data Frame Source #

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

Constructors

Frame
Fields _frameContext :: FrameContext _frameState :: FrameState

Instances

SDisplay Frame Source #
Instance details Defined in EVM.Emacs Methods sexp :: Frame -> SExpr Text Source #

data FrameContext Source #

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 Source #
Instance details Defined in EVM.Emacs Methods sexp :: FrameContext -> SExpr Text Source #

data FrameState Source #

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 Source #
Instance details Defined in EVM.Emacs Methods sexp :: FrameState -> SExpr Text Source #

data TxState Source #

The state that spans a whole transaction

Constructors

TxState
Fields _selfdestructs :: [Addr] _refunds :: [(Addr, Word)]

data Contract Source #

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 Source #
Instance details Defined in EVM Methods (==) :: Contract -> Contract -> Bool # (/=) :: Contract -> Contract -> Bool #
Show Contract Source #
Instance details Defined in EVM Methods showsPrec :: Int -> Contract -> ShowS # show :: Contract -> String # showList :: [Contract] -> ShowS #
SDisplay Contract Source #
Instance details Defined in EVM.Emacs Methods sexp :: Contract -> SExpr Text Source #

data Env Source #

Various environmental data

Constructors

Env
Fields _contracts :: Map Addr Contract _sha3Crack :: Map Word ByteString _origin :: Addr

data Block Source #

Data about the block

Constructors

Block
Fields _coinbase :: Addr _timestamp :: Word _number :: Word _difficulty :: Word _gaslimit :: Word _gasprice :: Word _schedule :: FeeSchedule Word

blankState :: FrameState Source #

static :: Lens' FrameState Bool Source #

stack :: Lens' FrameState [Word] Source #

returndata :: Lens' FrameState ByteString Source #

pc :: Lens' FrameState Int Source #

memorySize :: Lens' FrameState Int Source #

memory :: Lens' FrameState ByteString Source #

gas :: Lens' FrameState Word Source #

contract :: Lens' FrameState Addr Source #

codeContract :: Lens' FrameState Addr Source #

code :: Lens' FrameState ByteString Source #

callvalue :: Lens' FrameState Word Source #

caller :: Lens' FrameState Addr Source #

calldata :: Lens' FrameState ByteString Source #

frameState :: Lens' Frame FrameState Source #

frameContext :: Lens' Frame FrameContext Source #

timestamp :: Lens' Block Word Source #

schedule :: Lens' Block (FeeSchedule Word) Source #

number :: Lens' Block Word Source #

gasprice :: Lens' Block Word Source #

gaslimit :: Lens' Block Word Source #

difficulty :: Lens' Block Word Source #

coinbase :: Lens' Block Addr Source #

selfdestructs :: Lens' TxState [Addr] Source #

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

storage :: Lens' Contract (Map Word Word) Source #

opIxMap :: Lens' Contract (Vector Int) Source #

nonce :: Lens' Contract Word Source #

external :: Lens' Contract Bool Source #

codesize :: Lens' Contract Int Source #

codehash :: Lens' Contract W256 Source #

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

bytecode :: Lens' Contract ByteString Source #

balance :: Lens' Contract Word Source #

sha3Crack :: Lens' Env (Map Word ByteString) Source #

origin :: Lens' Env Addr Source #

contracts :: Lens' Env (Map Addr Contract) Source #

fetched :: Iso' Cache (Map Addr Contract) Source #

traceOpIx :: Lens' Trace Int Source #

traceData :: Lens' Trace TraceData Source #

traceCodehash :: Lens' Trace W256 Source #

tx :: Lens' VM TxState Source #

traces :: Lens' VM (TreePos Empty Trace) Source #

state :: Lens' VM FrameState Source #

result :: Lens' VM (Maybe VMResult) Source #

logs :: Lens' VM (Seq Log) Source #

frames :: Lens' VM [Frame] Source #

execMode :: Lens' VM ExecMode Source #

env :: Lens' VM Env Source #

cache :: Lens' VM Cache Source #

burned :: Lens' VM Word Source #

block :: Lens' VM Block Source #

Data accessors

currentContract :: VM -> Maybe Contract Source #

Data constructors

makeVm :: VMOpts -> VM Source #

initialContract :: ByteString -> Contract Source #

Opcode dispatch (exec1)

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

exec1 :: EVM () Source #

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

Opcode helper actions

noop :: Monad m => m () Source #

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

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

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

accessStorage Source #

Arguments

:: Addr	Contract address
-> Word	Storage slot key
-> (Word -> EVM ())	Continuation
-> EVM ()

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

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

replaceCodeOfSelf :: ByteString -> EVM () Source #

resetState :: EVM () Source #

finalize :: EVM () Source #

loadContract :: Addr -> EVM () Source #

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

notStatic :: EVM () -> EVM () Source #

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

refund :: Word -> EVM () Source #

Cheat codes

cheatCode :: Addr Source #

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

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

cheatActions :: Map Word32 CheatAction Source #

General call implementation ("delegateCall")

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

VM error implementation

underrun :: EVM () Source #

data FrameResult Source #

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 Source #
Instance details Defined in EVM Methods showsPrec :: Int -> FrameResult -> ShowS # show :: FrameResult -> String # showList :: [FrameResult] -> ShowS #

finishFrame :: FrameResult -> EVM () Source #

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

Memory helpers

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

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

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

readMemory :: Word -> Word -> VM -> ByteString Source #

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

Tracing

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

pushTrace :: TraceData -> EVM () Source #

insertTrace :: TraceData -> EVM () Source #

popTrace :: EVM () Source #

zipperRootForest :: TreePos Empty a -> Forest a Source #

traceForest :: VM -> Forest Trace Source #

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

Stack manipulation

push :: Word -> EVM () Source #

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

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

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

Bytecode data functions

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

insidePushData :: Int -> EVM Bool Source #

opSize :: Word8 -> Int Source #

mkOpIxMap :: ByteString -> Vector Int Source #

vmOp :: VM -> Maybe Op Source #

vmOpIx :: VM -> Maybe Int Source #

opParams :: VM -> Map String Word Source #

readOp :: Word8 -> ByteString -> Op Source #

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

Gas cost calculation helpers

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

memoryCost :: FeeSchedule Word -> Word -> Word Source #

Arithmetic

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

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

log2 :: FiniteBits b => b -> Int Source #

BalanceTooLow Word Word
UnrecognizedOpcode Word8
SelfDestruction
StackUnderrun
BadJumpDestination
Revert ByteString
NoSuchContract Addr
OutOfGas Word Word
BadCheatCode Word32
StackLimitExceeded
IllegalOverflow
Query Query
PrecompiledContractError Int
StateChangeWhileStatic

Data types

Data accessors

Data constructors

Opcode dispatch (exec1)

Opcode helper actions

Cheat codes

General call implementation ("delegateCall")

VM error implementation

Memory helpers

Tracing

Stack manipulation

Bytecode data functions

Gas cost calculation helpers

Arithmetic

Emacs setup