Skip to content

rolod0x/rolod0x

Repository files navigation

rolod0x: Your free private onchain address book

GitHub last commit hits
Tests Lint zip

Overview • Features • Video • Installation • Usage • Telegram • FAQ • Donations • Support • Security • Privacy • Development • Star History • Thanks • License

rolod0x in Chrome Web Store Download for Chrome rolod0x for Firefox Download for Firefox

Overview

Smart phone with unknown number calling

Would you buy a phone which didn't have an address book feature? Of course not - that would be ridiculous! You'd never know who was calling you, and making phone calls would be painful.

What about a phone which had an address book but required you to publish all the entries so that the whole world could see them? Of course not - that would be a massive privacy violation!

So why accept anything less when using web3 and blockchains?

Well, you don't have to any longer! rolod0x is a free cross-browser extension providing a totally private onchain address book which instantly makes every web3 website more usable and all your addresses more accessible.

For example, take: this randomly-picked transaction on etherscan:

etherscan transaction without rolod0x

After labelling the From and To addresses in rolod0x, it now looks like this:

etherscan transaction with rolod0x

Not only that, but whenever these addresses appear on any other website, they will now be labelled in this human-readable way!

Features

  • Completely free and Open Source!
  • Completely private local-only web3 address book.
  • Automatically translates blockchain addresses to human-readable labels.
  • Add entries directly from within a web page, by right-clicking on an address.
  • Instantly look up an address via a hotkey.
  • Works on any website.
  • Works on any EVM-based blockchain (and could easily support other chains in the future).
  • Should work on Chrome, Chromium, Brave, or any other browser in the Chrome family.
  • Should work on Firefox (see #19).
  • Command-line version for translating addresses output on the terminal.
  • Light and dark themes.
  • Named using a triple pun.

Demo video

Demo video on YouTube

Installation

Please see the installation guide.

Usage

Please see the user manual.

FAQ

Please see the Frequently Asked Questions page.

Donations

If you find this project helpful and would like to support its development, you can make a donation in a number of ways:

Your contribution will go directly towards enhancing the project, covering development costs, and supporting ongoing maintenance.

We appreciate every donation, no matter the size. It helps to ensure the project's sustainability and motivates us to continue delivering valuable updates and improvements.

Thank you for considering a donation to support our work!

Support

Please see this document.

Security

Please see the SECURITY.md file.

Privacy policy

Please see docs/privacy-policy.md file.

Development and building from source

For information on how to get started with development, please see the developer guide.

Any pull request providing an enhancement or bugfix is extremely welcome!

Star History

Thanks

Thanks to all contributors. Some special mentions:

  • @fregante for all his great npm modules, several of which are used by rolod0x.

  • @jonghakseo for https://github.com/Jonghakseo/chrome-extension-boilerplate-react-vite which was a great starting point for a React-based MV3 extension.

  • Miles Essex for some fantastic design work which freed up my time to focus on technical work. Check out his exciting project Rails which generates dynamic, interactive maps visualising DeFi transactions!

  • The awesome team at my startup Toucan for being early beta testers and encouraging me to keep working on this project. In particular, thanks to Alex Haase for brainstorming with me and coming up with the perfect name!

  • Dalton Maag and Canonical for the Ubuntu font whose 0x gave me the inspiration for the logo.

  • ricmoo for the wonderful ethers Javascript library.

License

Except where otherwise stated, this extension is licensed under the GNU General Public License v3 or later. See LICENSE.txt for details.

This Free Software license was chosen because its copyleft property ensures that rolod0x remains a public good whereby:

  • the whole community benefits indefinitely from any contributions, and

  • it's protected against commercial entities who could otherwise profit from the code without requiring any contributions back to the original project.

Why is there also a LICENSE file including the Expat ("MIT") license?

This extension is based on https://github.com/Jonghakseo/chrome-extension-boilerplate-react-vite/ released under the permissive Expat (a.k.a. MIT) license, and formerly on https://github.com/fregante/browser-extension-template/ which is released under CC0.

Relicensing to GPL is allowed because the permissive Expat license explicitly allows sublicensing as long as the original copyright notice is preserved.