@xyo-network/xl1-wrappers 1.28.0 → 1.28.3

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 +83 -6
  2. package/package.json +54 -54
package/README.md CHANGED
@@ -1,24 +1,101 @@
1
+ [![logo][]][logo-link]
2
+
1
3
  # @xyo-network/xl1-wrappers
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
+ > Object wrappers around raw XL1 protocol payloads — convenient accessors for transactions, chains, fees, and signatures.
9
+
10
+ ## About
11
+
12
+ XL1 protocol data is stored as plain payloads and bound witnesses. This package gives you ergonomic wrapper classes around those raw shapes — typed accessors for fees, signatures, transaction fields, and chain context — so application code can read protocol data without manually walking nested object structures.
5
13
 
6
- > XYO Layer One SDK Wrappers
14
+ It's bundled into the [`@xyo-network/xl1-sdk`](https://www.npmjs.com/package/@xyo-network/xl1-sdk) aggregate. Install directly when you only need wrappers.
7
15
 
8
16
  ## Install
9
17
 
18
+ Using npm:
19
+
20
+ ```sh
21
+ npm i --save @xyo-network/xl1-wrappers
22
+ ```
23
+
24
+ Using yarn:
25
+
26
+ ```sh
27
+ yarn add @xyo-network/xl1-wrappers
28
+ ```
29
+
30
+ Using pnpm:
31
+
10
32
  ```sh
11
- {{pm}} add {{name}}
33
+ pnpm add @xyo-network/xl1-wrappers
12
34
  ```
13
35
 
36
+ Using bun:
37
+
38
+ ```sh
39
+ bun add @xyo-network/xl1-wrappers
40
+ ```
41
+
42
+ ## What's Inside
43
+
44
+ - **`Base`** — base wrapper that other wrappers extend
45
+ - **`chain/`** — chain-context wrappers
46
+ - **`transaction/`** — transaction wrappers (signed/unsigned, fields, balances)
47
+ - **`Fees`** — typed fee accessors over raw transaction payloads
48
+ - **`Signature`** — signature inspection and validation helpers
49
+ - **`lib/`** — shared utilities used across the wrappers
50
+
51
+ ## Building Locally
52
+
53
+ ```sh
54
+ xy build @xyo-network/xl1-wrappers
55
+ xy test @xyo-network/xl1-wrappers
56
+ xy lint @xyo-network/xl1-wrappers
57
+ ```
58
+
59
+ ## Maintainers
60
+
61
+ <table>
62
+ <tr>
63
+ <td align="center" valign="top" width="120" bgcolor="#000000" style="background-color:#000000;">
64
+ <a href="https://github.com/arietrouw">
65
+ <img src="https://github.com/arietrouw.png" width="80" height="80" alt="Arie Trouw" /><br />
66
+ <sub><b>Arie Trouw</b></sub>
67
+ </a>
68
+ <br />
69
+ <a href="https://arietrouw.com">arietrouw.com</a>
70
+ </td>
71
+ <td align="center" valign="top" width="120" bgcolor="#000000" style="background-color:#000000;">
72
+ <a href="https://github.com/jonesmac">
73
+ <img src="https://github.com/jonesmac.png" width="80" height="80" alt="Matt Jones" /><br />
74
+ <sub><b>Matt Jones</b></sub>
75
+ </a>
76
+ </td>
77
+ <td align="center" valign="top" width="120" bgcolor="#000000" style="background-color:#000000;">
78
+ <a href="https://github.com/JoelBCarter">
79
+ <img src="https://github.com/JoelBCarter.png" width="80" height="80" alt="Joel Carter" /><br />
80
+ <sub><b>Joel Carter</b></sub>
81
+ </a>
82
+ </td>
83
+ </tr>
84
+ </table>
14
85
 
15
86
  ## License
16
87
 
17
- See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
88
+ See the [LICENSE](./LICENSE) file (LGPL-3.0-only).
89
+
90
+ ## Credits
18
91
 
92
+ [Made with 🔥 and ❄️ by XYO](https://xyo.network)
19
93
 
94
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
95
+ [logo-link]: https://xyo.network
20
96
 
21
97
  [npm-badge]: https://img.shields.io/npm/v/@xyo-network/xl1-wrappers.svg
22
98
  [npm-link]: https://www.npmjs.com/package/@xyo-network/xl1-wrappers
99
+
23
100
  [license-badge]: https://img.shields.io/npm/l/@xyo-network/xl1-wrappers.svg
24
- [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
101
+ [license-link]: ./LICENSE
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-wrappers",
4
- "version": "1.28.0",
4
+ "version": "1.28.3",
5
5
  "description": "XYO Layer One SDK Wrappers",
6
6
  "homepage": "https://xylabs.com",
7
7
  "bugs": {
@@ -35,9 +35,9 @@
35
35
  "README.md"
36
36
  ],
37
37
  "dependencies": {
38
- "@xyo-network/xl1-validation": "~1.28.0",
39
- "@xyo-network/xl1-protocol-sdk": "~1.28.0",
40
- "@xyo-network/xl1-protocol-lib": "~1.28.0"
38
+ "@xyo-network/xl1-protocol-sdk": "~1.28.3",
39
+ "@xyo-network/xl1-protocol-lib": "~1.28.3",
40
+ "@xyo-network/xl1-validation": "~1.28.3"
41
41
  },
42
42
  "devDependencies": {
43
43
  "@bitauth/libauth": "~3.0.0",
@@ -50,8 +50,8 @@
50
50
  "@xylabs/geo": "^5.1.1",
51
51
  "@xylabs/sdk-js": "^5.1.1",
52
52
  "@xylabs/threads": "~5.1.1",
53
- "@xylabs/toolchain": "~7.13.8",
54
- "@xylabs/tsconfig": "~7.13.8",
53
+ "@xylabs/toolchain": "~7.13.13",
54
+ "@xylabs/tsconfig": "~7.13.13",
55
55
  "@xyo-network/account": "~5.6.1",
56
56
  "@xyo-network/account-model": "~5.6.2",
57
57
  "@xyo-network/api": "~5.6.1",
@@ -93,56 +93,56 @@
93
93
  "wasm-feature-detect": "~1.8.0",
94
94
  "webextension-polyfill": "^0.12.0",
95
95
  "zod": "~4.4.3",
96
- "@xyo-network/xl1-test": "~1.28.0"
96
+ "@xyo-network/xl1-test": "~1.28.3"
97
97
  },
98
98
  "peerDependencies": {
99
- "@bitauth/libauth": ">=3.0.0 <3.1",
100
- "@metamask/providers": ">=22.1.1 <23",
101
- "@opentelemetry/api": ">=1.9.1 <2",
102
- "@opentelemetry/sdk-trace-base": ">=2.7.1 <3",
103
- "@scure/base": ">=2.2.0 <2.3",
104
- "@scure/bip39": ">=2.2.0 <2.3",
105
- "@xylabs/fetch": ">=5.1.1 <6",
106
- "@xylabs/geo": ">=5.1.1 <6",
107
- "@xylabs/sdk-js": ">=5.1.1 <6",
108
- "@xylabs/threads": ">=5.1.1 <5.2",
109
- "@xyo-network/account": ">=5.6.1 <5.7",
110
- "@xyo-network/account-model": ">=5.6.2 <5.7",
111
- "@xyo-network/api": ">=5.6.1 <5.7",
112
- "@xyo-network/api-models": ">=5.6.2 <5.7",
113
- "@xyo-network/boundwitness-builder": ">=5.6.1 <5.7",
114
- "@xyo-network/boundwitness-model": ">=5.6.2 <5.7",
115
- "@xyo-network/boundwitness-wrapper": ">=5.6.1 <5.7",
116
- "@xyo-network/config-payload-plugin": ">=5.6.2 <5.7",
117
- "@xyo-network/huri": ">=5.6.1 <5.7",
118
- "@xyo-network/manifest-model": ">=5.6.2 <5.7",
119
- "@xyo-network/payload-builder": ">=5.6.1 <5.7",
120
- "@xyo-network/payload-model": ">=5.6.2 <5.7",
121
- "@xyo-network/payload-plugin": ">=5.6.2 <5.7",
122
- "@xyo-network/payload-wrapper": ">=5.6.1 <5.7",
123
- "@xyo-network/query-payload-plugin": ">=5.6.2 <5.7",
124
- "@xyo-network/sdk-js": ">=5.6.3 <6",
125
- "@xyo-network/sdk-protocol-js": ">=5.6.2 <5.7",
126
- "@xyo-network/wallet": ">=5.6.1 <5.7",
127
- "@xyo-network/wallet-model": ">=5.6.2 <6",
128
- "ajv": ">=8.20.0 <9",
129
- "async-mutex": ">=0.5.0 <1",
130
- "bn.js": ">=5.2.3 <6",
131
- "buffer": ">=6.0.3 <7",
132
- "chalk": ">=5.6.2 <6",
133
- "cosmiconfig": ">=9.0.1 <10",
134
- "debug": ">=4.4.3 <4.5",
135
- "ethers": ">=6.16.0 <7",
136
- "hash-wasm": ">=4.12.0 <4.13",
137
- "idb": ">=8.0.3 <9",
138
- "lru-cache": ">=11.3.6 <12",
139
- "mapbox-gl": ">=3.23.1 <4",
140
- "observable-fns": ">=0.6.1 <0.7",
141
- "pako": ">=2.1.0 <3",
142
- "store2": ">=2.14.4 <2.15",
143
- "wasm-feature-detect": ">=1.8.0 <1.9",
144
- "webextension-polyfill": ">=0.12.0 <1",
145
- "zod": ">=4.4.3 <4.5"
99
+ "@bitauth/libauth": "~3.0",
100
+ "@metamask/providers": "^22.1",
101
+ "@opentelemetry/api": "^1.9",
102
+ "@opentelemetry/sdk-trace-base": "^2.7",
103
+ "@scure/base": "~2.2",
104
+ "@scure/bip39": "~2.2",
105
+ "@xylabs/fetch": "^5.1",
106
+ "@xylabs/geo": "^5.1",
107
+ "@xylabs/sdk-js": "^5.1",
108
+ "@xylabs/threads": "~5.1",
109
+ "@xyo-network/account": "~5.6",
110
+ "@xyo-network/account-model": "~5.6",
111
+ "@xyo-network/api": "~5.6",
112
+ "@xyo-network/api-models": "~5.6",
113
+ "@xyo-network/boundwitness-builder": "~5.6",
114
+ "@xyo-network/boundwitness-model": "~5.6",
115
+ "@xyo-network/boundwitness-wrapper": "~5.6",
116
+ "@xyo-network/config-payload-plugin": "~5.6",
117
+ "@xyo-network/huri": "~5.6",
118
+ "@xyo-network/manifest-model": "~5.6",
119
+ "@xyo-network/payload-builder": "~5.6",
120
+ "@xyo-network/payload-model": "~5.6",
121
+ "@xyo-network/payload-plugin": "~5.6",
122
+ "@xyo-network/payload-wrapper": "~5.6",
123
+ "@xyo-network/query-payload-plugin": "~5.6",
124
+ "@xyo-network/sdk-js": "^5.6",
125
+ "@xyo-network/sdk-protocol-js": "~5.6",
126
+ "@xyo-network/wallet": "~5.6",
127
+ "@xyo-network/wallet-model": "^5.6",
128
+ "ajv": "^8.20",
129
+ "async-mutex": "^0.5",
130
+ "bn.js": "^5.2",
131
+ "buffer": "^6.0",
132
+ "chalk": "^5.6",
133
+ "cosmiconfig": "^9.0",
134
+ "debug": "~4.4",
135
+ "ethers": "^6.16",
136
+ "hash-wasm": "~4.12",
137
+ "idb": "^8.0",
138
+ "lru-cache": "^11.3",
139
+ "mapbox-gl": "^3.23",
140
+ "observable-fns": "~0.6",
141
+ "pako": "^2.1",
142
+ "store2": "~2.14",
143
+ "wasm-feature-detect": "~1.8",
144
+ "webextension-polyfill": "^0.12",
145
+ "zod": "~4.4"
146
146
  },
147
147
  "engines": {
148
148
  "node": ">=22.3"