Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/harperreed/effigy.im
This is a simple service that will return a identicon of an ethereum address. You can use this to power avatars or whatever in your webapp
https://github.com/harperreed/effigy.im
ethereum identicon web3
Last synced: about 10 hours ago
JSON representation
This is a simple service that will return a identicon of an ethereum address. You can use this to power avatars or whatever in your webapp
- Host: GitHub
- URL: https://github.com/harperreed/effigy.im
- Owner: harperreed
- License: mit
- Created: 2021-06-13T22:19:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-30T01:41:02.000Z (7 months ago)
- Last Synced: 2024-05-08T00:03:31.133Z (6 months ago)
- Topics: ethereum, identicon, web3
- Language: JavaScript
- Homepage: https://effigy.im/
- Size: 240 KB
- Stars: 14
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# effigy.im 🎭
[](https://github.com/harperreed/effigy.im/blob/main/LICENSE)
This repository contains the source code and documentation for [effigy.im](https://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:
```html
```
### 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](https://github.com/MyCryptoHQ/ethereum-blockies-base64)
- [download13/blockies](https://github.com/download13/blockies)
- [PR by @qwtel](https://github.com/download13/blockies/pull/12)
Feel free to help make this better by submitting a pull request or sending me a note.
- [effigy.im on github](https://github.com/harperreed/effigy.im)
- [Send me a note: [email protected]](mailto:[email protected])
## License 📄
This project is open-source and available under the [MIT License](LICENSE).
---
Made with ❤️ by [@harperreed](https://github.com/harperreed) / [@harper](https://twitter.com/harper) / [harper.eth](https://art.pizza/harper.eth)