@xyo-network/key-model 5.3.30 → 5.4.1

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 +0 -475
  2. package/package.json +5 -9
package/README.md CHANGED
@@ -38,481 +38,6 @@ bun add {{name}}
38
38
 
39
39
  See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
40
40
 
41
- ## Reference
42
-
43
- ### packages
44
-
45
- ### protocol
46
-
47
- ### packages
48
-
49
- ### crypto
50
-
51
- ### packages
52
-
53
- ### key-model
54
-
55
- ### .temp-typedoc
56
-
57
- ### interfaces
58
-
59
- ### <a id="AddressValueInstance"></a>AddressValueInstance
60
-
61
- [**@xyo-network/key-model**](#../README)
62
-
63
- ***
64
-
65
- ## Extends
66
-
67
- - `EllipticKeyInstance`
68
-
69
- ## Properties
70
-
71
- ### base58
72
-
73
- ```ts
74
- base58: string;
75
- ```
76
-
77
- ### Inherited from
78
-
79
- ```ts
80
- EllipticKeyInstance.base58
81
- ```
82
-
83
- ***
84
-
85
- ### bytes
86
-
87
- ```ts
88
- bytes: ArrayBufferLike;
89
- ```
90
-
91
- ### Inherited from
92
-
93
- ```ts
94
- EllipticKeyInstance.bytes
95
- ```
96
-
97
- ***
98
-
99
- ### hex
100
-
101
- ```ts
102
- hex: BrandedHex;
103
- ```
104
-
105
- ### Inherited from
106
-
107
- ```ts
108
- EllipticKeyInstance.hex
109
- ```
110
-
111
- ***
112
-
113
- ### keccak256
114
-
115
- ```ts
116
- keccak256: ArrayBufferLike;
117
- ```
118
-
119
- ### Inherited from
120
-
121
- ```ts
122
- EllipticKeyInstance.keccak256
123
- ```
124
-
125
- ### <a id="AddressValueStatic"></a>AddressValueStatic
126
-
127
- [**@xyo-network/key-model**](#../README)
128
-
129
- ***
130
-
131
- ## Constructors
132
-
133
- ### Constructor
134
-
135
- ```ts
136
- new AddressValueStatic(address): AddressValueInstance;
137
- ```
138
-
139
- ### Parameters
140
-
141
- #### address
142
-
143
- `ArrayBuffer`
144
-
145
- ### Returns
146
-
147
- [`AddressValueInstance`](#AddressValueInstance)
148
-
149
- ## Methods
150
-
151
- ### addressFromAddressOrPublicKey()
152
-
153
- ```ts
154
- addressFromAddressOrPublicKey(bytes): ArrayBufferLike;
155
- ```
156
-
157
- ### Parameters
158
-
159
- #### bytes
160
-
161
- `ArrayBufferLike`
162
-
163
- ### Returns
164
-
165
- `ArrayBufferLike`
166
-
167
- ***
168
-
169
- ### addressFromPublicKey()
170
-
171
- ```ts
172
- addressFromPublicKey(key): ArrayBufferLike;
173
- ```
174
-
175
- ### Parameters
176
-
177
- #### key
178
-
179
- `ArrayBufferLike`
180
-
181
- ### Returns
182
-
183
- `ArrayBufferLike`
184
-
185
- ***
186
-
187
- ### isAddress()
188
-
189
- ```ts
190
- isAddress(value): boolean;
191
- ```
192
-
193
- ### Parameters
194
-
195
- #### value
196
-
197
- `unknown`
198
-
199
- ### Returns
200
-
201
- `boolean`
202
-
203
- ### <a id="PrivateKeyConfig"></a>PrivateKeyConfig
204
-
205
- [**@xyo-network/key-model**](#../README)
206
-
207
- ***
208
-
209
- ## Properties
210
-
211
- ### privateKeyData?
212
-
213
- ```ts
214
- optional privateKeyData?: ArrayBufferLike;
215
- ```
216
-
217
- ### <a id="PrivateKeyInstance"></a>PrivateKeyInstance
218
-
219
- [**@xyo-network/key-model**](#../README)
220
-
221
- ***
222
-
223
- ## Extends
224
-
225
- - `EllipticKeyInstance`
226
-
227
- ## Properties
228
-
229
- ### base58
230
-
231
- ```ts
232
- base58: string;
233
- ```
234
-
235
- ### Inherited from
236
-
237
- ```ts
238
- EllipticKeyInstance.base58
239
- ```
240
-
241
- ***
242
-
243
- ### bytes
244
-
245
- ```ts
246
- bytes: ArrayBufferLike;
247
- ```
248
-
249
- ### Inherited from
250
-
251
- ```ts
252
- EllipticKeyInstance.bytes
253
- ```
254
-
255
- ***
256
-
257
- ### hex
258
-
259
- ```ts
260
- hex: BrandedHex;
261
- ```
262
-
263
- ### Inherited from
264
-
265
- ```ts
266
- EllipticKeyInstance.hex
267
- ```
268
-
269
- ***
270
-
271
- ### keccak256
272
-
273
- ```ts
274
- keccak256: ArrayBufferLike;
275
- ```
276
-
277
- ### Inherited from
278
-
279
- ```ts
280
- EllipticKeyInstance.keccak256
281
- ```
282
-
283
- ***
284
-
285
- ### public
286
-
287
- ```ts
288
- public: PublicKeyInstance;
289
- ```
290
-
291
- ***
292
-
293
- ### sign
294
-
295
- ```ts
296
- sign: (hash) => ArrayBufferLike | Promise<ArrayBufferLike>;
297
- ```
298
-
299
- ### Parameters
300
-
301
- #### hash
302
-
303
- `ArrayBufferLike`
304
-
305
- ### Returns
306
-
307
- `ArrayBufferLike` \| `Promise`\<`ArrayBufferLike`\>
308
-
309
- ***
310
-
311
- ### verify
312
-
313
- ```ts
314
- verify: (msg, signature) => boolean | Promise<boolean>;
315
- ```
316
-
317
- ### Parameters
318
-
319
- #### msg
320
-
321
- `ArrayBufferLike`
322
-
323
- #### signature
324
-
325
- `ArrayBufferLike`
326
-
327
- ### Returns
328
-
329
- `boolean` \| `Promise`\<`boolean`\>
330
-
331
- ### <a id="PrivateKeyStatic"></a>PrivateKeyStatic
332
-
333
- [**@xyo-network/key-model**](#../README)
334
-
335
- ***
336
-
337
- ## Methods
338
-
339
- ### create()
340
-
341
- ```ts
342
- create(value): Promise<PrivateKeyInstance>;
343
- ```
344
-
345
- ### Parameters
346
-
347
- #### value
348
-
349
- `bigint` \| `ArrayBufferLike`
350
-
351
- ### Returns
352
-
353
- `Promise`\<[`PrivateKeyInstance`](#PrivateKeyInstance)\>
354
-
355
- ***
356
-
357
- ### isPrivateKey()
358
-
359
- ```ts
360
- isPrivateKey(value): boolean;
361
- ```
362
-
363
- ### Parameters
364
-
365
- #### value
366
-
367
- `unknown`
368
-
369
- ### Returns
370
-
371
- `boolean`
372
-
373
- ### <a id="PublicKeyInstance"></a>PublicKeyInstance
374
-
375
- [**@xyo-network/key-model**](#../README)
376
-
377
- ***
378
-
379
- ## Extends
380
-
381
- - `EllipticKeyInstance`
382
-
383
- ## Properties
384
-
385
- ### base58
386
-
387
- ```ts
388
- base58: string;
389
- ```
390
-
391
- ### Inherited from
392
-
393
- ```ts
394
- EllipticKeyInstance.base58
395
- ```
396
-
397
- ***
398
-
399
- ### bytes
400
-
401
- ```ts
402
- bytes: ArrayBufferLike;
403
- ```
404
-
405
- ### Inherited from
406
-
407
- ```ts
408
- EllipticKeyInstance.bytes
409
- ```
410
-
411
- ***
412
-
413
- ### hex
414
-
415
- ```ts
416
- hex: BrandedHex;
417
- ```
418
-
419
- ### Inherited from
420
-
421
- ```ts
422
- EllipticKeyInstance.hex
423
- ```
424
-
425
- ***
426
-
427
- ### keccak256
428
-
429
- ```ts
430
- keccak256: ArrayBufferLike;
431
- ```
432
-
433
- ### Inherited from
434
-
435
- ```ts
436
- EllipticKeyInstance.keccak256
437
- ```
438
-
439
- ## Accessors
440
-
441
- ### address
442
-
443
- ### Get Signature
444
-
445
- ```ts
446
- get address(): AddressValueInstance;
447
- ```
448
-
449
- #### Returns
450
-
451
- [`AddressValueInstance`](#AddressValueInstance)
452
-
453
- ## Methods
454
-
455
- ### verify()
456
-
457
- ```ts
458
- verify(msg, signature): boolean | Promise<boolean>;
459
- ```
460
-
461
- ### Parameters
462
-
463
- #### msg
464
-
465
- `ArrayBufferLike`
466
-
467
- #### signature
468
-
469
- `ArrayBufferLike`
470
-
471
- ### Returns
472
-
473
- `boolean` \| `Promise`\<`boolean`\>
474
-
475
- ### <a id="PublicKeyStatic"></a>PublicKeyStatic
476
-
477
- [**@xyo-network/key-model**](#../README)
478
-
479
- ***
480
-
481
- ## Methods
482
-
483
- ### create()
484
-
485
- ```ts
486
- create(bytes): Promise<PublicKeyInstance>;
487
- ```
488
-
489
- ### Parameters
490
-
491
- #### bytes
492
-
493
- `ArrayBufferLike`
494
-
495
- ### Returns
496
-
497
- `Promise`\<[`PublicKeyInstance`](#PublicKeyInstance)\>
498
-
499
- ***
500
-
501
- ### isPublicKey()
502
-
503
- ```ts
504
- isPublicKey(value): boolean;
505
- ```
506
-
507
- ### Parameters
508
-
509
- #### value
510
-
511
- `unknown`
512
-
513
- ### Returns
514
-
515
- `boolean`
516
41
 
517
42
 
518
43
  [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/key-model",
3
- "version": "5.3.30",
3
+ "version": "5.4.1",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -22,12 +22,10 @@
22
22
  "exports": {
23
23
  ".": {
24
24
  "types": "./dist/neutral/index.d.ts",
25
- "import": "./dist/neutral/index.mjs",
26
25
  "default": "./dist/neutral/index.mjs"
27
26
  },
28
27
  "./package.json": "./package.json"
29
28
  },
30
- "types": "dist/neutral/index.d.ts",
31
29
  "files": [
32
30
  "dist",
33
31
  "!**/*.bench.*",
@@ -36,15 +34,13 @@
36
34
  "README.md"
37
35
  ],
38
36
  "dependencies": {
39
- "@xyo-network/data": "~5.3.30"
37
+ "@xyo-network/data": "~5.4.1"
40
38
  },
41
39
  "devDependencies": {
42
40
  "@opentelemetry/api": "^1.9.1",
43
- "@xylabs/sdk-js": "^5.0.95",
44
- "@xylabs/ts-scripts-common": "~7.8.7",
45
- "@xylabs/ts-scripts-pnpm": "~7.8.7",
46
- "@xylabs/tsconfig": "~7.8.7",
47
- "axios": "^1.14.0",
41
+ "@xylabs/sdk-js": "^5.0.97",
42
+ "@xylabs/toolchain": "~7.10.8",
43
+ "@xylabs/tsconfig": "~7.10.8",
48
44
  "pako": "~2.1.0",
49
45
  "typescript": "~5.9.3",
50
46
  "zod": "^4.3.6"