From dfc6228495d24046c061312f60bf270dfe2849fa Mon Sep 17 00:00:00 2001 From: Pablo Alayeto <55535804+Pabl0cks@users.noreply.github.com> Date: Wed, 24 Apr 2024 07:58:28 +0200 Subject: [PATCH] Adapt Readme to heimdall and proxies version (#77) --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 666d42d9..985fe036 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,22 @@ # ABI Ninja -Interact with any contract on Ethereum. You just need the Contract address (if it's verified) or its ABI + Contract address. +Interact with any contract on Ethereum. ABI Ninja provides an intuitive frontend for contracts from most popular EVM networks, currently supporting: -Built with 🏗 [Scaffold-ETH 2](https://github.com/scaffold-eth/scaffold-eth-2). +- **Verified contracts**. Pulls the code from [AnyABI](https://anyabi.xyz/) and [Etherscan API](https://docs.etherscan.io/) as a fallback option. +- **Unverified contracts**. Two different options are available: + - Decompile using [`heimdall-rs`](https://github.com/Jon-Becker/heimdall-rs) (experimental). + - Provide the ABI and the contract address. +- **Proxy contracts**. Autodetects most popular proxy patterns, and allows to read and write as proxy. -![ABINinja - Index](.github/img/ui1.png) +ABI Ninja (v2) is built with 🏗 [Scaffold-ETH 2](https://github.com/scaffold-eth/scaffold-eth-2). -![ABINinja - Dashboard](.github/img/ui2.png) +| Homepage | Unverified Contract Options | +| :---------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------: | +| ![ABINinja - Index](https://github.com/BuidlGuidl/abi.ninja/assets/55535804/3b7e0f12-1423-4835-bda3-2e12d65b4f15) | ![ABINinja - Unverified Contract](https://github.com/BuidlGuidl/abi.ninja/assets/55535804/d30d76a3-35d0-4b3f-8633-c8e531999be6) | + +Friendly UI even for the most complex data structures: + +![ABINinja - Contract UI](https://github.com/BuidlGuidl/abi.ninja/assets/55535804/7b3ec72b-c70b-4357-9f76-d10cb673530c) # 🏄‍♂️ Development Quick Start