@xyo-network/xl1-network-model 1.26.13 → 1.26.15
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.
package/README.md
CHANGED
|
@@ -1,765 +1,24 @@
|
|
|
1
1
|
# @xyo-network/xl1-network-model
|
|
2
2
|
|
|
3
|
-
[![
|
|
3
|
+
[![npm][npm-badge]][npm-link]
|
|
4
|
+
[![license][license-badge]][license-link]
|
|
4
5
|
|
|
5
|
-
|
|
6
|
-
[![npm-downloads-badge][]][npm-link]
|
|
7
|
-
[![jsdelivr-badge][]][jsdelivr-link]
|
|
8
|
-
[![npm-license-badge][]](LICENSE)
|
|
9
|
-
[![socket-badge][]][socket-link]
|
|
6
|
+
> XYO Layer One API
|
|
10
7
|
|
|
11
|
-
|
|
8
|
+
## Install
|
|
12
9
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
## Reference
|
|
16
|
-
|
|
17
|
-
**@xyo-network/xl1-network-model**
|
|
18
|
-
|
|
19
|
-
***
|
|
20
|
-
|
|
21
|
-
## Interfaces
|
|
22
|
-
|
|
23
|
-
- [ChainConnection](#interfaces/ChainConnection)
|
|
24
|
-
- [ChainForkFields](#interfaces/ChainForkFields)
|
|
25
|
-
- [NetworkFields](#interfaces/NetworkFields)
|
|
26
|
-
- [NetworkBootstrapFields](#interfaces/NetworkBootstrapFields)
|
|
27
|
-
- [Network](#interfaces/Network)
|
|
28
|
-
|
|
29
|
-
## Type Aliases
|
|
30
|
-
|
|
31
|
-
- [NetworkBootstrapSchema](#type-aliases/NetworkBootstrapSchema)
|
|
32
|
-
- [NetworkBootstrap](#type-aliases/NetworkBootstrap)
|
|
33
|
-
|
|
34
|
-
## Variables
|
|
35
|
-
|
|
36
|
-
- [LocalNetworkIconString](#variables/LocalNetworkIconString)
|
|
37
|
-
- [MainNetwork](#variables/MainNetwork)
|
|
38
|
-
- [SequenceNetwork](#variables/SequenceNetwork)
|
|
39
|
-
- [LocalNetwork](#variables/LocalNetwork)
|
|
40
|
-
- [DefaultNetworks](#variables/DefaultNetworks)
|
|
41
|
-
- [NetworkBootstrapSchema](#variables/NetworkBootstrapSchema)
|
|
42
|
-
- [isNetworkBootstrap](#variables/isNetworkBootstrap)
|
|
43
|
-
- [asOptionalNetwork](#variables/asOptionalNetwork)
|
|
44
|
-
|
|
45
|
-
## Functions
|
|
46
|
-
|
|
47
|
-
- [getNetworkNode](#functions/getNetworkNode)
|
|
48
|
-
- [getNetworkNodes](#functions/getNetworkNodes)
|
|
49
|
-
- [initNetworkNode](#functions/initNetworkNode)
|
|
50
|
-
|
|
51
|
-
## References
|
|
52
|
-
|
|
53
|
-
### MainNetworkIconString
|
|
54
|
-
|
|
55
|
-
Renames and re-exports [LocalNetworkIconString](#variables/LocalNetworkIconString)
|
|
56
|
-
|
|
57
|
-
***
|
|
58
|
-
|
|
59
|
-
### SequenceNetworkIconString
|
|
60
|
-
|
|
61
|
-
Renames and re-exports [LocalNetworkIconString](#variables/LocalNetworkIconString)
|
|
62
|
-
|
|
63
|
-
### functions
|
|
64
|
-
|
|
65
|
-
### <a id="getNetworkNode"></a>getNetworkNode
|
|
66
|
-
|
|
67
|
-
[**@xyo-network/xl1-network-model**](#../README)
|
|
68
|
-
|
|
69
|
-
***
|
|
70
|
-
|
|
71
|
-
```ts
|
|
72
|
-
function getNetworkNode(): Promise<MemoryNode<MemoryNodeParams, NodeModuleEventData>>;
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
## Returns
|
|
76
|
-
|
|
77
|
-
`Promise`\<`MemoryNode`\<`MemoryNodeParams`, `NodeModuleEventData`\>\>
|
|
78
|
-
|
|
79
|
-
### <a id="getNetworkNodes"></a>getNetworkNodes
|
|
80
|
-
|
|
81
|
-
[**@xyo-network/xl1-network-model**](#../README)
|
|
82
|
-
|
|
83
|
-
***
|
|
84
|
-
|
|
85
|
-
```ts
|
|
86
|
-
function getNetworkNodes(): Map<string, AttachableNodeInstance<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>>;
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
## Returns
|
|
90
|
-
|
|
91
|
-
`Map`\<`string`, `AttachableNodeInstance`\<`NodeParams`\<`AnyConfigSchema`\<`NodeConfig`\>\>, `NodeModuleEventData`\>\>
|
|
92
|
-
|
|
93
|
-
### <a id="initNetworkNode"></a>initNetworkNode
|
|
94
|
-
|
|
95
|
-
[**@xyo-network/xl1-network-model**](#../README)
|
|
96
|
-
|
|
97
|
-
***
|
|
98
|
-
|
|
99
|
-
```ts
|
|
100
|
-
function initNetworkNode(activeNetwork): Promise<AttachableNodeInstance<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>>;
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
## Parameters
|
|
104
|
-
|
|
105
|
-
### activeNetwork
|
|
106
|
-
|
|
107
|
-
[`NetworkBootstrap`](#../type-aliases/NetworkBootstrap)
|
|
108
|
-
|
|
109
|
-
## Returns
|
|
110
|
-
|
|
111
|
-
`Promise`\<`AttachableNodeInstance`\<`NodeParams`\<`AnyConfigSchema`\<`NodeConfig`\>\>, `NodeModuleEventData`\>\>
|
|
112
|
-
|
|
113
|
-
### interfaces
|
|
114
|
-
|
|
115
|
-
### <a id="ChainConnection"></a>ChainConnection
|
|
116
|
-
|
|
117
|
-
[**@xyo-network/xl1-network-model**](#../README)
|
|
118
|
-
|
|
119
|
-
***
|
|
120
|
-
|
|
121
|
-
## Extended by
|
|
122
|
-
|
|
123
|
-
- [`NetworkBootstrapFields`](#NetworkBootstrapFields)
|
|
124
|
-
|
|
125
|
-
## Properties
|
|
126
|
-
|
|
127
|
-
### chain?
|
|
128
|
-
|
|
129
|
-
```ts
|
|
130
|
-
optional chain: ChainId;
|
|
131
|
-
```
|
|
132
|
-
|
|
133
|
-
Chain Identifier - can be a hex (eth contract address) or a string
|
|
134
|
-
|
|
135
|
-
***
|
|
136
|
-
|
|
137
|
-
### name
|
|
138
|
-
|
|
139
|
-
```ts
|
|
140
|
-
name: string;
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
Name of the chain
|
|
144
|
-
|
|
145
|
-
***
|
|
146
|
-
|
|
147
|
-
### url
|
|
148
|
-
|
|
149
|
-
```ts
|
|
150
|
-
url: string;
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
Url for accessing the network
|
|
154
|
-
|
|
155
|
-
### <a id="ChainForkFields"></a>ChainForkFields
|
|
156
|
-
|
|
157
|
-
[**@xyo-network/xl1-network-model**](#../README)
|
|
158
|
-
|
|
159
|
-
***
|
|
160
|
-
|
|
161
|
-
## Extended by
|
|
162
|
-
|
|
163
|
-
- [`NetworkBootstrapFields`](#NetworkBootstrapFields)
|
|
164
|
-
|
|
165
|
-
## Properties
|
|
166
|
-
|
|
167
|
-
### forkedAtLastBlockNumber?
|
|
168
|
-
|
|
169
|
-
```ts
|
|
170
|
-
optional forkedAtLastBlockNumber: string;
|
|
171
|
-
```
|
|
172
|
-
|
|
173
|
-
Block Number at which the chain was forked from
|
|
174
|
-
|
|
175
|
-
***
|
|
176
|
-
|
|
177
|
-
### forkedAtLastHash?
|
|
178
|
-
|
|
179
|
-
```ts
|
|
180
|
-
optional forkedAtLastHash: string;
|
|
181
|
-
```
|
|
182
|
-
|
|
183
|
-
Hash in the last block the chain was forked from
|
|
184
|
-
|
|
185
|
-
***
|
|
186
|
-
|
|
187
|
-
### forkedChainId?
|
|
188
|
-
|
|
189
|
-
```ts
|
|
190
|
-
optional forkedChainId: Address;
|
|
191
|
-
```
|
|
192
|
-
|
|
193
|
-
Address of the forked chain
|
|
194
|
-
|
|
195
|
-
### <a id="Network"></a>Network
|
|
196
|
-
|
|
197
|
-
[**@xyo-network/xl1-network-model**](#../README)
|
|
198
|
-
|
|
199
|
-
***
|
|
200
|
-
|
|
201
|
-
## Extends
|
|
202
|
-
|
|
203
|
-
- [`NetworkBootstrap`](#../type-aliases/NetworkBootstrap)
|
|
204
|
-
|
|
205
|
-
## Properties
|
|
206
|
-
|
|
207
|
-
### chain?
|
|
208
|
-
|
|
209
|
-
```ts
|
|
210
|
-
optional chain: ChainId;
|
|
211
|
-
```
|
|
212
|
-
|
|
213
|
-
Chain Identifier - can be a hex (eth contract address) or a string
|
|
214
|
-
|
|
215
|
-
### Inherited from
|
|
216
|
-
|
|
217
|
-
[`ChainConnection`](#ChainConnection).[`chain`](ChainConnection.md#chain)
|
|
218
|
-
|
|
219
|
-
***
|
|
220
|
-
|
|
221
|
-
### name
|
|
222
|
-
|
|
223
|
-
```ts
|
|
224
|
-
name: string;
|
|
225
|
-
```
|
|
226
|
-
|
|
227
|
-
Name of the chain
|
|
228
|
-
|
|
229
|
-
### Inherited from
|
|
230
|
-
|
|
231
|
-
[`ChainConnection`](#ChainConnection).[`name`](ChainConnection.md#name)
|
|
232
|
-
|
|
233
|
-
***
|
|
234
|
-
|
|
235
|
-
### url
|
|
236
|
-
|
|
237
|
-
```ts
|
|
238
|
-
url: string;
|
|
239
|
-
```
|
|
240
|
-
|
|
241
|
-
Url for accessing the network
|
|
242
|
-
|
|
243
|
-
### Inherited from
|
|
244
|
-
|
|
245
|
-
[`ChainConnection`](#ChainConnection).[`url`](ChainConnection.md#url)
|
|
246
|
-
|
|
247
|
-
***
|
|
248
|
-
|
|
249
|
-
### forkedAtLastBlockNumber?
|
|
250
|
-
|
|
251
|
-
```ts
|
|
252
|
-
optional forkedAtLastBlockNumber: string;
|
|
253
|
-
```
|
|
254
|
-
|
|
255
|
-
Block Number at which the chain was forked from
|
|
256
|
-
|
|
257
|
-
### Inherited from
|
|
258
|
-
|
|
259
|
-
[`ChainForkFields`](#ChainForkFields).[`forkedAtLastBlockNumber`](ChainForkFields.md#forkedatlastblocknumber)
|
|
260
|
-
|
|
261
|
-
***
|
|
262
|
-
|
|
263
|
-
### forkedAtLastHash?
|
|
264
|
-
|
|
265
|
-
```ts
|
|
266
|
-
optional forkedAtLastHash: string;
|
|
267
|
-
```
|
|
268
|
-
|
|
269
|
-
Hash in the last block the chain was forked from
|
|
270
|
-
|
|
271
|
-
### Inherited from
|
|
272
|
-
|
|
273
|
-
[`ChainForkFields`](#ChainForkFields).[`forkedAtLastHash`](ChainForkFields.md#forkedatlasthash)
|
|
274
|
-
|
|
275
|
-
***
|
|
276
|
-
|
|
277
|
-
### forkedChainId?
|
|
278
|
-
|
|
279
|
-
```ts
|
|
280
|
-
optional forkedChainId: Address;
|
|
281
|
-
```
|
|
282
|
-
|
|
283
|
-
Address of the forked chain
|
|
284
|
-
|
|
285
|
-
### Inherited from
|
|
286
|
-
|
|
287
|
-
[`ChainForkFields`](#ChainForkFields).[`forkedChainId`](ChainForkFields.md#forkedchainid)
|
|
288
|
-
|
|
289
|
-
***
|
|
290
|
-
|
|
291
|
-
### description
|
|
292
|
-
|
|
293
|
-
```ts
|
|
294
|
-
description: string;
|
|
295
|
-
```
|
|
296
|
-
|
|
297
|
-
Description of the network
|
|
298
|
-
|
|
299
|
-
### Inherited from
|
|
300
|
-
|
|
301
|
-
[`NetworkFields`](#NetworkFields).[`description`](NetworkFields.md#description)
|
|
302
|
-
|
|
303
|
-
***
|
|
304
|
-
|
|
305
|
-
### explorerUrl?
|
|
306
|
-
|
|
307
|
-
```ts
|
|
308
|
-
optional explorerUrl: string;
|
|
309
|
-
```
|
|
310
|
-
|
|
311
|
-
Url for accessing the network explorer
|
|
312
|
-
|
|
313
|
-
### Inherited from
|
|
314
|
-
|
|
315
|
-
[`NetworkFields`](#NetworkFields).[`explorerUrl`](NetworkFields.md#explorerurl)
|
|
316
|
-
|
|
317
|
-
***
|
|
318
|
-
|
|
319
|
-
### icon?
|
|
320
|
-
|
|
321
|
-
```ts
|
|
322
|
-
optional icon: string;
|
|
323
|
-
```
|
|
324
|
-
|
|
325
|
-
string representation of the icon (svg)
|
|
326
|
-
|
|
327
|
-
### Inherited from
|
|
328
|
-
|
|
329
|
-
[`NetworkFields`](#NetworkFields).[`icon`](NetworkFields.md#icon)
|
|
330
|
-
|
|
331
|
-
***
|
|
332
|
-
|
|
333
|
-
### id
|
|
334
|
-
|
|
335
|
-
```ts
|
|
336
|
-
id: DefaultNetworkIds;
|
|
337
|
-
```
|
|
338
|
-
|
|
339
|
-
Machine-readable identifier
|
|
340
|
-
|
|
341
|
-
### Inherited from
|
|
342
|
-
|
|
343
|
-
[`NetworkFields`](#NetworkFields).[`id`](NetworkFields.md#id)
|
|
344
|
-
|
|
345
|
-
***
|
|
346
|
-
|
|
347
|
-
### symbol?
|
|
348
|
-
|
|
349
|
-
```ts
|
|
350
|
-
optional symbol: string;
|
|
351
|
-
```
|
|
352
|
-
|
|
353
|
-
Symbol of the network
|
|
354
|
-
|
|
355
|
-
### Inherited from
|
|
356
|
-
|
|
357
|
-
[`NetworkFields`](#NetworkFields).[`symbol`](NetworkFields.md#symbol)
|
|
358
|
-
|
|
359
|
-
***
|
|
360
|
-
|
|
361
|
-
### custom
|
|
362
|
-
|
|
363
|
-
```ts
|
|
364
|
-
custom: boolean;
|
|
365
|
-
```
|
|
366
|
-
|
|
367
|
-
### <a id="NetworkBootstrapFields"></a>NetworkBootstrapFields
|
|
368
|
-
|
|
369
|
-
[**@xyo-network/xl1-network-model**](#../README)
|
|
370
|
-
|
|
371
|
-
***
|
|
372
|
-
|
|
373
|
-
Note: Optional Properties can be found walking the chain to the genesis block
|
|
374
|
-
|
|
375
|
-
## Extends
|
|
376
|
-
|
|
377
|
-
- [`NetworkFields`](#NetworkFields).[`ChainForkFields`](#ChainForkFields).[`ChainConnection`](#ChainConnection)
|
|
378
|
-
|
|
379
|
-
## Properties
|
|
380
|
-
|
|
381
|
-
### chain?
|
|
382
|
-
|
|
383
|
-
```ts
|
|
384
|
-
optional chain: ChainId;
|
|
385
|
-
```
|
|
386
|
-
|
|
387
|
-
Chain Identifier - can be a hex (eth contract address) or a string
|
|
388
|
-
|
|
389
|
-
### Inherited from
|
|
390
|
-
|
|
391
|
-
[`ChainConnection`](#ChainConnection).[`chain`](ChainConnection.md#chain)
|
|
392
|
-
|
|
393
|
-
***
|
|
394
|
-
|
|
395
|
-
### name
|
|
396
|
-
|
|
397
|
-
```ts
|
|
398
|
-
name: string;
|
|
399
|
-
```
|
|
400
|
-
|
|
401
|
-
Name of the chain
|
|
402
|
-
|
|
403
|
-
### Inherited from
|
|
404
|
-
|
|
405
|
-
[`ChainConnection`](#ChainConnection).[`name`](ChainConnection.md#name)
|
|
406
|
-
|
|
407
|
-
***
|
|
408
|
-
|
|
409
|
-
### url
|
|
410
|
-
|
|
411
|
-
```ts
|
|
412
|
-
url: string;
|
|
413
|
-
```
|
|
414
|
-
|
|
415
|
-
Url for accessing the network
|
|
416
|
-
|
|
417
|
-
### Inherited from
|
|
418
|
-
|
|
419
|
-
[`ChainConnection`](#ChainConnection).[`url`](ChainConnection.md#url)
|
|
420
|
-
|
|
421
|
-
***
|
|
422
|
-
|
|
423
|
-
### forkedAtLastBlockNumber?
|
|
424
|
-
|
|
425
|
-
```ts
|
|
426
|
-
optional forkedAtLastBlockNumber: string;
|
|
427
|
-
```
|
|
428
|
-
|
|
429
|
-
Block Number at which the chain was forked from
|
|
430
|
-
|
|
431
|
-
### Inherited from
|
|
432
|
-
|
|
433
|
-
[`ChainForkFields`](#ChainForkFields).[`forkedAtLastBlockNumber`](ChainForkFields.md#forkedatlastblocknumber)
|
|
434
|
-
|
|
435
|
-
***
|
|
436
|
-
|
|
437
|
-
### forkedAtLastHash?
|
|
438
|
-
|
|
439
|
-
```ts
|
|
440
|
-
optional forkedAtLastHash: string;
|
|
441
|
-
```
|
|
442
|
-
|
|
443
|
-
Hash in the last block the chain was forked from
|
|
444
|
-
|
|
445
|
-
### Inherited from
|
|
446
|
-
|
|
447
|
-
[`ChainForkFields`](#ChainForkFields).[`forkedAtLastHash`](ChainForkFields.md#forkedatlasthash)
|
|
448
|
-
|
|
449
|
-
***
|
|
450
|
-
|
|
451
|
-
### forkedChainId?
|
|
452
|
-
|
|
453
|
-
```ts
|
|
454
|
-
optional forkedChainId: Address;
|
|
455
|
-
```
|
|
456
|
-
|
|
457
|
-
Address of the forked chain
|
|
458
|
-
|
|
459
|
-
### Inherited from
|
|
460
|
-
|
|
461
|
-
[`ChainForkFields`](#ChainForkFields).[`forkedChainId`](ChainForkFields.md#forkedchainid)
|
|
462
|
-
|
|
463
|
-
***
|
|
464
|
-
|
|
465
|
-
### description
|
|
466
|
-
|
|
467
|
-
```ts
|
|
468
|
-
description: string;
|
|
469
|
-
```
|
|
470
|
-
|
|
471
|
-
Description of the network
|
|
472
|
-
|
|
473
|
-
### Inherited from
|
|
474
|
-
|
|
475
|
-
[`NetworkFields`](#NetworkFields).[`description`](NetworkFields.md#description)
|
|
476
|
-
|
|
477
|
-
***
|
|
478
|
-
|
|
479
|
-
### explorerUrl?
|
|
480
|
-
|
|
481
|
-
```ts
|
|
482
|
-
optional explorerUrl: string;
|
|
483
|
-
```
|
|
484
|
-
|
|
485
|
-
Url for accessing the network explorer
|
|
486
|
-
|
|
487
|
-
### Inherited from
|
|
488
|
-
|
|
489
|
-
[`NetworkFields`](#NetworkFields).[`explorerUrl`](NetworkFields.md#explorerurl)
|
|
490
|
-
|
|
491
|
-
***
|
|
492
|
-
|
|
493
|
-
### icon?
|
|
494
|
-
|
|
495
|
-
```ts
|
|
496
|
-
optional icon: string;
|
|
497
|
-
```
|
|
498
|
-
|
|
499
|
-
string representation of the icon (svg)
|
|
500
|
-
|
|
501
|
-
### Inherited from
|
|
502
|
-
|
|
503
|
-
[`NetworkFields`](#NetworkFields).[`icon`](NetworkFields.md#icon)
|
|
504
|
-
|
|
505
|
-
***
|
|
506
|
-
|
|
507
|
-
### id
|
|
508
|
-
|
|
509
|
-
```ts
|
|
510
|
-
id: DefaultNetworkIds;
|
|
511
|
-
```
|
|
512
|
-
|
|
513
|
-
Machine-readable identifier
|
|
514
|
-
|
|
515
|
-
### Inherited from
|
|
516
|
-
|
|
517
|
-
[`NetworkFields`](#NetworkFields).[`id`](NetworkFields.md#id)
|
|
518
|
-
|
|
519
|
-
***
|
|
520
|
-
|
|
521
|
-
### schema
|
|
522
|
-
|
|
523
|
-
```ts
|
|
524
|
-
schema: "network.xyo.network.bootstrap";
|
|
525
|
-
```
|
|
526
|
-
|
|
527
|
-
### Inherited from
|
|
528
|
-
|
|
529
|
-
[`NetworkFields`](#NetworkFields).[`schema`](NetworkFields.md#schema)
|
|
530
|
-
|
|
531
|
-
***
|
|
532
|
-
|
|
533
|
-
### symbol?
|
|
534
|
-
|
|
535
|
-
```ts
|
|
536
|
-
optional symbol: string;
|
|
537
|
-
```
|
|
538
|
-
|
|
539
|
-
Symbol of the network
|
|
540
|
-
|
|
541
|
-
### Inherited from
|
|
542
|
-
|
|
543
|
-
[`NetworkFields`](#NetworkFields).[`symbol`](NetworkFields.md#symbol)
|
|
544
|
-
|
|
545
|
-
### <a id="NetworkFields"></a>NetworkFields
|
|
546
|
-
|
|
547
|
-
[**@xyo-network/xl1-network-model**](#../README)
|
|
548
|
-
|
|
549
|
-
***
|
|
550
|
-
|
|
551
|
-
## Extended by
|
|
552
|
-
|
|
553
|
-
- [`NetworkBootstrapFields`](#NetworkBootstrapFields)
|
|
554
|
-
|
|
555
|
-
## Properties
|
|
556
|
-
|
|
557
|
-
### description
|
|
558
|
-
|
|
559
|
-
```ts
|
|
560
|
-
description: string;
|
|
561
|
-
```
|
|
562
|
-
|
|
563
|
-
Description of the network
|
|
564
|
-
|
|
565
|
-
***
|
|
566
|
-
|
|
567
|
-
### explorerUrl?
|
|
568
|
-
|
|
569
|
-
```ts
|
|
570
|
-
optional explorerUrl: string;
|
|
571
|
-
```
|
|
572
|
-
|
|
573
|
-
Url for accessing the network explorer
|
|
574
|
-
|
|
575
|
-
***
|
|
576
|
-
|
|
577
|
-
### icon?
|
|
578
|
-
|
|
579
|
-
```ts
|
|
580
|
-
optional icon: string;
|
|
581
|
-
```
|
|
582
|
-
|
|
583
|
-
string representation of the icon (svg)
|
|
584
|
-
|
|
585
|
-
***
|
|
586
|
-
|
|
587
|
-
### id
|
|
588
|
-
|
|
589
|
-
```ts
|
|
590
|
-
id: DefaultNetworkIds;
|
|
591
|
-
```
|
|
592
|
-
|
|
593
|
-
Machine-readable identifier
|
|
594
|
-
|
|
595
|
-
***
|
|
596
|
-
|
|
597
|
-
### schema
|
|
598
|
-
|
|
599
|
-
```ts
|
|
600
|
-
schema: "network.xyo.network.bootstrap";
|
|
601
|
-
```
|
|
602
|
-
|
|
603
|
-
***
|
|
604
|
-
|
|
605
|
-
### symbol?
|
|
606
|
-
|
|
607
|
-
```ts
|
|
608
|
-
optional symbol: string;
|
|
609
|
-
```
|
|
610
|
-
|
|
611
|
-
Symbol of the network
|
|
612
|
-
|
|
613
|
-
### type-aliases
|
|
614
|
-
|
|
615
|
-
### <a id="NetworkBootstrap"></a>NetworkBootstrap
|
|
616
|
-
|
|
617
|
-
[**@xyo-network/xl1-network-model**](#../README)
|
|
618
|
-
|
|
619
|
-
***
|
|
620
|
-
|
|
621
|
-
```ts
|
|
622
|
-
type NetworkBootstrap = Payload<NetworkBootstrapFields, NetworkBootstrapSchema>;
|
|
623
|
-
```
|
|
624
|
-
|
|
625
|
-
### <a id="NetworkBootstrapSchema"></a>NetworkBootstrapSchema
|
|
626
|
-
|
|
627
|
-
[**@xyo-network/xl1-network-model**](#../README)
|
|
628
|
-
|
|
629
|
-
***
|
|
630
|
-
|
|
631
|
-
```ts
|
|
632
|
-
type NetworkBootstrapSchema = typeof NetworkBootstrapSchema;
|
|
633
|
-
```
|
|
634
|
-
|
|
635
|
-
### variables
|
|
636
|
-
|
|
637
|
-
### <a id="DefaultNetworks"></a>DefaultNetworks
|
|
638
|
-
|
|
639
|
-
[**@xyo-network/xl1-network-model**](#../README)
|
|
640
|
-
|
|
641
|
-
***
|
|
642
|
-
|
|
643
|
-
```ts
|
|
644
|
-
const DefaultNetworks: NetworkBootstrap[];
|
|
645
|
-
```
|
|
646
|
-
|
|
647
|
-
### <a id="LocalNetwork"></a>LocalNetwork
|
|
648
|
-
|
|
649
|
-
[**@xyo-network/xl1-network-model**](#../README)
|
|
650
|
-
|
|
651
|
-
***
|
|
652
|
-
|
|
653
|
-
```ts
|
|
654
|
-
const LocalNetwork: NetworkBootstrap;
|
|
655
|
-
```
|
|
656
|
-
|
|
657
|
-
### <a id="LocalNetworkIconString"></a>LocalNetworkIconString
|
|
658
|
-
|
|
659
|
-
[**@xyo-network/xl1-network-model**](#../README)
|
|
660
|
-
|
|
661
|
-
***
|
|
662
|
-
|
|
663
|
-
```ts
|
|
664
|
-
const LocalNetworkIconString: string;
|
|
665
|
-
```
|
|
666
|
-
|
|
667
|
-
### <a id="MainNetwork"></a>MainNetwork
|
|
668
|
-
|
|
669
|
-
[**@xyo-network/xl1-network-model**](#../README)
|
|
670
|
-
|
|
671
|
-
***
|
|
672
|
-
|
|
673
|
-
```ts
|
|
674
|
-
const MainNetwork: NetworkBootstrap;
|
|
10
|
+
```sh
|
|
11
|
+
{{pm}} add {{name}}
|
|
675
12
|
```
|
|
676
13
|
|
|
677
|
-
### <a id="NetworkBootstrapSchema"></a>NetworkBootstrapSchema
|
|
678
|
-
|
|
679
|
-
[**@xyo-network/xl1-network-model**](#../README)
|
|
680
|
-
|
|
681
|
-
***
|
|
682
|
-
|
|
683
|
-
```ts
|
|
684
|
-
const NetworkBootstrapSchema: "network.xyo.network.bootstrap";
|
|
685
|
-
```
|
|
686
|
-
|
|
687
|
-
### <a id="SequenceNetwork"></a>SequenceNetwork
|
|
688
|
-
|
|
689
|
-
[**@xyo-network/xl1-network-model**](#../README)
|
|
690
|
-
|
|
691
|
-
***
|
|
692
|
-
|
|
693
|
-
```ts
|
|
694
|
-
const SequenceNetwork: NetworkBootstrap;
|
|
695
|
-
```
|
|
696
|
-
|
|
697
|
-
### <a id="asOptionalNetwork"></a>asOptionalNetwork
|
|
698
|
-
|
|
699
|
-
[**@xyo-network/xl1-network-model**](#../README)
|
|
700
|
-
|
|
701
|
-
***
|
|
702
|
-
|
|
703
|
-
```ts
|
|
704
|
-
const asOptionalNetwork: (value) => NetworkBootstrap | undefined;
|
|
705
|
-
```
|
|
706
|
-
|
|
707
|
-
## Parameters
|
|
708
|
-
|
|
709
|
-
### value
|
|
710
|
-
|
|
711
|
-
`AnyNonPromise`
|
|
712
|
-
|
|
713
|
-
## Returns
|
|
714
|
-
|
|
715
|
-
[`NetworkBootstrap`](#../type-aliases/NetworkBootstrap) \| `undefined`
|
|
716
|
-
|
|
717
|
-
### <a id="isNetworkBootstrap"></a>isNetworkBootstrap
|
|
718
|
-
|
|
719
|
-
[**@xyo-network/xl1-network-model**](#../README)
|
|
720
|
-
|
|
721
|
-
***
|
|
722
|
-
|
|
723
|
-
```ts
|
|
724
|
-
const isNetworkBootstrap: (x?) => x is NetworkBootstrap;
|
|
725
|
-
```
|
|
726
|
-
|
|
727
|
-
## Parameters
|
|
728
|
-
|
|
729
|
-
### x?
|
|
730
|
-
|
|
731
|
-
`unknown`
|
|
732
|
-
|
|
733
|
-
## Returns
|
|
734
|
-
|
|
735
|
-
`x is NetworkBootstrap`
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
## Maintainers
|
|
739
|
-
|
|
740
|
-
- [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
|
|
741
|
-
- [Matt Jones](https://github.com/jonesmac)
|
|
742
|
-
- [Joel Carter](https://github.com/JoelBCarter)
|
|
743
|
-
- [Jordan Trouw](https://github.com/jordantrouw)
|
|
744
14
|
|
|
745
15
|
## License
|
|
746
16
|
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
## Credits
|
|
17
|
+
See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
|
|
750
18
|
|
|
751
|
-
[Made with 🔥 and ❄️ by XYO](https://xyo.network)
|
|
752
19
|
|
|
753
|
-
[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
|
|
754
20
|
|
|
755
21
|
[npm-badge]: https://img.shields.io/npm/v/@xyo-network/xl1-network-model.svg
|
|
756
22
|
[npm-link]: https://www.npmjs.com/package/@xyo-network/xl1-network-model
|
|
757
|
-
|
|
758
|
-
[
|
|
759
|
-
[npm-license-badge]: https://img.shields.io/npm/l/@xyo-network/xl1-network-model
|
|
760
|
-
|
|
761
|
-
[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xyo-network/xl1-network-model/badge
|
|
762
|
-
[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xyo-network/xl1-network-model
|
|
763
|
-
|
|
764
|
-
[socket-badge]: https://socket.dev/api/badge/npm/package/@xyo-network/xl1-network-model
|
|
765
|
-
[socket-link]: https://socket.dev/npm/package/@xyo-network/xl1-network-model
|
|
23
|
+
[license-badge]: https://img.shields.io/npm/l/@xyo-network/xl1-network-model.svg
|
|
24
|
+
[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
|
|
@@ -52,5 +52,5 @@ export type NetworkBootstrap = Payload<NetworkBootstrapFields, NetworkBootstrapS
|
|
|
52
52
|
/** Type guard that checks whether a payload is a NetworkBootstrap. */
|
|
53
53
|
export declare const isNetworkBootstrap: (x?: unknown | null) => x is NetworkBootstrap;
|
|
54
54
|
/** Optionally casts a value to a Network if it is a valid NetworkBootstrap. */
|
|
55
|
-
export declare const asOptionalNetwork: (value: import("@xylabs/
|
|
55
|
+
export declare const asOptionalNetwork: (value: import("@xylabs/sdk-js").AnyNonPromise) => NetworkBootstrap | undefined;
|
|
56
56
|
//# sourceMappingURL=Bootstrap.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Bootstrap.d.ts","sourceRoot":"","sources":["../../../src/models/Bootstrap.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAE7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAElD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAA;AAE5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C,yDAAyD;AACzD,MAAM,WAAW,eAAe;IAC9B,yEAAyE;IACzE,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,oCAAoC;IACpC,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,wDAAwD;AACxD,eAAO,MAAM,sBAAsB;;CAAkD,CAAA;AACrF,kDAAkD;AAClD,MAAM,MAAM,sBAAsB,GAAG,OAAO,sBAAsB,CAAA;AAElE,6CAA6C;AAC7C,MAAM,WAAW,eAAe;IAC9B,sDAAsD;IACtD,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,uDAAuD;IACvD,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,kCAAkC;IAClC,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,6CAA6C;AAC7C,MAAM,WAAW,aAAa;IAC5B,iCAAiC;IACjC,WAAW,EAAE,MAAM,CAAA;IACnB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,8CAA8C;IAC9C,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,kCAAkC;IAClC,EAAE,EAAE,SAAS,CAAA;IACb,MAAM,EAAE,sBAAsB,CAAA;IAC9B,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,8EAA8E;AAC9E,MAAM,WAAW,sBAAuB,SAAQ,aAAa,EAAE,eAAe,EAAE,eAAe;CAAG;AAElG,0FAA0F;AAC1F,MAAM,WAAW,OAAQ,SAAQ,gBAAgB;IAC/C,MAAM,EAAE,OAAO,CAAA;CAChB;AAED,0EAA0E;AAC1E,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,CAAA;AAEtF,sEAAsE;AACtE,eAAO,MAAM,kBAAkB,+CAAkE,CAAA;AAEjG,+EAA+E;AAC/E,eAAO,MAAM,iBAAiB,
|
|
1
|
+
{"version":3,"file":"Bootstrap.d.ts","sourceRoot":"","sources":["../../../src/models/Bootstrap.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAE7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAElD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAA;AAE5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C,yDAAyD;AACzD,MAAM,WAAW,eAAe;IAC9B,yEAAyE;IACzE,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,oCAAoC;IACpC,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,wDAAwD;AACxD,eAAO,MAAM,sBAAsB;;CAAkD,CAAA;AACrF,kDAAkD;AAClD,MAAM,MAAM,sBAAsB,GAAG,OAAO,sBAAsB,CAAA;AAElE,6CAA6C;AAC7C,MAAM,WAAW,eAAe;IAC9B,sDAAsD;IACtD,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,uDAAuD;IACvD,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,kCAAkC;IAClC,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,6CAA6C;AAC7C,MAAM,WAAW,aAAa;IAC5B,iCAAiC;IACjC,WAAW,EAAE,MAAM,CAAA;IACnB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,8CAA8C;IAC9C,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,kCAAkC;IAClC,EAAE,EAAE,SAAS,CAAA;IACb,MAAM,EAAE,sBAAsB,CAAA;IAC9B,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,8EAA8E;AAC9E,MAAM,WAAW,sBAAuB,SAAQ,aAAa,EAAE,eAAe,EAAE,eAAe;CAAG;AAElG,0FAA0F;AAC1F,MAAM,WAAW,OAAQ,SAAQ,gBAAgB;IAC/C,MAAM,EAAE,OAAO,CAAA;CAChB;AAED,0EAA0E;AAC1E,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,CAAA;AAEtF,sEAAsE;AACtE,eAAO,MAAM,kBAAkB,+CAAkE,CAAA;AAEjG,+EAA+E;AAC/E,eAAO,MAAM,iBAAiB,iFAAqD,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xyo-network/xl1-network-model",
|
|
3
|
-
"version": "1.26.
|
|
3
|
+
"version": "1.26.15",
|
|
4
4
|
"description": "XYO Layer One API",
|
|
5
5
|
"homepage": "https://xylabs.com",
|
|
6
6
|
"bugs": {
|
|
@@ -23,22 +23,19 @@
|
|
|
23
23
|
".": {
|
|
24
24
|
"browser": {
|
|
25
25
|
"types": "./dist/neutral/index.d.ts",
|
|
26
|
-
"src": "./src/index.ts",
|
|
27
26
|
"default": "./dist/neutral/index.mjs"
|
|
28
27
|
},
|
|
29
28
|
"node": {
|
|
30
29
|
"types": "./dist/neutral/index.d.ts",
|
|
31
|
-
"src": "./src/index.ts",
|
|
32
30
|
"default": "./dist/neutral/index.mjs"
|
|
33
31
|
},
|
|
34
32
|
"neutral": {
|
|
35
33
|
"types": "./dist/neutral/index.d.ts",
|
|
36
|
-
"src": "./src/index.ts",
|
|
37
34
|
"default": "./dist/neutral/index.mjs"
|
|
38
|
-
}
|
|
35
|
+
},
|
|
36
|
+
"import": "./dist/neutral/index.mjs"
|
|
39
37
|
}
|
|
40
38
|
},
|
|
41
|
-
"module": "./dist/neutral/index.mjs",
|
|
42
39
|
"types": "./dist/neutral/index.d.ts",
|
|
43
40
|
"files": [
|
|
44
41
|
"dist",
|
|
@@ -48,39 +45,73 @@
|
|
|
48
45
|
"README.md"
|
|
49
46
|
],
|
|
50
47
|
"dependencies": {
|
|
51
|
-
"@xyo-network/xl1-protocol-lib": "~1.26.
|
|
48
|
+
"@xyo-network/xl1-protocol-lib": "~1.26.15"
|
|
52
49
|
},
|
|
53
50
|
"devDependencies": {
|
|
54
|
-
"@firebase/app": "0.x",
|
|
55
|
-
"@firebase/app-compat": "0.x",
|
|
56
|
-
"@firebase/app-types": "0.x",
|
|
57
|
-
"@firebase/util": "1.x",
|
|
58
|
-
"@metamask/providers": "^22",
|
|
59
51
|
"@opentelemetry/api": "^1.9.1",
|
|
60
|
-
"@types/node": "^25.5.
|
|
61
|
-
"@xylabs/
|
|
62
|
-
"@xylabs/
|
|
63
|
-
"@xylabs/ts-scripts-
|
|
64
|
-
"@xylabs/
|
|
65
|
-
"@
|
|
66
|
-
"@xyo-network/
|
|
67
|
-
"
|
|
68
|
-
"
|
|
52
|
+
"@types/node": "^25.5.2",
|
|
53
|
+
"@xylabs/sdk-js": "^5.0.95",
|
|
54
|
+
"@xylabs/ts-scripts-common": "~7.8.7",
|
|
55
|
+
"@xylabs/ts-scripts-pnpm": "~7.8.7",
|
|
56
|
+
"@xylabs/tsconfig": "~7.8.7",
|
|
57
|
+
"@xyo-network/account": "~5.3.30",
|
|
58
|
+
"@xyo-network/account-model": "~5.3.30",
|
|
59
|
+
"@xyo-network/api-models": "~5.3.30",
|
|
60
|
+
"@xyo-network/archivist-abstract": "~5.3.30",
|
|
61
|
+
"@xyo-network/archivist-generic": "~5.3.30",
|
|
62
|
+
"@xyo-network/archivist-memory": "~5.3.30",
|
|
63
|
+
"@xyo-network/archivist-model": "~5.3.30",
|
|
64
|
+
"@xyo-network/archivist-view": "~5.3.30",
|
|
65
|
+
"@xyo-network/archivist-wrapper": "~5.3",
|
|
66
|
+
"@xyo-network/boundwitness-builder": "~5.3.30",
|
|
67
|
+
"@xyo-network/boundwitness-validator": "~5.3.30",
|
|
68
|
+
"@xyo-network/bridge-abstract": "~5.3.30",
|
|
69
|
+
"@xyo-network/bridge-model": "~5.3.30",
|
|
70
|
+
"@xyo-network/config-payload-plugin": "~5.3.30",
|
|
71
|
+
"@xyo-network/data": "~5.3.30",
|
|
72
|
+
"@xyo-network/diviner-abstract": "~5.3",
|
|
73
|
+
"@xyo-network/diviner-boundwitness-memory": "~5.3.30",
|
|
74
|
+
"@xyo-network/diviner-identity": "~5.3.30",
|
|
75
|
+
"@xyo-network/diviner-model": "~5.3.30",
|
|
76
|
+
"@xyo-network/diviner-payload-generic": "~5.3.30",
|
|
77
|
+
"@xyo-network/diviner-payload-model": "~5.3.30",
|
|
78
|
+
"@xyo-network/diviner-wrapper": "~5.3",
|
|
79
|
+
"@xyo-network/dns": "~5.3.30",
|
|
80
|
+
"@xyo-network/domain-payload-plugin": "~5.3.30",
|
|
81
|
+
"@xyo-network/elliptic": "~5.3.30",
|
|
82
|
+
"@xyo-network/hash": "~5.3.30",
|
|
83
|
+
"@xyo-network/huri": "~5.3.30",
|
|
84
|
+
"@xyo-network/manifest-model": "~5.3.30",
|
|
85
|
+
"@xyo-network/module-abstract": "~5.3.30",
|
|
86
|
+
"@xyo-network/module-model": "~5.3.30",
|
|
87
|
+
"@xyo-network/module-resolver": "~5.3.30",
|
|
88
|
+
"@xyo-network/module-wrapper": "~5.3",
|
|
89
|
+
"@xyo-network/network": "~5.3.30",
|
|
90
|
+
"@xyo-network/node-abstract": "~5.3.30",
|
|
91
|
+
"@xyo-network/node-memory": "~5.3.30",
|
|
92
|
+
"@xyo-network/node-model": "~5.3.30",
|
|
93
|
+
"@xyo-network/node-view": "~5.3.30",
|
|
94
|
+
"@xyo-network/node-wrapper": "~5.3",
|
|
95
|
+
"@xyo-network/payload-builder": "~5.3.30",
|
|
96
|
+
"@xyo-network/payload-model": "~5.3.30",
|
|
97
|
+
"@xyo-network/payload-validator": "~5.3.30",
|
|
98
|
+
"@xyo-network/previous-hash-store-model": "~5.3.30",
|
|
99
|
+
"@xyo-network/sdk-js": "^5.3.30",
|
|
100
|
+
"@xyo-network/sentinel-abstract": "~5.3.30",
|
|
101
|
+
"@xyo-network/sentinel-memory": "~5.3.30",
|
|
102
|
+
"@xyo-network/sentinel-model": "~5.3.30",
|
|
103
|
+
"@xyo-network/wallet-model": "~5.3.30",
|
|
104
|
+
"@xyo-network/wasm": "~5.3.30",
|
|
105
|
+
"@xyo-network/witness-adhoc": "~5.3.30",
|
|
106
|
+
"@xyo-network/witness-model": "~5.3.30",
|
|
69
107
|
"axios": "^1.14.0",
|
|
70
|
-
"
|
|
71
|
-
"
|
|
72
|
-
"
|
|
73
|
-
"
|
|
74
|
-
"ethers": "^6.16.0",
|
|
75
|
-
"firebase": "^12",
|
|
76
|
-
"lru-cache": "^11",
|
|
77
|
-
"mapbox-gl": "^3",
|
|
78
|
-
"rollup": "^3.29.4 || ^4",
|
|
79
|
-
"tslib": "^2.8.1",
|
|
108
|
+
"dotenv": "~17.4.1",
|
|
109
|
+
"esbuild": "^0.28.0",
|
|
110
|
+
"ethers": "^6",
|
|
111
|
+
"pako": "~2.1.0",
|
|
80
112
|
"typescript": "~5.9.3",
|
|
81
|
-
"vite": "^8.0.
|
|
113
|
+
"vite": "^8.0.5",
|
|
82
114
|
"vitest": "~4.1.2",
|
|
83
|
-
"webextension-polyfill": "^0.10.0 || ^0.11.0 || ^0.12.0",
|
|
84
115
|
"zod": "~4.3.6"
|
|
85
116
|
},
|
|
86
117
|
"peerDependencies": {
|
|
@@ -89,16 +120,13 @@
|
|
|
89
120
|
"@xyo-network/sdk-js": "^5",
|
|
90
121
|
"zod": "^4"
|
|
91
122
|
},
|
|
92
|
-
"packageManager": "yarn@4.6.0",
|
|
93
123
|
"engines": {
|
|
94
124
|
"node": ">=22"
|
|
95
125
|
},
|
|
96
126
|
"volta": {
|
|
97
|
-
"node": "22.5.1"
|
|
98
|
-
"yarn": "4.6.0"
|
|
127
|
+
"node": "22.5.1"
|
|
99
128
|
},
|
|
100
129
|
"publishConfig": {
|
|
101
130
|
"access": "public"
|
|
102
|
-
}
|
|
103
|
-
|
|
104
|
-
}
|
|
131
|
+
}
|
|
132
|
+
}
|