@oasisomniverse/web4-api 2.0.0
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 +464 -0
- package/docs/README.md +52 -0
- package/docs/auth.md +89 -0
- package/docs/getting-started.md +129 -0
- package/docs/modules/Avatar.md +4160 -0
- package/docs/modules/Bridge.md +394 -0
- package/docs/modules/Chat.md +168 -0
- package/docs/modules/Clan.md +552 -0
- package/docs/modules/Competition.md +594 -0
- package/docs/modules/Data.md +796 -0
- package/docs/modules/EOSIO.md +508 -0
- package/docs/modules/Eggs.md +396 -0
- package/docs/modules/Files.md +312 -0
- package/docs/modules/Gifts.md +306 -0
- package/docs/modules/Health.md +90 -0
- package/docs/modules/Holochain.md +374 -0
- package/docs/modules/HyperDrive.md +3857 -0
- package/docs/modules/Karma.md +644 -0
- package/docs/modules/Keys.md +3303 -0
- package/docs/modules/Map.md +1026 -0
- package/docs/modules/Messaging.md +320 -0
- package/docs/modules/Nft.md +2216 -0
- package/docs/modules/OLand.md +425 -0
- package/docs/modules/ONET.md +442 -0
- package/docs/modules/ONODE.md +504 -0
- package/docs/modules/Provider.md +1396 -0
- package/docs/modules/Search.md +69 -0
- package/docs/modules/Seeds.md +167 -0
- package/docs/modules/Settings.md +533 -0
- package/docs/modules/Share.md +64 -0
- package/docs/modules/Social.md +190 -0
- package/docs/modules/Solana.md +150 -0
- package/docs/modules/Stats.md +359 -0
- package/docs/modules/Subscription.md +437 -0
- package/docs/modules/Video.md +150 -0
- package/docs/modules/Wallet.md +1993 -0
- package/index.d.ts +106 -0
- package/index.js +3 -0
- package/index.mjs +4 -0
- package/package.json +120 -0
- package/src/core/httpClient.js +110 -0
- package/src/core/routeHelper.js +50 -0
- package/src/core/tokenStore.js +52 -0
- package/src/core/types.d.ts +18 -0
- package/src/index.js +46 -0
- package/src/modules/Auth.d.ts +28 -0
- package/src/modules/Auth.js +98 -0
- package/src/modules/Avatar.d.ts +192 -0
- package/src/modules/Avatar.js +143 -0
- package/src/modules/Bridge.d.ts +24 -0
- package/src/modules/Bridge.js +35 -0
- package/src/modules/Cargo.js +35 -0
- package/src/modules/Chat.d.ts +15 -0
- package/src/modules/Chat.js +27 -0
- package/src/modules/Clan.d.ts +36 -0
- package/src/modules/Clan.js +41 -0
- package/src/modules/Competition.d.ts +33 -0
- package/src/modules/Competition.js +39 -0
- package/src/modules/Core.js +27 -0
- package/src/modules/Data.d.ts +36 -0
- package/src/modules/Data.js +41 -0
- package/src/modules/EOSIO.d.ts +33 -0
- package/src/modules/EOSIO.js +39 -0
- package/src/modules/Eggs.d.ts +24 -0
- package/src/modules/Eggs.js +33 -0
- package/src/modules/Files.d.ts +24 -0
- package/src/modules/Files.js +33 -0
- package/src/modules/Gifts.d.ts +24 -0
- package/src/modules/Gifts.js +33 -0
- package/src/modules/Health.d.ts +12 -0
- package/src/modules/Health.js +25 -0
- package/src/modules/Holochain.d.ts +27 -0
- package/src/modules/Holochain.js +35 -0
- package/src/modules/HyperDrive.d.ts +237 -0
- package/src/modules/HyperDrive.js +175 -0
- package/src/modules/Karma.d.ts +42 -0
- package/src/modules/Karma.js +45 -0
- package/src/modules/Keys.d.ts +183 -0
- package/src/modules/Keys.js +139 -0
- package/src/modules/Map.d.ts +75 -0
- package/src/modules/Map.js +65 -0
- package/src/modules/Messaging.d.ts +24 -0
- package/src/modules/Messaging.js +33 -0
- package/src/modules/Nft.d.ts +102 -0
- package/src/modules/Nft.js +85 -0
- package/src/modules/OAPP.js +31 -0
- package/src/modules/OLand.d.ts +27 -0
- package/src/modules/OLand.js +35 -0
- package/src/modules/ONET.d.ts +39 -0
- package/src/modules/ONET.js +43 -0
- package/src/modules/ONODE.d.ts +45 -0
- package/src/modules/ONODE.js +47 -0
- package/src/modules/Provider.d.ts +99 -0
- package/src/modules/Provider.js +83 -0
- package/src/modules/Search.d.ts +9 -0
- package/src/modules/Search.js +23 -0
- package/src/modules/Seeds.d.ts +15 -0
- package/src/modules/Seeds.js +27 -0
- package/src/modules/Settings.d.ts +48 -0
- package/src/modules/Settings.js +47 -0
- package/src/modules/Share.d.ts +9 -0
- package/src/modules/Share.js +23 -0
- package/src/modules/Social.d.ts +18 -0
- package/src/modules/Social.js +29 -0
- package/src/modules/Solana.d.ts +12 -0
- package/src/modules/Solana.js +25 -0
- package/src/modules/Stats.d.ts +30 -0
- package/src/modules/Stats.js +37 -0
- package/src/modules/Subscription.d.ts +36 -0
- package/src/modules/Subscription.js +41 -0
- package/src/modules/Telos.js +39 -0
- package/src/modules/Video.d.ts +15 -0
- package/src/modules/Video.js +27 -0
- package/src/modules/Wallet.d.ts +102 -0
- package/src/modules/Wallet.js +85 -0
- package/src/modules/index.js +79 -0
|
@@ -0,0 +1,442 @@
|
|
|
1
|
+
# ONET — `oasis.oNET`
|
|
2
|
+
|
|
3
|
+
Source controller: [`ONETController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/ONETController.cs)
|
|
4
|
+
Route prefix: `api/v1/onet`
|
|
5
|
+
11 operation(s).
|
|
6
|
+
|
|
7
|
+
Every method takes a single args object: any key matching a `{token}` in the route is substituted into the URL; everything else becomes the query string (GET/DELETE) or JSON body (POST/PUT). Every call resolves to the standard OASIS envelope:
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
{
|
|
11
|
+
isError: boolean;
|
|
12
|
+
isWarning: boolean;
|
|
13
|
+
message: string;
|
|
14
|
+
errorCode?: string;
|
|
15
|
+
result: T; // see each endpoint's Response section below
|
|
16
|
+
}
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Operations
|
|
20
|
+
|
|
21
|
+
### `broadcastMessage`
|
|
22
|
+
|
|
23
|
+
Broadcast message to network
|
|
24
|
+
|
|
25
|
+
**POST** `api/v1/onet/network/broadcast`
|
|
26
|
+
|
|
27
|
+
**Request**
|
|
28
|
+
|
|
29
|
+
Body type: `BroadcastMessageRequest`
|
|
30
|
+
|
|
31
|
+
| Field | Type |
|
|
32
|
+
| --- | --- |
|
|
33
|
+
| `Message` | `string` |
|
|
34
|
+
| `MessageType` | `string` |
|
|
35
|
+
|
|
36
|
+
**Response**
|
|
37
|
+
|
|
38
|
+
Standard `OASISResult` envelope (see top of this page) with:
|
|
39
|
+
|
|
40
|
+
`result` type: `IActionResult` (not part of the request/response payload).
|
|
41
|
+
|
|
42
|
+
**Example**
|
|
43
|
+
|
|
44
|
+
```js
|
|
45
|
+
const { isError, message, result } = await oasis.oNET.broadcastMessage({
|
|
46
|
+
message: "example string",
|
|
47
|
+
messageType: "example string"
|
|
48
|
+
});
|
|
49
|
+
if (isError) throw new Error(message);
|
|
50
|
+
console.log(result);
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Example response:
|
|
54
|
+
|
|
55
|
+
```json
|
|
56
|
+
{
|
|
57
|
+
"isError": false,
|
|
58
|
+
"message": "",
|
|
59
|
+
"result": null
|
|
60
|
+
}
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
### `connectToNode`
|
|
66
|
+
|
|
67
|
+
Connect to a specific node
|
|
68
|
+
|
|
69
|
+
**POST** `api/v1/onet/network/connect`
|
|
70
|
+
|
|
71
|
+
**Request**
|
|
72
|
+
|
|
73
|
+
Body type: `ConnectNodeRequest`
|
|
74
|
+
|
|
75
|
+
| Field | Type |
|
|
76
|
+
| --- | --- |
|
|
77
|
+
| `NodeId` | `string` |
|
|
78
|
+
| `NodeAddress` | `string` |
|
|
79
|
+
|
|
80
|
+
**Response**
|
|
81
|
+
|
|
82
|
+
Standard `OASISResult` envelope (see top of this page) with:
|
|
83
|
+
|
|
84
|
+
`result` type: `IActionResult` (not part of the request/response payload).
|
|
85
|
+
|
|
86
|
+
**Example**
|
|
87
|
+
|
|
88
|
+
```js
|
|
89
|
+
const { isError, message, result } = await oasis.oNET.connectToNode({
|
|
90
|
+
nodeId: "example string",
|
|
91
|
+
nodeAddress: "example string"
|
|
92
|
+
});
|
|
93
|
+
if (isError) throw new Error(message);
|
|
94
|
+
console.log(result);
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
Example response:
|
|
98
|
+
|
|
99
|
+
```json
|
|
100
|
+
{
|
|
101
|
+
"isError": false,
|
|
102
|
+
"message": "",
|
|
103
|
+
"result": null
|
|
104
|
+
}
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
### `disconnectFromNode`
|
|
110
|
+
|
|
111
|
+
Disconnect from a specific node
|
|
112
|
+
|
|
113
|
+
**POST** `api/v1/onet/network/disconnect`
|
|
114
|
+
|
|
115
|
+
**Request**
|
|
116
|
+
|
|
117
|
+
Body type: `DisconnectNodeRequest`
|
|
118
|
+
|
|
119
|
+
| Field | Type |
|
|
120
|
+
| --- | --- |
|
|
121
|
+
| `NodeId` | `string` |
|
|
122
|
+
|
|
123
|
+
**Response**
|
|
124
|
+
|
|
125
|
+
Standard `OASISResult` envelope (see top of this page) with:
|
|
126
|
+
|
|
127
|
+
`result` type: `IActionResult` (not part of the request/response payload).
|
|
128
|
+
|
|
129
|
+
**Example**
|
|
130
|
+
|
|
131
|
+
```js
|
|
132
|
+
const { isError, message, result } = await oasis.oNET.disconnectFromNode({
|
|
133
|
+
nodeId: "example string"
|
|
134
|
+
});
|
|
135
|
+
if (isError) throw new Error(message);
|
|
136
|
+
console.log(result);
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
Example response:
|
|
140
|
+
|
|
141
|
+
```json
|
|
142
|
+
{
|
|
143
|
+
"isError": false,
|
|
144
|
+
"message": "",
|
|
145
|
+
"result": null
|
|
146
|
+
}
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
### `getConnectedNodes`
|
|
152
|
+
|
|
153
|
+
Get connected nodes
|
|
154
|
+
|
|
155
|
+
**GET** `api/v1/onet/network/nodes`
|
|
156
|
+
|
|
157
|
+
**Request**
|
|
158
|
+
|
|
159
|
+
No request body.
|
|
160
|
+
|
|
161
|
+
**Response**
|
|
162
|
+
|
|
163
|
+
Standard `OASISResult` envelope (see top of this page) with:
|
|
164
|
+
|
|
165
|
+
`result` type: `IActionResult` (not part of the request/response payload).
|
|
166
|
+
|
|
167
|
+
**Example**
|
|
168
|
+
|
|
169
|
+
```js
|
|
170
|
+
const { isError, message, result } = await oasis.oNET.getConnectedNodes({});
|
|
171
|
+
if (isError) throw new Error(message);
|
|
172
|
+
console.log(result);
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
Example response:
|
|
176
|
+
|
|
177
|
+
```json
|
|
178
|
+
{
|
|
179
|
+
"isError": false,
|
|
180
|
+
"message": "",
|
|
181
|
+
"result": null
|
|
182
|
+
}
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
---
|
|
186
|
+
|
|
187
|
+
### `getNetworkStats`
|
|
188
|
+
|
|
189
|
+
Get network statistics
|
|
190
|
+
|
|
191
|
+
**GET** `api/v1/onet/network/stats`
|
|
192
|
+
|
|
193
|
+
**Request**
|
|
194
|
+
|
|
195
|
+
No request body.
|
|
196
|
+
|
|
197
|
+
**Response**
|
|
198
|
+
|
|
199
|
+
Standard `OASISResult` envelope (see top of this page) with:
|
|
200
|
+
|
|
201
|
+
`result` type: `IActionResult` (not part of the request/response payload).
|
|
202
|
+
|
|
203
|
+
**Example**
|
|
204
|
+
|
|
205
|
+
```js
|
|
206
|
+
const { isError, message, result } = await oasis.oNET.getNetworkStats({});
|
|
207
|
+
if (isError) throw new Error(message);
|
|
208
|
+
console.log(result);
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
Example response:
|
|
212
|
+
|
|
213
|
+
```json
|
|
214
|
+
{
|
|
215
|
+
"isError": false,
|
|
216
|
+
"message": "",
|
|
217
|
+
"result": null
|
|
218
|
+
}
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
---
|
|
222
|
+
|
|
223
|
+
### `getNetworkStatus`
|
|
224
|
+
|
|
225
|
+
Get P2P network status
|
|
226
|
+
|
|
227
|
+
**GET** `api/v1/onet/network/status`
|
|
228
|
+
|
|
229
|
+
**Request**
|
|
230
|
+
|
|
231
|
+
No request body.
|
|
232
|
+
|
|
233
|
+
**Response**
|
|
234
|
+
|
|
235
|
+
Standard `OASISResult` envelope (see top of this page) with:
|
|
236
|
+
|
|
237
|
+
`result` type: `IActionResult` (not part of the request/response payload).
|
|
238
|
+
|
|
239
|
+
**Example**
|
|
240
|
+
|
|
241
|
+
```js
|
|
242
|
+
const { isError, message, result } = await oasis.oNET.getNetworkStatus({});
|
|
243
|
+
if (isError) throw new Error(message);
|
|
244
|
+
console.log(result);
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
Example response:
|
|
248
|
+
|
|
249
|
+
```json
|
|
250
|
+
{
|
|
251
|
+
"isError": false,
|
|
252
|
+
"message": "",
|
|
253
|
+
"result": null
|
|
254
|
+
}
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
---
|
|
258
|
+
|
|
259
|
+
### `getNetworkTopology`
|
|
260
|
+
|
|
261
|
+
Get network topology
|
|
262
|
+
|
|
263
|
+
**GET** `api/v1/onet/network/topology`
|
|
264
|
+
|
|
265
|
+
**Request**
|
|
266
|
+
|
|
267
|
+
No request body.
|
|
268
|
+
|
|
269
|
+
**Response**
|
|
270
|
+
|
|
271
|
+
Standard `OASISResult` envelope (see top of this page) with:
|
|
272
|
+
|
|
273
|
+
`result` type: `IActionResult` (not part of the request/response payload).
|
|
274
|
+
|
|
275
|
+
**Example**
|
|
276
|
+
|
|
277
|
+
```js
|
|
278
|
+
const { isError, message, result } = await oasis.oNET.getNetworkTopology({});
|
|
279
|
+
if (isError) throw new Error(message);
|
|
280
|
+
console.log(result);
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
Example response:
|
|
284
|
+
|
|
285
|
+
```json
|
|
286
|
+
{
|
|
287
|
+
"isError": false,
|
|
288
|
+
"message": "",
|
|
289
|
+
"result": null
|
|
290
|
+
}
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
---
|
|
294
|
+
|
|
295
|
+
### `getOASISDNA`
|
|
296
|
+
|
|
297
|
+
Get OASISDNA configuration for ONET
|
|
298
|
+
|
|
299
|
+
**GET** `api/v1/onet/oasisdna`
|
|
300
|
+
|
|
301
|
+
**Request**
|
|
302
|
+
|
|
303
|
+
No request body.
|
|
304
|
+
|
|
305
|
+
**Response**
|
|
306
|
+
|
|
307
|
+
Standard `OASISResult` envelope (see top of this page) with:
|
|
308
|
+
|
|
309
|
+
`result` type: `IActionResult` (not part of the request/response payload).
|
|
310
|
+
|
|
311
|
+
**Example**
|
|
312
|
+
|
|
313
|
+
```js
|
|
314
|
+
const { isError, message, result } = await oasis.oNET.getOASISDNA({});
|
|
315
|
+
if (isError) throw new Error(message);
|
|
316
|
+
console.log(result);
|
|
317
|
+
```
|
|
318
|
+
|
|
319
|
+
Example response:
|
|
320
|
+
|
|
321
|
+
```json
|
|
322
|
+
{
|
|
323
|
+
"isError": false,
|
|
324
|
+
"message": "",
|
|
325
|
+
"result": null
|
|
326
|
+
}
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
---
|
|
330
|
+
|
|
331
|
+
### `startNetwork`
|
|
332
|
+
|
|
333
|
+
Start P2P network
|
|
334
|
+
|
|
335
|
+
**POST** `api/v1/onet/network/start`
|
|
336
|
+
|
|
337
|
+
**Request**
|
|
338
|
+
|
|
339
|
+
No request body.
|
|
340
|
+
|
|
341
|
+
**Response**
|
|
342
|
+
|
|
343
|
+
Standard `OASISResult` envelope (see top of this page) with:
|
|
344
|
+
|
|
345
|
+
`result` type: `IActionResult` (not part of the request/response payload).
|
|
346
|
+
|
|
347
|
+
**Example**
|
|
348
|
+
|
|
349
|
+
```js
|
|
350
|
+
const { isError, message, result } = await oasis.oNET.startNetwork({});
|
|
351
|
+
if (isError) throw new Error(message);
|
|
352
|
+
console.log(result);
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
Example response:
|
|
356
|
+
|
|
357
|
+
```json
|
|
358
|
+
{
|
|
359
|
+
"isError": false,
|
|
360
|
+
"message": "",
|
|
361
|
+
"result": null
|
|
362
|
+
}
|
|
363
|
+
```
|
|
364
|
+
|
|
365
|
+
---
|
|
366
|
+
|
|
367
|
+
### `stopNetwork`
|
|
368
|
+
|
|
369
|
+
Stop P2P network
|
|
370
|
+
|
|
371
|
+
**POST** `api/v1/onet/network/stop`
|
|
372
|
+
|
|
373
|
+
**Request**
|
|
374
|
+
|
|
375
|
+
No request body.
|
|
376
|
+
|
|
377
|
+
**Response**
|
|
378
|
+
|
|
379
|
+
Standard `OASISResult` envelope (see top of this page) with:
|
|
380
|
+
|
|
381
|
+
`result` type: `IActionResult` (not part of the request/response payload).
|
|
382
|
+
|
|
383
|
+
**Example**
|
|
384
|
+
|
|
385
|
+
```js
|
|
386
|
+
const { isError, message, result } = await oasis.oNET.stopNetwork({});
|
|
387
|
+
if (isError) throw new Error(message);
|
|
388
|
+
console.log(result);
|
|
389
|
+
```
|
|
390
|
+
|
|
391
|
+
Example response:
|
|
392
|
+
|
|
393
|
+
```json
|
|
394
|
+
{
|
|
395
|
+
"isError": false,
|
|
396
|
+
"message": "",
|
|
397
|
+
"result": null
|
|
398
|
+
}
|
|
399
|
+
```
|
|
400
|
+
|
|
401
|
+
---
|
|
402
|
+
|
|
403
|
+
### `updateOASISDNA`
|
|
404
|
+
|
|
405
|
+
Update OASISDNA configuration for ONET
|
|
406
|
+
|
|
407
|
+
**PUT** `api/v1/onet/oasisdna`
|
|
408
|
+
|
|
409
|
+
**Request**
|
|
410
|
+
|
|
411
|
+
Body type: `OASISDNA`
|
|
412
|
+
|
|
413
|
+
| Field | Type |
|
|
414
|
+
| --- | --- |
|
|
415
|
+
| `OASIS` | `OASIS` |
|
|
416
|
+
|
|
417
|
+
**Response**
|
|
418
|
+
|
|
419
|
+
Standard `OASISResult` envelope (see top of this page) with:
|
|
420
|
+
|
|
421
|
+
`result` type: `IActionResult` (not part of the request/response payload).
|
|
422
|
+
|
|
423
|
+
**Example**
|
|
424
|
+
|
|
425
|
+
```js
|
|
426
|
+
const { isError, message, result } = await oasis.oNET.updateOASISDNA({
|
|
427
|
+
oASIS: { "CurrentLiveVersion": "example string", "CurrentStagingVersion": "example string", "OASISVersion": "example string", "Terms": "example string", "Logging": { "LoggingFramework": "example string", "AlsoUseDefaultLogProvider": true, "LogToConsole": true, "ShowColouredLogs": true, "DebugColour": /* <ConsoleColor> */, "InfoColour": /* <ConsoleColor> */, "WarningColour": /* <ConsoleColor> */, "ErrorColour": /* <ConsoleColor> */, "LogToFile": true, "LogPath": "example string", "LogFileName": "example string", "MaxLogFileSize": 1, "NumberOfRetriesToLogToFile": 1, "RetryLoggingToFileEverySeconds": 1, "InsertExtraNewLineAfterLogMessage": true, "IndentLogMessagesBy": 1 }, "ErrorHandling": { "ShowStackTrace": true, "ThrowExceptionsOnErrors": true, "ThrowExceptionsOnWarnings": true, "LogAllErrors": true, "LogAllWarnings": true, "ErrorHandlingBehaviour": { }, "WarningHandlingBehaviour": /* <WarningHandlingBehaviour> */ }, "Security": { "HideVerificationToken": true, "HideRefreshTokens": true, "SecretKey": "example string", "JwtTokenExpirationMinutes": 1, "RefreshTokenExpirationDays": 1, "AvatarPassword": { "BCryptEncryptionEnabled": true, "Rijndael256EncryptionEnabled": true, "Rijndael256Key": "example string", "QuantumEncryptionEnabled": true }, "OASISProviderPrivateKeys": {} }, "Email": { "EmailFrom": "example string", "SmtpHost": "example string", "SmtpPort": 1, "SmtpUser": "example string", "SmtpPass": "example string", "ResendKey": "example string", "DisableAllEmails": true, "SendVerificationEmail": true, "OASISWebSiteURL": "example string" }, "StorageProviders": { "LogSwitchingProvidersToConsole": true, "LogSwitchingProvidersToFile": true, "LogSwitchingProviders": true, "ProviderMethodCallTimeOutSeconds": 1, "ActivateProviderTimeOutSeconds": 1, "DectivateProviderTimeOutSeconds": 1, "AutoReplicationEnabled": true, "AutoFailOverEnabled": true, "AutoFailOverEnabledForAvatarLogin": true, "AutoFailOverEnabledForCheckIfEmailAlreadyInUse": true, "AutoFailOverEnabledForCheckIfUsernameAlreadyInUse": true, "AutoLoadBalanceEnabled": true, "AutoLoadBalanceReadPollIntervalMins": 1, "AutoLoadBalanceWritePollIntervalMins": 1, "AutoReplicationProviders": "example string", "AutoLoadBalanceProviders": "example string", "AutoFailOverProviders": "example string", "AutoFailOverProvidersForAvatarLogin": "example string", "AutoFailOverProvidersForCheckIfEmailAlreadyInUse": "example string", "AutoFailOverProvidersForCheckIfUsernameAlreadyInUse": "example string", "AutoFailOverProvidersForCheckIfOASISSystemAccountExists": "example string", "AutoFailOverLocalProvidersEnabled": true, "AutoFailOverLocalProviders": "example string", "OASISProviderBootType": "example string", "AzureCosmosDBOASIS": { "ServiceEndpoint": "example string", "AuthKey": "example string", "DBName": "example string", "CollectionNames": "example string" }, "HoloOASIS": { "HolochainVersion": { }, "UseLocalNode": true, "UseHoloNetwork": true, "HoloNetworkURI": "example string", "LocalNodeURI": "example string", "HoloNETORMUseReflection": true, "STARBasePath": "example string", "RustDNARSMTemplateFolder": "example string", "RustTemplateLib": "example string", "RustTemplateHolon": "example string", "RustTemplateValidation": "example string", "RustTemplateCreate": "example string", "RustTemplateRead": "example string", "RustTemplateUpdate": "example string", "RustTemplateDelete": "example string", "RustTemplateList": "example string", "RustTemplateInt": "example string", "RustTemplateString": "example string", "RustTemplateBool": "example string" }, "MongoDBOASIS": { "DBName": "example string" }, "EOSIOOASIS": { "AccountName": "example string", "AccountPrivateKey": "example string", "ChainId": "example string" }, "TelosOASIS": { "RpcEndpoint": "example string", "Network": "example string", "ChainId": "example string" }, "SEEDSOASIS": { }, "ThreeFoldOASIS": { }, "EthereumOASIS": { "ChainPrivateKey": "example string", "ChainId": 1, "ContractAddress": "example string" }, "ArbitrumOASIS": { "ChainPrivateKey": "example string", "ChainId": 1, "ContractAddress": "example string" }, "RootstockOASIS": { "ChainPrivateKey": "example string", "ContractAddress": "example string", "Abi": "example string" }, "PolygonOASIS": { "ChainPrivateKey": "example string", "ContractAddress": "example string", "Abi": "example string" }, "SQLLiteDBOASIS": { }, "IPFSOASIS": { "LookUpIPFSAddress": "example string" }, "Neo4jOASIS": { "Username": "example string", "Password": "example string" }, "SolanaOASIS": { "WalletMnemonicWords": "example string", "PrivateKey": "example string", "PublicKey": "example string" }, "CargoOASIS": { "SingingMessage": "example string", "PrivateKey": "example string", "HostUrl": "example string" }, "LocalFileOASIS": { "FilePath": "example string" }, "PinataOASIS": { "ConnectionString": "example string" }, "BitcoinOASIS": { "RpcEndpoint": "example string", "Network": "example string" }, "CardanoOASIS": { "RpcEndpoint": "example string", "NetworkId": "example string", "ProjectId": "example string" }, "PolkadotOASIS": { "RpcEndpoint": "example string", "Network": "example string" }, "BNBChainOASIS": { "RpcEndpoint": "example string", "NetworkId": "example string", "ChainId": "example string" }, "FantomOASIS": { "RpcEndpoint": "example string", "NetworkId": "example string", "ChainId": "example string" }, "OptimismOASIS": { "RpcEndpoint": "example string", "NetworkId": "example string", "ChainId": "example string" }, "ChainLinkOASIS": { "RpcEndpoint": "example string", "NetworkId": "example string", "ChainId": "example string" }, "ElrondOASIS": { "RpcEndpoint": "example string", "Network": "example string", "ChainId": "example string" }, "AptosOASIS": { "RpcEndpoint": "example string", "Network": "example string", "ChainId": "example string", "PrivateKey": "example string", "ContractAddress": "example string" }, "TRONOASIS": { "RpcEndpoint": "example string", "Network": "example string", "ChainId": "example string" }, "HashgraphOASIS": { "RpcEndpoint": "example string", "Network": "example string", "ChainId": "example string" }, "AvalancheOASIS": { "RpcEndpoint": "example string", "NetworkId": "example string", "ChainId": "example string", "ChainPrivateKey": "example string", "ContractAddress": "example string" }, "CosmosBlockChainOASIS": { "RpcEndpoint": "example string", "Network": "example string", "ChainId": "example string" }, "NEAROASIS": { "RpcEndpoint": "example string", "Network": "example string", "ChainId": "example string" }, "BaseOASIS": { "RpcEndpoint": "example string", "NetworkId": "example string", "ChainId": "example string", "ChainPrivateKey": "example string", "ContractAddress": "example string" }, "SuiOASIS": { "RpcEndpoint": "example string", "Network": "example string", "ChainId": "example string", "ContractAddress": "example string" }, "MoralisOASIS": { "ApiKey": "example string", "RpcEndpoint": "example string", "Network": "example string" }, "ActivityPubOASIS": { "BaseUrl": "example string", "UserAgent": "example string", "AcceptHeader": "example string", "TimeoutSeconds": 1, "EnableCaching": true, "CacheExpirationMinutes": 1 }, "GoogleCloudOASIS": { "ProjectId": "example string", "BucketName": "example string", "CredentialsPath": "example string", "FirestoreDatabaseId": "example string", "BigQueryDatasetId": "example string", "EnableStorage": true, "EnableFirestore": true, "EnableBigQuery": true } }, "OASISHyperDriveConfig": { "IsEnabled": true, "DefaultStrategy": "example string", "AutoFailoverEnabled": true, "AutoReplicationEnabled": true, "AutoLoadBalancingEnabled": true, "MaxRetryAttempts": 1, "RequestTimeoutMs": 1, "HealthCheckIntervalMs": 1, "MaxConcurrentRequests": 1, "PerformanceWeight": 1.0, "CostWeight": 1.0, "GeographicWeight": 1.0, "AvailabilityWeight": 1.0, "LatencyWeight": 1.0, "ThroughputWeight": 1.0, "ReliabilityWeight": 1.0, "MaxLatencyThresholdMs": 1, "MaxErrorRateThreshold": 1.0, "MinUptimeThreshold": 1.0, "EnabledProviders": ["example string"], "AutoFailoverProviders": ["example string"], "AutoReplicationProviders": ["example string"], "LoadBalancingProviders": ["example string"], "ProviderConfigs": { "<string>": { "ProviderType": "example string", "IsEnabled": true, "Weight": 1, "TimeoutMs": 1, "MaxConnections": 1, "ErrorThreshold": 1.0, "MinUptime": 1.0, "MaxLatencyMs": 1, "Endpoint": "example string", "ApiKey": "example string", "SecretKey": "example string", "CustomSettings": { "<string>": "example string" } } }, "GeographicConfig": { "IsEnabled": true, "DefaultRegion": "example string", "UserLocation": "example string", "MaxDistanceKm": 1.0, "MaxNetworkHops": 1, "MaxLatencyMs": 1, "Regions": { "<string>": { "Name": "example string", "Country": "example string", "City": "example string", "Latitude": 1.0, "Longitude": 1.0, "TimeZone": "example string", "MaxLatencyMs": 1.0, "MaxNetworkHops": 1 } } }, "CostConfig": { "IsEnabled": true, "Currency": "example string", "MaxCostPerOperation": 1.0, "MaxStorageCostPerGB": 1.0, "MaxComputeCostPerHour": 1.0, "MaxNetworkCostPerGB": 1.0, "ProviderCosts": { "<string>": { "ProviderType": "example string", "StorageCostPerGB": 1.0, "ComputeCostPerHour": 1.0, "NetworkCostPerGB": 1.0, "TransactionCost": 1.0, "ApiCallCost": 1.0, "TotalCost": 1.0, "Currency": "example string", "LastUpdated": "2026-01-01T00:00:00Z", "CostEfficiencyScore": 1 } } }, "PerformanceConfig": { "IsEnabled": true, "MaxResponseTimeMs": 1, "MaxErrorRate": 1.0, "MinUptime": 1.0, "MinThroughputMbps": 1, "MaxConcurrentConnections": 1, "QueueDepthThreshold": 1, "MaxCpuUsage": 1.0, "MaxMemoryUsage": 1.0 }, "SecurityConfig": { "IsEnabled": true, "RequireEncryption": true, "RequireAuthentication": true, "RequireAuthorization": true, "MaxRetryAttempts": 1, "SessionTimeoutMs": 1, "MaxConcurrentSessions": 1, "AllowedIPs": ["example string"], "BlockedIPs": ["example string"], "SecurityHeaders": { "<string>": "example string" } }, "MonitoringConfig": { "IsEnabled": true, "MetricsCollectionIntervalMs": 1, "MaxMetricsHistory": 1, "AlertThreshold": 1, "EnableRealTimeMonitoring": true, "EnablePerformanceProfiling": true, "EnableCostTracking": true, "EnableGeographicTracking": true, "MonitoringEndpoints": ["example string"], "CustomMetrics": { "<string>": "example string" } } }, "Web6": { "DefaultProvider": "example string", "DefaultOpenServModel": "example string", "DefaultRoutingPriority": "example string", "DefaultRoutingFallbackEnabled": true, "OpenServ": { "BaseUrl": "example string", "DefaultModel": "example string", "AvailableModels": ["example string"] }, "FAHRN": { "EMAAlpha": 1.0, "DefaultDispatchMode": "example string", "AutoSeedOpenServAgentsOnStartup": true, "MaxDecomposedSubProblems": 1 }, "HolonicBraid": { "AutoPersistWinningPlan": true }, "HolonicMemory": { "DefaultRetentionPolicy": "example string", "RecordDispatchOutcomes": true } }, "HyperDriveMode": "example string", "ReplicationRules": { "Mode": "example string", "IsEnabled": true, "MaxReplicationsPerMonth": 1, "CostThreshold": 1.0, "FreeProvidersOnly": true, "GasFeeThreshold": 1.0, "ReplicationTriggers": [{ "Id": "example string", "Name": "example string", "Condition": { "Type": "example string", "Operator": "example string", "Value": {}, "Field": "example string", "ProviderType": "example string", "TimeWindow": { "Start": "example string", "End": "example string", "TimeZone": "example string", "DaysOfWeek": ["example string"] } }, "Priority": "example string", "IsEnabled": true, "Action": { "Type": "example string", "TargetProviders": ["example string"], "DataTypes": ["example string"], "Permissions": { "AvatarPermissions": { "IsEnabled": true, "Fields": [{ "FieldName": "example string", "Permission": "example string", "IsEncrypted": true, "IsRequired": true, "ProviderTypes": ["example string"] }], "DefaultPermission": "example string", "ProviderOverrides": { "<string>": [] } }, "HolonPermissions": { "IsEnabled": true, "HolonTypes": [{ "HolonType": "example string", "Permission": "example string", "IsEncrypted": true, "IsRequired": true, "ProviderTypes": ["example string"], "Fields": [{ "FieldName": "example string", "Permission": "example string", "IsEncrypted": true, "IsRequired": true }] }], "DefaultPermission": "example string", "ProviderOverrides": { "<string>": [] } }, "ProviderPermissions": { "IsEnabled": true, "Providers": [{ "ProviderType": "example string", "Permission": "example string", "AllowedDataTypes": ["example string"], "CostLimit": 1.0, "GasFeeLimit": 1.0, "Schedule": { "Type": "example string", "Interval": 1, "IntervalUnit": "example string", "CronExpression": "example string", "TimeZone": "example string", "StartTime": "example string", "EndTime": "example string", "DaysOfWeek": ["example string"], "DaysOfMonth": [1] } }] }, "FieldLevelPermissions": { "IsEnabled": true, "Rules": [{ "FieldPath": "example string", "DataType": "example string", "Permissions": { "<string>": "example string" }, "Encryption": { "<string>": true }, "Required": { "<string>": true } }] }, "AccessControl": { "IsEnabled": true, "AuthenticationRequired": true, "AuthorizationLevel": "example string", "EncryptionLevel": "example string", "AuditLogging": true, "AccessPolicies": [{ "Name": "example string", "Condition": { "UserRole": "example string", "SubscriptionPlan": "example string", "TimeWindow": {}, "Location": "example string", "DeviceType": "example string" }, "Permissions": "example string", "Providers": ["example string"], "DataTypes": ["example string"] }] } }, "CostLimit": 1.0, "Schedule": {} } }], "ProviderRules": [{ "ProviderType": "example string", "IsEnabled": true, "Priority": 1, "CostLimit": 1.0, "GasFeeLimit": 1.0, "DataTypes": ["example string"], "Permissions": {}, "Conditions": [], "Schedule": {} }], "DataTypeRules": [{ "DataType": "example string", "IsEnabled": true, "RequiredProviders": ["example string"], "OptionalProviders": ["example string"], "Permissions": {}, "CostLimit": 1.0, "Schedule": {} }], "ScheduleRules": [{ "Name": "example string", "IsEnabled": true, "Schedule": {}, "DataTypes": ["example string"], "Providers": ["example string"], "Permissions": {} }], "CostOptimization": { "IsEnabled": true, "MaxCostPerReplication": 1.0, "MaxCostPerMonth": 1.0, "PreferredFreeProviders": ["example string"], "AvoidHighGasProviders": true, "GasFeeThreshold": 1.0, "CostAlertThreshold": 1.0 }, "IntelligentSelection": { "IsEnabled": true, "Algorithm": "example string", "Weights": { "Cost": 1.0, "Performance": 1.0, "Reliability": 1.0, "Security": 1.0, "Geographic": 1.0, "Availability": 1.0 }, "LearningEnabled": true, "AdaptationSpeed": "example string", "OptimizationGoals": [{ "Type": "example string", "Weight": 1.0, "Target": 1.0, "IsEnabled": true }] } }, "FailoverRules": { "Mode": "example string", "IsEnabled": true, "MaxFailoversPerMonth": 1, "CostThreshold": 1.0, "FreeProvidersOnly": true, "GasFeeThreshold": 1.0, "FailoverTriggers": [{ "Id": "example string", "Name": "example string", "Condition": { "Type": "example string", "Operator": "example string", "Value": {}, "ProviderType": "example string", "TimeWindow": {}, "Threshold": 1.0 }, "Priority": "example string", "IsEnabled": true, "Action": { "Type": "example string", "TargetProvider": "example string", "FallbackProviders": ["example string"], "CostLimit": 1.0, "Schedule": {} } }], "ProviderRules": [{ "ProviderType": "example string", "IsEnabled": true, "Priority": 1, "CostLimit": 1.0, "GasFeeLimit": 1.0, "Conditions": [], "FallbackProviders": ["example string"] }], "IntelligentSelection": {}, "EscalationRules": [{ "Name": "example string", "Level": "example string", "Condition": {}, "Action": {}, "Notification": { "Channels": ["example string"], "Message": "example string", "Priority": "example string", "IsEnabled": true } }] }, "SubscriptionConfig": { "PlanType": "example string", "MaxReplicationsPerMonth": 1, "MaxFailoversPerMonth": 1, "MaxRequestsPerMonth": 1, "MaxStorageGB": 1, "PayAsYouGoEnabled": true, "CostPerReplication": 1.0, "CostPerFailover": 1.0, "CostPerGB": 1.0, "Currency": "example string", "BillingCycle": "example string", "UsageAlerts": [{ "Id": "example string", "Name": "example string", "Threshold": 1.0, "ThresholdType": "example string", "NotificationChannels": ["example string"], "IsEnabled": true }], "QuotaNotifications": [{ "Id": "example string", "Name": "example string", "QuotaType": "example string", "Threshold": 1.0, "NotificationChannels": ["example string"], "Actions": [{ "Type": "example string", "Value": {}, "Schedule": {} }], "IsEnabled": true }] }, "DataPermissions": {}, "IntelligentMode": { "IsEnabled": true, "AutoOptimization": true, "CostAwareness": true, "PerformanceOptimization": true, "SecurityOptimization": true, "LearningEnabled": true, "AdaptationSpeed": "example string", "OptimizationGoals": [] }, "OASISSystemAccountId": "example string", "OASISAPIURL": "example string", "NetworkId": "example string", "SettingsLookupHolonId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "StatsCacheEnabled": true, "StatsCacheTtlSeconds": 1 }
|
|
428
|
+
});
|
|
429
|
+
if (isError) throw new Error(message);
|
|
430
|
+
console.log(result);
|
|
431
|
+
```
|
|
432
|
+
|
|
433
|
+
Example response:
|
|
434
|
+
|
|
435
|
+
```json
|
|
436
|
+
{
|
|
437
|
+
"isError": false,
|
|
438
|
+
"message": "",
|
|
439
|
+
"result": null
|
|
440
|
+
}
|
|
441
|
+
```
|
|
442
|
+
|