@xyo-network/react-chain-model 1.16.14 → 1.16.16

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 +64 -44
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -21,126 +21,142 @@ XYO Layer One React SDK Stake
21
21
  ## Interfaces
22
22
 
23
23
  - [XyoGlobal](#interfaces/XyoGlobal)
24
+ - [UninitializedXyoGlobal](#interfaces/UninitializedXyoGlobal)
24
25
 
25
26
  ## Functions
26
27
 
27
- - [hasXyoWalletInjectable](#functions/hasXyoWalletInjectable)
28
- - [hasXyoWalletProvider](#functions/hasXyoWalletProvider)
29
- - [getXyoProvider](#functions/getXyoProvider)
28
+ - [isXyoGlobal](#functions/isXyoGlobal)
29
+ - [isUninitializedXyoGlobal](#functions/isUninitializedXyoGlobal)
30
30
 
31
31
  ### functions
32
32
 
33
- ### <a id="getXyoProvider"></a>getXyoProvider
33
+ ### <a id="isUninitializedXyoGlobal"></a>isUninitializedXyoGlobal
34
34
 
35
35
  [**@xyo-network/react-chain-model**](#../README)
36
36
 
37
37
  ***
38
38
 
39
39
  ```ts
40
- function getXyoProvider(options): XyoConnection;
40
+ function isUninitializedXyoGlobal(obj): obj is UninitializedXyoGlobal;
41
41
  ```
42
42
 
43
43
  ## Parameters
44
44
 
45
- ### options
45
+ ### obj
46
46
 
47
- ### assert
48
-
49
- `true`
47
+ `unknown`
50
48
 
51
49
  ## Returns
52
50
 
53
- `XyoConnection`
51
+ `obj is UninitializedXyoGlobal`
54
52
 
55
- ### <a id="hasXyoWalletInjectable"></a>hasXyoWalletInjectable
53
+ ### <a id="isXyoGlobal"></a>isXyoGlobal
56
54
 
57
55
  [**@xyo-network/react-chain-model**](#../README)
58
56
 
59
57
  ***
60
58
 
61
59
  ```ts
62
- function hasXyoWalletInjectable(): boolean;
60
+ function isXyoGlobal(obj): obj is XyoGlobal;
63
61
  ```
64
62
 
65
- ## Returns
66
-
67
- `boolean`
68
-
69
- ### <a id="hasXyoWalletProvider"></a>hasXyoWalletProvider
70
-
71
- [**@xyo-network/react-chain-model**](#../README)
63
+ ## Parameters
72
64
 
73
- ***
65
+ ### obj
74
66
 
75
- ```ts
76
- function hasXyoWalletProvider(): boolean;
77
- ```
67
+ `unknown`
78
68
 
79
69
  ## Returns
80
70
 
81
- `boolean`
71
+ `obj is XyoGlobal`
82
72
 
83
73
  ### interfaces
84
74
 
85
- ### <a id="XyoGlobal"></a>XyoGlobal
75
+ ### <a id="UninitializedXyoGlobal"></a>UninitializedXyoGlobal
86
76
 
87
77
  [**@xyo-network/react-chain-model**](#../README)
88
78
 
89
79
  ***
90
80
 
81
+ Describes the initial state of the global XYO object before initialization
82
+ (i.e. before the client is initialized)
83
+
84
+ ## Extended by
85
+
86
+ - [`XyoGlobal`](#XyoGlobal)
87
+
91
88
  ## Properties
92
89
 
93
- ### client?
90
+ ### connections
94
91
 
95
92
  ```ts
96
- optional client: XyoClient;
93
+ connections: Record<NetworkId, NetworkBootstrap>;
97
94
  ```
98
95
 
99
96
  ***
100
97
 
101
- ### ~~connections~~
98
+ ### sessionId()
102
99
 
103
100
  ```ts
104
- connections: object;
101
+ sessionId: () => string;
105
102
  ```
106
103
 
107
- ### Index Signature
104
+ ### Returns
105
+
106
+ `string`
107
+
108
+ ***
109
+
110
+ ### walletExtensionId()
108
111
 
109
112
  ```ts
110
- [chainId: string]: ChainConnection
113
+ walletExtensionId: () => string;
111
114
  ```
112
115
 
113
- ### Deprecated
116
+ ### Returns
117
+
118
+ `string`
119
+
120
+ ### <a id="XyoGlobal"></a>XyoGlobal
114
121
 
115
- - use client gateways instead
122
+ [**@xyo-network/react-chain-model**](#../README)
116
123
 
117
124
  ***
118
125
 
119
- ### errors?
126
+ Describes the initial state of the global XYO object before initialization
127
+ (i.e. before the client is initialized)
128
+
129
+ ## Extends
130
+
131
+ - [`UninitializedXyoGlobal`](#UninitializedXyoGlobal)
132
+
133
+ ## Properties
134
+
135
+ ### client
120
136
 
121
137
  ```ts
122
- optional errors: Error[];
138
+ client: XyoClient;
123
139
  ```
124
140
 
125
141
  ***
126
142
 
127
- ### gateway?
143
+ ### errors
128
144
 
129
145
  ```ts
130
- optional gateway: XyoGatewayProvider;
146
+ errors: Error[];
131
147
  ```
132
148
 
133
149
  ***
134
150
 
135
- ### ~~provider?~~
151
+ ### connections
136
152
 
137
153
  ```ts
138
- optional provider: XyoConnection;
154
+ connections: Record<NetworkId, NetworkBootstrap>;
139
155
  ```
140
156
 
141
- ### Deprecated
157
+ ### Inherited from
142
158
 
143
- - use client gateways instead
159
+ [`UninitializedXyoGlobal`](#UninitializedXyoGlobal).[`connections`](UninitializedXyoGlobal.md#connections)
144
160
 
145
161
  ***
146
162
 
@@ -154,9 +170,13 @@ sessionId: () => string;
154
170
 
155
171
  `string`
156
172
 
173
+ ### Inherited from
174
+
175
+ [`UninitializedXyoGlobal`](#UninitializedXyoGlobal).[`sessionId`](UninitializedXyoGlobal.md#sessionid)
176
+
157
177
  ***
158
178
 
159
- ### ~~walletExtensionId()~~
179
+ ### walletExtensionId()
160
180
 
161
181
  ```ts
162
182
  walletExtensionId: () => string;
@@ -166,9 +186,9 @@ walletExtensionId: () => string;
166
186
 
167
187
  `string`
168
188
 
169
- ### Deprecated
189
+ ### Inherited from
170
190
 
171
- - use session id instead
191
+ [`UninitializedXyoGlobal`](#UninitializedXyoGlobal).[`walletExtensionId`](UninitializedXyoGlobal.md#walletextensionid)
172
192
 
173
193
 
174
194
  ## Maintainers
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "http://json.schemastore.org/package.json",
3
3
  "name": "@xyo-network/react-chain-model",
4
- "version": "1.16.14",
4
+ "version": "1.16.16",
5
5
  "description": "XYO Layer One React SDK Stake",
6
6
  "homepage": "https://xylabs.com",
7
7
  "bugs": {
@@ -42,9 +42,9 @@
42
42
  ],
43
43
  "dependencies": {
44
44
  "@xylabs/sdk-js": "~5.0.34",
45
- "@xyo-network/xl1-network-model": "~1.16.14",
45
+ "@xyo-network/xl1-network-model": "~1.16.16",
46
46
  "@xyo-network/xl1-protocol": "~1.13.11",
47
- "@xyo-network/xl1-protocol-sdk": "~1.16.14"
47
+ "@xyo-network/xl1-protocol-sdk": "~1.16.16"
48
48
  },
49
49
  "devDependencies": {
50
50
  "@xylabs/ts-scripts-yarn3": "~7.2.8",