@xyo-network/chain-orchestration 1.7.6 → 1.7.8

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 +149 -3
  2. package/package.json +15 -15
package/README.md CHANGED
@@ -8,13 +8,159 @@
8
8
  [![npm-license-badge][]](LICENSE)
9
9
  [![socket-badge][]][socket-link]
10
10
 
11
- Version: 1.7.3
12
-
13
11
  XYO Layer One SDK Orchestration
14
12
 
15
13
  ## Documentation
16
14
 
17
- [TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__chain-orchestration)
15
+ ## Reference
16
+
17
+ **@xyo-network/chain-orchestration**
18
+
19
+ ***
20
+
21
+ ## Variables
22
+
23
+ - [DefaultReadCachingArchivistConfig](#variables/DefaultReadCachingArchivistConfig)
24
+ - [initBridgedModule](#variables/initBridgedModule)
25
+ - [initBridgedArchivistModule](#variables/initBridgedArchivistModule)
26
+
27
+ ## Functions
28
+
29
+ - [initArchivistSync](#functions/initArchivistSync)
30
+ - [wrapWithReadCachingArchivist](#functions/wrapWithReadCachingArchivist)
31
+ - [initBridge](#functions/initBridge)
32
+
33
+ ### functions
34
+
35
+ ### <a id="initArchivistSync"></a>initArchivistSync
36
+
37
+ [**@xyo-network/chain-orchestration**](#../README)
38
+
39
+ ***
40
+
41
+ ```ts
42
+ function initArchivistSync(
43
+ name,
44
+ inArchivist,
45
+ outArchivist,
46
+ frequency,
47
+ max,
48
+ traceProvider?): Promise<MemoryNode<MemoryNodeParams, NodeModuleEventData>>;
49
+ ```
50
+
51
+ ## Parameters
52
+
53
+ ### name
54
+
55
+ `string`
56
+
57
+ ### inArchivist
58
+
59
+ `ArchivistInstance`
60
+
61
+ ### outArchivist
62
+
63
+ `ArchivistInstance`
64
+
65
+ ### frequency
66
+
67
+ `number` = `1000`
68
+
69
+ ### max
70
+
71
+ `number` = `1000`
72
+
73
+ ### traceProvider?
74
+
75
+ `TracerProvider`
76
+
77
+ ## Returns
78
+
79
+ `Promise`\<`MemoryNode`\<`MemoryNodeParams`, `NodeModuleEventData`\>\>
80
+
81
+ ### <a id="initBridge"></a>initBridge
82
+
83
+ [**@xyo-network/chain-orchestration**](#../README)
84
+
85
+ ***
86
+
87
+ ```ts
88
+ function initBridge(nodeUrl): Promise<AttachableBridgeInstance<BridgeParams<AnyConfigSchema<BridgeConfig>>, BridgeModuleEventData>>;
89
+ ```
90
+
91
+ ## Parameters
92
+
93
+ ### nodeUrl
94
+
95
+ `string`
96
+
97
+ ## Returns
98
+
99
+ `Promise`\<`AttachableBridgeInstance`\<`BridgeParams`\<`AnyConfigSchema`\<`BridgeConfig`\>\>, `BridgeModuleEventData`\>\>
100
+
101
+ ### <a id="wrapWithReadCachingArchivist"></a>wrapWithReadCachingArchivist
102
+
103
+ [**@xyo-network/chain-orchestration**](#../README)
104
+
105
+ ***
106
+
107
+ ```ts
108
+ function wrapWithReadCachingArchivist(archivist, config): Promise<AttachableArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>>;
109
+ ```
110
+
111
+ ## Parameters
112
+
113
+ ### archivist
114
+
115
+ `AttachableArchivistInstance`
116
+
117
+ ### config
118
+
119
+ `Partial`\<`MemoryArchivistConfig`\> = `DefaultReadCachingArchivistConfig`
120
+
121
+ ## Returns
122
+
123
+ `Promise`\<`AttachableArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>\>
124
+
125
+ ### variables
126
+
127
+ ### <a id="DefaultReadCachingArchivistConfig"></a>DefaultReadCachingArchivistConfig
128
+
129
+ [**@xyo-network/chain-orchestration**](#../README)
130
+
131
+ ***
132
+
133
+ ```ts
134
+ const DefaultReadCachingArchivistConfig: MemoryArchivistConfig;
135
+ ```
136
+
137
+ ### <a id="initBridgedArchivistModule"></a>initBridgedArchivistModule
138
+
139
+ [**@xyo-network/chain-orchestration**](#../README)
140
+
141
+ ***
142
+
143
+ ```ts
144
+ const initBridgedArchivistModule: Initializable<{
145
+ bridge: BridgeInstance;
146
+ logger?: Logger;
147
+ moduleName: ModuleIdentifier;
148
+ }, AttachableArchivistInstance>;
149
+ ```
150
+
151
+ ### <a id="initBridgedModule"></a>initBridgedModule
152
+
153
+ [**@xyo-network/chain-orchestration**](#../README)
154
+
155
+ ***
156
+
157
+ ```ts
158
+ const initBridgedModule: Initializable<{
159
+ bridge: BridgeInstance;
160
+ moduleName: ModuleIdentifier;
161
+ }, AttachableModuleInstance>;
162
+ ```
163
+
18
164
 
19
165
  ## Maintainers
20
166
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "http://json.schemastore.org/package.json",
3
3
  "name": "@xyo-network/chain-orchestration",
4
- "version": "1.7.6",
4
+ "version": "1.7.8",
5
5
  "description": "XYO Layer One SDK Orchestration",
6
6
  "homepage": "https://xylabs.com",
7
7
  "bugs": {
@@ -35,27 +35,27 @@
35
35
  },
36
36
  "dependencies": {
37
37
  "@opentelemetry/api": "^1.9.0",
38
- "@xylabs/assert": "^4.13.19",
39
- "@xylabs/logger": "^4.13.19",
40
- "@xyo-network/archivist-memory": "^4.1.4",
41
- "@xyo-network/archivist-model": "^4.1.4",
42
- "@xyo-network/bridge-http": "^4.1.4",
43
- "@xyo-network/bridge-model": "^4.1.4",
44
- "@xyo-network/chain-modules": "^1.7.6",
45
- "@xyo-network/diviner-model": "^4.1.4",
46
- "@xyo-network/module-model": "^4.1.4",
47
- "@xyo-network/node-memory": "^4.1.4",
48
- "@xyo-network/sentinel-memory": "^4.1.4",
49
- "@xyo-network/sentinel-model": "^4.1.4",
38
+ "@xylabs/assert": "^4.13.21",
39
+ "@xylabs/logger": "^4.13.21",
40
+ "@xyo-network/archivist-memory": "^4.1.5",
41
+ "@xyo-network/archivist-model": "^4.1.5",
42
+ "@xyo-network/bridge-http": "^4.1.5",
43
+ "@xyo-network/bridge-model": "^4.1.5",
44
+ "@xyo-network/chain-modules": "^1.7.8",
45
+ "@xyo-network/diviner-model": "^4.1.5",
46
+ "@xyo-network/module-model": "^4.1.5",
47
+ "@xyo-network/node-memory": "^4.1.5",
48
+ "@xyo-network/sentinel-memory": "^4.1.5",
49
+ "@xyo-network/sentinel-model": "^4.1.5",
50
50
  "@xyo-network/xl1-protocol": "^1.7.5",
51
51
  "async-mutex": "^0.5.0"
52
52
  },
53
53
  "devDependencies": {
54
54
  "@types/node": "^24.0.14",
55
- "@xylabs/hex": "^4.13.19",
55
+ "@xylabs/hex": "^4.13.21",
56
56
  "@xylabs/ts-scripts-yarn3": "^7.0.0",
57
57
  "@xylabs/tsconfig": "^7.0.0",
58
- "knip": "^5.61.3",
58
+ "knip": "^5.62.0",
59
59
  "typescript": "^5.8.3"
60
60
  },
61
61
  "engines": {