lazy-etherscan

Crates.iolazy-etherscan
lib.rslazy-etherscan
version0.1.1
sourcesrc
created_at2023-12-03 17:10:32.770988
updated_at2024-01-11 07:38:09.550141
descriptionSimple Terminal UI for the Ethereum Blockchain Explorer
homepagehttps://github.com/woxjro/lazy-etherscan
repositoryhttps://github.com/woxjro/lazy-etherscan
max_upload_size
id1057009
size9,022,025
woxjro (woxjro)

documentation

README

lazy-etherscan

Static Badge build status GitHub

demo

Table of contents

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.

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. And add it to your environment variables. If you are using zsh, run the following command.

$ echo 'export ETHERSCAN_API_KEY=XXXXXXXXXXXX' >> ~/.zshenv

Optional: ethereum-input-data-decoder

To see transactions' decoded input data, you have to preinstall ethereum-input-data-decoder. Please run the following command.

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
$ git clone 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:

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 <Ctrl+e> to toggle the sidebar.
  • Press <Ctrl+p> to move to a previous screen.

Roadmap

Please see this issue.

Contributing

This project is currently in the Proof of Concept (PoC) stage. Contributions are kindly requested to be postponed until further notice. Crash reports are welcome, please create an issue to do that.

Sponsors

This project has been developed with a grant from the Ethereum Foundation and Gitcoin. ethereum foundation gitcoin

Acknowledgement

lazy-etherscan is written in Rust and is built on top of ratatui. This project is highly inspired by Etherscan, lazygit and spotify-tui.

Commit count: 167

cargo fmt