<div align="center"> <img width="860" alt="blo" src="https://github.com/bpierre/blo/assets/36158/7ddc0bf0-076d-4c5a-8624-cc8646e4c5aa"> blo is a small and fast library to generate Ethereum identicons. </div> <a href="https://www.npmjs.com/package/blo"><img src="https://img.shields.io/npm/v/blo?colorB=007ec6" alt="npm version"></a> <a href="https://bundlejs.com/?q=blo"><img src="https://deno.bundlejs.com/badge?q=blo" alt="Bundle size"></a> <a href="https://github.com/bpierre/blo/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/blo?colorB=007ec6" alt="License: MIT"></a>

Features

🐥 Small: 0.7 kB gzipped, even less with tree shaking.
💥 Fast: more than 5x faster than the second fastest solution.
🔍 Optimized: Leverages SVG to generate compact and sharp images at any size.
💆 Simple: Focuses on Ethereum identicons only, allowing for a simpler API.
🗂 Typed: Ships with TypeScript definitions.
👫 Universal: Compatible with browsers, Bun, and Node.js.
☁️ Standalone: Zero dependencies.

Library Comparison

| Library | Operations/sec[^1] | Size | Types | Environment[^2] | Rendering | | ------------------------------------- | -----------------: | ---------------------------------------------------------------------------------------------------------- | -------------------------------------------- | ---------------------------------------------- | --------: | | blo | 💥 403,226 | | | | SVG | | ethereum-blockies-base64 | 2,191 | | | | PNG | | blockies-react-svg | 76,628 | | | | SVG | | @download/blockies | 112 | | | | Canvas | | blockies-ts | 137 | | | | Canvas | | react-blockies | 4,693 | | | | Canvas |

[^1]: These numbers are based on the #benchmark results (higher is better). [^2]: The term “all” refers to libraries that are framework agnostic and that run in browsers, Bun and Node.js.

Getting Started

npm i -S blo
pnpm add blo
yarn add blo

import { blo } from "blo";

img.src = blo("0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045");

React / Vue / Others

blo is fast enough to not require memoization or async rendering for common use cases.

function AddressIcon({ address }: { address: `0x${string}` }) {
  return (
    <img
      alt={address}
      src={blo(address)}
    />
  );
}

API

<details> <summary><code>blo(address: Address, size = 64): string</code></summary>

Get a data URI string representing the identicon as an SVG image.

The size paramater shouldn’t usually be needed, as the image will stay sharp no matter what the size of the img element is.

Example:

import { blo } from "blo";

img.src = blo(address); // size inside the SVG defaults to 64px
img2.src = blo(address, 24); // set it to 24px

</details> <details> <summary><code>bloSvg(address: Address, size = 64): string</code></summary>

Same as above except it returns the SVG code instead of a data URI string.

</details> <details> <summary><code>bloImage(address: Address): BloImage</code></summary>

Get a BloImage data structure that can be used to render the image in different formats.

Check the Bun and Node demos to see usage examples.

</details>

Types

The library ships with TypeScript types included.

// BloImage contains the data needed to render an icon.
export type BloImage = [BloImageData, Palette];

// 4x8 grid of the image left side, as 32 PaletteIndex items.
// The right side is omitted as it's a mirror of the left side.
export type BloImageData = Uint8Array;

// Colors used by a given icon.
export type Palette = [
  Hsl, // background
  Hsl, // color
  Hsl, // spot
];

// Points to one of the three Palette colors.
export type PaletteIndex =
  | 0 // background
  | 1 // color
  | 2; // spot

// A color in the HSL color space.
// [0]: 0-360 (hue)
// [1]: 0-100 (saturation)
// [2]: 0-100 (lightness)
export type Hsl = Uint16Array;

// An Ethereum address.
export type Address = `0x${string}`;

Acknowledgements

blo is a modernized version of ethereum-blockies-base64, which I think was based on ethereum/blockies.
This README style was heavily inspired by colord.
The visual was made in collaboration with @dizzypaty 💖.

FAQ

Does it follow the exact same algorithm as Etherscan, MetaMask and others?

Yes.

Does it work with ENS names?

No it only works with Ethereum addresses, but you can resolve the ENS name to an address (e.g. with wagmi) and pass the result to blo.

Can blo render other formats than SVG?

You can render to any format you want by using the bloImage() function, which returns a data structure (see API above). Check out the Bun and Node demos for examples of rendering an identicon in the terminal.

Can it be used to generate other types of identicons?

blo only focuses on the Ethereum identicons algorithm but you can use it with any data, just prefix it with 0x to fulfill the expected Address type if you are using TypeScript.

Why is it named blo?

blo is short for blockies, which is the name of the original library it is based on.

Benchmark

This benchmark attempts to use the fastest possible way to generate a data URI representing an Ethereum identicon, for each of the libraries compared.

$ bun benchmark

clk: ~2.39 GHz
cpu: AMD Ryzen 7 PRO 7840U w/ Radeon 780M Graphics
runtime: bun 1.2.5 (x64-linux)

benchmark                   avg (min … max) p75 / p99    (min … top 1%)
------------------------------------------- -------------------------------
blo                            2.48 µs/iter   2.55 µs   3.13 µs ▅▆█▃▃▂▁▁▁▁▁
@download/blockies             8.95 ms/iter   9.17 ms  10.63 ms █▇▃▄▂▂▂▂▂▁▁
blockies-react-svg            13.05 µs/iter  14.39 µs  14.53 µs █▃▆▁▁▁▁▁▁▃▃
blockies-ts                    7.28 ms/iter   7.41 ms   8.48 ms █▆▂▂▁▂▂▃▁▁▁
ethereum-blockies-base64     456.49 µs/iter 501.59 µs 882.05 µs ▆█▄▄▂▃▂▂▁▁▁
react-blockies               213.03 µs/iter 220.64 µs 268.34 µs ▁▃▆██▆▃▂▂▁▁

summary
  blo
   5.26x faster than blockies-react-svg
   85.78x faster than react-blockies
   183.82x faster than ethereum-blockies-base64
   2929.86x faster than blockies-ts
   3603.5x faster than @download/blockies

See ./benchmark for the benchmark code.

License

MIT

Blo

Install / Use

README