diff --git a/ChangeLog.md b/ChangeLog.md new file mode 100644 --- /dev/null +++ b/ChangeLog.md @@ -0,0 +1,5 @@ +# Revision history for ethereum-analyzer + +## 0.1.0.0 -- YYYY-mm-dd + +* First version. Released on an unsuspecting world. diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2017 Kevin Chen + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,1 @@ +# ethereum-analyzer diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,3 @@ +import Distribution.Simple + +main = defaultMain diff --git a/ethereum-analyzer-cli.cabal b/ethereum-analyzer-cli.cabal new file mode 100644 --- /dev/null +++ b/ethereum-analyzer-cli.cabal @@ -0,0 +1,90 @@ +name: ethereum-analyzer-cli +version: 1.0.0 +synopsis: A CLI frontend for ethereum-analyzer. +homepage: https://github.com/ethereumK/ethereum-analyzer +license: Apache-2.0 +license-file: LICENSE +author: Kevin Chen +maintainer: k_@berkeley.edu +category: CLI, Ethereum, Static Analysis +build-type: Simple +extra-source-files: ChangeLog.md, README.md +cabal-version: >=1.10 +description: A CLI frontend for ethereum-analyzer. + +source-repository head + type: git + location: https://github.com/zchn/ethereum-analyzer + branch: master + subdir: ethereum-analyzer-cli + +source-repository this + type: git + location: https://github.com/zchn/ethereum-analyzer + tag: v1.0.0 + subdir: ethereum-analyzer-cli + +library + build-depends: base >= 4 && < 5, + aeson, + bimap, + bytestring, + conduit-combinators, + conduit-extra, + containers, + ethereum-analyzer-deps, + exceptions, + extra, + fgl, + graphviz, + hexstring, + hflags, + hoopl >= 3.10.2.1, + http-conduit, + http-media, + http-types, + json-rpc, + logging-effect, + monad-logger, + mtl, + neat-interpolation, + network, + optparse-applicative, + prometheus-client, + prometheus-metrics-ghc, + protolude, + servant, + servant-server, + text, + time, + unordered-containers, + vector, + wai, + wai-extra, + wai-middleware-prometheus, + warp, + wl-pprint-text + + exposed-modules: Ethereum.Jsonrpc.Client + ghc-options: -Wall + hs-source-dirs: src + buildable: True + default-language: Haskell98 + default-extensions: OverloadedStrings + +executable ea-dump-contract + main-is: DumpCodeMain.hs + build-depends: base >= 4 && < 5 + , directory + , ethereum-analyzer + , ethereum-analyzer-cli + , ethereum-analyzer-deps + , hflags + , monad-logger + , mtl + , text + ghc-options: -Wall + hs-source-dirs: exec_src + buildable: True + default-language: Haskell98 + diff --git a/exec_src/DumpCodeMain.hs b/exec_src/DumpCodeMain.hs new file mode 100644 --- /dev/null +++ b/exec_src/DumpCodeMain.hs @@ -0,0 +1,72 @@ +{-# LANGUAGE OverloadedStrings, TemplateHaskell, FlexibleContexts + #-} + +-- | Dump all contracts. +module Main + ( main + ) where + +import Ethereum.Jsonrpc.Client +import Blockchain.Output +import Control.Monad.Logger +import Control.Monad.Trans +import Data.Maybe +import Data.Text as T hiding (map) +import HFlags +import Numeric +import System.Directory as SD + +defineFlag + "jrpcServer" + ("127.0.0.1" :: String) + "Ethereum json-rpc server address." + +defineFlag "jrpcPort" (8545 :: Int) "Ethereum json-rpc server port." + +defineFlag "contractDir" ("contracts" :: String) "Directory for contact files." + +-- https://github.com/nilcons/hflags/issues/14 +return [] + +main :: IO () +main = do + s <- $initHFlags "ea-dump-contract" + putStrLn $ "Flags: " ++ show s + flip runLoggingT printLogMsg (dumpContracts flags_jrpcServer flags_jrpcPort) + +dumpContracts :: String -> Int -> LoggingT IO () +dumpContracts server port = do + $logInfo "Dumping eth contracts." + ver <- web3ClientVersion server port + $logInfo $ T.append "version is " ver + latest_bNum <- ethBlockNumber server port + let parsed_bns = readHex $ Prelude.drop 2 $ T.unpack latest_bNum + $logInfo $ T.pack $ "parsing block number: " ++ show parsed_bns + let latest_bn = fst $ Prelude.head $ parsed_bns + $logInfo $ T.pack $ "block number is " ++ show latest_bn + enumerateContractAt server port latest_bn + return () + +enumerateContractAt :: String -> Int -> Int -> LoggingT IO () +enumerateContractAt _ _ 0 = return () +enumerateContractAt s p bn = do + $logInfo $ T.pack $ "processing block " ++ show bn + transactions <- ethGetTransactionsByBlockNumber s p (T.pack $ show bn) + -- $logInfo $ T.pack $ "transactions: " ++ show transactions + addresses <- catMaybes <$> mapM (ethGetContractAddrByTxHash s p) transactions + -- $logInfo $ T.pack $ "addresses: " ++ show addresses + mapM_ + (\addr -> do + let fpath = flags_contractDir ++ "/" ++ T.unpack addr ++ ".contract" + fileExists <- lift $ doesFileExist fpath + if fileExists + then $logInfo $ T.pack $ "skipping: " ++ show addr + else do + textCode <- ethGetCode s p addr + lift $ writeFile fpath $ T.unpack $ T.drop 2 textCode + -- $logInfo $ T.append "textCode is " textCode + ) + addresses + -- code <- getCode server port "0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe" + -- $logInfo $ T.pack $ "decompiled code is " ++ formatCode code + enumerateContractAt s p (bn - 1) diff --git a/src/Ethereum/Jsonrpc/Client.hs b/src/Ethereum/Jsonrpc/Client.hs new file mode 100644 --- /dev/null +++ b/src/Ethereum/Jsonrpc/Client.hs @@ -0,0 +1,199 @@ +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE OverloadedStrings, TemplateHaskell #-} + +module Ethereum.Jsonrpc.Client + ( web3ClientVersion + , ethBlockNumber + , ethGetTransactionsByBlockNumber + , ethGetContractAddrByTxHash + , ethGetCode + , getCode + ) where + +import Blockchain.Data.Code as BDC +import Conduit +import Control.Monad.Catch +import Data.Aeson +import Data.Aeson.Types hiding (Error) +import Data.Foldable as DF +import Data.HashMap.Strict as DHS +import Data.HexString +import Data.Text as T +import Network.HTTP.Conduit as NHC hiding (port) +import Network.JsonRpc as NJ +import qualified Data.ByteString.Char8 as DBC +import qualified Data.Vector as V + +data Req + = Web3_clientVersionReq + | Eth_blockNumberReq + -- blockNumber, returnFullTransation + | Eth_getBlockByNumberReq Text + Bool + -- txHash + | Eth_getTransactionReceiptReq Text + -- codeAddres codeBlockNum + | Eth_getCodeReq Text + Text + deriving (Show, Eq) + +parseJSONElemAtIndex + :: FromJSON a + => Int -> V.Vector Value -> Parser a +parseJSONElemAtIndex idx ary = parseJSON (V.unsafeIndex ary idx) + +instance FromRequest Req where + parseParams "web3_clientVersion" = Just $ const $ return Web3_clientVersionReq + parseParams "eth_blockNumber" = Just $ const $ return Eth_blockNumberReq + parseParams "eth_getBlockByNumber" = + Just $ + withArray "(blockNumber, returnFullTransation)" $ + \ab -> + let n = V.length ab + in if n == 2 + then do + bn <- parseJSONElemAtIndex 0 ab + full <- parseJSONElemAtIndex 1 ab + return $ Eth_getBlockByNumberReq bn full + else fail $ + "cannot unpack array of length " ++ + show n ++ " into a Eth_getBlockByNumberReq" + parseParams "eth_getTransactionReceipt" = + Just $ + withArray "(txHash)" $ + \ab -> + let n = V.length ab + in if n == 1 + then do + txhash <- parseJSONElemAtIndex 0 ab + return $ Eth_getTransactionReceiptReq txhash + else fail $ + "cannot unpack array of length " ++ + show n ++ " into a Eth_getTransactionReceiptReq" + parseParams "eth_getCode" = + Just $ + withArray "(address, blockNum)" $ + \ab -> + let n = V.length ab + in if n == 2 + then do + addr <- parseJSONElemAtIndex 0 ab + blk <- parseJSONElemAtIndex 1 ab + return $ Eth_getCodeReq addr blk + else fail $ + "cannot unpack array of length " ++ + show n ++ " into a Eth_getCodeReq" + parseParams _ = Nothing + +instance ToRequest Req where + requestMethod Web3_clientVersionReq = "web3_clientVersion" + requestMethod Eth_blockNumberReq = "eth_blockNumber" + requestMethod (Eth_getBlockByNumberReq _ _) = "eth_getBlockByNumber" + requestMethod (Eth_getTransactionReceiptReq _) = "eth_getTransactionReceipt" + requestMethod (Eth_getCodeReq _ _) = "eth_getCode" + requestIsNotif = const False + +instance ToJSON Req where + toJSON Web3_clientVersionReq = emptyArray + toJSON Eth_blockNumberReq = emptyArray + toJSON (Eth_getBlockByNumberReq blk full) = toJSON (blk, full) + toJSON (Eth_getTransactionReceiptReq txhash) = toJSON [txhash] + toJSON (Eth_getCodeReq addr blk) = toJSON (addr, blk) + +data Res + = Web3_clientVersionRes { clientVersion :: Text} + | Eth_blockNumberRes { blockNumber :: Text} + | Eth_getBlockByNumberRes { blockInfo :: Object} + | Eth_getTransactionReceiptRes { txReceipt :: Object} + | Eth_getCodeRes { code :: Text} + deriving (Show, Eq) + +instance FromResponse Res where + parseResult "web3_clientVersion" = + Just $ withText "clientVersion" (return . Web3_clientVersionRes) + parseResult "eth_blockNumber" = + Just $ withText "blockNumber" (return . Eth_blockNumberRes) + parseResult "eth_getBlockByNumber" = + Just $ withObject "result" (return . Eth_getBlockByNumberRes) + parseResult "eth_getTransactionReceipt" = + Just $ withObject "result" (return . Eth_getTransactionReceiptRes) + parseResult "eth_getCode" = Just $ withText "code" (return . Eth_getCodeRes) + parseResult _ = Nothing + +instance ToJSON Res where + toJSON (Web3_clientVersionRes result) = toJSON result + toJSON (Eth_blockNumberRes result) = toJSON result + toJSON (Eth_getBlockByNumberRes result) = toJSON result + toJSON (Eth_getTransactionReceiptRes result) = toJSON result + toJSON (Eth_getCodeRes codeRes) = toJSON codeRes + +callJsonRpc + :: (MonadIO m, MonadCatch m) + => String -> Int -> Req -> m Res +callJsonRpc server port req = do + initReq <- NHC.parseUrl ("http://" ++ server ++ ":" ++ (show port)) + let requ = + initReq + { NHC.method = "POST" + , NHC.requestHeaders = + ("Content-Type", "application/json") : NHC.requestHeaders initReq + , NHC.requestBody = + RequestBodyLBS $ encode $ toJSON (NJ.buildRequest V2 req (IdInt 1)) + } + manager <- liftIO $ newManager tlsManagerSettings + resp <- NHC.httpLbs requ manager + case decode $ responseBody resp of + Just body -> + case fromResponse (requestMethod req) body of + Just res -> return res + Nothing -> error $ "couldn't parse json-rpc response: " ++ (show resp) + Nothing -> error $ "couldn't parse json: " ++ (show resp) + +web3ClientVersion + :: (MonadIO m, MonadCatch m) + => String -> Int -> m Text +web3ClientVersion server port = clientVersion <$> callJsonRpc server port Web3_clientVersionReq + +ethBlockNumber + :: (MonadIO m, MonadCatch m) + => String -> Int -> m Text +ethBlockNumber server port = blockNumber <$> callJsonRpc server port Eth_blockNumberReq + +ethGetTransactionsByBlockNumber + :: (MonadIO m, MonadCatch m) + => String -> Int -> Text -> m [Text] +ethGetTransactionsByBlockNumber server port blk = + (Prelude.map $ \(String s) -> s) <$> (\(Array a) -> DF.toList $ a) <$> + (lookupDefault (Array $ V.singleton (String "error")) "transactions") <$> + blockInfo <$> + callJsonRpc server port (Eth_getBlockByNumberReq blk False) + +ethGetContractAddrByTxHash + :: (MonadIO m, MonadCatch m) + => String -> Int -> Text -> m (Maybe Text) +ethGetContractAddrByTxHash server port txhash = + (\ares -> + case ares of + (String a) -> + if toLower a == "null" + then Nothing + else Just a + Null -> Nothing + other -> error $ show other) <$> + (lookupDefault (String "error") "contractAddress") <$> + txReceipt <$> + callJsonRpc server port (Eth_getTransactionReceiptReq txhash) + +ethGetCode + :: (MonadIO m, MonadCatch m) + => String -> Int -> Text -> m Text +ethGetCode server port address = + fmap code $ callJsonRpc server port (Eth_getCodeReq address "latest") + +getCode + :: (MonadIO m, MonadCatch m) + => String -> Int -> Text -> m Code +getCode server port address = do + textCode <- ethGetCode server port address + return $ + BDC.Code $ toBytes (hexString (DBC.pack $ T.unpack $ T.drop 3 textCode))