@obolnetwork/obol-sdk 1.0.8 → 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,49 +1,64 @@
-import { Signer } from 'ethers';
-import { Base } from './base';
-import { ClusterDefintion, ClusterLock, ClusterPayload } 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>;
-    /**
-     * @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/types/src/schema.d.ts

@@ -0,0 +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[];
+};

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>;

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

@@ -1,150 +1,153 @@
-/**
- * Permitted ChainID's
- */
-export declare enum FORK_MAPPING {
-    /** Mainnet. */
-    "0x00000000" = 1,
-    /** Goerli/Prater. */
-    "0x00001020" = 5,
-    /** Gnosis Chain. */
-    "0x00000064" = 100,
-    /** Holesky. */
-    "0x01017000" = 17000
-}
-/**
- * Cluster Node Operator
- */
-export declare type ClusterOperator = {
-    /** The operator address. */
-    address: string;
-    /** The operator ethereum node record. */
-    enr?: string;
-    /** The cluster fork_version. */
-    fork_version?: string;
-    /** The cluster version. */
-    version?: string;
-    /** The operator enr signature. */
-    enr_signature?: string;
-    /** The operator configuration signature. */
-    config_signature?: string;
-};
-/**
- * Cluster Creator
- */
-export declare type ClusterCreator = {
-    /** The creator address. */
-    address: string;
-    /** The cluster configuration signature. */
-    config_signature?: string;
-};
-/**
- * Cluster Validator
- */
-export declare type ClusterValidator = {
-    /** The validator fee recipient address. */
-    fee_recipient_address: string;
-    /** The validator reward address. */
-    withdrawal_address: string;
-};
-/**
- * Cluster Required Configuration
- */
-export interface ClusterPayload {
-    /** The cluster name. */
-    name: string;
-    /** The cluster nodes operators addresses. */
-    operators: ClusterOperator[];
-    /** The clusters validators information. */
-    validators: ClusterValidator[];
-}
-/**
- * Cluster Definition
- */
-export interface ClusterDefintion extends ClusterPayload {
-    /** The creator of the cluster. */
-    creator: ClusterCreator;
-    /** The cluster configuration version. */
-    version: string;
-    /** The cluster dkg algorithm. */
-    dkg_algorithm: string;
-    /** The cluster fork version. */
-    fork_version: string;
-    /** The cluster uuid. */
-    uuid: string;
-    /** The cluster creation timestamp. */
-    timestamp: string;
-    /** The cluster configuration hash. */
-    config_hash: string;
-    /** The distributed validator threshold. */
-    threshold: number;
-    /** The number of distributed validators in the cluster. */
-    num_validators: number;
-    /** The hash of the cluster definition. */
-    definition_hash?: string;
-}
-/**
- * Unsigned DV Builder Registration Message
- */
-export declare type BuilderRegistrationMessage = {
-    /** The DV fee recipient. */
-    fee_recipient: string;
-    /** Default is 30000000. */
-    gas_limit: number;
-    /** Timestamp when generating cluster lock file. */
-    timestamp: number;
-    /** The public key of the DV. */
-    pubkey: string;
-};
-/**
- * Pre-generated Signed Validator Builder Registration
- */
-export declare type BuilderRegistration = {
-    /** Builder registration message. */
-    message: BuilderRegistrationMessage;
-    /** BLS signature of the builder registration message. */
-    signature: string;
-};
-/**
- * Deposit Data
- */
-export declare type DepositData = {
-    /** The public key of the distributed validator. */
-    pubkey: string;
-    /** The 0x01 withdrawal address of the DV. */
-    withdrawal_credentials: string;
-    /** 32 ethers. */
-    amount: string;
-    /** A checksum for DepositData fields . */
-    deposit_data_root: string;
-    /** BLS signature of the deposit message. */
-    signature: string;
-};
-/**
- * Distributed Validator
- */
-export declare type DistributedValidator = {
-    /** The public key of the distributed validator. */
-    distributed_public_key: string;
-    /** The public key of the node distributed validator share. */
-    public_shares: string[];
-    /** The required deposit data for activating the DV. */
-    deposit_data: Partial<DepositData>;
-    /** pre-generated signed validator builder registration to be sent to builder network. */
-    builder_registration: BuilderRegistration;
-};
-/**
- * Cluster Lock (Cluster Details after DKG is complete)
- */
-export interface ClusterLock {
-    /** The cluster definition. */
-    cluster_definition: ClusterDefintion;
-    /** The cluster distributed validators. */
-    distributed_validators: DistributedValidator[];
-    /** The cluster bls signature aggregate. */
-    signature_aggregate: string;
-    /** The hash of the cluster lock. */
-    lock_hash: string;
-    /** Node Signature for the lock hash by the node secp256k1 key. */
-    node_signatures: string[];
-}
-//# sourceMappingURL=types.d.ts.map
+/**
+ * Permitted ChainID's
+ */
+export declare enum FORK_MAPPING {
+    /** Mainnet. */
+    "0x00000000" = 1,
+    /** Goerli/Prater. */
+    "0x00001020" = 5,
+    /** Gnosis Chain. */
+    "0x00000064" = 100,
+    /** Holesky. */
+    "0x01017000" = 17000
+}
+/**
+ * Node operator data
+ */
+export type ClusterOperator = {
+    /** The operator address. */
+    address: string;
+    /** The operator ethereum node record. */
+    enr?: string;
+    /** The cluster fork_version. */
+    fork_version?: string;
+    /** The cluster version. */
+    version?: string;
+    /** The operator enr signature. */
+    enr_signature?: string;
+    /** The operator configuration signature. */
+    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'>>;
+/**
+ * Cluster creator data
+ */
+export type ClusterCreator = {
+    /** The creator address. */
+    address: string;
+    /** The cluster configuration signature. */
+    config_signature?: string;
+};
+/**
+ * Validator withdrawal configuration
+ */
+export type ClusterValidator = {
+    /** The validator fee recipient address. */
+    fee_recipient_address: string;
+    /** The validator reward address. */
+    withdrawal_address: string;
+};
+/**
+ * Cluster configuration
+ */
+export type ClusterPayload = {
+    /** The cluster name. */
+    name: string;
+    /** The cluster nodes operators addresses. */
+    operators: ClusterOperator[];
+    /** The clusters validators information. */
+    validators: ClusterValidator[];
+};
+/**
+ * Cluster definition data needed for dkg
+ */
+export interface ClusterDefintion extends ClusterPayload {
+    /** The creator of the cluster. */
+    creator: ClusterCreator;
+    /** The cluster configuration version. */
+    version: string;
+    /** The cluster dkg algorithm. */
+    dkg_algorithm: string;
+    /** The cluster fork version. */
+    fork_version: string;
+    /** The cluster uuid. */
+    uuid: string;
+    /** The cluster creation timestamp. */
+    timestamp: string;
+    /** The cluster configuration hash. */
+    config_hash: string;
+    /** The distributed validator threshold. */
+    threshold: number;
+    /** The number of distributed validators in the cluster. */
+    num_validators: number;
+    /** The hash of the cluster definition. */
+    definition_hash?: string;
+}
+/**
+ * Unsigned DV Builder Registration Message
+ */
+export type BuilderRegistrationMessage = {
+    /** The DV fee recipient. */
+    fee_recipient: string;
+    /** Default is 30000000. */
+    gas_limit: number;
+    /** Timestamp when generating cluster lock file. */
+    timestamp: number;
+    /** The public key of the DV. */
+    pubkey: string;
+};
+/**
+ * Pre-generated Signed Validator Builder Registration
+ */
+export type BuilderRegistration = {
+    /** Builder registration message. */
+    message: BuilderRegistrationMessage;
+    /** BLS signature of the builder registration message. */
+    signature: string;
+};
+/**
+ * Required deposit data for validator activation
+ */
+export type DepositData = {
+    /** The public key of the distributed validator. */
+    pubkey: string;
+    /** The 0x01 withdrawal address of the DV. */
+    withdrawal_credentials: string;
+    /** 32 ethers. */
+    amount: string;
+    /** A checksum for DepositData fields . */
+    deposit_data_root: string;
+    /** BLS signature of the deposit message. */
+    signature: string;
+};
+/**
+ * Required deposit data for validator activation
+ */
+export type DistributedValidator = {
+    /** The public key of the distributed validator. */
+    distributed_public_key: string;
+    /** The public key of the node distributed validator share. */
+    public_shares: string[];
+    /** The required deposit data for activating the DV. */
+    deposit_data: Partial<DepositData>;
+    /** pre-generated signed validator builder registration to be sent to builder network. */
+    builder_registration: BuilderRegistration;
+};
+/**
+ * Cluster Details after DKG is complete
+ */
+export type ClusterLock = {
+    /** The cluster definition. */
+    cluster_definition: ClusterDefintion;
+    /** The cluster distributed validators. */
+    distributed_validators: DistributedValidator[];
+    /** The cluster bls signature aggregate. */
+    signature_aggregate: string;
+    /** The hash of the cluster lock. */
+    lock_hash: string;
+    /** Node Signature for the lock hash by the node secp256k1 key. */
+    node_signatures: string[];
+};

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

@@ -0,0 +1,2 @@
+export declare const hexWithout0x: (hex: string) => string;
+export declare const strToUint8Array: (str: string) => Uint8Array;

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

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+import { ClusterLock } from "./types.js";
+export declare const signingRoot: (domain: Uint8Array, messageBuffer: Buffer) => Uint8Array;
+export declare const isValidClusterLock: (clusterLock: ClusterLock) => Promise<boolean>;