@ssv-labs/ssv-sdk 0.0.1

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 (64) hide show
  1. package/LICENSE +674 -0
  2. package/README.html +102 -0
  3. package/README.md +136 -0
  4. package/README.pdf +0 -0
  5. package/dist/abi/holesky/v4/getter.d.ts +824 -0
  6. package/dist/abi/holesky/v4/setter.d.ts +1662 -0
  7. package/dist/abi/mainnet/v4/getter.d.ts +824 -0
  8. package/dist/abi/mainnet/v4/setter.d.ts +1677 -0
  9. package/dist/abi/token.d.ts +292 -0
  10. package/dist/api/ssv-api/index.d.ts +16 -0
  11. package/dist/api/subgraph/index.d.ts +101 -0
  12. package/dist/config/chains.d.ts +94 -0
  13. package/dist/config/create.d.ts +45 -0
  14. package/dist/config/globals.d.ts +33 -0
  15. package/dist/config/index.d.ts +3 -0
  16. package/dist/config-DPI30L0i.js +5159 -0
  17. package/dist/config-DlwfpwZd.mjs +5161 -0
  18. package/dist/contract-interactions/create.d.ts +3 -0
  19. package/dist/contract-interactions/index.d.ts +1 -0
  20. package/dist/contract-interactions/types.d.ts +93 -0
  21. package/dist/graphql/graphql.d.ts +3249 -0
  22. package/dist/libs/api/index.d.ts +81 -0
  23. package/dist/libs/cluster/index.d.ts +5636 -0
  24. package/dist/libs/cluster/methods/deposit.d.ts +286 -0
  25. package/dist/libs/cluster/methods/exit-validators.d.ts +283 -0
  26. package/dist/libs/cluster/methods/index.d.ts +8 -0
  27. package/dist/libs/cluster/methods/liquidate-cluster.d.ts +281 -0
  28. package/dist/libs/cluster/methods/reactivate-cluster.d.ts +282 -0
  29. package/dist/libs/cluster/methods/register-validators.d.ts +3652 -0
  30. package/dist/libs/cluster/methods/remove-validators.d.ts +283 -0
  31. package/dist/libs/cluster/methods/set-fee-recipient.d.ts +282 -0
  32. package/dist/libs/cluster/methods/withdraw.d.ts +282 -0
  33. package/dist/libs/operator/index.d.ts +4005 -0
  34. package/dist/libs/operator/methods.d.ts +844 -0
  35. package/dist/libs/utils/index.d.ts +32 -0
  36. package/dist/libs/utils/methods/get-cluster-balance.d.ts +9 -0
  37. package/dist/libs/utils/methods/index.d.ts +4 -0
  38. package/dist/libs/utils/methods/keyshares.d.ts +21 -0
  39. package/dist/libs/utils/methods/keystores.d.ts +13 -0
  40. package/dist/libs/utils/methods/methods.d.ts +2 -0
  41. package/dist/main.d.ts +8 -0
  42. package/dist/main.js +36437 -0
  43. package/dist/main.mjs +36437 -0
  44. package/dist/mock/api.d.ts +3 -0
  45. package/dist/mock/config.d.ts +6 -0
  46. package/dist/mock/index.d.ts +8 -0
  47. package/dist/sdk.d.ts +14 -0
  48. package/dist/types/contract-interactions.d.ts +21 -0
  49. package/dist/types/methods.d.ts +3 -0
  50. package/dist/types/operator.d.ts +9 -0
  51. package/dist/types/utils.d.ts +3 -0
  52. package/dist/utils/bigint.d.ts +29 -0
  53. package/dist/utils/cluster.d.ts +8 -0
  54. package/dist/utils/contract.d.ts +3 -0
  55. package/dist/utils/index.d.ts +9 -0
  56. package/dist/utils/keyshares.d.ts +21 -0
  57. package/dist/utils/number.d.ts +21 -0
  58. package/dist/utils/operator.d.ts +5 -0
  59. package/dist/utils/try-catch.d.ts +1 -0
  60. package/dist/utils/url-join.d.ts +1 -0
  61. package/dist/utils/zod/config.d.ts +9 -0
  62. package/dist/utils.js +43 -0
  63. package/dist/utils.mjs +43 -0
  64. package/package.json +136 -0
@@ -0,0 +1,283 @@
1
+ import { ConfigReturnType } from '../../../config/create';
2
+ import { SmartFnWriteOptions } from '../../../contract-interactions/types';
3
+ import { Hex } from 'viem';
4
+ type RemoveValidatorsProps = SmartFnWriteOptions<{
5
+ id: string;
6
+ publicKeys: Hex[];
7
+ }>;
8
+ export declare const removeValidators: (config: ConfigReturnType, { args: { id, publicKeys }, ...writeOptions }: RemoveValidatorsProps) => Promise<{
9
+ hash: `0x${string}`;
10
+ wait: () => Promise<import('viem').TransactionReceipt & {
11
+ events: ({
12
+ eventName: "AdminChanged";
13
+ args: {
14
+ previousAdmin: `0x${string}`;
15
+ newAdmin: `0x${string}`;
16
+ };
17
+ } | {
18
+ eventName: "BeaconUpgraded";
19
+ args: {
20
+ beacon: `0x${string}`;
21
+ };
22
+ } | {
23
+ eventName: "Initialized";
24
+ args: {
25
+ version: number;
26
+ };
27
+ } | {
28
+ eventName: "OwnershipTransferStarted";
29
+ args: {
30
+ previousOwner: `0x${string}`;
31
+ newOwner: `0x${string}`;
32
+ };
33
+ } | {
34
+ eventName: "OwnershipTransferred";
35
+ args: {
36
+ previousOwner: `0x${string}`;
37
+ newOwner: `0x${string}`;
38
+ };
39
+ } | {
40
+ eventName: "Upgraded";
41
+ args: {
42
+ implementation: `0x${string}`;
43
+ };
44
+ } | {
45
+ eventName: "ClusterDeposited";
46
+ args: {
47
+ owner: `0x${string}`;
48
+ operatorIds: readonly bigint[];
49
+ value: bigint;
50
+ cluster: {
51
+ validatorCount: number;
52
+ networkFeeIndex: bigint;
53
+ index: bigint;
54
+ active: boolean;
55
+ balance: bigint;
56
+ };
57
+ };
58
+ } | {
59
+ eventName: "ClusterLiquidated";
60
+ args: {
61
+ owner: `0x${string}`;
62
+ operatorIds: readonly bigint[];
63
+ cluster: {
64
+ validatorCount: number;
65
+ networkFeeIndex: bigint;
66
+ index: bigint;
67
+ active: boolean;
68
+ balance: bigint;
69
+ };
70
+ };
71
+ } | {
72
+ eventName: "ClusterReactivated";
73
+ args: {
74
+ owner: `0x${string}`;
75
+ operatorIds: readonly bigint[];
76
+ cluster: {
77
+ validatorCount: number;
78
+ networkFeeIndex: bigint;
79
+ index: bigint;
80
+ active: boolean;
81
+ balance: bigint;
82
+ };
83
+ };
84
+ } | {
85
+ eventName: "ClusterWithdrawn";
86
+ args: {
87
+ owner: `0x${string}`;
88
+ operatorIds: readonly bigint[];
89
+ value: bigint;
90
+ cluster: {
91
+ validatorCount: number;
92
+ networkFeeIndex: bigint;
93
+ index: bigint;
94
+ active: boolean;
95
+ balance: bigint;
96
+ };
97
+ };
98
+ } | {
99
+ eventName: "DeclareOperatorFeePeriodUpdated";
100
+ args: {
101
+ value: bigint;
102
+ };
103
+ } | {
104
+ eventName: "ExecuteOperatorFeePeriodUpdated";
105
+ args: {
106
+ value: bigint;
107
+ };
108
+ } | {
109
+ eventName: "FeeRecipientAddressUpdated";
110
+ args: {
111
+ owner: `0x${string}`;
112
+ recipientAddress: `0x${string}`;
113
+ };
114
+ } | {
115
+ eventName: "LiquidationThresholdPeriodUpdated";
116
+ args: {
117
+ value: bigint;
118
+ };
119
+ } | {
120
+ eventName: "MinimumLiquidationCollateralUpdated";
121
+ args: {
122
+ value: bigint;
123
+ };
124
+ } | {
125
+ eventName: "ModuleUpgraded";
126
+ args: {
127
+ moduleId: number;
128
+ moduleAddress: `0x${string}`;
129
+ };
130
+ } | {
131
+ eventName: "NetworkEarningsWithdrawn";
132
+ args: {
133
+ value: bigint;
134
+ recipient: `0x${string}`;
135
+ };
136
+ } | {
137
+ eventName: "NetworkFeeUpdated";
138
+ args: {
139
+ oldFee: bigint;
140
+ newFee: bigint;
141
+ };
142
+ } | {
143
+ eventName: "OperatorAdded";
144
+ args: {
145
+ operatorId: bigint;
146
+ owner: `0x${string}`;
147
+ publicKey: `0x${string}`;
148
+ fee: bigint;
149
+ };
150
+ } | {
151
+ eventName: "OperatorFeeDeclarationCancelled";
152
+ args: {
153
+ owner: `0x${string}`;
154
+ operatorId: bigint;
155
+ };
156
+ } | {
157
+ eventName: "OperatorFeeDeclared";
158
+ args: {
159
+ owner: `0x${string}`;
160
+ operatorId: bigint;
161
+ blockNumber: bigint;
162
+ fee: bigint;
163
+ };
164
+ } | {
165
+ eventName: "OperatorFeeExecuted";
166
+ args: {
167
+ owner: `0x${string}`;
168
+ operatorId: bigint;
169
+ blockNumber: bigint;
170
+ fee: bigint;
171
+ };
172
+ } | {
173
+ eventName: "OperatorFeeIncreaseLimitUpdated";
174
+ args: {
175
+ value: bigint;
176
+ };
177
+ } | {
178
+ eventName: "OperatorMaximumFeeUpdated";
179
+ args: {
180
+ maxFee: bigint;
181
+ };
182
+ } | {
183
+ eventName: "OperatorMultipleWhitelistRemoved";
184
+ args: {
185
+ operatorIds: readonly bigint[];
186
+ whitelistAddresses: readonly `0x${string}`[];
187
+ };
188
+ } | {
189
+ eventName: "OperatorMultipleWhitelistUpdated";
190
+ args: {
191
+ operatorIds: readonly bigint[];
192
+ whitelistAddresses: readonly `0x${string}`[];
193
+ };
194
+ } | {
195
+ eventName: "OperatorPrivacyStatusUpdated";
196
+ args: {
197
+ operatorIds: readonly bigint[];
198
+ toPrivate: boolean;
199
+ };
200
+ } | {
201
+ eventName: "OperatorRemoved";
202
+ args: {
203
+ operatorId: bigint;
204
+ };
205
+ } | {
206
+ eventName: "OperatorWhitelistUpdated";
207
+ args: {
208
+ operatorId: bigint;
209
+ whitelisted: `0x${string}`;
210
+ };
211
+ } | {
212
+ eventName: "OperatorWhitelistingContractUpdated";
213
+ args: {
214
+ operatorIds: readonly bigint[];
215
+ whitelistingContract: `0x${string}`;
216
+ };
217
+ } | {
218
+ eventName: "OperatorWithdrawn";
219
+ args: {
220
+ owner: `0x${string}`;
221
+ operatorId: bigint;
222
+ value: bigint;
223
+ };
224
+ } | {
225
+ eventName: "ValidatorAdded";
226
+ args: {
227
+ owner: `0x${string}`;
228
+ operatorIds: readonly bigint[];
229
+ publicKey: `0x${string}`;
230
+ shares: `0x${string}`;
231
+ cluster: {
232
+ validatorCount: number;
233
+ networkFeeIndex: bigint;
234
+ index: bigint;
235
+ active: boolean;
236
+ balance: bigint;
237
+ };
238
+ };
239
+ } | {
240
+ eventName: "ValidatorExited";
241
+ args: {
242
+ owner: `0x${string}`;
243
+ operatorIds: readonly bigint[];
244
+ publicKey: `0x${string}`;
245
+ };
246
+ } | {
247
+ eventName: "ValidatorRemoved";
248
+ args: {
249
+ owner: `0x${string}`;
250
+ operatorIds: readonly bigint[];
251
+ publicKey: `0x${string}`;
252
+ cluster: {
253
+ validatorCount: number;
254
+ networkFeeIndex: bigint;
255
+ index: bigint;
256
+ active: boolean;
257
+ balance: bigint;
258
+ };
259
+ };
260
+ } | {
261
+ eventName: "OwnershipTransferred";
262
+ args: {
263
+ previousOwner: `0x${string}`;
264
+ newOwner: `0x${string}`;
265
+ };
266
+ } | {
267
+ eventName: "Approval";
268
+ args: {
269
+ owner: `0x${string}`;
270
+ spender: `0x${string}`;
271
+ value: bigint;
272
+ };
273
+ } | {
274
+ eventName: "Transfer";
275
+ args: {
276
+ from: `0x${string}`;
277
+ to: `0x${string}`;
278
+ value: bigint;
279
+ };
280
+ })[];
281
+ }>;
282
+ }>;
283
+ export {};
@@ -0,0 +1,282 @@
1
+ import { ConfigReturnType } from '../../../config/create';
2
+ import { SmartFnWriteOptions } from '../../../contract-interactions/types';
3
+ import { Address } from 'abitype';
4
+ type SetFeeRecipientProps = SmartFnWriteOptions<{
5
+ recipient: Address;
6
+ }>;
7
+ export declare const setFeeRecipient: (config: ConfigReturnType, { args: { recipient }, ...writeOptions }: SetFeeRecipientProps) => Promise<{
8
+ hash: `0x${string}`;
9
+ wait: () => Promise<import('viem').TransactionReceipt & {
10
+ events: ({
11
+ eventName: "AdminChanged";
12
+ args: {
13
+ previousAdmin: `0x${string}`;
14
+ newAdmin: `0x${string}`;
15
+ };
16
+ } | {
17
+ eventName: "BeaconUpgraded";
18
+ args: {
19
+ beacon: `0x${string}`;
20
+ };
21
+ } | {
22
+ eventName: "Initialized";
23
+ args: {
24
+ version: number;
25
+ };
26
+ } | {
27
+ eventName: "OwnershipTransferStarted";
28
+ args: {
29
+ previousOwner: `0x${string}`;
30
+ newOwner: `0x${string}`;
31
+ };
32
+ } | {
33
+ eventName: "OwnershipTransferred";
34
+ args: {
35
+ previousOwner: `0x${string}`;
36
+ newOwner: `0x${string}`;
37
+ };
38
+ } | {
39
+ eventName: "Upgraded";
40
+ args: {
41
+ implementation: `0x${string}`;
42
+ };
43
+ } | {
44
+ eventName: "ClusterDeposited";
45
+ args: {
46
+ owner: `0x${string}`;
47
+ operatorIds: readonly bigint[];
48
+ value: bigint;
49
+ cluster: {
50
+ validatorCount: number;
51
+ networkFeeIndex: bigint;
52
+ index: bigint;
53
+ active: boolean;
54
+ balance: bigint;
55
+ };
56
+ };
57
+ } | {
58
+ eventName: "ClusterLiquidated";
59
+ args: {
60
+ owner: `0x${string}`;
61
+ operatorIds: readonly bigint[];
62
+ cluster: {
63
+ validatorCount: number;
64
+ networkFeeIndex: bigint;
65
+ index: bigint;
66
+ active: boolean;
67
+ balance: bigint;
68
+ };
69
+ };
70
+ } | {
71
+ eventName: "ClusterReactivated";
72
+ args: {
73
+ owner: `0x${string}`;
74
+ operatorIds: readonly bigint[];
75
+ cluster: {
76
+ validatorCount: number;
77
+ networkFeeIndex: bigint;
78
+ index: bigint;
79
+ active: boolean;
80
+ balance: bigint;
81
+ };
82
+ };
83
+ } | {
84
+ eventName: "ClusterWithdrawn";
85
+ args: {
86
+ owner: `0x${string}`;
87
+ operatorIds: readonly bigint[];
88
+ value: bigint;
89
+ cluster: {
90
+ validatorCount: number;
91
+ networkFeeIndex: bigint;
92
+ index: bigint;
93
+ active: boolean;
94
+ balance: bigint;
95
+ };
96
+ };
97
+ } | {
98
+ eventName: "DeclareOperatorFeePeriodUpdated";
99
+ args: {
100
+ value: bigint;
101
+ };
102
+ } | {
103
+ eventName: "ExecuteOperatorFeePeriodUpdated";
104
+ args: {
105
+ value: bigint;
106
+ };
107
+ } | {
108
+ eventName: "FeeRecipientAddressUpdated";
109
+ args: {
110
+ owner: `0x${string}`;
111
+ recipientAddress: `0x${string}`;
112
+ };
113
+ } | {
114
+ eventName: "LiquidationThresholdPeriodUpdated";
115
+ args: {
116
+ value: bigint;
117
+ };
118
+ } | {
119
+ eventName: "MinimumLiquidationCollateralUpdated";
120
+ args: {
121
+ value: bigint;
122
+ };
123
+ } | {
124
+ eventName: "ModuleUpgraded";
125
+ args: {
126
+ moduleId: number;
127
+ moduleAddress: `0x${string}`;
128
+ };
129
+ } | {
130
+ eventName: "NetworkEarningsWithdrawn";
131
+ args: {
132
+ value: bigint;
133
+ recipient: `0x${string}`;
134
+ };
135
+ } | {
136
+ eventName: "NetworkFeeUpdated";
137
+ args: {
138
+ oldFee: bigint;
139
+ newFee: bigint;
140
+ };
141
+ } | {
142
+ eventName: "OperatorAdded";
143
+ args: {
144
+ operatorId: bigint;
145
+ owner: `0x${string}`;
146
+ publicKey: `0x${string}`;
147
+ fee: bigint;
148
+ };
149
+ } | {
150
+ eventName: "OperatorFeeDeclarationCancelled";
151
+ args: {
152
+ owner: `0x${string}`;
153
+ operatorId: bigint;
154
+ };
155
+ } | {
156
+ eventName: "OperatorFeeDeclared";
157
+ args: {
158
+ owner: `0x${string}`;
159
+ operatorId: bigint;
160
+ blockNumber: bigint;
161
+ fee: bigint;
162
+ };
163
+ } | {
164
+ eventName: "OperatorFeeExecuted";
165
+ args: {
166
+ owner: `0x${string}`;
167
+ operatorId: bigint;
168
+ blockNumber: bigint;
169
+ fee: bigint;
170
+ };
171
+ } | {
172
+ eventName: "OperatorFeeIncreaseLimitUpdated";
173
+ args: {
174
+ value: bigint;
175
+ };
176
+ } | {
177
+ eventName: "OperatorMaximumFeeUpdated";
178
+ args: {
179
+ maxFee: bigint;
180
+ };
181
+ } | {
182
+ eventName: "OperatorMultipleWhitelistRemoved";
183
+ args: {
184
+ operatorIds: readonly bigint[];
185
+ whitelistAddresses: readonly `0x${string}`[];
186
+ };
187
+ } | {
188
+ eventName: "OperatorMultipleWhitelistUpdated";
189
+ args: {
190
+ operatorIds: readonly bigint[];
191
+ whitelistAddresses: readonly `0x${string}`[];
192
+ };
193
+ } | {
194
+ eventName: "OperatorPrivacyStatusUpdated";
195
+ args: {
196
+ operatorIds: readonly bigint[];
197
+ toPrivate: boolean;
198
+ };
199
+ } | {
200
+ eventName: "OperatorRemoved";
201
+ args: {
202
+ operatorId: bigint;
203
+ };
204
+ } | {
205
+ eventName: "OperatorWhitelistUpdated";
206
+ args: {
207
+ operatorId: bigint;
208
+ whitelisted: `0x${string}`;
209
+ };
210
+ } | {
211
+ eventName: "OperatorWhitelistingContractUpdated";
212
+ args: {
213
+ operatorIds: readonly bigint[];
214
+ whitelistingContract: `0x${string}`;
215
+ };
216
+ } | {
217
+ eventName: "OperatorWithdrawn";
218
+ args: {
219
+ owner: `0x${string}`;
220
+ operatorId: bigint;
221
+ value: bigint;
222
+ };
223
+ } | {
224
+ eventName: "ValidatorAdded";
225
+ args: {
226
+ owner: `0x${string}`;
227
+ operatorIds: readonly bigint[];
228
+ publicKey: `0x${string}`;
229
+ shares: `0x${string}`;
230
+ cluster: {
231
+ validatorCount: number;
232
+ networkFeeIndex: bigint;
233
+ index: bigint;
234
+ active: boolean;
235
+ balance: bigint;
236
+ };
237
+ };
238
+ } | {
239
+ eventName: "ValidatorExited";
240
+ args: {
241
+ owner: `0x${string}`;
242
+ operatorIds: readonly bigint[];
243
+ publicKey: `0x${string}`;
244
+ };
245
+ } | {
246
+ eventName: "ValidatorRemoved";
247
+ args: {
248
+ owner: `0x${string}`;
249
+ operatorIds: readonly bigint[];
250
+ publicKey: `0x${string}`;
251
+ cluster: {
252
+ validatorCount: number;
253
+ networkFeeIndex: bigint;
254
+ index: bigint;
255
+ active: boolean;
256
+ balance: bigint;
257
+ };
258
+ };
259
+ } | {
260
+ eventName: "OwnershipTransferred";
261
+ args: {
262
+ previousOwner: `0x${string}`;
263
+ newOwner: `0x${string}`;
264
+ };
265
+ } | {
266
+ eventName: "Approval";
267
+ args: {
268
+ owner: `0x${string}`;
269
+ spender: `0x${string}`;
270
+ value: bigint;
271
+ };
272
+ } | {
273
+ eventName: "Transfer";
274
+ args: {
275
+ from: `0x${string}`;
276
+ to: `0x${string}`;
277
+ value: bigint;
278
+ };
279
+ })[];
280
+ }>;
281
+ }>;
282
+ export {};