@xyo-network/chain-validation 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 +207 -3
  2. package/package.json +23 -23
package/README.md CHANGED
@@ -8,13 +8,217 @@
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 Validation
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-validation)
15
+ ## Reference
16
+
17
+ **@xyo-network/chain-validation**
18
+
19
+ ***
20
+
21
+ ## Variables
22
+
23
+ - [validateBlock](#variables/validateBlock)
24
+ - [BoundWitnessSignaturesValidator](#variables/BoundWitnessSignaturesValidator)
25
+ - [validateHydratedBlock](#variables/validateHydratedBlock)
26
+ - [PayloadsInBlockValidator](#variables/PayloadsInBlockValidator)
27
+ - [validateHydratedBlockState](#variables/validateHydratedBlockState)
28
+ - [RequiredBalanceBlockStateValidator](#variables/RequiredBalanceBlockStateValidator)
29
+ - [TransactionDurationValidator](#variables/TransactionDurationValidator)
30
+ - [TransactionElevationValidator](#variables/TransactionElevationValidator)
31
+ - [TransactionFromValidator](#variables/TransactionFromValidator)
32
+ - [TransactionGasValidator](#variables/TransactionGasValidator)
33
+ - [TransactionJsonSchemaValidator](#variables/TransactionJsonSchemaValidator)
34
+ - [TransactionProtocolValidator](#variables/TransactionProtocolValidator)
35
+
36
+ ## Functions
37
+
38
+ - [BoundWitnessReferencesValidator](#functions/BoundWitnessReferencesValidator)
39
+ - [validateTransaction](#functions/validateTransaction)
40
+
41
+ ### functions
42
+
43
+ ### <a id="BoundWitnessReferencesValidator"></a>BoundWitnessReferencesValidator
44
+
45
+ [**@xyo-network/chain-validation**](#../README)
46
+
47
+ ***
48
+
49
+ ```ts
50
+ function BoundWitnessReferencesValidator<T>(allowedSchemas?): HydratedBoundWitnessValidationFunction<T>;
51
+ ```
52
+
53
+ ## Type Parameters
54
+
55
+ ### T
56
+
57
+ `T` *extends* `BoundWitness` = `BoundWitness`
58
+
59
+ ## Parameters
60
+
61
+ ### allowedSchemas?
62
+
63
+ `string`[]
64
+
65
+ ## Returns
66
+
67
+ `HydratedBoundWitnessValidationFunction`\<`T`\>
68
+
69
+ ### <a id="validateTransaction"></a>validateTransaction
70
+
71
+ [**@xyo-network/chain-validation**](#../README)
72
+
73
+ ***
74
+
75
+ ```ts
76
+ function validateTransaction(
77
+ tx,
78
+ chainId?,
79
+ additionalValidators?): Promise<Error[]>;
80
+ ```
81
+
82
+ ## Parameters
83
+
84
+ ### tx
85
+
86
+ `HydratedTransaction`
87
+
88
+ ### chainId?
89
+
90
+ `Lowercase`\<`string`\>
91
+
92
+ ### additionalValidators?
93
+
94
+ `HydratedTransactionValidationFunction`[] = `[]`
95
+
96
+ ## Returns
97
+
98
+ `Promise`\<`Error`[]\>
99
+
100
+ ### variables
101
+
102
+ ### <a id="BoundWitnessSignaturesValidator"></a>BoundWitnessSignaturesValidator
103
+
104
+ [**@xyo-network/chain-validation**](#../README)
105
+
106
+ ***
107
+
108
+ ```ts
109
+ const BoundWitnessSignaturesValidator: BoundWitnessValidationFunction;
110
+ ```
111
+
112
+ ### <a id="PayloadsInBlockValidator"></a>PayloadsInBlockValidator
113
+
114
+ [**@xyo-network/chain-validation**](#../README)
115
+
116
+ ***
117
+
118
+ ```ts
119
+ const PayloadsInBlockValidator: HydratedBlockValidationFunction;
120
+ ```
121
+
122
+ ### <a id="RequiredBalanceBlockStateValidator"></a>RequiredBalanceBlockStateValidator
123
+
124
+ [**@xyo-network/chain-validation**](#../README)
125
+
126
+ ***
127
+
128
+ ```ts
129
+ const RequiredBalanceBlockStateValidator: HydratedBlockStateValidationFunctionV2;
130
+ ```
131
+
132
+ ### <a id="TransactionDurationValidator"></a>TransactionDurationValidator
133
+
134
+ [**@xyo-network/chain-validation**](#../README)
135
+
136
+ ***
137
+
138
+ ```ts
139
+ const TransactionDurationValidator: HydratedTransactionValidationFunction<TransactionBoundWitness>;
140
+ ```
141
+
142
+ ### <a id="TransactionElevationValidator"></a>TransactionElevationValidator
143
+
144
+ [**@xyo-network/chain-validation**](#../README)
145
+
146
+ ***
147
+
148
+ ```ts
149
+ const TransactionElevationValidator: HydratedTransactionValidationFunction<TransactionBoundWitness>;
150
+ ```
151
+
152
+ ### <a id="TransactionFromValidator"></a>TransactionFromValidator
153
+
154
+ [**@xyo-network/chain-validation**](#../README)
155
+
156
+ ***
157
+
158
+ ```ts
159
+ const TransactionFromValidator: HydratedTransactionValidationFunction<TransactionBoundWitness>;
160
+ ```
161
+
162
+ ### <a id="TransactionGasValidator"></a>TransactionGasValidator
163
+
164
+ [**@xyo-network/chain-validation**](#../README)
165
+
166
+ ***
167
+
168
+ ```ts
169
+ const TransactionGasValidator: HydratedTransactionValidationFunction<TransactionBoundWitness>;
170
+ ```
171
+
172
+ ### <a id="TransactionJsonSchemaValidator"></a>TransactionJsonSchemaValidator
173
+
174
+ [**@xyo-network/chain-validation**](#../README)
175
+
176
+ ***
177
+
178
+ ```ts
179
+ const TransactionJsonSchemaValidator: HydratedTransactionValidationFunction<TransactionBoundWitness>;
180
+ ```
181
+
182
+ ### <a id="TransactionProtocolValidator"></a>TransactionProtocolValidator
183
+
184
+ [**@xyo-network/chain-validation**](#../README)
185
+
186
+ ***
187
+
188
+ ```ts
189
+ const TransactionProtocolValidator: HydratedTransactionValidationFunction<TransactionBoundWitness>;
190
+ ```
191
+
192
+ ### <a id="validateBlock"></a>validateBlock
193
+
194
+ [**@xyo-network/chain-validation**](#../README)
195
+
196
+ ***
197
+
198
+ ```ts
199
+ const validateBlock: BlockValidatorFunction;
200
+ ```
201
+
202
+ ### <a id="validateHydratedBlock"></a>validateHydratedBlock
203
+
204
+ [**@xyo-network/chain-validation**](#../README)
205
+
206
+ ***
207
+
208
+ ```ts
209
+ const validateHydratedBlock: HydratedBlockValidationFunction;
210
+ ```
211
+
212
+ ### <a id="validateHydratedBlockState"></a>validateHydratedBlockState
213
+
214
+ [**@xyo-network/chain-validation**](#../README)
215
+
216
+ ***
217
+
218
+ ```ts
219
+ const validateHydratedBlockState: HydratedBlockStateValidationFunctionV2;
220
+ ```
221
+
18
222
 
19
223
  ## Maintainers
20
224
 
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-validation",
4
- "version": "1.7.6",
4
+ "version": "1.7.8",
5
5
  "description": "XYO Layer One SDK Validation",
6
6
  "homepage": "https://xylabs.com",
7
7
  "bugs": {
@@ -34,35 +34,35 @@
34
34
  "deploy3": "echo Deploy3 not allowed!"
35
35
  },
36
36
  "dependencies": {
37
- "@xylabs/arraybuffer": "^4.13.19",
38
- "@xylabs/hex": "^4.13.19",
39
- "@xylabs/typeof": "^4.13.19",
40
- "@xyo-network/boundwitness-builder": "^4.1.4",
41
- "@xyo-network/boundwitness-model": "^4.1.4",
42
- "@xyo-network/boundwitness-validator": "^4.1.4",
43
- "@xyo-network/chain-protocol": "^1.7.6",
44
- "@xyo-network/chain-schema": "^1.7.6",
45
- "@xyo-network/chain-utils": "^1.7.6",
46
- "@xyo-network/payload-builder": "^4.1.4",
47
- "@xyo-network/payload-model": "^4.1.4",
48
- "@xyo-network/schema-payload-plugin": "^4.1.4",
37
+ "@xylabs/arraybuffer": "^4.13.21",
38
+ "@xylabs/hex": "^4.13.21",
39
+ "@xylabs/typeof": "^4.13.21",
40
+ "@xyo-network/boundwitness-builder": "^4.1.5",
41
+ "@xyo-network/boundwitness-model": "^4.1.5",
42
+ "@xyo-network/boundwitness-validator": "^4.1.5",
43
+ "@xyo-network/chain-protocol": "^1.7.8",
44
+ "@xyo-network/chain-schema": "^1.7.8",
45
+ "@xyo-network/chain-utils": "^1.7.8",
46
+ "@xyo-network/payload-builder": "^4.1.5",
47
+ "@xyo-network/payload-model": "^4.1.5",
48
+ "@xyo-network/schema-payload-plugin": "^4.1.5",
49
49
  "@xyo-network/xl1-protocol": "^1.7.5",
50
- "@xyo-network/xl1-protocol-sdk": "^1.7.6",
50
+ "@xyo-network/xl1-protocol-sdk": "^1.7.8",
51
51
  "ajv": "^8.17.1"
52
52
  },
53
53
  "devDependencies": {
54
54
  "@types/node": "^24.0.14",
55
- "@xylabs/assert": "^4.13.19",
56
- "@xylabs/promise": "^4.13.19",
55
+ "@xylabs/assert": "^4.13.21",
56
+ "@xylabs/promise": "^4.13.21",
57
57
  "@xylabs/ts-scripts-yarn3": "^7.0.0",
58
58
  "@xylabs/tsconfig": "^7.0.0",
59
- "@xyo-network/account": "^4.1.4",
60
- "@xyo-network/account-model": "^4.1.4",
61
- "@xyo-network/archivist-memory": "^4.1.4",
62
- "@xyo-network/archivist-model": "^4.1.4",
63
- "@xyo-network/wallet": "^4.1.4",
64
- "@xyo-network/xl1-protocol-sdk": "^1.7.6",
65
- "knip": "^5.61.3",
59
+ "@xyo-network/account": "^4.1.5",
60
+ "@xyo-network/account-model": "^4.1.5",
61
+ "@xyo-network/archivist-memory": "^4.1.5",
62
+ "@xyo-network/archivist-model": "^4.1.5",
63
+ "@xyo-network/wallet": "^4.1.5",
64
+ "@xyo-network/xl1-protocol-sdk": "^1.7.8",
65
+ "knip": "^5.62.0",
66
66
  "typescript": "^5.8.3",
67
67
  "vitest": "^3.2.4"
68
68
  },