Safe Haskell	None
Language	Haskell2010

EVM.Solidity

Synopsis

solidity :: Text -> Text -> IO (Maybe ByteString)
solcRuntime :: Text -> Text -> IO (Maybe ByteString)
solidity' :: Text -> IO (Text, Text)
data JumpType
- = JumpInto
- | JumpFrom
- | JumpRegular
data SolcContract = SolcContract {
- _runtimeCodehash :: W256
- _creationCodehash :: W256
- _runtimeCode :: ByteString
- _creationCode :: ByteString
- _contractName :: Text
- _constructorInputs :: [(Text, AbiType)]
- _abiMap :: Map Word32 Method
- _eventMap :: Map W256 Event
- _storageLayout :: Maybe (Map Text StorageItem)
- _runtimeSrcmap :: Seq SrcMap
- _creationSrcmap :: Seq SrcMap
}
data StorageItem = StorageItem {
- _type :: SlotType
- _offset :: Int
- _slot :: Int
}
data SourceCache = SourceCache {
- _sourceFiles :: Map Int (Text, ByteString)
- _sourceLines :: Map Int (Vector ByteString)
- _sourceAsts :: Map Text Value
}
data SrcMap = SM {
- srcMapOffset :: Int
- srcMapLength :: Int
- srcMapFile :: Int
- srcMapJump :: JumpType
- srcMapModifierDepth :: Int
}
data CodeType
- = Creation
- | Runtime
data Method = Method {
- _methodOutput :: [(Text, AbiType)]
- _methodInputs :: [(Text, AbiType)]
- _methodName :: Text
- _methodSignature :: Text
}
data SlotType
- = StorageMapping (NonEmpty AbiType) AbiType
- | StorageValue AbiType
methodName :: Lens' Method Text
methodSignature :: Lens' Method Text
methodInputs :: Lens' Method [(Text, AbiType)]
methodOutput :: Lens' Method [(Text, AbiType)]
abiMap :: Lens' SolcContract (Map Word32 Method)
eventMap :: Lens' SolcContract (Map W256 Event)
storageLayout :: Lens' SolcContract (Maybe (Map Text StorageItem))
contractName :: Lens' SolcContract Text
constructorInputs :: Lens' SolcContract [(Text, AbiType)]
creationCode :: Lens' SolcContract ByteString
functionAbi :: Text -> IO Method
makeSrcMaps :: Text -> Maybe (Seq SrcMap)
readSolc :: FilePath -> IO (Maybe (Map Text SolcContract, SourceCache))
readJSON :: Text -> Maybe (Map Text SolcContract, Map Text Value, [(Text, Maybe ByteString)])
readStdJSON :: Text -> Maybe (Map Text SolcContract, Map Text Value, [(Text, Maybe ByteString)])
readCombinedJSON :: Text -> Maybe (Map Text SolcContract, Map Text Value, [(Text, Maybe ByteString)])
runtimeCode :: Lens' SolcContract ByteString
runtimeCodehash :: Lens' SolcContract W256
creationCodehash :: Lens' SolcContract W256
runtimeSrcmap :: Lens' SolcContract (Seq SrcMap)
creationSrcmap :: Lens' SolcContract (Seq SrcMap)
sourceFiles :: Lens' SourceCache (Map Int (Text, ByteString))
sourceLines :: Lens' SourceCache (Map Int (Vector ByteString))
sourceAsts :: Lens' SourceCache (Map Text Value)
stripBytecodeMetadata :: ByteString -> ByteString
stripBytecodeMetadataSym :: [SWord 8] -> [SWord 8]
signature :: AsValue s => s -> Text
solc :: Language -> Text -> IO Text
data Language
- = Solidity
- | Yul
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
astSrcMap :: Map Int Value -> SrcMap -> Maybe Value

Documentation

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

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

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

data JumpType Source #

Constructors

JumpInto
JumpFrom
JumpRegular

Instances

Instances details

Eq JumpType Source #
Instance details Defined in EVM.Solidity Methods (==) :: JumpType -> JumpType -> Bool # (/=) :: JumpType -> JumpType -> Bool #
Ord JumpType Source #
Instance details 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 #
Show JumpType Source #
Instance details Defined in EVM.Solidity Methods showsPrec :: Int -> JumpType -> ShowS # show :: JumpType -> String # showList :: [JumpType] -> ShowS #
Generic JumpType Source #
Instance details Defined in EVM.Solidity Associated Types type Rep JumpType :: Type -> Type # Methods from :: JumpType -> Rep JumpType x # to :: Rep JumpType x -> JumpType #
type Rep JumpType Source #
Instance details Defined in EVM.Solidity type Rep JumpType = D1 ('MetaData "JumpType" "EVM.Solidity" "hevm-0.46.0-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 Source #

Constructors

SolcContract
Fields _runtimeCodehash :: W256 _creationCodehash :: W256 _runtimeCode :: ByteString _creationCode :: ByteString _contractName :: Text _constructorInputs :: [(Text, AbiType)] _abiMap :: Map Word32 Method _eventMap :: Map W256 Event _storageLayout :: Maybe (Map Text StorageItem) _runtimeSrcmap :: Seq SrcMap _creationSrcmap :: Seq SrcMap

Instances

Instances details

Eq SolcContract Source #
Instance details Defined in EVM.Solidity Methods (==) :: SolcContract -> SolcContract -> Bool # (/=) :: SolcContract -> SolcContract -> Bool #
Show SolcContract Source #
Instance details Defined in EVM.Solidity Methods showsPrec :: Int -> SolcContract -> ShowS # show :: SolcContract -> String # showList :: [SolcContract] -> ShowS #
Generic SolcContract Source #
Instance details Defined in EVM.Solidity Associated Types type Rep SolcContract :: Type -> Type # Methods from :: SolcContract -> Rep SolcContract x # to :: Rep SolcContract x -> SolcContract #
type Rep SolcContract Source #
Instance details Defined in EVM.Solidity type Rep SolcContract = D1 ('MetaData "SolcContract" "EVM.Solidity" "hevm-0.46.0-inplace" 'False) (C1 ('MetaCons "SolcContract" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_runtimeCodehash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 W256) :: S1 ('MetaSel ('Just "_creationCodehash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 W256)) :: (S1 ('MetaSel ('Just "_runtimeCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString) :: (S1 ('MetaSel ('Just "_creationCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString) :: S1 ('MetaSel ('Just "_contractName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :: ((S1 ('MetaSel ('Just "_constructorInputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [(Text, AbiType)]) :: (S1 ('MetaSel ('Just "_abiMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Map Word32 Method)) :: S1 ('MetaSel ('Just "_eventMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Map W256 Event)))) :: (S1 ('MetaSel ('Just "_storageLayout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Map Text StorageItem))) :: (S1 ('MetaSel ('Just "_runtimeSrcmap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq SrcMap)) :: S1 ('MetaSel ('Just "_creationSrcmap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq SrcMap)))))))

data StorageItem Source #

Constructors

StorageItem
Fields _type :: SlotType _offset :: Int _slot :: Int

Instances

Instances details

Eq StorageItem Source #
Instance details Defined in EVM.Solidity Methods (==) :: StorageItem -> StorageItem -> Bool # (/=) :: StorageItem -> StorageItem -> Bool #
Show StorageItem Source #
Instance details Defined in EVM.Solidity Methods showsPrec :: Int -> StorageItem -> ShowS # show :: StorageItem -> String # showList :: [StorageItem] -> ShowS #

data SourceCache Source #

Constructors

SourceCache
Fields _sourceFiles :: Map Int (Text, ByteString) _sourceLines :: Map Int (Vector ByteString) _sourceAsts :: Map Text Value

Instances

Instances details

Eq SourceCache Source #
Instance details Defined in EVM.Solidity Methods (==) :: SourceCache -> SourceCache -> Bool # (/=) :: SourceCache -> SourceCache -> Bool #
Show SourceCache Source #
Instance details Defined in EVM.Solidity Methods showsPrec :: Int -> SourceCache -> ShowS # show :: SourceCache -> String # showList :: [SourceCache] -> ShowS #
Generic SourceCache Source #
Instance details Defined in EVM.Solidity Associated Types type Rep SourceCache :: Type -> Type # Methods from :: SourceCache -> Rep SourceCache x # to :: Rep SourceCache x -> SourceCache #
Semigroup SourceCache Source #
Instance details Defined in EVM.Solidity Methods (<>) :: SourceCache -> SourceCache -> SourceCache # sconcat :: NonEmpty SourceCache -> SourceCache # stimes :: Integral b => b -> SourceCache -> SourceCache #
Monoid SourceCache Source #
Instance details Defined in EVM.Solidity Methods mempty :: SourceCache # mappend :: SourceCache -> SourceCache -> SourceCache # mconcat :: [SourceCache] -> SourceCache #
type Rep SourceCache Source #
Instance details Defined in EVM.Solidity type Rep SourceCache = D1 ('MetaData "SourceCache" "EVM.Solidity" "hevm-0.46.0-inplace" 'False) (C1 ('MetaCons "SourceCache" 'PrefixI 'True) (S1 ('MetaSel ('Just "_sourceFiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Map Int (Text, ByteString))) :: (S1 ('MetaSel ('Just "_sourceLines") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Map Int (Vector ByteString))) :: S1 ('MetaSel ('Just "_sourceAsts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Map Text Value)))))

data SrcMap Source #

Constructors

SM
Fields srcMapOffset :: Int srcMapLength :: Int srcMapFile :: Int srcMapJump :: JumpType srcMapModifierDepth :: Int

Instances

Instances details

Eq SrcMap Source #
Instance details Defined in EVM.Solidity Methods (==) :: SrcMap -> SrcMap -> Bool # (/=) :: SrcMap -> SrcMap -> Bool #
Ord SrcMap Source #
Instance details 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 #
Show SrcMap Source #
Instance details Defined in EVM.Solidity Methods showsPrec :: Int -> SrcMap -> ShowS # show :: SrcMap -> String # showList :: [SrcMap] -> ShowS #
Generic SrcMap Source #
Instance details Defined in EVM.Solidity Associated Types type Rep SrcMap :: Type -> Type # Methods from :: SrcMap -> Rep SrcMap x # to :: Rep SrcMap x -> SrcMap #
type Rep SrcMap Source #
Instance details Defined in EVM.Solidity type Rep SrcMap = D1 ('MetaData "SrcMap" "EVM.Solidity" "hevm-0.46.0-inplace" 'False) (C1 ('MetaCons "SM" 'PrefixI 'True) ((S1 ('MetaSel ('Just "srcMapOffset") 'SourceUnpack 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "srcMapLength") 'SourceUnpack 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "srcMapFile") 'SourceUnpack 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "srcMapJump") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JumpType) :: S1 ('MetaSel ('Just "srcMapModifierDepth") 'SourceUnpack 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

data CodeType Source #

Constructors

Creation
Runtime

Instances

Instances details

Eq CodeType Source #
Instance details Defined in EVM.Solidity Methods (==) :: CodeType -> CodeType -> Bool # (/=) :: CodeType -> CodeType -> Bool #
Ord CodeType Source #
Instance details 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 #
Show CodeType Source #
Instance details Defined in EVM.Solidity Methods showsPrec :: Int -> CodeType -> ShowS # show :: CodeType -> String # showList :: [CodeType] -> ShowS #

data Method Source #

Constructors

Method
Fields _methodOutput :: [(Text, AbiType)] _methodInputs :: [(Text, AbiType)] _methodName :: Text _methodSignature :: Text

Instances

Instances details

Eq Method Source #
Instance details Defined in EVM.Solidity Methods (==) :: Method -> Method -> Bool # (/=) :: Method -> Method -> Bool #
Ord Method Source #
Instance details 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 #
Show Method Source #
Instance details Defined in EVM.Solidity Methods showsPrec :: Int -> Method -> ShowS # show :: Method -> String # showList :: [Method] -> ShowS #
Generic Method Source #
Instance details Defined in EVM.Solidity Associated Types type Rep Method :: Type -> Type # Methods from :: Method -> Rep Method x # to :: Rep Method x -> Method #
type Rep Method Source #
Instance details Defined in EVM.Solidity type Rep Method = D1 ('MetaData "Method" "EVM.Solidity" "hevm-0.46.0-inplace" 'False) (C1 ('MetaCons "Method" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_methodOutput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [(Text, AbiType)]) :: S1 ('MetaSel ('Just "_methodInputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [(Text, AbiType)])) :: (S1 ('MetaSel ('Just "_methodName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "_methodSignature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

data SlotType Source #

Constructors

StorageMapping (NonEmpty AbiType) AbiType
StorageValue AbiType

Instances

Instances details

Eq SlotType Source #
Instance details Defined in EVM.Solidity Methods (==) :: SlotType -> SlotType -> Bool # (/=) :: SlotType -> SlotType -> Bool #
Read SlotType Source #
Instance details Defined in EVM.Solidity Methods readsPrec :: Int -> ReadS SlotType # readList :: ReadS [SlotType] # readPrec :: ReadPrec SlotType # readListPrec :: ReadPrec [SlotType] #
Show SlotType Source #
Instance details Defined in EVM.Solidity Methods showsPrec :: Int -> SlotType -> ShowS # show :: SlotType -> String # showList :: [SlotType] -> ShowS #

methodName :: Lens' Method Text Source #

methodSignature :: Lens' Method Text Source #

methodInputs :: Lens' Method [(Text, AbiType)] Source #

methodOutput :: Lens' Method [(Text, AbiType)] Source #

abiMap :: Lens' SolcContract (Map Word32 Method) Source #

eventMap :: Lens' SolcContract (Map W256 Event) Source #

storageLayout :: Lens' SolcContract (Maybe (Map Text StorageItem)) Source #

contractName :: Lens' SolcContract Text Source #

constructorInputs :: Lens' SolcContract [(Text, AbiType)] Source #

creationCode :: Lens' SolcContract ByteString Source #

functionAbi :: Text -> IO Method Source #

makeSrcMaps :: Text -> Maybe (Seq SrcMap) Source #

readSolc :: FilePath -> IO (Maybe (Map Text SolcContract, SourceCache)) Source #

readJSON :: Text -> Maybe (Map Text SolcContract, Map Text Value, [(Text, Maybe ByteString)]) Source #

readStdJSON :: Text -> Maybe (Map Text SolcContract, Map Text Value, [(Text, Maybe ByteString)]) Source #

readCombinedJSON :: Text -> Maybe (Map Text SolcContract, Map Text Value, [(Text, Maybe ByteString)]) Source #

runtimeCode :: Lens' SolcContract ByteString Source #

runtimeCodehash :: Lens' SolcContract W256 Source #

creationCodehash :: Lens' SolcContract W256 Source #

runtimeSrcmap :: Lens' SolcContract (Seq SrcMap) Source #

creationSrcmap :: Lens' SolcContract (Seq SrcMap) Source #

sourceFiles :: Lens' SourceCache (Map Int (Text, ByteString)) Source #

sourceLines :: Lens' SourceCache (Map Int (Vector ByteString)) Source #

sourceAsts :: Lens' SourceCache (Map Text Value) Source #

stripBytecodeMetadata :: ByteString -> ByteString Source #

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 :: [SWord 8] -> [SWord 8] Source #

signature :: AsValue s => s -> Text Source #

solc :: Language -> Text -> IO Text Source #

data Language Source #

Constructors

Solidity
Yul

Instances

Instances details

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

stdjson :: Language -> Text -> Text Source #

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

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

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

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