@xyo-network/xl1-blockies 4.0.11 → 4.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +54 -39
  2. package/package.json +13 -41
package/README.md CHANGED
@@ -5,11 +5,13 @@
5
5
  [![npm-badge][]][npm-link]
6
6
  [![license-badge][]][license-link]
7
7
 
8
- > React Blockies components for XL1 — deterministic identicons for addresses and accounts.
8
+ > React identicons for XL1 addresses and accounts.
9
9
 
10
- ## About
10
+ ## Description
11
11
 
12
- This package provides the React Blockies components used throughout the XL1 React ecosystem to render visual identicons for addresses. It's bundled into [`@xyo-network/xl1-react-client-sdk`](https://www.npmjs.com/package/@xyo-network/xl1-react-client-sdk) — install this package directly only when you want the blockies components without the rest of the React client SDK.
12
+ XL1 is the XYO Layer One blockchain protocol. This package provides deterministic
13
+ React identicons for XL1 addresses. It is used by the XL1 React client SDK, but
14
+ can be installed directly when an app only needs address avatars.
13
15
 
14
16
  ## Install
15
17
 
@@ -37,53 +39,66 @@ Using bun:
37
39
  bun add @xyo-network/xl1-blockies
38
40
  ```
39
41
 
40
- ## What's Inside
42
+ Install peer dependencies from this package's `peerDependencies` in
43
+ `package.json`, especially `react`, `react-dom`, and `@mui/material`.
41
44
 
42
- - React components for rendering deterministic identicons from XL1 addresses
43
- - Designed to drop into MUI 7 + React 19 dApps
45
+ ## Usage
44
46
 
45
- ## Peer Dependencies
47
+ Render a deterministic avatar from an address or seed:
46
48
 
47
- This package targets the same React/MUI stack as the rest of the XL1 React SDK. See [`package.json`](./package.json) for the exact `peerDependencies` ranges.
49
+ ```tsx
50
+ import { BlockiesAvatarAddress, RingsAvatarAddress } from '@xyo-network/xl1-blockies'
48
51
 
49
- ## Building Locally
52
+ export const AccountAvatar = ({ address }: { address: string }) => (
53
+ <>
54
+ <BlockiesAvatarAddress address={address} size={32} />
55
+ <RingsAvatarAddress seed={address} size={32} />
56
+ </>
57
+ )
58
+ ```
59
+
60
+ ## Documentation
61
+
62
+ Exports include:
63
+
64
+ - `BlockiesAvatar`, `BlockiesAvatarAddress`, and `BlockiesAvatarAddressApproved`.
65
+ - `RingsAvatar` and `RingsAvatarAddress`.
66
+ - Low-level `createIcon` and ring rendering helpers for custom avatar components.
67
+
68
+ Use `@xyo-network/xl1-react-client-sdk` when you also need wallet providers,
69
+ gateway hooks, and connected-account UI.
70
+
71
+ ## AI Agent Skills
72
+
73
+ Install the recommended XL1/XYO skills with [Skills.sh](https://skills.sh):
50
74
 
51
75
  ```sh
52
- xy build @xyo-network/xl1-blockies
53
- xy test @xyo-network/xl1-blockies
54
- xy lint @xyo-network/xl1-blockies
76
+ npx skills add XYOracleNetwork/xyo-skills --all
55
77
  ```
56
78
 
57
- ## Maintainers
58
-
59
- <table>
60
- <tr>
61
- <td align="center" valign="top" width="120">
62
- <a href="https://github.com/arietrouw">
63
- <img src="https://github.com/arietrouw.png" width="80" height="80" alt="Arie Trouw" /><br />
64
- <sub><b>Arie Trouw</b></sub>
65
- </a>
66
- <br />
67
- <a href="https://arietrouw.com">arietrouw.com</a>
68
- </td>
69
- <td align="center" valign="top" width="120">
70
- <a href="https://github.com/jonesmac">
71
- <img src="https://github.com/jonesmac.png" width="80" height="80" alt="Matt Jones" /><br />
72
- <sub><b>Matt Jones</b></sub>
73
- </a>
74
- </td>
75
- <td align="center" valign="top" width="120">
76
- <a href="https://github.com/JoelBCarter">
77
- <img src="https://github.com/JoelBCarter.png" width="80" height="80" alt="Joel Carter" /><br />
78
- <sub><b>Joel Carter</b></sub>
79
- </a>
80
- </td>
81
- </tr>
82
- </table>
79
+ In XY toolchain repos, the equivalent convenience command is:
80
+
81
+ ```sh
82
+ pnpm xy skills defaults
83
+ pnpm xy skills lint --fix
84
+ ```
85
+
86
+ For XL1 work, ask your agent to use `xyo-knowledge`, `xl1-knowledge`, and
87
+ `xl1-patterns`. These skills cover XYO primitives, XL1 chain and gateway APIs,
88
+ and application patterns for XL1 dApps.
89
+
90
+ ## Building Locally
91
+
92
+ ```sh
93
+ pnpm xy build @xyo-network/xl1-blockies
94
+ pnpm xy test @xyo-network/xl1-blockies
95
+ pnpm xy lint @xyo-network/xl1-blockies
96
+ ```
83
97
 
84
98
  ## License
85
99
 
86
- See the [LICENSE](./LICENSE) file (LGPL-3.0-only).
100
+ See the [LICENSE](./LICENSE) file for license rights and limitations
101
+ (LGPL-3.0-only).
87
102
 
88
103
  ## Credits
89
104
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "http://json.schemastore.org/package.json",
3
3
  "name": "@xyo-network/xl1-blockies",
4
- "version": "4.0.11",
4
+ "version": "4.0.14",
5
5
  "description": "XL1 React SDK Blockies",
6
6
  "homepage": "https://xylabs.com",
7
7
  "bugs": {
@@ -38,65 +38,37 @@
38
38
  "!**/*.test.*",
39
39
  "README.md"
40
40
  ],
41
+ "dependencies": {
42
+ "@ariestools/sdk-react": "~11.0.2",
43
+ "@mui/icons-material": "~9.2.0"
44
+ },
41
45
  "devDependencies": {
42
- "@ariestools/sdk": "~7.0.8",
43
- "@ariestools/sdk-react": "~10.0.5",
44
- "@mui/icons-material": "~9.2.0",
46
+ "@ariestools/sdk": "~8.0.3",
47
+ "@ariestools/toolchain": "~8.6.12",
48
+ "@ariestools/tsconfig": "~8.6.12",
49
+ "@ariestools/tsconfig-dom": "~8.6.12",
50
+ "@ariestools/tsconfig-react": "~8.6.12",
45
51
  "@mui/material": "~9.2.0",
46
52
  "@opentelemetry/api": "~1.9.1",
47
53
  "@opentelemetry/sdk-trace-base": "~2.9.0",
48
- "@react-spring/web": "~10.1.2",
49
54
  "@storybook/react-vite": "~10.4.6",
50
55
  "@types/react": "~19.2.17",
51
- "@xylabs/eth-address": "~7.0.8",
52
- "@xylabs/pixel": "~7.0.8",
53
- "@xylabs/toolchain": "~8.6.2",
54
- "@xylabs/tsconfig": "~8.6.2",
55
- "@xylabs/tsconfig-dom": "~8.6.2",
56
- "@xylabs/tsconfig-react": "~8.6.2",
57
- "async-mutex": "~0.5.0",
58
- "clsx": "~2.1.1",
59
56
  "eslint": "~10.6.0",
60
- "ethers": "~6.17.0",
61
- "lru-cache": "~11.5.1",
62
- "md5": "~2.3.0",
63
- "numeral": "~2.0.6",
64
- "query-string": "~9.4.1",
65
57
  "react": "~19.2.7",
66
58
  "react-dom": "~19.2.7",
67
- "react-router-dom": "~7.18.1",
68
- "rollbar": "~3.1.0",
69
59
  "storybook": "~10.4.6",
70
60
  "typescript": "~6.0.3",
71
- "viem": "~2.54.3",
72
61
  "vite": "~8.1.3",
73
- "zod": "~4.4.3",
74
- "zustand": "~5.0.14"
62
+ "zod": "~4.4.3"
75
63
  },
76
64
  "peerDependencies": {
77
- "@ariestools/sdk": "^7.0.8",
78
- "@ariestools/sdk-react": "^10.0.5",
79
- "@mui/icons-material": "^9.2.0",
65
+ "@ariestools/sdk": "^8.0.3",
80
66
  "@mui/material": "^9.2.0",
81
67
  "@opentelemetry/api": "^1.9.1",
82
68
  "@opentelemetry/sdk-trace-base": "^2.9.0",
83
- "@react-spring/web": "^10.1.2",
84
- "@xylabs/eth-address": "^7.0.8",
85
- "@xylabs/pixel": "^7.0.8",
86
- "async-mutex": "^0.5.0",
87
- "clsx": "^2.1.1",
88
- "ethers": "^6.17.0",
89
- "lru-cache": "^11.5.1",
90
- "md5": "^2.3.0",
91
- "numeral": "^2.0.6",
92
- "query-string": "^9.4.1",
93
69
  "react": "^19.2.7",
94
70
  "react-dom": "^19.2.7",
95
- "react-router-dom": "^7.18.1",
96
- "rollbar": "^3.1.0",
97
- "viem": "^2.54.3",
98
- "zod": "^4.4.3",
99
- "zustand": "^5.0.14"
71
+ "zod": "^4.4.3"
100
72
  },
101
73
  "engines": {
102
74
  "node": ">=22.3"