Skip to main content
Version: v0.19.1

Client

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

Extends

  • Base

Constructors

new Client(config, signer)

new Client(config, signer?): Client

Parameters

ParameterTypeDescription
configObject
config.baseUrl?string-
config.chainId?number-
signer?SignerethersJS Signer

Returns

Client

Obol-SDK Client instance

An example of how to instantiate obol-sdk Client: obolClient

Overrides

Base.constructor

Source

index.ts:27

Properties

PropertyModifierTypeInherited from
baseUrlpublicstringBase.baseUrl
chainIdpublicnumberBase.chainId
fork_versionpublicstringBase.fork_version
signerprivateundefined | Signer-

Methods

createClusterDefinition()

createClusterDefinition(newCluster): Promise< string >

Creates a cluster definition which contains cluster configuration.

Parameters

ParameterTypeDescription
newClusterClusterPayloadThe 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

Source

index.ts:42


getClusterDefinition()

getClusterDefinition(configHash): Promise< ClusterDefintion >

Parameters

ParameterType
configHashstring

Returns

Promise< ClusterDefintion >

The cluster definition for config hash

Throws

On not found config hash.

An example of how to use getClusterDefinition: getObolClusterDefinition

Source

index.ts:132


getClusterLock()

getClusterLock(configHash): Promise< ClusterLock >

Parameters

ParameterType
configHashstring

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

Source

index.ts:148


request()

protected request< T>(endpoint, options?): Promise< T >

Type parameters

Type parameter
T

Parameters

ParameterType
endpointstring
options?RequestInit

Returns

Promise< T >

Inherited from

Base.request

Source

base.ts:23


updateClusterDefinition()

updateClusterDefinition(operatorPayload, configHash): Promise< ClusterDefintion >

Approves joining a cluster with specific configuration.

Parameters

ParameterTypeDescription
operatorPayloadOperatorPayloadThe operator data including signatures.
configHashstringThe 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

Source

index.ts:93