effigy.im 🎭

This repository contains the source code and documentation for effigy.im, a service that generates Ethereum "blockie" identicons for Ethereum addresses and ENS names. 🌈

Features ✨

• Generate identicons as SVG or PNG images 🖼️
• Support for Ethereum addresses and ENS names 🔖
• Redirect to ENS avatar if available 🔀
• Customizable identicon styles and colors 🎨

Usage 🚀

To generate an identicon, simply use the following URL format:

https://effigy.im/a/[ethereumAddress|ensName].[png|svg]

Replace [ethereumAddress|ensName] with the desired Ethereum address or ENS name, and specify the desired image format (png or svg).

To use the service in an image tag, use the following format:

<img src="https://effigy.im/a/[ethereumAddress|ensName].[png|svg]">

Examples

• Ethereum address (PNG): https://effigy.im/a/0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045.png
• Ethereum address (SVG): https://effigy.im/a/0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045.svg
• ENS name (PNG): https://effigy.im/a/vitalik.eth.png
• ENS name (SVG): https://effigy.im/a/vitalik.eth.svg

If an ENS avatar is available for the provided Ethereum address or ENS name, effigy.im will redirect to the avatar URL. 🌠

Repository Structure 📂

The repository is organized as follows:

• functions/: Contains the Firebase Functions code for generating identicons and handling requests 🔥
• site/: Contains the source code for the effigy.im website, built with Hugo 🌐
• LICENSE: The license file for the project 📜
• README.md: This readme file 📖

Contributing 🤝

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request. 😊

Inspiration and Influences

This project was inspired and influenced by:

• MyCryptoHQ/ethereum-blockies-base64
• download13/blockies
• PR by @qwtel

Feel free to help make this better by submitting a pull request or sending me a note.

• effigy.im on github
• Send me a note: [email protected]

License 📄

This project is open-source and available under the MIT License.

Made with ❤️ by @harperreed / @harper / harper.eth