@obolnetwork/obol-sdk 1.0.12 → 1.0.13

package/src/schema.ts

@@ -1,70 +1,58 @@
 export const operatorPayloadSchema = {
-  type: "object",
+  type: 'object',
   properties: {
     version: {
-      type: "string"
+      type: 'string',
     },
     enr: {
-      type: "string"
+      type: 'string',
     },
   },
-  required: [
-    "version",
-    "enr",
-  ]
+  required: ['version', 'enr'],
 }
 
 export const definitionSchema = {
-  type: "object",
+  type: 'object',
   properties: {
     name: {
-      type: "string"
+      type: 'string',
     },
     operators: {
-      type: "array",
+      type: 'array',
       minItems: 4,
       uniqueItems: true,
       items: {
-        type: "object",
+        type: 'object',
         properties: {
           address: {
-            type: "string",
+            type: 'string',
             minLength: 42,
-            maxLength: 42
-          }
+            maxLength: 42,
+          },
         },
-        required: [
-          "address"
-        ]
-      }
+        required: ['address'],
+      },
     },
     validators: {
-      type: "array",
+      type: 'array',
       minItems: 1,
       items: {
-        type: "object",
+        type: 'object',
         properties: {
           fee_recipient_address: {
-            type: "string",
+            type: 'string',
             minLength: 42,
-            maxLength: 42
+            maxLength: 42,
           },
           withdrawal_address: {
-            type: "string",
+            type: 'string',
             minLength: 42,
-            maxLength: 42
-          }
+            maxLength: 42,
+          },
         },
-        required: [
-          "fee_recipient_address",
-          "withdrawal_address"
-        ]
-      }
-    }
+        required: ['fee_recipient_address', 'withdrawal_address'],
+      },
+    },
   },
-  required: [
-    "name",
-    "operators",
-    "validators"
-  ]
+  required: ['name', 'operators', 'validators'],
 }

package/src/services.ts

@@ -1,20 +1,22 @@
-import { ClusterLock } from "./types.js";
-import { isValidClusterLock } from "./verify.js";
+import { type ClusterLock } from './types.js'
+import { isValidClusterLock } from './verification/common.js'
 
-/** 
+/**
  * Verifies Cluster Lock's validity.
  * @param lock - cluster lock
- * @returns {Promise<{ result: boolean }> } boolean result to indicate if lock is valid  
+ * @returns {Promise<{ result: boolean }> } boolean result to indicate if lock is valid
  * @throws on missing keys or values.
- * 
+ *
  * An example of how to use validateClusterLock:
  * [validateClusterLock](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
  */
-export const validateClusterLock = async (lock: ClusterLock): Promise<boolean> => {
-    try {
-        const isLockValid = await isValidClusterLock(lock);
-        return isLockValid
-    } catch (err: any) {
-        throw err;
-    }
-}
+export const validateClusterLock = async (
+  lock: ClusterLock,
+): Promise<boolean> => {
+  try {
+    const isLockValid = await isValidClusterLock(lock)
+    return isLockValid
+  } catch (err: any) {
+    throw err
+  }
+}

package/src/types.ts

@@ -2,210 +2,208 @@
  * Permitted ChainID's
  */
 export enum FORK_MAPPING {
-
   /** Mainnet. */
-  "0x00000000" = 1,
+  '0x00000000' = 1,
 
   /** Goerli/Prater. */
-  "0x00001020" = 5,
+  '0x00001020' = 5,
 
   /** Gnosis Chain. */
-  "0x00000064" = 100,
+  '0x00000064' = 100,
 
   /** Holesky. */
-  "0x01017000" = 17000
+  '0x01017000' = 17000,
 }
 
 /**
  * Node operator data
  */
-export type ClusterOperator = {
-
+export interface ClusterOperator {
   /** The operator address. */
-  address: string;
+  address: string
 
   /** The operator ethereum node record. */
-  enr?: string;
+  enr?: string
 
   /** The cluster fork_version. */
-  fork_version?: string;
+  fork_version?: string
 
   /** The cluster version. */
-  version?: string;
+  version?: string
 
   /** The operator enr signature. */
-  enr_signature?: string;
+  enr_signature?: string
 
   /** The operator configuration signature. */
-  config_signature?: string;
+  config_signature?: string
 }
 
 /**
  * A partial view of `ClusterOperator` with `enr` and `version` as required properties.
  */
-export type OperatorPayload =  Partial<ClusterOperator> & Required<Pick<ClusterOperator, 'enr' | 'version'>>;
+export type OperatorPayload = Partial<ClusterOperator> &
+  Required<Pick<ClusterOperator, 'enr' | 'version'>>
 
 /**
  * Cluster creator data
  */
-export type ClusterCreator = {
-
+export interface ClusterCreator {
   /** The creator address. */
-  address: string;
+  address: string
   /** The cluster configuration signature. */
-  config_signature?: string;
+  config_signature?: string
 }
 
 /**
  * Validator withdrawal configuration
  */
-export type ClusterValidator = {
-
+export interface ClusterValidator {
   /** The validator fee recipient address. */
-  fee_recipient_address: string;
+  fee_recipient_address: string
 
   /** The validator reward address. */
-  withdrawal_address: string;
+  withdrawal_address: string
 }
 
 /**
  * Cluster configuration
  */
-export type ClusterPayload = {
-
+export interface ClusterPayload {
   /** The cluster name. */
-  name: string;
+  name: string
 
   /** The cluster nodes operators addresses. */
-  operators: ClusterOperator[];
+  operators: ClusterOperator[]
 
-  /** The clusters validators information. */
-  validators: ClusterValidator[];
-};
+  /** The cluster validators information. */
+  validators: ClusterValidator[]
+
+  /** The cluster partial deposits in gwei or 32000000000. */
+  deposit_amounts?: string[]
+}
 
 /**
  * Cluster definition data needed for dkg
  */
 export interface ClusterDefintion extends ClusterPayload {
-
   /** The creator of the cluster. */
-  creator: ClusterCreator;
+  creator: ClusterCreator
 
   /** The cluster configuration version. */
-  version: string;
+  version: string
 
   /** The cluster dkg algorithm. */
-  dkg_algorithm: string;
+  dkg_algorithm: string
 
   /** The cluster fork version. */
-  fork_version: string;
+  fork_version: string
 
   /** The cluster uuid. */
-  uuid: string;
+  uuid: string
 
   /** The cluster creation timestamp. */
-  timestamp: string;
+  timestamp: string
 
   /** The cluster configuration hash. */
-  config_hash: string;
+  config_hash: string
 
   /** The distributed validator threshold. */
-  threshold: number;
+  threshold: number
 
   /** The number of distributed validators in the cluster. */
-  num_validators: number;
+  num_validators: number
+
+  /** The cluster partial deposits in gwei or 32000000000. */
+  deposit_amounts?: string[]
 
   /** The hash of the cluster definition. */
-  definition_hash?: string;
-};
+  definition_hash?: string
+}
 
 /**
  * Unsigned DV Builder Registration Message
  */
-export type BuilderRegistrationMessage = {
-
+export interface BuilderRegistrationMessage {
   /** The DV fee recipient. */
-  fee_recipient: string;
+  fee_recipient: string
 
   /** Default is 30000000. */
-  gas_limit: number;
+  gas_limit: number
 
   /** Timestamp when generating cluster lock file. */
-  timestamp: number;
+  timestamp: number
 
   /** The public key of the DV. */
-  pubkey: string;
+  pubkey: string
 }
 
 /**
  * Pre-generated Signed Validator Builder Registration
  */
-export type BuilderRegistration = {
-
+export interface BuilderRegistration {
   /** Builder registration message. */
-  message: BuilderRegistrationMessage;
+  message: BuilderRegistrationMessage
 
   /** BLS signature of the builder registration message. */
-  signature: string;
+  signature: string
 }
 
 /**
  * Required deposit data for validator activation
  */
-export type DepositData = {
-
+export interface DepositData {
   /** The public key of the distributed validator. */
-  pubkey: string;
+  pubkey: string
 
   /** The 0x01 withdrawal address of the DV. */
-  withdrawal_credentials: string;
+  withdrawal_credentials: string
 
   /** 32 ethers. */
-  amount: string;
+  amount: string
 
   /** A checksum for DepositData fields . */
-  deposit_data_root: string;
+  deposit_data_root: string
 
   /** BLS signature of the deposit message. */
-  signature: string;
+  signature: string
 }
 
 /**
  * Required deposit data for validator activation
  */
-export type DistributedValidator = {
-
+export interface DistributedValidator {
   /** The public key of the distributed validator. */
-  distributed_public_key: string;
+  distributed_public_key: string
 
   /** The public key of the node distributed validator share. */
-  public_shares: string[];
+  public_shares: string[]
+
+  /** The deposit data for activating the DV. */
+  deposit_data?: Partial<DepositData>
 
-  /** The required deposit data for activating the DV. */
-  deposit_data: Partial<DepositData>;
+  /** The deposit data with partial amounts or full amount for activating the DV. */
+  partial_deposit_data?: Array<Partial<DepositData>>
 
   /** pre-generated signed validator builder registration to be sent to builder network. */
-  builder_registration: BuilderRegistration;
+  builder_registration?: BuilderRegistration
 }
 
 /**
  * Cluster Details after DKG is complete
  */
-export type ClusterLock = {
-  
+export interface ClusterLock {
   /** The cluster definition. */
-  cluster_definition: ClusterDefintion;
+  cluster_definition: ClusterDefintion
 
   /** The cluster distributed validators. */
-  distributed_validators: DistributedValidator[];
+  distributed_validators: DistributedValidator[]
 
   /** The cluster bls signature aggregate. */
-  signature_aggregate: string;
+  signature_aggregate: string
 
   /** The hash of the cluster lock. */
-  lock_hash: string;
+  lock_hash: string
 
   /** Node Signature for the lock hash by the node secp256k1 key. */
-  node_signatures: string[];
-};
-
+  node_signatures?: string[]
+}

package/src/utils.ts

@@ -1,7 +1,56 @@
+import { DefinitionFlow } from './constants'
+import { type ClusterDefintion } from './types'
+
 export const hexWithout0x = (hex: string): string => {
-    return hex.slice(2, hex.length);
-};
+  return hex.slice(2, hex.length)
+}
 
 export const strToUint8Array = (str: string): Uint8Array => {
-    return new TextEncoder().encode(str);
-  };
+  return new TextEncoder().encode(str)
+}
+
+export const definitionFlow = (
+  clusterDefinition: ClusterDefintion,
+): DefinitionFlow | null => {
+  if (
+    clusterDefinition.creator.address &&
+    clusterDefinition.creator.config_signature &&
+    clusterDefinition.operators.every((operator) => {
+      return (
+        operator.address &&
+        operator.config_signature &&
+        operator.enr &&
+        operator.enr_signature
+      )
+    })
+  ) {
+    return DefinitionFlow.Group
+  } else if (
+    clusterDefinition.creator.address &&
+    clusterDefinition.creator.config_signature &&
+    clusterDefinition.operators.every((operator) => {
+      return (
+        !operator.address &&
+        !operator.config_signature &&
+        operator.enr &&
+        !operator.enr_signature
+      )
+    })
+  ) {
+    return DefinitionFlow.Solo
+  } else if (
+    !clusterDefinition.creator.address &&
+    !clusterDefinition.creator.config_signature &&
+    clusterDefinition.operators.every((operator) => {
+      return (
+        !operator.address &&
+        !operator.config_signature &&
+        operator.enr &&
+        !operator.enr_signature
+      )
+    })
+  ) {
+    return DefinitionFlow.Charon
+  }
+  return null
+}