Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adapt Readme to heimdall and proxies version #77

Merged
merged 2 commits into from
Apr 24, 2024
Merged

Adapt Readme to heimdall and proxies version #77

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a9b9cf
Adapt Readme to heimdall and proxies version and complex data structs
Pabl0cks Apr 1, 2024
02e8d81
Change proxy contracts description after changing evm-proxy-detection…
Pabl0cks Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Loading