EVM.Solidity

Documentation

solidity :: Text -> Text -> IO (Maybe ByteString)

solcRuntime :: Text -> Text -> IO (Maybe ByteString)

solidity' :: Text -> IO (Text, Text)

yul' :: Text -> IO (Text, Text)

yul :: Text -> Text -> IO (Maybe ByteString)

yulRuntime :: Text -> Text -> IO (Maybe ByteString)

data JumpType

Constructors

JumpInto

JumpFrom

JumpRegular

Instances

Generic JumpType

Defined in EVM.Solidity

Associated Types

type Rep JumpType :: Type -> Type

Methods

from :: JumpType -> Rep JumpType x

to :: Rep JumpType x -> JumpType

Show JumpType

Defined in EVM.Solidity

Methods

showsPrec :: Int -> JumpType -> ShowS

show :: JumpType -> String

showList :: [JumpType] -> ShowS

Eq JumpType

Defined in EVM.Solidity

Methods

(==) :: JumpType -> JumpType -> Bool

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

Ord JumpType

Defined in EVM.Solidity

Methods

compare :: JumpType -> JumpType -> Ordering

(<) :: JumpType -> JumpType -> Bool

(<=) :: JumpType -> JumpType -> Bool

(>) :: JumpType -> JumpType -> Bool

(>=) :: JumpType -> JumpType -> Bool

max :: JumpType -> JumpType -> JumpType

min :: JumpType -> JumpType -> JumpType

type Rep JumpType

Defined in EVM.Solidity

type Rep JumpType = D1 ('MetaData "JumpType" "EVM.Solidity" "hevm-0.51.2-inplace" 'False) (C1 ('MetaCons "JumpInto" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "JumpFrom" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "JumpRegular" 'PrefixI 'False) (U1 :: Type -> Type)))

data SolcContract

Constructors

SolcContract

Fields

• runtimeCodehash :: W256
• creationCodehash :: W256
• runtimeCode :: ByteString
• creationCode :: ByteString
• contractName :: Text
• constructorInputs :: [(Text, AbiType)]
• abiMap :: Map FunctionSelector Method
• eventMap :: Map W256 Event
• errorMap :: Map W256 SolError
• immutableReferences :: Map W256 [Reference]
• storageLayout :: Maybe (Map Text StorageItem)
• runtimeSrcmap :: Seq SrcMap
• creationSrcmap :: Seq SrcMap

Instances

Generic SolcContract

Defined in EVM.Solidity

Associated Types

type Rep SolcContract :: Type -> Type

Methods

from :: SolcContract -> Rep SolcContract x

to :: Rep SolcContract x -> SolcContract

Show SolcContract

Defined in EVM.Solidity

Methods

showsPrec :: Int -> SolcContract -> ShowS

show :: SolcContract -> String

showList :: [SolcContract] -> ShowS

Eq SolcContract

Defined in EVM.Solidity

Methods

(==) :: SolcContract -> SolcContract -> Bool

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

type Rep SolcContract

Defined in EVM.Solidity

type Rep SolcContract = D1 ('MetaData "SolcContract" "EVM.Solidity" "hevm-0.51.2-inplace" 'False) (C1 ('MetaCons "SolcContract" 'PrefixI 'True) (((S1 ('MetaSel ('Just "runtimeCodehash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 W256) :*: (S1 ('MetaSel ('Just "creationCodehash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 W256) :*: S1 ('MetaSel ('Just "runtimeCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString))) :*: (S1 ('MetaSel ('Just "creationCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :*: (S1 ('MetaSel ('Just "contractName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "constructorInputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Text, AbiType)])))) :*: ((S1 ('MetaSel ('Just "abiMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map FunctionSelector Method)) :*: (S1 ('MetaSel ('Just "eventMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map W256 Event)) :*: S1 ('MetaSel ('Just "errorMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map W256 SolError)))) :*: ((S1 ('MetaSel ('Just "immutableReferences") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map W256 [Reference])) :*: S1 ('MetaSel ('Just "storageLayout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text StorageItem)))) :*: (S1 ('MetaSel ('Just "runtimeSrcmap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Seq SrcMap)) :*: S1 ('MetaSel ('Just "creationSrcmap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Seq SrcMap)))))))

newtype Contracts

A mapping from contract identifiers (filepath:name) to a SolcContract object

Constructors

Contracts (Map Text SolcContract)

Instances

Monoid Contracts

Defined in EVM.Solidity

Methods

mempty :: Contracts

mappend :: Contracts -> Contracts -> Contracts

mconcat :: [Contracts] -> Contracts

Semigroup Contracts

Defined in EVM.Solidity

Methods

(<>) :: Contracts -> Contracts -> Contracts

sconcat :: NonEmpty Contracts -> Contracts

stimes :: Integral b => b -> Contracts -> Contracts

Show Contracts

Defined in EVM.Solidity

Methods

showsPrec :: Int -> Contracts -> ShowS

show :: Contracts -> String

showList :: [Contracts] -> ShowS

Eq Contracts

Defined in EVM.Solidity

Methods

(==) :: Contracts -> Contracts -> Bool

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

data ProjectType

The various project types understood by hevm

Constructors

DappTools

CombinedJSON

Foundry

Instances

Read ProjectType

Defined in EVM.Solidity

Methods

readsPrec :: Int -> ReadS ProjectType

readList :: ReadS [ProjectType]

readPrec :: ReadPrec ProjectType

readListPrec :: ReadPrec [ProjectType]

Show ProjectType

Defined in EVM.Solidity

Methods

showsPrec :: Int -> ProjectType -> ShowS

show :: ProjectType -> String

showList :: [ProjectType] -> ShowS

Eq ProjectType

Defined in EVM.Solidity

Methods

(==) :: ProjectType -> ProjectType -> Bool

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

ParseField ProjectType

Defined in EVM.Solidity

Methods

parseField :: Maybe Text -> Maybe Text -> Maybe Char -> Maybe String -> Parser ProjectType

parseListOfField :: Maybe Text -> Maybe Text -> Maybe Char -> Maybe String -> Parser [ProjectType]

readField :: ReadM ProjectType

metavar :: proxy ProjectType -> String

data BuildOutput

Constructors

BuildOutput

Fields

• contracts :: Contracts
• sources :: SourceCache

Instances

Monoid BuildOutput

Defined in EVM.Solidity

Methods

mempty :: BuildOutput

mappend :: BuildOutput -> BuildOutput -> BuildOutput

mconcat :: [BuildOutput] -> BuildOutput

Semigroup BuildOutput

Defined in EVM.Solidity

Methods

(<>) :: BuildOutput -> BuildOutput -> BuildOutput

sconcat :: NonEmpty BuildOutput -> BuildOutput

stimes :: Integral b => b -> BuildOutput -> BuildOutput

Show BuildOutput

Defined in EVM.Solidity

Methods

showsPrec :: Int -> BuildOutput -> ShowS

show :: BuildOutput -> String

showList :: [BuildOutput] -> ShowS

Eq BuildOutput

Defined in EVM.Solidity

Methods

(==) :: BuildOutput -> BuildOutput -> Bool

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

data StorageItem

Constructors

StorageItem

Fields

• slotType :: SlotType
• offset :: Int
• slot :: Int

Instances

Show StorageItem

Defined in EVM.Solidity

Methods

showsPrec :: Int -> StorageItem -> ShowS

show :: StorageItem -> String

showList :: [StorageItem] -> ShowS

Eq StorageItem

Defined in EVM.Solidity

Methods

(==) :: StorageItem -> StorageItem -> Bool

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

data SourceCache

Constructors

SourceCache

Fields

• files :: Map Int (FilePath, ByteString)
• lines :: Map Int (Vector ByteString)
• asts :: Map Text Value

Instances

Monoid SourceCache

Defined in EVM.Solidity

Methods

mempty :: SourceCache

mappend :: SourceCache -> SourceCache -> SourceCache

mconcat :: [SourceCache] -> SourceCache

Semigroup SourceCache

Defined in EVM.Solidity

Methods

(<>) :: SourceCache -> SourceCache -> SourceCache

sconcat :: NonEmpty SourceCache -> SourceCache

stimes :: Integral b => b -> SourceCache -> SourceCache

Generic SourceCache

Defined in EVM.Solidity

Associated Types

type Rep SourceCache :: Type -> Type

Methods

from :: SourceCache -> Rep SourceCache x

to :: Rep SourceCache x -> SourceCache

Show SourceCache

Defined in EVM.Solidity

Methods

showsPrec :: Int -> SourceCache -> ShowS

show :: SourceCache -> String

showList :: [SourceCache] -> ShowS

Eq SourceCache

Defined in EVM.Solidity

Methods

(==) :: SourceCache -> SourceCache -> Bool

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

type Rep SourceCache

Defined in EVM.Solidity

type Rep SourceCache = D1 ('MetaData "SourceCache" "EVM.Solidity" "hevm-0.51.2-inplace" 'False) (C1 ('MetaCons "SourceCache" 'PrefixI 'True) (S1 ('MetaSel ('Just "files") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Int (FilePath, ByteString))) :*: (S1 ('MetaSel ('Just "lines") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Int (Vector ByteString))) :*: S1 ('MetaSel ('Just "asts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Value)))))

data SrcMap

Constructors

SM

Fields

• offset :: !Int
• length :: !Int
• file :: !Int
• jump :: JumpType
• modifierDepth :: !Int

Instances

Generic SrcMap

Defined in EVM.Solidity

Associated Types

type Rep SrcMap :: Type -> Type

Methods

from :: SrcMap -> Rep SrcMap x

to :: Rep SrcMap x -> SrcMap

Show SrcMap

Defined in EVM.Solidity

Methods

showsPrec :: Int -> SrcMap -> ShowS

show :: SrcMap -> String

showList :: [SrcMap] -> ShowS

Eq SrcMap

Defined in EVM.Solidity

Methods

(==) :: SrcMap -> SrcMap -> Bool

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

Ord SrcMap

Defined in EVM.Solidity

Methods

compare :: SrcMap -> SrcMap -> Ordering

(<) :: SrcMap -> SrcMap -> Bool

(<=) :: SrcMap -> SrcMap -> Bool

(>) :: SrcMap -> SrcMap -> Bool

(>=) :: SrcMap -> SrcMap -> Bool

max :: SrcMap -> SrcMap -> SrcMap

min :: SrcMap -> SrcMap -> SrcMap

type Rep SrcMap

Defined in EVM.Solidity

type Rep SrcMap = D1 ('MetaData "SrcMap" "EVM.Solidity" "hevm-0.51.2-inplace" 'False) (C1 ('MetaCons "SM" 'PrefixI 'True) ((S1 ('MetaSel ('Just "offset") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "length") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "file") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "jump") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JumpType) :*: S1 ('MetaSel ('Just "modifierDepth") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int)))))

data CodeType

Constructors

Creation

Runtime

Instances

Show CodeType

Defined in EVM.Solidity

Methods

showsPrec :: Int -> CodeType -> ShowS

show :: CodeType -> String

showList :: [CodeType] -> ShowS

Eq CodeType

Defined in EVM.Solidity

Methods

(==) :: CodeType -> CodeType -> Bool

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

Ord CodeType

Defined in EVM.Solidity

Methods

compare :: CodeType -> CodeType -> Ordering

(<) :: CodeType -> CodeType -> Bool

(<=) :: CodeType -> CodeType -> Bool

(>) :: CodeType -> CodeType -> Bool

(>=) :: CodeType -> CodeType -> Bool

max :: CodeType -> CodeType -> CodeType

min :: CodeType -> CodeType -> CodeType

data Method

Constructors

Method

Fields

• output :: [(Text, AbiType)]
• inputs :: [(Text, AbiType)]
• name :: Text
• methodSignature :: Text
• mutability :: Mutability

Instances

Generic Method

Defined in EVM.Solidity

Associated Types

type Rep Method :: Type -> Type

Methods

from :: Method -> Rep Method x

to :: Rep Method x -> Method

Show Method

Defined in EVM.Solidity

Methods

showsPrec :: Int -> Method -> ShowS

show :: Method -> String

showList :: [Method] -> ShowS

Eq Method

Defined in EVM.Solidity

Methods

(==) :: Method -> Method -> Bool

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

Ord Method

Defined in EVM.Solidity

Methods

compare :: Method -> Method -> Ordering

(<) :: Method -> Method -> Bool

(<=) :: Method -> Method -> Bool

(>) :: Method -> Method -> Bool

(>=) :: Method -> Method -> Bool

max :: Method -> Method -> Method

min :: Method -> Method -> Method

type Rep Method

Defined in EVM.Solidity

type Rep Method = D1 ('MetaData "Method" "EVM.Solidity" "hevm-0.51.2-inplace" 'False) (C1 ('MetaCons "Method" 'PrefixI 'True) ((S1 ('MetaSel ('Just "output") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Text, AbiType)]) :*: S1 ('MetaSel ('Just "inputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Text, AbiType)])) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "methodSignature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "mutability") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Mutability)))))

data SlotType

Constructors

StorageMapping (NonEmpty AbiType) AbiType

StorageValue AbiType

Instances

Read SlotType

Defined in EVM.Solidity

Methods

readsPrec :: Int -> ReadS SlotType

readList :: ReadS [SlotType]

readPrec :: ReadPrec SlotType

readListPrec :: ReadPrec [SlotType]

Show SlotType

Defined in EVM.Solidity

Methods

showsPrec :: Int -> SlotType -> ShowS

show :: SlotType -> String

showList :: [SlotType] -> ShowS

Eq SlotType

Defined in EVM.Solidity

Methods

(==) :: SlotType -> SlotType -> Bool

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

data Reference

Constructors

Reference

Fields

• start :: Int
• length :: Int

Instances

FromJSON Reference

Defined in EVM.Solidity

Methods

parseJSON :: Value -> Parser Reference

parseJSONList :: Value -> Parser [Reference]

Show Reference

Defined in EVM.Solidity

Methods

showsPrec :: Int -> Reference -> ShowS

show :: Reference -> String

showList :: [Reference] -> ShowS

Eq Reference

Defined in EVM.Solidity

Methods

(==) :: Reference -> Reference -> Bool

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

data Mutability

Constructors

Pure

specified to not read blockchain state

View

specified to not modify the blockchain state

NonPayable

function does not accept Ether - the default

Payable

function accepts Ether

Instances

Generic Mutability

Defined in EVM.Solidity

Associated Types

type Rep Mutability :: Type -> Type

Methods

from :: Mutability -> Rep Mutability x

to :: Rep Mutability x -> Mutability

Show Mutability

Defined in EVM.Solidity

Methods

showsPrec :: Int -> Mutability -> ShowS

show :: Mutability -> String

showList :: [Mutability] -> ShowS

Eq Mutability

Defined in EVM.Solidity

Methods

(==) :: Mutability -> Mutability -> Bool

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

Ord Mutability

Defined in EVM.Solidity

Methods

compare :: Mutability -> Mutability -> Ordering

(<) :: Mutability -> Mutability -> Bool

(<=) :: Mutability -> Mutability -> Bool

(>) :: Mutability -> Mutability -> Bool

(>=) :: Mutability -> Mutability -> Bool

max :: Mutability -> Mutability -> Mutability

min :: Mutability -> Mutability -> Mutability

type Rep Mutability

Defined in EVM.Solidity

type Rep Mutability = D1 ('MetaData "Mutability" "EVM.Solidity" "hevm-0.51.2-inplace" 'False) ((C1 ('MetaCons "Pure" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "View" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "NonPayable" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Payable" 'PrefixI 'False) (U1 :: Type -> Type)))

readBuildOutput :: FilePath -> ProjectType -> IO (Either String BuildOutput)

Reads all solc ouput json files found under the provided filepath and returns them merged into a BuildOutput

functionAbi :: Text -> IO Method

makeSrcMaps :: Text -> Maybe (Seq SrcMap)

readSolc :: ProjectType -> FilePath -> FilePath -> IO (Either String BuildOutput)

readJSON :: ProjectType -> Text -> Text -> Maybe (Contracts, Asts, Sources)

readStdJSON :: Text -> Maybe (Contracts, Asts, Sources)

Parses the standard json output from solc

stripBytecodeMetadata :: ByteString -> ByteString

When doing CREATE and passing constructor arguments, Solidity loads the argument data via the creation bytecode, since there is no "calldata" for CREATE.

This interferes with our ability to look up the current contract by codehash, so we must somehow strip away this extra suffix. Luckily we can detect the end of the actual bytecode by looking for the "metadata hash". (Not 100% correct, but works in practice.)

Actually, we strip away the entire BZZR suffix too, because as long as the codehash matches otherwise, we don't care if there is some difference there.

stripBytecodeMetadataSym :: [Expr Byte] -> [Expr Byte]

signature :: AsValue s => s -> Text

solc :: Language -> Text -> IO Text

data Language

Constructors

Solidity

Yul

Instances

Show Language

Defined in EVM.Solidity

Methods

showsPrec :: Int -> Language -> ShowS

show :: Language -> String

showList :: [Language] -> ShowS

stdjson :: Language -> Text -> Text

parseMethodInput :: AsValue s => s -> (Text, AbiType)

lineSubrange :: Vector ByteString -> (Int, Int) -> Int -> Maybe (Int, Int)

astIdMap :: Foldable f => f Value -> Map Int Value

Every node in the AST has an ID, and other nodes reference those IDs. This function recurses through the tree looking for objects with the "id" key and makes a big map from ID to value.

astSrcMap :: Map Int Value -> SrcMap -> Maybe Value

containsLinkerHole :: Text -> Bool

makeSourceCache :: FilePath -> Sources -> Asts -> IO SourceCache