@xyo-network/boundwitness-loader 5.3.25 → 5.3.27

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 +161 -10
  2. package/package.json +18 -23
package/README.md CHANGED
@@ -1,23 +1,174 @@
1
+ [![logo][]](https://xyo.network)
2
+
1
3
  # @xyo-network/boundwitness-loader
2
4
 
3
- [![logo][]](https://xyo.network)
5
+ [![npm][npm-badge]][npm-link]
6
+ [![license][license-badge]][license-link]
7
+
8
+ > Primary SDK for using XYO Protocol 2.0
9
+
10
+ ## Install
11
+
12
+ Using npm:
13
+
14
+ ```sh
15
+ npm install {{name}}
16
+ ```
17
+
18
+ Using yarn:
4
19
 
5
- Version: 5.0.2
20
+ ```sh
21
+ yarn add {{name}}
22
+ ```
6
23
 
7
- Primary SDK for using XYO Protocol 2.0
24
+ Using pnpm:
8
25
 
9
- ## Documentation
26
+ ```sh
27
+ pnpm add {{name}}
28
+ ```
10
29
 
11
- [TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__boundwitness-loader)
30
+ Using bun:
31
+
32
+ ```sh
33
+ bun add {{name}}
34
+ ```
12
35
 
13
- Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
14
36
 
15
37
  ## License
16
38
 
17
- > See the [LICENSE](LICENSE) file for license details
39
+ See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
40
+
41
+ ## Reference
42
+
43
+ ### packages
44
+
45
+ ### protocol
46
+
47
+ ### packages
48
+
49
+ ### boundwitness
50
+
51
+ ### packages
52
+
53
+ ### loader
54
+
55
+ ### .temp-typedoc
56
+
57
+ ### classes
58
+
59
+ ### <a id="BoundWitnessLoader"></a>BoundWitnessLoader
60
+
61
+ [**@xyo-network/boundwitness-loader**](#../README)
62
+
63
+ ***
64
+
65
+ ## Extends
66
+
67
+ - `Base`\<[`BoundWitnessLoaderParams`](#../interfaces/BoundWitnessLoaderParams)\>
68
+
69
+ ## Constructors
70
+
71
+ ### Constructor
72
+
73
+ ```ts
74
+ new BoundWitnessLoader(params): BoundWitnessLoader;
75
+ ```
76
+
77
+ ### Parameters
78
+
79
+ #### params
80
+
81
+ `BaseParams`\<[`BoundWitnessLoaderParams`](#../interfaces/BoundWitnessLoaderParams)\>
82
+
83
+ ### Returns
84
+
85
+ `BoundWitnessLoader`
86
+
87
+ ### Inherited from
88
+
89
+ ```ts
90
+ Base<BoundWitnessLoaderParams>.constructor
91
+ ```
92
+
93
+ ## Methods
94
+
95
+ ### load()
96
+
97
+ ```ts
98
+ load(hash): Promise<Payload[]>;
99
+ ```
100
+
101
+ ### Parameters
102
+
103
+ #### hash
104
+
105
+ `BrandedHash` \| `BrandedHash`[]
106
+
107
+ ### Returns
108
+
109
+ `Promise`\<`Payload`[]\>
110
+
111
+ ### interfaces
112
+
113
+ ### <a id="BoundWitnessLoaderParams"></a>BoundWitnessLoaderParams
114
+
115
+ [**@xyo-network/boundwitness-loader**](#../README)
116
+
117
+ ***
118
+
119
+ ## Extends
120
+
121
+ - `BaseParams`
122
+
123
+ ## Properties
124
+
125
+ ### cache?
126
+
127
+ ```ts
128
+ optional cache?: ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>;
129
+ ```
130
+
131
+ ***
132
+
133
+ ### workingSet
134
+
135
+ ```ts
136
+ workingSet: PayloadWorkingSet;
137
+ ```
138
+
139
+ ### <a id="PayloadWorkingSet"></a>PayloadWorkingSet
140
+
141
+ [**@xyo-network/boundwitness-loader**](#../README)
142
+
143
+ ***
144
+
145
+ ## Properties
146
+
147
+ ### archivists?
148
+
149
+ ```ts
150
+ optional archivists?: ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>[];
151
+ ```
152
+
153
+ ***
154
+
155
+ ### huriEndpoints?
156
+
157
+ ```ts
158
+ optional huriEndpoints?: string[];
159
+ ```
160
+
161
+ ***
162
+
163
+ ### payloads?
18
164
 
19
- ## Credits
165
+ ```ts
166
+ optional payloads?: Payload[];
167
+ ```
20
168
 
21
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
22
169
 
23
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
170
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
171
+ [npm-badge]: https://img.shields.io/npm/v/@xyo-network/boundwitness-loader.svg
172
+ [npm-link]: https://www.npmjs.com/package/@xyo-network/boundwitness-loader
173
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/boundwitness-loader.svg
174
+ [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/boundwitness-loader",
3
- "version": "5.3.25",
3
+ "version": "5.3.27",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -22,11 +22,11 @@
22
22
  "exports": {
23
23
  ".": {
24
24
  "types": "./dist/neutral/index.d.ts",
25
+ "import": "./dist/neutral/index.mjs",
25
26
  "default": "./dist/neutral/index.mjs"
26
27
  },
27
28
  "./package.json": "./package.json"
28
29
  },
29
- "module": "dist/neutral/index.mjs",
30
30
  "types": "dist/neutral/index.d.ts",
31
31
  "files": [
32
32
  "dist",
@@ -37,40 +37,35 @@
37
37
  ],
38
38
  "dependencies": {
39
39
  "async-mutex": "~0.5.0",
40
- "@xyo-network/archivist-memory": "~5.3.25",
41
- "@xyo-network/boundwitness-model": "~5.3.25",
42
- "@xyo-network/payload-model": "~5.3.25",
43
- "@xyo-network/huri": "~5.3.25",
44
- "@xyo-network/archivist-model": "~5.3.25"
40
+ "@xyo-network/archivist-memory": "~5.3.27",
41
+ "@xyo-network/archivist-model": "~5.3.27",
42
+ "@xyo-network/payload-model": "~5.3.27",
43
+ "@xyo-network/huri": "~5.3.27",
44
+ "@xyo-network/boundwitness-model": "~5.3.27"
45
45
  },
46
46
  "devDependencies": {
47
47
  "@opentelemetry/api": "^1.9.1",
48
- "@types/node": "^25.5.0",
49
- "@xylabs/sdk-js": "^5.0.93",
50
- "@xylabs/ts-scripts-common": "~7.6.16",
51
- "@xylabs/ts-scripts-pnpm": "~7.6.16",
52
- "@xylabs/tsconfig": "~7.6.16",
53
- "acorn": "^8.16.0",
48
+ "@types/node": "^25.5.2",
49
+ "@xylabs/sdk-js": "^5.0.94",
50
+ "@xylabs/ts-scripts-common": "~7.7.15",
51
+ "@xylabs/ts-scripts-pnpm": "~7.7.15",
52
+ "@xylabs/tsconfig": "~7.7.15",
54
53
  "async-mutex": "~0.5.0",
55
54
  "axios": "^1.14.0",
56
55
  "esbuild": "^0.28.0",
57
56
  "ethers": "^6.16.0",
58
- "tslib": "^2.8.1",
59
57
  "typescript": "~5.9.3",
60
58
  "vite": "^8.0.3",
61
59
  "vitest": "~4.1.2",
62
60
  "zod": "^4.3.6",
63
- "@xyo-network/archivist-memory": "~5.3.25",
64
- "@xyo-network/archivist-model": "~5.3.25",
65
- "@xyo-network/boundwitness-model": "~5.3.25",
66
- "@xyo-network/huri": "~5.3.25",
67
- "@xyo-network/payload-model": "~5.3.25"
61
+ "@xyo-network/archivist-memory": "~5.3.27",
62
+ "@xyo-network/boundwitness-model": "~5.3.27",
63
+ "@xyo-network/archivist-model": "~5.3.27",
64
+ "@xyo-network/huri": "~5.3.27",
65
+ "@xyo-network/payload-model": "~5.3.27"
68
66
  },
69
67
  "peerDependencies": {
70
- "@xylabs/sdk-js": "^5",
71
- "ethers": "^6",
72
- "tslib": "^2.8.1",
73
- "zod": "^4"
68
+ "@xylabs/sdk-js": "^5"
74
69
  },
75
70
  "publishConfig": {
76
71
  "access": "public"