@xyo-network/xl1-network-model 1.16.14 → 1.16.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 +13 -26
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,7 +20,7 @@ XYO Layer One API
|
|
|
20
20
|
|
|
21
21
|
## Interfaces
|
|
22
22
|
|
|
23
|
-
- [
|
|
23
|
+
- [ChainConnection](#interfaces/ChainConnection)
|
|
24
24
|
- [ChainForkFields](#interfaces/ChainForkFields)
|
|
25
25
|
- [NetworkFields](#interfaces/NetworkFields)
|
|
26
26
|
- [NetworkBootstrapFields](#interfaces/NetworkBootstrapFields)
|
|
@@ -33,6 +33,7 @@ XYO Layer One API
|
|
|
33
33
|
|
|
34
34
|
## Variables
|
|
35
35
|
|
|
36
|
+
- [LocalNetworkIconString](#variables/LocalNetworkIconString)
|
|
36
37
|
- [MainNetwork](#variables/MainNetwork)
|
|
37
38
|
- [SequenceNetwork](#variables/SequenceNetwork)
|
|
38
39
|
- [LocalNetwork](#variables/LocalNetwork)
|
|
@@ -40,7 +41,6 @@ XYO Layer One API
|
|
|
40
41
|
- [NetworkBootstrapSchema](#variables/NetworkBootstrapSchema)
|
|
41
42
|
- [isNetworkBootstrap](#variables/isNetworkBootstrap)
|
|
42
43
|
- [asOptionalNetwork](#variables/asOptionalNetwork)
|
|
43
|
-
- [LocalNetworkIconString](#variables/LocalNetworkIconString)
|
|
44
44
|
|
|
45
45
|
## Functions
|
|
46
46
|
|
|
@@ -118,28 +118,23 @@ function initNetworkNode(activeNetwork): Promise<AttachableNodeInstance<NodePara
|
|
|
118
118
|
|
|
119
119
|
***
|
|
120
120
|
|
|
121
|
-
## Deprecated
|
|
122
|
-
|
|
123
|
-
only for backward compatibility
|
|
124
|
-
|
|
125
121
|
## Extended by
|
|
126
122
|
|
|
127
123
|
- [`NetworkBootstrapFields`](#NetworkBootstrapFields)
|
|
128
124
|
|
|
129
125
|
## Properties
|
|
130
126
|
|
|
131
|
-
###
|
|
127
|
+
### chain?
|
|
132
128
|
|
|
133
129
|
```ts
|
|
134
|
-
optional chain:
|
|
135
|
-
}>;
|
|
130
|
+
optional chain: ChainId;
|
|
136
131
|
```
|
|
137
132
|
|
|
138
133
|
Chain Identifier - can be a hex (eth contract address) or a string
|
|
139
134
|
|
|
140
135
|
***
|
|
141
136
|
|
|
142
|
-
###
|
|
137
|
+
### name
|
|
143
138
|
|
|
144
139
|
```ts
|
|
145
140
|
name: string;
|
|
@@ -149,7 +144,7 @@ Name of the chain
|
|
|
149
144
|
|
|
150
145
|
***
|
|
151
146
|
|
|
152
|
-
###
|
|
147
|
+
### url
|
|
153
148
|
|
|
154
149
|
```ts
|
|
155
150
|
url: string;
|
|
@@ -192,9 +187,7 @@ Hash in the last block the chain was forked from
|
|
|
192
187
|
### forkedChainId?
|
|
193
188
|
|
|
194
189
|
```ts
|
|
195
|
-
optional forkedChainId:
|
|
196
|
-
}>, {
|
|
197
|
-
}>;
|
|
190
|
+
optional forkedChainId: Address;
|
|
198
191
|
```
|
|
199
192
|
|
|
200
193
|
Address of the forked chain
|
|
@@ -214,8 +207,7 @@ Address of the forked chain
|
|
|
214
207
|
### chain?
|
|
215
208
|
|
|
216
209
|
```ts
|
|
217
|
-
optional chain:
|
|
218
|
-
}>;
|
|
210
|
+
optional chain: ChainId;
|
|
219
211
|
```
|
|
220
212
|
|
|
221
213
|
Chain Identifier - can be a hex (eth contract address) or a string
|
|
@@ -285,9 +277,7 @@ Hash in the last block the chain was forked from
|
|
|
285
277
|
### forkedChainId?
|
|
286
278
|
|
|
287
279
|
```ts
|
|
288
|
-
optional forkedChainId:
|
|
289
|
-
}>, {
|
|
290
|
-
}>;
|
|
280
|
+
optional forkedChainId: Address;
|
|
291
281
|
```
|
|
292
282
|
|
|
293
283
|
Address of the forked chain
|
|
@@ -391,8 +381,7 @@ Note: Optional Properties can be found walking the chain to the genesis block
|
|
|
391
381
|
### chain?
|
|
392
382
|
|
|
393
383
|
```ts
|
|
394
|
-
optional chain:
|
|
395
|
-
}>;
|
|
384
|
+
optional chain: ChainId;
|
|
396
385
|
```
|
|
397
386
|
|
|
398
387
|
Chain Identifier - can be a hex (eth contract address) or a string
|
|
@@ -462,9 +451,7 @@ Hash in the last block the chain was forked from
|
|
|
462
451
|
### forkedChainId?
|
|
463
452
|
|
|
464
453
|
```ts
|
|
465
|
-
optional forkedChainId:
|
|
466
|
-
}>, {
|
|
467
|
-
}>;
|
|
454
|
+
optional forkedChainId: Address;
|
|
468
455
|
```
|
|
469
456
|
|
|
470
457
|
Address of the forked chain
|
|
@@ -714,7 +701,7 @@ const SequenceNetwork: NetworkBootstrap;
|
|
|
714
701
|
***
|
|
715
702
|
|
|
716
703
|
```ts
|
|
717
|
-
const asOptionalNetwork: (value) =>
|
|
704
|
+
const asOptionalNetwork: (value) => NetworkBootstrap | undefined;
|
|
718
705
|
```
|
|
719
706
|
|
|
720
707
|
## Parameters
|
|
@@ -725,7 +712,7 @@ const asOptionalNetwork: (value) => undefined | NetworkBootstrap;
|
|
|
725
712
|
|
|
726
713
|
## Returns
|
|
727
714
|
|
|
728
|
-
|
|
715
|
+
[`NetworkBootstrap`](#../type-aliases/NetworkBootstrap) \| `undefined`
|
|
729
716
|
|
|
730
717
|
### <a id="isNetworkBootstrap"></a>isNetworkBootstrap
|
|
731
718
|
|