@obolnetwork/obol-sdk 2.2.3 → 2.3.0

package/dist/cjs/test/methods.test.js

@@ -31,6 +31,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var _a, _b;
 Object.defineProperty(exports, "__esModule", { value: true });
 const ethers_1 = require("ethers");
 const index_1 = require("../src/index");
@@ -44,15 +45,14 @@ const termsAndConditions_1 = require("../src/verification/termsAndConditions");
 const utils = __importStar(require("../src/utils"));
 const splitsHelpers = __importStar(require("../src/splitHelpers"));
 jest.setTimeout(20000);
+const mnemonic = (_b = (_a = ethers_1.ethers.Wallet.createRandom().mnemonic) === null || _a === void 0 ? void 0 : _a.phrase) !== null && _b !== void 0 ? _b : '';
+const privateKey = ethers_1.ethers.Wallet.fromPhrase(mnemonic).privateKey;
+const provider = new ethers_1.JsonRpcProvider('https://ethereum-holesky.publicnode.com');
+const wallet = new ethers_1.ethers.Wallet(privateKey, provider);
+const mockSigner = wallet.connect(provider);
 /* eslint no-new: 0 */
 describe('Cluster Client', () => {
-    var _a, _b;
     const mockConfigHash = '0x1f6c94e6c070393a68c1aa6073a21cb1fd57f0e14d2a475a2958990ab728c2fd';
-    const mnemonic = (_b = (_a = ethers_1.ethers.Wallet.createRandom().mnemonic) === null || _a === void 0 ? void 0 : _a.phrase) !== null && _b !== void 0 ? _b : '';
-    const privateKey = ethers_1.ethers.Wallet.fromPhrase(mnemonic).privateKey;
-    const provider = new ethers_1.JsonRpcProvider('https://ethereum-holesky.publicnode.com');
-    const wallet = new ethers_1.ethers.Wallet(privateKey, provider);
-    const mockSigner = wallet.connect(provider);
     const clientInstance = new index_1.Client({ baseUrl: 'https://obol-api-dev.gcp.obol.tech', chainId: 17000 }, mockSigner);
     test('createTermsAndConditions should return "successful authorization"', () => __awaiter(void 0, void 0, void 0, function* () {
         clientInstance['request'] = jest
@@ -117,12 +117,12 @@ describe('Cluster Client', () => {
         }
     }));
     test('getClusterdefinition should return cluster definition if config hash exist', () => __awaiter(void 0, void 0, void 0, function* () {
-        var _c;
+        var _a;
         clientInstance['request'] = jest
             .fn()
             .mockReturnValue(Promise.resolve(fixtures_js_1.clusterLockV1X8.cluster_definition));
         const clusterDefinition = yield clientInstance.getClusterDefinition(fixtures_js_1.clusterLockV1X8.cluster_definition.config_hash);
-        expect((_c = clusterDefinition.deposit_amounts) === null || _c === void 0 ? void 0 : _c.length).toEqual(fixtures_js_1.clusterLockV1X8.cluster_definition.deposit_amounts.length);
+        expect((_a = clusterDefinition.deposit_amounts) === null || _a === void 0 ? void 0 : _a.length).toEqual(fixtures_js_1.clusterLockV1X8.cluster_definition.deposit_amounts.length);
         expect(clusterDefinition.config_hash).toEqual(fixtures_js_1.clusterLockV1X8.cluster_definition.config_hash);
     }));
     test('getClusterLock should return lockFile if exist', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -211,6 +211,10 @@ describe('Cluster Client without a signer', () => {
             clusterLock: fixtures_js_1.clusterLockWithSafe,
         },
         { version: 'v1.10.0', clusterLock: fixtures_js_1.clusterLockV1X10 },
+        {
+            version: 'v1.10.0 with compunding withdrawals',
+            clusterLock: fixtures_js_1.clusterLockWithCompoundingWithdrawals,
+        },
     ])("$version: 'should return true on verified cluster lock'", ({ clusterLock }) => __awaiter(void 0, void 0, void 0, function* () {
         const isValidLock = yield (0, index_1.validateClusterLock)(clusterLock);
         expect(isValidLock).toEqual(true);
@@ -229,9 +233,8 @@ describe('Cluster Client without a signer', () => {
     }));
 });
 describe('createObolRewardsSplit', () => {
-    let clientInstance, clientInstanceWithourSigner, mockSplitRecipients, mockPrincipalRecipient, mockEtherAmount, mockSigner;
+    let clientInstance, clientInstanceWithourSigner, mockSplitRecipients, mockPrincipalRecipient, mockEtherAmount;
     beforeAll(() => {
-        var _a, _b;
         jest
             .spyOn(utils, 'isContractAvailable')
             .mockImplementation(() => __awaiter(void 0, void 0, void 0, function* () { return yield Promise.resolve(true); }));
@@ -244,11 +247,6 @@ describe('createObolRewardsSplit', () => {
                 fee_recipient_address: '0xFeeRecipientAddress',
             });
         }));
-        const mnemonic = (_b = (_a = ethers_1.ethers.Wallet.createRandom().mnemonic) === null || _a === void 0 ? void 0 : _a.phrase) !== null && _b !== void 0 ? _b : '';
-        const privateKey = ethers_1.ethers.Wallet.fromPhrase(mnemonic).privateKey;
-        const provider = new ethers_1.JsonRpcProvider('https://ethereum-holesky.publicnode.com');
-        const wallet = new ethers_1.ethers.Wallet(privateKey, provider);
-        mockSigner = wallet.connect(provider);
         clientInstance = new index_1.Client({ baseUrl: 'https://obol-api-dev.gcp.obol.tech', chainId: 17000 }, mockSigner);
         clientInstanceWithourSigner = new index_1.Client({
             baseUrl: 'https://obol-api-dev.gcp.obol.tech',
@@ -326,9 +324,8 @@ describe('createObolRewardsSplit', () => {
     }));
 });
 describe('createObolTotalSplit', () => {
-    let clientInstanceWithourSigner, mockSplitRecipients, mockSigner, clientInstance;
+    let clientInstanceWithourSigner, mockSplitRecipients, clientInstance;
     beforeAll(() => {
-        var _a, _b;
         jest
             .spyOn(utils, 'isContractAvailable')
             .mockImplementation(() => __awaiter(void 0, void 0, void 0, function* () { return yield Promise.resolve(true); }));
@@ -338,11 +335,6 @@ describe('createObolTotalSplit', () => {
         jest
             .spyOn(splitsHelpers, 'deploySplitterContract')
             .mockImplementation(() => __awaiter(void 0, void 0, void 0, function* () { return yield Promise.resolve('0xSplitterAddress'); }));
-        const mnemonic = (_b = (_a = ethers_1.ethers.Wallet.createRandom().mnemonic) === null || _a === void 0 ? void 0 : _a.phrase) !== null && _b !== void 0 ? _b : '';
-        const privateKey = ethers_1.ethers.Wallet.fromPhrase(mnemonic).privateKey;
-        const provider = new ethers_1.JsonRpcProvider('https://ethereum-holesky.publicnode.com');
-        const wallet = new ethers_1.ethers.Wallet(privateKey, provider);
-        mockSigner = wallet.connect(provider);
         clientInstance = new index_1.Client({ baseUrl: 'https://obol-api-dev.gcp.obol.tech', chainId: 17000 }, mockSigner);
         clientInstanceWithourSigner = new index_1.Client({
             baseUrl: 'https://obol-api-dev.gcp.obol.tech',
@@ -419,3 +411,47 @@ describe('createObolTotalSplit', () => {
         });
     }));
 });
+describe('getIncentivesByAddress', () => {
+    let clientInstance;
+    beforeAll(() => {
+        jest
+            .spyOn(utils, 'isContractAvailable')
+            .mockImplementation(() => __awaiter(void 0, void 0, void 0, function* () { return yield Promise.resolve(true); }));
+        jest
+            .spyOn(splitsHelpers, 'predictSplitterAddress')
+            .mockImplementation(() => __awaiter(void 0, void 0, void 0, function* () { return yield Promise.resolve('0xPredictedAddress'); }));
+        jest
+            .spyOn(splitsHelpers, 'deploySplitterContract')
+            .mockImplementation(() => __awaiter(void 0, void 0, void 0, function* () { return yield Promise.resolve('0xSplitterAddress'); }));
+        clientInstance = new index_1.Client({ baseUrl: 'https://obol-api-dev.gcp.obol.tech', chainId: 17000 }, mockSigner);
+    });
+    test('should return incentives for a valid address', () => __awaiter(void 0, void 0, void 0, function* () {
+        const mockAddress = '0x1234567890abcdef1234567890abcdef12345678';
+        const mockIncentives = {
+            operator_address: '0x8c00157cae72c4ed6a1f8bfb60205601f0252e26',
+            amount: '100',
+            index: 1,
+            merkle_proof: ['hash1', 'hash2'],
+            contract_address: '0xContract',
+        };
+        clientInstance['request'] = jest
+            .fn()
+            .mockReturnValue(Promise.resolve(mockIncentives));
+        const incentives = yield clientInstance.getIncentivesByAddress(mockAddress);
+        expect(incentives).toEqual(mockIncentives);
+    }));
+    test('should throw an error if address is not found', () => __awaiter(void 0, void 0, void 0, function* () {
+        const invalidAddress = '0x0000000000000000000000000000000000000000';
+        clientInstance['request'] = jest
+            .fn()
+            .mockRejectedValue(new Error('Not found'));
+        yield expect(clientInstance.getIncentivesByAddress(invalidAddress)).rejects.toThrow('Not found');
+    }));
+    test('should throw an error if request fails', () => __awaiter(void 0, void 0, void 0, function* () {
+        const mockAddress = '0x1234567890abcdef1234567890abcdef12345678';
+        clientInstance['request'] = jest
+            .fn()
+            .mockRejectedValue(new Error('Network error'));
+        yield expect(clientInstance.getIncentivesByAddress(mockAddress)).rejects.toThrow('Network error');
+    }));
+});

package/dist/esm/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@obolnetwork/obol-sdk",
-    "version": "2.2.3",
+    "version": "2.3.0",
     "description": "A package for creating Distributed Validators using the Obol API.",
     "bugs": {
         "url": "https://github.com/obolnetwork/obol-sdk/issues"

package/dist/esm/src/index.js

@@ -353,4 +353,17 @@ export class Client extends Base {
             return lock;
         });
     }
+    /**
+     * @param address - Operator address
+     * @returns {Promise<Incentives>} The matched incentives from DB
+     * @throws On not found if address not found.
+     */
+    getIncentivesByAddress(address) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const incentives = yield this.request(`/${DEFAULT_BASE_VERSION}/address/incentives/${address}`, {
+                method: 'GET',
+            });
+            return incentives;
+        });
+    }
 }

package/dist/esm/src/verification/common.js

@@ -208,18 +208,13 @@ const computeDomain = (domainType, lockForkVersion, genesisValidatorsRoot = from
  * @param {string} withdrawalAddress - withdrawal address in definition file.
  * @returns {boolean} - return if deposit data is valid.
  */
-export const verifyDepositData = (distributedPublicKey, depositData, withdrawalAddress, forkVersion) => {
+export const verifyDepositData = (distributedPublicKey, depositData, withdrawalAddress, forkVersion, compounding) => {
     const depositDomain = computeDomain(fromHexString(DOMAIN_DEPOSIT), forkVersion);
-    const eth1AddressWithdrawalPrefix = '0x01';
-    const compoundingWithdrawalPrefix = '0x02';
-    if (eth1AddressWithdrawalPrefix +
+    const withdrawalPrefix = compounding ? '0x02' : '0x01';
+    const expectedWithdrawalCredentials = withdrawalPrefix +
         '0'.repeat(22) +
-        withdrawalAddress.toLowerCase().slice(2) !==
-        depositData.withdrawal_credentials &&
-        compoundingWithdrawalPrefix +
-            '0'.repeat(22) +
-            withdrawalAddress.toLowerCase().slice(2) !==
-            depositData.withdrawal_credentials) {
+        withdrawalAddress.toLowerCase().slice(2);
+    if (expectedWithdrawalCredentials !== depositData.withdrawal_credentials) {
         return { isValidDepositData: false, depositDataMsg: new Uint8Array(0) };
     }
     if (distributedPublicKey !== depositData.pubkey) {

package/dist/esm/src/verification/v1.10.0.js

@@ -1,7 +1,7 @@
 import { UintNumberType, } from '@chainsafe/ssz/lib/type/uint';
 import { strToUint8Array } from '../utils';
 import { builderRegistrationContainer, depositDataContainer, newCreatorContainerType, newOperatorContainerType, validatorsContainerType, } from './sszTypes';
-import { ByteListType, ByteVectorType, ContainerType, ListBasicType, ListCompositeType, fromHexString, } from '@chainsafe/ssz';
+import { ByteListType, ByteVectorType, ContainerType, ListBasicType, ListCompositeType, fromHexString, BooleanType, } from '@chainsafe/ssz';
 import { verifyDVV1X8 } from './v1.8.0';
 /**
  * Returns the containerized cluster definition
@@ -24,6 +24,7 @@ export const clusterDefinitionContainerTypeV1X10 = (configOnly) => {
         deposit_amounts: new ListBasicType(new UintNumberType(8), 256),
         consensus_protocol: new ByteListType(256),
         target_gas_limit: new UintNumberType(8),
+        compounding: new BooleanType(),
     };
     if (!configOnly) {
         returnedContainerType = Object.assign(Object.assign({}, returnedContainerType), { config_hash: new ByteVectorType(32) });
@@ -75,6 +76,9 @@ export const hashClusterDefinitionV1X10 = (cluster, configOnly) => {
     if (cluster.target_gas_limit) {
         val.target_gas_limit = cluster.target_gas_limit;
     }
+    if (cluster.compounding) {
+        val.compounding = cluster.compounding;
+    }
     if (!configOnly) {
         val.config_hash = fromHexString(cluster.config_hash);
     }

package/dist/esm/src/verification/v1.8.0.js

@@ -144,7 +144,7 @@ export const verifyDVV1X8 = (clusterLock) => {
         // Deposit Data Verification
         for (const element of validator.partial_deposit_data) {
             const depositData = element;
-            const { isValidDepositData, depositDataMsg } = verifyDepositData(distributedPublicKey, depositData, clusterLock.cluster_definition.validators[i].withdrawal_address, clusterLock.cluster_definition.fork_version);
+            const { isValidDepositData, depositDataMsg } = verifyDepositData(distributedPublicKey, depositData, clusterLock.cluster_definition.validators[i].withdrawal_address, clusterLock.cluster_definition.fork_version, clusterLock.cluster_definition.compounding);
             if (!isValidDepositData) {
                 return false;
             }