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