Updates

Author: rastislavcore

.gitignore

@@ -11,6 +11,7 @@ lerna-debug.log*
 package-lock.json
 yarn.lock
 pnpm-lock.yaml
+bun.lockb
 
 node_modules
 dist

demos/bun/.gitignore

@@ -46,6 +46,11 @@ bower_components
 
 .lock-wscript
 
+# Lock files
+package-lock.json
+bun.lockb
+*.lock
+
 # Compiled binary addons (https://nodejs.org/api/addons.html)
 
 build/Release

demos/bun/index.ts

@@ -2,15 +2,17 @@ import { bloImage } from "@blockchainhub/blo";
 
 const SQUARE_WIDTH = 3;
 
+const paletteKeys = ["background", "primary", "accent"] as const;
+
 function renderImage([data, palette]: ReturnType<typeof bloImage>) {
   let output = "";
   const currentLine: string[] = [];
 
   for (let i = 0; i < data.length; i++) {
     const color = hsl2rgb(
-      palette[data[i]][0],
-      palette[data[i]][1] / 100,
-      palette[data[i]][2] / 100,
+      palette[paletteKeys[data[i]]][0],
+      palette[paletteKeys[data[i]]][1] / 100,
+      palette[paletteKeys[data[i]]][2] / 100,
     );
 
     const [r, g, b] = color.map((c) => Math.floor(c * 255));
@@ -28,7 +30,7 @@ function renderImage([data, palette]: ReturnType<typeof bloImage>) {
   return output;
 }
 
-function renderIcon(address: `0x${string}`) {
+function renderIcon(address: string) {
   console.log(
     renderImage(bloImage(address)),
     `\n${address}`,

demos/node/.gitignore

@@ -107,6 +107,11 @@ web_modules/
 .cache
 .parcel-cache
 
+# Lock files
+package-lock.json
+bun.lockb
+*.lock
+
 # Next.js build output
 
 .next

demos/node/index.js

@@ -1,16 +1,17 @@
 import { bloImage } from "@blockchainhub/blo";
 
 const SQUARE_WIDTH = 3;
+const paletteKeys = ["background", "primary", "accent"];
 
 function renderImage([data, palette]) {
   let output = "";
   const currentLine = [];
 
   for (let i = 0; i < data.length; i++) {
     const color = hsl2rgb(
-      palette[data[i]][0],
-      palette[data[i]][1] / 100,
-      palette[data[i]][2] / 100,
+      palette[paletteKeys[data[i]]][0],
+      palette[paletteKeys[data[i]]][1] / 100,
+      palette[paletteKeys[data[i]]][2] / 100,
     );
 
     const [r, g, b] = color.map((c) => Math.floor(c * 255));

demos/react/.gitignore

@@ -0,0 +1,177 @@
+# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
+
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# Runtime data
+
+pids
+_.pid
+_.seed
+\*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+
+lib-cov
+
+# Coverage directory used by tools like istanbul
+
+coverage
+\*.lcov
+
+# nyc test coverage
+
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+bower_components
+
+# node-waf configuration
+
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+
+build/Release
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+
+web_modules/
+
+# TypeScript cache
+
+\*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Microbundle cache
+
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+\*.tgz
+
+# Yarn Integrity file
+
+.yarn-integrity
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+
+.cache
+.parcel-cache
+
+# Lock files
+package-lock.json
+bun.lockb
+*.lock
+
+# Next.js build output
+
+.next
+out
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+.cache/
+
+# Comment in the public line in if your project uses Gatsby and not Next.js
+
+# https://nextjs.org/blog/next-9-1#public-directory-support
+
+# public
+
+# vuepress build output
+
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+
+.temp
+.cache
+
+# Docusaurus cache and generated files
+
+.docusaurus
+
+# Serverless directories
+
+.serverless/
+
+# FuseBox cache
+
+.fusebox/
+
+# DynamoDB Local files
+
+.dynamodb/
+
+# TernJS port file
+
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# yarn v2
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.\*
+
+# IntelliJ based IDEs
+.idea

demos/react/tsconfig.json

@@ -1,7 +1,8 @@
 {
   "extends": "../../tsconfig.json",
   "compilerOptions": {
-    "jsx": "react-jsx"
+    "jsx": "react-jsx",
+    "types": ["react", "react-dom"]
   },
   "include": [".", ".."]
 }

src/image.ts

@@ -1,4 +1,4 @@
-import type { Address, BloImage, BloImageData, Hsl, PaletteIndex } from "./types";
+import type { Address, BloImage, BloImageData, Hsl, Palette, PaletteIndex } from "./types";
 
 import { seedRandom } from "./random";
 
@@ -28,12 +28,12 @@ export function randomImageData(random: () => number): BloImageData {
   return data;
 }
 
-export function randomPalette(random: () => number): [Hsl, Hsl, Hsl] {
+export function randomPalette(random: () => number): Palette {
   // calls order is significant
-  const c = randomColor(random);
-  const b = randomColor(random);
-  const s = randomColor(random);
-  return [b, c, s];
+  const primary = randomColor(random);
+  const background = randomColor(random);
+  const accent = randomColor(random);
+  return { background, primary, accent };
 }
 
 export function randomColor(rand: () => number): Hsl {

src/index.ts

@@ -12,14 +12,16 @@ export type {
   PaletteIndex,
 } from "./types";
 
-export function blo(address: Address, size: number = 64): string {
-  return "data:image/svg+xml;base64," + btoa(bloSvg(address, size));
+export function blo(address: Address, uppercase: boolean = true, size: number = 64): string {
+  return "data:image/svg+xml;base64," + btoa(bloSvg(address, uppercase, size));
 }
 
-export function bloSvg(address: Address, size: number = 64): string {
-  return svg(address, size);
+export function bloSvg(address: Address, uppercase: boolean = true, size: number = 64): string {
+  const processedAddress = uppercase ? address.toUpperCase() : address;
+  return svg(processedAddress, size);
 }
 
-export function bloImage(address: Address): BloImage {
-  return image(address);
+export function bloImage(address: Address, uppercase: boolean = true): BloImage {
+  const processedAddress = uppercase ? address.toUpperCase() : address;
+  return image(processedAddress);
 }

src/svg.ts

@@ -10,8 +10,7 @@ const SVG_START = `<svg `
 
 export function svg(address: Address, size: number) {
   const random = seedRandom(address.toLowerCase());
-
-  const [b, c, s] = randomPalette(random);
+  const { background: b, primary: c, accent: s } = randomPalette(random);
 
   const paths = [
     `M0,0H8V8H0z`, // background

src/types.ts

@@ -6,17 +6,19 @@ export type BloImage = [BloImageData, Palette];
 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
+export type Palette = {
+  background: Hsl;
+  primary: Hsl;
+  accent: Hsl;
+};
+
+// Or using const for better type inference
+export const PaletteIndexes = {
+  BACKGROUND: 0,
+  PRIMARY: 1,
+  ACCENT: 2,
+} as const;
+export type PaletteIndex = typeof PaletteIndexes[keyof typeof PaletteIndexes];
 
 // A color in the HSL color space.
 // [0]: 0-360 (hue)
@@ -26,3 +28,19 @@ export type Hsl = Uint16Array;
 
 // An Ethereum address.
 export type Address = string;
+
+// Add size constraints
+export type ValidSize = number;
+// Or more strictly:
+// export type ValidSize = 16 | 32 | 64 | 128 | 256;
+
+// Function signatures with improved type safety
+export type BloFunction = (address: Address, uppercase?: boolean, size?: ValidSize) => string;
+export type BloSvgFunction = (address: Address, uppercase?: boolean, size?: ValidSize) => string;
+export type BloImageFunction = (address: Address, uppercase?: boolean) => BloImage;
+
+export type HslValues = {
+  hue: number;        // 0-360
+  saturation: number; // 0-100
+  lightness: number;  // 0-100
+};