Go to file
Willian Mitsuda 8f3761b8ae
Use websocket by default
2022-08-22 20:02:49 -03:00
.github Bump github actions versions 2022-06-06 19:05:23 -03:00
4bytes@5197eb52b8 Update 4bytes 2022-06-03 18:21:31 -03:00
chains@bf0148171a Update chains submodule 2022-06-11 17:19:50 -03:00
docs Migrate docker build to work with vitejs structure; small improvements in the process 2022-08-05 03:32:42 -03:00
nginx Parameterize chain info using ethereum-lists/chains submodule 2022-03-28 14:10:42 -03:00
public Use websocket by default 2022-08-22 20:02:49 -03:00
src Fix error handling 2022-08-22 19:57:19 -03:00
topic0@f6a21e2e00 Update topic0 release; fix #337 2022-08-16 00:52:43 -03:00
trustwallet@ae131df88b Update trustwallet assets 2022-06-03 18:10:18 -03:00
.dockerignore Add chain info to production docker image 2022-03-28 15:35:51 -03:00
.gitignore Add radicle ignores 2022-08-08 18:11:39 -03:00
.gitmodules Add ethereum-lists/chains submodule 2022-03-26 14:37:17 -03:00
.nvmrc Bump node version to 16.16 2022-07-16 13:58:22 -03:00
Dockerfile Migrate docker build to work with vitejs structure; small improvements in the process 2022-08-05 03:32:42 -03:00
LICENSE Initial public alpha version 2021-07-01 15:47:23 -03:00
README.md Expose custom jsonrpc docs in README 2022-01-20 16:31:07 -03:00
index.html First working version using vitejs instead of CRA 2022-08-04 18:47:14 -03:00
package-lock.json Bump @types/node from 16.11.49 to 16.11.52 (#342) 2022-08-22 18:01:17 +00:00
package.json Bump @types/node from 16.11.49 to 16.11.52 (#342) 2022-08-22 18:01:17 +00:00
postcss.config.js Apply code formatter 2022-08-05 05:40:49 -03:00
run-nginx.sh Fix assets url for bytes in production build 2021-09-04 23:18:35 -03:00
tailwind.config.js Tailwind 3 enables everything by default 2022-08-08 05:01:32 -03:00
tsconfig.json Remove react-scripts 2022-08-04 20:03:29 -03:00
tsconfig.node.json First working version using vitejs instead of CRA 2022-08-04 18:47:14 -03:00
vite.config.ts Enable brotli compression 2022-08-05 05:52:18 -03:00

README.md

Otterscan

An open-source, fast, local, laptop-friendly Ethereum block explorer.

https://user-images.githubusercontent.com/28685/124196700-4fe71200-daa3-11eb-912c-b66494fe4b23.mov

What?

This is an Ethereum block explorer designed to be run locally with an archive node companion, more specifically, with Erigon.

This approach brings many advantages, as follows.

Privacy

You are querying your own node, so you are not sending your IP address or queries to an external third-party node.

Fast

Since you are querying your local archive node, everything is fast, no network roundtrips are necessary.

Actually, very fast

This software was designed to be a companion of Erigon, a blazingly fast archive node.

Really, it is even faster

The standard web3 jsonrpc methods are quite verbose and generic requiring many calls to gather many pieces of information at client side.

We've implemented some custom methods at rpcdaemon level, less information is needed to be json-marshalled and transmitted over network.

Alpha warning

This software is in alpha stage, and for sure lots of features, error handling, edge cases are missing.

Be sure to check it often or send patches 😀

Why?

Current offerings are either closed source or lack many features the most famous Ethereum block explorer has, or simply have high requirements like having an archive node + additional indexers.

Otterscan requires only mainline Erigon executing node, patched Erigon RPC daemon and running Otterscan itself (a simple React app), which makes it a laptop-friendly block explorer.

Why the name?

3 reasons:

  • It is heavily based on Erigon, whose mascot is an otter (Erigon, the otter), think about an otter scanning your transactions inside blocks.
  • It is an homage to the most famous and used ethereum block explorer.
  • The author loves wordplays and bad puns.

It looks familiar...

The UI was intentionally made very similar to the most popular Ethereum block explorer so users do not strugle trying to find where the information is.

However, you will see that we made many UI improvements.

Install instructions

Here.

Contract verification

We make use of Sourcify for displaying contract verification info. More info here.

Otterscan JSON-RPC API extensions

We implemented new JSON-RPC APIs to expose information not available in a standard ETH node. They can be useful for non-Otterscan users and their specification is available here.

Kudos (in no particular order)

We make use of many open-source software and integrate many public datasources, mainly:

To the Geth team whose code Erigon is based on.

To the Erigon team that made it possible for regular humans to run an archive node in a retail laptop. Also, they have been very helpful explaining Erigon's internals which made the modifications Otterscan requires possible.

To the mdbx team which is the blazingly fast database that empowers Erigon.

To Trust Wallet who sponsor and make available their icons under a permissive license.

To the owners of the 4bytes repository that we import and use to translate the method selectors to human-friendly strings.

To Sourcify, a public decentralized source code and metadata verification service.

To Ethers which is the client library we used to interact with the ETH node. It is high level enough to hide most jsonrpc particularities, but flexible enough to allow easy interaction with custom jsonrpc methods.

Future

Erigon keeps evolving at a fast pace, with weekly releases, sometimes with (necessary) breaking changes.

This project intends to keep following their progress and mantaining compatibility as the availability of the author permits.

Erigon itself is alpha, so I consider this software is also in alpha state, however it is pretty usable.

Also there is room for many improvements that are not possible in the current centralized, closed source block explorer offerings and the author of this software would like to have.

Licensing

This software itself is MIT licensed and redistributes MIT-compatible dependencies.

The Otterscan patches for Erigon are LGPL-3 as required by Geth (since Erigon is a Geth derivative) and kept in a separate repository.

Getting in touch

Erigon Discord server

Otterscan has a community channel under the "ecosystem" section of Erigon's Discord.

Twitter

Follow the creator on Twitter for updates (@wmitsuda).

Donation address

If you like this project, feel free to send donations to otterscan.eth or use our gitcoin grant page: https://gitcoin.co/grants/3224/otterscan