@obolnetwork/obol-sdk 2.2.4 → 2.3.0

package/dist/cjs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@obolnetwork/obol-sdk",
-    "version": "2.2.4",
+    "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/cjs/src/index.js

@@ -370,5 +370,18 @@ class Client extends base_js_1.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(`/${constants_js_1.DEFAULT_BASE_VERSION}/address/incentives/${address}`, {
+                method: 'GET',
+            });
+            return incentives;
+        });
+    }
 }
 exports.Client = Client;

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* () {
@@ -233,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); }));
@@ -248,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',
@@ -330,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); }));
@@ -342,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',
@@ -423,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.4",
+    "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/test/methods.test.js

@@ -7,6 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var _a, _b;
 import { ethers, JsonRpcProvider } from 'ethers';
 import { Client, validateClusterLock } from '../src/index';
 import { clusterConfigV1X7, clusterConfigV1X8, clusterLockV1X10, clusterLockV1X6, clusterLockV1X7, clusterLockV1X8, clusterLockWithCompoundingWithdrawals, clusterLockWithSafe, nullDepositAmountsClusterLockV1X8, } from './fixtures.js';
@@ -19,15 +20,14 @@ import { hashTermsAndConditions } from '../src/verification/termsAndConditions';
 import * as utils from '../src/utils';
 import * as splitsHelpers from '../src/splitHelpers';
 jest.setTimeout(20000);
+const mnemonic = (_b = (_a = ethers.Wallet.createRandom().mnemonic) === null || _a === void 0 ? void 0 : _a.phrase) !== null && _b !== void 0 ? _b : '';
+const privateKey = ethers.Wallet.fromPhrase(mnemonic).privateKey;
+const provider = new JsonRpcProvider('https://ethereum-holesky.publicnode.com');
+const wallet = new 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.Wallet.createRandom().mnemonic) === null || _a === void 0 ? void 0 : _a.phrase) !== null && _b !== void 0 ? _b : '';
-    const privateKey = ethers.Wallet.fromPhrase(mnemonic).privateKey;
-    const provider = new JsonRpcProvider('https://ethereum-holesky.publicnode.com');
-    const wallet = new ethers.Wallet(privateKey, provider);
-    const mockSigner = wallet.connect(provider);
     const clientInstance = new 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
@@ -92,12 +92,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(clusterLockV1X8.cluster_definition));
         const clusterDefinition = yield clientInstance.getClusterDefinition(clusterLockV1X8.cluster_definition.config_hash);
-        expect((_c = clusterDefinition.deposit_amounts) === null || _c === void 0 ? void 0 : _c.length).toEqual(clusterLockV1X8.cluster_definition.deposit_amounts.length);
+        expect((_a = clusterDefinition.deposit_amounts) === null || _a === void 0 ? void 0 : _a.length).toEqual(clusterLockV1X8.cluster_definition.deposit_amounts.length);
         expect(clusterDefinition.config_hash).toEqual(clusterLockV1X8.cluster_definition.config_hash);
     }));
     test('getClusterLock should return lockFile if exist', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -208,9 +208,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); }));
@@ -223,11 +222,6 @@ describe('createObolRewardsSplit', () => {
                 fee_recipient_address: '0xFeeRecipientAddress',
             });
         }));
-        const mnemonic = (_b = (_a = ethers.Wallet.createRandom().mnemonic) === null || _a === void 0 ? void 0 : _a.phrase) !== null && _b !== void 0 ? _b : '';
-        const privateKey = ethers.Wallet.fromPhrase(mnemonic).privateKey;
-        const provider = new JsonRpcProvider('https://ethereum-holesky.publicnode.com');
-        const wallet = new ethers.Wallet(privateKey, provider);
-        mockSigner = wallet.connect(provider);
         clientInstance = new Client({ baseUrl: 'https://obol-api-dev.gcp.obol.tech', chainId: 17000 }, mockSigner);
         clientInstanceWithourSigner = new Client({
             baseUrl: 'https://obol-api-dev.gcp.obol.tech',
@@ -305,9 +299,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); }));
@@ -317,11 +310,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.Wallet.createRandom().mnemonic) === null || _a === void 0 ? void 0 : _a.phrase) !== null && _b !== void 0 ? _b : '';
-        const privateKey = ethers.Wallet.fromPhrase(mnemonic).privateKey;
-        const provider = new JsonRpcProvider('https://ethereum-holesky.publicnode.com');
-        const wallet = new ethers.Wallet(privateKey, provider);
-        mockSigner = wallet.connect(provider);
         clientInstance = new Client({ baseUrl: 'https://obol-api-dev.gcp.obol.tech', chainId: 17000 }, mockSigner);
         clientInstanceWithourSigner = new Client({
             baseUrl: 'https://obol-api-dev.gcp.obol.tech',
@@ -398,3 +386,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 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/types/src/index.d.ts

@@ -1,6 +1,6 @@
 import { type Signer } from 'ethers';
 import { Base } from './base.js';
-import { type RewardsSplitPayload, type ClusterDefinition, type ClusterLock, type ClusterPayload, type OperatorPayload, type TotalSplitPayload, type ClusterValidator, type ETH_ADDRESS, type OWRTranches } from './types.js';
+import { type RewardsSplitPayload, type ClusterDefinition, type ClusterLock, type ClusterPayload, type OperatorPayload, type TotalSplitPayload, type ClusterValidator, type ETH_ADDRESS, type OWRTranches, type Incentives } from './types.js';
 export * from './types.js';
 export * from './services.js';
 export * from './verification/signature-validator.js';
@@ -112,4 +112,10 @@ export declare class Client extends Base {
      * [getObolClusterLock](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts#L89)
      */
     getClusterLock(configHash: string): Promise<ClusterLock>;
+    /**
+     * @param address - Operator address
+     * @returns {Promise<Incentives>} The matched incentives from DB
+     * @throws On not found if address not found.
+     */
+    getIncentivesByAddress(address: string): Promise<Incentives>;
 }

package/dist/types/src/types.d.ts

@@ -211,6 +211,21 @@ export type ClusterLock = {
     /** Node Signature for the lock hash by the node secp256k1 key. */
     node_signatures?: string[];
 };
+/**
+ * Incentives
+ */
+export type Incentives = {
+    /** Operator Address. */
+    operator_address: string;
+    /** The amount the recipient is entitled to. */
+    amount: string;
+    /** The recipient’s index in the Merkle tree. */
+    index: number;
+    /** The Merkle proof (an array of hashes) generated for the recipient. */
+    merkle_proof: string[];
+    /** The MerkleDistributor contract address. */
+    contract_address: string;
+};
 /**
  * String expected to be Ethereum Address
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@obolnetwork/obol-sdk",
-  "version": "2.2.4",
+  "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/src/index.ts

@@ -30,6 +30,7 @@ import {
   type ClusterValidator,
   type ETH_ADDRESS,
   type OWRTranches,
+  type Incentives,
 } from './types.js';
 import { clusterConfigOrDefinitionHash } from './verification/common.js';
 import { validatePayload } from './ajv.js';
@@ -520,4 +521,19 @@ 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.
+   */
+  async getIncentivesByAddress(address: string): Promise<Incentives> {
+    const incentives: Incentives = await this.request(
+      `/${DEFAULT_BASE_VERSION}/address/incentives/${address}`,
+      {
+        method: 'GET',
+      },
+    );
+    return incentives;
+  }
 }

package/src/types.ts

@@ -293,6 +293,26 @@ export type ClusterLock = {
   node_signatures?: string[];
 };
 
+/**
+ * Incentives
+ */
+export type Incentives = {
+  /** Operator Address. */
+  operator_address: string;
+
+  /** The amount the recipient is entitled to. */
+  amount: string;
+
+  /** The recipient’s index in the Merkle tree. */
+  index: number;
+
+  /** The Merkle proof (an array of hashes) generated for the recipient. */
+  merkle_proof: string[];
+
+  /** The MerkleDistributor contract address. */
+  contract_address: string;
+};
+
 /**
  * String expected to be Ethereum Address
  */