Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hanan/activate validators #267

Merged
merged 5 commits into from
Oct 12, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 49 additions & 20 deletions docs/int/quickstart/advanced/quickstart-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem';
The Obol-SDK is in an alpha state and should be used with caution.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The Obol-SDK is in an alpha state and should be used with caution.
The Obol-SDK is in an alpha state and should be used with caution, particularly on mainnet.

:::

This is a walkthrough of using the [Obol-SDK](https://www.npmjs.com/package/@obolnetwork/obol-sdk) to propose a four-node distributed validator cluster for creation using the [DV Launchpad](../../../dvl/intro.md).
This is a walkthrough of using the [Obol-SDK](https://www.npmjs.com/package/@obolnetwork/obol-sdk) to propose a four-node distributed validator cluster for creation using the [DV Launchpad](../../../dvl/intro.md).

## Pre-requisites

Expand Down Expand Up @@ -43,7 +43,6 @@ The first thing you need to do is create a instance of the Obol SDK client. The
- The `chainID` for the chain you intend to use.
- An ethers.js [signer](https://docs.ethers.org/v6/api/providers/#Signer-signTypedData) object.


```ts
import { Client } from "@obolnetwork/obol-sdk";
import { ethers } from "ethers";
Expand All @@ -54,8 +53,8 @@ const privateKey = ethers.Wallet.fromPhrase(mnemonic).privateKey;
const wallet = new ethers.Wallet(privateKey);
const signer = wallet.connect(null);

// Instantiate the Obol Client for goerli
const obol = new Client({chainId: 5}, signer);
// Instantiate the Obol Client for goerli
const obol = new Client({ chainId: 5 }, signer);
```

## Propose the cluster
Expand All @@ -66,20 +65,23 @@ List the Ethereum addresses of participating operators, along with withdrawal an
// A config hash is a deterministic hash of the proposed DV cluster configuration
const configHash = await obol.createClusterDefinition({
name: "SDK Demo Cluster",
operators:
[
{ address: "0xC35CfCd67b9C27345a54EDEcC1033F2284148c81" },
{ address: "0x33807D6F1DCe44b9C599fFE03640762A6F08C496" },
{ address: "0xc6e76F72Ea672FAe05C357157CfC37720F0aF26f" },
{ address: "0x86B8145c98e5BD25BA722645b15eD65f024a87EC" }
],
validators: [{
fee_recipient_address: "0x3CD4958e76C317abcEA19faDd076348808424F99",
withdrawal_address: "0xE0C5ceA4D3869F156717C66E188Ae81C80914a6e"
}],
operators: [
{ address: "0xC35CfCd67b9C27345a54EDEcC1033F2284148c81" },
{ address: "0x33807D6F1DCe44b9C599fFE03640762A6F08C496" },
{ address: "0xc6e76F72Ea672FAe05C357157CfC37720F0aF26f" },
{ address: "0x86B8145c98e5BD25BA722645b15eD65f024a87EC" },
],
validators: [
{
fee_recipient_address: "0x3CD4958e76C317abcEA19faDd076348808424F99",
withdrawal_address: "0xE0C5ceA4D3869F156717C66E188Ae81C80914a6e",
},
],
});

console.log(`Direct the operators to https://goerli.launchpad.obol.tech/dv?configHash=${configHash} to complete the key generation process`)
console.log(
`Direct the operators to https://goerli.launchpad.obol.tech/dv?configHash=${configHash} to complete the key generation process`
);
```

## Invite the Operators to complete the DKG
Expand All @@ -88,21 +90,48 @@ Once the Obol-API returns a `configHash` string from the `createClusterDefinitio

1. Operators navigate to `https://<NETWORK_NAME_HERE>.launchpad.obol.tech/dv?configHash=<CONFIG_HASH_HERE>` and complete the [run a DV with others](../group/quickstart-group-operator.md) flow.
1. Once the DKG is complete, and operators are using the `--publish` flag, the created cluster details will be posted to the Obol API
1. The creator will be able to retrieve this data with `obol.getClusterLock(configHash)`, to use for activating the newly created validator.
1. The creator will be able to retrieve this data with `obol.getClusterLock(configHash)`, to use for activating the newly created validator.

## Retrieve the created Distributed Validators using the SDK

Once the DKG is complete, the proposer of the cluster can retrieve key data such as the validator public keys and their associated deposit data messages.
Once the DKG is complete, the proposer of the cluster can retrieve key data such as the validator public keys and their associated deposit data messages.

```js
const clusterLock = await obol.getClusterLock(configHash);
```

Reference lock files can be found [here](https://github.com/ObolNetwork/charon/tree/main/cluster/testdata).
Reference lock files can be found [here](https://github.com/ObolNetwork/charon/tree/main/cluster/testdata).

## Activate the DVs using the deposit contract

This guide will in future cover activating the deposit data from a lock file.
In order to activate cluster validator, the cluster operator can retrieve the validator associated deposit data and call deposit from the deposit contract.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In order to activate cluster validator, the cluster operator can retrieve the validator associated deposit data and call deposit from the deposit contract.
In order to activate the distributed validators, the cluster operator can retrieve the validators' associated deposit data from the lock file and use it to craft transactions to the `deposit()` method on the deposit contract.


```js
const WEI_FACTOR = 10 ** 18;

const validatorDepositData =
clusterLock.distributed_validators[validatorIndex].deposit_data;

const depositContract = new ethers.Contract(
DEPOSIT_CONTRACT_ADDRESS, // 0x00000000219ab540356cBB839Cbe05303d7705Fa for Mainnet, 0xff50ed3d0ec03aC01D4C79aAd74928BFF48a7b2b for Goerli
depositContractABI, // https://etherscan.io/address/0x00000000219ab540356cBB839Cbe05303d7705Fa#code for Mainnet, and replace the address for Goerli
signer
);

const principal = BigNumber.from(validatorDepositData.amount); // 32 ethers

const TX_VALUE = principal.mul(WEI_FACTOR);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you tested this? I would have thought principal coming from our API ends up being "32000000000". So multiplying by a further 18 decimals leads to too many decimals and too high a value?

I would imagine we multiply by 10 ** 9 to get the outcome we want.

Here's a calculator to help test https://eth-converter.com/

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right. Fixing it


const tx = await depositContract.deposit(
validatorDepositData.pubkey,
validatorDepositData.withdrawal_credentials,
validatorDepositData.signature,
validatorDepositData.deposit_data_root,
{ value: TX_VALUE }
);

const txResult = await tx.wait();
```

## Usage Examples

Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,8 @@ const config = {
position: 'left',
label: 'API',
},
{ to: "https://blog.obol.tech", label: "Blog", position: "left" },
{ to: "https://obolnetwork.github.io/obol-packages", label: "SDK", position: "left" },
{ to: "https://blog.obol.tech", label: "Blog", position: "left" },
{
href: "https://github.com/obolnetwork/obol-docs",
label: "GitHub",
Expand Down
Loading