Class Client

Obol sdk Client can be used for creating, managing and activating distributed validators.

Hierarchy

Base
- Client

Index

Constructors

Methods

createClusterDefinition getClusterDefinition getClusterLock updateClusterDefinition

Constructors

constructor

new Client(config, signer?): Client
Parameters
- config: {
  baseUrl?: string;
  chainId?: number;
  }
  - Optional baseUrl?: string
  - Optional chainId?: number
- Optional signer: Signer
  
  ethersJS Signer
Returns Client
Obol-SDK Client instance

An example of how to instantiate obol-sdk Client: obolClient
Overrides Base.constructor
- Defined in index.ts:27

Methods

createClusterDefinition

createClusterDefinition(newCluster): Promise<string>
Creates a cluster definition which contains cluster configuration.
Parameters
- newCluster: ClusterPayload
  
  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
- Defined in index.ts:42

getClusterDefinition

getClusterDefinition(configHash): Promise<ClusterDefintion>
Parameters
- configHash: string
Returns Promise<ClusterDefintion>
The cluster definition for config hash

Throws
On not found config hash.

An example of how to use getClusterDefinition: getObolClusterDefinition
- Defined in index.ts:132

getClusterLock

getClusterLock(configHash): Promise<ClusterLock>
Parameters
- configHash: string
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
- Defined in index.ts:148

updateClusterDefinition

updateClusterDefinition(operatorPayload, configHash): Promise<ClusterDefintion>
Approves joining a cluster with specific configuration.
Parameters
- operatorPayload: OperatorPayload
  
  The operator data including signatures.
- configHash: string
  
  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
- Defined in index.ts:93

Generated using TypeDoc