@obolnetwork/obol-sdk 2.7.0 → 2.8.0

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 (50) hide show
  1. package/dist/cjs/package.json +4 -2
  2. package/dist/cjs/src/abi/OVMFactory.js +620 -0
  3. package/dist/cjs/src/ajv.js +33 -6
  4. package/dist/cjs/src/bytecodes.js +8 -1
  5. package/dist/cjs/src/constants.js +55 -7
  6. package/dist/cjs/src/index.js +21 -9
  7. package/dist/cjs/src/schema.js +71 -1
  8. package/dist/cjs/src/splits/splitHelpers.js +218 -12
  9. package/dist/cjs/src/splits/splits.js +261 -0
  10. package/dist/cjs/src/types.js +0 -1
  11. package/dist/cjs/test/client/ajv.spec.js +269 -0
  12. package/dist/cjs/test/client/methods.spec.js +418 -0
  13. package/dist/cjs/test/fixtures.js +13 -1
  14. package/dist/cjs/test/splits/splits.spec.js +239 -0
  15. package/dist/esm/package.json +4 -2
  16. package/dist/esm/src/abi/OVMFactory.js +617 -0
  17. package/dist/esm/src/ajv.js +33 -6
  18. package/dist/esm/src/bytecodes.js +7 -0
  19. package/dist/esm/src/constants.js +54 -7
  20. package/dist/esm/src/index.js +20 -9
  21. package/dist/esm/src/schema.js +71 -1
  22. package/dist/esm/src/splits/splitHelpers.js +213 -13
  23. package/dist/esm/src/splits/splits.js +257 -0
  24. package/dist/esm/src/types.js +0 -1
  25. package/dist/esm/test/client/ajv.spec.js +267 -0
  26. package/dist/esm/test/client/methods.spec.js +393 -0
  27. package/dist/esm/test/fixtures.js +12 -0
  28. package/dist/esm/test/splits/splits.spec.js +237 -0
  29. package/dist/types/src/abi/OVMFactory.d.ts +662 -0
  30. package/dist/types/src/bytecodes.d.ts +7 -0
  31. package/dist/types/src/constants.d.ts +10 -21
  32. package/dist/types/src/index.d.ts +7 -0
  33. package/dist/types/src/schema.d.ts +145 -0
  34. package/dist/types/src/splits/splitHelpers.d.ts +40 -1
  35. package/dist/types/src/splits/splits.d.ts +51 -0
  36. package/dist/types/src/types.d.ts +83 -2
  37. package/dist/types/test/client/ajv.spec.d.ts +1 -0
  38. package/dist/types/test/client/methods.spec.d.ts +1 -0
  39. package/dist/types/test/fixtures.d.ts +10 -0
  40. package/dist/types/test/splits/splits.spec.d.ts +1 -0
  41. package/package.json +4 -2
  42. package/src/abi/OVMFactory.ts +617 -0
  43. package/src/ajv.ts +55 -13
  44. package/src/bytecodes.ts +15 -0
  45. package/src/constants.ts +66 -8
  46. package/src/index.ts +36 -15
  47. package/src/schema.ts +80 -0
  48. package/src/splits/splitHelpers.ts +360 -14
  49. package/src/splits/splits.ts +355 -0
  50. package/src/types.ts +96 -3
@@ -0,0 +1,267 @@
1
+ import { validatePayload } from '../../src/ajv';
2
+ import { ovmRewardsSplitPayloadSchema, ovmTotalSplitPayloadSchema, } from '../../src/schema';
3
+ import { TEST_ADDRESSES } from '../fixtures';
4
+ describe('validatePayload - OVM Schemas', () => {
5
+ describe('ovmRewardsSplitPayloadSchema', () => {
6
+ const validRewardsSplitPayload = {
7
+ rewardSplitRecipients: [
8
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_1, percentAllocation: 50 },
9
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_2, percentAllocation: 49 },
10
+ ],
11
+ OVMOwnerAddress: TEST_ADDRESSES.OVM_OWNER,
12
+ splitOwnerAddress: TEST_ADDRESSES.SPLIT_OWNER,
13
+ principalRecipient: TEST_ADDRESSES.PRINCIPAL_RECIPIENT,
14
+ distributorFeePercent: 0,
15
+ };
16
+ it('should validate a valid rewards split payload', () => {
17
+ const result = validatePayload(validRewardsSplitPayload, ovmRewardsSplitPayloadSchema);
18
+ expect(result).toEqual(validRewardsSplitPayload);
19
+ });
20
+ it('should validate rewards split payload with default values', () => {
21
+ const payloadWithoutDefaults = {
22
+ rewardSplitRecipients: [
23
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_1, percentAllocation: 50 },
24
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_2, percentAllocation: 49 },
25
+ ],
26
+ OVMOwnerAddress: TEST_ADDRESSES.OVM_OWNER,
27
+ principalRecipient: TEST_ADDRESSES.PRINCIPAL_RECIPIENT,
28
+ };
29
+ const result = validatePayload(payloadWithoutDefaults, ovmRewardsSplitPayloadSchema);
30
+ expect(result).toEqual(Object.assign(Object.assign({}, payloadWithoutDefaults), { splitOwnerAddress: TEST_ADDRESSES.ZERO_ADDRESS, principalThreshold: 16, distributorFeePercent: 0 }));
31
+ });
32
+ it('should throw error when rewardSplitRecipients total percentage is not 99%', () => {
33
+ const invalidPayload = Object.assign(Object.assign({}, validRewardsSplitPayload), { rewardSplitRecipients: [
34
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_1, percentAllocation: 50 },
35
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_2, percentAllocation: 40 }, // Total: 90%
36
+ ] });
37
+ expect(() => validatePayload(invalidPayload, ovmRewardsSplitPayloadSchema)).toThrow('Validation failed: must pass "validateOVMRewardsSplitRecipients" keyword validation');
38
+ });
39
+ it('should throw error when rewardSplitRecipients total percentage exceeds 99%', () => {
40
+ const invalidPayload = Object.assign(Object.assign({}, validRewardsSplitPayload), { rewardSplitRecipients: [
41
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_1, percentAllocation: 60 },
42
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_2, percentAllocation: 50 }, // Total: 110%
43
+ ] });
44
+ expect(() => validatePayload(invalidPayload, ovmRewardsSplitPayloadSchema)).toThrow('Validation failed: must pass "validateOVMRewardsSplitRecipients" keyword validation');
45
+ });
46
+ it('should throw error when rewardSplitRecipients is empty', () => {
47
+ const invalidPayload = Object.assign(Object.assign({}, validRewardsSplitPayload), { rewardSplitRecipients: [] });
48
+ expect(() => validatePayload(invalidPayload, ovmRewardsSplitPayloadSchema)).toThrow('Validation failed: must pass "validateOVMRewardsSplitRecipients" keyword validation');
49
+ });
50
+ it('should throw error when rewardSplitRecipients has invalid address format', () => {
51
+ const invalidPayload = Object.assign(Object.assign({}, validRewardsSplitPayload), { rewardSplitRecipients: [
52
+ { address: 'invalid-address', percentAllocation: 50 },
53
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_2, percentAllocation: 49 },
54
+ ] });
55
+ expect(() => validatePayload(invalidPayload, ovmRewardsSplitPayloadSchema)).toThrow('Validation failed: /rewardSplitRecipients/0/address must match pattern');
56
+ });
57
+ it('should throw error when OVMOwnerAddress is missing', () => {
58
+ const invalidPayload = {
59
+ rewardSplitRecipients: validRewardsSplitPayload.rewardSplitRecipients,
60
+ principalRecipient: validRewardsSplitPayload.principalRecipient,
61
+ };
62
+ expect(() => validatePayload(invalidPayload, ovmRewardsSplitPayloadSchema)).toThrow("Validation failed: must have required property 'OVMOwnerAddress'");
63
+ });
64
+ it('should throw error when principalRecipient is missing', () => {
65
+ const invalidPayload = {
66
+ rewardSplitRecipients: validRewardsSplitPayload.rewardSplitRecipients,
67
+ OVMOwnerAddress: validRewardsSplitPayload.OVMOwnerAddress,
68
+ };
69
+ expect(() => validatePayload(invalidPayload, ovmRewardsSplitPayloadSchema)).toThrow("Validation failed: must have required property 'principalRecipient'");
70
+ });
71
+ });
72
+ describe('ovmTotalSplitPayloadSchema', () => {
73
+ const validTotalSplitPayload = {
74
+ rewardSplitRecipients: [
75
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_1, percentAllocation: 50 },
76
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_2, percentAllocation: 49 },
77
+ ],
78
+ principalSplitRecipients: [
79
+ {
80
+ address: TEST_ADDRESSES.PRINCIPAL_RECIPIENT_1,
81
+ percentAllocation: 60,
82
+ },
83
+ {
84
+ address: TEST_ADDRESSES.PRINCIPAL_RECIPIENT_2,
85
+ percentAllocation: 40,
86
+ },
87
+ ],
88
+ OVMOwnerAddress: TEST_ADDRESSES.OVM_OWNER,
89
+ splitOwnerAddress: TEST_ADDRESSES.SPLIT_OWNER,
90
+ distributorFeePercent: 0,
91
+ };
92
+ it('should validate a valid total split payload', () => {
93
+ const result = validatePayload(validTotalSplitPayload, ovmTotalSplitPayloadSchema);
94
+ expect(result).toEqual(validTotalSplitPayload);
95
+ });
96
+ it('should validate total split payload with default values', () => {
97
+ const payloadWithoutDefaults = {
98
+ rewardSplitRecipients: [
99
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_1, percentAllocation: 50 },
100
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_2, percentAllocation: 49 },
101
+ ],
102
+ principalSplitRecipients: [
103
+ {
104
+ address: TEST_ADDRESSES.PRINCIPAL_RECIPIENT_1,
105
+ percentAllocation: 60,
106
+ },
107
+ {
108
+ address: TEST_ADDRESSES.PRINCIPAL_RECIPIENT_2,
109
+ percentAllocation: 40,
110
+ },
111
+ ],
112
+ OVMOwnerAddress: TEST_ADDRESSES.OVM_OWNER,
113
+ };
114
+ const result = validatePayload(payloadWithoutDefaults, ovmTotalSplitPayloadSchema);
115
+ expect(result).toEqual(Object.assign(Object.assign({}, payloadWithoutDefaults), { splitOwnerAddress: TEST_ADDRESSES.ZERO_ADDRESS, principalThreshold: 16, distributorFeePercent: 0 }));
116
+ });
117
+ it('should throw error when rewardSplitRecipients total percentage is not 99%', () => {
118
+ const invalidPayload = Object.assign(Object.assign({}, validTotalSplitPayload), { rewardSplitRecipients: [
119
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_1, percentAllocation: 50 },
120
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_2, percentAllocation: 40 }, // Total: 90%
121
+ ] });
122
+ expect(() => validatePayload(invalidPayload, ovmTotalSplitPayloadSchema)).toThrow('Validation failed: must pass "validateOVMRewardsSplitRecipients" keyword validation');
123
+ });
124
+ it('should throw error when principalSplitRecipients total percentage is not 100%', () => {
125
+ const invalidPayload = Object.assign(Object.assign({}, validTotalSplitPayload), { principalSplitRecipients: [
126
+ {
127
+ address: TEST_ADDRESSES.PRINCIPAL_RECIPIENT_1,
128
+ percentAllocation: 60,
129
+ },
130
+ {
131
+ address: TEST_ADDRESSES.PRINCIPAL_RECIPIENT_2,
132
+ percentAllocation: 30,
133
+ }, // Total: 90%
134
+ ] });
135
+ expect(() => validatePayload(invalidPayload, ovmTotalSplitPayloadSchema)).toThrow('Validation failed: must pass "validateOVMTotalSplitRecipients" keyword validation');
136
+ });
137
+ it('should throw error when principalSplitRecipients total percentage exceeds 100%', () => {
138
+ const invalidPayload = Object.assign(Object.assign({}, validTotalSplitPayload), { principalSplitRecipients: [
139
+ {
140
+ address: TEST_ADDRESSES.PRINCIPAL_RECIPIENT_1,
141
+ percentAllocation: 70,
142
+ },
143
+ {
144
+ address: TEST_ADDRESSES.PRINCIPAL_RECIPIENT_2,
145
+ percentAllocation: 40,
146
+ }, // Total: 110%
147
+ ] });
148
+ expect(() => validatePayload(invalidPayload, ovmTotalSplitPayloadSchema)).toThrow('Validation failed: must pass "validateOVMTotalSplitRecipients" keyword validation');
149
+ });
150
+ it('should throw error when principalSplitRecipients is empty', () => {
151
+ const invalidPayload = Object.assign(Object.assign({}, validTotalSplitPayload), { principalSplitRecipients: [] });
152
+ expect(() => validatePayload(invalidPayload, ovmTotalSplitPayloadSchema)).toThrow('Validation failed: must pass "validateOVMTotalSplitRecipients" keyword validation');
153
+ });
154
+ it('should throw error when principalSplitRecipients has invalid address format', () => {
155
+ const invalidPayload = Object.assign(Object.assign({}, validTotalSplitPayload), { principalSplitRecipients: [
156
+ { address: 'invalid-address', percentAllocation: 60 },
157
+ {
158
+ address: TEST_ADDRESSES.PRINCIPAL_RECIPIENT_2,
159
+ percentAllocation: 40,
160
+ },
161
+ ] });
162
+ expect(() => validatePayload(invalidPayload, ovmTotalSplitPayloadSchema)).toThrow('Validation failed: /principalSplitRecipients/0/address must match pattern');
163
+ });
164
+ it('should throw error when OVMOwnerAddress is missing', () => {
165
+ const invalidPayload = {
166
+ rewardSplitRecipients: validTotalSplitPayload.rewardSplitRecipients,
167
+ principalSplitRecipients: validTotalSplitPayload.principalSplitRecipients,
168
+ };
169
+ expect(() => validatePayload(invalidPayload, ovmTotalSplitPayloadSchema)).toThrow("Validation failed: must have required property 'OVMOwnerAddress'");
170
+ });
171
+ it('should throw error when principalThreshold is less than 16', () => {
172
+ const invalidPayload = Object.assign(Object.assign({}, validTotalSplitPayload), { principalThreshold: 15 });
173
+ expect(() => validatePayload(invalidPayload, ovmTotalSplitPayloadSchema)).toThrow('Validation failed: /principalThreshold must be >= 16');
174
+ });
175
+ it('should validate when principalThreshold is exactly 16', () => {
176
+ const validPayload = Object.assign(Object.assign({}, validTotalSplitPayload), { principalThreshold: 16 });
177
+ const result = validatePayload(validPayload, ovmTotalSplitPayloadSchema);
178
+ expect(result).toEqual(validPayload);
179
+ });
180
+ it('should validate when principalThreshold is greater than 16', () => {
181
+ const validPayload = Object.assign(Object.assign({}, validTotalSplitPayload), { principalThreshold: 20 });
182
+ const result = validatePayload(validPayload, ovmTotalSplitPayloadSchema);
183
+ expect(result).toEqual(validPayload);
184
+ });
185
+ });
186
+ describe('Edge cases and boundary conditions', () => {
187
+ it('should handle decimal percentages correctly for rewards split', () => {
188
+ const payload = {
189
+ rewardSplitRecipients: [
190
+ {
191
+ address: TEST_ADDRESSES.REWARD_RECIPIENT_1,
192
+ percentAllocation: 49.5,
193
+ },
194
+ {
195
+ address: TEST_ADDRESSES.REWARD_RECIPIENT_2,
196
+ percentAllocation: 49.5,
197
+ },
198
+ ],
199
+ OVMOwnerAddress: TEST_ADDRESSES.OVM_OWNER,
200
+ principalRecipient: TEST_ADDRESSES.PRINCIPAL_RECIPIENT,
201
+ };
202
+ const result = validatePayload(payload, ovmRewardsSplitPayloadSchema);
203
+ expect(result).toEqual(Object.assign(Object.assign({}, payload), { splitOwnerAddress: TEST_ADDRESSES.ZERO_ADDRESS, principalThreshold: 16, distributorFeePercent: 0 }));
204
+ });
205
+ it('should handle decimal percentages correctly for total split', () => {
206
+ const payload = {
207
+ rewardSplitRecipients: [
208
+ {
209
+ address: TEST_ADDRESSES.REWARD_RECIPIENT_1,
210
+ percentAllocation: 49.5,
211
+ },
212
+ {
213
+ address: TEST_ADDRESSES.REWARD_RECIPIENT_2,
214
+ percentAllocation: 49.5,
215
+ },
216
+ ],
217
+ principalSplitRecipients: [
218
+ {
219
+ address: TEST_ADDRESSES.PRINCIPAL_RECIPIENT_1,
220
+ percentAllocation: 60.5,
221
+ },
222
+ {
223
+ address: TEST_ADDRESSES.PRINCIPAL_RECIPIENT_2,
224
+ percentAllocation: 39.5,
225
+ },
226
+ ],
227
+ OVMOwnerAddress: TEST_ADDRESSES.OVM_OWNER,
228
+ };
229
+ const result = validatePayload(payload, ovmTotalSplitPayloadSchema);
230
+ expect(result).toEqual(Object.assign(Object.assign({}, payload), { splitOwnerAddress: TEST_ADDRESSES.ZERO_ADDRESS, principalThreshold: 16, distributorFeePercent: 0 }));
231
+ });
232
+ it('should handle single recipient with 99% allocation for rewards split', () => {
233
+ const payload = {
234
+ rewardSplitRecipients: [
235
+ { address: TEST_ADDRESSES.REWARD_RECIPIENT_1, percentAllocation: 99 },
236
+ ],
237
+ OVMOwnerAddress: TEST_ADDRESSES.OVM_OWNER,
238
+ principalRecipient: TEST_ADDRESSES.PRINCIPAL_RECIPIENT,
239
+ };
240
+ const result = validatePayload(payload, ovmRewardsSplitPayloadSchema);
241
+ expect(result).toEqual(Object.assign(Object.assign({}, payload), { splitOwnerAddress: TEST_ADDRESSES.ZERO_ADDRESS, principalThreshold: 16, distributorFeePercent: 0 }));
242
+ });
243
+ it('should handle single recipient with 100% allocation for total split', () => {
244
+ const payload = {
245
+ rewardSplitRecipients: [
246
+ {
247
+ address: TEST_ADDRESSES.REWARD_RECIPIENT_1,
248
+ percentAllocation: 49.5,
249
+ },
250
+ {
251
+ address: TEST_ADDRESSES.REWARD_RECIPIENT_2,
252
+ percentAllocation: 49.5,
253
+ },
254
+ ],
255
+ principalSplitRecipients: [
256
+ {
257
+ address: TEST_ADDRESSES.PRINCIPAL_RECIPIENT_1,
258
+ percentAllocation: 100,
259
+ },
260
+ ],
261
+ OVMOwnerAddress: TEST_ADDRESSES.OVM_OWNER,
262
+ };
263
+ const result = validatePayload(payload, ovmTotalSplitPayloadSchema);
264
+ expect(result).toEqual(Object.assign(Object.assign({}, payload), { splitOwnerAddress: TEST_ADDRESSES.ZERO_ADDRESS, principalThreshold: 16, distributorFeePercent: 0 }));
265
+ });
266
+ });
267
+ });
@@ -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
+ });