| Safe Haskell | Safe-Inferred |
|---|---|
| Language | GHC2021 |
EVM
Contents
- Data accessors
- Data constructors
- Opcode dispatch (exec1)
- Opcode helper actions
- How to finalize a transaction
- Substate manipulation
- Cheat codes
- General call implementation ("delegateCall")
- VM error implementation
- Memory helpers
- Tracing
- Stack manipulation
- Bytecode data functions
- Gas cost calculation helpers
- Arithmetic
Synopsis
- blankState :: ST s (FrameState s)
- bytecode :: Getter Contract (Maybe (Expr Buf))
- currentContract :: VM s -> Maybe Contract
- makeVm :: VMOpts -> ST s (VM s)
- unknownContract :: Expr EAddr -> Contract
- abstractContract :: ContractCode -> Expr EAddr -> Contract
- emptyContract :: Contract
- initialContract :: ContractCode -> Contract
- isCreation :: ContractCode -> Bool
- next :: (?op :: Word8) => EVM s ()
- exec1 :: EVM s ()
- transfer :: Expr EAddr -> Expr EAddr -> Expr EWord -> EVM s ()
- callChecks :: (?op :: Word8) => Contract -> Word64 -> Expr EAddr -> Expr EAddr -> Expr EWord -> W256 -> W256 -> W256 -> W256 -> [Expr EWord] -> (Word64 -> EVM s ()) -> EVM s ()
- precompiledContract :: (?op :: Word8) => Contract -> Word64 -> Addr -> Addr -> Expr EWord -> W256 -> W256 -> W256 -> W256 -> [Expr EWord] -> EVM s ()
- executePrecompile :: (?op :: Word8) => Addr -> Word64 -> W256 -> W256 -> W256 -> W256 -> [Expr EWord] -> EVM s ()
- truncpadlit :: Int -> ByteString -> ByteString
- lazySlice :: W256 -> W256 -> ByteString -> ByteString
- parseModexpLength :: ByteString -> (W256, W256, W256)
- isZero :: W256 -> W256 -> ByteString -> Bool
- asInteger :: ByteString -> Integer
- 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 s -> CodeLocation
- query :: Query s -> EVM s ()
- choose :: Choose s -> EVM s ()
- branch :: forall s. Expr EWord -> (Bool -> EVM s ()) -> EVM s ()
- fetchAccount :: Expr EAddr -> (Contract -> EVM s ()) -> EVM s ()
- accessStorage :: Expr EAddr -> Expr EWord -> (Expr EWord -> EVM s ()) -> EVM s ()
- accountExists :: Expr EAddr -> VM s -> Bool
- accountEmpty :: Contract -> Bool
- finalize :: EVM s ()
- loadContract :: Expr EAddr -> State (VM s) ()
- limitStack :: Int -> EVM s () -> EVM s ()
- notStatic :: EVM s () -> EVM s ()
- burn :: Word64 -> EVM s () -> EVM s ()
- forceAddr :: Expr EWord -> String -> (Expr EAddr -> EVM s ()) -> EVM s ()
- forceConcrete :: Expr EWord -> String -> (W256 -> EVM s ()) -> EVM s ()
- forceConcreteAddr :: Expr EAddr -> String -> (Addr -> EVM s ()) -> EVM s ()
- forceConcreteAddr2 :: (Expr EAddr, Expr EAddr) -> String -> ((Addr, Addr) -> EVM s ()) -> EVM s ()
- forceConcrete2 :: (Expr EWord, Expr EWord) -> String -> ((W256, W256) -> EVM s ()) -> EVM s ()
- forceConcrete3 :: (Expr EWord, Expr EWord, Expr EWord) -> String -> ((W256, W256, W256) -> EVM s ()) -> EVM s ()
- forceConcrete4 :: (Expr EWord, Expr EWord, Expr EWord, Expr EWord) -> String -> ((W256, W256, W256, W256) -> EVM s ()) -> EVM s ()
- forceConcrete5 :: (Expr EWord, Expr EWord, Expr EWord, Expr EWord, Expr EWord) -> String -> ((W256, W256, W256, W256, W256) -> EVM s ()) -> EVM s ()
- forceConcrete6 :: (Expr EWord, Expr EWord, Expr EWord, Expr EWord, Expr EWord, Expr EWord) -> String -> ((W256, W256, W256, W256, W256, W256) -> EVM s ()) -> EVM s ()
- forceConcreteBuf :: Expr Buf -> String -> (ByteString -> EVM s ()) -> EVM s ()
- refund :: Word64 -> EVM s ()
- unRefund :: Word64 -> EVM s ()
- touchAccount :: Expr EAddr -> EVM s ()
- selfdestruct :: Expr EAddr -> EVM s ()
- accessAndBurn :: Expr EAddr -> EVM s () -> EVM s ()
- accessAccountForGas :: Expr EAddr -> EVM s Bool
- accessStorageForGas :: Expr EAddr -> Expr EWord -> EVM s Bool
- cheatCode :: Expr EAddr
- cheat :: (?op :: Word8) => (W256, W256) -> (W256, W256) -> EVM s ()
- type CheatAction s = Expr EWord -> Expr EWord -> Expr Buf -> EVM s ()
- cheatActions :: Map FunctionSelector (CheatAction s)
- delegateCall :: (?op :: Word8) => Contract -> Word64 -> Expr EAddr -> Expr EAddr -> Expr EWord -> W256 -> W256 -> W256 -> W256 -> [Expr EWord] -> (Expr EAddr -> EVM s ()) -> EVM s ()
- collision :: Maybe Contract -> Bool
- create :: (?op :: Word8) => Expr EAddr -> Contract -> W256 -> Word64 -> Expr EWord -> [Expr EWord] -> Expr EAddr -> Expr Buf -> EVM s ()
- parseInitCode :: Expr Buf -> Maybe ContractCode
- replaceCode :: Expr EAddr -> ContractCode -> EVM s ()
- replaceCodeOfSelf :: ContractCode -> EVM s ()
- resetState :: EVM s ()
- vmError :: EvmError -> EVM s ()
- partial :: PartialExec -> EVM s ()
- wrap :: Typeable a => [Expr a] -> [SomeExpr]
- underrun :: EVM s ()
- data FrameResult
- = FrameReturned (Expr Buf)
- | FrameReverted (Expr Buf)
- | FrameErrored EvmError
- finishFrame :: FrameResult -> EVM s ()
- accessUnboundedMemoryRange :: Word64 -> Word64 -> EVM s () -> EVM s ()
- accessMemoryRange :: W256 -> W256 -> EVM s () -> EVM s ()
- accessMemoryWord :: W256 -> EVM s () -> EVM s ()
- copyBytesToMemory :: Expr Buf -> Expr EWord -> Expr EWord -> Expr EWord -> EVM s ()
- copyCallBytesToMemory :: Expr Buf -> Expr EWord -> Expr EWord -> EVM s ()
- readMemory :: Expr EWord -> Expr EWord -> EVM s (Expr Buf)
- withTraceLocation :: TraceData -> EVM s Trace
- pushTrace :: TraceData -> EVM s ()
- insertTrace :: TraceData -> EVM s ()
- popTrace :: EVM s ()
- zipperRootForest :: TreePos Empty a -> Forest a
- traceForest :: VM s -> Forest Trace
- traceForest' :: Expr End -> Forest Trace
- traceContext :: Expr End -> Map (Expr EAddr) Contract
- traceTopLog :: [Expr Log] -> EVM s ()
- push :: W256 -> EVM s ()
- pushSym :: Expr EWord -> EVM s ()
- pushAddr :: Expr EAddr -> EVM s ()
- stackOp1 :: (?op :: Word8) => Word64 -> (Expr EWord -> Expr EWord) -> EVM s ()
- stackOp2 :: (?op :: Word8) => Word64 -> (Expr EWord -> Expr EWord -> Expr EWord) -> EVM s ()
- stackOp3 :: (?op :: Word8) => Word64 -> (Expr EWord -> Expr EWord -> Expr EWord -> Expr EWord) -> EVM s ()
- use' :: (VM s -> a) -> EVM s a
- checkJump :: Int -> [Expr EWord] -> EVM s ()
- noJumpIntoInitData :: Int -> EVM s () -> EVM s ()
- isValidJumpDest :: VM s -> Int -> Bool
- opSize :: Word8 -> Int
- mkOpIxMap :: ContractCode -> Vector Int
- vmOp :: VM s -> Maybe Op
- vmOpIx :: VM s -> Maybe Int
- mkCodeOps :: ContractCode -> Vector (Int, Op)
- costOfCall :: FeeSchedule Word64 -> Bool -> Expr EWord -> Word64 -> Word64 -> Expr EAddr -> EVM s (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
- codelen :: ContractCode -> Expr EWord
- toBuf :: ContractCode -> Maybe (Expr Buf)
- codeloc :: EVM s CodeLocation
- createAddress :: Expr EAddr -> Maybe W64 -> EVM s (Expr EAddr)
- create2Address :: Expr EAddr -> W256 -> ByteString -> EVM s (Expr EAddr)
- freshSymAddr :: EVM s (Expr EAddr)
- isPrecompileAddr :: Expr EAddr -> Bool
- ceilDiv :: (Num a, Integral a) => a -> a -> a
- allButOne64th :: (Num a, Integral a) => a -> a
- log2 :: FiniteBits b => b -> Int
- writeMemory :: MutableMemory s -> Int -> ByteString -> EVM s ()
- freezeMemory :: MutableMemory s -> EVM s (Expr Buf)
Documentation
blankState :: ST s (FrameState s) Source #
bytecode :: Getter Contract (Maybe (Expr Buf)) Source #
An "external" view of a contract's bytecode, appropriate for
e.g. EXTCODEHASH.
Data accessors
Data constructors
abstractContract :: ContractCode -> Expr EAddr -> Contract Source #
Initialize an abstract contract with known code
emptyContract :: Contract Source #
Initialize an empty contract without code
initialContract :: ContractCode -> Contract Source #
Initialize empty contract with given code
isCreation :: ContractCode -> Bool Source #
Opcode dispatch (exec1)
callChecks :: (?op :: Word8) => Contract -> Word64 -> Expr EAddr -> Expr EAddr -> Expr EWord -> W256 -> W256 -> W256 -> W256 -> [Expr EWord] -> (Word64 -> EVM s ()) -> EVM s () Source #
Checks a *CALL for failure; OOG, too many callframes, memory access etc.
precompiledContract :: (?op :: Word8) => Contract -> Word64 -> Addr -> Addr -> Expr EWord -> W256 -> W256 -> W256 -> W256 -> [Expr EWord] -> EVM s () Source #
executePrecompile :: (?op :: Word8) => Addr -> Word64 -> W256 -> W256 -> W256 -> W256 -> [Expr EWord] -> EVM s () Source #
truncpadlit :: Int -> ByteString -> ByteString Source #
lazySlice :: W256 -> W256 -> ByteString -> ByteString Source #
parseModexpLength :: ByteString -> (W256, W256, W256) Source #
asInteger :: ByteString -> Integer Source #
Opcode helper actions
pushTo :: MonadState s m => Lens s s [a] [a] -> a -> m () Source #
pushToSequence :: MonadState s m => Setter s s (Seq a) (Seq a) -> a -> m () Source #
getCodeLocation :: VM s -> CodeLocation Source #
fetchAccount :: Expr EAddr -> (Contract -> EVM s ()) -> EVM s () Source #
Construct RPC Query and halt execution until resolved
accountEmpty :: Contract -> Bool Source #
How to finalize a transaction
loadContract :: Expr EAddr -> State (VM s) () Source #
Loads the selected contract as the current contract to execute
forceConcreteAddr2 :: (Expr EAddr, Expr EAddr) -> String -> ((Addr, Addr) -> EVM s ()) -> EVM s () Source #
forceConcrete2 :: (Expr EWord, Expr EWord) -> String -> ((W256, W256) -> EVM s ()) -> EVM s () Source #
forceConcrete3 :: (Expr EWord, Expr EWord, Expr EWord) -> String -> ((W256, W256, W256) -> EVM s ()) -> EVM s () Source #
forceConcrete4 :: (Expr EWord, Expr EWord, Expr EWord, Expr EWord) -> String -> ((W256, W256, W256, W256) -> EVM s ()) -> EVM s () Source #
forceConcrete5 :: (Expr EWord, Expr EWord, Expr EWord, Expr EWord, Expr EWord) -> String -> ((W256, W256, W256, W256, W256) -> EVM s ()) -> EVM s () Source #
forceConcrete6 :: (Expr EWord, Expr EWord, Expr EWord, Expr EWord, Expr EWord, Expr EWord) -> String -> ((W256, W256, W256, W256, W256, W256) -> EVM s ()) -> EVM s () Source #
forceConcreteBuf :: Expr Buf -> String -> (ByteString -> EVM s ()) -> EVM s () Source #
Substate manipulation
accessAccountForGas :: Expr EAddr -> EVM s Bool Source #
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 :: Expr EAddr -> Expr EWord -> EVM s Bool Source #
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
General call implementation ("delegateCall")
delegateCall :: (?op :: Word8) => Contract -> Word64 -> Expr EAddr -> Expr EAddr -> Expr EWord -> W256 -> W256 -> W256 -> W256 -> [Expr EWord] -> (Expr EAddr -> EVM s ()) -> EVM s () Source #
create :: (?op :: Word8) => Expr EAddr -> Contract -> W256 -> Word64 -> Expr EWord -> [Expr EWord] -> Expr EAddr -> Expr Buf -> EVM s () Source #
parseInitCode :: Expr Buf -> Maybe ContractCode Source #
Parses a raw Buf into an InitCode
solidity implements constructor args by appending them to the end of the initcode. we support this internally by treating initCode as a concrete region (initCode) followed by a potentially symbolic region (arguments).
when constructing a contract that has symbolic construcor args, we need to apply some heuristics to convert the (unstructured) initcode in memory into this structured representation. The (unsound, bad, hacky) way that we do this, is by: looking for the first potentially symbolic byte in the input buffer and then splitting it there into code / data.
replaceCode :: Expr EAddr -> ContractCode -> EVM s () Source #
Replace a contract's code, like when CREATE returns from the constructor code.
replaceCodeOfSelf :: ContractCode -> EVM s () Source #
resetState :: EVM s () Source #
VM error implementation
partial :: PartialExec -> EVM s () Source #
data FrameResult Source #
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 Source # | |
Defined in EVM Methods showsPrec :: Int -> FrameResult -> ShowS # show :: FrameResult -> String # showList :: [FrameResult] -> ShowS # | |
finishFrame :: FrameResult -> EVM s () 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.
Memory helpers
Tracing
insertTrace :: TraceData -> EVM s () Source #
Stack manipulation
stackOp2 :: (?op :: Word8) => Word64 -> (Expr EWord -> Expr EWord -> Expr EWord) -> EVM s () Source #
stackOp3 :: (?op :: Word8) => Word64 -> (Expr EWord -> Expr EWord -> Expr EWord -> Expr EWord) -> EVM s () Source #
Bytecode data functions
Gas cost calculation helpers
costOfCall :: FeeSchedule Word64 -> Bool -> Expr EWord -> Word64 -> Word64 -> Expr EAddr -> EVM s (Word64, Word64) Source #
costOfCreate :: FeeSchedule Word64 -> Word64 -> W256 -> Bool -> (Word64, Word64) Source #
costOfPrecompile :: FeeSchedule Word64 -> Addr -> Expr Buf -> Word64 Source #
memoryCost :: FeeSchedule Word64 -> Word64 -> Word64 Source #
opslen :: ContractCode -> Int Source #
The length of the code ignoring any constructor args. This represents the region that can contain executable opcodes
codelen :: ContractCode -> Expr EWord Source #
The length of the code including any constructor args. This can return an abstract value
codeloc :: EVM s CodeLocation Source #
create2Address :: Expr EAddr -> W256 -> ByteString -> EVM s (Expr EAddr) Source #
Arithmetic
allButOne64th :: (Num a, Integral a) => a -> a Source #
log2 :: FiniteBits b => b -> Int Source #
writeMemory :: MutableMemory s -> Int -> ByteString -> EVM s () Source #
freezeMemory :: MutableMemory s -> EVM s (Expr Buf) Source #