@obolnetwork/obol-sdk 2.2.3 → 2.2.4

package/dist/types/src/verification/v1.10.0.d.ts

@@ -1,6 +1,6 @@
 import { UintNumberType } from '@chainsafe/ssz/lib/type/uint';
 import { type creatorAddressWrapperType, type creatorContainerType, type operatorAddressWrapperType, type operatorContainerType, validatorsContainerType } from './sszTypes';
-import { ByteListType, ByteVectorType, ContainerType, ListBasicType, ListCompositeType } from '@chainsafe/ssz';
+import { ByteListType, ByteVectorType, ContainerType, ListBasicType, ListCompositeType, BooleanType } from '@chainsafe/ssz';
 import { type ValueOfFields } from '@chainsafe/ssz/lib/view/container';
 import { type ClusterDefinition, type ClusterLock } from '../types';
 type DefinitionFieldsV1X10 = {
@@ -18,6 +18,7 @@ type DefinitionFieldsV1X10 = {
     deposit_amounts: ListBasicType<UintNumberType>;
     consensus_protocol: ByteListType;
     target_gas_limit: UintNumberType;
+    compounding: BooleanType;
     config_hash?: ByteVectorType;
 };
 type DefinitionContainerTypeV1X10 = ContainerType<DefinitionFieldsV1X10>;

package/dist/types/test/fixtures.d.ts

@@ -290,6 +290,61 @@ export declare const clusterLockV1X10: {
         deposit_amounts: null;
         consensus_protocol: string;
         target_gas_limit: number;
+        compounding: boolean;
+        config_hash: string;
+        definition_hash: string;
+    };
+    distributed_validators: {
+        distributed_public_key: string;
+        public_shares: string[];
+        builder_registration: {
+            message: {
+                fee_recipient: string;
+                gas_limit: number;
+                timestamp: number;
+                pubkey: string;
+            };
+            signature: string;
+        };
+        partial_deposit_data: {
+            pubkey: string;
+            withdrawal_credentials: string;
+            amount: string;
+            signature: string;
+        }[];
+    }[];
+    signature_aggregate: string;
+    lock_hash: string;
+    node_signatures: string[];
+};
+export declare const clusterLockWithCompoundingWithdrawals: {
+    cluster_definition: {
+        name: string;
+        creator: {
+            address: string;
+            config_signature: string;
+        };
+        operators: {
+            address: string;
+            enr: string;
+            config_signature: string;
+            enr_signature: string;
+        }[];
+        uuid: string;
+        version: string;
+        timestamp: string;
+        num_validators: number;
+        threshold: number;
+        validators: {
+            fee_recipient_address: string;
+            withdrawal_address: string;
+        }[];
+        dkg_algorithm: string;
+        fork_version: string;
+        deposit_amounts: null;
+        consensus_protocol: string;
+        target_gas_limit: number;
+        compounding: boolean;
         config_hash: string;
         definition_hash: string;
     };

package/package.json

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

package/src/types.ts

@@ -144,6 +144,9 @@ export interface ClusterDefinition extends ClusterPayload {
 
   /** The target gas limit where default is 30M. */
   target_gas_limit?: number;
+
+  /** A withdrawal mechanism with 0x02 withdrawal credentials. */
+  compounding?: boolean;
 }
 
 /**

package/src/verification/common.ts

@@ -354,23 +354,19 @@ export const verifyDepositData = (
   depositData: Partial<DepositData>,
   withdrawalAddress: string,
   forkVersion: string,
+  compounding?: boolean,
 ): { isValidDepositData: boolean; depositDataMsg: Uint8Array } => {
   const depositDomain = computeDomain(
     fromHexString(DOMAIN_DEPOSIT),
     forkVersion,
   );
-  const eth1AddressWithdrawalPrefix = '0x01';
-  const compoundingWithdrawalPrefix = '0x02';
-  if (
-    eth1AddressWithdrawalPrefix +
-      '0'.repeat(22) +
-      withdrawalAddress.toLowerCase().slice(2) !==
-      depositData.withdrawal_credentials &&
-    compoundingWithdrawalPrefix +
-      '0'.repeat(22) +
-      withdrawalAddress.toLowerCase().slice(2) !==
-      depositData.withdrawal_credentials
-  ) {
+  const withdrawalPrefix = compounding ? '0x02' : '0x01';
+  const expectedWithdrawalCredentials =
+    withdrawalPrefix +
+    '0'.repeat(22) +
+    withdrawalAddress.toLowerCase().slice(2);
+
+  if (expectedWithdrawalCredentials !== depositData.withdrawal_credentials) {
     return { isValidDepositData: false, depositDataMsg: new Uint8Array(0) };
   }
 

package/src/verification/v1.10.0.ts

@@ -21,6 +21,7 @@ import {
   ListBasicType,
   ListCompositeType,
   fromHexString,
+  BooleanType,
 } from '@chainsafe/ssz';
 import { type ValueOfFields } from '@chainsafe/ssz/lib/view/container';
 import {
@@ -48,6 +49,7 @@ type DefinitionFieldsV1X10 = {
   deposit_amounts: ListBasicType<UintNumberType>;
   consensus_protocol: ByteListType;
   target_gas_limit: UintNumberType;
+  compounding: BooleanType;
   config_hash?: ByteVectorType;
 };
 
@@ -79,6 +81,7 @@ export const clusterDefinitionContainerTypeV1X10 = (
     ),
     consensus_protocol: new ByteListType(256),
     target_gas_limit: new UintNumberType(8 as UintNumberByteLen),
+    compounding: new BooleanType(),
   };
 
   if (!configOnly) {
@@ -144,6 +147,10 @@ export const hashClusterDefinitionV1X10 = (
     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/src/verification/v1.8.0.ts

@@ -259,6 +259,7 @@ export const verifyDVV1X8 = (clusterLock: ClusterLock): boolean => {
         depositData as Partial<DepositData>,
         clusterLock.cluster_definition.validators[i].withdrawal_address,
         clusterLock.cluster_definition.fork_version,
+        clusterLock.cluster_definition.compounding,
       );
 
       if (!isValidDepositData) {