Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/woxjro/lazy-etherscan
⚡️Simple Terminal UI for the Ethereum Blockchain Explorer
https://github.com/woxjro/lazy-etherscan
blockchain ethereum etherscan ratatui rust tui web3
Last synced: 2 months ago
JSON representation
⚡️Simple Terminal UI for the Ethereum Blockchain Explorer
- Host: GitHub
- URL: https://github.com/woxjro/lazy-etherscan
- Owner: woxjro
- License: mit
- Created: 2023-07-30T08:25:43.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-03-20T13:59:21.000Z (10 months ago)
- Last Synced: 2024-10-16T04:10:03.790Z (3 months ago)
- Topics: blockchain, ethereum, etherscan, ratatui, rust, tui, web3
- Language: Rust
- Homepage: https://woxjro.github.io/lazy-etherscan/
- Size: 32.2 MB
- Stars: 128
- Watchers: 5
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ratatui - lazy-etherscan - A Simple Terminal UI for the Ethereum Blockchain Explorer. (💻 Apps / 🚀 Productivity and Utilities)
README
# lazy-etherscan
![demo](resources/screenshots/demo.gif)
Table of contents
- [lazy-etherscan](#lazy-etherscan)
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Build](#build)
- [Configurations & Usage](#configurations--usage)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [Sponsors](#sponsors)
- [Acknowledgement](#acknowledgement)
## Features
- **No Browser Required** - Use it effortlessly even in environments where browsers are unavailable, such as within servers.
- **Developer Friendly** - Operate efficiently using keyboard shortcuts.
- **Easily Switch Endpoints** - Switch between endpoints, including Mainnet, Testnets, custom node connections, and even BSC endpoints.
- **Rich Search Functionality** - You can search by the following words.
- Address
- Block Number
- ENS ID
- Transaction Hash
- Ticker Name (`USDT`, `BNB`,`UNI`, ...)## Prerequisites
### Optional: Etherscan API Key
To see statistics information about Ethereum, you have to set an Etherscan's free API key.
You can get it from [here](https://etherscan.io/apis).
And add it to your environment variables. If you are using `zsh`, run the following command.
```sh
$ echo 'export ETHERSCAN_API_KEY=XXXXXXXXXXXX' >> ~/.zshenv
```### Optional: [`ethereum-input-data-decoder`](https://github.com/miguelmota/ethereum-input-data-decoder)
To see transactions' decoded input data, you have to preinstall [`ethereum-input-data-decoder`](https://github.com/miguelmota/ethereum-input-data-decoder). Please run the following command.
```sh
$ npm install -g ethereum-input-data-decoder
```## Build
This software has been tested and verified to work correctly on the following operating systems:
- `Ubuntu 22.04.2 LTS`
- `macOS Ventura 13.2````sh
$ git clone --recursive https://github.com/woxjro/lazy-etherscan
$ cd lazy-etherscan
$ cargo run --
```## Configurations & Usage
Please check the various settings such as endpoints using the following command:
```sh
$ cargo run -- --help
```### Usage
The basic usage is as follows:
- Press `q` to exit `lazy-etherscan`.
- Press `s` to focus on the search bar, where you can perform searches for addresses, blocks, transactions, and more.
- Press `1` to navigate the "Latest Blocks" panel. Use `j` to move to a block below and `k` to an above block.
- Press `r` to refresh the "Latest Blocks".
- Press `2` to navigate the "Latest Transactions" panel. Use `j` to move to a transaction below and `k` to move to a transaction above.
- Press `r` to refresh the "Latest Transactions".
- Press `` to toggle the sidebar.
- Press `` to move to a previous screen.## Roadmap
Please see [this issue](https://github.com/woxjro/lazy-etherscan/issues/1).## Contributing
Any contributions are welcome!
Please see [CONTRIBUTING.md](./CONTRIBUTING.md).## Sponsors
This project has been developed with a grant from the [Ethereum Foundation](https://ethereum.org/en/foundation/) and [Gitcoin](https://www.gitcoin.co/).
![ethereum foundation](resources/ethereum_foundation.png)## Acknowledgement
`lazy-etherscan` is written in [Rust](https://www.rust-lang.org/) and is built on top of [ratatui](https://github.com/ratatui-org/ratatui).
This project is highly inspired by [Etherscan](https://etherscan.io/), [lazygit](https://github.com/jesseduffield/lazygit) and [spotify-tui](https://github.com/Rigellute/spotify-tui).