From 0b6f068318043198179f45ebca605a18d6d76cf5 Mon Sep 17 00:00:00 2001 From: Idan Yael Date: Tue, 11 Jul 2023 23:15:12 +0300 Subject: [PATCH] readme update --- README.md | 39 +++++++++++++++++++++++++++++++++------ 1 file changed, 33 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1e9c2b9..512e114 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,38 @@ A command line tool for inspecting Ethereum smart contracts, transactions and accounts. ### Install + +#### Homebrew +``` +brew tap idanya/tools +brew install evm-cli +``` +#### Go +``` go install github.com/idanya/evm-cli@latest +``` + +### Usage +``` +$ evm-cli --help +A CLI tool to interact with the EVM blockchains via JSON-RPC + +Usage: + evm-cli [flags] + evm-cli [command] + +Available Commands: + account Account related commands + completion Generate the autocompletion script for the specified shell + contract Contract related commands + help Help about any command + tx Transaction related commands + +Flags: + -c, --chain-id uint Chain ID of the blockchain (default 1) + -h, --help help for evm-cli + --rpc-url string node RPC endpoint (overrides the chain ID) + +Use "evm-cli [command] --help" for more information about a command. +``` -### TODO -- [X] Detect minimal proxy by comparing on-chain bytecode to the minimal proxy template -- [ ] optimize concurrency when detecting proxy -- [ ] mock node responses for tests -- [ ] `inspect` command for complete analysis of a contract -- [ ] Extract dispatched logs (PUSH32 ?)