@obolnetwork/obol-sdk 2.9.0 → 2.9.1

package/dist/cjs/package.json

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

package/dist/cjs/src/ajv.js

@@ -68,7 +68,6 @@ const validateOVMTotalSplitRecipients = (_, data) => {
     return validateTotalPercentage(splitPercentage);
 };
 const validateOVMRequestWithdrawalPayload = (_, data) => {
-    console.log(data, 'hanaaan dataaaa');
     if (!data.pubKeys || !data.amounts) {
         return false;
     }

package/dist/cjs/src/schema.js

@@ -212,6 +212,10 @@ exports.ovmTotalSplitPayloadSchema = {
 exports.ovmRequestWithdrawalPayloadSchema = {
     type: 'object',
     properties: {
+        withdrawalFees: {
+            type: 'string',
+            pattern: '^[0-9]+$',
+        },
         ovmAddress: {
             type: 'string',
             pattern: '^0x[a-fA-F0-9]{40}$',
@@ -234,5 +238,5 @@ exports.ovmRequestWithdrawalPayloadSchema = {
         },
     },
     validateOVMRequestWithdrawalPayload: true,
-    required: ['ovmAddress', 'pubKeys', 'amounts'],
+    required: ['ovmAddress', 'pubKeys', 'amounts', 'withdrawalFees'],
 };

package/dist/cjs/src/splits/splitHelpers.js

@@ -507,13 +507,15 @@ const getChainConfig = (chainId) => {
  * @param signer - The signer to use for the transaction
  * @returns Promise that resolves to the transaction hash
  */
-const requestWithdrawalFromOVM = ({ ovmAddress, pubKeys, amounts, signer, }) => __awaiter(void 0, void 0, void 0, function* () {
+const requestWithdrawalFromOVM = ({ ovmAddress, pubKeys, amounts, withdrawalFees, signer, }) => __awaiter(void 0, void 0, void 0, function* () {
     var _15;
     try {
         // Convert string amounts to bigint
         const bigintAmounts = amounts.map(amount => BigInt(amount));
         const ovmContract = new ethers_1.Contract(ovmAddress, OVMFactory_1.OVMContract.abi, signer);
-        const tx = yield ovmContract.requestWithdrawal(pubKeys, bigintAmounts);
+        const tx = yield ovmContract.requestWithdrawal(pubKeys, bigintAmounts, {
+            value: BigInt(withdrawalFees),
+        });
         const receipt = yield tx.wait();
         return { txHash: receipt.hash };
     }

package/dist/cjs/src/splits/splits.js

@@ -314,6 +314,7 @@ class ObolSplits {
                 ovmAddress: validatedPayload.ovmAddress,
                 pubKeys: validatedPayload.pubKeys,
                 amounts: validatedPayload.amounts,
+                withdrawalFees: validatedPayload.withdrawalFees,
                 signer: this.signer,
             });
         });

package/dist/cjs/test/client/ajv.spec.js

@@ -274,6 +274,7 @@ describe('ovmRequestWithdrawalPayloadSchema', () => {
             '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
         ],
         amounts: ['32000000000'],
+        withdrawalFees: '1',
     };
     it('should throw error when OVM address is missing', () => {
         const payload = {
@@ -288,14 +289,32 @@ describe('ovmRequestWithdrawalPayloadSchema', () => {
             pubKeys: validPayload.pubKeys,
             amounts: validPayload.amounts,
         };
-        expect(() => (0, ajv_1.validatePayload)(payload, schema_1.ovmRequestWithdrawalPayloadSchema)).toThrow('Validation failed: /ovmAddress must match pattern');
+        expect(() => (0, ajv_1.validatePayload)(payload, schema_1.ovmRequestWithdrawalPayloadSchema)).toThrow('Validation failed:  must have required property \'withdrawalFees\', /ovmAddress must match pattern "^0x[a-fA-F0-9]{40}$"');
     });
     it('should throw error when number of public keys does not match number of amounts', () => {
         const payload = {
             ovmAddress: validPayload.ovmAddress,
             pubKeys: validPayload.pubKeys,
             amounts: ['32000000000', '16000000000'], // 2 amounts, 1 pubKey
+            withdrawalFees: validPayload.withdrawalFees,
         };
         expect(() => (0, ajv_1.validatePayload)(payload, schema_1.ovmRequestWithdrawalPayloadSchema)).toThrow('Validation failed:  must pass "validateOVMRequestWithdrawalPayload" keyword validation');
     });
+    it('should throw error when withdrawalFees is missing', () => {
+        const payload = {
+            ovmAddress: validPayload.ovmAddress,
+            pubKeys: validPayload.pubKeys,
+            amounts: validPayload.amounts,
+        };
+        expect(() => (0, ajv_1.validatePayload)(payload, schema_1.ovmRequestWithdrawalPayloadSchema)).toThrow("Validation failed:  must have required property 'withdrawalFees'");
+    });
+    it('should throw error when withdrawalFees is invalid', () => {
+        const payload = {
+            ovmAddress: validPayload.ovmAddress,
+            pubKeys: validPayload.pubKeys,
+            amounts: validPayload.amounts,
+            withdrawalFees: 'invalid',
+        };
+        expect(() => (0, ajv_1.validatePayload)(payload, schema_1.ovmRequestWithdrawalPayloadSchema)).toThrow('Validation failed: /withdrawalFees must match pattern "^[0-9]+$"');
+    });
 });

package/dist/cjs/test/splits/splits.spec.js

@@ -246,6 +246,7 @@ describe('ObolSplits', () => {
                 ovmAddress: mockOVMAddress,
                 pubKeys: mockPubKeys,
                 amounts: mockAmounts,
+                withdrawalFees: '1',
             });
             expect(result).toEqual({
                 txHash: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
@@ -254,6 +255,7 @@ describe('ObolSplits', () => {
                 ovmAddress: mockOVMAddress,
                 pubKeys: mockPubKeys,
                 amounts: mockAmounts,
+                withdrawalFees: '1',
                 signer: mockSigner,
             });
         }));
@@ -263,6 +265,7 @@ describe('ObolSplits', () => {
                 ovmAddress: mockOVMAddress,
                 pubKeys: mockPubKeys,
                 amounts: mockAmounts,
+                withdrawalFees: '1',
             })).rejects.toThrow('Signer is required in requestWithdrawal');
         }));
         // it('should throw error when amount is below minimum (1,000,000 gwei)', async () => {
@@ -290,6 +293,7 @@ describe('ObolSplits', () => {
                 ovmAddress: mockOVMAddress,
                 pubKeys: multiplePubKeys,
                 amounts: multipleAmounts,
+                withdrawalFees: '1',
             });
             expect(result).toEqual({
                 txHash: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
@@ -298,6 +302,7 @@ describe('ObolSplits', () => {
                 ovmAddress: mockOVMAddress,
                 pubKeys: multiplePubKeys,
                 amounts: multipleAmounts,
+                withdrawalFees: '1',
                 signer: mockSigner,
             });
         }));

package/dist/esm/package.json

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

package/dist/esm/src/ajv.js

@@ -62,7 +62,6 @@ const validateOVMTotalSplitRecipients = (_, data) => {
     return validateTotalPercentage(splitPercentage);
 };
 const validateOVMRequestWithdrawalPayload = (_, data) => {
-    console.log(data, 'hanaaan dataaaa');
     if (!data.pubKeys || !data.amounts) {
         return false;
     }

package/dist/esm/src/schema.js

@@ -209,6 +209,10 @@ export const ovmTotalSplitPayloadSchema = {
 export const ovmRequestWithdrawalPayloadSchema = {
     type: 'object',
     properties: {
+        withdrawalFees: {
+            type: 'string',
+            pattern: '^[0-9]+$',
+        },
         ovmAddress: {
             type: 'string',
             pattern: '^0x[a-fA-F0-9]{40}$',
@@ -231,5 +235,5 @@ export const ovmRequestWithdrawalPayloadSchema = {
         },
     },
     validateOVMRequestWithdrawalPayload: true,
-    required: ['ovmAddress', 'pubKeys', 'amounts'],
+    required: ['ovmAddress', 'pubKeys', 'amounts', 'withdrawalFees'],
 };

package/dist/esm/src/splits/splitHelpers.js

@@ -492,13 +492,15 @@ const getChainConfig = (chainId) => {
  * @param signer - The signer to use for the transaction
  * @returns Promise that resolves to the transaction hash
  */
-export const requestWithdrawalFromOVM = ({ ovmAddress, pubKeys, amounts, signer, }) => __awaiter(void 0, void 0, void 0, function* () {
+export const requestWithdrawalFromOVM = ({ ovmAddress, pubKeys, amounts, withdrawalFees, signer, }) => __awaiter(void 0, void 0, void 0, function* () {
     var _15;
     try {
         // Convert string amounts to bigint
         const bigintAmounts = amounts.map(amount => BigInt(amount));
         const ovmContract = new Contract(ovmAddress, OVMContract.abi, signer);
-        const tx = yield ovmContract.requestWithdrawal(pubKeys, bigintAmounts);
+        const tx = yield ovmContract.requestWithdrawal(pubKeys, bigintAmounts, {
+            value: BigInt(withdrawalFees),
+        });
         const receipt = yield tx.wait();
         return { txHash: receipt.hash };
     }

package/dist/esm/src/splits/splits.js

@@ -311,6 +311,7 @@ export class ObolSplits {
                 ovmAddress: validatedPayload.ovmAddress,
                 pubKeys: validatedPayload.pubKeys,
                 amounts: validatedPayload.amounts,
+                withdrawalFees: validatedPayload.withdrawalFees,
                 signer: this.signer,
             });
         });

package/dist/esm/test/client/ajv.spec.js

@@ -272,6 +272,7 @@ describe('ovmRequestWithdrawalPayloadSchema', () => {
             '0x123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456',
         ],
         amounts: ['32000000000'],
+        withdrawalFees: '1',
     };
     it('should throw error when OVM address is missing', () => {
         const payload = {
@@ -286,14 +287,32 @@ describe('ovmRequestWithdrawalPayloadSchema', () => {
             pubKeys: validPayload.pubKeys,
             amounts: validPayload.amounts,
         };
-        expect(() => validatePayload(payload, ovmRequestWithdrawalPayloadSchema)).toThrow('Validation failed: /ovmAddress must match pattern');
+        expect(() => validatePayload(payload, ovmRequestWithdrawalPayloadSchema)).toThrow('Validation failed:  must have required property \'withdrawalFees\', /ovmAddress must match pattern "^0x[a-fA-F0-9]{40}$"');
     });
     it('should throw error when number of public keys does not match number of amounts', () => {
         const payload = {
             ovmAddress: validPayload.ovmAddress,
             pubKeys: validPayload.pubKeys,
             amounts: ['32000000000', '16000000000'], // 2 amounts, 1 pubKey
+            withdrawalFees: validPayload.withdrawalFees,
         };
         expect(() => validatePayload(payload, ovmRequestWithdrawalPayloadSchema)).toThrow('Validation failed:  must pass "validateOVMRequestWithdrawalPayload" keyword validation');
     });
+    it('should throw error when withdrawalFees is missing', () => {
+        const payload = {
+            ovmAddress: validPayload.ovmAddress,
+            pubKeys: validPayload.pubKeys,
+            amounts: validPayload.amounts,
+        };
+        expect(() => validatePayload(payload, ovmRequestWithdrawalPayloadSchema)).toThrow("Validation failed:  must have required property 'withdrawalFees'");
+    });
+    it('should throw error when withdrawalFees is invalid', () => {
+        const payload = {
+            ovmAddress: validPayload.ovmAddress,
+            pubKeys: validPayload.pubKeys,
+            amounts: validPayload.amounts,
+            withdrawalFees: 'invalid',
+        };
+        expect(() => validatePayload(payload, ovmRequestWithdrawalPayloadSchema)).toThrow('Validation failed: /withdrawalFees must match pattern "^[0-9]+$"');
+    });
 });

package/dist/esm/test/splits/splits.spec.js

@@ -244,6 +244,7 @@ describe('ObolSplits', () => {
                 ovmAddress: mockOVMAddress,
                 pubKeys: mockPubKeys,
                 amounts: mockAmounts,
+                withdrawalFees: '1',
             });
             expect(result).toEqual({
                 txHash: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
@@ -252,6 +253,7 @@ describe('ObolSplits', () => {
                 ovmAddress: mockOVMAddress,
                 pubKeys: mockPubKeys,
                 amounts: mockAmounts,
+                withdrawalFees: '1',
                 signer: mockSigner,
             });
         }));
@@ -261,6 +263,7 @@ describe('ObolSplits', () => {
                 ovmAddress: mockOVMAddress,
                 pubKeys: mockPubKeys,
                 amounts: mockAmounts,
+                withdrawalFees: '1',
             })).rejects.toThrow('Signer is required in requestWithdrawal');
         }));
         // it('should throw error when amount is below minimum (1,000,000 gwei)', async () => {
@@ -288,6 +291,7 @@ describe('ObolSplits', () => {
                 ovmAddress: mockOVMAddress,
                 pubKeys: multiplePubKeys,
                 amounts: multipleAmounts,
+                withdrawalFees: '1',
             });
             expect(result).toEqual({
                 txHash: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
@@ -296,6 +300,7 @@ describe('ObolSplits', () => {
                 ovmAddress: mockOVMAddress,
                 pubKeys: multiplePubKeys,
                 amounts: multipleAmounts,
+                withdrawalFees: '1',
                 signer: mockSigner,
             });
         }));

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

@@ -324,6 +324,10 @@ export declare const ovmTotalSplitPayloadSchema: {
 export declare const ovmRequestWithdrawalPayloadSchema: {
     type: string;
     properties: {
+        withdrawalFees: {
+            type: string;
+            pattern: string;
+        };
         ovmAddress: {
             type: string;
             pattern: string;

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

@@ -107,10 +107,11 @@ export declare const deployOVMAndSplitV2: ({ ovmArgs, rewardRecipients, isReward
  * @param signer - The signer to use for the transaction
  * @returns Promise that resolves to the transaction hash
  */
-export declare const requestWithdrawalFromOVM: ({ ovmAddress, pubKeys, amounts, signer, }: {
+export declare const requestWithdrawalFromOVM: ({ ovmAddress, pubKeys, amounts, withdrawalFees, signer, }: {
     ovmAddress: string;
     pubKeys: string[];
     amounts: string[];
+    withdrawalFees: string;
     signer: SignerType;
 }) => Promise<{
     txHash: string;

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

@@ -476,6 +476,8 @@ export type ChainConfig = {
  * Payload for requesting withdrawal from OVM contract
  */
 export type OVMRequestWithdrawalPayload = {
+    /** request withdrawal fees in wei */
+    withdrawalFees: string;
     /** OVM contract address */
     ovmAddress: string;
     /** Array of validator public keys in bytes format */

package/package.json

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

package/src/ajv.ts

@@ -112,7 +112,6 @@ const validateOVMRequestWithdrawalPayload = (
   _: boolean,
   data: OVMRequestWithdrawalPayload,
 ): boolean => {
-  console.log(data, 'hanaaan dataaaa');
   if (!data.pubKeys || !data.amounts) {
     return false;
   }

package/src/schema.ts

@@ -233,6 +233,10 @@ export const ovmTotalSplitPayloadSchema = {
 export const ovmRequestWithdrawalPayloadSchema = {
   type: 'object',
   properties: {
+    withdrawalFees: {
+      type: 'string',
+      pattern: '^[0-9]+$',
+    },
     ovmAddress: {
       type: 'string',
       pattern: '^0x[a-fA-F0-9]{40}$',
@@ -255,5 +259,5 @@ export const ovmRequestWithdrawalPayloadSchema = {
     },
   },
   validateOVMRequestWithdrawalPayload: true,
-  required: ['ovmAddress', 'pubKeys', 'amounts'],
+  required: ['ovmAddress', 'pubKeys', 'amounts', 'withdrawalFees'],
 };

package/src/splits/splitHelpers.ts

@@ -923,11 +923,13 @@ export const requestWithdrawalFromOVM = async ({
   ovmAddress,
   pubKeys,
   amounts,
+  withdrawalFees,
   signer,
 }: {
   ovmAddress: string;
   pubKeys: string[];
   amounts: string[];
+  withdrawalFees: string;
   signer: SignerType;
 }): Promise<{ txHash: string }> => {
   try {
@@ -936,7 +938,9 @@ export const requestWithdrawalFromOVM = async ({
 
     const ovmContract = new Contract(ovmAddress, OVMContract.abi, signer);
 
-    const tx = await ovmContract.requestWithdrawal(pubKeys, bigintAmounts);
+    const tx = await ovmContract.requestWithdrawal(pubKeys, bigintAmounts, {
+      value: BigInt(withdrawalFees),
+    });
     const receipt = await tx.wait();
 
     return { txHash: receipt.hash };

package/src/splits/splits.ts

@@ -447,6 +447,7 @@ export class ObolSplits {
       ovmAddress: validatedPayload.ovmAddress,
       pubKeys: validatedPayload.pubKeys,
       amounts: validatedPayload.amounts,
+      withdrawalFees: validatedPayload.withdrawalFees,
       signer: this.signer,
     });
   }

package/src/types.ts

@@ -612,6 +612,9 @@ export type ChainConfig = {
  * Payload for requesting withdrawal from OVM contract
  */
 export type OVMRequestWithdrawalPayload = {
+  /** request withdrawal fees in wei */
+  withdrawalFees: string;
+
   /** OVM contract address */
   ovmAddress: string;