@xyo-network/diviner-address-history-model 5.3.24 → 5.3.26

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 +228 -10
  2. package/package.json +13 -13
package/README.md CHANGED
@@ -1,23 +1,241 @@
1
+ [![logo][]](https://xyo.network)
2
+
1
3
  # @xyo-network/diviner-address-history-model
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:
4
13
 
5
- Version: 5.0.2
14
+ ```sh
15
+ npm install {{name}}
16
+ ```
6
17
 
7
- Primary SDK for using XYO Protocol 2.0
18
+ Using yarn:
8
19
 
9
- ## Documentation
20
+ ```sh
21
+ yarn add {{name}}
22
+ ```
10
23
 
11
- [TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__diviner-address-history-model)
24
+ Using pnpm:
25
+
26
+ ```sh
27
+ pnpm add {{name}}
28
+ ```
29
+
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
+ ### modules
46
+
47
+ ### packages
48
+
49
+ ### diviner
50
+
51
+ ### packages
52
+
53
+ ### addresshistory
54
+
55
+ ### packages
56
+
57
+ ### model
58
+
59
+ ### .temp-typedoc
60
+
61
+ ### functions
62
+
63
+ ### <a id="isAddressHistoryPayload"></a>isAddressHistoryPayload
64
+
65
+ [**@xyo-network/diviner-address-history-model**](#../README)
66
+
67
+ ***
68
+
69
+ ```ts
70
+ function isAddressHistoryPayload(x?): x is AddressHistoryPayload;
71
+ ```
72
+
73
+ ## Parameters
74
+
75
+ ### x?
76
+
77
+ `Payload` \| `null`
78
+
79
+ ## Returns
80
+
81
+ `x is AddressHistoryPayload`
82
+
83
+ ### type-aliases
84
+
85
+ ### <a id="AddressHistoryDivinerConfig"></a>AddressHistoryDivinerConfig
86
+
87
+ [**@xyo-network/diviner-address-history-model**](#../README)
88
+
89
+ ***
90
+
91
+ ```ts
92
+ type AddressHistoryDivinerConfig = DivinerConfig<{
93
+ address?: Address;
94
+ schema: AddressHistoryDivinerConfigSchema;
95
+ }>;
96
+ ```
97
+
98
+ ### <a id="AddressHistoryDivinerConfigSchema"></a>AddressHistoryDivinerConfigSchema
99
+
100
+ [**@xyo-network/diviner-address-history-model**](#../README)
101
+
102
+ ***
103
+
104
+ ```ts
105
+ type AddressHistoryDivinerConfigSchema = typeof AddressHistoryDivinerConfigSchema;
106
+ ```
107
+
108
+ ### <a id="AddressHistoryDivinerParams"></a>AddressHistoryDivinerParams
109
+
110
+ [**@xyo-network/diviner-address-history-model**](#../README)
111
+
112
+ ***
113
+
114
+ ```ts
115
+ type AddressHistoryDivinerParams = DivinerParams<AnyConfigSchema<AddressHistoryDivinerConfig>>;
116
+ ```
117
+
118
+ ### <a id="AddressHistoryPayload"></a>AddressHistoryPayload
119
+
120
+ [**@xyo-network/diviner-address-history-model**](#../README)
121
+
122
+ ***
123
+
124
+ ```ts
125
+ type AddressHistoryPayload = Payload<{
126
+ schema: AddressHistorySchema;
127
+ }>;
128
+ ```
129
+
130
+ ### <a id="AddressHistoryQueryPayload"></a>AddressHistoryQueryPayload
131
+
132
+ [**@xyo-network/diviner-address-history-model**](#../README)
133
+
134
+ ***
135
+
136
+ ```ts
137
+ type AddressHistoryQueryPayload = Query<object & Omit<PayloadFindFilter, "schema">>;
138
+ ```
139
+
140
+ ### <a id="AddressHistoryQuerySchema"></a>AddressHistoryQuerySchema
141
+
142
+ [**@xyo-network/diviner-address-history-model**](#../README)
143
+
144
+ ***
145
+
146
+ ```ts
147
+ type AddressHistoryQuerySchema = typeof AddressHistoryQuerySchema;
148
+ ```
149
+
150
+ ### <a id="AddressHistorySchema"></a>AddressHistorySchema
151
+
152
+ [**@xyo-network/diviner-address-history-model**](#../README)
153
+
154
+ ***
155
+
156
+ ```ts
157
+ type AddressHistorySchema = typeof AddressHistorySchema;
158
+ ```
159
+
160
+ ### variables
161
+
162
+ ### <a id="AddressHistoryDivinerConfigSchema"></a>AddressHistoryDivinerConfigSchema
163
+
164
+ [**@xyo-network/diviner-address-history-model**](#../README)
165
+
166
+ ***
167
+
168
+ ```ts
169
+ const AddressHistoryDivinerConfigSchema: string & object;
170
+ ```
171
+
172
+ ## Type Declaration
173
+
174
+ ### \_\_schema
175
+
176
+ ```ts
177
+ readonly __schema: true;
178
+ ```
179
+
180
+ ### <a id="AddressHistoryQuerySchema"></a>AddressHistoryQuerySchema
181
+
182
+ [**@xyo-network/diviner-address-history-model**](#../README)
183
+
184
+ ***
185
+
186
+ ```ts
187
+ const AddressHistoryQuerySchema: "network.xyo.diviner.address.history.query" & object;
188
+ ```
189
+
190
+ ## Type Declaration
191
+
192
+ ### \_\_schema
193
+
194
+ ```ts
195
+ readonly __schema: true;
196
+ ```
197
+
198
+ ### <a id="AddressHistorySchema"></a>AddressHistorySchema
199
+
200
+ [**@xyo-network/diviner-address-history-model**](#../README)
201
+
202
+ ***
203
+
204
+ ```ts
205
+ const AddressHistorySchema: "network.xyo.diviner.address.history" & object;
206
+ ```
207
+
208
+ ## Type Declaration
209
+
210
+ ### \_\_schema
211
+
212
+ ```ts
213
+ readonly __schema: true;
214
+ ```
215
+
216
+ ### <a id="isAddressHistoryQueryPayload"></a>isAddressHistoryQueryPayload
217
+
218
+ [**@xyo-network/diviner-address-history-model**](#../README)
219
+
220
+ ***
221
+
222
+ ```ts
223
+ const isAddressHistoryQueryPayload: (x?) => x is AddressHistoryQueryPayload;
224
+ ```
225
+
226
+ ## Parameters
227
+
228
+ ### x?
229
+
230
+ `unknown`
231
+
232
+ ## Returns
18
233
 
19
- ## Credits
234
+ `x is AddressHistoryQueryPayload`
20
235
 
21
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
22
236
 
23
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
237
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
238
+ [npm-badge]: https://img.shields.io/npm/v/@xyo-network/diviner-address-history-model.svg
239
+ [npm-link]: https://www.npmjs.com/package/@xyo-network/diviner-address-history-model
240
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/diviner-address-history-model.svg
241
+ [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/diviner-address-history-model",
3
- "version": "5.3.24",
3
+ "version": "5.3.26",
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",
@@ -36,25 +36,25 @@
36
36
  "README.md"
37
37
  ],
38
38
  "dependencies": {
39
- "@xyo-network/diviner-model": "~5.3.24",
40
- "@xyo-network/module-model": "~5.3.24",
41
- "@xyo-network/payload-model": "~5.3.24"
39
+ "@xyo-network/diviner-model": "~5.3.26",
40
+ "@xyo-network/module-model": "~5.3.26",
41
+ "@xyo-network/payload-model": "~5.3.26"
42
42
  },
43
43
  "devDependencies": {
44
44
  "@opentelemetry/api": "^1.9.1",
45
- "@types/node": "^25.5.0",
46
- "@xylabs/sdk-js": "^5.0.93",
47
- "@xylabs/ts-scripts-common": "~7.6.16",
48
- "@xylabs/ts-scripts-pnpm": "~7.6.16",
49
- "@xylabs/tsconfig": "~7.6.16",
45
+ "@types/node": "^25.5.2",
46
+ "@xylabs/sdk-js": "^5.0.94",
47
+ "@xylabs/ts-scripts-common": "~7.7.5",
48
+ "@xylabs/ts-scripts-pnpm": "~7.7.5",
49
+ "@xylabs/tsconfig": "~7.7.5",
50
50
  "acorn": "^8.16.0",
51
51
  "axios": "^1.14.0",
52
52
  "esbuild": "^0.28.0",
53
53
  "typescript": "~5.9.3",
54
54
  "zod": "^4.3.6",
55
- "@xyo-network/diviner-model": "~5.3.24",
56
- "@xyo-network/module-model": "~5.3.24",
57
- "@xyo-network/payload-model": "~5.3.24"
55
+ "@xyo-network/module-model": "~5.3.26",
56
+ "@xyo-network/diviner-model": "~5.3.26",
57
+ "@xyo-network/payload-model": "~5.3.26"
58
58
  },
59
59
  "peerDependencies": {
60
60
  "@xylabs/sdk-js": "^5"