@obolnetwork/obol-sdk 2.7.0 → 2.8.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 (56) hide show
  1. package/dist/cjs/package.json +1 -1
  2. package/dist/cjs/src/abi/OVMFactory.js +620 -0
  3. package/dist/cjs/src/abi/splitV2FactoryAbi.js +420 -0
  4. package/dist/cjs/src/ajv.js +33 -6
  5. package/dist/cjs/src/bytecodes.js +10 -1
  6. package/dist/cjs/src/constants.js +71 -15
  7. package/dist/cjs/src/index.js +21 -9
  8. package/dist/cjs/src/schema.js +70 -1
  9. package/dist/cjs/src/splits/splitHelpers.js +188 -14
  10. package/dist/cjs/src/splits/splits.js +283 -0
  11. package/dist/cjs/src/types.js +0 -1
  12. package/dist/cjs/test/client/ajv.spec.js +269 -0
  13. package/dist/cjs/test/client/methods.spec.js +418 -0
  14. package/dist/cjs/test/fixtures.js +13 -1
  15. package/dist/cjs/test/splits/splits.spec.js +239 -0
  16. package/dist/esm/package.json +1 -1
  17. package/dist/esm/src/abi/OVMFactory.js +617 -0
  18. package/dist/esm/src/abi/splitV2FactoryAbi.js +417 -0
  19. package/dist/esm/src/ajv.js +33 -6
  20. package/dist/esm/src/bytecodes.js +9 -0
  21. package/dist/esm/src/constants.js +70 -15
  22. package/dist/esm/src/index.js +20 -9
  23. package/dist/esm/src/schema.js +70 -1
  24. package/dist/esm/src/splits/splitHelpers.js +182 -13
  25. package/dist/esm/src/splits/splits.js +279 -0
  26. package/dist/esm/src/types.js +0 -1
  27. package/dist/esm/test/client/ajv.spec.js +267 -0
  28. package/dist/esm/test/client/methods.spec.js +393 -0
  29. package/dist/esm/test/fixtures.js +12 -0
  30. package/dist/esm/test/splits/splits.spec.js +237 -0
  31. package/dist/types/src/abi/OVMFactory.d.ts +662 -0
  32. package/dist/types/src/abi/splitV2FactoryAbi.d.ts +60 -0
  33. package/dist/types/src/bytecodes.d.ts +9 -0
  34. package/dist/types/src/constants.d.ts +10 -21
  35. package/dist/types/src/exits/verificationHelpers.d.ts +1 -0
  36. package/dist/types/src/index.d.ts +7 -0
  37. package/dist/types/src/schema.d.ts +145 -0
  38. package/dist/types/src/splits/splitHelpers.d.ts +39 -2
  39. package/dist/types/src/splits/splits.d.ts +51 -0
  40. package/dist/types/src/types.d.ts +87 -2
  41. package/dist/types/src/verification/common.d.ts +1 -0
  42. package/dist/types/test/client/ajv.spec.d.ts +1 -0
  43. package/dist/types/test/client/methods.spec.d.ts +1 -0
  44. package/dist/types/test/fixtures.d.ts +10 -0
  45. package/dist/types/test/splits/splits.spec.d.ts +1 -0
  46. package/package.json +1 -1
  47. package/src/abi/OVMFactory.ts +617 -0
  48. package/src/abi/splitV2FactoryAbi.ts +417 -0
  49. package/src/ajv.ts +55 -13
  50. package/src/bytecodes.ts +19 -0
  51. package/src/constants.ts +84 -16
  52. package/src/index.ts +36 -15
  53. package/src/schema.ts +79 -0
  54. package/src/splits/splitHelpers.ts +373 -18
  55. package/src/splits/splits.ts +406 -0
  56. package/src/types.ts +100 -3
@@ -0,0 +1,393 @@
1
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
+ return new (P || (P = Promise))(function (resolve, reject) {
4
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
8
+ });
9
+ };
10
+ var _a, _b;
11
+ import { ethers, JsonRpcProvider } from 'ethers';
12
+ import { Client, validateClusterLock } from '../../src/index';
13
+ import { clusterConfigV1X7, clusterConfigV1X10, clusterLockV1X10, clusterLockV1X6, clusterLockV1X7, clusterLockV1X8, clusterLockWithCompoundingWithdrawals, clusterLockWithSafe, nullDepositAmountsClusterLockV1X8, } from '../fixtures.js';
14
+ import { SDK_VERSION } from '../../src/constants';
15
+ import { Base } from '../../src/base';
16
+ import { HttpResponse, http } from 'msw';
17
+ import { setupServer } from 'msw/node';
18
+ import { hashTermsAndConditions } from '../../src/verification/termsAndConditions';
19
+ import * as utils from '../../src/utils';
20
+ import * as splitsHelpers from '../../src/splits/splitHelpers';
21
+ jest.setTimeout(20000);
22
+ const mnemonic = (_b = (_a = ethers.Wallet.createRandom().mnemonic) === null || _a === void 0 ? void 0 : _a.phrase) !== null && _b !== void 0 ? _b : '';
23
+ const privateKey = ethers.Wallet.fromPhrase(mnemonic).privateKey;
24
+ const provider = new JsonRpcProvider('https://ethereum-holesky.publicnode.com');
25
+ const wallet = new ethers.Wallet(privateKey, provider);
26
+ const mockSigner = wallet.connect(provider);
27
+ /* eslint no-new: 0 */
28
+ describe('Cluster Client', () => {
29
+ const mockConfigHash = '0x1f6c94e6c070393a68c1aa6073a21cb1fd57f0e14d2a475a2958990ab728c2fd';
30
+ const clientInstance = new Client({ baseUrl: 'https://obol-api-dev.gcp.obol.tech', chainId: 17000 }, mockSigner);
31
+ test('createTermsAndConditions should return "successful authorization"', () => __awaiter(void 0, void 0, void 0, function* () {
32
+ clientInstance['request'] = jest
33
+ .fn()
34
+ .mockReturnValue(Promise.resolve({ message: 'successful authorization' }));
35
+ const isAuthorized = yield clientInstance.acceptObolLatestTermsAndConditions();
36
+ expect(isAuthorized).toEqual('successful authorization');
37
+ }));
38
+ test('createClusterDefinition should return config_hash', () => __awaiter(void 0, void 0, void 0, function* () {
39
+ clientInstance['request'] = jest
40
+ .fn()
41
+ .mockReturnValue(Promise.resolve({ config_hash: mockConfigHash }));
42
+ const configHash = yield clientInstance.createClusterDefinition(clusterConfigV1X10);
43
+ expect(configHash).toEqual(mockConfigHash);
44
+ }));
45
+ test('acceptClusterDefinition should return cluster definition', () => __awaiter(void 0, void 0, void 0, function* () {
46
+ clientInstance['request'] = jest
47
+ .fn()
48
+ .mockReturnValue(Promise.resolve(clusterLockV1X10.cluster_definition));
49
+ const clusterDefinition = yield clientInstance.acceptClusterDefinition({
50
+ enr: clusterLockV1X10.cluster_definition.operators[0].enr,
51
+ version: clusterLockV1X10.cluster_definition.version,
52
+ }, clusterLockV1X10.cluster_definition.config_hash);
53
+ expect(clusterDefinition).toEqual(clusterLockV1X10.cluster_definition);
54
+ }));
55
+ test('createClusterDefinition should throw an error on invalid operators', () => __awaiter(void 0, void 0, void 0, function* () {
56
+ clientInstance['request'] = jest
57
+ .fn()
58
+ .mockReturnValue(Promise.resolve({ config_hash: mockConfigHash }));
59
+ try {
60
+ yield clientInstance.createClusterDefinition(Object.assign(Object.assign({}, clusterConfigV1X10), { operators: [] }));
61
+ }
62
+ catch (error) {
63
+ expect(error.message).toEqual('Validation failed: /operators must pass "validateUniqueAddresses" keyword validation, /operators must NOT have fewer than 4 items');
64
+ }
65
+ }));
66
+ // cause we default to null
67
+ test('createClusterDefinition should accept a configuration without deposit_amounts', () => __awaiter(void 0, void 0, void 0, function* () {
68
+ clientInstance['request'] = jest
69
+ .fn()
70
+ .mockReturnValue(Promise.resolve({ config_hash: mockConfigHash }));
71
+ const configHash = yield clientInstance.createClusterDefinition(Object.assign({}, clusterConfigV1X7));
72
+ expect(configHash).toEqual(mockConfigHash);
73
+ }));
74
+ test('createClusterDefinition should throw on not valid deposit_amounts ', () => __awaiter(void 0, void 0, void 0, function* () {
75
+ clientInstance['request'] = jest
76
+ .fn()
77
+ .mockReturnValue(Promise.resolve({ config_hash: mockConfigHash }));
78
+ try {
79
+ yield clientInstance.createClusterDefinition(Object.assign(Object.assign({}, clusterConfigV1X7), { deposit_amounts: ['34000000'] }));
80
+ }
81
+ catch (error) {
82
+ expect(error.message).toEqual('Validation failed: /deposit_amounts/0 must be equal to one of the allowed values, /deposit_amounts must match "then" schema');
83
+ }
84
+ }));
85
+ test('getClusterdefinition should return cluster definition if config hash exist', () => __awaiter(void 0, void 0, void 0, function* () {
86
+ clientInstance['request'] = jest
87
+ .fn()
88
+ .mockReturnValue(Promise.resolve(clusterLockV1X10.cluster_definition));
89
+ const clusterDefinition = yield clientInstance.getClusterDefinition(clusterLockV1X10.cluster_definition.config_hash);
90
+ expect(clusterDefinition.deposit_amounts).toBeDefined();
91
+ expect(clusterDefinition.config_hash).toEqual(clusterLockV1X10.cluster_definition.config_hash);
92
+ // Test for new fields
93
+ expect(clusterDefinition.compounding).toBeDefined();
94
+ expect(clusterDefinition.target_gas_limit).toBeDefined();
95
+ expect(clusterDefinition.consensus_protocol).toBeDefined();
96
+ }));
97
+ test('getClusterLock should return lockFile if exist', () => __awaiter(void 0, void 0, void 0, function* () {
98
+ clientInstance['request'] = jest
99
+ .fn()
100
+ .mockReturnValue(Promise.resolve(clusterLockV1X10));
101
+ const clusterLock = yield clientInstance.getClusterLock(clusterLockV1X10.cluster_definition.config_hash);
102
+ expect(clusterLock.lock_hash).toEqual(clusterLockV1X10.lock_hash);
103
+ }));
104
+ test('request method should set user agent header', () => __awaiter(void 0, void 0, void 0, function* () {
105
+ const server = setupServer(http.get('http://testexample.com/test', ({ request }) => {
106
+ // Check if the request contains specific headers
107
+ if (request.headers.get('User-Agent') === `Obol-SDK/${SDK_VERSION}`) {
108
+ return HttpResponse.json({ message: 'user-agent header exist' });
109
+ }
110
+ }));
111
+ server.listen();
112
+ class TestBase extends Base {
113
+ callProtectedRequest(endpoint, options) {
114
+ return __awaiter(this, void 0, void 0, function* () {
115
+ return yield this['request'](endpoint, options);
116
+ });
117
+ }
118
+ }
119
+ const testBaseInstance = new TestBase({
120
+ baseUrl: 'http://testExample.com',
121
+ });
122
+ const result = yield testBaseInstance.callProtectedRequest('/test', {
123
+ method: 'GET',
124
+ });
125
+ expect(result === null || result === void 0 ? void 0 : result.message).toEqual('user-agent header exist');
126
+ server.close();
127
+ }));
128
+ });
129
+ describe('Cluster Client without a signer', () => {
130
+ const clientInstance = new Client({
131
+ baseUrl: 'https://obol-api-dev.gcp.obol.tech',
132
+ chainId: 17000,
133
+ });
134
+ beforeAll(() => {
135
+ jest.restoreAllMocks();
136
+ });
137
+ beforeEach(() => {
138
+ jest.resetModules();
139
+ });
140
+ test('createClusterDefinition should throw an error without signer', () => __awaiter(void 0, void 0, void 0, function* () {
141
+ try {
142
+ yield clientInstance.createClusterDefinition(clusterConfigV1X10);
143
+ }
144
+ catch (err) {
145
+ expect(err.message).toEqual('Signer is required in createClusterDefinition');
146
+ }
147
+ }));
148
+ test('acceptClusterDefinition should throw an error without signer', () => __awaiter(void 0, void 0, void 0, function* () {
149
+ try {
150
+ yield clientInstance.acceptClusterDefinition({
151
+ enr: clusterLockV1X10.cluster_definition.operators[0].enr,
152
+ version: clusterLockV1X10.cluster_definition.version,
153
+ }, clusterLockV1X10.cluster_definition.config_hash);
154
+ }
155
+ catch (err) {
156
+ expect(err.message).toEqual('Signer is required in acceptClusterDefinition');
157
+ }
158
+ }));
159
+ test('getClusterdefinition should return cluster definition if config hash exist', () => __awaiter(void 0, void 0, void 0, function* () {
160
+ clientInstance['request'] = jest
161
+ .fn()
162
+ .mockReturnValue(Promise.resolve(clusterLockV1X10.cluster_definition));
163
+ const clusterDefinition = yield clientInstance.getClusterDefinition(clusterLockV1X10.cluster_definition.config_hash);
164
+ expect(clusterDefinition.config_hash).toEqual(clusterLockV1X10.cluster_definition.config_hash);
165
+ }));
166
+ test('getClusterLock should return lockFile if exist', () => __awaiter(void 0, void 0, void 0, function* () {
167
+ clientInstance['request'] = jest
168
+ .fn()
169
+ .mockReturnValue(Promise.resolve(clusterLockV1X10));
170
+ const clusterLock = yield clientInstance.getClusterLock(clusterLockV1X10.cluster_definition.config_hash);
171
+ expect(clusterLock.lock_hash).toEqual(clusterLockV1X10.lock_hash);
172
+ }));
173
+ test.each([
174
+ { version: 'v1.6.0', clusterLock: clusterLockV1X6 },
175
+ { version: 'v1.7.0', clusterLock: clusterLockV1X7 },
176
+ { version: 'v1.8.0', clusterLock: clusterLockV1X8 },
177
+ {
178
+ version: 'null deposit_amounts v1.8.0',
179
+ clusterLock: nullDepositAmountsClusterLockV1X8,
180
+ },
181
+ {
182
+ version: 'Cluster with safe address v1.8.0',
183
+ clusterLock: clusterLockWithSafe,
184
+ },
185
+ { version: 'v1.10.0', clusterLock: clusterLockV1X10 },
186
+ {
187
+ version: 'v1.10.0 with compunding withdrawals',
188
+ clusterLock: clusterLockWithCompoundingWithdrawals,
189
+ },
190
+ ])("$version: 'should return true on verified cluster lock'", ({ clusterLock }) => __awaiter(void 0, void 0, void 0, function* () {
191
+ const isValidLock = yield validateClusterLock(clusterLock);
192
+ expect(isValidLock).toEqual(true);
193
+ }));
194
+ test('should return true on verified cluster lock with Safe wallet and safe rpc url', () => __awaiter(void 0, void 0, void 0, function* () {
195
+ process.env.RPC_HOLESKY = undefined;
196
+ /* eslint-disable @typescript-eslint/no-var-requires */
197
+ const { validateClusterLock: validateLockWithRpcUrl, } = require('../../src/index');
198
+ const safeRpcUrl = 'https://ethereum-holesky-rpc.publicnode.com';
199
+ const isValidLock = yield validateLockWithRpcUrl(clusterLockWithSafe, safeRpcUrl);
200
+ expect(isValidLock).toEqual(true);
201
+ }));
202
+ test('validateCluster should return false for cluster with null deposit_amounts and incorrect partial_deposits', () => __awaiter(void 0, void 0, void 0, function* () {
203
+ const partialDeposit = nullDepositAmountsClusterLockV1X8.distributed_validators[0]
204
+ .partial_deposit_data[0];
205
+ const isValidLock = yield validateClusterLock(Object.assign(Object.assign({}, nullDepositAmountsClusterLockV1X8), { distributed_validators: [
206
+ Object.assign(Object.assign({}, nullDepositAmountsClusterLockV1X8.distributed_validators[0]), { partial_deposit_data: [partialDeposit, partialDeposit] }),
207
+ ] }));
208
+ expect(isValidLock).toEqual(false);
209
+ }));
210
+ test('Finds the hash of the latest version of terms and conditions', () => __awaiter(void 0, void 0, void 0, function* () {
211
+ const termsAndConditionsHash = yield hashTermsAndConditions();
212
+ expect(termsAndConditionsHash).toEqual('0xd33721644e8f3afab1495a74abe3523cec12d48b8da6cb760972492ca3f1a273');
213
+ }));
214
+ });
215
+ describe('createObolRewardsSplit', () => {
216
+ let clientInstance, clientInstanceWithourSigner, mockSplitRecipients, mockPrincipalRecipient, mockEtherAmount;
217
+ beforeAll(() => {
218
+ jest
219
+ .spyOn(utils, 'isContractAvailable')
220
+ .mockImplementation(() => __awaiter(void 0, void 0, void 0, function* () { return yield Promise.resolve(true); }));
221
+ jest
222
+ .spyOn(splitsHelpers, 'predictSplitterAddress')
223
+ .mockImplementation(() => __awaiter(void 0, void 0, void 0, function* () { return yield Promise.resolve('0xPredictedAddress'); }));
224
+ jest.spyOn(splitsHelpers, 'handleDeployOWRAndSplitter').mockImplementation(() => __awaiter(void 0, void 0, void 0, function* () {
225
+ return yield Promise.resolve({
226
+ withdrawal_address: '0xWithdrawalAddress',
227
+ fee_recipient_address: '0xFeeRecipientAddress',
228
+ });
229
+ }));
230
+ clientInstance = new Client({ baseUrl: 'https://obol-api-dev.gcp.obol.tech', chainId: 17000 }, mockSigner);
231
+ clientInstanceWithourSigner = new Client({
232
+ baseUrl: 'https://obol-api-dev.gcp.obol.tech',
233
+ chainId: 17000,
234
+ });
235
+ mockSplitRecipients = [
236
+ {
237
+ account: '0x86B8145c98e5BD25BA722645b15eD65f024a87EC',
238
+ percentAllocation: 99,
239
+ },
240
+ ];
241
+ mockPrincipalRecipient = '0x86B8145c98e5BD25BA722645b15eD65f024a87EC';
242
+ mockEtherAmount = 64;
243
+ });
244
+ it('should throw an error if signer is not defined', () => __awaiter(void 0, void 0, void 0, function* () {
245
+ yield expect(clientInstanceWithourSigner.createObolRewardsSplit({
246
+ splitRecipients: mockSplitRecipients,
247
+ principalRecipient: mockPrincipalRecipient,
248
+ etherAmount: mockEtherAmount,
249
+ })).rejects.toThrow('Signer is required in createObolRewardsSplit');
250
+ }));
251
+ it('should throw an error if chainId is not supported', () => __awaiter(void 0, void 0, void 0, function* () {
252
+ const unsupportedSplitterChainClient = new Client({ baseUrl: 'https://obol-api-dev.gcp.obol.tech', chainId: 100 }, mockSigner);
253
+ try {
254
+ yield unsupportedSplitterChainClient.createObolRewardsSplit({
255
+ splitRecipients: mockSplitRecipients,
256
+ principalRecipient: mockPrincipalRecipient,
257
+ etherAmount: mockEtherAmount,
258
+ });
259
+ }
260
+ catch (error) {
261
+ expect(error.message).toEqual('Splitter configuration is not supported on 100 chain');
262
+ }
263
+ }));
264
+ test('should throw an error on invalid recipients', () => __awaiter(void 0, void 0, void 0, function* () {
265
+ try {
266
+ yield clientInstance.createObolRewardsSplit({
267
+ splitRecipients: [
268
+ {
269
+ account: '0x86B8145c98e5BD25BA722645b15eD65f024a87EC',
270
+ percentAllocation: 22,
271
+ },
272
+ ],
273
+ principalRecipient: mockPrincipalRecipient,
274
+ etherAmount: mockEtherAmount,
275
+ });
276
+ }
277
+ catch (error) {
278
+ expect(error.message).toEqual('Validation failed: must pass "validateRewardsSplitRecipients" keyword validation');
279
+ }
280
+ }));
281
+ test('should throw an error if ObolRAFSplit is less than 1', () => __awaiter(void 0, void 0, void 0, function* () {
282
+ try {
283
+ yield clientInstance.createObolRewardsSplit({
284
+ splitRecipients: mockSplitRecipients,
285
+ principalRecipient: mockPrincipalRecipient,
286
+ etherAmount: mockEtherAmount,
287
+ ObolRAFSplit: 0.5,
288
+ });
289
+ }
290
+ catch (error) {
291
+ expect(error.message).toEqual('Validation failed: must pass "validateRewardsSplitRecipients" keyword validation, /ObolRAFSplit must be >= 1');
292
+ }
293
+ }));
294
+ it('should return the correct withdrawal and fee recipient addresses', () => __awaiter(void 0, void 0, void 0, function* () {
295
+ const result = yield clientInstance.createObolRewardsSplit({
296
+ splitRecipients: mockSplitRecipients,
297
+ principalRecipient: mockPrincipalRecipient,
298
+ etherAmount: mockEtherAmount,
299
+ });
300
+ expect(result).toEqual({
301
+ withdrawal_address: '0xWithdrawalAddress',
302
+ fee_recipient_address: '0xFeeRecipientAddress',
303
+ });
304
+ }));
305
+ });
306
+ describe('createObolTotalSplit', () => {
307
+ let clientInstanceWithourSigner, mockSplitRecipients, clientInstance;
308
+ beforeAll(() => {
309
+ jest
310
+ .spyOn(utils, 'isContractAvailable')
311
+ .mockImplementation(() => __awaiter(void 0, void 0, void 0, function* () { return yield Promise.resolve(true); }));
312
+ jest
313
+ .spyOn(splitsHelpers, 'predictSplitterAddress')
314
+ .mockImplementation(() => __awaiter(void 0, void 0, void 0, function* () { return yield Promise.resolve('0xPredictedAddress'); }));
315
+ jest
316
+ .spyOn(splitsHelpers, 'deploySplitterContract')
317
+ .mockImplementation(() => __awaiter(void 0, void 0, void 0, function* () { return yield Promise.resolve('0xSplitterAddress'); }));
318
+ clientInstance = new Client({ baseUrl: 'https://obol-api-dev.gcp.obol.tech', chainId: 17000 }, mockSigner);
319
+ clientInstanceWithourSigner = new Client({
320
+ baseUrl: 'https://obol-api-dev.gcp.obol.tech',
321
+ chainId: 17000,
322
+ });
323
+ mockSplitRecipients = [
324
+ {
325
+ account: '0x86B8145c98e5BD25BA722645b15eD65f024a87EC',
326
+ percentAllocation: 99.9,
327
+ },
328
+ ];
329
+ });
330
+ it('should throw an error if signer is not defined', () => __awaiter(void 0, void 0, void 0, function* () {
331
+ yield expect(clientInstanceWithourSigner.createObolTotalSplit({
332
+ splitRecipients: mockSplitRecipients,
333
+ })).rejects.toThrow('Signer is required in createObolTotalSplit');
334
+ }));
335
+ it('should throw an error if chainId is not supported', () => __awaiter(void 0, void 0, void 0, function* () {
336
+ const unsupportedSplitterChainClient = new Client({ baseUrl: 'https://obol-api-dev.gcp.obol.tech', chainId: 100 }, mockSigner);
337
+ try {
338
+ yield unsupportedSplitterChainClient.createObolTotalSplit({
339
+ splitRecipients: mockSplitRecipients,
340
+ });
341
+ }
342
+ catch (error) {
343
+ expect(error.message).toEqual('Splitter configuration is not supported on 100 chain');
344
+ }
345
+ }));
346
+ test('should throw an error on invalid recipients', () => __awaiter(void 0, void 0, void 0, function* () {
347
+ try {
348
+ yield clientInstance.createObolTotalSplit({
349
+ splitRecipients: [
350
+ {
351
+ account: '0x86B8145c98e5BD25BA722645b15eD65f024a87EC',
352
+ percentAllocation: 22,
353
+ },
354
+ ],
355
+ });
356
+ }
357
+ catch (error) {
358
+ expect(error.message).toEqual('Validation failed: must pass "validateTotalSplitRecipients" keyword validation');
359
+ }
360
+ }));
361
+ test('should throw an error if ObolRAFSplit is less than 0.1', () => __awaiter(void 0, void 0, void 0, function* () {
362
+ try {
363
+ yield clientInstance.createObolTotalSplit({
364
+ splitRecipients: mockSplitRecipients,
365
+ ObolRAFSplit: 0.05,
366
+ });
367
+ }
368
+ catch (error) {
369
+ expect(error.message).toEqual('Validation failed: must pass "validateTotalSplitRecipients" keyword validation, /ObolRAFSplit must be >= 0.1');
370
+ }
371
+ }));
372
+ it('should return the correct withdrawal and fee recipient addresses and ObolRAFSplit', () => __awaiter(void 0, void 0, void 0, function* () {
373
+ const result = yield clientInstance.createObolTotalSplit({
374
+ splitRecipients: mockSplitRecipients,
375
+ ObolRAFSplit: 0.1,
376
+ });
377
+ // 0xPredictedAddress and not 0xSplitterAddress since were mocking isContractAvailable response to be true
378
+ expect(result).toEqual({
379
+ withdrawal_address: '0xPredictedAddress',
380
+ fee_recipient_address: '0xPredictedAddress',
381
+ });
382
+ }));
383
+ it('should return the correct withdrawal and fee recipient addresses without passing ObolRAFSplit', () => __awaiter(void 0, void 0, void 0, function* () {
384
+ const result = yield clientInstance.createObolTotalSplit({
385
+ splitRecipients: mockSplitRecipients,
386
+ });
387
+ // 0xPredictedAddress and not 0xSplitterAddress since were mocking isContractAvailable response to be true
388
+ expect(result).toEqual({
389
+ withdrawal_address: '0xPredictedAddress',
390
+ fee_recipient_address: '0xPredictedAddress',
391
+ });
392
+ }));
393
+ });
@@ -1,3 +1,15 @@
1
+ import { ZeroAddress } from 'ethers';
2
+ // Test address constants for OVM splits
3
+ export const TEST_ADDRESSES = {
4
+ REWARD_RECIPIENT_1: '0x1234567890123456789012345678901234567890',
5
+ REWARD_RECIPIENT_2: '0x2345678901234567890123456789012345678901',
6
+ PRINCIPAL_RECIPIENT_1: '0x3456789012345678901234567890123456789012',
7
+ PRINCIPAL_RECIPIENT_2: '0x4567890123456789012345678901234567890123',
8
+ OVM_OWNER: '0x5678901234567890123456789012345678901234',
9
+ SPLIT_OWNER: '0x6789012345678901234567890123456789012345',
10
+ PRINCIPAL_RECIPIENT: '0x7890123456789012345678901234567890123456',
11
+ ZERO_ADDRESS: ZeroAddress,
12
+ };
1
13
  export const enr = 'enr:-HW4QLlrtMjFLGkFT1bwdGbvZQlH8hLi0M2g44JAxEYP3BZmYpcsy9Q56HPPD87fMucjvLv4-obEFacpsg0ehRilbHeAgmlkgnY0iXNlY3AyNTZrMaEDRaa5o2aSgqyFq_ERZcQTztrOij1mFtXX1bJuVI6ieak';
2
14
  // v1.6.0
3
15
  export const clusterLockV1X6 = {
@@ -0,0 +1,237 @@
1
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
+ return new (P || (P = Promise))(function (resolve, reject) {
4
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
8
+ });
9
+ };
10
+ import { Client } from '../../src';
11
+ import { CHAIN_CONFIGURATION } from '../../src/constants';
12
+ import { formatRecipientsForSplitV2, predictSplitV2Address, isSplitV2Deployed, deployOVMAndSplitV2, deployOVMContract, } from '../../src/splits/splitHelpers';
13
+ import { isContractAvailable } from '../../src/utils';
14
+ import { TEST_ADDRESSES } from '../fixtures';
15
+ // Mock the split helpers
16
+ jest.mock('../../src/splits/splitHelpers', () => ({
17
+ formatRecipientsForSplitV2: jest.fn(),
18
+ predictSplitV2Address: jest.fn(),
19
+ isSplitV2Deployed: jest.fn(),
20
+ deployOVMContract: jest.fn(),
21
+ deployOVMAndSplitV2: jest.fn(),
22
+ }));
23
+ // Mock the utils
24
+ jest.mock('../../src/utils', () => ({
25
+ isContractAvailable: jest.fn(),
26
+ }));
27
+ // Mock the validation
28
+ jest.mock('../../src/ajv', () => ({
29
+ validatePayload: jest.fn(data => data),
30
+ }));
31
+ // Type the mocked functions
32
+ const mockFormatRecipientsForSplitV2 = formatRecipientsForSplitV2;
33
+ const mockPredictSplitV2Address = predictSplitV2Address;
34
+ const mockIsSplitV2Deployed = isSplitV2Deployed;
35
+ const mockDeployOVMAndSplitV2 = deployOVMAndSplitV2;
36
+ const mockDeployOVMContract = deployOVMContract;
37
+ const mockIsContractAvailable = isContractAvailable;
38
+ describe('ObolSplits', () => {
39
+ let client;
40
+ let mockSigner;
41
+ let mockProvider;
42
+ beforeEach(() => {
43
+ // Clear all mocks before each test
44
+ jest.clearAllMocks();
45
+ mockSigner = {
46
+ getAddress: jest
47
+ .fn()
48
+ .mockResolvedValue('0x1234567890123456789012345678901234567890'),
49
+ signTypedData: jest.fn().mockResolvedValue('0xsigned'),
50
+ provider: {
51
+ getCode: jest.fn().mockResolvedValue('0x123456'),
52
+ },
53
+ };
54
+ mockProvider = {
55
+ getCode: jest.fn().mockResolvedValue('0x123456'),
56
+ };
57
+ client = new Client({ chainId: 1 }, mockSigner, mockProvider);
58
+ });
59
+ describe('createValidatorManagerAndRewardsSplit', () => {
60
+ const mockRewardsSplitPayload = {
61
+ rewardSplitRecipients: [
62
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_1, percentAllocation: 50 },
63
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_2, percentAllocation: 49 },
64
+ ],
65
+ OVMOwnerAddress: TEST_ADDRESSES.OVM_OWNER,
66
+ splitOwnerAddress: TEST_ADDRESSES.SPLIT_OWNER,
67
+ principalRecipient: TEST_ADDRESSES.PRINCIPAL_RECIPIENT,
68
+ distributorFeePercent: 0,
69
+ };
70
+ it('should create rewards-only split successfully', () => __awaiter(void 0, void 0, void 0, function* () {
71
+ // Mock helper functions
72
+ mockFormatRecipientsForSplitV2.mockReturnValue([
73
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_1, percentAllocation: 50 },
74
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_2, percentAllocation: 49 },
75
+ {
76
+ address: '0xDe5aE4De36c966747Ea7DF13BD9589642e2B1D0d',
77
+ percentAllocation: 1,
78
+ },
79
+ ]);
80
+ mockPredictSplitV2Address.mockResolvedValue('0xRewardsSplitAddress');
81
+ mockIsSplitV2Deployed.mockResolvedValue(false);
82
+ mockDeployOVMAndSplitV2.mockResolvedValue('0xOVMAddress');
83
+ mockIsContractAvailable.mockResolvedValue(true);
84
+ const result = yield client.splits.createValidatorManagerAndRewardsSplit(mockRewardsSplitPayload);
85
+ expect(result).toEqual({
86
+ withdrawal_address: '0xOVMAddress',
87
+ fee_recipient_address: '0xRewardsSplitAddress',
88
+ });
89
+ expect(mockFormatRecipientsForSplitV2).toHaveBeenCalled();
90
+ expect(mockPredictSplitV2Address).toHaveBeenCalled();
91
+ expect(mockIsSplitV2Deployed).toHaveBeenCalled();
92
+ expect(mockDeployOVMAndSplitV2).toHaveBeenCalled();
93
+ }));
94
+ it('should throw error when signer is not provided', () => __awaiter(void 0, void 0, void 0, function* () {
95
+ const clientWithoutSigner = new Client({ chainId: 1 }, undefined, mockProvider);
96
+ yield expect(clientWithoutSigner.splits.createValidatorManagerAndRewardsSplit(mockRewardsSplitPayload)).rejects.toThrow('Signer is required in createValidatorManagerAndRewardsSplit');
97
+ }));
98
+ it('should throw error when chain is not supported', () => __awaiter(void 0, void 0, void 0, function* () {
99
+ const clientUnsupportedChain = new Client({ chainId: 999 }, mockSigner, mockProvider);
100
+ yield expect(clientUnsupportedChain.splits.createValidatorManagerAndRewardsSplit(mockRewardsSplitPayload)).rejects.toThrow('Splitter configuration is not supported on 999 chain');
101
+ }));
102
+ it('should throw error when OVM factory is not configured', () => __awaiter(void 0, void 0, void 0, function* () {
103
+ // Mock chain configuration without OVM factory
104
+ const originalConfig = CHAIN_CONFIGURATION[1];
105
+ // Create a new config object without OVM_FACTORY_CONTRACT
106
+ const configWithoutOVM = Object.assign({}, originalConfig);
107
+ delete configWithoutOVM.OVM_FACTORY_CONTRACT;
108
+ CHAIN_CONFIGURATION[1] = configWithoutOVM;
109
+ yield expect(client.splits.createValidatorManagerAndRewardsSplit(mockRewardsSplitPayload)).rejects.toThrow('OVM contract factory is not configured for chain 1');
110
+ // Restore original config
111
+ CHAIN_CONFIGURATION[1] = originalConfig;
112
+ }));
113
+ });
114
+ describe('createValidatorManagerAndTotalSplit', () => {
115
+ const mockTotalSplitPayload = {
116
+ rewardSplitRecipients: [
117
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_1, percentAllocation: 50 },
118
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_2, percentAllocation: 49 },
119
+ ],
120
+ principalSplitRecipients: [
121
+ {
122
+ address: TEST_ADDRESSES.PRINCIPAL_RECIPIENT_1,
123
+ percentAllocation: 60,
124
+ },
125
+ {
126
+ address: TEST_ADDRESSES.PRINCIPAL_RECIPIENT_2,
127
+ percentAllocation: 40,
128
+ },
129
+ ],
130
+ OVMOwnerAddress: TEST_ADDRESSES.OVM_OWNER,
131
+ splitOwnerAddress: TEST_ADDRESSES.SPLIT_OWNER,
132
+ distributorFeePercent: 0,
133
+ };
134
+ it('should create total split successfully', () => __awaiter(void 0, void 0, void 0, function* () {
135
+ // Mock helper functions
136
+ mockFormatRecipientsForSplitV2
137
+ .mockReturnValueOnce([
138
+ // rewards recipients
139
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_1, percentAllocation: 50 },
140
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_2, percentAllocation: 49 },
141
+ {
142
+ address: '0xDe5aE4De36c966747Ea7DF13BD9589642e2B1D0d',
143
+ percentAllocation: 1,
144
+ },
145
+ ])
146
+ .mockReturnValueOnce([
147
+ // principal recipients
148
+ {
149
+ address: TEST_ADDRESSES.PRINCIPAL_RECIPIENT_1,
150
+ percentAllocation: 60,
151
+ },
152
+ {
153
+ address: TEST_ADDRESSES.PRINCIPAL_RECIPIENT_2,
154
+ percentAllocation: 40,
155
+ },
156
+ ]);
157
+ mockPredictSplitV2Address
158
+ .mockResolvedValueOnce('0xRewardsSplitAddress')
159
+ .mockResolvedValueOnce('0xPrincipalSplitAddress');
160
+ mockIsSplitV2Deployed
161
+ .mockResolvedValueOnce(false) // rewards split not deployed
162
+ .mockResolvedValueOnce(false); // principal split not deployed
163
+ mockDeployOVMAndSplitV2.mockResolvedValue('0xOVMAddress');
164
+ mockIsContractAvailable.mockResolvedValue(true);
165
+ const result = yield client.splits.createValidatorManagerAndTotalSplit(mockTotalSplitPayload);
166
+ expect(result).toEqual({
167
+ withdrawal_address: '0xOVMAddress',
168
+ fee_recipient_address: '0xRewardsSplitAddress',
169
+ });
170
+ expect(mockFormatRecipientsForSplitV2).toHaveBeenCalledTimes(2);
171
+ expect(mockPredictSplitV2Address).toHaveBeenCalledTimes(2);
172
+ expect(mockIsSplitV2Deployed).toHaveBeenCalledTimes(2);
173
+ expect(mockDeployOVMAndSplitV2).toHaveBeenCalled();
174
+ }));
175
+ it('should handle case when both splits are already deployed', () => __awaiter(void 0, void 0, void 0, function* () {
176
+ // Mock helper functions
177
+ mockFormatRecipientsForSplitV2
178
+ .mockReturnValueOnce([
179
+ // rewards recipients
180
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_1, percentAllocation: 50 },
181
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_2, percentAllocation: 49 },
182
+ {
183
+ address: '0xDe5aE4De36c966747Ea7DF13BD9589642e2B1D0d',
184
+ percentAllocation: 1,
185
+ },
186
+ ])
187
+ .mockReturnValueOnce([
188
+ // principal recipients
189
+ {
190
+ address: TEST_ADDRESSES.PRINCIPAL_RECIPIENT_1,
191
+ percentAllocation: 60,
192
+ },
193
+ {
194
+ address: TEST_ADDRESSES.PRINCIPAL_RECIPIENT_2,
195
+ percentAllocation: 40,
196
+ },
197
+ ]);
198
+ mockPredictSplitV2Address
199
+ .mockResolvedValueOnce('0xRewardsSplitAddress')
200
+ .mockResolvedValueOnce('0xPrincipalSplitAddress');
201
+ mockIsSplitV2Deployed
202
+ .mockResolvedValueOnce(true) // rewards split deployed
203
+ .mockResolvedValueOnce(true); // principal split deployed
204
+ mockDeployOVMContract.mockResolvedValue('0xOVMAddress');
205
+ mockIsContractAvailable.mockResolvedValue(true);
206
+ const result = yield client.splits.createValidatorManagerAndTotalSplit(mockTotalSplitPayload);
207
+ expect(result).toEqual({
208
+ withdrawal_address: '0xOVMAddress',
209
+ fee_recipient_address: '0xRewardsSplitAddress',
210
+ });
211
+ expect(mockDeployOVMContract).toHaveBeenCalledWith({
212
+ OVMOwnerAddress: mockTotalSplitPayload.OVMOwnerAddress,
213
+ principalRecipient: '0xPrincipalSplitAddress',
214
+ rewardRecipient: '0xRewardsSplitAddress',
215
+ principalThreshold: mockTotalSplitPayload.principalThreshold,
216
+ signer: mockSigner,
217
+ chainId: 1,
218
+ });
219
+ }));
220
+ it('should throw error when signer is not provided', () => __awaiter(void 0, void 0, void 0, function* () {
221
+ const clientWithoutSigner = new Client({ chainId: 1 }, undefined, mockProvider);
222
+ yield expect(clientWithoutSigner.splits.createValidatorManagerAndTotalSplit(mockTotalSplitPayload)).rejects.toThrow('Signer is required in createValidatorManagerAndTotalSplit');
223
+ }));
224
+ it('should throw error when chain is not supported', () => __awaiter(void 0, void 0, void 0, function* () {
225
+ const clientUnsupportedChain = new Client({ chainId: 999 }, mockSigner, mockProvider);
226
+ yield expect(clientUnsupportedChain.splits.createValidatorManagerAndTotalSplit(mockTotalSplitPayload)).rejects.toThrow('Splitter configuration is not supported on 999 chain');
227
+ }));
228
+ });
229
+ describe('constructor', () => {
230
+ it('should create Client instance with splits property', () => {
231
+ const testClient = new Client({ chainId: 1 }, mockSigner, mockProvider);
232
+ expect(testClient.splits).toBeDefined();
233
+ expect(testClient.splits.chainId).toBe(1);
234
+ expect(testClient.splits.provider).toBe(mockProvider);
235
+ });
236
+ });
237
+ });