@xyo-network/xl1-schema 1.28.0 → 1.28.2

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 +81 -6
  2. package/package.json +49 -49
package/README.md CHANGED
@@ -1,24 +1,99 @@
1
+ [![logo][]][logo-link]
2
+
1
3
  # @xyo-network/xl1-schema
2
4
 
3
- [![npm][npm-badge]][npm-link]
4
- [![license][license-badge]][license-link]
5
+ [![npm-badge][]][npm-link]
6
+ [![license-badge][]][license-link]
7
+
8
+ > AJV-compatible JSON Schemas for XL1 payloads, bound witnesses, and storage metadata.
9
+
10
+ ## About
11
+
12
+ This package contains the JSON Schema definitions used to validate XL1 protocol data at network and storage boundaries. The schemas pair with the Zod definitions in [`@xyo-network/xl1-protocol-model`](https://www.npmjs.com/package/@xyo-network/xl1-protocol-model) — Zod for in-process type-checking, JSON Schema for cross-language interoperability and AJV-based validation in [`@xyo-network/xl1-validation`](https://www.npmjs.com/package/@xyo-network/xl1-validation).
5
13
 
6
- > XYO Layer One SDK Schema
14
+ Most consumers receive this package transitively via [`@xyo-network/xl1-protocol`](https://www.npmjs.com/package/@xyo-network/xl1-protocol) or [`@xyo-network/xl1-sdk`](https://www.npmjs.com/package/@xyo-network/xl1-sdk). Install directly if you're integrating XL1 validation into a non-TypeScript service, or hand-rolling AJV usage.
7
15
 
8
16
  ## Install
9
17
 
18
+ Using npm:
19
+
20
+ ```sh
21
+ npm i --save @xyo-network/xl1-schema
22
+ ```
23
+
24
+ Using yarn:
25
+
26
+ ```sh
27
+ yarn add @xyo-network/xl1-schema
28
+ ```
29
+
30
+ Using pnpm:
31
+
10
32
  ```sh
11
- {{pm}} add {{name}}
33
+ pnpm add @xyo-network/xl1-schema
12
34
  ```
13
35
 
36
+ Using bun:
37
+
38
+ ```sh
39
+ bun add @xyo-network/xl1-schema
40
+ ```
41
+
42
+ ## What's Inside
43
+
44
+ - **Bound-witness schemas** — JSON Schema definitions for the various bound-witness shapes
45
+ - **Payload schemas** — schemas for the elevatable payload variants
46
+ - **`Executable`** — schema and helpers for executable payloads
47
+ - **`StorageMeta`** — schema for storage-tier metadata fields
48
+
49
+ ## Building Locally
50
+
51
+ ```sh
52
+ xy build @xyo-network/xl1-schema
53
+ xy test @xyo-network/xl1-schema
54
+ xy lint @xyo-network/xl1-schema
55
+ ```
56
+
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>
14
83
 
15
84
  ## License
16
85
 
17
- See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
86
+ See the [LICENSE](./LICENSE) file (LGPL-3.0-only).
87
+
88
+ ## Credits
18
89
 
90
+ [Made with 🔥 and ❄️ by XYO](https://xyo.network)
19
91
 
92
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
93
+ [logo-link]: https://xyo.network
20
94
 
21
95
  [npm-badge]: https://img.shields.io/npm/v/@xyo-network/xl1-schema.svg
22
96
  [npm-link]: https://www.npmjs.com/package/@xyo-network/xl1-schema
97
+
23
98
  [license-badge]: https://img.shields.io/npm/l/@xyo-network/xl1-schema.svg
24
- [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
99
+ [license-link]: ./LICENSE
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/xl1-schema",
3
- "version": "1.28.0",
3
+ "version": "1.28.2",
4
4
  "description": "XYO Layer One SDK Schema",
5
5
  "homepage": "https://xylabs.com",
6
6
  "bugs": {
@@ -34,7 +34,7 @@
34
34
  "README.md"
35
35
  ],
36
36
  "dependencies": {
37
- "@xyo-network/xl1-protocol-lib": "~1.28.0"
37
+ "@xyo-network/xl1-protocol-lib": "~1.28.2"
38
38
  },
39
39
  "devDependencies": {
40
40
  "@bitauth/libauth": "~3.0.0",
@@ -46,8 +46,8 @@
46
46
  "@xylabs/geo": "^5.1.1",
47
47
  "@xylabs/sdk-js": "^5.1.1",
48
48
  "@xylabs/threads": "~5.1.1",
49
- "@xylabs/toolchain": "~7.13.8",
50
- "@xylabs/tsconfig": "~7.13.8",
49
+ "@xylabs/toolchain": "~7.13.13",
50
+ "@xylabs/tsconfig": "~7.13.13",
51
51
  "@xyo-network/account": "~5.6.1",
52
52
  "@xyo-network/account-model": "~5.6.2",
53
53
  "@xyo-network/api": "~5.6.1",
@@ -90,51 +90,51 @@
90
90
  "zod": "~4.4.3"
91
91
  },
92
92
  "peerDependencies": {
93
- "@bitauth/libauth": ">=3.0.0 <3.1",
94
- "@metamask/providers": ">=22.1.1 <23",
95
- "@opentelemetry/api": ">=1.9.1 <2",
96
- "@opentelemetry/sdk-trace-base": ">=2.7.1 <3",
97
- "@scure/base": ">=2.2.0 <2.3",
98
- "@scure/bip39": ">=2.2.0 <2.3",
99
- "@xylabs/geo": ">=5.1.1 <6",
100
- "@xylabs/sdk-js": ">=5.1.1 <6",
101
- "@xylabs/threads": ">=5.1.1 <5.2",
102
- "@xyo-network/account": ">=5.6.1 <5.7",
103
- "@xyo-network/account-model": ">=5.6.2 <5.7",
104
- "@xyo-network/api": ">=5.6.1 <5.7",
105
- "@xyo-network/api-models": ">=5.6.2 <5.7",
106
- "@xyo-network/boundwitness-builder": ">=5.6.1 <5.7",
107
- "@xyo-network/boundwitness-model": ">=5.6.2 <5.7",
108
- "@xyo-network/boundwitness-wrapper": ">=5.6.1 <5.7",
109
- "@xyo-network/config-payload-plugin": ">=5.6.2 <5.7",
110
- "@xyo-network/huri": ">=5.6.1 <5.7",
111
- "@xyo-network/manifest-model": ">=5.6.2 <5.7",
112
- "@xyo-network/payload-builder": ">=5.6.1 <5.7",
113
- "@xyo-network/payload-model": ">=5.6.2 <5.7",
114
- "@xyo-network/payload-plugin": ">=5.6.2 <5.7",
115
- "@xyo-network/payload-wrapper": ">=5.6.1 <5.7",
116
- "@xyo-network/query-payload-plugin": ">=5.6.2 <5.7",
117
- "@xyo-network/sdk-js": ">=5.6.3 <6",
118
- "@xyo-network/sdk-protocol-js": ">=5.6.2 <5.7",
119
- "@xyo-network/wallet": ">=5.6.1 <5.7",
120
- "@xyo-network/wallet-model": ">=5.6.2 <6",
121
- "ajv": ">=8.20.0 <9",
122
- "async-mutex": ">=0.5.0 <1",
123
- "bn.js": ">=5.2.3 <6",
124
- "buffer": ">=6.0.3 <7",
125
- "chalk": ">=5.6.2 <6",
126
- "debug": ">=4.4.3 <4.5",
127
- "ethers": ">=6.16.0 <7",
128
- "hash-wasm": ">=4.12.0 <4.13",
129
- "idb": ">=8.0.3 <9",
130
- "lru-cache": ">=11.3.6 <12",
131
- "mapbox-gl": ">=3.23.1 <4",
132
- "observable-fns": ">=0.6.1 <0.7",
133
- "pako": ">=2.1.0 <3",
134
- "store2": ">=2.14.4 <2.15",
135
- "wasm-feature-detect": ">=1.8.0 <1.9",
136
- "webextension-polyfill": ">=0.12.0 <1",
137
- "zod": ">=4.4.3 <4.5"
93
+ "@bitauth/libauth": "~3.0",
94
+ "@metamask/providers": "^22.1",
95
+ "@opentelemetry/api": "^1.9",
96
+ "@opentelemetry/sdk-trace-base": "^2.7",
97
+ "@scure/base": "~2.2",
98
+ "@scure/bip39": "~2.2",
99
+ "@xylabs/geo": "^5.1",
100
+ "@xylabs/sdk-js": "^5.1",
101
+ "@xylabs/threads": "~5.1",
102
+ "@xyo-network/account": "~5.6",
103
+ "@xyo-network/account-model": "~5.6",
104
+ "@xyo-network/api": "~5.6",
105
+ "@xyo-network/api-models": "~5.6",
106
+ "@xyo-network/boundwitness-builder": "~5.6",
107
+ "@xyo-network/boundwitness-model": "~5.6",
108
+ "@xyo-network/boundwitness-wrapper": "~5.6",
109
+ "@xyo-network/config-payload-plugin": "~5.6",
110
+ "@xyo-network/huri": "~5.6",
111
+ "@xyo-network/manifest-model": "~5.6",
112
+ "@xyo-network/payload-builder": "~5.6",
113
+ "@xyo-network/payload-model": "~5.6",
114
+ "@xyo-network/payload-plugin": "~5.6",
115
+ "@xyo-network/payload-wrapper": "~5.6",
116
+ "@xyo-network/query-payload-plugin": "~5.6",
117
+ "@xyo-network/sdk-js": "^5.6",
118
+ "@xyo-network/sdk-protocol-js": "~5.6",
119
+ "@xyo-network/wallet": "~5.6",
120
+ "@xyo-network/wallet-model": "^5.6",
121
+ "ajv": "^8.20",
122
+ "async-mutex": "^0.5",
123
+ "bn.js": "^5.2",
124
+ "buffer": "^6.0",
125
+ "chalk": "^5.6",
126
+ "debug": "~4.4",
127
+ "ethers": "^6.16",
128
+ "hash-wasm": "~4.12",
129
+ "idb": "^8.0",
130
+ "lru-cache": "^11.3",
131
+ "mapbox-gl": "^3.23",
132
+ "observable-fns": "~0.6",
133
+ "pako": "^2.1",
134
+ "store2": "~2.14",
135
+ "wasm-feature-detect": "~1.8",
136
+ "webextension-polyfill": "^0.12",
137
+ "zod": "~4.4"
138
138
  },
139
139
  "engines": {
140
140
  "node": ">=22.3"