Client
Last updated
Version-v1.4.0 (current)
Last updated
Obol sdk Client can be used for creating, managing and activating distributed validators.
Base
new Client(
config,signer?):
Parameters
config
object
Client configurations
config.baseUrl?
string
obol-api url
config.chainId?
number
Blockchain network ID
signer?
Signer
ethersJS Signer
Returns
Obol-SDK Client instance
An example of how to instantiate obol-sdk Client:
Overrides
Base.constructor
Defined in
index.ts:66
acceptObolLatestTermsAndConditions():
Promise<string>
Accepts Obol terms and conditions to be able to create or update data.
Returns
Promise<string>
terms and conditions acceptance success message.
Throws
On unverified signature or wrong hash.
Defined in
index.ts:79
Deploys OWR and Splitter Proxy.
Parameters
rewardsSplitPayload
Data needed to deploy owr and splitter.
Returns
owr address as withdrawal address and splitter as fee recipient
Remarks
⚠️ Important: If you're storing the private key in an .env file, ensure it is securely managed and not pushed to version control.
Defined in
index.ts:133
Deploys Splitter Proxy.
Parameters
totalSplitPayload
Data needed to deploy splitter if it doesnt exist.
Returns
splitter address as withdrawal address and splitter as fee recipient too
Remarks
⚠️ Important: If you're storing the private key in an .env file, ensure it is securely managed and not pushed to version control.
Defined in
index.ts:254
createClusterDefinition(
newCluster):Promise<string>
Creates a cluster definition which contains cluster configuration.
Parameters
newCluster
The new unique cluster.
Returns
Promise<string>
config_hash.
Throws
On duplicate entries, missing or wrong cluster keys.
Defined in
index.ts:350
Approves joining a cluster with specific configuration.
Parameters
operatorPayload
The operator data including signatures.
configHash
string
The config hash of the cluster which the operator confirms joining to.
Returns
The cluster definition.
Throws
On unauthorized, duplicate entries, missing keys, not found cluster or invalid data.
Defined in
index.ts:415
Parameters
configHash
string
The configuration hash returned in createClusterDefinition
Returns
The cluster definition for config hash
Throws
On not found config hash.
Defined in
index.ts:469
Parameters
configHash
string
The configuration hash in cluster-definition
Returns
The matched cluster details (lock) from DB
Throws
On not found cluster definition or lock.
Defined in
index.ts:488
An example of how to use acceptObolLatestTermsAndConditions:
createObolRewardsSplit(rewardsSplitPayload): Promise<>
Promise<>
An example of how to use createObolRewardsSplit:
createObolTotalSplit(totalSplitPayload): Promise<>
Promise<>
An example of how to use createObolTotalSplit:
An example of how to use createClusterDefinition:
acceptClusterDefinition(operatorPayload, configHash): Promise<>
Promise<>
An example of how to use acceptClusterDefinition:
getClusterDefinition(configHash): Promise<>
Promise<>
An example of how to use getClusterDefinition:
getClusterLock(configHash): Promise<>
Promise<>
An example of how to use getClusterLock: