@xyo-network/xl1-network-model 1.15.2 → 1.15.4

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 -67
  2. package/package.json +17 -17
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @xyo-network/chain-network-model
1
+ # @xyo-network/xl1-network-model
2
2
 
3
3
  [![logo][]](https://xyo.network)
4
4
 
@@ -14,7 +14,7 @@ XYO Layer One API
14
14
 
15
15
  ## Reference
16
16
 
17
- **@xyo-network/chain-network-model**
17
+ **@xyo-network/xl1-network-model**
18
18
 
19
19
  ***
20
20
 
@@ -64,7 +64,7 @@ Renames and re-exports [LocalNetworkIconString](#variables/LocalNetworkIconStrin
64
64
 
65
65
  ### <a id="getNetworkNode"></a>getNetworkNode
66
66
 
67
- [**@xyo-network/chain-network-model**](#../README)
67
+ [**@xyo-network/xl1-network-model**](#../README)
68
68
 
69
69
  ***
70
70
 
@@ -78,7 +78,7 @@ function getNetworkNode(): Promise<MemoryNode<MemoryNodeParams, NodeModuleEventD
78
78
 
79
79
  ### <a id="getNetworkNodes"></a>getNetworkNodes
80
80
 
81
- [**@xyo-network/chain-network-model**](#../README)
81
+ [**@xyo-network/xl1-network-model**](#../README)
82
82
 
83
83
  ***
84
84
 
@@ -92,7 +92,7 @@ function getNetworkNodes(): Map<string, AttachableNodeInstance<NodeParams<AnyCon
92
92
 
93
93
  ### <a id="initNetworkNode"></a>initNetworkNode
94
94
 
95
- [**@xyo-network/chain-network-model**](#../README)
95
+ [**@xyo-network/xl1-network-model**](#../README)
96
96
 
97
97
  ***
98
98
 
@@ -114,7 +114,7 @@ function initNetworkNode(activeNetwork): Promise<AttachableNodeInstance<NodePara
114
114
 
115
115
  ### <a id="ChainConnection"></a>ChainConnection
116
116
 
117
- [**@xyo-network/chain-network-model**](#../README)
117
+ [**@xyo-network/xl1-network-model**](#../README)
118
118
 
119
119
  ***
120
120
 
@@ -131,7 +131,8 @@ only for backward compatibility
131
131
  ### ~~chain?~~
132
132
 
133
133
  ```ts
134
- optional chain: Lowercase<string>;
134
+ optional chain: Brand<Lowercase<string>, {
135
+ }>;
135
136
  ```
136
137
 
137
138
  Chain Identifier - can be a hex (eth contract address) or a string
@@ -158,7 +159,7 @@ Url for accessing the network
158
159
 
159
160
  ### <a id="ChainForkFields"></a>ChainForkFields
160
161
 
161
- [**@xyo-network/chain-network-model**](#../README)
162
+ [**@xyo-network/xl1-network-model**](#../README)
162
163
 
163
164
  ***
164
165
 
@@ -191,14 +192,16 @@ Hash in the last block the chain was forked from
191
192
  ### forkedChainId?
192
193
 
193
194
  ```ts
194
- optional forkedChainId: Lowercase<string>;
195
+ optional forkedChainId: Brand<Brand<Lowercase<string>, {
196
+ }>, {
197
+ }>;
195
198
  ```
196
199
 
197
200
  Address of the forked chain
198
201
 
199
202
  ### <a id="Network"></a>Network
200
203
 
201
- [**@xyo-network/chain-network-model**](#../README)
204
+ [**@xyo-network/xl1-network-model**](#../README)
202
205
 
203
206
  ***
204
207
 
@@ -211,16 +214,15 @@ Address of the forked chain
211
214
  ### chain?
212
215
 
213
216
  ```ts
214
- optional chain: Lowercase<string>;
217
+ optional chain: Brand<Lowercase<string>, {
218
+ }>;
215
219
  ```
216
220
 
217
221
  Chain Identifier - can be a hex (eth contract address) or a string
218
222
 
219
223
  ### Inherited from
220
224
 
221
- ```ts
222
- NetworkBootstrap.chain
223
- ```
225
+ [`ChainConnection`](#ChainConnection).[`chain`](ChainConnection.md#chain)
224
226
 
225
227
  ***
226
228
 
@@ -234,9 +236,7 @@ Name of the chain
234
236
 
235
237
  ### Inherited from
236
238
 
237
- ```ts
238
- NetworkBootstrap.name
239
- ```
239
+ [`ChainConnection`](#ChainConnection).[`name`](ChainConnection.md#name)
240
240
 
241
241
  ***
242
242
 
@@ -250,9 +250,7 @@ Url for accessing the network
250
250
 
251
251
  ### Inherited from
252
252
 
253
- ```ts
254
- NetworkBootstrap.url
255
- ```
253
+ [`ChainConnection`](#ChainConnection).[`url`](ChainConnection.md#url)
256
254
 
257
255
  ***
258
256
 
@@ -266,9 +264,7 @@ Block Number at which the chain was forked from
266
264
 
267
265
  ### Inherited from
268
266
 
269
- ```ts
270
- NetworkBootstrap.forkedAtLastBlockNumber
271
- ```
267
+ [`ChainForkFields`](#ChainForkFields).[`forkedAtLastBlockNumber`](ChainForkFields.md#forkedatlastblocknumber)
272
268
 
273
269
  ***
274
270
 
@@ -282,25 +278,23 @@ Hash in the last block the chain was forked from
282
278
 
283
279
  ### Inherited from
284
280
 
285
- ```ts
286
- NetworkBootstrap.forkedAtLastHash
287
- ```
281
+ [`ChainForkFields`](#ChainForkFields).[`forkedAtLastHash`](ChainForkFields.md#forkedatlasthash)
288
282
 
289
283
  ***
290
284
 
291
285
  ### forkedChainId?
292
286
 
293
287
  ```ts
294
- optional forkedChainId: Lowercase<string>;
288
+ optional forkedChainId: Brand<Brand<Lowercase<string>, {
289
+ }>, {
290
+ }>;
295
291
  ```
296
292
 
297
293
  Address of the forked chain
298
294
 
299
295
  ### Inherited from
300
296
 
301
- ```ts
302
- NetworkBootstrap.forkedChainId
303
- ```
297
+ [`ChainForkFields`](#ChainForkFields).[`forkedChainId`](ChainForkFields.md#forkedchainid)
304
298
 
305
299
  ***
306
300
 
@@ -314,9 +308,7 @@ Description of the network
314
308
 
315
309
  ### Inherited from
316
310
 
317
- ```ts
318
- NetworkBootstrap.description
319
- ```
311
+ [`NetworkFields`](#NetworkFields).[`description`](NetworkFields.md#description)
320
312
 
321
313
  ***
322
314
 
@@ -330,9 +322,7 @@ Url for accessing the network explorer
330
322
 
331
323
  ### Inherited from
332
324
 
333
- ```ts
334
- NetworkBootstrap.explorerUrl
335
- ```
325
+ [`NetworkFields`](#NetworkFields).[`explorerUrl`](NetworkFields.md#explorerurl)
336
326
 
337
327
  ***
338
328
 
@@ -346,9 +336,7 @@ string representation of the icon (svg)
346
336
 
347
337
  ### Inherited from
348
338
 
349
- ```ts
350
- NetworkBootstrap.icon
351
- ```
339
+ [`NetworkFields`](#NetworkFields).[`icon`](NetworkFields.md#icon)
352
340
 
353
341
  ***
354
342
 
@@ -362,9 +350,7 @@ Machine-readable identifier
362
350
 
363
351
  ### Inherited from
364
352
 
365
- ```ts
366
- NetworkBootstrap.id
367
- ```
353
+ [`NetworkFields`](#NetworkFields).[`id`](NetworkFields.md#id)
368
354
 
369
355
  ***
370
356
 
@@ -378,9 +364,7 @@ Symbol of the network
378
364
 
379
365
  ### Inherited from
380
366
 
381
- ```ts
382
- NetworkBootstrap.symbol
383
- ```
367
+ [`NetworkFields`](#NetworkFields).[`symbol`](NetworkFields.md#symbol)
384
368
 
385
369
  ***
386
370
 
@@ -392,7 +376,7 @@ custom: boolean;
392
376
 
393
377
  ### <a id="NetworkBootstrapFields"></a>NetworkBootstrapFields
394
378
 
395
- [**@xyo-network/chain-network-model**](#../README)
379
+ [**@xyo-network/xl1-network-model**](#../README)
396
380
 
397
381
  ***
398
382
 
@@ -407,7 +391,8 @@ Note: Optional Properties can be found walking the chain to the genesis block
407
391
  ### chain?
408
392
 
409
393
  ```ts
410
- optional chain: Lowercase<string>;
394
+ optional chain: Brand<Lowercase<string>, {
395
+ }>;
411
396
  ```
412
397
 
413
398
  Chain Identifier - can be a hex (eth contract address) or a string
@@ -477,7 +462,9 @@ Hash in the last block the chain was forked from
477
462
  ### forkedChainId?
478
463
 
479
464
  ```ts
480
- optional forkedChainId: Lowercase<string>;
465
+ optional forkedChainId: Brand<Brand<Lowercase<string>, {
466
+ }>, {
467
+ }>;
481
468
  ```
482
469
 
483
470
  Address of the forked chain
@@ -570,7 +557,7 @@ Symbol of the network
570
557
 
571
558
  ### <a id="NetworkFields"></a>NetworkFields
572
559
 
573
- [**@xyo-network/chain-network-model**](#../README)
560
+ [**@xyo-network/xl1-network-model**](#../README)
574
561
 
575
562
  ***
576
563
 
@@ -640,7 +627,7 @@ Symbol of the network
640
627
 
641
628
  ### <a id="NetworkBootstrap"></a>NetworkBootstrap
642
629
 
643
- [**@xyo-network/chain-network-model**](#../README)
630
+ [**@xyo-network/xl1-network-model**](#../README)
644
631
 
645
632
  ***
646
633
 
@@ -650,7 +637,7 @@ type NetworkBootstrap = Payload<NetworkBootstrapFields, NetworkBootstrapSchema>;
650
637
 
651
638
  ### <a id="NetworkBootstrapSchema"></a>NetworkBootstrapSchema
652
639
 
653
- [**@xyo-network/chain-network-model**](#../README)
640
+ [**@xyo-network/xl1-network-model**](#../README)
654
641
 
655
642
  ***
656
643
 
@@ -662,7 +649,7 @@ type NetworkBootstrapSchema = typeof NetworkBootstrapSchema;
662
649
 
663
650
  ### <a id="DefaultNetworks"></a>DefaultNetworks
664
651
 
665
- [**@xyo-network/chain-network-model**](#../README)
652
+ [**@xyo-network/xl1-network-model**](#../README)
666
653
 
667
654
  ***
668
655
 
@@ -672,7 +659,7 @@ const DefaultNetworks: NetworkBootstrap[];
672
659
 
673
660
  ### <a id="LocalNetwork"></a>LocalNetwork
674
661
 
675
- [**@xyo-network/chain-network-model**](#../README)
662
+ [**@xyo-network/xl1-network-model**](#../README)
676
663
 
677
664
  ***
678
665
 
@@ -682,7 +669,7 @@ const LocalNetwork: NetworkBootstrap;
682
669
 
683
670
  ### <a id="LocalNetworkIconString"></a>LocalNetworkIconString
684
671
 
685
- [**@xyo-network/chain-network-model**](#../README)
672
+ [**@xyo-network/xl1-network-model**](#../README)
686
673
 
687
674
  ***
688
675
 
@@ -692,7 +679,7 @@ const LocalNetworkIconString: string;
692
679
 
693
680
  ### <a id="MainNetwork"></a>MainNetwork
694
681
 
695
- [**@xyo-network/chain-network-model**](#../README)
682
+ [**@xyo-network/xl1-network-model**](#../README)
696
683
 
697
684
  ***
698
685
 
@@ -702,7 +689,7 @@ const MainNetwork: NetworkBootstrap;
702
689
 
703
690
  ### <a id="NetworkBootstrapSchema"></a>NetworkBootstrapSchema
704
691
 
705
- [**@xyo-network/chain-network-model**](#../README)
692
+ [**@xyo-network/xl1-network-model**](#../README)
706
693
 
707
694
  ***
708
695
 
@@ -712,7 +699,7 @@ const NetworkBootstrapSchema: "network.xyo.network.bootstrap";
712
699
 
713
700
  ### <a id="SequenceNetwork"></a>SequenceNetwork
714
701
 
715
- [**@xyo-network/chain-network-model**](#../README)
702
+ [**@xyo-network/xl1-network-model**](#../README)
716
703
 
717
704
  ***
718
705
 
@@ -722,7 +709,7 @@ const SequenceNetwork: NetworkBootstrap;
722
709
 
723
710
  ### <a id="asOptionalNetwork"></a>asOptionalNetwork
724
711
 
725
- [**@xyo-network/chain-network-model**](#../README)
712
+ [**@xyo-network/xl1-network-model**](#../README)
726
713
 
727
714
  ***
728
715
 
@@ -742,7 +729,7 @@ const asOptionalNetwork: (value) => undefined | NetworkBootstrap;
742
729
 
743
730
  ### <a id="isNetworkBootstrap"></a>isNetworkBootstrap
744
731
 
745
- [**@xyo-network/chain-network-model**](#../README)
732
+ [**@xyo-network/xl1-network-model**](#../README)
746
733
 
747
734
  ***
748
735
 
@@ -778,14 +765,14 @@ const isNetworkBootstrap: (x?) => x is NetworkBootstrap;
778
765
 
779
766
  [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
780
767
 
781
- [npm-badge]: https://img.shields.io/npm/v/@xyo-network/chain-network-model.svg
782
- [npm-link]: https://www.npmjs.com/package/@xyo-network/chain-network-model
768
+ [npm-badge]: https://img.shields.io/npm/v/@xyo-network/xl1-network-model.svg
769
+ [npm-link]: https://www.npmjs.com/package/@xyo-network/xl1-network-model
783
770
 
784
- [npm-downloads-badge]: https://img.shields.io/npm/dw/@xyo-network/chain-network-model
785
- [npm-license-badge]: https://img.shields.io/npm/l/@xyo-network/chain-network-model
771
+ [npm-downloads-badge]: https://img.shields.io/npm/dw/@xyo-network/xl1-network-model
772
+ [npm-license-badge]: https://img.shields.io/npm/l/@xyo-network/xl1-network-model
786
773
 
787
- [jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xyo-network/chain-network-model/badge
788
- [jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xyo-network/chain-network-model
774
+ [jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xyo-network/xl1-network-model/badge
775
+ [jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xyo-network/xl1-network-model
789
776
 
790
- [socket-badge]: https://socket.dev/api/badge/npm/package/@xyo-network/chain-network-model
791
- [socket-link]: https://socket.dev/npm/package/@xyo-network/chain-network-model
777
+ [socket-badge]: https://socket.dev/api/badge/npm/package/@xyo-network/xl1-network-model
778
+ [socket-link]: https://socket.dev/npm/package/@xyo-network/xl1-network-model
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-network-model",
4
- "version": "1.15.2",
4
+ "version": "1.15.4",
5
5
  "description": "XYO Layer One API",
6
6
  "homepage": "https://xylabs.com",
7
7
  "bugs": {
@@ -46,25 +46,25 @@
46
46
  "src"
47
47
  ],
48
48
  "dependencies": {
49
- "@xylabs/hex": "~5.0.11",
50
- "@xylabs/object": "~5.0.11",
51
- "@xyo-network/manifest-model": "~5.1.3",
52
- "@xyo-network/manifest-wrapper": "~5.1.3",
53
- "@xyo-network/module-factory-locator": "~5.1.3",
54
- "@xyo-network/node-model": "~5.1.3",
55
- "@xyo-network/payload-model": "~5.1.3",
56
- "@xyo-network/wallet": "~5.1.3",
57
- "@xyo-network/xl1-protocol": "~1.12.40"
49
+ "@xylabs/hex": "~5.0.12",
50
+ "@xylabs/object": "~5.0.12",
51
+ "@xyo-network/manifest-model": "~5.1.6",
52
+ "@xyo-network/manifest-wrapper": "~5.1.6",
53
+ "@xyo-network/module-factory-locator": "~5.1.6",
54
+ "@xyo-network/node-model": "~5.1.6",
55
+ "@xyo-network/payload-model": "~5.1.6",
56
+ "@xyo-network/wallet": "~5.1.6",
57
+ "@xyo-network/xl1-protocol": "~1.12.69"
58
58
  },
59
59
  "devDependencies": {
60
- "@types/node": "~24.5.2",
61
- "@xylabs/ts-scripts-yarn3": "~7.1.7",
62
- "@xylabs/tsconfig": "~7.1.7",
63
- "@xylabs/vitest-extended": "~5.0.11",
60
+ "@types/node": "~24.7.2",
61
+ "@xylabs/ts-scripts-yarn3": "~7.1.8",
62
+ "@xylabs/tsconfig": "~7.1.8",
63
+ "@xylabs/vitest-extended": "~5.0.12",
64
64
  "copyfiles": "~2.4.1",
65
- "dotenv": "~17.2.2",
66
- "eslint": "^9.36.0",
67
- "typescript": "~5.9.2",
65
+ "dotenv": "~17.2.3",
66
+ "eslint": "^9.37.0",
67
+ "typescript": "~5.9.3",
68
68
  "vitest": "~3.2.4"
69
69
  },
70
70
  "packageManager": "yarn@4.6.0",