@obolnetwork/obol-sdk 1.0.9 → 1.0.11

package/dist/{hash.d.ts → types/src/hash.d.ts}

@@ -1,64 +1,56 @@
-import { ContainerType, ByteVectorType, UintNumberType, ListCompositeType, ByteListType } from '@chainsafe/ssz';
-import { ValueOfFields } from '@chainsafe/ssz/lib/view/container';
-import { ClusterDefintion } from './types';
-/**
- * Returns the SSZ cluster config hash or the definition hash of the given cluster definition object
- * @param cluster The cluster whose config hash or definition hash needs to be calculated
- * @param configOnly A flag that indicates which hash to evaluate
- * @returns The config hash or he definition hash in of the corresponding cluster definition
- */
-export declare const clusterConfigOrDefinitionHash: (cluster: ClusterDefintion, configOnly: boolean) => string;
-export declare const hashClusterDefinitionV1X7: (cluster: ClusterDefintion, configOnly: boolean) => ValueOfFields<DefinitionFieldsV1X7>;
-/**
- * Converts a string to a Uint8Array
- * @param str The string to convert
- * @returns The converted Uint8Array
- */
-export declare const strToUint8Array: (str: string) => Uint8Array;
-/**
- * operatorContainerType is an SSZ Composite Container type for Operator.
- * Note that the type has fixed size for address as it is an ETH1 address (20 bytes).
- */
-declare const operatorAddressWrapperType: ContainerType<{
-    address: ByteVectorType;
-}>;
-declare const creatorAddressWrapperType: ContainerType<{
-    address: ByteVectorType;
-}>;
-export declare const operatorContainerType: ContainerType<{
-    address: ByteVectorType;
-    enr: ByteListType;
-    config_signature: ByteVectorType;
-    enr_signature: ByteVectorType;
-}>;
-export declare const creatorContainerType: ContainerType<{
-    address: ByteVectorType;
-    config_signature: ByteVectorType;
-}>;
-export declare const validatorsContainerType: ContainerType<{
-    fee_recipient_address: ByteVectorType;
-    withdrawal_address: ByteVectorType;
-}>;
-declare type DefinitionFieldsV1X7 = {
-    uuid: ByteListType;
-    name: ByteListType;
-    version: ByteListType;
-    timestamp: ByteListType;
-    num_validators: UintNumberType;
-    threshold: UintNumberType;
-    dkg_algorithm: ByteListType;
-    fork_version: ByteVectorType;
-    operators: ListCompositeType<typeof operatorContainerType | typeof operatorAddressWrapperType>;
-    creator: typeof creatorContainerType | typeof creatorAddressWrapperType;
-    validators: ListCompositeType<typeof validatorsContainerType>;
-    config_hash?: ByteVectorType;
-};
-export declare type DefinitionContainerTypeV1X7 = ContainerType<DefinitionFieldsV1X7>;
-/**
- * Returns the containerized cluster definition
- * @param cluster ClusterDefinition to calculate the type from
- * @returns SSZ Containerized type of cluster input
- */
-export declare const clusterDefinitionContainerTypeV1X7: (configOnly: boolean) => DefinitionContainerTypeV1X7;
-export {};
-//# sourceMappingURL=hash.d.ts.map
+import { ContainerType, ByteVectorType, UintNumberType, ListCompositeType, ByteListType } from '@chainsafe/ssz';
+import { ValueOfFields } from '@chainsafe/ssz/lib/view/container.js';
+import { ClusterDefintion, ClusterLock } from './types.js';
+/**
+ * @param cluster The cluster configuration or the cluster definition
+ * @param configOnly a boolean to indicate config hash or definition hash
+ * @returns The config hash or the definition hash in of the corresponding cluster
+ */
+export declare const clusterConfigOrDefinitionHash: (cluster: ClusterDefintion, configOnly: boolean) => string;
+export declare const hashClusterDefinition: (cluster: ClusterDefintion, configOnly: boolean) => ValueOfFields<DefinitionFields>;
+declare const operatorAddressWrapperType: ContainerType<{
+    address: ByteVectorType;
+}>;
+declare const creatorAddressWrapperType: ContainerType<{
+    address: ByteVectorType;
+}>;
+export declare const operatorContainerType: ContainerType<{
+    address: ByteVectorType;
+    enr: ByteListType;
+    config_signature: ByteVectorType;
+    enr_signature: ByteVectorType;
+}>;
+export declare const creatorContainerType: ContainerType<{
+    address: ByteVectorType;
+    config_signature: ByteVectorType;
+}>;
+export declare const validatorsContainerType: ContainerType<{
+    fee_recipient_address: ByteVectorType;
+    withdrawal_address: ByteVectorType;
+}>;
+type DefinitionFields = {
+    uuid: ByteListType;
+    name: ByteListType;
+    version: ByteListType;
+    timestamp: ByteListType;
+    num_validators: UintNumberType;
+    threshold: UintNumberType;
+    dkg_algorithm: ByteListType;
+    fork_version: ByteVectorType;
+    operators: ListCompositeType<typeof operatorContainerType | typeof operatorAddressWrapperType>;
+    creator: typeof creatorContainerType | typeof creatorAddressWrapperType;
+    validators: ListCompositeType<typeof validatorsContainerType>;
+    config_hash?: ByteVectorType;
+};
+export type DefinitionContainerType = ContainerType<DefinitionFields>;
+/**
+ * @param configOnly a boolean to indicate config hash or definition hash
+ * @returns SSZ Containerized type of cluster definition
+ */
+export declare const clusterDefinitionContainerType: (configOnly: boolean) => DefinitionContainerType;
+/**
+ * @param cluster The published cluster lock
+ * @returns The lock hash in of the corresponding cluster
+ */
+export declare const clusterLockHash: (cluster: ClusterLock) => string;
+export {};

package/dist/{index.d.ts → types/src/index.d.ts}

@@ -1,60 +1,64 @@
-import { Signer } from 'ethers';
-import { Base } from './base';
-import { ClusterDefintion, ClusterLock, ClusterPayload, OperatorPayload } from './types';
-export * from "./types";
-/**
- * Obol sdk Client can be used for creating, managing and activating distributed validators.
- */
-export declare class Client extends Base {
-    private signer;
-    /**
-     * @param config
-     * @param signer ethersJS Signer
-     * @returns Obol-SDK Client instance
-     *
-     * An example of how to instantiate obol-sdk Client:
-     * [obolClient](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts#L29)
-     */
-    constructor(config: {
-        baseUrl?: string | undefined;
-        chainId?: number | undefined;
-    }, signer?: Signer);
-    /**
-     * Creates a cluster definition which contains cluster configuration.
-     * @param {ClusterPayload} newCluster - The new unique cluster.
-     * @returns {Promise<string>} config_hash.
-     * @throws On duplicate entries, missing or wrong cluster keys.
-     *
-     * An example of how to use createClusterDefinition:
-     * [createObolCluster](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
-     */
-    createClusterDefinition(newCluster: ClusterPayload): Promise<string>;
-    /**
-    * Approves joining a cluster with specific configuration.
-    * @param {OperatorPayload} operatorPayload - The operator data including signatures.
-    * @param {string} configHash - The config hash of the cluster which the operator confirms joining to.
-    * @returns {Promise<ClusterDefintion>} The cluster definition.
-    * @throws On unauthorized, duplicate entries, missing keys, not found cluster or invalid data.
-    *
-    * An example of how to use updateClusterDefinition:
-    * [updateClusterDefinition](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
-    */
-    updateClusterDefinition(operatorPayload: OperatorPayload, configHash: string): Promise<ClusterDefintion>;
-    /**
-     * @returns {Promise<ClusterDefintion>} The  cluster definition for config hash
-     * @throws On not found config hash.
-     *
-     * An example of how to use getClusterDefinition:
-     * [getObolClusterDefinition](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
-     */
-    getClusterDefinition(configHash: string): Promise<ClusterDefintion>;
-    /**
-     * @returns {Promise<ClusterLock>} The matched cluster details (lock) from DB
-     * @throws On not found cluster definition or lock.
-     *
-     * An example of how to use getClusterLock:
-     * [getObolClusterLock](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
-     */
-    getClusterLock(configHash: string): Promise<ClusterLock>;
-}
-//# sourceMappingURL=index.d.ts.map
+import { Signer } from "ethers";
+import { Base } from './base.js';
+import { ClusterDefintion, ClusterLock, ClusterPayload, OperatorPayload } from './types.js';
+export * from "./types.js";
+export * from "./services.js";
+/**
+ * Obol sdk Client can be used for creating, managing and activating distributed validators.
+ */
+export declare class Client extends Base {
+    private signer;
+    /**
+     * @param config - Client configurations
+     * @param config.baseUrl - obol-api url
+     * @param config.chainId - Blockchain network ID
+     * @param signer - ethersJS Signer
+     * @returns Obol-SDK Client instance
+     *
+     * An example of how to instantiate obol-sdk Client:
+     * [obolClient](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts#L29)
+     */
+    constructor(config: {
+        baseUrl?: string | undefined;
+        chainId?: number | undefined;
+    }, signer?: Signer);
+    /**
+     * Creates a cluster definition which contains cluster configuration.
+     * @param {ClusterPayload} newCluster - The new unique cluster.
+     * @returns {Promise<string>} config_hash.
+     * @throws On duplicate entries, missing or wrong cluster keys.
+     *
+     * An example of how to use createClusterDefinition:
+     * [createObolCluster](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
+     */
+    createClusterDefinition(newCluster: ClusterPayload): Promise<string>;
+    /**
+    * Approves joining a cluster with specific configuration.
+    * @param {OperatorPayload} operatorPayload - The operator data including signatures.
+    * @param {string} configHash - The config hash of the cluster which the operator confirms joining to.
+    * @returns {Promise<ClusterDefintion>} The cluster definition.
+    * @throws On unauthorized, duplicate entries, missing keys, not found cluster or invalid data.
+    *
+    * An example of how to use acceptClusterDefinition:
+    * [acceptClusterDefinition](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
+    */
+    acceptClusterDefinition(operatorPayload: OperatorPayload, configHash: string): Promise<ClusterDefintion>;
+    /**
+     * @param configHash - The configuration hash returned in createClusterDefinition
+     * @returns {Promise<ClusterDefintion>} The  cluster definition for config hash
+     * @throws On not found config hash.
+     *
+     * An example of how to use getClusterDefinition:
+     * [getObolClusterDefinition](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
+     */
+    getClusterDefinition(configHash: string): Promise<ClusterDefintion>;
+    /**
+     * @param configHash - The configuration hash in cluster-definition
+     * @returns {Promise<ClusterLock>} The matched cluster details (lock) from DB
+     * @throws On not found cluster definition or lock.
+     *
+     * An example of how to use getClusterLock:
+     * [getObolClusterLock](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
+     */
+    getClusterLock(configHash: string): Promise<ClusterLock>;
+}

package/dist/{schema.d.ts → types/src/schema.d.ts}

@@ -1,58 +1,57 @@
-export declare const operatorPayloadSchema: {
-    type: string;
-    properties: {
-        version: {
-            type: string;
-        };
-        enr: {
-            type: string;
-        };
-    };
-    required: string[];
-};
-export declare const definitionSchema: {
-    type: string;
-    properties: {
-        name: {
-            type: string;
-        };
-        operators: {
-            type: string;
-            minItems: number;
-            uniqueItems: boolean;
-            items: {
-                type: string;
-                properties: {
-                    address: {
-                        type: string;
-                        minLength: number;
-                        maxLength: number;
-                    };
-                };
-                required: string[];
-            };
-        };
-        validators: {
-            type: string;
-            minItems: number;
-            items: {
-                type: string;
-                properties: {
-                    fee_recipient_address: {
-                        type: string;
-                        minLength: number;
-                        maxLength: number;
-                    };
-                    withdrawal_address: {
-                        type: string;
-                        minLength: number;
-                        maxLength: number;
-                    };
-                };
-                required: string[];
-            };
-        };
-    };
-    required: string[];
-};
-//# sourceMappingURL=schema.d.ts.map
+export declare const operatorPayloadSchema: {
+    type: string;
+    properties: {
+        version: {
+            type: string;
+        };
+        enr: {
+            type: string;
+        };
+    };
+    required: string[];
+};
+export declare const definitionSchema: {
+    type: string;
+    properties: {
+        name: {
+            type: string;
+        };
+        operators: {
+            type: string;
+            minItems: number;
+            uniqueItems: boolean;
+            items: {
+                type: string;
+                properties: {
+                    address: {
+                        type: string;
+                        minLength: number;
+                        maxLength: number;
+                    };
+                };
+                required: string[];
+            };
+        };
+        validators: {
+            type: string;
+            minItems: number;
+            items: {
+                type: string;
+                properties: {
+                    fee_recipient_address: {
+                        type: string;
+                        minLength: number;
+                        maxLength: number;
+                    };
+                    withdrawal_address: {
+                        type: string;
+                        minLength: number;
+                        maxLength: number;
+                    };
+                };
+                required: string[];
+            };
+        };
+    };
+    required: string[];
+};

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

@@ -0,0 +1,11 @@
+import { ClusterLock } from "./types.js";
+/**
+ * Verifies Cluster Lock's validity.
+ * @param lock - cluster lock
+ * @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 declare const validateClusterLock: (lock: ClusterLock) => Promise<boolean>;