diff --git a/docs/developers/README.md b/docs/developers/README.md index f3aeeda..d323e7e 100644 --- a/docs/developers/README.md +++ b/docs/developers/README.md @@ -1,47 +1,406 @@ --- -sidebar_label: 'Developers' +sidebar_label: 'Quickstart' sidebar_position: 1 --- -# Developers +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; -SSV is a permissionless network that enables the distribution of validator operations between non-trusting operators. +# Quickstart -![Get Started](/img/get-started-1.avif) +SSV is a permissionless network that enables the distribution of validator operations between non-trusting operators. If you're new to SSV network, go through [the Learn section](/learn/introduction/) to understand its core concepts first. -## How to integrate with SSV +This guide explains how to generate validator keys, split them into key shares, and register them on the Hoodi testnet via the SSV-SDK. -Eager to jump into action? [Quickstart](/developers/quickstart.md) is a great place to start and automate bulk validator registration using our SDK. +### Introduction -If you're new to ssv network, go through [the Learn section](/learn/introduction/) to understand its core concepts first. +Before getting started, review the following list of essential items for integrating with SSV: +- [Quickstart guide below](#overview) shows how to automate bulk validator registration. +- You can also find several [other Guides](/developers/SSV-SDK/examples/) in the respective section. +- On-chain data is made available via [Subgraph](/developers/tools/ssv-subgraph/) and the [SSV API](/developers/tools/ssv-api) (e.g. operator metadata). +- We recommend integrating with SSV by using [the SDK](/developers/SSV-SDK/). You can better understand how it is structured with [SSV SDK Module Reference](/developers/SSV-SDK/module-reference/). +- Lastly, you can start experimenting by interacting with [our Hoodi Testnet](/developers/testnet) smart contracts, before interacting [with the Mainnet ones](/developers/smart-contracts/README.md). -The best way to get started with SSV is using [the SDK](/developers/SSV-SDK/), which allows developers to perform transactions to the smart contract, and access Subgraph data, via simple, high level functions. [SSV SDK Module Reference](/developers/SSV-SDK/module-reference/) can help you understand how it is structured. It might also be helpful to look at [several examples](/developers/SSV-SDK/examples/) of how to use the SSV SDK. +### Overview -[SSV Network smart contract](./smart-contracts/ssvnetwork.md) allows stakers and operators to coordinate in a permissionless way. +The steps you will need to take: +1. [Installation](#1-installation) +2. [Select operators and collect their data](#2-select-operators-and-collect-their-data) +3. [Split your validator keys to shares](#3-split-validator-keys) +4. [Register your validators to the SSV network](#4-register-validators) -On-chain data generated by the smart contract is made available via [Subgraph](./tools/ssv-subgraph/) and the [SSV API](https://api.ssv.network/documentation/#/v4) (for things like operator metadata). +There is also [Full code example](#full-code-example) by the end of this page. -Lastly, you can start experimenting by interacting with [our Hoodi Testnet](/developers/testnet) smart contracts, before interacting with Mainnet ones. +:::note Prerequisite +This tutorial assumes you already have keystores generated, or will use the [*code illustrated here*](/developers/SSV-SDK/examples/create-validator-keys) to generate them pragmatically. +::: +### **1. Installation** -## Tools and Resources +#### Install +```bash +npm i @ssv-labs/ssv-sdk fs path web3 viem +``` -### [SSV SDK](/developers/SSV-SDK/) +#### Import -A comprehensive, open-source developer toolkit that can be used to programmatically write scripts for tasks such as [operator management](/developers/SSV-SDK/module-reference/operator-module), [keyshare generation](/developers/tools/ssv-dkg-client/generate-key-shares), and [bulk validator registration](/developers/quickstart.md). +```typescript +import { SSVSDK, chains } from '@ssv-labs/ssv-sdk' +import { parseEther, createPublicClient, createWalletClient, http } from 'viem' +import { privateKeyToAccount } from 'viem/accounts' +``` -### [Smart Contracts](smart-contracts/) +#### Instantiation -The SSV Network and SSV Read contract handle all of the on-chain data regarding SSV. +To instantiate the SDK, provide a number of parameters: -### [DKG Client](tools/ssv-dkg-client/) +| Parameter | Description | +| --------------- | --------------------------------------- | +| `public_client` | Public client object created using viem | +| `wallet_client` | Wallet object created using viem | -Securely generate keyshares for a validator and distribute them to operators without the full key ever being stored. +You can use these like so to instantiate the SDK and store it an object: -### [Subgraph](tools/ssv-subgraph/) +```typescript +// Setup viem clients +const chain = chains.hoodi as any // or chains.mainnet +const transport = http() -All data about the SSV Network is stored here, accessible through straightforward and user-friendly API calls. +const publicClient = createPublicClient({ + chain, + transport, +}) as any -### [SSV API](https://api.ssv.network/documentation/#/v4) +const account = privateKeyToAccount('0x...') +const walletClient = createWalletClient({ + account, + chain, + transport, +}) as any -A set of calls to get information about the SSV network. \ No newline at end of file +// Initialize SDK with viem clients +const sdk = new SSVSDK({ + publicClient, + walletClient, +}) +``` + +### **2. Select operators and collect their data** +A cluster can have 4, 7, 10, or 13 operators. If you already know the operator IDs you can proceed to any of the 3 options below to get their data. + +If you need to choose operators, feel free to browse [SSV Explorer](https://explorer.ssv.network/operators) to find the operators you will add to your cluster. Then proceed to the steps below. Please note, some of the operators are Private and only allow specific whitelisted addresses to onboard validators to them. + + + + To generate keyshares, operator IDs and their public keys are needed. You can collect keys of each operator using [SSV Subgraph](/developers/tools/ssv-subgraph). You will need to create own Graph API key and use endpoint with it. + + Alternatively, you can do it using [The Graph UI](https://thegraph.com/explorer/subgraphs/F4AU5vPCuKfHvnLsusibxJEiTN7ELCoYTvnzg3YHGYbh?view=Query&chain=arbitrum-one). + + An example of how Hoodi Subgraph can fetch the operator data is below. The code snippet considers you have environment variables (`SUBGRAPH_API_KEY` and `OPERATOR_IDS`) in an `.env` file: + ```typescript + const operatorIDs = JSON.parse(process.env.OPERATOR_IDS) + const url = "https://gateway.thegraph.com/api/subgraphs/id/F4AU5vPCuKfHvnLsusibxJEiTN7ELCoYTvnzg3YHGYbh"; + const query = ` + query OperatorData($operatorIDs: [Bytes!]) { + operators(where: {id_in: $operatorIDs}) { + id + publicKey + } + }` + + const variables = { operatorIDs: operatorIDs } + const response = await fetch(url, { + method: 'POST', + headers: { + 'Content-Type': 'application/json', + 'Authorization': `Bearer ${process.env.SUBGRAPH_API_KEY}` + }, + body: JSON.stringify({ query, variables }) + }); + + const responseData: any = await response.json(); + const web3 = new Web3(); + const operators: { id: string; publicKey: string }[] = responseData.data.operators.map((operator: any) => {return { + id: operator.id, + publicKey: web3.eth.abi.decodeParameter("string", operator.publicKey) + }}) + ``` + + + To generate keyshares, operator IDs and their public keys are needed. This can also be done with [SSV Explorer](https://explorer.ssv.network/operators). + + On each operator's page, there is a 🗝️ sign next to operator's name. Click on the key sign and their public key will be copied. Repeat the process for each operator you chose. + + + Operator public key can be collected using our API once you know the ID. Use [this request type](https://api.ssv.network/documentation/#/Operators/OperatorsV4Controller_getOperator) to get the data. You only need to set the network and operator ID. + +```bash +curl -X 'GET' \ + 'https://api.ssv.network/api/v4/hoodi/operators/1' \ + -H 'accept: */*' +``` + +From the response you will need `id` and `public_key` contents: +```json +{ + "id": 1, + "id_str": "1", + "declared_fee": "0", + "previous_fee": "0", + "fee": "382640000000", + "public_key": "LS0tLS1CRUdJTiBSU0EgUFVCTElDIEtFWS0tLS0tCk1JSUJJakFOQmdrcWhraUc5dzBCQVFFRkFBT0NBUThBTUlJQkNnS0NBUUVBeVpGNUR2M2UwSkEzT25TSGwyQmMKNGFxbmpUTWFrUXNZSkY5eE55M21CVTZSQld1d2xVd1dIelJGWUFvb0FlRER3NlYxL3hRQ0JFaWJwTGx1RVdLTgoxNmRpcU5EVmY5VEZndmZlM2NHc3pNcDZCUE04bWhBdkx0c01DcHlXeDZtTEczVm0zVVRNK3hRdUJwVFZsdHNNCkV6eUZEZzNWTlphOW9hZkswbkVYRHVidlBIbkJCdWhlUW5LZThoUkJnRUo0emIrV3dncjFrM3YyWmkwTEtWNUQKYWd3c2QxK25Lb1grVktjYmJFVFBEdGRPV1AvZlpXM3dBMGp3R1pSdkhwNS8xUjBmZy91N01BUk1KTkRWVFYxQwo0Vlh1eHJkbHZWQ2JiS1pnWUIzY1ROSEMzZkVldit0NFVEeFJuQzdUcUN0WFZSYnpZQ001WHVSeUFRa3BiYU0wCjlRSURBUUFCCi0tLS0tRU5EIFJTQSBQVUJMSUMgS0VZLS0tLS0K", + "owner_address": "0x3187a42658417a4d60866163A4534Ce00D40C0C8", + "address_whitelist": "0x5E33db0b37622F7E6b2f0654aA7B985D854EA9Cb", + "whitelist_addresses": [ + "0x5E33db0b37622F7E6b2f0654aA7B985D854EA9Cb" + ], + "is_private": true, + "whitelisting_contract": "", + "location": "United States of America", + "setup_provider": "AWS", + "eth1_node_client": "Geth", + "eth2_node_client": "Prysm", + "mev_relays": "", + "description": "", + "website_url": "", + "twitter_url": "", + "linkedin_url": "", + "dkg_address": "", + "logo": "https://media-v2.ssv.network/operator_1_v4_mainnet_ssvBlack.png", + "type": "operator", + "name": "SSV Labs", + "performance": { + "24h": 100, + "30d": 99.86798961841079 + }, + "is_valid": true, + "is_deleted": false, + "is_active": 1, + "status": "Active", + "validators_count": 143, + "version": "v4", + "network": "mainnet" +} +``` + + + +Pass the collected operator info into ```generateKeyShares``` function in the code below. + +### **3. Split validator keys** +Use the collected data and your keystore to generate the keyshare transaction payload. + +The code snippet below considers you have environment variables (`KEYSTORE_PASSWORD` and `OWNER_ADDRESS`) in an `.env` file. Also, `nonce` is being handled automatically in the [full code example](#full-code-example): + +```typescript +const keysharesPayload = await sdk.utils.generateKeyShares({ + keystore: keystoreValues, + keystore_password: process.env.KEYSTORE_PASSWORD, + operator_keys: operators.map((operator: { id: string; publicKey: string }) => operator.publicKey), + operator_ids: operators.map((operator: { id: string; publicKey: string }) => Number(operator.id)), + owner_address: process.env.OWNER_ADDRESS, + nonce: nonce, +}) +``` + +### **4. Register validators** +Then finally the `registerValidators` function can be called and return the transaction receipt: + +Register your validators to the SSV network is performed on completion of this function, when the transaction is processed successfully. + +```typescript +const txn_receipt = await sdk.clusters.registerValidators({ + args: { + keyshares: keysharesPayload, + depositAmount: parseEther('30') + }, + }).then(tx => tx.wait()) +console.log("txn_receipt: ", txn_receipt) +``` + +For validator [registration transaction](/developers/smart-contracts/ssvnetwork#bulkregistervalidatorpublickey-operatorids-shares-cluster) you need to provide the cluster’s latest snapshot data and the user nonce. Fortunately, SSV SDK retrieves this data automatically, so you don't have to. + +### Full code example + +This example assumes you already have a number of keystore files and they are stored, under whatever is set for `KEYSTORE_FILE_DIRECTORY` in the `.env` file. + +**`.env` example file for the below script:** + +```sh +PRIVATE_KEY=0xYOUR_PRIVATE_KEY +OWNER_ADDRESS=0xA4831B989972605A62141a667578d742927Cbef9 +KEYSTORE_PASSWORD=test1234 +KEYSTORE_FILE_DIRECTORY=./validator_keys +DEPOSIT_AMOUNT=0.1234 +OPERATOR_IDS='["1", "2", "3", "4"]' +SUBGRAPH_API_KEY=GRAPH_API_KEY +``` + +```typescript +import { SSVSDK, chains } from '@ssv-labs/ssv-sdk' +import { parseEther, createPublicClient, createWalletClient, http } from 'viem' +import { privateKeyToAccount } from 'viem/accounts' +import * as dotenv from 'dotenv'; +import * as fs from 'fs'; +import * as path from 'path'; +import Web3 from 'web3'; + +dotenv.config(); + +async function main(): Promise { + + if (!process.env.KEYSTORE_FILE_DIRECTORY || + !process.env.OWNER_ADDRESS || + !process.env.KEYSTORE_PASSWORD || + !process.env.OPERATOR_IDS || + !process.env.SUBGRAPH_API_KEY || + !process.env.DEPOSIT_AMOUNT) { + throw new Error('Required environment variables are not set'); + } + + const private_key: `0x${string}` = process.env.PRIVATE_KEY as `0x${string}`; + + // Setup viem clients + const chain = chains.hoodi as any // or chains.mainnet + const transport = http() + + const publicClient = createPublicClient({ + chain, + transport + }) as any + + const account = privateKeyToAccount(private_key as `0x${string}`) + const walletClient = createWalletClient({ + account, + chain, + transport, + }) as any + + // Initialize SDK with viem clients + const sdk = new SSVSDK({ + publicClient, + walletClient, + }) + + const directoryPath = process.env.KEYSTORE_FILE_DIRECTORY; + let keystoresArray: { name: string; keystore: any }[]; + try { + keystoresArray = await loadKeystores(directoryPath); + console.log('Loaded keystores: Keystore Amount: ', keystoresArray.length); + } catch (error) { + console.error('Failed to load keystores:', error); + throw error; // If keystores can't be loaded the code will exit + } + + // keystoresArray is defined at this point + let nonce = Number(await sdk.api.getOwnerNonce({ owner: process.env.OWNER_ADDRESS })) + console.log("Initial nonce: ", nonce) + + const operatorIDs = JSON.parse(process.env.OPERATOR_IDS) + const url = "https://gateway.thegraph.com/api/subgraphs/id/F4AU5vPCuKfHvnLsusibxJEiTN7ELCoYTvnzg3YHGYbh"; + const query = ` + query OperatorData($operatorIDs: [Bytes!]) { + operators(where: {id_in: $operatorIDs}) { + id + publicKey + } + }` + + const variables = { operatorIDs: operatorIDs } + const response = await fetch(url, { + method: 'POST', + headers: { + 'Content-Type': 'application/json', + 'Authorization': `Bearer ${process.env.SUBGRAPH_API_KEY}` + }, + body: JSON.stringify({ query, variables }) + }); + + const responseData: any = await response.json(); + const web3 = new Web3(); + const operators: { id: string; publicKey: string }[] = responseData.data.operators.map((operator: any) => {return { + id: operator.id, + publicKey: web3.eth.abi.decodeParameter("string", operator.publicKey) + }}) + + console.log(operators.map((operator: { id: string; publicKey: string }) => operator.publicKey)) + console.log(operators.map((operator: { id: string; publicKey: string }) => Number(operator.id))) + + const chunkSize = 40; // Number of validators per transaction + for (let i = 0; i < keystoresArray.length; i += chunkSize) { + const chunk = keystoresArray.slice(i, i + chunkSize); + + const keystoreValues = chunk.map(item => item.keystore); + + const keysharesPayload = await sdk.utils.generateKeyShares({ + keystore: keystoreValues, + keystore_password: process.env.KEYSTORE_PASSWORD, + operator_keys: operators.map((operator: { id: string; publicKey: string }) => operator.publicKey), + operator_ids: operators.map((operator: { id: string; publicKey: string }) => Number(operator.id)), + owner_address: process.env.OWNER_ADDRESS, + nonce: nonce, + }) + + nonce = nonce + Number(chunk.length) + console.log("New nonce: ", nonce) + // Optional: to validate generated Keyshares you can use sdk.utils.validateSharesPreRegistration + + let txn_receipt + try { + console.log(`Processing chunk from index ${i} to ${i + chunk.length - 1}`); + txn_receipt = await sdk.clusters.registerValidators({ + args: { + keyshares: keysharesPayload, + depositAmount: parseEther(process.env.DEPOSIT_AMOUNT) + }, + }).then(tx => tx.wait()) + console.log("txn_receipt: ", txn_receipt) + } catch (error) { + logErrorToFile(error); + console.log("Failed to do register: ", error) + } + } +} + +async function loadKeystores(directory: string): Promise<{ name: string; keystore: any }[]> { + const keystoresArray: { name: string; keystore: any }[] = []; + + try { + const files = await fs.promises.readdir(directory); + + for (const file of files) { + if (file.startsWith('keystore-m') && file.endsWith('.json')) { + const filePath = path.join(directory, file); + + const fileContent = await fs.promises.readFile(filePath, 'utf-8'); + const jsonContent = JSON.parse(fileContent); + keystoresArray.push({ name: file, keystore: jsonContent }); + } + } + + return keystoresArray; + } catch (error) { + console.error('Error loading keystores:', error); + throw error; + } +} + +function logErrorToFile(error: unknown): void { + const errorMessage = `Failed to do register: ${error instanceof Error ? error.message : String(error)}\n`; + + // Log the error to the console + console.log(errorMessage); + + // Save the error message to a local file + const filePath = './error-log.txt'; + fs.appendFile(filePath, errorMessage, (err) => { + if (err) { + console.error("Failed to write to file: ", err); + } else { + console.log(`Error saved to file: ${filePath}`); + } + }); +} + +main(); +``` diff --git a/docs/developers/SSV-SDK/README.md b/docs/developers/SSV-SDK/README.md index 08257b8..ef0ef5d 100644 --- a/docs/developers/SSV-SDK/README.md +++ b/docs/developers/SSV-SDK/README.md @@ -4,13 +4,7 @@ sidebar_position: 3 # SSV SDK -:::warning -Development Notice: This SDK is currently under active development and testing. It is not recommended for production use at this time. - -This section and SDK are a work in progress and will be continuously updated as new components of the SDK are released. -::: - -The SSV SDK is a comprehensive, open-source developer toolkit written in TypeScript, designed to empower developers to seamlessly interact with the SSV Network programmatically. +The SSV SDK is a comprehensive, open-source developer toolkit written in TypeScript, designed to empower developers to seamlessly interact with the SSV Network programmatically. It consolidates all necessary tooling into a single, cohesive package. diff --git a/docs/developers/SSV-SDK/examples/README.md b/docs/developers/SSV-SDK/examples/README.md index 246bc5a..2bbe466 100644 --- a/docs/developers/SSV-SDK/examples/README.md +++ b/docs/developers/SSV-SDK/examples/README.md @@ -4,6 +4,6 @@ sidebar_position: 2 # Examples -In this examples section we will provide quick snippets of code to do certain actions, we will not show the imports/setup for each as this is covered previously. +In this examples section we will provide quick snippets of code to do certain actions, we will not show the imports/setup for each as this is covered previously. Each example will also be available in an executable typescript file found in the SDK repo. diff --git a/docs/developers/SSV-SDK/examples/api-calls.md b/docs/developers/SSV-SDK/examples/api-calls.md index 698a700..451daff 100644 --- a/docs/developers/SSV-SDK/examples/api-calls.md +++ b/docs/developers/SSV-SDK/examples/api-calls.md @@ -4,11 +4,11 @@ sidebar_position: 2 # API calls -This page will show how to use the API module to do various calls. The API module is used to get data such as the Account Nonce, or Cluster Snapshot, both are covered on this page. +This page will show how to use the API module to do various calls. The API module is used to get data such as the Account Nonce, or Cluster Snapshot, both are covered on this page. For the full list of functions you can check the [API Module Reference](../module-reference/api-module.md). -### Get Nonce +### Get Nonce ``` typescript const ownerNonce = await sdk.api.getOwnerNonce({ diff --git a/docs/developers/SSV-SDK/examples/cluster-balance-script.md b/docs/developers/SSV-SDK/examples/cluster-balance-script.md new file mode 100644 index 0000000..1833608 --- /dev/null +++ b/docs/developers/SSV-SDK/examples/cluster-balance-script.md @@ -0,0 +1,24 @@ +# Cluster Balance Calculation + +The script below calculates the balance of a cluster on the SSV network. This calculation can be made useful by adding it to cluster balance monitoring tool/automation of your own. + +Details on the formulas used can be found in the documentation page related to [Cluster Balance](/stakers/clusters/cluster-balance). + +The core calculation function that computes and prints the cluster balance: + +```typescript +try { + const { balance, operationalRunway } = await sdk.utils.getClusterBalance({ + args: { + operatorIds: [1, 2, 3, 4], + }, + }); + + console.log('Cluster balance result:', { + balance: balance.toString(), + operationalRunway: operationalRunway.toString(), + }); +} catch (error) { + console.error('Failed to get cluster balance:', error); +} +``` \ No newline at end of file diff --git a/docs/developers/SSV-SDK/examples/create-validator-keys.md b/docs/developers/SSV-SDK/examples/create-validator-keys.md index 60b85b6..96bfd8f 100644 --- a/docs/developers/SSV-SDK/examples/create-validator-keys.md +++ b/docs/developers/SSV-SDK/examples/create-validator-keys.md @@ -4,7 +4,7 @@ sidebar_position: 3 # Create Validator Keys -The SSV SDK does not natively support programmatically generating keystores out of the box, but a number of external libraries can be used to achieve this. +The SSV SDK does not natively support programmatically generating keystores out of the box, but a number of external libraries can be used to achieve this. If you do not need to do this programmatically, it may be easier to use the [Ethereum Staking Deposit CLI](https://github.com/ethereum/staking-deposit-cli) to generate validator keys. To generate Hoodi validator keys you can use [eth-educators' Staking Deposit CLI fork](https://github.com/eth-educators/ethstaker-deposit-cli). diff --git a/docs/developers/SSV-SDK/examples/deposit-eth.md b/docs/developers/SSV-SDK/examples/deposit-eth.md new file mode 100644 index 0000000..e37dc2b --- /dev/null +++ b/docs/developers/SSV-SDK/examples/deposit-eth.md @@ -0,0 +1,28 @@ +--- +sidebar_position: 8 +--- + +# Deposit ETH + +This page shows how to programmatically deposit ETH to a cluster on the SSV network. This executes the contract call to the smart contract to deposit ETH to the cluster. + +### Deposit ETH + +```typescript +import { parseEther } from 'viem'; + +try { + const txnReceipt = await sdk.clusters.deposit({ + value: parseEther('0.123') + args: { + id: "ee8881d3c979203025996773ef8a13cb4aac57076e22638dd6ed9b17adcdabfc", + }, + }, + ).then(tx => tx.wait()); + + console.log('Transaction receipt:', txnReceipt); +} catch (error) { + console.error('Failed to deposit ETH:', error); +} +``` + diff --git a/docs/developers/SSV-SDK/examples/deposit-ssv.md b/docs/developers/SSV-SDK/examples/deposit-ssv.md deleted file mode 100644 index fafc133..0000000 --- a/docs/developers/SSV-SDK/examples/deposit-ssv.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Deposit SSV - -This page shows how to programmatically deposit SSV to a cluster on the SSV network. This executes the contract call to the SSV smart contract to deposit SSV to the cluster. - -### Deposit SSV - -```typescript -import { parseEther } from 'viem'; - -try { - const txnReceipt = await sdk.clusters.deposit({ - args: { - id: "ee8881d3c979203025996773ef8a13cb4aac57076e22638dd6ed9b17adcdabfc", - amount: parseEther('30'), - }, - }, { - approve: true, // Automatically triggers token approval transaction if the allowance is lower than the deposit amount - }).then(tx => tx.wait()); - - console.log('Transaction receipt:', txnReceipt); -} catch (error) { - console.error('Failed to deposit SSV:', error); -} -``` - diff --git a/docs/developers/SSV-SDK/examples/register-validator.md b/docs/developers/SSV-SDK/examples/register-validator.md index 4c2e480..e894f3a 100644 --- a/docs/developers/SSV-SDK/examples/register-validator.md +++ b/docs/developers/SSV-SDK/examples/register-validator.md @@ -4,7 +4,7 @@ sidebar_position: 5 # Register Validator -This page shows how to progmatically register a validator to the SSV network. Assuming you already have generated a valid keyshare. +This page shows how to progmatically register a validator to the SSV network. Assuming you already have generated a valid keyshare. ### Register Validator diff --git a/docs/developers/SSV-SDK/examples/withdraw-ssv.md b/docs/developers/SSV-SDK/examples/withdraw-eth.md similarity index 66% rename from docs/developers/SSV-SDK/examples/withdraw-ssv.md rename to docs/developers/SSV-SDK/examples/withdraw-eth.md index 1a14766..e8628b4 100644 --- a/docs/developers/SSV-SDK/examples/withdraw-ssv.md +++ b/docs/developers/SSV-SDK/examples/withdraw-eth.md @@ -2,11 +2,11 @@ sidebar_position: 9 --- -# Withdraw SSV +# Withdraw ETH -This page shows how to programmatically withdraw SSV from a cluster on the SSV network. +This page shows how to programmatically withdraw ETH from a cluster on the SSV network. -### Withdraw SSV +### Withdraw ETH ```typescript import { parseEther } from 'viem'; @@ -15,13 +15,13 @@ try { const txnReceipt = await sdk.clusters.withdraw({ args: { id: "ee8881d3c979203025996773ef8a13cb4aac57076e22638dd6ed9b17adcdabfc", - amount: parseEther('30'), + amount: parseEther('0.123'), }, }).then(tx => tx.wait()); console.log('Transaction receipt:', txnReceipt); } catch (error) { - console.error('Failed to withdraw SSV:', error); + console.error('Failed to withdraw ETH:', error); } ``` diff --git a/docs/developers/SSV-SDK/module-reference/api-module.md b/docs/developers/SSV-SDK/module-reference/api-module.md index 3b1a4ef..27d2d30 100644 --- a/docs/developers/SSV-SDK/module-reference/api-module.md +++ b/docs/developers/SSV-SDK/module-reference/api-module.md @@ -14,11 +14,9 @@ sdk.api.getOwnerNonce() Accepts a list of addresses, fetches their nonces using subgraph, returns as a list. -Input parameters: -
Input parameterInput typeDescriptionExample input
account_addressstringAn array of owner addresses.[“0xA4831B989972605A62141a667578d742927Cbef9”]
-Examples input: +#### Example: ```typescript const ownerAddress = "0xA4831B989972605A62141a667578d742927Cbef9" @@ -35,11 +33,9 @@ Example output: Accepts a list of addresses, fetches cluster snapshots using subgraph, returns as a list. -Input: -
Input parameterInput typeDescriptionExample input
cluster_idstringAn array of cluster IDs in their computed ID form.[“4c0239091131c3e57e9555c540bcfd00bcd2484a9c4048f13411f22329511131”]
-Example: +#### Example: ```typescript const clusterSnapshot = await sdk.api.getClusterSnapshot({id: clusterID}) @@ -61,14 +57,13 @@ Example output: Accepts the owner address and a list of operator IDs, computes and returns the cluster ID hash. -Input: | Input parameter | Input type | Description | Example input | | ----------------- | ---------- | ----------------------------- | -------------------------------------------- | | owner\_address | string | Address of the cluster Owner. | '0x81592c3de184a3e2c0dcb5a261bc107bfa91f494' | | operator\_ids\[] | integer | List of operator IDs. | \[12, 34, 56, 78] | -Example: +#### Example: ```typescript import { createClusterId } from '@ssv-labs/ssv-sdk/utils' @@ -77,7 +72,7 @@ const operatorIds = [242, 686, 707, 736] const clusterID = createClusterId(ownerAddress, operatorIds) ``` -Example output: +Example output: ```bash 1179fed483c8c1b0327c8667521162015fa8cbe1a1b047a26baf0f0971a81929 @@ -87,11 +82,9 @@ Example output: Accepts a cluster id in it's hashed form. Returns details about the cluster. -Input: -
Input parameterInput typeDescriptionExample input
cluster_idstringA cluster ID in it's computed form“4c0239091131c3e57e9555c540bcfd00bcd2484a9c4048f13411f22329511131”
daoAddressstringAddress of the DAO (chain specific)"0x38A4794cCEd47d3baf7370CcC43B560D3a1beEFA"
operatorIdsstring[]A list of operator Ids[1,2,3,4]
-Example: +#### Example: ```typescript const ownerAddress = "0xA4831B989972605A62141a667578d742927Cbef9" @@ -116,11 +109,9 @@ Example output: Accepts a cluster id in it's hashed form. Returns details about the cluster. -Input: -
Input parameterInput typeDescriptionExample input
cluster_idstringAn array of cluster IDs in their computed ID form.[“4c0239091131c3e57e9555c540bcfd00bcd2484a9c4048f13411f22329511131”]
-Example: +#### Example: ```typescript const clusterData = await sdk.api.getCluster({id: clusterID}) @@ -141,13 +132,11 @@ Example output: ### `getClusters(owner)` -Accepts an owner address. Returns details about all of the clusters that they own. - -Input: +Accepts an owner address. Returns details about all of the clusters that they own.
Input parameterInput typeDescriptionExample input
ownerstringAn owner address"0xA4831B989972605A62141a667578d742927Cbef9"
-Example: +#### Example: ```typescript const ownerAddress = "0xA4831B989972605A62141a667578d742927Cbef9" @@ -183,11 +172,9 @@ Example output: Accepts an operator ID and returns details about the operator. -Input: -
Input parameterInput typeDescriptionExample input
idstringA single operator ID"4"
-Example: +#### Example: ```typescript const operatorData = await sdk.api.getOperator({id: "4"}) @@ -210,11 +197,9 @@ Example output: Accepts a list of operator IDs and returns details about them. -Input: -
Input parameterInput typeDescriptionExample input
operatorIdsstring[]A single operator ID["4","5"]
-Example: +#### Example: ```typescript const operatorData = await sdk.api.getOperators({operatorIds: ["4","5"]}) @@ -247,11 +232,9 @@ Example output: Accepts a validator ID and returns details about the validator. -Input: -
Input parameterInput typeDescriptionExample input
idstringA single validator ID0x0c74493afd8082f86485e4172be72678b0feb1494087ee6abe7d7ea7437c2a3fc6c06193040c6e24cdf59c9081d1c7a9
-Example: +#### Example: ```typescript const validatorData = await sdk.api.getValidators({id: "0x0c74493afd8082f86485e4172be72678b0feb1494087ee6abe7d7ea7437c2a3fc6c06193040c6e24cdf59c9081d1c7a9"}) @@ -269,11 +252,9 @@ Example output: Accepts an validator ID and returns details about the validator. -Input: -
Input parameterInput typeDescriptionExample input
idsstring[]An array of validator IDs["0x0c74493afd8082f86485e4172be72678b0feb1494087ee6abe7d7ea7437c2a3fc6c06193040c6e24cdf59c9081d1c7a9", "0x1a85052f3b9d17e73ec76c472220c80ada65a19a0fd177344b1e9f6173d51136c400120989dbd9ff498defc99dfe5181"]
-Example: +#### Example: ```typescript const validatorData = await sdk.api.getValidators({id: ["0x0c74493afd8082f86485e4172be72678b0feb1494087ee6abe7d7ea7437c2a3fc6c06193040c6e24cdf59c9081d1c7a9", "0x1a85052f3b9d17e73ec76c472220c80ada65a19a0fd177344b1e9f6173d51136c400120989dbd9ff498defc99dfe5181"]}) diff --git a/docs/developers/SSV-SDK/module-reference/cluster-module.md b/docs/developers/SSV-SDK/module-reference/cluster-module.md index 1aa6636..ae21791 100644 --- a/docs/developers/SSV-SDK/module-reference/cluster-module.md +++ b/docs/developers/SSV-SDK/module-reference/cluster-module.md @@ -4,7 +4,7 @@ sidebar_position: 1 # Cluster Module -This is a library which contains all the cluster functions you need for working with SSV, such as registering a validator +This is a library which contains all the functions you need for working with Clusters of SSV network, such as registering a validator. After instantiating the SDK, you can call any of the functions in the utils library like so: @@ -14,142 +14,176 @@ sdk.clusters.registerValidators() ## Function List -### `registerValidators()` +### `migrateClusterToETH()` +Converts an SSV-based cluster (legacy) to ETH-based cluster. Accepts cluster ID to migrate to ETH-denominated fees, and the amount of ETH to deposit upon migrating. -Accepts all parameters necessary to compute the keyshares, does this in the background using ssv-keys library, returns the keyshares as an object or saves it to file. +| Input parameter | Input type | Description | Example input | +|----------------|------------|-------------|---------------| +| `cluster_Id` | string | A `cluster_id` in its computed ID form. | 0xf69A08B652f0CEBb685c2fFE043cfB767b66544A-5-6-7-8 | +| amount | bigint | Amount of ETH to deposit to fund the cluster | 0.1234 | -Input: +#### Example: + +```typescript +txn_receipt = await sdk.clusters.migrateClusterToETH({ + args: { + cluster_Id: "0xf69A08B652f0CEBb685c2fFE043cfB767b66544A-5-6-7-8", + amount: parseEther('0.1234') + }, +}).then(tx => tx.wait()) +``` + +### `registerValidators()` + +Accepts a number of keyshares to be validated and registered to the network. | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| -| keyshares | KeySharesItem[] \| KeySharesPayload[] | Keyshare or transaction payload | See output of [generateKeyShares()](../../tools/ssv-dkg-client/generate-key-shares.md) | -| depositAmount | bigint | Amount of SSV to deposit to cluster | 4 | +| keyshares | KeySharesItem[] | Keyshares | See [keyshares example with its structure](/developers/keyshares-structure) | +| depositAmount | bigint | Amount of ETH to deposit to cluster | 0.1234 | -Example: +#### Example: ```typescript txn_receipt = await sdk.clusters.registerValidators({ args: { keyshares: keysharesPayload, - depositAmount: parseEther('30') + depositAmount: parseEther('0.1234') }, }).then(tx => tx.wait()) ``` ### `deposit()` -Executes the contract call to the SSV smart contract to deposit SSV to the cluster. - -Input: +Executes the contract call to to deposit ETH to the cluster balance. | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| -| id | string | Cluster ID | ee8881d3c979203025996773ef8a13cb4aac57076e22638dd6ed9b17adcdabfc | -| amount | bigint | Amount of SSV to deposit to cluster | 4 | -| approve | bool | Whether to execute out the SSV ERC20 approve transaction or not | true | +| id | string | Cluster ID | 0xf69A08B652f0CEBb685c2fFE043cfB767b66544A-5-6-7-8 | +| amount | bigint | Amount of ETH to deposit to cluster | 0.1234 | -Example: +#### Example: ```typescript import { parseEther } from 'viem' txn_receipt = await sdk.clusters.deposit({ args: { - id: "ee8881d3c979203025996773ef8a13cb4aac57076e22638dd6ed9b17adcdabfc", - amount: parseEther('30') + id: "0xf69A08B652f0CEBb685c2fFE043cfB767b66544A-5-6-7-8", + amount: parseEther('0.1234') }, - { - approve: true, // Automatically triggers token approval transaction if the allowance is lower than the deposit amount - }, }).then(tx => tx.wait()) ``` ### `liquidateCluster()` -Liquidates a cluster sends their balances to the msg.sender (the Liquidator), **will fail** if the cluster is not liquidatable. - -Input: +Liquidates a cluster sends their balance to the msg.sender (the Liquidator). **Will fail** if the cluster is not liquidatable. | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| -| id | string | Cluster ID | ee8881d3c979203025996773ef8a13cb4aac57076e22638dd6ed9b17adcdabfc | +| id | string | Cluster ID | 0xf69A08B652f0CEBb685c2fFE043cfB767b66544A-5-6-7-8 | -Example: +#### Example: ```typescript txn_receipt = await sdk.clusters.liquidateCluster({ args: { - id: "ee8881d3c979203025996773ef8a13cb4aac57076e22638dd6ed9b17adcdabfc", + id: "0xf69A08B652f0CEBb685c2fFE043cfB767b66544A-5-6-7-8", }, }).then(tx => tx.wait()) ``` +### `liquidateSSV()` + +Liquidates a legacy (SSV-based) cluster sends their balance to the msg.sender (the Liquidator). **Will fail** if the cluster is not liquidatable. + +| Input parameter | Input type | Description | Example input | +|----------------|------------|-------------|---------------| +| id | string | Cluster ID | 0xf69A08B652f0CEBb685c2fFE043cfB767b66544A-5-6-7-8 | + +#### Example: + +```typescript +txn_receipt = await sdk.clusters.liquidateSSV({ + args: { + id: "0xf69A08B652f0CEBb685c2fFE043cfB767b66544A-5-6-7-8", + }, +}).then(tx => tx.wait()) +``` + + ### `withdraw()` -Withdraw a specified amount of SSV from a cluster. +Withdraw a specified amount of ETH from a cluster. -Input: +**Will fail** if: +- the amount to withdraw exceeds the current balance of a cluster; +- msg.sender is not the cluster owner. | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| -| id | string | Cluster ID | ee8881d3c979203025996773ef8a13cb4aac57076e22638dd6ed9b17adcdabfc | -| amount | bigint | Amount of SSV to withdraw to cluster | 4 | +| id | string | Cluster ID | 0xf69A08B652f0CEBb685c2fFE043cfB767b66544A-5-6-7-8 | +| amount | bigint | Amount of ETH to withdraw from the cluster | 0.1234 | -Example: +#### Example: ```typescript import { parseEther } from 'viem' txn_receipt = await sdk.clusters.withdraw({ args: { - id: "ee8881d3c979203025996773ef8a13cb4aac57076e22638dd6ed9b17adcdabfc", - amount: parseEther('30') + id: "0xf69A08B652f0CEBb685c2fFE043cfB767b66544A-5-6-7-8", + amount: parseEther('0.1234') }, }).then(tx => tx.wait()) ``` ### `reactivateCluster()` -Reactivates a liquidated cluster, **will fail** if insufficient SSV tokens to cover the cluster's liquidation collateral have been deposited. +Reactivates a liquidated cluster. -Input: +**Will fail** if: +- the ETH amount to deposit is insufficient to cover the cluster's liquidation collateral; +- msg.sender is not the cluster owner. | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| -| id | string | Cluster ID | ee8881d3c979203025996773ef8a13cb4aac57076e22638dd6ed9b17adcdabfc | -| amount | bigint | Amount of SSV to withdraw to cluster | 4 | +| id | string | Cluster ID | 0xf69A08B652f0CEBb685c2fFE043cfB767b66544A-5-6-7-8 | +| amount | bigint | Amount of ETH to deposit to cluster | 0.1234 | -Example input: +#### Example: ```typescript import { parseEther } from 'viem' txn_receipt = await sdk.clusters.reactivateCluster({ args: { - id: "ee8881d3c979203025996773ef8a13cb4aac57076e22638dd6ed9b17adcdabfc", - amount: parseEther('30') + id: "0xf69A08B652f0CEBb685c2fFE043cfB767b66544A-5-6-7-8", + amount: parseEther('0.1234') }, }).then(tx => tx.wait()) ``` ### `removeValidators()` -Accepts all parameters necessary to compute the keyshares, does this in the background using ssv-keys library, returns the keyshares as an object or saves it to file. +Accepts all parameters necessary to remove the validators. Removes all the validators provided as argument from the SSV network. -Input: +**Will fail** if: +- the provided validator keys are not registered to ssv network; +- msg.sender is not the cluster owner. | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| -| id | string | Cluster ID | ee8881d3c979203025996773ef8a13cb4aac57076e22638dd6ed9b17adcdabfc | +| id | string | Cluster ID | 0xf69A08B652f0CEBb685c2fFE043cfB767b66544A-5-6-7-8 | | publicKeys | Hex[] | Array of validator public keys to remove | ["0x820fd0519c75f74c8be9f21f185406919721dad0c624464538e2eaa323d77d3eb3ef27a039e8779de6cfa649a5484e86", "0x820fd0519c75f74c8be9f21f185406919721dad0c624464538e2eaa323d77d3eb3ef27a039e8779de6cfa649a5484e87"] | -Example: +#### Example: ```typescript txn_receipt = await sdk.clusters.removeValidators({ args: { - id: "ee8881d3c979203025996773ef8a13cb4aac57076e22638dd6ed9b17adcdabfc", - depositAmount: ["0x820fd0519c75f74c8be9f21f185406919721dad0c624464538e2eaa323d77d3eb3ef27a039e8779de6cfa649a5484e86", "0x820fd0519c75f74c8be9f21f185406919721dad0c624464538e2eaa323d77d3eb3ef27a039e8779de6cfa649a5484e87"], + id: "0xf69A08B652f0CEBb685c2fFE043cfB767b66544A-5-6-7-8", + publicKeys: ["0x820fd0519c75f74c8be9f21f185406919721dad0c624464538e2eaa323d77d3eb3ef27a039e8779de6cfa649a5484e86", "0x820fd0519c75f74c8be9f21f185406919721dad0c624464538e2eaa323d77d3eb3ef27a039e8779de6cfa649a5484e87"], }, }).then(tx => tx.wait()) ``` @@ -158,13 +192,11 @@ txn_receipt = await sdk.clusters.removeValidators({ Sets a fee recipient address to receive tips from user transactions (part block proposal rewards). This address will be set for all the account's validators (all clusters). -Input: - | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| | recipient | Address | Valid Ethereum address | 0xA4831B989972605A62141a667578d742927Cbef9 | -Example: +#### Example: ```typescript txn_receipt = await sdk.clusters.setFeeRecipient({ @@ -178,14 +210,16 @@ txn_receipt = await sdk.clusters.setFeeRecipient({ Prompts SSV nodes to sign a voluntary exit of the validator. -Input: +**Will fail** if: +- the provided validator keys are not registered to ssv network; +- msg.sender is not the cluster owner. | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| -| publicKeys | Hex[] | Public keys of the validators to be exited | ["0xA4831B989972605A62141a667578d742927Cbef9","0xA4831B989972605A62141a667578d742927Cbef8"] | +| publicKeys | Hex[] | Array of public keys of the validators to be exited | ["0xA4831B989972605A62141a667578d742927Cbef9","0xA4831B989972605A62141a667578d742927Cbef8"] | | operatorIds | bigint[] | IDs of the operators | [1,2,3,4] | -Example input: +#### Example: ```typescript txn_receipt = await sdk.clusters.exitValidators({ @@ -198,21 +232,19 @@ txn_receipt = await sdk.clusters.exitValidators({ ### `validateSharesPostRegistration()` -Accepts a transaction hash of the validator registration contract call. - -Input: +Accepts a transaction hash of the validator registration contract call. | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| | txHash | Hex | Hash of the register validator transaction | "0xd9095893dba18b101c01973069922db2d81c45e814003851ccc586d60ae28e5b" | -Example input: +#### Example: ```typescript -const result = await validateSharesPostRegistration( { txHash: '0x123' as Hex }) +const result = await sdk.clusters.validateSharesPostRegistration( { txHash: '0x123' as Hex }) ``` -Example output: +Output: ```typescript { diff --git a/docs/developers/SSV-SDK/module-reference/operator-module.md b/docs/developers/SSV-SDK/module-reference/operator-module.md index ed1ed5a..ec8a6d4 100644 --- a/docs/developers/SSV-SDK/module-reference/operator-module.md +++ b/docs/developers/SSV-SDK/module-reference/operator-module.md @@ -5,7 +5,7 @@ sidebar_position: 2 # Operator Module -This is a library which contains all the helper functions you need for working with operators on SSV. +This is a library which contains all the helper functions you need for working with operators on SSV network. After instantiating the SDK, you can call any of the functions in the utils library like so: @@ -19,22 +19,22 @@ sdk.operators.registerOperator() Accepts a list of addresses, fetches their nonces using subgraph, returns as a list. -Input parameters: - | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| | isPrivate | bool | true/false flag of whether the operator is private | true | -| yearlyFee | bigint | The operator public key (generated as part of the node setup) | 2000000000000000 | -| publicKey | string | The operator public key (generated as part of the node setup) | "0xA4831B989972605A62141a667578d742927Cbef9" | +| yearlyFee | bigint | Operator yearly fee specified in ETH | 0.1234 | +| publicKey | string | The operator public key (generated as part of the node setup) | "LS0tLS1CRUdJTiBSU0EgUFVCTElDIE..." | -Example: +#### Example: ```typescript +import { parseEther } from 'viem' + const receipt = await sdk.operators .registerOperator({ args: { publicKey: "LS0tLS1CRUdJTiBSU0EgUFVCTElDIE..." - yearlyFee: 100000000000000, + yearlyFee: parseEther('0.1234') isPrivate: true, }, }) @@ -43,15 +43,14 @@ const receipt = await sdk.operators ### `removeOperator()` -Permanently removes the operator from the network (irreversible). +Permanently removes the operator from the network (irreversible). **Will fail if** msg.sender is not the operator owner. -Input parameters: | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| | operatorId | bigint | Operator id | 4 | -Example: +#### Example: ```typescript const receipt = await sdk.operators @@ -65,23 +64,83 @@ const receipt = await sdk.operators ### `withdraw()` -Withdraws an amount of SSV from a specified operator. +Withdraws an amount of ETH from a specified operator. **Will fail if** msg.sender is not the operator owner. + +| Input parameter | Input type | Description | Example input | +|----------------|------------|-------------|---------------| +| operatorId | string | Operator id | 4 | +| amount | bigint | Withdraws a specified amount of ETH earnings from provided operator balance to msg.sender | 0.1234 | + +#### Example: + +```typescript +import { parseEther } from 'viem' + +const receipt = await sdk.operators.withdraw({ + args: { + operatorId: "4", + amount: parseEther('0.1234'), + }, + }) +.then((tx) => tx.wait()) +``` + +### `withdrawOperatorEarningsSSV()` -Input parameters: +Withdraws an amount of SSV from a specified operator. **Will fail if** msg.sender is not the operator owner. | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| | operatorId | string | Operator id | 4 | -| amount | bigint | Withdraws all SSV tokens earnings from provided operator balance to msg.sender, **will fail if** msg.sender is not the operator owner | 1231231231311231 | +| amount | bigint | Withdraws a specified amount of SSV tokens earnings from provided operator balance to msg.sender | 30 | -Example: +#### Example: ```typescript -const receipt = await sdk.operators - .withdraw({ +import { parseEther } from 'viem' + +const receipt = await sdk.operators.withdrawOperatorEarningsSSV({ + args: { + operatorId: "4", + amount: parseEther('30'), + }, + }) +.then((tx) => tx.wait()) +``` + +### `withdrawAllOperatorEarningsSSV()` + +Withdraws all of the available SSV from a specified operator's balance. **Will fail if** msg.sender is not the operator owner. + +| Input parameter | Input type | Description | Example input | +|----------------|------------|-------------|---------------| +| operatorId | string | Operator id | 4 | + +#### Example: + +```typescript +const receipt = await sdk.operators.withdrawAllOperatorEarningsSSV({ + args: { + operatorId: "4", + }, + }) +.then((tx) => tx.wait()) +``` + +### `withdrawAllVersionOperatorEarnings()` + +Withdraws all available SSV tokens *and* ETH from specified operators' balances. **Will fail if** msg.sender is not the operator owner. + +| Input parameter | Input type | Description | Example input | +|----------------|------------|-------------|---------------| +| operatorId | string | Operator id | 4 | + +#### Example: + +```typescript +const receipt = await sdk.operators.withdrawAllVersionOperatorEarnings({ args: { operatorId: "4", - amount: 1231231231311231, }, }) .then((tx) => tx.wait()) @@ -91,18 +150,15 @@ const receipt = await sdk.operators For a list of operators provided, set a list of whitelisted addresses which can register validators to these operators. -Input parameters: - | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| -| operatorId | bigint[] | Operator id array | [1,2,3,4] | -| whitelisted | Hex[] | A list of ETH1 addresses to be whitelisted | ["0xA4831B989972605A62141a667578d742927Cbef9", "0xA4831B989972605A62141a667578d742927Cbef8"] | +| operatorId | bigint[] | Array of operator ID(s) | [1,2,3,4] | +| whitelisted | Hex[] | Array of ETH1 addresses to be whitelisted | ["0xA4831B989972605A62141a667578d742927Cbef9", "0xA4831B989972605A62141a667578d742927Cbef8"] | -Example: +#### Example: ```typescript -const receipt = await sdk.operators - .setOperatorWhitelists({ +const receipt = await sdk.operators.setOperatorWhitelists({ args: { operatorId: [1,2,3,4], whitelisted: ["0xA4831B989972605A62141a667578d742927Cbef9", "0xA4831B989972605A62141a667578d742927Cbef8"], @@ -113,20 +169,17 @@ const receipt = await sdk.operators ### `removeOperatorWhitelists()` -For a list of operators provided, remove a list of whitelisted addresses. - -Input parameters: +For a list of operators provided, remove a list of whitelisted addresses. **Will fail if** msg.sender is not the operator owner. | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| -| operatorId | bigint[] | Operator id array | [1,2,3,4] | -| whitelisted | Hex[] | A list of ETH1 addresses to be removed from the whitelist | ["0xA4831B989972605A62141a667578d742927Cbef9", "0xA4831B989972605A62141a667578d742927Cbef8"] | +| operatorId | bigint[] | Array of operator ID(s) | [1,2,3,4] | +| whitelisted | Hex[] | Array of ETH1 addresses to be removed from the whitelist | ["0xA4831B989972605A62141a667578d742927Cbef9", "0xA4831B989972605A62141a667578d742927Cbef8"] | -Example: +#### Example: ```typescript -const receipt = await sdk.operators - .removeOperatorWhitelists({ +const receipt = await sdk.operators.removeOperatorWhitelists({ args: { operatorId: [1,2,3,4], whitelisted: ["0xA4831B989972605A62141a667578d742927Cbef9", "0xA4831B989972605A62141a667578d742927Cbef8"], @@ -137,19 +190,16 @@ const receipt = await sdk.operators ### `setOperatorsPrivate()` -For a list of operators provided, set their status to private. - -Input parameters: +For a list of operators provided, set their status to private. **Will fail if** msg.sender is not the operator owner. | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| -| operatorId | bigint[] | Operator id array | [1,2,3,4] | +| operatorId | bigint[] | Array of operator ID(s) | [1,2,3,4] | -Example: +#### Example: ```typescript -const receipt = await sdk.operators - .setOperatorsPrivate({ +const receipt = await sdk.operators.setOperatorsPrivate({ args: { operatorId: [1,2,3,4], }, @@ -159,19 +209,16 @@ const receipt = await sdk.operators ### `setOperatorsPublic()` -For a list of operators provided, set their status to public. - -Input parameters: +For a list of operators provided, set their status to public. **Will fail if** msg.sender is not the operator owner. | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| -| operatorId | bigint[] | Operator id array | [1,2,3,4] | +| operatorId | bigint[] | Array of operator ID(s) | [1,2,3,4] | -Example: +#### Example: ```typescript -const receipt = await sdk.operators - .setOperatorsPublic({ +const receipt = await sdk.operators.setOperatorsPublic({ args: { operatorId: [1,2,3,4], }, @@ -181,20 +228,17 @@ const receipt = await sdk.operators ### `setOperatorWhitelistingContract()` -For a list of operators provided, set an external whitelisting contract to manage the whitelist for these operators. [Must be a valid whitelisting contract.](https://docs.ssv.network/developers/smart-contracts/external-whitelist-contract-example) - -Input parameters: +For a list of operators provided, set an external whitelisting contract to manage the whitelist for these operators. [Must be a valid whitelisting contract.](https://docs.ssv.network/developers/smart-contracts/external-whitelist-contract-example). **Will fail if** msg.sender is not the operator owner. | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| -| operatorId | bigint[] | Operator id array | [1,2,3,4] | +| operatorId | bigint[] | Array of operator ID(s) | [1,2,3,4] | | whitelistingContract | string | A valid whitelisting contract address | "0xA4831B989972605A62141a667578d742927Cbef9" | -Example: +#### Example: ```typescript -const receipt = await sdk.operators - .setOperatorWhitelistingContract({ +const receipt = await sdk.operators.setOperatorWhitelistingContract({ args: { operatorId: [1,2,3,4], whitelistingContract: "0xA4831B989972605A62141a667578d742927Cbef9", @@ -205,15 +249,13 @@ const receipt = await sdk.operators ### `removeOperatorWhitelistingContract()` -For a list of operators provided, remove the whitelisting contract stored. - -Input parameters: +For a list of operators provided, remove the whitelisting contract stored. **Will fail if** msg.sender is not the operator owner. | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| -| operatorId | bigint[] | Operator id array | [1,2,3,4] | +| operatorId | bigint[] | Array of operator ID(s) | [1,2,3,4] | -Example: +#### Example: ```typescript const receipt = await sdk.operators @@ -227,23 +269,23 @@ const receipt = await sdk.operators #### `declareOperatorFee()` -Initiates the first step of the operator fee update cycle - declaration of a new fee. [After specified](https://docs.ssv.network/developers/smart-contracts/ssvnetworkviews#getoperatorfeeperiods) time window operator will be able to change to the new fee with executeOperatorFee(). - -Input parameters: +Initiates the first step of the operator fee update cycle - declaration of a new fee. [After specified](https://docs.ssv.network/developers/smart-contracts/ssvnetworkviews#getoperatorfeeperiods) time window operator will be able to change to the new fee with executeOperatorFee(). **Will fail if** msg.sender is not the operator owner. | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| | operatorId | bigint | Operator id | 4 | -| operatorFee | bigint | New fee (denominated as $SSV tokens per block). ***Amount must be shrinkable (divisible by 10000000)*** | 100000000 | +| fee | bigint | New fee (denominated as ETH per block). ***Amount must be shrinkable (divisible by 10000000)***, for simplicity we use `parseEther` | 0.1234 | -Example: +#### Example: ```typescript +import { parseEther } from 'viem' + const receipt = await sdk.operators .declareOperatorFee({ args: { operatorId: 4, - operatorFee: 100000000, + fee: parseEther('0.1234'), }, }) .then((tx) => tx.wait()) @@ -253,13 +295,11 @@ const receipt = await sdk.operators Activates operator's fee change specified in previously called declareOperatorFee(). This function needs to be called within a [certain time window](https://docs.ssv.network/developers/smart-contracts/ssvnetworkviews#getoperatorfeeperiods) following declareOperatorFee(). -Input parameters: - | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| | operatorId | bigint | Operator id | 4 | -Example: +#### Example: ```typescript const receipt = await sdk.operators @@ -275,13 +315,11 @@ const receipt = await sdk.operators Cancels operator's fee change requested in previously called declareOperatorFee(). -Input parameters: - | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| | operatorId | bigint | Operator id | 4 | -Example: +#### Example: ```typescript const receipt = await sdk.operators @@ -297,21 +335,21 @@ const receipt = await sdk.operators Reduce the operator fee, does not abide by the restrictions of fee increase. -Input parameters: - | Input parameter | Input type | Description | Example input | |----------------|------------|-------------|---------------| | operatorId | bigint | Operator id | 4 | -| fee | bigint | New fee (denominated as $SSV tokens per block). ***Amount must be shrinkable (divisible by 10000000)*** | 100000000 | +| fee | bigint | New fee (denominated as ETH per block). ***Amount must be shrinkable (divisible by 10000000)***, for simplicity we use `parseEther` | 0.1234 | -Example: +#### Example: ```typescript +import { parseEther } from 'viem' + const receipt = await sdk.operators .reduceOperatorFee({ args: { operatorId: 4, - fee: 100000000, + fee: parseEther('0.1234'), }, }) .then((tx) => tx.wait()) diff --git a/docs/developers/SSV-SDK/module-reference/utils-module.md b/docs/developers/SSV-SDK/module-reference/utils-module.md index cff2224..a62cf94 100644 --- a/docs/developers/SSV-SDK/module-reference/utils-module.md +++ b/docs/developers/SSV-SDK/module-reference/utils-module.md @@ -14,11 +14,16 @@ sdk.utils.generateKeyShares() Accepts all parameters necessary to compute the keyshares, does this in the background using ssv-keys library, returns the keyshares as an object or saves it to file. -Input: +| Input parameter | Input type | Description | Example input | +|----------------|------------|-------------|---------------| +| operator_keys | string[] | Array of operator public keys to register the validator to | ["LS0tLS1CRUdJTi...", "LS0tLS1CRUdJTi...", "LS0tLS1CRUdJTi...", "LS0tLS1CRUdJTi..."] | +| operator_ids | integer[] | Array of operator IDs to register the validator to. | [12, 34, 56, 78] | +| keystore | string | Validator keystore file created when generating the validator. Passed as object programmatically or file path. | ‘./path-to-keystore.json' | +| keystore_password | string | Password for the attached keystore file. | '1234' | +| owner_address | string | Address of the validator Owner. | '0x81592c3de184a3e2c0dcb5a261bc107bfa91f494' | +| nonce | bigint | Nonce of the owner address | 24 | -
Input parameterInput typeDescriptionExample input
operator_keys[]stringList of operator public keys to register the validator to.["LS0tLS1CRUdJTi...", "LS0tLS1CRUdJTi...", "LS0tLS1CRUdJTi...", "LS0tLS1CRUdJTi..."]
operator_ids[]integerList of operator IDs to register the validator to.[12, 34, 56, 78]
keystorestringValidator keystore file created when generating the validator. Passed as object programmatically or file path.‘./path-to-keystore.json'
keystore_passwordstringPassword for the attached keystore file.‘123’
owner_addressstringAddress of the validator Owner.'0x81592c3de184a3e2c0dcb5a261bc107bfa91f494'
noncebigintNonce of the owner address24
- -Example: +#### Example: ```typescript const ownerAddress = "0xA4831B989972605A62141a667578d742927Cbef9" @@ -46,22 +51,22 @@ Example output: ### `validateKeysharesJSON()` -Checks a JSON file of keyshares and returns whether it is valid or not. +Checks a JSON file of keyshares and returns whether it is valid or not. -
Input ParameterInput Type Description Example Input
operators'id[]' | 'publicKey[]'Array of operator ids or public keysOperatorArrayObject
keysharesstring | objectGenerated keysharesKeyshares json file
+| Input parameter | Input type | Description | Example input | +|----------------|------------|-------------|---------------| +| account | string | Owner address of the validators in keyshares | 0x012f55B6Cc5D57F943F1E79cF00214B652513f88 | +| operators | 'id[]' OR 'publicKey[]' | Array of operator ids or public keys | ['1','2','3','4'] | +| keyshares | string OR object | Generated keyshares | Keyshares json file | -Example: -```typescript -const operatorObjectArray = [{ - publicKey: string - id: string -}] +#### Example: -await sdk.utils.validateKeysharesJSON({ +```typescript +const validatedShares = await sdk.utils.validateKeysharesJSON({ account: '0x012f55B6Cc5D57F943F1E79cF00214B652513f88', - operators: operatorObjectArray, - keyshares: keyshareFile, + operators: ['1','2','3','4'], + keyshares: keysharesJsonFile, }); ``` @@ -98,16 +103,20 @@ Example output: ### `validateSharesPreRegistration()` -Checks keyshares json file and returns whether it is valid or not. +Checks keyshares json file and returns whether it is valid or not. -
Input ParameterInput Type Description Example Input
operatorIds'id[]' | 'publicKey[]'Array of operator ids or public keys['1','2','3','4']
keysharesstring | objectGenerated keysharesKeyshares json file
+| Input parameter | Input type | Description | Example input | +|----------------|------------|-------------|---------------| +| operatorIds | string[] | Array of operator ids | ['1','2','3','4'] | +| keyshares | string OR object | Generated keyshares | Keyshares json file | -Example: + +#### Example: ```typescript const validatedShares = await sdk.utils.validateSharesPreRegistration({ + operatorIds: ['1','2','3','4'], keyshares: keysharesJsonFile, - operatorIds: ['242','686','707','736'], }); ``` @@ -144,14 +153,16 @@ Example output: ### `getOperatorCapacity()` -Checks how many validators an operator has registered, compares it with the maximum amount of validators that can be registered, and returns the amount that can be registered. +Checks how many validators an operator has registered, compares it with the maximum amount of validators that can be registered, and returns the amount that can be registered. -
Input ParameterInput Type Description Example Input
idstringOperator ID"1"
+| Input parameter | Input type | Description | Example input | +|----------------|------------|-------------|---------------| +| id | string | Operator ID | "1” | -Example: +#### Example: ```typescript -const result = await getOperatorCapacity('1') +const result = await sdk.utils.getOperatorCapacity('1') ``` Example output: @@ -162,21 +173,53 @@ Example output: ### `getClusterBalance()` -Returns the[ balance of a cluster](/stakers/clusters/cluster-balance). +Accepts a cluster ID to identify the cluster, for which the balance needs to be fetched. Returns the[ balance of a cluster](/stakers/clusters/cluster-balance). -
Input ParameterInput Type Description Example Input
operatorIdsnumber[]Operator ID array[1,2,3,4]
+| Input parameter | Input type | Description | Example input | +|----------------|------------|-------------|---------------| +| cluster_Id | string | A cluster_id in its computed ID form. | “0xf69A08B652f0CEBb685c2fFE043cfB767b66544A-5-6-7-8” | -Example: +#### Example: ```typescript -const result = await getClusterBalance([1,2,3,4]) +const result = await sdk.utils.getClusterBalance(“0xf69A08B652f0CEBb685c2fFE043cfB767b66544A-5-6-7-8”) ``` Example output: ```typescript { - balance: 1728318231823, // ssv in wei + balance: 1728318231823, // ETH in gwei operationalRunway: 123, // days left in cluster runway } ``` + +### `calcDepositFromRunway()` + +Accepts a string, and a number. Calculates the ETH needed to be deposited, in order to achieve the specified cluster runway. Returns a success message or relevant error. + +The function fetches the cluster snapshot using the provided ID, calculate the Burn Rate of the cluster, and reverse [the Operational Runway formula](https://docs.ssv.network/stakers/clusters/cluster-balance/#operational-runway) , to explicit the needed Cluster Balance to obtain the specified Runway. + +| Input parameter | Input type | Description | Example input | +|----------------|------------|-------------|---------------| +| cluster_Id | string | A cluster_id in its computed ID form. | “0xf69A08B652f0CEBb685c2fFE043cfB767b66544A-5-6-7-8” | +| runway | number | Desired Runway length, measured in number of days. | 45 | + + +#### Example: + +```typescript +const result = await sdk.utils.calcDepositFromRunway({ + cluster_Id: “0xf69A08B652f0CEBb685c2fFE043cfB767b66544A-5-6-7-8”, + runway: 45, + }); +``` + +Example output: + +```typescript +{ + 1728318231823, // ETH in gwei +} +``` + diff --git a/docs/developers/code-examples-and-snippets/README.md b/docs/developers/code-examples-and-snippets/README.md index 79f0af3..0d1337a 100644 --- a/docs/developers/code-examples-and-snippets/README.md +++ b/docs/developers/code-examples-and-snippets/README.md @@ -1,6 +1,7 @@ --- sidebar_label: 'Code examples and snippets' sidebar_position: 6 +unlisted: true --- # Code examples and snippets diff --git a/docs/developers/code-examples-and-snippets/cluster-balance-script.md b/docs/developers/code-examples-and-snippets/cluster-balance-script.md deleted file mode 100644 index b98830b..0000000 --- a/docs/developers/code-examples-and-snippets/cluster-balance-script.md +++ /dev/null @@ -1,352 +0,0 @@ -# Automated Cluster Balance Monitoring - -This script automatically monitors the balance of multiple clusters on the SSV network at regular intervals. It calculates the current balance of each cluster by: - -* Querying the subgraph for the relevant data (see the [Subgraph Examples](../tools/ssv-subgraph/subgraph-examples) page for more information) -* Using these values to compute the current cluster balance for each specified cluster, outputting the amount in SSV - -Details on the formulas used can be found in the documentation page related to [Cluster Balance](../../stakers/clusters/cluster-balance). - -## Cluster Balance Calculation - -The core calculation function that computes the cluster balance: - -```typescript -function calculateClusterBalance(responseData: GraphQLResponse, clusterName: string): ClusterCalculationResult | null { - - // Network Fee Calculation - const networkFee = - parseInt(responseData.data.daovalues.networkFeeIndex) + - (responseData.data._meta.block.number - - parseInt(responseData.data.daovalues.networkFeeIndexBlockNumber)) * - parseInt(responseData.data.daovalues.networkFee) - - responseData.data.cluster.networkFeeIndex * 10000000; - - // Operator Fee Calculation - let operatorFee = -responseData.data.cluster.index * 10000000; - for (let operator of responseData.data.operators) { - operatorFee += - parseInt(operator.feeIndex) + - (responseData.data._meta.block.number - - parseInt(operator.feeIndexBlockNumber)) * - parseInt(operator.fee); - } - - // Cluster Balance Calculation - const clusterBalance = - responseData.data.cluster.balance - - (networkFee + operatorFee) * responseData.data.cluster.validatorCount; - - return { - networkFee, - operatorFee, - clusterBalance, - validatorCount: responseData.data.cluster.validatorCount, - }; -} -``` - -## Full Script - -```typescript -import fetch from "node-fetch"; -import fs from "fs"; -import path from "path"; -import { fileURLToPath } from "url"; - -const __filename = fileURLToPath(import.meta.url); -const __dirname = path.dirname(__filename); - -interface ClusterConfig { - name: string; - accountAddress: string; - operatorIds: string[]; - clusterId: string; -} - -interface Config { - intervalSeconds: number; - graphqlUrl: string; - subgraphApiKey: string; - clusters: ClusterConfig[]; -} - -let monitoring = true; - -function loadConfig(): Config { - const configPath = path.join(__dirname, "config.json"); - const configData = fs.readFileSync(configPath, "utf-8"); - return JSON.parse(configData); -} - -function buildQuery(cluster: ClusterConfig): string { - const operatorIdsJson = JSON.stringify(cluster.operatorIds); - - return `{ - _meta { - block { - number - } - } - daovalues(id: "${cluster.accountAddress}") { - networkFee - networkFeeIndex - networkFeeIndexBlockNumber - } - operators(where: {id_in: ${operatorIdsJson}}) { - fee - feeIndex - feeIndexBlockNumber - } - cluster(id: "${cluster.clusterId}") { - validatorCount - networkFeeIndex - index - balance - } -}`; -} - -async function fetchClusterData(url: string, query: string, apiKey: string) { - const headers: Record = { - "Content-Type": "application/json", - }; - - if (apiKey) { - headers["Authorization"] = `Bearer ${apiKey}`; - } - - const response = await fetch(url, { - method: "POST", - headers, - body: JSON.stringify({ query }), - }); - - return await response.json(); -} - -function calculateClusterBalance(responseData: any, cluster: ClusterConfig) { - if (responseData.errors) { - console.error(`[${cluster.name}] GraphQL errors:`, responseData.errors); - return null; - } - - if (!responseData.data) { - console.error(`[${cluster.name}] No data in response`); - return null; - } - - if (!responseData.data.daovalues) { - console.error(`[${cluster.name}] daovalues is null`); - return null; - } - - if (!responseData.data.cluster) { - console.error(`[${cluster.name}] cluster is null`); - return null; - } - - if (!responseData.data.operators || responseData.data.operators.length === 0) { - console.error(`[${cluster.name}] operators is null or empty`); - return null; - } - - const networkFee = - parseInt(responseData.data.daovalues.networkFeeIndex) + - (responseData.data._meta.block.number - - parseInt(responseData.data.daovalues.networkFeeIndexBlockNumber)) * - parseInt(responseData.data.daovalues.networkFee) - - responseData.data.cluster.networkFeeIndex * 10000000; - - let operatorFee = -responseData.data.cluster.index * 10000000; - - for (let operator of responseData.data.operators) { - operatorFee += - parseInt(operator.feeIndex) + - (responseData.data._meta.block.number - - parseInt(operator.feeIndexBlockNumber)) * - parseInt(operator.fee); - } - - const clusterBalance = - responseData.data.cluster.balance - - (networkFee + operatorFee) * responseData.data.cluster.validatorCount; - - return { - networkFee, - operatorFee, - clusterBalance, - validatorCount: responseData.data.cluster.validatorCount, - }; -} - -async function monitorClusters() { - const config = loadConfig(); - const timestamp = new Date().toISOString(); - - console.log(`\n${"=".repeat(60)}`); - console.log(`Monitoring at ${timestamp}`); - console.log(`${"=".repeat(60)}\n`); - - for (const cluster of config.clusters) { - try { - const query = buildQuery(cluster); - const responseData = await fetchClusterData(config.graphqlUrl, query, config.subgraphApiKey); - const result = calculateClusterBalance(responseData, cluster); - - if (result) { - console.log(`[${cluster.name}]`); - console.log(` Validators: ${result.validatorCount}`); - console.log(` Network Fee: ${result.networkFee}`); - console.log(` Operator Fee: ${result.operatorFee}`); - console.log(` Cluster Balance: ${result.clusterBalance}`); - console.log(); - } - } catch (error) { - console.error(`[${cluster.name}] Error fetching data:`, error); - } - } -} - -async function startMonitoring() { - const config = loadConfig(); - - console.log(`Starting cluster monitoring...`); - console.log(`Interval: ${config.intervalSeconds} seconds`); - console.log(`Clusters to monitor: ${config.clusters.length}`); - console.log(`Press Ctrl+C to stop\n`); - - await monitorClusters(); - - const intervalId = setInterval(async () => { - if (!monitoring) { - clearInterval(intervalId); - return; - } - - await monitorClusters(); - }, config.intervalSeconds * 1000); - - process.on("SIGINT", () => { - console.log("\n\nStopping monitoring..."); - monitoring = false; - clearInterval(intervalId); - process.exit(0); - }); -} - -startMonitoring(); -``` - -## Configuration File - -Create a `config.json` file in the same directory as your script with the following structure: - -```json -{ - "intervalSeconds": 10, - "graphqlUrl": "https://api.studio.thegraph.com/query/71118/ssv-network-hoodi/version/latest", - "subgraphApiKey": "YOUR_SUBGRAPH_API_KEY_HERE", - "clusters": [ - { - "name": "Cluster 1", - "accountAddress": "0x58410Bef803ECd7E63B23664C586A6DB72DAf59c", - "operatorIds": ["108", "111", "173", "180"], - "clusterId": "0x0577a0d29662e048aab8d4ff3e8883a10b67a489-108-111-173-180" - }, - { - "name": "Cluster 2", - "accountAddress": "0x58410Bef803ECd7E63B23664C586A6DB72DAf59c", - "operatorIds": ["108", "111", "173", "180"], - "clusterId": "0x0577a0d29662e048aab8d4ff3e8883a10b67a489-108-111-173-180" - } - ] -} -``` - -## Prerequisites - -* [_Node.js_](https://nodejs.org/en) must be installed on the system - -## How to Run - -1. Create a file called `monitor-clusters.js` -2. Copy the script code above into this file -3. Create a `config.json` file in the same directory with your cluster configuration (see example above) -4. Install the required dependencies: - - ```bash - npm i node-fetch - ``` - -5. Run the script with node: - - ```bash - node monitor-clusters.js - ``` - -6. The script will continuously monitor your clusters at the interval specified in `config.json`. Press `Ctrl+C` to stop monitoring. - -## Example Output - -When you run the script, you'll see output similar to the following: - -```bash -$ node monitor-clusters.ts - -Starting cluster monitoring... -Interval: 10 seconds -Clusters to monitor: 2 -Press Ctrl+C to stop - -============================================================ -Monitoring at 2025-11-06T16:13:06.689Z -============================================================ - -[Cluster 1] - Validators: 1 - Network Fee: 5364995440000000 - Operator Fee: 30902704629999870 - Cluster Balance: 29963732299930000000 - -[Cluster 2] - Validators: 1 - Network Fee: 5364995440000000 - Operator Fee: 30902704629999870 - Cluster Balance: 29963732299930000000 - -============================================================ -Monitoring at 2025-11-06T16:13:17.642Z -============================================================ - -[Cluster 1] - Validators: 1 - Network Fee: 5365378080000000 - Operator Fee: 30904908659999360 - Cluster Balance: 29963729713260000000 - -[Cluster 2] - Validators: 1 - Network Fee: 5365378080000000 - Operator Fee: 30904908659999360 - Cluster Balance: 29963729713260000000 -``` - -:::info -If you get a warning, or an error similar to this: - -``` -(node:232985) Warning: To load an ES module, set "type": "module" in the package.json or use the .mjs extension. -``` - -Just make sure to edit the `package.json` file and add a line with `"type": "module"` to it, like in the example below: - -```json -{ - "dependencies": { - "node-fetch": "^3.3.2" - }, - "type": "module" -} -``` -::: diff --git a/docs/developers/integration-guides/lido-csm.md b/docs/developers/integration-guides/lido-csm.md index 9a17790..a1f2729 100644 --- a/docs/developers/integration-guides/lido-csm.md +++ b/docs/developers/integration-guides/lido-csm.md @@ -29,7 +29,7 @@ These two conditions are necessary and cannot be omitted. Changing the fee recipient on SSV applies to **all validators owned by an account**. So if you have registered CSM validators in the past, or intend to register validators that will not be part of CSM in the future, please utilize a different account, or you will be effectively **donating the execution rewards to Lido** instead of keeping them for yourself. -### Prerequisites +### Prerequisites * Over 2 ETH for CSM bonding and gas for transactions. * SSV tokens when registering your validator to the network @@ -59,7 +59,7 @@ To register your validator with SSV you can follow [the related guide in this do You can move onto the next step once your validator is registered to a cluster as shown below. -### 3. Set the Fee Recipient +### 3. Set the Fee Recipient As mentioned at the top of this guide, a requirement from Lido for all the validators registered to the CSM is that the fee recipient is set to the Lido Execution Layer Rewards Vault. @@ -77,7 +77,7 @@ In the following screen, set the address to this value: Enter the address, click update, and sign the transaction with your wallet. -### 4. Deposit bond on Lido CSM +### 4. Deposit bond on Lido CSM The following, and final step is to deposit the 1.3 - 2.4 ETH bond to Lido along with the validator deposit data to add the validator to the activation queue. Lido will deposit the 32 ETH needed for the activation to happen. @@ -104,4 +104,4 @@ To check your validator you can use this link, making sure to swap ` ``` -Once the validator has been activated, the SSV operators you have chosen in step two will handle the validator duties for you. +Once the validator has been activated, the SSV operators you have chosen in step two will handle the validator duties for you. diff --git a/docs/developers/integration-guides/staking-services.md b/docs/developers/integration-guides/staking-services.md index 80dc5bc..02c797a 100644 --- a/docs/developers/integration-guides/staking-services.md +++ b/docs/developers/integration-guides/staking-services.md @@ -44,13 +44,13 @@ The second stage outlines how to onboard new or existing validators that your op In order to assign validator operations to your operators, you must distribute their validator key to KeyShares and register them to the ssv.network. -Follow the Run a Distributor Validator guide for each new validator you want to manage. +Follow the [Run a Distributor Validator guide](/docs/stakers/validator-management/distributing-a-validator.md) for each new validator you want to manage. Please note that since validators are assigned to the staking service’s Operators (created during the previous stage), the “Operators Selection” step can be skipped. #### Validator Funding -Your staking service account must be funded with the appropriate amount of SSV to carry your validator's operational costs. These costs come in the form of operator and network fees (learn more on account balance and validator funding). +Your staking service account must be funded with the appropriate amount of ETH to carry your validator's operational costs. These costs come in the form of operator and network fees (learn more on account balance and validator funding). Keep in mind that all the validators that you manage will pay operator fees back to your own operators (basically paying yourself). Therefore, you don’t need to account for operator fees when calculating the required funding for running each of the validators you manage. @@ -62,8 +62,8 @@ Required\,Funding =( O1fee+O2_{fee}+ O3_{fee} + O4_{fee}+N_{fee})*LTP + (N_{fee Legend: ``` -* $$O1...4_{fee}$$ - operator fee ($SSV per block) -* $$N_{fee}$$ - [network fee] ($SSV per block)​ +* $$O1...4_{fee}$$ - operator fee (ETH per block) +* $$N_{fee}$$ - [network fee] (ETH per block)​ * $$Period$$ - operation period (blocks) * $$LTP$$ - [liquidation threshold period] ``` @@ -82,7 +82,7 @@ To manage account balance, the staking service can deposit or withdraw funds fro * [Deposit] * [Withdraw] -#### Validator Management +#### Validator Management Validators are fully customizable in the ssv.network, giving service providers more flexibility and control over their operations. Having the ability to update the operator group managing your validators can be useful when you want to spin up an additional operator or use another operator’s services. Additionally, being able to offboard a validator can help if one of your users wants to stop their validator operation or migrate to a different service. diff --git a/docs/developers/quickstart.md b/docs/developers/quickstart.md deleted file mode 100644 index 66dc718..0000000 --- a/docs/developers/quickstart.md +++ /dev/null @@ -1,425 +0,0 @@ ---- -description: Quickstart -sidebar_label: 'Quickstart' -sidebar_position: 2 ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -# Quickstart -This page shows how to register any amount of validators to the SSV network. - -:::note Prerequisite -This tutorial assumes you already have keystores generated, or will use the [*code illustrated here*](/developers/SSV-SDK/examples/create-validator-keys.md) to generate them pragmatically. -::: - - -### Overview - -![Get Started](/img/get-started-2.avif) - -Bulk registration flow is roughly outlined in the schema above. - -**Below are the actual steps you will need to take:** -1. [Installation](#1-installation) -2. [Select operators and collect their data](#2-select-operators-and-collect-their-data) -3. [Split your validator keys to shares](#3-split-validator-keys) -4. [Register your validators to the SSV network](#4-register-validators) - -There is also [Full code example](#full-code-example) by the end of this page. - -### **1. Installation** - -#### Install -```bash -npm i @ssv-labs/ssv-sdk fs path web3 viem -``` - -#### Import - -```typescript -import { SSVSDK, chains } from '@ssv-labs/ssv-sdk' -import { parseEther, createPublicClient, createWalletClient, http } from 'viem' -import { privateKeyToAccount } from 'viem/accounts' -``` - -#### Instantiation - -To instantiate the SDK, provide a number of parameters: - -| Parameter | Description | -| --------------- | --------------------------------------- | -| `public_client` | Public client object created using viem | -| `wallet_client` | Wallet object created using viem | - -You can use these like so to instantiate the SDK and store it an object: - -```typescript -// Setup viem clients -const chain = chains.hoodi as any // or chains.mainnet -const transport = http() - -const publicClient = createPublicClient({ - chain, - transport, -}) as any - -const account = privateKeyToAccount('0x...') -const walletClient = createWalletClient({ - account, - chain, - transport, -}) as any - -// Initialize SDK with viem clients -const sdk = new SSVSDK({ - publicClient, - walletClient, -}) -``` - -### **2. Select operators and collect their data** -A cluster can have 4, 7, 10, or 13 operators — the bigger your cluster, the higher yearly fee, and the more reliable your validator operations. - -If you already know the operator IDs you can proceed to any of the 3 options below to get their data. - -If you need to choose operators, feel free to browse [SSV Explorer](https://explorer.ssv.network/operators) to find the operators you will add to your cluster. Then proceed to the steps below. Please note, some of the operators are Private and only allow specific whitelisted addresses to onboard validators to them. - - - - To generate keyshares, operator IDs and their public keys are needed. You can collect keys of each operator using [SSV Subgraph](/developers/tools/ssv-subgraph). You will need to create own Graph API key and use endpoint with it. - - Alternatively, you can do it using [The Graph UI](https://thegraph.com/explorer/subgraphs/F4AU5vPCuKfHvnLsusibxJEiTN7ELCoYTvnzg3YHGYbh?view=Query&chain=arbitrum-one). - - An example of how Hoodi Subgraph can fetch the operator data is below. The code snippet considers you have environment variables (`SUBGRAPH_API_KEY` and `OPERATOR_IDS`) in an `.env` file: - ```typescript - const operatorIDs = JSON.parse(process.env.OPERATOR_IDS) - const url = "https://gateway.thegraph.com/api/subgraphs/id/F4AU5vPCuKfHvnLsusibxJEiTN7ELCoYTvnzg3YHGYbh"; - const query = ` - query ValidatorData($operatorIDs: [Bytes!]) { - operators(where: {id_in: $operatorIDs}) { - id - publicKey - } - }` - - const variables = { operatorIDs: operatorIDs } - const response = await fetch(url, { - method: 'POST', - headers: { - 'Content-Type': 'application/json', - 'Authorization': `Bearer ${process.env.SUBGRAPH_API_KEY}` - }, - body: JSON.stringify({ query, variables }) - }); - - const responseData: any = await response.json(); - const web3 = new Web3(); - const operators: { id: string; publicKey: string }[] = responseData.data.operators.map((operator: any) => {return { - id: operator.id, - publicKey: web3.eth.abi.decodeParameter("string", operator.publicKey) - }}) - ``` - - - To generate keyshares, operator IDs and their public keys are needed. This can also be done with [SSV Explorer](https://explorer.ssv.network/operators). - - On each operator's page, there is a 🗝️ sign next to operator's name. Click on the key sign and their public key will be copied. Repeat the process for each operator you chose. - - - Operator public key can be collected using our API once you know the ID. Use [this request type](https://api.ssv.network/documentation/#/Operators/OperatorsV4Controller_getOperator) to get the data. You only need to set the network and operator ID. - -```bash -curl -X 'GET' \ - 'https://api.ssv.network/api/v4/hoodi/operators/1' \ - -H 'accept: */*' -``` - -From the response you will need `id` and `public_key` contents: -```json -{ - "id": 1, - "id_str": "1", - "declared_fee": "0", - "previous_fee": "0", - "fee": "382640000000", - "public_key": "LS0tLS1CRUdJTiBSU0EgUFVCTElDIEtFWS0tLS0tCk1JSUJJakFOQmdrcWhraUc5dzBCQVFFRkFBT0NBUThBTUlJQkNnS0NBUUVBeVpGNUR2M2UwSkEzT25TSGwyQmMKNGFxbmpUTWFrUXNZSkY5eE55M21CVTZSQld1d2xVd1dIelJGWUFvb0FlRER3NlYxL3hRQ0JFaWJwTGx1RVdLTgoxNmRpcU5EVmY5VEZndmZlM2NHc3pNcDZCUE04bWhBdkx0c01DcHlXeDZtTEczVm0zVVRNK3hRdUJwVFZsdHNNCkV6eUZEZzNWTlphOW9hZkswbkVYRHVidlBIbkJCdWhlUW5LZThoUkJnRUo0emIrV3dncjFrM3YyWmkwTEtWNUQKYWd3c2QxK25Lb1grVktjYmJFVFBEdGRPV1AvZlpXM3dBMGp3R1pSdkhwNS8xUjBmZy91N01BUk1KTkRWVFYxQwo0Vlh1eHJkbHZWQ2JiS1pnWUIzY1ROSEMzZkVldit0NFVEeFJuQzdUcUN0WFZSYnpZQ001WHVSeUFRa3BiYU0wCjlRSURBUUFCCi0tLS0tRU5EIFJTQSBQVUJMSUMgS0VZLS0tLS0K", - "owner_address": "0x3187a42658417a4d60866163A4534Ce00D40C0C8", - "address_whitelist": "0x5E33db0b37622F7E6b2f0654aA7B985D854EA9Cb", - "whitelist_addresses": [ - "0x5E33db0b37622F7E6b2f0654aA7B985D854EA9Cb" - ], - "is_private": true, - "whitelisting_contract": "", - "location": "United States of America", - "setup_provider": "AWS", - "eth1_node_client": "Geth", - "eth2_node_client": "Prysm", - "mev_relays": "", - "description": "", - "website_url": "", - "twitter_url": "", - "linkedin_url": "", - "dkg_address": "", - "logo": "https://media-v2.ssv.network/operator_1_v4_mainnet_ssvBlack.png", - "type": "operator", - "name": "SSV Labs", - "performance": { - "24h": 100, - "30d": 99.86798961841079 - }, - "is_valid": true, - "is_deleted": false, - "is_active": 1, - "status": "Active", - "validators_count": 143, - "version": "v4", - "network": "mainnet" -} -``` - - - -Pass the collected operator info into ```generateKeyShares``` function in the code below. - -### **3. Split validator keys** -Use the collected data and your keystore to generate the keyshare transaction payload. - -The code snippet below considers you have environment variables (`KEYSTORE_PASSWORD` and `OWNER_ADDRESS`) in an `.env` file. Also, `nonce` is being handled automatically in the [full code example](#full-code-example): - -```typescript -const keysharesPayload = await sdk.utils.generateKeyShares({ - keystore: keystoreValues, - keystore_password: process.env.KEYSTORE_PASSWORD, - operator_keys: operators.map((operator: { id: string; publicKey: string }) => operator.publicKey), - operator_ids: operators.map((operator: { id: string; publicKey: string }) => Number(operator.id)), - owner_address: process.env.OWNER_ADDRESS, - nonce: nonce, -}) -``` - -Before doing the registration transaction, the specified amount of SSV needs to be approved: - -```typescript -await sdk.contract.token.write -.approve({ - args: { - spender: sdk.core.contractAddresses.setter, - amount: parseEther('10'), - }, -}) -.then((tx) => tx.wait()) -``` - -### **4. Register validators** -Then finally the `registerValidators` function can be called and return the transaction receipt: - -Register your validators to the SSV network is performed on completion of this function, when the transaction is processed successfully. - -```typescript -const txn_receipt = await sdk.clusters.registerValidators({ - args: { - keyshares: keysharesPayload, - depositAmount: parseEther('30') - }, - }).then(tx => tx.wait()) -console.log("txn_receipt: ", txn_receipt) -``` - -For validator [registration transaction](/developers/smart-contracts/ssvnetwork#bulkregistervalidatorpublickey-operatorids-shares-amount-cluster) you need to provide the cluster’s latest snapshot data and the user nonce. Fortunately, SSV SDK retrieves this data automatically, so you don't have to. - -### Full code example - -This example assumes you already have a number of keystore files and they are stored, under whatever is set for `KEYSTORE_FILE_DIRECTORY` in the `.env` file. - -**`.env` example file for the below script:** - -```sh -PRIVATE_KEY=0xYOUR_PRIVATE_KEY -OWNER_ADDRESS=0xA4831B989972605A62141a667578d742927Cbef9 -KEYSTORE_PASSWORD=test1234 -KEYSTORE_FILE_DIRECTORY=./validator_keys -DEPOSIT_AMOUNT=5 -MINIMUM_RUNWAY_DAYS=30 -OPERATOR_IDS='["1", "2", "3", "4"]' -SUBGRAPH_API_KEY=GRAPH_API_KEY -``` - -```typescript -import { SSVSDK, chains } from '@ssv-labs/ssv-sdk' -import { parseEther, createPublicClient, createWalletClient, http } from 'viem' -import { privateKeyToAccount } from 'viem/accounts' -import * as dotenv from 'dotenv'; -import * as fs from 'fs'; -import * as path from 'path'; -import Web3 from 'web3'; - -dotenv.config(); - -async function main(): Promise { - - if (!process.env.KEYSTORE_FILE_DIRECTORY || - !process.env.OWNER_ADDRESS || - !process.env.KEYSTORE_PASSWORD || - !process.env.OPERATOR_IDS || - !process.env.SUBGRAPH_API_KEY) { - throw new Error('Required environment variables are not set'); - } - - const private_key: `0x${string}` = process.env.PRIVATE_KEY as `0x${string}`; - - // Setup viem clients - const chain = chains.hoodi as any // or chains.mainnet - const transport = http() - - const publicClient = createPublicClient({ - chain, - transport - }) as any - - const account = privateKeyToAccount(private_key as `0x${string}`) - const walletClient = createWalletClient({ - account, - chain, - transport, - }) as any - - // Initialize SDK with viem clients - const sdk = new SSVSDK({ - publicClient, - walletClient, - }) - - const directoryPath = process.env.KEYSTORE_FILE_DIRECTORY; - let keystoresArray: { name: string; keystore: any }[]; - try { - keystoresArray = await loadKeystores(directoryPath); - console.log('Loaded keystores: Keystore Amount: ', keystoresArray.length); - } catch (error) { - console.error('Failed to load keystores:', error); - throw error; // If keystores can't be loaded the code will exit - } - - // keystoresArray is defined at this point - await sdk.contract.token.write - .approve({ - args: { - spender: sdk.config.contractAddresses.setter, - amount: parseEther('10000'), - }, - }) - .then((tx) => tx.wait()) - - let nonce = Number(await sdk.api.getOwnerNonce({ owner: process.env.OWNER_ADDRESS })) - console.log("Initial nonce: ", nonce) - - const operatorIDs = JSON.parse(process.env.OPERATOR_IDS) - const url = "https://gateway.thegraph.com/api/subgraphs/id/F4AU5vPCuKfHvnLsusibxJEiTN7ELCoYTvnzg3YHGYbh"; - const query = ` - query ValidatorData($operatorIDs: [Bytes!]) { - operators(where: {id_in: $operatorIDs}) { - id - publicKey - } - }` - - const variables = { operatorIDs: operatorIDs } - const response = await fetch(url, { - method: 'POST', - headers: { - 'Content-Type': 'application/json', - 'Authorization': `Bearer ${process.env.SUBGRAPH_API_KEY}` - }, - body: JSON.stringify({ query, variables }) - }); - - const responseData: any = await response.json(); - const web3 = new Web3(); - const operators: { id: string; publicKey: string }[] = responseData.data.operators.map((operator: any) => {return { - id: operator.id, - publicKey: web3.eth.abi.decodeParameter("string", operator.publicKey) - }}) - - console.log(operators.map((operator: { id: string; publicKey: string }) => operator.publicKey)) - console.log(operators.map((operator: { id: string; publicKey: string }) => Number(operator.id))) - - const chunkSize = 40; // Number of validators per transaction - for (let i = 0; i < keystoresArray.length; i += chunkSize) { - const chunk = keystoresArray.slice(i, i + chunkSize); - - const keystoreValues = chunk.map(item => item.keystore); - - const keysharesPayload = await sdk.utils.generateKeyShares({ - keystore: keystoreValues, - keystore_password: process.env.KEYSTORE_PASSWORD, - operator_keys: operators.map((operator: { id: string; publicKey: string }) => operator.publicKey), - operator_ids: operators.map((operator: { id: string; publicKey: string }) => Number(operator.id)), - owner_address: process.env.OWNER_ADDRESS, - nonce: nonce, - }) - - nonce = nonce + Number(chunk.length) - console.log("New nonce: ", nonce) - - // TODO: validate keysharesPayload - - let txn_receipt - try { - console.log(`Processing chunk from index ${i} to ${i + chunk.length - 1}`); - txn_receipt = await sdk.clusters.registerValidators({ - args: { - keyshares: keysharesPayload, - depositAmount: parseEther('30') - }, - }).then(tx => tx.wait()) - console.log("txn_receipt: ", txn_receipt) - } catch (error) { - logErrorToFile(error); - console.log("Failed to do register: ", error) - } - } -} - -async function loadKeystores(directory: string): Promise<{ name: string; keystore: any }[]> { - const keystoresArray: { name: string; keystore: any }[] = []; - - try { - const files = await fs.promises.readdir(directory); - - for (const file of files) { - if (file.startsWith('keystore-m') && file.endsWith('.json')) { - const filePath = path.join(directory, file); - - const fileContent = await fs.promises.readFile(filePath, 'utf-8'); - const jsonContent = JSON.parse(fileContent); - keystoresArray.push({ name: file, keystore: jsonContent }); - } - } - - return keystoresArray; - } catch (error) { - console.error('Error loading keystores:', error); - throw error; - } -} - -function logErrorToFile(error: unknown): void { - const errorMessage = `Failed to do register: ${error instanceof Error ? error.message : String(error)}\n`; - - // Log the error to the console - console.log(errorMessage); - - // Save the error message to a local file - const filePath = './error-log.txt'; - fs.appendFile(filePath, errorMessage, (err) => { - if (err) { - console.error("Failed to write to file: ", err); - } else { - console.log(`Error saved to file: ${filePath}`); - } - }); -} - -main(); -``` diff --git a/docs/developers/smart-contracts/external-whitelist-contract-example.md b/docs/developers/smart-contracts/external-whitelist-contract-example.md index e6512cd..6476bbc 100644 --- a/docs/developers/smart-contracts/external-whitelist-contract-example.md +++ b/docs/developers/smart-contracts/external-whitelist-contract-example.md @@ -4,9 +4,9 @@ sidebar_position: 4 # External Whitelist Contract example -When [configuring a permissioned Operator](../../operators/operator-management/configuring-a-permissioned-operator), we have the option to set an external whitelising contract to manage this whitelist. To work correctly with the SSV network contract, it must meet certain specifications. +When [configuring a permissioned Operator](../../operators/operator-management/configuring-a-permissioned-operator), we have the option to set an external whitelising contract to manage this whitelist. To work correctly with the SSV network contract, it must meet certain specifications. -### What is a valid Whitelisting Contract? +### What is a valid Whitelisting Contract? The operators can choose to whitelist an external contract with custom logic to manage authorized addresses externally. To be used in SSV contracts, it needs to implement the [ISSVWhitelistingContract](https://github.com/ssvlabs/ssv-network/blob/v1.2.0/contracts/interfaces/external/ISSVWhitelistingContract.sol) interface, that requires to implement the `isWhitelisted(address account, uint256 operatorId)` function. This function is called in the register validator process, that must return `true/false` to indicate if the caller (`msg.sender`) is whitelisted for the operator. diff --git a/docs/developers/smart-contracts/ssvnetwork.md b/docs/developers/smart-contracts/ssvnetwork.md index aa59c21..b1ec096 100644 --- a/docs/developers/smart-contracts/ssvnetwork.md +++ b/docs/developers/smart-contracts/ssvnetwork.md @@ -17,7 +17,7 @@ Description: Registers a new operator (key) with a set fee, **fails if** fee is | **Parameter** | **Type** | **Description** | | ------------- | ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | publicKey | bytes | The operator public key (generated as part of the node setup). | -| operatorFee | uint256(casted to uint64) | The fee charged by the operator (denominated as $SSV tokens per block) | +| operatorFee | uint256(casted to uint64) | The fee charged by the operator (denominated as ETH per block) | | setPrivate | bool | A flag to set the operator to private or public during registration. Calls the [**`setOperatorsPrivateUnchecked`**](ssvnetwork.md#setoperatorsprivateuncheckedoperatorids)function if set to true. | Events: @@ -39,7 +39,7 @@ Events: ### **`withdrawOperatorEarnings(operatorId)`** -Description: Withdraws a specified amount of SSV tokens from provided operator balance to msg.sender, **will fail if** msg.sender is not the operator owner. +Description: Withdraws a specified amount of ETH from provided operator balance to msg.sender, **will fail if** msg.sender is not the operator owner. | **Parameter** | **Type** | **Description** | | ------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------- | @@ -52,7 +52,7 @@ Events: ### `withdrawAllOperatorEarnings`**`(operatorId)`** -Description: Withdraws all SSV tokens earnings from provided operator balance to msg.sender, **will fail if** msg.sender is not the operator owner. +Description: Withdraws all ETH earnings from provided operator balance to msg.sender, **will fail if** msg.sender is not the operator owner. | **Parameter** | **Type** | **Description** | | ------------- | -------- | --------------- | @@ -62,7 +62,7 @@ Events: * `OperatorWithdrawn(address indexed owner, uint64 indexed operatorId, uint256 value)` -### **`setOperatorWhitelists (operatorIds, whitelisted)`** +### **`setOperatorsWhitelists (operatorIds, whitelisted)`** Description: For a list of operators provided, set a list of whitelisted addresses which can register validators to these operators. @@ -75,7 +75,7 @@ Events: * `OperatorMultipleWhitelistUpdated(uint64[] operatorIds, address[] whitelistAddresses)` -### **`removeOperatorWhitelists (operatorIds, whitelisted)`** +### **`removeOperatorsWhitelists (operatorIds, whitelisted)`** Description: For a list of operators provided, remove a list of whitelisted addresses. @@ -112,7 +112,7 @@ Events: * `OperatorPrivacyStatusUpdated(uint64[] operatorIds, bool toPrivate)` -### **`setOperatorWhitelistingContract(operatorIds, whitelistingContract)`** +### **`setOperatorsWhitelistingContract(operatorIds, whitelistingContract)`** Description: For a list of operators provided, set an external whitelisting contract to manage the whitelist for these operators. [Must be a valid whitelisting contract.](external-whitelist-contract-example.md) @@ -144,7 +144,7 @@ Description: Initiates the first step of the operator fee update cycle - declara | **Parameter** | **Type** | **Description** | | ------------- | -------------------------- | ----------------------------------------------- | | operatorId | uint64 | The operator id | -| operatorFee | uint256 (casted to uint64) | New fee (denominated as $SSV tokens per block). | +| operatorFee | uint256 (casted to uint64) | New fee (denominated as ETH per block). | Events: @@ -181,7 +181,7 @@ Description: Reduce the operator fee, does not abide by the restrictions of fee | Parameter | Type | Description | | ---------- | -------------------------- | ----------------------------------------------- | | operatorId | uint64 | The operator id | -| fee | uint256 (casted to uint64) | New fee (denominated as $SSV tokens per block). | +| fee | uint256 (casted to uint64) | New fee (denominated as ETH per block). | Events: @@ -203,15 +203,25 @@ Events: ## Cluster Methods -### **`registerValidator(publicKey, operatorIds, shares, amount, cluster)`** +### `migrateClusterToETH(operatorIds, amount, cluster)` + +| **Parameter** | **Type** | **Description** | +| ------------------- | -------- | ---------------------------------------------------- | +| operatorIds | uint64[] | An array of operator IDs of the cluster. | +| amount | uint256 | Amount of ETH to deposit to cluster's balance after migration. | +| cluster | tuple\[] | Object containing the latest cluster snapshot data - obtained using the [SSV Subgraph](/developers/tools/ssv-subgraph/subgraph-examples#cluster-snapshot), or [SSV Scanner](/developers/tools/ssv-scanner) tools | + +Events: -Description: Registers new validator to a cluster of provided operators (ids + shares), **fails if** number of operatorIds is greater than 13. +* `ClusterMigratedToETH(address owner, uint64[] operatorIds, uint256 ethDeposited, uint256 ssvRefunded, uint32 effectiveBalance, Cluster cluster)` -:::info -To deposit the SSV Token, you need to approve the amount of SSV tokens you wish to deposit to the cluster. +### **`registerValidator(publicKey, operatorIds, shares, cluster)`** -The approval transaction must be called on the SSV token contract, with the approval address set to the SSVNetwork contract address. [Both adddresses can be found here.](../smart-contracts) +Registers new validator to a cluster of provided operators (ids + shares), **fails if** number of operatorIds is greater than 13. The ETH amount to deposit must be [supplied via `msg.value`](https://docs.ethers.org/v4/api-contract.html#overrides). + +:::info Breaking Changes +With the [introduction of ETH payments](https://ssv.network/blog/introduction-to-ssv-staking), the smart contract function signature has changed. The `amount` parameter has been removed, and the function is now `payable`. The ETH amount to deposit must be supplied via `msg.value`. Update your integrations accordingly, in line with [the ethers documentation](https://docs.ethers.org/v4/api-contract.html#overrides). ::: | **Parameter** | **Type** | **Description** | @@ -219,21 +229,17 @@ The approval transaction must be called on the SSV token contract, with the appr | publicKey | bytes | The validator’s public key. | | operatorIds | unit64\[] | List of cluster operators Ids. | | sharesData | bytes | String of keyshares - obtained by splitting the validator key using the [SSV-Keys](../tools/ssv-keys) tool. | -| amount | uint256 (casted to uint64) | Amount of SSV token to be deposited as payment (not mandatory). Amount must be shrinkable (divisible by 10000000) | -| cluster | tuple\[] | Object containing the latest cluster snapshot data - obtained using the [SSV Subgraph](../tools/ssv-subgraph/subgraph-examples#cluster-snapshot), or [SSV Scanner](../tools/ssv-scanner) tools If this is the 1st validator within a specific cluster (unique set of operators), use - \{0,0,0,true,0\} | - +| cluster | tuple\[] | Object containing the latest cluster snapshot data - obtained using the [SSV Subgraph](/developers/tools/ssv-subgraph/subgraph-examples#cluster-snapshot), or [SSV Scanner](/developers/tools/ssv-scanner) tools | Events: * `ValidatorAdded(address indexed owner, uint64[] operatorIds, bytes publicKey, bytes shares, Cluster cluster)` -### **`bulkRegisterValidator(publicKey, operatorIds, shares, amount, cluster)`** - -Description: Registers all the new validators provided as argument to a cluster of provided operators (ids + shares), **fails if** number of operatorIds is greater than 13. +### **`bulkRegisterValidator(publicKey, operatorIds, shares, cluster)`** -:::info -To deposit the SSV Token, you need to approve the amount of SSV tokens you wish to deposit to the cluster. +Description: Registers all the new validators provided as argument to a cluster of provided operators (ids + shares), **fails if** number of operatorIds is greater than 13. The ETH amount to deposit must be [supplied via `msg.value`](https://docs.ethers.org/v4/api-contract.html#overrides). -The approval transaction must be called on the SSV token contract, with the approval address set to the SSVNetwork contract address. [Both adddresses can be found here.](../smart-contracts) +:::info Breaking Changes +With the [introduction of ETH payments](https://ssv.network/blog/introduction-to-ssv-staking), the smart contract function signature has changed. The `amount` parameter has been removed, and the function is now `payable`. The ETH amount to deposit must be supplied via `msg.value`. Update your integrations accordingly, in line with [the ethers documentation](https://docs.ethers.org/v4/api-contract.html#overrides). ::: | **Parameter** | **Type** | **Description** | @@ -241,9 +247,7 @@ The approval transaction must be called on the SSV token contract, with the appr | publicKeys | bytes\[] | An array of validators’ public keys. | | operatorIds | unit64\[] | List of cluster operators Ids. | | sharesData | bytes\[] | An array of strings of keyshares - obtained by splitting the validator key using the [SSV-Keys](../tools/ssv-keys) Each element in this array must relate to a public key in the publicKeys array. | -| amount | uint256 (casted to uint64) | Amount of SSV token to be deposited as payment (not mandatory).Amount must be shrinkable (divisible by 10000000)p> | -| cluster | tuple\[] | Object containing the latest cluster snapshot data - obtained using the [SSV Subgraph](../tools/ssv-subgraph/subgraph-examples#cluster-snapshot), or [SSV Scanner](../tools/ssv-scanner) tools If this is the 1st validator within a specific cluster (unique set of operators), use - \{0,0,0,true,0\} | - +| cluster | tuple\[] | Object containing the latest cluster snapshot data - obtained using the [SSV Subgraph](/developers/tools/ssv-subgraph/subgraph-examples#cluster-snapshot), or [SSV Scanner](/developers/tools/ssv-scanner) tools | Events: * `ValidatorAdded(address indexed owner, uint64[] operatorIds, bytes publicKey, bytes shares, Cluster cluster)` @@ -322,21 +326,20 @@ The function emits as many `ValidatorExited` events, as is the length of the pro Please note: the number of validators that can be requested to exit from the beacon chain with the`bulkExitValidator` function is limited by the total transaction size to a maximum of **500 validator keys at a time.** -### **`deposit(owner, operatorIds, amount, cluster)`** +### **`deposit(owner, operatorIds, cluster)`** -Description: Deposits SSV token into a cluster, **will fail if** not enough tokens are approved. +Description: Deposits ETH into a cluster balance, will fail if not enough tokens are approved. -:::info -To deposit the SSV Token, you need to approve the amount of SSV tokens you wish to deposit to the cluster. +The ETH amount to deposit must be [supplied via `msg.value`](https://docs.ethers.org/v4/api-contract.html#overrides). -The approval transaction must be called on the SSV token contract, with the approval address set to the SSVNetwork contract address. [Both adddresses can be found here.](../smart-contracts) +:::info Breaking Changes +With the [introduction of ETH payments](https://ssv.network/blog/introduction-to-ssv-staking), the smart contract function signature has changed. The `amount` parameter has been removed, and the function is now `payable`. The ETH amount to deposit must be supplied via `msg.value`. Update your integrations accordingly, in line with [the ethers documentation](https://docs.ethers.org/v4/api-contract.html#overrides). ::: | **Parameter** | **Type** | **Description** | | ------------- | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | owner | address | The cluster owner address | | operatorIds | unit64\[] | List of cluster operators Ids. | -| amount | uint256 (casted to uint64) | $SSV amount to be deposited. Amount must be shrinkable (divisible by 10000000) | | cluster | tuple\[] | Object containing the latest cluster snapshot data - obtained using the [SSV Subgraph](../tools/ssv-subgraph/subgraph-examples.md#cluster-snapshot), or [SSV Scanner](../tools/ssv-scanner) tools. | Events: @@ -345,7 +348,7 @@ Events: ### **`withdraw(operatorIds, amount, cluster)`** -Description: Withdraws a specified amount of SSV tokens from cluster of msg.sender, **will fail if** msg.sender tries to withdraw more than the cluster’s liquidation collateral. To withdraw the entire cluster balance and stop its operation use liquidate(). +Description: Withdraws a specified amount of ETH from cluster of msg.sender, **will fail if** msg.sender tries to withdraw more than the cluster’s liquidation collateral. To withdraw the entire cluster balance and stop its operation use liquidate(). | **Parameter** | **Type** | **Description** | | ------------- | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -357,21 +360,17 @@ Events: * `ClusterWithdrawn(address indexed owner, uint64[] operatorIds, uint256 value, Cluster cluster)` -### **`reactivate(operatorIds, amount, cluster)`** - -Description: Reactivates a liquidated cluster, **will fail** if insufficient SSV tokens to cover the cluster’s liquidation collateral have been deposited. +### **`reactivate(operatorIds, cluster)`** -:::info -To deposit the SSV Token, you need to approve the amount of SSV tokens you wish to deposit to the cluster. +Description: Reactivates a liquidated cluster, **will fail** if insufficient ETH to cover the cluster’s liquidation collateral have been deposited. The ETH amount to deposit must be [supplied via `msg.value`](https://docs.ethers.org/v4/api-contract.html#overrides). -The approval transaction must be called on the SSV token contract, with the approval address set to the SSVNetwork contract address. [Both adddresses can be found here.](../smart-contracts) +:::info Breaking Changes +With the [introduction of ETH payments](https://ssv.network/blog/introduction-to-ssv-staking), the smart contract function signature has changed. The `amount` parameter has been removed, and the function is now `payable`. The ETH amount to deposit must be supplied via `msg.value`. Update your integrations accordingly, in line with [the ethers documentation](https://docs.ethers.org/v4/api-contract.html#overrides). ::: | **Parameter** | **Type** | **Description** | | ------------- | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| operatorIds | unit64\[] | List of cluster operators Ids. | -| amount | uint256 (casted to uint64) | $SSV amount to be deposited. Amount must be shrinkable (divisible by 10000000) - | +| operatorIds | unit64\[] | List of cluster operators Ids. | | | cluster | tuple\[] | Object containing the latest cluster snapshot data - obtained using the [SSV Subgraph](../tools/ssv-subgraph/subgraph-examples.md#cluster-snapshot), or [SSV Scanner](../tools/ssv-scanner) tools. | Events: @@ -404,24 +403,12 @@ Description: Updates network fee. | **Parameter** | **Type** | **Description** | | ------------- | -------------------------- | ------------------------------------------------------------------------------------ | -| networkFee | uint256 (casted to uint64) | The fee charged by the network per validator (denominated as $SSV tokens per block). | +| networkFee | uint256 (casted to uint64) | The fee charged by the network per 32 ETH (denominated as ETH per block). | Events: * `NetworkFeeUpdated(uint256 oldFee, uint256 newFee)` -### **`withdrawNetworkEarnings(amount)`** - -Description: Withdraws accumulated network fees in SSV token to DAO treasury. - -| **Parameter** | **Type** | **Description** | -| ------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| amount | uint256 (casted to uint64) | Amount to be withdrawn. Amount must be shrinkable (divisible by 10000000) | - -Events: - -* `NetworkEarningsWithdrawn(uint256 value, address recipient)` - ### **`updateLiquidationThresholdPeriod(blocks)`** Description: Sets the minimum period (in blocks) after which a cluster can be liquidated. @@ -436,11 +423,11 @@ Events: ### `updateMaxiumumOperatorFee`**`(maxFee)`** -Description: Updates the maximum fee an operator that uses SSV token can set +Description: Updates the maximum yearly fee per 32 ETH an operator can set | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------------------------------- | -| maxFee | uint64 | Maximum fee (in SSV tokens per year) an operator can set | +| maxFee | uint64 | Maximum fee (in ETH per year) an operator can set | Events: @@ -448,11 +435,11 @@ Events: ### `updateMinimumLiquidationCollateral(amount)` -Description: Sets the minimum collateral (in $SSV) each cluster must keep in his balance. +Description: Sets the minimum collateral (in ETH) each cluster must keep in his balance. | **Parameter** | **Type** | **Description** | | ------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| amount | uint256 (casted to uint64) | Amount of SSV collateral. Amount must be shrinkable (divisible by 10000000) | +| amount | uint256 (casted to uint64) | Amount of ETH collateral. Amount must be shrinkable (divisible by 10000000) | Events: @@ -493,3 +480,95 @@ Description: Sets the time window (in seconds) in which an operator can activate Events: * `ExecuteOperatorFeePeriodUpdated(uint64 value)` + +## Legacy Methods + +All methods that relate to the legacy (SSV-based) clusters. + +### **`withdrawOperatorEarningsSSV(operatorId)`** + +Description: Withdraws a specified amount of SSV tokens from provided operator balance to msg.sender, **will fail if** msg.sender is not the operator owner. + +| **Parameter** | **Type** | **Description** | +| ------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| operatorId | uint64 | The operator id | +| amount | uint256 (casted to uint64) | Amount must be shrinkable (divisible by 10000000) | + +Events: + +* `OperatorWithdrawn(address indexed owner, uint64 indexed operatorId, uint256 value)` + +### `withdrawAllOperatorEarningsSSV`**`(operatorId)`** + +Description: Withdraws all SSV tokens earnings from provided operator balance to msg.sender, **will fail if** msg.sender is not the operator owner. + +| **Parameter** | **Type** | **Description** | +| ------------- | -------- | --------------- | +| operatorId | uint64 | The operator id | + +Events: + +* `OperatorWithdrawn(address indexed owner, uint64 indexed operatorId, uint256 value)` + +### **`liquidateSSV(owner, operatorIds, cluster)`** + +Description: Liquidates an SSV-based cluster sends their balances to the msg.sender (the Liquidator), **will fail** if the cluster is not liquidatable (see isLiquidatable()). + +| **Parameter** | **Type** | **Description** | +| ------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| owner | address | The cluster owner address | +| operatorIds | unit64\[] | List of cluster operators Ids. | +| cluster | tuple\[] | Object containing the latest cluster snapshot data - obtained using the [SSV Subgraph](../tools/ssv-subgraph/subgraph-examples.md#cluster-snapshot), or [SSV Scanner](../tools/ssv-scanner) tools. | + +Events: + +* `ClusterLiquidatedSSV(address indexed owner, uint64[] operatorIds, Cluster cluster)` + +### **`updateNetworkFeeSSV(networkFee)`** + +Description: Updates network fee. + +| **Parameter** | **Type** | **Description** | +| ------------- | -------------------------- | ------------------------------------------------------------------------------------ | +| networkFee | uint256 (casted to uint64) | The fee charged by the network per validator (denominated as SSV tokens per block). | + +Events: + +* `NetworkFeeUpdatedSSV(uint256 oldFee, uint256 newFee)` + +### **`withdrawNetworkSSVEarnings(amount)`** + +Description: Withdraws accumulated network fees in SSV token to DAO treasury. + +| **Parameter** | **Type** | **Description** | +| ------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------- | +| amount | uint256 (casted to uint64) | Amount to be withdrawn. Amount must be shrinkable (divisible by 10000000) | + +Events: + +* `NetworkEarningsWithdrawn(uint256 value, address recipient)` + +### **`updateLiquidationThresholdPeriodSSV(blocks)`** + +Description: Sets the minimum period (in blocks) after which an SSV-based cluster can be liquidated. + +| **Parameter** | **Type** | **Description** | +| ------------- | -------- | --------------------------------------------- | +| blocks | uint64 | Duration in blocks to have sufficient balance | + +Events: + +* `LiquidationThresholdPeriodSSVUpdated(uint64 value)` + +### `updateMinimumLiquidationCollateralSSV(amount)` + +Description: Sets the minimum collateral each SSV-based cluster must keep in his balance. + +| **Parameter** | **Type** | **Description** | +| ------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| amount | uint256 (casted to uint64) | Amount of SSV token collateral. Amount must be shrinkable (divisible by 10000000) | + +Events: + +* `MinimumLiquidationCollateralSSVUpdated(uint256 value)` + diff --git a/docs/developers/smart-contracts/ssvnetworkviews.md b/docs/developers/smart-contracts/ssvnetworkviews.md index 27f4257..b0007ab 100644 --- a/docs/developers/smart-contracts/ssvnetworkviews.md +++ b/docs/developers/smart-contracts/ssvnetworkviews.md @@ -8,7 +8,7 @@ The SSVNetworkViews contract is for reading information about the network and it [SSV Views Contracts Repository](https://github.com/ssvlabs/ssv-network/tree/main/contracts) -### General Methods +## General Methods ### **`getNetworkFee ()`** @@ -18,7 +18,7 @@ Return values: | Parameter | Type | Description | |-----------|------|-------------| -| fee | uint256 | The fee charged by the network (denominated as $SSV tokens per block) | +| fee | uint256 | The fee charged by the network proportional to Effective Balance (denominated as ETH per block) | ### **`getNetworkEarnings ()`** @@ -48,13 +48,12 @@ Return values | **Parameter** | **Type** | **Description** | | ------------- | -------- | ---------------------------------------------------------------------------------------------------- | -| amount | uint256 | The minimum amount of SSV which a cluster has to have (liquidation collateral) to not be liquidated. | +| amount | uint256 | The minimum amount of ETH which a cluster has to have (liquidation collateral) to not be liquidated. | ### **`getOperatorFeeIncreaseLimit()`** Description: Returns the max amount by which operators can increase fees in each fee update cycle. This does refer to the max operator fee limitation, but to the rate (%) by which it can be increased. - Return values | **Parameter** | **Type** | **Description** | @@ -65,7 +64,6 @@ Return values Description: returns the time windows (in seconds) of operators declaration and execution fee periods. - Return values: | Parameter | Type | Description | @@ -75,15 +73,15 @@ Return values: ### **`getMaximumOperatorFee()`** -Description: **Gets the operator maximum fee for operators that use SSV token** +Description: **Gets the operator maximum fee for operators that use ETH token** Return values | Parameter | Type | Description | | --------- | ------ | -------------------------------- | -| maxFee | uint64 | The maximum fee value (SSV/year) | +| maxFee | uint64 | The maximum fee value (ETH/year) | -### `getValidatorsPerOperatorLimit()` +### **`getValidatorsPerOperatorLimit()`** Description: Returns the maximum amount of validators an operator may manage. @@ -93,7 +91,7 @@ Return values | --------------- | -------- | -------------------------------------------- | | Validator limit | uint32 | amount of validators an operator may manage. | -### Operator Methods +## Operator Methods ### **`getOperatorById (operatorId)`** @@ -108,7 +106,7 @@ Return values: | Parameter | Type | Description | |-----------|------|-------------| | owner | address | The operator's admin address (for management purposes) | -| fee | uint64256 | The fee charged by the operator (denominated as $SSV tokens per block) | +| fee | uint64256 | The fee charged by the operator (denominated as ETH per block) | | validatorCount | uint32 | The amount of managed validators | | whitelistedContract | address | The external contract set to manage this operator's whitelisted addresses | | isPrivate | boolean | Indication if operator is permissioned | @@ -126,7 +124,7 @@ Return values | **Parameter** | **Type** | **Description** | | ------------- | -------- | ---------------------------------------------------------------------- | -| declaredFee | uint256 | The fee charged by the operator (denominated as $SSV tokens per block) | +| declaredFee | uint256 | The fee charged by the operator (denominated as ETH per block) | ### **`getOperatorDeclaredFee (operatorId)`** @@ -136,7 +134,13 @@ Description: Returns the declared fee (not actual fee) together with the executi | ------------- | -------- | --------------- | | operatorId | uint64 | The operator id | -Return value**getOperatorEarnings (operatorId)** +Return value + +| **Parameter** | **Type** | **Description** | +| ------------- | -------- | ---------------------------------------------------------------------- | +| declaredFee | uint256 | The fee declared by the operator (denominated as ETH per block) | + +### **`getOperatorEarnings (operatorId)`** Description: Returns the outstanding earnings of an operator. @@ -148,13 +152,58 @@ Return values | **Parameter** | **Type** | **Description** | | ------------- | -------- | ---------------------------------------------- | -| balance | uint256 | Operators outstanding earnings in $SSV tokens. | +| balance | uint256 | Operators outstanding earnings in ETH. | + +### **`getWhitelistedOperators(operatorIds, whitelistedAddress)`** + +Description: Returns a list of operators that have this address whitelisted for them. + +| **Parameter** | **Type** | **Description** | +| ------------------ | --------- | ---------------------- | +| operatorIds | uint64\[] | List of operators Ids. | +| whitelistedAddress | address | ETH1 address | + +Return values -### Cluster Methods +| **Parameter** | **Type** | **Description** | +| ---------------------- | --------- | ---------------------------------------------------------- | +| whitelistedOperatorIds | uint64\[] | List of operator IDs that this address is whitelisted for. | + +### **`isWhitelistingContract(contractAddress)`** + +Description: Returns if a contract address is a valid whitelisting contract or not. + +| **Parameter** | **Type** | **Description** | +| ------------------ | -------- | ------------------------------ | +| whitelistedAddress | address | Whitelisting contract address. | + +Return values + +| **Parameter** | **Type** | **Description** | +| ------------- | -------- | ---------------------------------------- | +| isWhitelistingContract | bool | True if contract is valid, false if not. | + +### **`isAddressWhitelistedInWhitelistingContract(addressToCheck, operatorId, whitelistingContract)`** + +Description: Checks the whitelisted contract for an operator to see if the address provided is whitelisted for the given operator. + +| **Parameter** | **Type** | **Description** | +| ------------------ | -------- | ---------------------------------------- | +| addressToCheck | address | Address we want to check is whitelisted. | +| operatorId | uint256 | Operator ID. | +| whitelistedAddress | address | Whitelisting contract address. | + +Return values + +| **Parameter** | **Type** | **Description** | +| ------------- | -------- | --------------------------------------------- | +| isWhitelisted | bool | True if address is whitelisted, false if not. | + +## Cluster Methods ### **`getBalance (owner, operatorIds, cluster)`** -Description: Returns the outstanding SSV balance of a cluster. +Description: Returns the outstanding ETH balance of a cluster. | Parameter | Type | Description | |-----------|------|-------------| @@ -166,35 +215,231 @@ Return values: | Parameter | Type | Description | |-----------|------|-------------| -| balance | uint256 | Clusters outstanding balance denominated in $SSV tokens | +| balance | uint256 | Clusters outstanding balance denominated in ETH | ### **`getBurnRate (owner, operatorIds, cluster)`** -Description: Returns current ongoing expenses of SSV tokens for a particular SSV cluster balance on per block basis (aggregates all expenses for all the validators in this cluster).\\ +Description: Returns current ongoing expenses of ETH for a particular SSV cluster balance on per block basis (aggregates all expenses for all the validators in this cluster).\\ | **Parameter** | **Type** | **Description** | | ------------- | --------- | ------------------------------------------------------------------------------------------------------------------------ | | owner | address | The user address | | operatorIds | uint64\[] | List of cluster operators Ids. | -| cluster | tuple\[] | Object containing the latest cluster snapshot data - obtained using the [SSV Scanner](/developers/tools/ssv-scanner) tool. | +| cluster | tuple\[] | Object containing the latest cluster snapshot data - obtained using the [SSV Subgraph](/developers/tools/ssv-subgraph/subgraph-examples#cluster-snapshot), or [SSV Scanner](/developers/tools/ssv-scanner) tools If this is the 1st validator within a specific cluster (unique set of operators), use - \{0,0,0,true,0\} | Return values | **Parameter** | **Type** | **Description** | | ------------- | -------- | --------------------------------------------------- | -| burnRate | uint256 | The rate per block in which the account spends SSV. | +| burnRate | uint256 | The rate per block in which the account spends ETH. | + +### **`getClusterAssetType(address,uint64[])`** + +Description: Payment asset for the cluster identified by provided parameters. + +| **Parameter** | **Type** | **Description** | +| ------------- | --------- | ------------------------------------------------------------------------------------------------------------------------ | +| owner | address | The user address | +| operatorIds | uint64\[] | List of cluster operators Ids. | + +Return values + +| **Parameter** | **Type** | **Description** | +| --------------- | -------- | -------------------------------------------- | +| Cluster asset type | uint8 | Cluster asset type | + +### **`getEffectiveBalance(address,uint64[],tuple)`** + +Description: Total Effective Balance of the cluster identified by the provided parameters. + +| **Parameter** | **Type** | **Description** | +| ------------- | --------- | ------------------------------------------------------------------------------------------------------------------------ | +| owner | address | The user address | +| operatorIds | uint64\[] | List of cluster operators Ids. | +| cluster | tuple\[] | Object containing the latest cluster snapshot data - obtained using the [SSV Subgraph](/developers/tools/ssv-subgraph/subgraph-examples#cluster-snapshot), or [SSV Scanner](/developers/tools/ssv-scanner) tools If this is the 1st validator within a specific cluster (unique set of operators), use - \{0,0,0,true,0\} | + +Return values + +| **Parameter** | **Type** | **Description** | +| --------------- | -------- | -------------------------------------------- | +| effectiveBalance | uint32 | Total effective balance of the identified cluster | + +## Oracle Methods + +### **`getActiveOracleIds()`** + +Description: IDs of the currently active Oracles. + +Return values + +| **Parameter** | **Type** | **Description** | +| --------------- | -------- | -------------------------------------------- | +| oracleIds | uint32[4] | The active oracles' IDs. | + +### **`getOracle(uint32)`** + +Description: Wallet address of the Oracle identified by the provided ID. + +| **Parameter** | **Type** | **Description** | +| ------------- | --------- | ------------------------------------------------------------------------------------------------------------------------ | +| oracleId | uint32 | ID of the oracle to fetch. | + +Return values + +| **Parameter** | **Type** | **Description** | +| --------------- | -------- | -------------------------------------------- | +| Wallet address | address | Wallet address of the Oracle identified by the provided ID. | + +### **`getOracleWeight(uint32)`** + +Description: Delegation weight associated with the Oracle identified by the provided ID. + +| **Parameter** | **Type** | **Description** | +| ------------- | --------- | ------------------------------------------------------------------------------------------------------------------------ | +| oracleId | uint32 | ID of the oracle to fetch. | + +Return values + +| **Parameter** | **Type** | **Description** | +| --------------- | -------- | -------------------------------------------- | +| Delegation weight | unit256 | Delegation weight associated with the Oracle identified by the provided ID. | + +### **`getUserDelegation(address)`** + +Description: Returns the delegations made by the provided wallet address to the active Oracles. + +| **Parameter** | **Type** | **Description** | +| ------------- | --------- | ------------------------------------------------------------------------------------------------------------------------ | +| address | address | Wallet address to fetch delegations. | + +Return values + +| **Parameter** | **Type** | **Description** | +| --------------- | -------- | -------------------------------------------- | +| oracleIds | uint32[4] | The oracles' IDs. | +| amounts | uint256[4] | The delegations made by each Oracle. | + +### **`getQuorumBps()`** + +Description: Quorum the Oracles need to reach in order to commit a Hash root, measured in Base Points. + +Return values + +| **Parameter** | **Type** | **Description** | +| --------------- | -------- | -------------------------------------------- | +| Quorum Base Points | uint16 | Quorum the Oracles need to reach in order to commit a Hash root. | + +### **`getCommittedRoot(uint64)`** + +Description: Hash root of the total effective balance committed by the Oracles on the given block. + +| **Parameter** | **Type** | **Description** | +| ------------- | --------- | ------------------------------------------------------------------------------------------------------------------------ | +| blockNum | uint64\[] | Block number. | + +Return values + +| **Parameter** | **Type** | **Description** | +| --------------- | -------- | -------------------------------------------- | +| Hash root | bytes32 | of the total effective balance committed by the Oracles on the given block. | + +## Staking Methods + +### **`accEthPerShare()`** + +Description: Global cumulative ETH reward index per 1 cSSV share (fixed-point, scaled by PRECISION). Used to compute each account’s pending ETH via shares * index - rewardDebt. + +Return values + +| **Parameter** | **Type** | **Description** | +| --------------- | -------- | -------------------------------------------- | +| ETH reward index | uint256 | Global cumulative ETH reward index | + +### **`cooldownDuration()`** + +Description: Delay between request for withdrawal of staked SSV and the availability for tokens to be withdrawn. + +Return values + +| **Parameter** | **Type** | **Description** | +| --------------- | -------- | -------------------------------------------- | +| Cooldown duration | uint256 | The delay duration | + +### **`pendingUnstake(address)`** + +Description: List of pending unstaked token amounts and their respective remaining cooldown. + +| **Parameter** | **Type** | **Description** | +| ------------- | --------- | ------------------------------------------------------------------------------------------------------------------------ | +| Wallet address | address | User wallet address. | + +Return values + +| **Parameter** | **Type** | **Description** | +| --------------- | -------- | -------------------------------------------- | +| amounts[] | uint256 | Amounts of pending unstaked token requests. | +| unlockTimes[] | uint256 | The unlock time for each of the unstaking requests. | + +### **`previewClaimableEth(address)`** -### Liquidator Methods +Description: Amount of accrued ETH the provided address can claim. + +| **Parameter** | **Type** | **Description** | +| ------------- | --------- | ------------------------------------------------------------------------------------------------------------------------ | +| Wallet address | address | User wallet address. | + +Return values + +| **Parameter** | **Type** | **Description** | +| --------------- | -------- | -------------------------------------------- | +| Accrued amount | uint256 | Previewed amount of claimable ETH for the provided address. | + +### **`stakedBalanceOf(address)`** + +Description: Total amount of SSV tokens staked by the provided address. + +| **Parameter** | **Type** | **Description** | +| ------------- | --------- | ------------------------------------------------------------------------------------------------------------------------ | +| Wallet address | address | User wallet address. | + +Return values + +| **Parameter** | **Type** | **Description** | +| --------------- | -------- | -------------------------------------------- | +| Staked amount | uint256 | Total amount of SSV token staked by the provided address. | + +### **`stakingEthPoolBalance()`** + +Description: Total amount of ETH accrued in fees by the protocol. + +Return values + +| **Parameter** | **Type** | **Description** | +| --------------- | -------- | -------------------------------------------- | +| ETH Accrued | uint64 | Total amount of ETH accrued in fees by the protocol | + +### **`totalStaked()`** + +Description: Total amount of SSV tokens staked in the protocol. + +Return values + +| **Parameter** | **Type** | **Description** | +| --------------- | -------- | -------------------------------------------- | +| Total staked | uint256 | Amount of SSV tokens staked in the protocol. | + + +## Liquidator Methods ### **`isLiquidatable (owner, operatorIds, cluster)`** -Description: Returns true if the specified cluster is under the liquidation threshold and can be liquidated.\\ +Description: Returns true if the specified cluster is under the liquidation threshold and can be liquidated. | **Parameter** | **Type** | **Description** | | ------------- | --------- | ------------------------------------------------------------------------------------------------------------------------ | | owner | address | The user address | | operatorIds | uint64\[] | List of cluster operators Ids. | -| cluster | tuple\[] | Object containing the latest cluster snapshot data - obtained using the [SSV Scanner](/developers/tools/ssv-scanner) tool. | +| cluster | tuple\[] | Object containing the latest cluster snapshot data - obtained using the [SSV Subgraph](/developers/tools/ssv-subgraph/subgraph-examples#cluster-snapshot), or [SSV Scanner](/developers/tools/ssv-scanner) tools If this is the 1st validator within a specific cluster (unique set of operators), use - \{0,0,0,true,0\} | Return values @@ -210,7 +455,7 @@ Description: Returns true if the provided cluster is liquidated. | ------------- | --------- | ------------------------------------------------------------------------------------------------------------------------ | | owner | address | The user address | | operatorIds | uint64\[] | List of cluster operators Ids. | -| cluster | tuple\[] | Object containing the latest cluster snapshot data - obtained using the [SSV Scanner](/developers/tools/ssv-scanner) tool. | +| cluster | tuple\[] | Object containing the latest cluster snapshot data - obtained using the [SSV Subgraph](/developers/tools/ssv-subgraph/subgraph-examples#cluster-snapshot), or [SSV Scanner](/developers/tools/ssv-scanner) tools If this is the 1st validator within a specific cluster (unique set of operators), use - \{0,0,0,true,0\} | Return values @@ -218,47 +463,149 @@ Return values | ------------- | -------- | ------------------------------------- | | isLiquidated | boolean | Indication if a cluster is liquidated | -### **`getWhitelistedOperators(operatorIds, whitelistedAddress)`** +## Legacy Methods -Description: Returns a list of operators that have this address whitelisted for them. +### **`getBalanceSSV (owner, operatorIds, cluster)`** -| **Parameter** | **Type** | **Description** | -| ------------------ | --------- | ---------------------- | -| operatorIds | uint64\[] | List of operators Ids. | -| whitelistedAddress | address | ETH1 address | +Description: Returns the outstanding SSV balance of a legacy (SSV-based) cluster. + +| Parameter | Type | Description | +|-----------|------|-------------| +| owner | address | The cluster owner address | +| operatorIds | uint64[] | List of cluster operators Ids | +| cluster | tuple[] | Object containing the latest cluster snapshot data - obtained using the [SSV Scanner](/developers/tools/ssv-scanner) tool | + +Return values: + +| Parameter | Type | Description | +|-----------|------|-------------| +| balance | uint256 | Clusters outstanding balance denominated in SSV | + +### **`getBurnRateSSV (owner, operatorIds, cluster)`** + +Description: Returns current ongoing expenses of SSV for a particular SSV cluster balance on per block basis (aggregates all expenses for all the validators in this cluster).\\ + +| **Parameter** | **Type** | **Description** | +| ------------- | --------- | ------------------------------------------------------------------------------------------------------------------------ | +| owner | address | The user address | +| operatorIds | uint64\[] | List of cluster operators Ids. | +| cluster | tuple\[] | Object containing the latest cluster snapshot data - obtained using the [SSV Subgraph](/developers/tools/ssv-subgraph/subgraph-examples#cluster-snapshot), or [SSV Scanner](/developers/tools/ssv-scanner) tools If this is the 1st validator within a specific cluster (unique set of operators), use - \{0,0,0,true,0\} | Return values -| **Parameter** | **Type** | **Description** | -| ---------------------- | --------- | ---------------------------------------------------------- | -| whitelistedOperatorIds | uint64\[] | List of operator IDs that this address is whitelisted for. | +| **Parameter** | **Type** | **Description** | +| ------------- | -------- | --------------------------------------------------- | +| burnRate | uint256 | The rate per block in which the account spends ETH. | -### **`isWhitelistingContract(contractAddress)`** +### **`getNetworkFeeSSV ()`** -Description: Returns if a contract address is a valid whitelisting contract or not. +Description: Returns current network fee for legacy (SSV-based) clusters. -| **Parameter** | **Type** | **Description** | -| ------------------ | -------- | ------------------------------ | -| whitelistedAddress | address | Whitelisting contract address. | +Return values: + +| Parameter | Type | Description | +|-----------|------|-------------| +| fee | uint256 | The fee charged by the network (denominated as SSV per block) | + +### **`getNetworkEarningsSSV ()`** + +Description: Returns accumulated network fees not yet withdrawn from the legacy (SSV-based) clusters. + +Return values: + +| Parameter | Type | Description | +|-----------|------|-------------| +| amount | uint256 | Amount of fees accumulated in the network treasury | + +### **`getLiquidationThresholdPeriodSSV ()`** + +Description: Returns the minimum duration (in blocks) which legacy cluster has to have sufficient balance (liquidation collateral) to not be liquidated. Return values -| **Parameter** | **Type** | **Description** | -| ------------- | -------- | ---------------------------------------- | -| isWhitelistingContract | bool | True if contract is valid, false if not. | +| **Parameter** | **Type** | **Description** | +| ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------- | +| blocks | uint64 | The minimum duration (blocks) which legacy cluster has to have sufficient balance (liquidation collateral) to not be liquidated. | -### **`isAddressWhitelistedInWhitelistingContract(addressToCheck, operatorId, whitelistingContract)`** +### **`getMinimumLiquidationCollateralSSV()`** -Description: Checks the whitelisted contract for an operator to see if the address provided is whitelisted for the given operator. +Description: Returns the minimum amount which legacy cluster has to have sufficient balance (liquidation collateral) to not be liquidated. -| **Parameter** | **Type** | **Description** | -| ------------------ | -------- | ---------------------------------------- | -| addressToCheck | address | Address we want to check is whitelisted. | -| operatorId | uint256 | Operator ID. | -| whitelistedAddress | address | Whitelisting contract address. | +Return values + +| **Parameter** | **Type** | **Description** | +| ------------- | -------- | ---------------------------------------------------------------------------------------------------- | +| amount | uint256 | The minimum amount of SSV which a cluster has to have (liquidation collateral) to not be liquidated. | + +### **`getMaximumOperatorFeeSSV()`** + +Description: **Gets the operator maximum fee for operators that use SSV token** Return values -| **Parameter** | **Type** | **Description** | -| ------------- | -------- | --------------------------------------------- | -| isWhitelisted | bool | True if address is whitelisted, false if not. | \ No newline at end of file +| Parameter | Type | Description | +| --------- | ------ | -------------------------------- | +| maxFee | uint64 | The maximum fee value (SSV/year) | + +### **`getOperatorByIdSSV (operatorId)`** + +Description: Returns operator's data for operators participating in legacy clusters. + +| Parameter | Type | Description | +|-----------|------|-------------| +| operatorId | uint64 | The operator id | + +Return values: + +| Parameter | Type | Description | +|-----------|------|-------------| +| owner | address | The operator's admin address (for management purposes) | +| fee | uint64256 | The fee charged by the operator (denominated as SSV per block) | +| validatorCount | uint32 | The amount of managed validators | +| whitelistedContract | address | The external contract set to manage this operator's whitelisted addresses | +| isPrivate | boolean | Indication if operator is permissioned | +| active | boolean | Operator network status | + +### **`getOperatorFeeSSV (operatorId)`** + +Description: returns current operator's fee (not declared). + +| **Parameter** | **Type** | **Description** | +| ------------- | -------- | --------------- | +| operatorId | uint64 | The operator id | + +Return values + +| **Parameter** | **Type** | **Description** | +| ------------- | -------- | ---------------------------------------------------------------------- | +| declaredFee | uint256 | The fee charged by the operator (denominated as SSV per block) | + +### **getOperatorEarningsSSV (operatorId)** + +Description: Returns the outstanding earnings of an operator participating legacy cluster(s). + +| **Parameter** | **Type** | **Description** | +| ------------- | -------- | --------------- | +| operatorId | uint64 | The operator id | + +Return values + +| **Parameter** | **Type** | **Description** | +| ------------- | -------- | ---------------------------------------------- | +| balance | uint256 | Operators outstanding earnings in SSV. | + +### **`isLiquidatableSSV (owner, operatorIds, cluster)`** + +Description: Returns true if the specified legacy cluster is under the liquidation threshold and can be liquidated. + +| **Parameter** | **Type** | **Description** | +| ------------- | --------- | ------------------------------------------------------------------------------------------------------------------------ | +| owner | address | The user address | +| operatorIds | uint64\[] | List of cluster operators Ids. | +| cluster | tuple\[] | Object containing the latest cluster snapshot data - obtained using the [SSV Subgraph](/developers/tools/ssv-subgraph/subgraph-examples#cluster-snapshot), or [SSV Scanner](/developers/tools/ssv-scanner) tools If this is the 1st validator within a specific cluster (unique set of operators), use - \{0,0,0,true,0\} | + +Return values + +| **Parameter** | **Type** | **Description** | +| ------------- | -------- | ------------------------------------------- | +| isLiquidatable | boolean | Indication if a legacy cluster could be liquidated | \ No newline at end of file diff --git a/docs/developers/tools/ssv-dkg-client/change-operator-set-and-reshare-validator-key-shares.md b/docs/developers/tools/ssv-dkg-client/change-operator-set-and-reshare-validator-key-shares.md index 2d197e4..c8d35cb 100644 --- a/docs/developers/tools/ssv-dkg-client/change-operator-set-and-reshare-validator-key-shares.md +++ b/docs/developers/tools/ssv-dkg-client/change-operator-set-and-reshare-validator-key-shares.md @@ -55,7 +55,7 @@ proofsFilePath: ./output/ceremony-2024-11-18--16-04-55.529/proofs.json newOperatorIDs: [5, 6, 7, 8] ``` -* For more information on the YAML configuration file, and how to provide it to the tool, [please refer to this section (Additional flag for generate-reshare-msg)](/developers/tools/ssv-dkg-client/commands-and-config). Make sure to add the `proofsFilePath` parameter to the YAML configuration file +* For more information on the YAML configuration file, and how to provide it to the tool, [please refer to this section (Additional flag for generate-reshare-msg)](/developers/tools/ssv-dkg-client/commands-and-config). Make sure to add the `proofsFilePath` parameter to the YAML configuration file * Alternatively, the tool can be launched as a binary executable. For more information, please [refer to the appropriate section of this page](/developers/tools/ssv-dkg-client/commands-and-config) * For the reference of command line flags, [please refer to this section (Additional flag for generate-reshare-msg)](/developers/tools/ssv-dkg-client/commands-and-config), instead. Remember to add the `proofsFilePath` flag. @@ -96,7 +96,7 @@ newOperatorIDs: [5, 6, 7, 8] signatures: 111886aa25a07bbd9cb64e50e3237f98a6ecabad6f448bc9c4736ccebcacb45c56ecac273b076a5d0b1f19619bf808741dff2d8019c728e16a953d3a0b5ff4771b ``` -* For more information on the YAML file configuration, and how to provide it to the tool, [please refer to this section (Additional flag for reshare command)](/developers/tools/ssv-dkg-client/commands-and-config). +* For more information on the YAML file configuration, and how to provide it to the tool, [please refer to this section (Additional flag for reshare command)](/developers/tools/ssv-dkg-client/commands-and-config). * Alternatively, the tool can be launched as a binary executable. For more information, please [refer to the appropriate section of this page](/developers/tools/ssv-dkg-client/commands-and-config) * For the reference of command line flags, [please refer to this section (Additional flag for reshare command)](/developers/tools/ssv-dkg-client/commands-and-config), instead. diff --git a/docs/developers/tools/ssv-dkg-client/commands-and-config.md b/docs/developers/tools/ssv-dkg-client/commands-and-config.md index e6e89a6..0cac58f 100644 --- a/docs/developers/tools/ssv-dkg-client/commands-and-config.md +++ b/docs/developers/tools/ssv-dkg-client/commands-and-config.md @@ -27,7 +27,7 @@ In order to provide these features, the following options are available: * `generate-reshare-msg` - generates a message with the content of a `proofs.json` file from a past ceremony, that needs to be signed by the `owner` used in that ceremony, in order for a `reshare` ceremony to take place * `reshare` - initiates a DKG ceremony to re-generate Key Shares involving a different operator set * `generate-resign-msg` - generates a message with the content of a `proofs.json` file from a past ceremony, that needs to be signed by the `owner` used in that ceremony, in order for a `resign`ceremony to take place -* `resign` - initiates a DKG ceremony to re-generate the signature portion of existing Key Shares, providing the ability to generate Key Shares for the same validator public key, for a different `owner`, or adjusting the `nonce` for the same `owner` +* `resign` - initiates a DKG ceremony to re-generate the signature portion of existing Key Shares, providing the ability to generate Key Shares for the same validator public key, for a different `owner`, or adjusting the `nonce` for the same `owner` ### Configuration input As previously mentioned, the user can provide input to the tool either through a config file, or through a a series of command line flags. diff --git a/docs/developers/tools/ssv-scanner.md b/docs/developers/tools/ssv-scanner.md index 3ec8425..45e4d16 100644 --- a/docs/developers/tools/ssv-scanner.md +++ b/docs/developers/tools/ssv-scanner.md @@ -17,12 +17,12 @@ Clusters are unique to each account and are defined by the combination of the va Cluster snapshots are required for SSV contract transactions with cluster related functions which require the **cluster object** as input: -* [registerValidator()](/developers/smart-contracts/ssvnetwork.md#registervalidatorpublickey-operatorids-shares-amount-cluster) +* [registerValidator()](/developers/smart-contracts/ssvnetwork.md#registervalidatorpublickey-operatorids-shares-cluster) * [removeValidator()](/developers/smart-contracts/ssvnetwork#removevalidatorpublickey-operatorids-cluster) -* [deposit()](/developers/smart-contracts/ssvnetwork.md#depositowner-operatorids-amount-cluster) +* [deposit()](/developers/smart-contracts/ssvnetwork.md#depositowner-operatorids-cluster) * [withdraw()](/developers/smart-contracts/ssvnetwork.md#withdrawoperatorids-amount-cluster) * [getBalance()](/developers/smart-contracts/ssvnetworkviews.md#getbalance-owner-operatorids-cluster) -* [reactivate()](/developers/smart-contracts/ssvnetwork.md#reactivateoperatorids-amount-cluster) +* [reactivate()](/developers/smart-contracts/ssvnetwork.md#reactivateoperatorids-cluster) * [isLiquidated()](/developers/smart-contracts/ssvnetworkviews.md#isliquidated-owner-operatorids-cluster) * [isLiquidatable()](/developers/smart-contracts/ssvnetworkviews.md#isliquidatable-owner-operatorids-cluster) * [liquidate()](/developers/smart-contracts/ssvnetwork.md#liquidateowner-operatorids-cluster) diff --git a/docs/developers/tools/ssv-subgraph/subgraph-examples.md b/docs/developers/tools/ssv-subgraph/subgraph-examples.md index e10047d..31c83e5 100644 --- a/docs/developers/tools/ssv-subgraph/subgraph-examples.md +++ b/docs/developers/tools/ssv-subgraph/subgraph-examples.md @@ -84,7 +84,7 @@ Output: ### Cluster Snapshot -Returns the Cluster Snapshot needed in many smart contracts functions, like [registering a validator](../../smart-contracts/ssvnetwork.md#registervalidatorpublickey-operatorids-shares-amount-cluster). +Returns the Cluster Snapshot needed in many smart contracts functions, like [registering a validator](/developers/smart-contracts/ssvnetwork.md#bulkregistervalidatorpublickey-operatorids-shares-cluster). :::info Please note The cluster's `id` is generated by concatenating the owner address and the operator IDs using a dash (`-`) separator. @@ -165,7 +165,7 @@ Output ### DAO constants and protocol network fee index -Returns the value of important values set by the DAO (such as Minimum Liquidation Collatera, and Liquidation Threshold Period), as well as the protocol-wide Network Fee Index, needed to calculate the balance of clusters and verify their risk of liquidation. +Returns the value of important values set by the DAO (such as Minimum Liquidation Collatera, and Liquidation Threshold Period), as well as the protocol-wide Network Fee Index, needed to calculate the balance of clusters and verify their risk of liquidation, or the amount of ETH per each share of SSV tokens. :::info Please note The `id` of `daovalues` is the address of the SSVNetwork smart contract deployed on the current chain. So in the case of Hoodi it's ` 0x58410Bef803ECd7E63B23664C586A6DB72DAf59c` @@ -186,6 +186,16 @@ query daoValues { networkFeeIndexBlockNumber operatorFeeIncreaseLimit operatorMaximumFee + quorum + accEthPerShare + latestMerkleRoot + totalEffectiveBalance + networkFeeSSV + networkFeeIndexSSV + operatorMaximumFeeSSV + liquidationThresholdSSV + networkFeeIndexBlockNumberSSV + minimumLiquidationCollateralSSV } } ``` @@ -207,6 +217,16 @@ query daoValues { networkFeeIndexBlockNumber operatorFeeIncreaseLimit operatorMaximumFee + quorum + accEthPerShare + latestMerkleRoot + totalEffectiveBalance + networkFeeSSV + networkFeeIndexSSV + operatorMaximumFeeSSV + liquidationThresholdSSV + networkFeeIndexBlockNumberSSV + minimumLiquidationCollateralSSV } }`; @@ -229,7 +249,7 @@ console.log(responseData); curl -X POST "https://api.studio.thegraph.com/query/71118/ssv-network-hoodi/version/latest" \ -H "Content-Type: application/json" \ -d '{ - "query": "query daoValues { daovalues(id: \"0x58410Bef803ECd7E63B23664C586A6DB72DAf59c\") { declareOperatorFeePeriod executeOperatorFeePeriod liquidationThreshold minimumLiquidationCollateral networkFee networkFeeIndex networkFeeIndexBlockNumber operatorFeeIncreaseLimit operatorMaximumFee }}" + "query": "query daoValues { daovalues(id: \"0x58410Bef803ECd7E63B23664C586A6DB72DAf59c\") { declareOperatorFeePeriod executeOperatorFeePeriod liquidationThreshold minimumLiquidationCollateral networkFee networkFeeIndex networkFeeIndexBlockNumber operatorFeeIncreaseLimit operatorMaximumFee quorum accEthPerShare latestMerkleRoot totalEffectiveBalance networkFeeSSV networkFeeIndexSSV operatorMaximumFeeSSV liquidationThresholdSSV networkFeeIndexBlockNumberSSV minimumLiquidationCollateralSSV }}" }' ``` @@ -241,15 +261,25 @@ Output { "data": { "daovalues": { - "declareOperatorFeePeriod": "604800", - "executeOperatorFeePeriod": "60480", - "liquidationThreshold": "214800", - "minimumLiquidationCollateral": "1000000000000000000", - "networkFee": "382640000000", - "networkFeeIndex": "215784140000000", - "networkFeeIndexBlockNumber": "131572", + "declareOperatorFeePeriod": "180", + "executeOperatorFeePeriod": "180", + "liquidationThreshold": "50190", + "minimumLiquidationCollateral": "940000000000000", + "networkFee": "3550000000", + "networkFeeIndex": "704794182000000000", + "networkFeeIndexBlockNumber": "2122845", "operatorFeeIncreaseLimit": "1000", - "operatorMaximumFee": "76528650000000" + "operatorMaximumFee": "13900000000", + "quorum": 7500, + "accEthPerShare": "8640821385400000", + "latestMerkleRoot": "0x00000000", + "totalEffectiveBalance": "1685694", + "networkFeeSSV": "0", + "networkFeeIndexSSV": "0", + "operatorMaximumFeeSSV": "0", + "liquidationThresholdSSV": "214800", + "networkFeeIndexBlockNumberSSV": "0", + "minimumLiquidationCollateralSSV": "1000000000000000000" } } } @@ -579,7 +609,7 @@ Output ### Cluster Data by ID (Balance, Active status and Operator IDs) -Returns balance, active status and operator IDs for a cluster. +Returns active status, effective balance, fee asset type (ETH or SSV), validator count and public key for all its validators. :::info Please note The cluster's `id` is generated by concatenating the owner address and the operator IDs using a dash (`-`) separator. @@ -592,13 +622,12 @@ The cluster's `id` is generated by concatenating the owner address and the opera query ClusterData { cluster(id: "0x0f1651507bdd33d3d18a5732c22d4713020cd100-5-6-7-8") { active + effectiveBalance + feeAsset + validatorCount validators { id - owner { - id - } } - validatorCount } } ``` @@ -612,13 +641,12 @@ const query = ` query ClusterData { cluster(id: "0x0f1651507bdd33d3d18a5732c22d4713020cd100-5-6-7-8") { active + effectiveBalance + feeAsset + validatorCount validators { id - owner { - id - } } - validatorCount } }`; @@ -641,7 +669,7 @@ console.log(responseData); curl -X POST "https://api.studio.thegraph.com/query/71118/ssv-network-hoodi/version/latest" \ -H "Content-Type: application/json" \ -d '{ - "query": "query ClusterData { cluster(id: \"0x0f1651507bdd33d3d18a5732c22d4713020cd100-5-6-7-8\") { active validators { id owner { id } } validatorCount }}" + "query": "query ClusterData { cluster(id: \"0x0f1651507bdd33d3d18a5732c22d4713020cd100-5-6-7-8\") { active effectiveBalance feeAsset validatorCount validators { id } }}" }' ``` @@ -654,6 +682,9 @@ Output: "data": { "cluster": { "active": true, + "effectiveBalance": "110000000000000000000", + "feeAsset": "ETH", + "validatorCount": "3" "validators": [ { "id": "0x82808139fefab04eec339d1e4137b0e7d05eb75ec5eacdfe0b6f8d1cf2151b9f46ff3854e3ac5f44467fdc86bdbca345", @@ -674,7 +705,6 @@ Output: } } ], - "validatorCount": "3" } } } @@ -695,6 +725,7 @@ query ValidatorCountPerOperator { totalWithdrawn isPrivate validatorCount + totalEffectiveBalance whitelisted { id } @@ -715,6 +746,7 @@ query ValidatorCountPerOperator { totalWithdrawn isPrivate validatorCount + totalEffectiveBalance whitelisted { id } @@ -740,7 +772,7 @@ console.log(responseData); curl -X POST "https://api.studio.thegraph.com/query/71118/ssv-network-hoodi/version/latest" \ -H "Content-Type: application/json" \ -d '{ - "query": "query ValidatorCountPerOperator { operator(id: \"7\") { fee removed totalWithdrawn validatorCount isPrivate whitelisted { id } }}" + "query": "query ValidatorCountPerOperator { operator(id: \"7\") { fee removed totalWithdrawn validatorCount totalEffectiveBalance isPrivate whitelisted { id } }}" }' ``` @@ -756,6 +788,7 @@ Output: "removed": false, "totalWithdrawn": "0", "validatorCount": "318", + "totalEffectiveBalance": "651264", "isPrivate": false, "whitelisted": [] } @@ -763,6 +796,107 @@ Output: } ``` +### Oracle data by ID (oracle ID, address, total delegated amount and its delegators) + +Returns oracle ID, address, total delegated amount and its delegators of a given Oracle + + + + +```graphql +query OracleData { + operator(id: "1") { + totalDelegatedAmount + oracleId + oracleAddress + id + delegators { + amount + delegator { + id + } + } + } + } +} +``` + + + + +```javascript +const url = "https://api.studio.thegraph.com/query/71118/ssv-network-hoodi/version/latest"; +const query = ` +query OracleData { + operator(id: "1") { + totalDelegatedAmount + oracleId + oracleAddress + id + delegators { + amount + delegator { + id + } + } + } + } +}`; + +const response = await fetch(url, { + method: 'POST', + headers: { + 'Content-Type': 'application/json', + }, + body: JSON.stringify({ query }) +}); + +const responseData = await response.json(); +console.log(responseData); +``` + + + + +```bash +curl -X POST "https://api.studio.thegraph.com/query/71118/ssv-network-hoodi/version/latest" \ + -H "Content-Type: application/json" \ + -d '{ + "query": "query OracleData { operator(id: \"1\") { totalDelegatedAmount oracleId oracleAddress id delegators { amount delegator { id } } } } }" +}' +``` + + + + +Output: +```json +{ + "data": { + "oracle": { + "totalDelegatedAmount": "5421250000000000000000", + "oracleId": "1", + "oracleAddress": "0x011684890d10ecc4473f2a4a8b0f2cb7f19c66eb", + "id": "1", + "delegators": [ + { + "amount": "7750000000000000000", + "delegator": { + "id": "0x4f0f5ab30f62b62ed0466b697f0ec7b30560ee48" + } + }, + { + "amount": "6250000000000000000", + "delegator": { + "id": "0x599fdcd9b73052226721f093fe7b0bddd393fbdf" + } + } + ] + } + } +} +``` + ### 10 most recent clusters with a validator count of 4 Returns data on the 10 most recent clusters, we get this by the last updated blocks and using `orderBy: lastUpdateBlockNumber`and sort it by descending using `orderDirection: desc` diff --git a/docs/learn/glossary.md b/docs/learn/glossary.md index e74b15a..581f5d8 100644 --- a/docs/learn/glossary.md +++ b/docs/learn/glossary.md @@ -13,12 +13,27 @@ The Beacon Chain is a brand-new, proof-of-stake blockchain that stores and manag ### Cluster -The group (usually 4, in compliance with [the fault tolerance rule is accepted](../../../stakers/validators/validator-onboarding)) of non-trusting operators that manage a set (one, or multiple) validator(s). Each operator in the cluster holds a share of the complete validator key, for more information, see [Shamir Secret Sharing](glossary.md#shamir-secret-sharing). +The group (usually 4, in compliance with [the fault tolerance rule is accepted](/stakers/validators/validator-onboarding)) of non-trusting operators that manage a set (one, or multiple) validator(s). Each operator in the cluster holds a share of the complete validator key, for more information, see [Shamir Secret Sharing](glossary.md#shamir-secret-sharing). ### Consensus Client Formerly known as an Eth2 client. Runs the Ethereum PoS (Proof-of-Stake) consensus layer, aka the Beacon Chain, checking the validity of transactions and new blocks. Examples of consensus clients include Prysm, Teku, Lighthouse, Nimbus, and Lodestar. +### cSSV Unstaking Cooldown Period + +The mandatory waiting period (initially 7-days) between cSSV token unstaking and withdrawing your staked SSV. During this cooldown: +- Rewards stop accruing immediately +- Oracle voting weight remains active +- The process cannot be cancelled +- Unclaimed rewards can still be claimed + +The cooldown exists to maintain oracle voting stability and prepare for future governance mechanisms. + +### cSSV + +A non-rebasing transferrable ERC-20 token received when you stake SSV tokens. When unstaking, cSSV is burned and you receive back your original SSV plus any unclaimed rewards. cSSV contributes to the network's oracle infrastructure by providing voting weight for effective balance reporting. + + ### Custodial Staking Centralized service that manages the entire ETH staking process on behalf of the user and retains custody over user private validator keys and withdrawal keys. Custodial staking risks include: severe slashing penalties, reduced overall rewards and increased likelihood of attack on user keys as they are held in a centralized fashion by the service. @@ -35,6 +50,12 @@ A cryptographic process to generate a shared public and private key set, calcula Distributed Validator Technology is another name for SSV (Secret Shared Validator). SSV can also be referred to as DVT because the validator is distributed over multiple non-trusting nodes. +### Effective Balance (EB) + +The active stake balance of a validator on the Beacon Chain is used to calculate staking rewards. After Ethereum's Pectra upgrade, validators can have variable effective balances from 32 to 2048 ETH (previously fixed at 32 ETH). + +In SSV Network, effective balance is used as fee accounting measure. Clusters pay fees proportional to their validators' actual EBs. The EBs is reported by oracles and used to calculate fair fee distribution. + ### Epochs & Slots An epoch lasts approximately 6.4 minutes, and includes 32 slots. A slot lasts 12 seconds, during and is the time period in which a randomly selected validator proposes a block. @@ -93,6 +114,12 @@ Applying secure Multi-Party Computation (MPC) to secret sharing allows for KeySh A service that provides streamlined Ethereum validator set-up and management, but does not hold user private validator keys AND withdrawal keys. Allowing users to maximize staking returns, mitigate security risks and retain complete control over their assets. +### Effective Balance Oracles + +In the SSV Network, oracles report validator effective balances from the Beacon Chain to on-chain smart contracts. + +These oracles are backed by SSV stakers, who delegate their voting power to their chosen Effective Balance (EB) oracle. This system enables fair fee calculation for validators with variable balances following the Pectra upgrade. + ### Operator Individuals or institutions that provide the hardware infrastructure, run the SSV protocol, and manage validator KeyShares on behalf of users (stakers). Operators collect fees from stakers in SSV tokens in return for operating their validator(s) on ssv.network. Each operator is ranked on a scale of 0-100% by the DAO based on the overall quality of service they provide. @@ -128,19 +155,24 @@ The SSV Node software maintain peer-to-peer connections with other Nodes to hand ### SSV Token -ssv.network allows access to a decentralized ETH staking infrastructure with SSV token as the protocol’s native token. It has 3 main purposes: +ssv.network allows access to a decentralized ETH staking infrastructure with SSV token as the protocol's native token. It has 4 main purposes: * **Governance** – Submitting votes and voting on DAO proposals -* **Fees** – Operators receive SSV tokens from Stakers for managing and operating validators on their behalf +* **Payments** – The network receives fees paid in ETH by clusters * **Grants** – DAO funding for developers and contributors helping to grow the network +* **Staking** – The oracle infrastructure is supported through SSV staking, which enables the delegation of voting power to a chosen oracle. + +### SSV Staker + +An SSV token holder who stakes their SSV tokens to contribute voting weight to the network's oracle system, which reports validator effective balances to the blockchain. When staking SSV a holder receives cSSV which also allows to participates in SSV governance. ### Staker -Services or individual ETH holders that wish to leverage SSV/DVT technology for optimal liveness, security and decentralization of their validator(s). Stakers put 32 ETH “at stake” for each validator they want to run. In the PoS consensus mechanism, validators secure the Ethereum blockchain and earn ETH rewards in return for doing so. +Services or individual ETH holders that wish to leverage SSV/DVT technology for optimal liveness, security and decentralization of their validator(s). Stakers put 32 ETH "at stake" for each validator they want to run. In the PoS consensus mechanism, validators secure the Ethereum blockchain and earn ETH rewards in return for doing so. ### Staking -Staking is the contributory action of running a node in a PoS consensus mechanism blockchain. One must ‘put at stake’ a certain amount of network tokens in order to participate in securing the blockchain by verifying and adding blocks. On Ethereum, the minimum threshold to participate as a validator is 32 ETH. Validators will earn ETH rewards for honestly attesting to and adding blocks. A validator risks decreasing their stake by participating in malicious behaviors or for time spent offline, disconnected from the network. +Staking is the contributory action of running a node in a PoS consensus mechanism blockchain. One must 'put at stake' a certain amount of network tokens in order to participate in securing the blockchain by verifying and adding blocks. On Ethereum, the minimum threshold to participate as a validator is 32 ETH. Validators will earn ETH rewards for honestly attesting to and adding blocks. A validator risks decreasing their stake by participating in malicious behaviors or for time spent offline, disconnected from the network. ### Total Value Locked (TVL) @@ -148,6 +180,8 @@ The total amount of ETH in USD (or other currency) that is “locked-up” by st ### Validator -A validator is responsible for confirming transactions and proposing new blocks on the Ethereum blockchain. In order to run a validator, one must put 32 ETH ‘at stake’, which is subject to increase (or decrease) as the validator performs its assigned duties. A validator is different from the comparable concept of a miner on the legacy Ethereum chain, as validators are called upon by the PoS protocol to propose and validate emerging blocks rather than compete for their generation. +A validator is responsible for confirming transactions and proposing new blocks on the Ethereum blockchain. In order to run a validator, one must put 32 ETH 'at stake', which is subject to increase (or decrease) as the validator performs its assigned duties. A validator is different from the comparable concept of a miner on the legacy Ethereum chain, as validators are called upon by the PoS protocol to propose and validate emerging blocks rather than compete for their generation. An SSV validator is one that is run on ssv.network and employs SSV technology to split the validator key into 4 KeyShares for the purposes of distributing the validator over multiple nodes for redundancy and fault-tolerance. + +Post-Pectra, validators can have variable effective balances from 32 to 2048 ETH. \ No newline at end of file diff --git a/docs/learn/introduction/governance.md b/docs/learn/introduction/governance.md index 1ccda5b..e5dbd77 100644 --- a/docs/learn/introduction/governance.md +++ b/docs/learn/introduction/governance.md @@ -18,7 +18,7 @@ The ssv.network DAO exercises its mandate by two main mechanisms. The first is b * **Network fees** - To use ssv.network, stakers are required to pay a network fee. The network fee is a fixed cost charged per validator, and it’s determined by the DAO. Network fees flow directly into the DAO treasury and can be used to fund further development of the SSV ecosystem and activities that have passed the DAO voting process. Decisions regarding new fee amounts need to be balanced; high enough to cover DAO expenses; but low enough for the SSV protocol to remain competitive. * **Operator fees -** These fees are set and controlled by the operators themselves, not by the DAO governance. The smart contract does however include guardrails that limit the amount by which operators can increase their fees in each fee change cycle as well as the cycle duration (read more on [Operator fee change guidelines](/operators/operator-onboarding/update-fee)). These parameters are essential to ensure the stability of the network and to protect stakers against sudden operator price hikes. On the other hand, if the rate of fee change was too low or the fee change was too long, it could cause the system to be too rigid and not adaptable to the changing market conditions. Setting these parameters must be done judiciously to match the current market conditions. -* **Liquidation parameters** - DAO governance sets the minimum SSV balance required to cover fees for each validator. If the account balance goes below this liquidation threshold, it will be at risk of liquidation. This parameter is essential to ensure the health of the network, and protects it from becoming insolvent (read more on [Liquidations](../protocol-overview/tokenomics/liquidations.md)) +* **Liquidation parameters** - DAO governance sets the minimum SSV balance required to cover fees for each validator. If the account balance goes below this liquidation threshold, it will be at risk of liquidation. This parameter is essential to ensure the health of the network, and protects it from becoming insolvent (read more on [Liquidations](/learn/tokenomics/liquidations.md)) #### Governance Functions diff --git a/docs/learn/introduction/network-overview.md b/docs/learn/introduction/network-overview.md index 59a0565..a371725 100644 --- a/docs/learn/introduction/network-overview.md +++ b/docs/learn/introduction/network-overview.md @@ -8,15 +8,12 @@ The ssv.network ecosystem is composed of 3 types of actors: stakers, operators a ### [Stakers](../../stakers) -Services or individual ETH holders that leverage SSV/DVT technology for optimal liveness, security, and decentralization of their validator(s). Stakers pay a fee in SSV tokens to operators for managing their validator(s). +Services or individual ETH holders that leverage SSV/DVT technology for optimal liveness, security, and decentralization of their validator(s). Stakers pay a fee in ETH to operators for managing their validator(s). ### [Operators](../../operators) -Operators provide the hardware infrastructure, run the SSV protocol, and are responsible for maintaining validators and the overall health of ssv.network. Operators determine their fees for services in SSV tokens and charge stakers for operating and maintaining their validator(s). +Operators provide the hardware infrastructure, run the SSV protocol, and are responsible for maintaining validators and the overall health of ssv.network. Operators determine their fees for services in ETH and charge stakers for operating and maintaining their validator(s). ### DAO The ssv.network DAO decentralises ownership and governance of the ssv.network protocol and treasury, with SSV being the native token of the network. DAO exercises its mandate by two main mechanisms, executing governance functions and executing snapshot proposals passed by the token holders. For more information read the [governance section](governance.md). - - - diff --git a/docs/learn/introduction/oracles.md b/docs/learn/introduction/oracles.md new file mode 100644 index 0000000..316f4f5 --- /dev/null +++ b/docs/learn/introduction/oracles.md @@ -0,0 +1,33 @@ +--- +description: Effective Balance Oracles described and explained +sidebar_position: 2 +--- + +# Effective Balance Oracles + +## Introduction + +Effective Balance Oracles are responsible for tracking validator effective balances on the beacon chain and enable the protocol to keep [its on-chain accounting](/stakers/clusters/effective-balance.md) aligned with real validator state as balances evolve over time. + +## Overview + +SSV stakers delegate their staking weight to oracle operators, using stake as voting power. The oracle set is then composed of the operators with the highest delegated stake, allowing the set to evolve and rotate over time based on staker preferences and observed performance. + +Stake-based delegation is a critical component of this design. Effective Balance Oracles directly influence protocol accounting and liquidation behavior, making correctness and reliability essential. By tying oracle selection to delegated stake, the protocol ensures that oracle operators are economically aligned with the system: operators with higher delegated stake are incentivized to behave correctly, while stakers can reallocate delegation away from underperforming or untrusted oracles. + +## Effective Balance Updates + +### Cluster Balance Snapshots + +Effective Balance Oracles continuously track validator effective balances on the beacon chain. At defined intervals, they take a snapshot of all validator balances, aggregate them per cluster, and construct a Merkle tree representing the effective balances of all clusters at that snapshot. + +To reach consensus on this snapshot, each oracle independently commits the Merkle root representing this snapshot. Once a threshold of oracle commitments is reached, the snapshot is accepted by the protocol as the authoritative and accurate view of effective balances for that point in time. This threshold-based mechanism ensures both correctness of the data and that no single oracle can dictate balance updates. + +### Cluster Balance Updates + +Once a snapshot is accepted, cluster-level effective balances can be updated on-chain by submitting a proof derived from the committed Merkle tree for a specific cluster. + +When a cluster’s effective balance is updated, the protocol updates all related accounting based on the new value. This affects: +- Cluster runway calculations +- Network and operator fee accruals tied to the amount of effective balance being managed +- If an update causes a cluster to fall below liquidation thresholds, the cluster can be liquidated as part of the same process. \ No newline at end of file diff --git a/docs/learn/introduction/ssv-token.md b/docs/learn/introduction/ssv-token.md index e4b74af..d3462a1 100644 --- a/docs/learn/introduction/ssv-token.md +++ b/docs/learn/introduction/ssv-token.md @@ -4,23 +4,26 @@ sidebar_position: 3 # SSV Token -Secret Shared Validator ($SSV) is the native token of [ssv.network](https://ssv.network/). +Secret Shared Validator (SSV) is the native token of [ssv.network](https://ssv.network/). -$SSV's main use cases are payments and governance. +SSV's main use cases are governance and staking. -* **Payments** - serve as a way for stakers to compensate operators for managing their validators -* **Governance** - a way to participate in ssv.network related decision-making and treasury allocations. +* **Governance** - A way to participate in ssv.network related decision-making and treasury allocations +* **Staking** - Stake SSV tokens to support oracle infrastructure -$SSV is playing a pivotal role in the network’s ability to harness a community and motivate the right stakeholders to meaningfully contribute to the network. +SSV is playing a pivotal role in the network's ability to harness a community and motivate the right stakeholders to meaningfully contribute to the network. -### **Tokenomics** +## SSV token utility + +Staked SSV supports the network's oracle infrastructure by providing voting weight for Effective Balance reporting. -Stakers using ssv.network will pay operators using $SSV. Each participating operator can determine its own price point and compete with other network operators. A percentage of fees collected by operators will be allocated to the DAO treasury in return the DAO will determine the payment in an open vote. +**Key benefits:** +* Support the network's oracle system for validator balance reporting +* Participate in securing decentralized oracle consensus +* Receive rewards from actual network activity -Fundamentally, the more ETH is staked in the network, the more fees will be paid to operators and the DAO’s treasury. The DAO will be able to use its treasury for promoting the network’s growth and development efforts thus creating a positive cycle of ETH inflows and $SSV revenue. +Learn more in the [SSV Staking Guide](/ssv-staking/). -$SSV is designed to exponentially progress the network's core values: +### **Tokenomics** -1. **Decentralized DAO governance -** no single entity or group should have control over the network. -2. **DAO treasury -** continuously increase the DAO’s treasury value (for-profit DAO)**.** A stable, and well-funded treasury will allow the DAO to expedite development efforts, allocate grants and engage in revenue share schemes for DAO members. -3. **Operator income -** a growing network will affect operator compensation. Higher income will incentivize new operators to join the network and existing ones to improve their service, performance, and competitiveness. +You can find more details on the [Tokenomics dedicated docs page](/learn/tokenomics/README.md). \ No newline at end of file diff --git a/docs/learn/introduction/tech-overview.md b/docs/learn/introduction/tech-overview.md index 9bbca1c..85abb5a 100644 --- a/docs/learn/introduction/tech-overview.md +++ b/docs/learn/introduction/tech-overview.md @@ -9,13 +9,13 @@ SSV is a sophisticated multi-signature wallet with a consensus layer. It is a mi * **Distributed Key Generation** -This process generates a shared public and private key set calculated by the operators running an SSV instance. Each operator owns a single portion of the private key, ensuring that no single operator can affect or have control over the entire private key and make unilateral decisions. +This process generates a shared public and private key set calculated by the operators running an SSV instance. Each operator owns a single portion of the private key, ensuring that no single operator can affect or have control over the entire private key and make unilateral decisions. * **Shamir Secret Sharing** This mechanism used to reconstruct a validator key using a pre-defined threshold of KeyShares. Individual KeyShares cannot be used to sign a duty, yet not all are needed if some are faulty as described by n≥3f+1. -SSV.network is able to leverage the BLS signatures - allowing for multiple signatures to be combined to recreate a validator key signature. By combining Shamir and BLS - the keys are 'broken down' to share and regrouped whenever a duty is assigned. +SSV.network is able to leverage the BLS signatures - allowing for multiple signatures to be combined to recreate a validator key signature. By combining Shamir and BLS - the keys are 'broken down' to share and regrouped whenever a duty is assigned. * **Multi-Party Computation** @@ -23,4 +23,4 @@ Applying secure Multi-Party Computation (MPC) to secret sharing allows the KeySh * **Istanbul Byzantine Fault Tolerance Consensus** -Tying it all together, the consensus layer of SSV, based on the Istanbul Byzantine Fault Tolerance (IBFT) algorithm. The algorithm randomly selects a validator node (KeyShare) responsible for block proposal and sharing the information with the other participants. Once the predefined threshold of KeyShares deems the block to be valid, it is added to the chain. As such, consensus can be reached even if some operators (up to the threshold) are faulty or not currently online. +Tying it all together, the consensus layer of SSV, based on the Istanbul Byzantine Fault Tolerance (IBFT) algorithm. The algorithm randomly selects a validator node (KeyShare) responsible for block proposal and sharing the information with the other participants. Once the predefined threshold of KeyShares deems the block to be valid, it is added to the chain. As such, consensus can be reached even if some operators (up to the threshold) are faulty or not currently online. diff --git a/docs/learn/protocol-overview/README.md b/docs/learn/protocol-overview/README.md index d19d29f..67e7df5 100644 --- a/docs/learn/protocol-overview/README.md +++ b/docs/learn/protocol-overview/README.md @@ -1,6 +1,7 @@ --- sidebar_label: 'Protocol Overview' sidebar_position: 2 +unlisted: true --- # Protocol Overview diff --git a/docs/learn/protocol-overview/tokenomics/README.md b/docs/learn/protocol-overview/tokenomics/README.md deleted file mode 100644 index 46c7af1..0000000 --- a/docs/learn/protocol-overview/tokenomics/README.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -description: Understanding SSV Network tokenomics -sidebar_position: 1 ---- - -# Tokenomics - -The ssv.network utilizes its native SSV token to facilitate payments between stakers and SSV node operators to maintain their validators. Operators maintain validators by reaching a consensus with clusters of other operators to perform network duties on the beacon chain, thereby generating Ethereum staking rewards for stakers. - -Operators receive SSV payments and generate ETH rewards for stakers. Stakers pay SSV and receive generated ETH rewards in return. - - -![Operators receive SSV payments and generate ETH rewards for stakers. Stakers pay SSV and receive generated ETH rewards in return.](/img/tokenomics-readme-1.avif) -*Operators receive SSV payments and generate ETH rewards for stakers. Stakers pay SSV and receive generated ETH rewards in return.* \ No newline at end of file diff --git a/docs/learn/tokenomics/README.md b/docs/learn/tokenomics/README.md new file mode 100644 index 0000000..a04c976 --- /dev/null +++ b/docs/learn/tokenomics/README.md @@ -0,0 +1,55 @@ +--- +description: Understanding SSV Network tokenomics +sidebar_position: 1 +--- + +# Tokenomics + +The ssv.network utilizes its native SSV token to function as an ETH-accrual token. ETH is used to facilitate payments between stakers and SSV node operators to maintain their validators. Operators maintain validators by reaching a consensus with clusters of other operators to perform network duties on the beacon chain, thereby generating Ethereum staking rewards for stakers. + +Operators receive ETH payments and generate ETH rewards for stakers. Stakers pay ETH and receive generated ETH rewards in return. + +![Operators receive ETH payments and generate ETH rewards for stakers. Stakers pay ETH and receive generated ETH rewards in return.](/img/tokenomics-readme-1.png) +*Operators receive ETH payments and generate ETH rewards for stakers. Stakers pay ETH and receive generated ETH rewards in return.* +SSV Network has evolved to include both payment mechanisms and staking utilities, creating a comprehensive economic model that aligns network growth with token holder rewards. + +## Network Payments + +The network uses ETH-based payments for clusters and operators: + +* **Clusters pay in ETH** - Deposit ETH to cover operator and network fees +* **Operators earn in ETH** - Receive ETH payments for managing validators +* **Network fees in ETH** - A portion of fees flows to the protocol + +![Operators receive ETH payments and generate rewards for stakers. Stakers pay ETH and receive generated rewards in return.](/img/tokenomics-readme-1.png) +*Operators receive ETH payments and generate rewards for stakers. Stakers pay ETH and receive generated rewards in return.* + +## SSV token utility + +Staked SSV supports the network's oracle infrastructure by providing voting weight for effective balance reporting. + +Also, when clusters pay fees in ETH, a portion flows into the SSV Staking contract and is distributed proportionally to all token holders. Learn more in the [SSV Staking Guide](/ssv-staking/). + +## Dual Utility Model + +SSV token serves multiple purposes in the ecosystem: + +| Utility | Description | Benefit | +|---------|-------------|---------| +| **Governance** | Vote on protocol decisions and treasury allocation | Decentralized control | +| **Oracle Support** | Staked SSV supports oracle consensus | Network security and accuracy | +| **Legacy Payments** | SSV tokens still used in legacy clusters | Backward compatibility | +| **Staking** | Stake SSV to support the network's oracle infrastructure | Provides voting weight for effective balance reporting | + +## Economic Sustainability + +The new economic model creates sustainable, circular value flow: + +1. **More ETH staked** → More validators using SSV +2. **More validators** → More ETH fees collected +3. **More fees** → Higher rewards for SSV stakers +4. **Higher rewards** → Increased usability for SSV token +5. **More SSV staked** → Stronger oracle infrastructure +6. **Stronger network** → Attracts more ETH validators + +This positive feedback loop ties SSV directly to real network usage and rewards. diff --git a/docs/learn/protocol-overview/tokenomics/fees.md b/docs/learn/tokenomics/fees.md similarity index 57% rename from docs/learn/protocol-overview/tokenomics/fees.md rename to docs/learn/tokenomics/fees.md index 8f825d9..2696a61 100644 --- a/docs/learn/protocol-overview/tokenomics/fees.md +++ b/docs/learn/tokenomics/fees.md @@ -8,18 +8,18 @@ sidebar_position: 1 The ssv.network utilizes a free-market approach such that operators can set their desired fees. This approach drives competition between operators and helps ensure that operator services are provided to stakers at lower costs. -When operators register to the network, they set their fee (denominated in SSV), which is then charged to each validator that selects them as an operator. +When operators register to the network, they set their fee, which is then charged to each validator that selects them as an operator. For simplicity and standardization, fees charged for using the network are normalized as annual payments. Although, in practice, they are paid to operators on an ongoing basis - per each passing block (contrary to a single payment model). -For example, assuming there are 100 blocks per day and an operator has a set fee of 365 SSV per year, then the revenue from each validator would be: +For example, assuming there are 100 blocks per day and an operator has a set fee of 0.365 ETH per year, then the revenue from each validator would be: -365 ssv / 100 blocks per day / 365 days in a year = 0.01 SSV per block +0.365 ETH / 100 blocks per day / 365 days in a year = 0.00001 ETH per block + +You can find more details on the dedicated [Operator Onboarding page](/operators/operator-onboarding/README.md). ### Network Fees In addition to operator fees, stakers are also required to pay a ‘network fee’ for each validator they run through the network. -The network fee is a fixed cost determined by the DAO that governs the network. Also denominated in SSV and similar to operator fees, they are paid continuously over time to the DAO treasury. - -This capital is used to fund, grow, and develop activities and projects in the ecosystem that have passed the voting process. +The network fee is a fixed cost determined by the DAO that governs the network. It's accessible through the [SSV Network Views smart contract](/developers/smart-contracts/ssvnetworkviews#getnetworkfee-) or via the [Subgraph](/developers/tools/ssv-subgraph/subgraph-examples#dao-constants-and-protocol-network-fee-index). \ No newline at end of file diff --git a/docs/learn/protocol-overview/tokenomics/liquidations.md b/docs/learn/tokenomics/liquidations.md similarity index 68% rename from docs/learn/protocol-overview/tokenomics/liquidations.md rename to docs/learn/tokenomics/liquidations.md index 569fc06..6d72db6 100644 --- a/docs/learn/protocol-overview/tokenomics/liquidations.md +++ b/docs/learn/tokenomics/liquidations.md @@ -7,7 +7,7 @@ sidebar_position: 3 Since the payments between validators and operators are a zero-sum game (revenue of operators is the expenses of validators) and payments are paid as an ongoing process that is calculated in retrospect, there can't be a case where a user has insufficient funds in their balance to cover the validator's operational costs. -To use the ssv.network, stakers are required to deposit a sufficient balance of SSV tokens into their cluster balance proportional to the number of validator in the cluster itself. This balance is known as _Liquidation Collateral_, whereas the exceeding portion is usually referred to as Operational Runway. +To use the ssv.network, stakers are required to deposit a sufficient balance of ETH into their cluster balance proportional to the Effective Balance of their validators. This balance is known as _Liquidation Collateral_, whereas the exceeding portion is usually referred to as Operational Runway. ![Liquidation Collateral](/img/liquidation-1.avif) @@ -15,7 +15,7 @@ To use the ssv.network, stakers are required to deposit a sufficient balance of Since transactions on Ethereum aren't free, and users can't incur additional costs if their account runs out of balance, an incentivization model is required to keep the system solvent. -This requires additional actors called [Liquidators](../../../operators/liquidator-bot/) to work behind the scenes to keep the system functioning by flagging users that have insufficient balances to carry their expenses. +This requires additional actors called [Liquidators](/operators/liquidator-bot/) to work behind the scenes to keep the system functioning by flagging users that have insufficient balances to carry their expenses. The ssv network rewards liquidators for the costs and risks associated with liquidating insolvent clusters. The provided collateral serves as a liquidation penalty for clusters and a reward to liquidators for their efforts. @@ -30,9 +30,9 @@ liquidatable = balanceParameterDescription--node-urlThe Ethereum execution node end-point--private-keyPrivate key of the liquidator's wallet--ssv-token-addressSSV token contract address--ssv-network-addressThe ssv.network contract address--ssv-network-viewsThe ssv.network views contract address--gas-price

Gas price heuristic according to the median gas price suggested by web3 gas price oracle:

  • Low (*0.1)
  • Med (*0.2)
  • High (*0.3)
+| CLI Parameter | .ENV Variable | Description | +| ---------------| ---------- | --------------------------------------- | +| `--node-url` | `NODE_URL` |The Ethereum execution node end-point | +| `--private-key` | `ACCOUNT_PRIVATE_KEY` |Private key of the liquidator's wallet | +| `--liquidator-type` | `LIQUIDATOR_TYPE` |The liquidator type. `eth` `ssv` | +| `--ssv-sync-env` | `SSV_SYNC_ENV` |The SSV sync environment. `prod` (default) or `stage` | +| `--ssv-sync` | `SSV_SYNC` |The SSV contract name. `v4.hoodi` (default) or `v4.mainnet` | +| `--gas-price` | `GAS_PRICE` |Gas price heuristic according to the median gas price suggested by web3 gas price oracle: low (0.1), med (0.2), high (0.3). Default: low | +| `--hide-table` | `HIDE_TABLE` |Hide/show realtime table | +| `--max-visible-blocks` | `MAX_VISIBLE_BLOCKS` |Max block range to display active clusters (optional, by default: `50000`) | + ### Running Options @@ -44,7 +49,7 @@ This installation requires NodeJS on your machine. ```sh -yarn cli --ssv-sync-env= --ssv-sync= --node-url= --private-key= --gas-price=slow --max-visible-blocks= +yarn cli --liquidator-type=eth --ssv-sync-env= --ssv-sync= --node-url= --private-key= --gas-price=low --max-visible-blocks= ``` @@ -53,13 +58,14 @@ yarn cli --ssv-sync-env= --ssv-sync= GAS_PRICE=medium # low | medium | high HIDE_TABLE=false MAX_VISIBLE_BLOCKS=50000 SSV_SYNC_ENV=prod # prod or stage, prod - is default value -SSV_SYNC=v4.prater # v4.holesky | v4.mainnet | v4.prater +SSV_SYNC=v4.mainnet # v4.hoodi - is the default ``` @@ -68,17 +74,15 @@ SSV_SYNC=v4.prater # v4.holesky | v4.mainnet | v4.prater :::warning Make sure that `--ssv-sync` and `--node-url` parameters (or `SSV_SYNC` and `NODE_URL` environment variables) are all relative to the same blockchain. -For example, for Holesky (using a sample QuickNode RPC endpoint), the command should look like this: +For example, for Hoodi (using a sample QuickNode RPC endpoint), the command should look like this: ```sh yarn cli \ --ssv-sync-env=prod \ ---ssv-sync=v4.holesky \ ---node-url=https://red-silent-dawn.ethereum-holesky.quiknode.pro// \ +--ssv-sync=v4.hoodi \ +--node-url=https://red-silent-dawn.ethereum-hoodi.quiknode.pro// \ --private-key= \ --gas-price=slow \ --max-visible-blocks=5000 ``` - -The smart contract addresses were taken [from this page](../../developers/smart-contracts/#holesky-testnet), in this instance. ::: diff --git a/docs/operators/operator-management/registration.md b/docs/operators/operator-management/registration.md index 8f3829e..161eef5 100644 --- a/docs/operators/operator-management/registration.md +++ b/docs/operators/operator-management/registration.md @@ -14,7 +14,7 @@ You can register your operator through the SSV network [web app](https://app.ssv While registering your operator you will need to provide the following parameters: * [Operator public key](/operators/operator-node/node-setup) - Generated in the node installation process (base64 format) -* [Operator fee](../../learn/protocol-overview/tokenomics/fees) - The fee charged by the operator per each managed validator +* [Operator fee](/learn/tokenomics/fees) - The fee charged by the operator per each managed validator :::info The wallet address used to register the operator is the only address that will hold management permissions for it. @@ -52,7 +52,7 @@ Click _Next_ when ready. In the following screen, shown below, you are being asked to set the Operator Fee. -For more information about fees, please [head over to the related page](../../learn/protocol-overview/tokenomics/fees). Just know that it will be possible to update the Operator fees later, [with limitations imposed by the protocol, to protect stakers](/operators/operator-onboarding/update-fee), for a guide on how to do that, head over to [the dedicated page](/operators/operator-management/updating-operator-fees). +For more information about fees, please [head over to the related page](/learn/tokenomics/fees). Just know that it will be possible to update the Operator fees later, [with limitations imposed by the protocol, to protect stakers](/operators/operator-onboarding/update-fee), for a guide on how to do that, head over to [the dedicated page](/operators/operator-management/updating-operator-fees). Enter a number and click _Next_ when ready. diff --git a/docs/operators/operator-node/node-setup/README.md b/docs/operators/operator-node/node-setup/README.md index 992267f..87b573c 100644 --- a/docs/operators/operator-node/node-setup/README.md +++ b/docs/operators/operator-node/node-setup/README.md @@ -23,7 +23,7 @@ At a high level, here is what involved in installing an SSV Node: 3. Adjust your configuration 4. Run it! -Please note the process implies you will setup Execution and Beacon clients on your own, _before_ installing the SSV Node. +Please note the process implies you will setup Execution and Beacon clients on your own, _before_ installing the SSV Node. Once you have your node running you'll be able to participate in multiple validator clusters and earn rewards 🥳 @@ -100,7 +100,7 @@ In order to run the SSV Node, in a server, only Docker engine is necessary, you Git -To install the latest stable version for your release of Debian/Ubuntu run `apt-get install git` in your command line. +To install the latest stable version for your release of Debian/Ubuntu run `apt-get install git` in your command line. If your machine is using another Linux distribution, please use the [official Git documentation](https://git-scm.com/downloads/linux), and find the option that better fits your server configuration. @@ -153,7 +153,7 @@ Example: `BEACON_NODE_ADDR=http://1.2.3.4:5052;http://1.2.3.4:5053` ::: ### Password and private key -On the first start the Node will generate a random `password` and encrypted `private_key` files. You can find the files under `~/ssv-stack/ssv-node-data` directory. +On the first start the Node will generate a random `password` and encrypted `private_key` files. You can find the files under `~/ssv-stack/ssv-node-data` directory. **If you already have encrypted key and password files**: * Copy/move them to `/ssv-stack/ssv-node-data` @@ -172,7 +172,7 @@ Both password and private key are needed to run SSV and DKG Nodes. ### Custom ports -We recommend using the default ports for ease of the setup. +We recommend using the default ports for ease of the setup. If you wish to change any of the ports — change them in both `ssv.env` and `docker-compose.yaml`, then get [back to exposing those ports in your firewall](#4-adjust-firewall). @@ -210,7 +210,7 @@ Be sure to implement a robust backup and recovery strategy for your database(s), ## What's next? -* You might want to [configure MEV](/operators/operator-node/setup-sidecars/configuring-mev) to increase your rewards for block proposals. +* You might want to [configure MEV](/operators/operator-node/setup-sidecars/configuring-mev) to increase your rewards for block proposals. * You can [enable DKG node](/operators/operator-node/setup-sidecars/enabling-dkg/) to increase your chances of being included in a cluster. diff --git a/docs/operators/operator-node/setup-sidecars/enabling-dkg/README.md b/docs/operators/operator-node/setup-sidecars/enabling-dkg/README.md index 3518f1e..ae91175 100644 --- a/docs/operators/operator-node/setup-sidecars/enabling-dkg/README.md +++ b/docs/operators/operator-node/setup-sidecars/enabling-dkg/README.md @@ -17,6 +17,6 @@ Also, in order to access logs it is necessary to utilize permanent storage when You can setup your `ssv-dkg` node by following these three pages: -1. [**Prerequisites**](prerequisites.md) -2. [**Start DKG Node**](start-dkg-node/) +1. [**Prerequisites**](prerequisites.md) +2. [**Start DKG Node**](start-dkg-node/) 3. [**Final Steps**](final-steps.md) diff --git a/docs/operators/operator-node/setup-sidecars/enabling-dkg/prerequisites.md b/docs/operators/operator-node/setup-sidecars/enabling-dkg/prerequisites.md index d719979..2dfe3c9 100644 --- a/docs/operators/operator-node/setup-sidecars/enabling-dkg/prerequisites.md +++ b/docs/operators/operator-node/setup-sidecars/enabling-dkg/prerequisites.md @@ -7,7 +7,7 @@ sidebar_position: 1 ## Minimum requirements -The minimum requirement is an AWS `t3.small` or equivalent machine dedicated to run DKG. +The minimum requirement is an AWS `t3.small` or equivalent machine dedicated to run DKG. The recommend requirement is an AWS `t3.medium` or higher tier machine ([https://aws.amazon.com/ec2/instance-types/](https://aws.amazon.com/ec2/instance-types/)). Minimum docker resource allocations: @@ -31,7 +31,7 @@ In order to successfully participate in DKG ceremonies initiated by stakers, you * **Operator ID** - the ID of your operator within the SSV network. * **Operator Key Pair** - * **Public Key** - the public key of the operator + * **Public Key** - the public key of the operator * **Private Key** - the private key of the operator as an password-encrypted file (if you are in possession of raw text private key, follow [this migration guide to encrypt your existing operator keys](/operators/operator-node/maintenance/troubleshooting/#faq)) * **Machine Endpoint** - the endpoint (`protocol:ip:port`, e.g. `https://my-dkg.com:3030`) of the machine intended to run the `ssv-dkg` client (if you have a domain name, instead of an `ip` that works as well) diff --git a/docs/operators/operator-node/setup-sidecars/remote-signer.md b/docs/operators/operator-node/setup-sidecars/remote-signer.md index dc7a2f0..1119fc1 100644 --- a/docs/operators/operator-node/setup-sidecars/remote-signer.md +++ b/docs/operators/operator-node/setup-sidecars/remote-signer.md @@ -120,7 +120,7 @@ Run `web3signer` with the arguments in the example. You might need to change HTT When TLS is enabled on Web3Signer, make sure to: 1. Use `https://` in the `WEB3SIGNER_ENDPOINT` value for SSV-Signer 2. Configure client TLS options for SSV-Signer to connect securely ( - see [Client TLS Configuration](#client-tls-configuration-ssv-signer-connecting-to-web3signer) section for detailed + see [Client TLS Configuration](#5-configure-tls-for-ssv-signer) section for detailed examples) diff --git a/docs/operators/operator-onboarding/README.md b/docs/operators/operator-onboarding/README.md index fb6363e..dcdaecc 100644 --- a/docs/operators/operator-onboarding/README.md +++ b/docs/operators/operator-onboarding/README.md @@ -14,9 +14,9 @@ This can be done by installing the [node software](/operators/operator-node/) on ### Operator Fee -Operators set their own fees - denominated in SSV tokens - to be charged per each validator that selects them as one of their operators. +Operators set their own fees denominated in ETH. This fee will be charged per each 32 ETH staked with validators that selects them as one of their operators. -Operator earnings are paid to their account balance, and can be withdrawn to their wallet at any time. +Operator earnings are paid to their account balance(s), and can be withdrawn to their wallet at any time. **Fee Configuration** @@ -24,14 +24,21 @@ Operators initially set their fee when registering an operator to the network. Fees are presented as annual payments, but in practice are paid to operators continuously as an ongoing process - per each passed block. -This means that when setting the operator fee through the smart contract (whether at registration or fee updates), operators should set their preferred fee according to a fee per block format. +Please note, if you set your operator fee through the smart contract (whether at registration or fee updates), the value should be according to a fee per block format. * To calculate fee per block according to a desired annual fee in fiat (USD): -$$ Fee\;per\;block = \dfrac{Annual\;Fee_{usd}}{SSV_{usd}}\;/\;Blocks_{year} $$ - +$$ Fee\;per\;block = \dfrac{Annual\;Fee_{usd}}{ETH_{usd}}\;/\;Blocks_{year} $$ Where: - $\text{Annual Fee}_{usd}$ - desired fee per year in USD -- $SSV_{usd}$ - SSV price in USD +- $ETH_{usd}$ - ETH price in USD - $Blocks_{year}$ - avg. number of blocks per year ([reference](https://ycharts.com/indicators/ethereum_blocks_per_day)) + +:::tip ETH vs SSV fees +**Previously registered operators will have a default ETH fee** which [they can change as usual](/operators/operator-management/updating-operator-fees.md). They will also have 2 separate balances — in ETH and SSV token. Once all clusters they participate in migrate to ETH, the operator will only have ETH balance. + +Fees in SSV (legacy) can not be changed and are charged per each validator, regardless of their effective balance. + +**Newly registered operators** will only have ETH balance, without an option to be paid in SSV token. +::: \ No newline at end of file diff --git a/docs/operators/operator-onboarding/offboarding.md b/docs/operators/operator-onboarding/offboarding.md index 0c95d2c..d5df22d 100644 --- a/docs/operators/operator-onboarding/offboarding.md +++ b/docs/operators/operator-onboarding/offboarding.md @@ -12,7 +12,7 @@ An operator can choose to leave the network at any time. Choosing to remove an o * Remove themself from the network and they will no longer be discoverable by other validators. :::warning -Please be aware: this process is irreversible and removed Operators would not be able to reactivate or register this operator back in the future. +Please be aware: this process is **irreversible** and removed Operators would not be able to reactivate or register this operator back in the future. Attempting to register an Operator using the same private key will result in an error. In such a case, Operator registration must be done with with a new key. ::: diff --git a/docs/operators/operator-onboarding/permissioned-operators.md b/docs/operators/operator-onboarding/permissioned-operators.md index d7e0f7e..580f884 100644 --- a/docs/operators/operator-onboarding/permissioned-operators.md +++ b/docs/operators/operator-onboarding/permissioned-operators.md @@ -5,15 +5,23 @@ sidebar_position: 5 # Permissioned Operators -### What are Permissioned Operators? +## What are Permissioned Operators? Permissioned Operators (also known as "Private") are Operators that have selected to authorize only a list of wallet addresses to register validators to them. There are multiple reasons why an Operator would want this, and various reasons why they would **not** want to choose this option, and why this disabled by default. -:::tip New feature -The latest version of the SSVNetworks smart contract adds the ability to set multiple whitelisted addresses to multiple operators in bulk. Information on how to do this via the webapp can be found [here](/operators/operator-management/configuring-a-permissioned-operator). +### How to become a Permissioned Operator? + +The **`setOperatorMultipleWhitelists`** smart contract function allows to whitelist a set of addresses to a number of different with the permission to register validators to the specified operators. + +Conveniently, [the ssv.network WebApp](https://app.ssv.network/) offers a way to interact with the smart contract through a UI, and you can get guidance on the process [on this page in this documentation](/operators/operator-management/configuring-a-permissioned-operator). + +:::info +It's important to note that configuring Permissioned Operator only affects **future validator registrations**. + +If any number of validators have already been registered to various clusters that include a certain Operator, configuring this Operator to become a Permissioned Operator **will not** cause these validators to stop working. ::: -#### How to identify Permissioned Operators +### How to identify Permissioned Operators When an Operator owner chooses to identify their Operator as Permissioned, **any smart contract transaction to register a validator with such Operator will fail**, if the sender of the transaction is not included in the list of whitelisted addresses. @@ -25,13 +33,13 @@ Similarly, the [SSV Explorer](https://explorer.ssv.network/operators/1) also sho ![permissioned-operator](/img/permissioned-operators-2.avif) -#### SSV Subgraph +### SSV Subgraph SSV also provide a subgraph to easily look up information on permissioned Operators, this tracks all the events surrounding whitelisting and means we can check which operators are private, and which addresses are whitelisted per operator. You can find out more details on how to use the subgraph [**here**](../../developers/tools/ssv-subgraph/)**.** One last way to verify this is to use the [SSV Network Views smart contract](../../developers/smart-contracts/ssvnetworkviews.md#getoperatorbyid-operatorid). -#### Use Cases +### Use Cases Since setting an operator as Permissioned Operator has the consequence of renouncing from potentially being chosen by public customers to operate their validators, let's talk about the upsides, and why one would choose to do so. The main use cases for a Permissioned Operator are: @@ -48,14 +56,3 @@ The team could elect to reduce Operator Fees to 0, but this would mean that **ev In practical terms, this means renouncing the potential profits from public customers choosing their Operator and paying Operator fees, but if the team projects that the service fees paid to the Staking Service and the convenience of not paying Operator fees will outweigh the potential missed revenue, then this is the right choice for them. -### How to become a Permissioned Operator? - -The **`setOperatorMultipleWhitelists`** smart contract function allows to whitelist a set of addresses to a number of different with the permission to register validators to the specified operators. - -Conveniently, [the ssv.network WebApp](https://app.ssv.network/) offers a way to interact with the smart contract through a UI, and you can get guidance on the process [on this page in this documentation](/operators/operator-management/configuring-a-permissioned-operator). - -:::info -It's important to note that configuring Permissioned Operator only affects **future validator registrations**. - -If any number of validators have already been registered to various clusters that include a certain Operator, configuring this Operator to become a Permissioned Operator **will not** cause these validators to stop working. -::: diff --git a/docs/operators/operator-onboarding/update-fee.md b/docs/operators/operator-onboarding/update-fee.md index a85d51a..0326f4d 100644 --- a/docs/operators/operator-onboarding/update-fee.md +++ b/docs/operators/operator-onboarding/update-fee.md @@ -9,7 +9,7 @@ On this page you will find educational concepts, to see the actionable steps to Fees are initially set when registering an operator but can be changed at any point in time. -Fee changes are generally initiated to stay competitive with other operators or to align with SSV market price fluctuations. +Fee changes are generally initiated to stay competitive with other operators. ### Fee Increase Process diff --git a/docs/ssv-staking/README.md b/docs/ssv-staking/README.md new file mode 100644 index 0000000..c5c6ae4 --- /dev/null +++ b/docs/ssv-staking/README.md @@ -0,0 +1,63 @@ +--- +sidebar_position: 1 +--- + +# SSV Staking + +SSV Staking allows SSV token holders to support the network's oracle infrastructure and get rewards. + +## Overview +By staking SSV, your staked weight contributes to oracle consensus for effective balance reporting. In return, you receive transferable cSSV tokens that represent your staked position, while your voting power is automatically delegated to the oracles. You can claim rewards at any time and unstake with a 7-day cooldown period. + + + +### Staking Flow + +``` +Stake SSV and Delegate → Receive cSSV → Claim Rewards → Unstake → Withdraw +``` + +1. **Stake SSV and Delegate** - Deposit SSV tokens into the staking contract, delegating voting power to [oracles](/learn/introduction/oracles.md) +2. **Receive cSSV** - Receive cSSV tokens that represent staked position +3. **Claim rewards** - Claim your accumulated rewards at any time +4. **Unstake** - Start the unstaking process, which triggers a 7-day cooldown +5. **Withdraw** - After the cooldown, withdraw your SSV and any remaining rewards + +When clusters pay operator fees and network fees in ETH, a portion of these fees flows into the SSV Staking contract. These fees are distributed proportionally to all cSSV holders based on their share of the total staked SSV. + +## cSSV Token Mechanics + + + +### Key Properties +cSSV is non-rebasing, meaning your cSSV balance stays constant and does not automatically increase. It is transferable as a standard ERC-20 token and can be moved or used in DeFi. Rewards accrue based on the cSSV balance, so when cSSV is transferred, rewards stop accumulating for the sender. Rewards are calculated based on a reward index that reflects network fee inflows. + +### Rewards flow + +Rewards flow from network fees to SSV stakers through the following mechanism: + +``` +ETH Clusters pay fees + ↓ +Network fee portion + ↓ +SSV Staking contract + ↓ +Distributed to cSSV holders +``` + + + +## Oracle Delegation + +When you stake SSV, your stake weight is automatically delegated to the network's oracle system. Your stake weight remains active during the unstaking cooldown period. + +Oracles report validator effective balances to the blockchain. Check out [the Effective Balance Oracles page](/learn/introduction/oracles.md) to learn more about their role in the network. + +## Getting Started + +Ready to start staking? Follow these guides: + +- [Stake SSV](stake-ssv.md) - Step-by-step guide to stake your SSV tokens +- [Claim Rewards](claim-rewards.md) - How to claim your accumulated rewards +- [Unstake SSV](unstake-ssv.md) - How to unstake your SSV tokens \ No newline at end of file diff --git a/docs/ssv-staking/claim-rewards.md b/docs/ssv-staking/claim-rewards.md new file mode 100644 index 0000000..39c3d4d --- /dev/null +++ b/docs/ssv-staking/claim-rewards.md @@ -0,0 +1,34 @@ +--- +sidebar_position: 3 +--- + +# Claim Rewards + +## Overview + +As an SSV staker, you earn network fees proportional to your share of total staked SSV. These rewards: +- Can be claimed anytime without affecting your staking position +- Do not auto-compound, so your cSSV balance stays constant +- If you transfer cSSV tokens to another wallet recipient earns new rewards from the transfer moment onward + +## Claiming Process + +#### 1. Connect Wallet + +Navigate to the [SSV Network webapp](https://app.ssv.network/) and connect your wallet holding cSSV tokens. + +![Claim Rewards](/img/stake-ssv-1.png) + +#### 2. View Unclaimed Rewards + +Click on the "Rewards" to see the unclaimed rewards. + +![Claim Rewards](/img/staking-rewards-2.png) + +#### 3. Initiate Claim + +Click "Claim All" and review the claim details. Your wallet will prompt for confirmation. Review and confirm the transaction, then wait for blockchain confirmation. + +![Claim Rewards](/img/staking-rewards-3.png) + +**Once confirmed**, ETH is sent to your wallet. Your "Unclaimed Rewards" counter resets to 0, cSSV balance remains unchanged, and new rewards continue accruing. \ No newline at end of file diff --git a/docs/ssv-staking/stake-ssv.md b/docs/ssv-staking/stake-ssv.md new file mode 100644 index 0000000..a1f1c3d --- /dev/null +++ b/docs/ssv-staking/stake-ssv.md @@ -0,0 +1,57 @@ +--- +sidebar_position: 2 +--- + +# Stake SSV + +## Prerequisites + +1. SSV tokens in your wallet +2. Compatible Web3 wallet (MetaMask, WalletConnect, etc.) +3. Sufficient ETH for gas fees +4. Access to the [SSV Network Web App](https://app.ssv.network/) + +## Staking Process + +#### 1. Connect Your Wallet + +Navigate to the [SSV Network Web App](https://app.ssv.network/), click "Connect Wallet", and approve the connection. + +![Stake SSV](/img/stake-ssv-1.png) + +#### 2. Navigate to Staking + +Go to the "Stake" section to start the staking process. + +![Stake SSV](/img/stake-ssv-2.png) + +#### 3. Enter Staking Amount + +Click "Stake SSV", enter the amount you wish to stake, and review the details. + +![Stake SSV](/img/stake-ssv-3.png) + +#### 4. Approve SSV Token *(First Time Only)* + +If this is your first time staking, approve the staking contract to access your SSV tokens. Click "Approve SSV" and confirm the transaction. Note, you only need to do this once. + +![Stake SSV](/img/stake-ssv-4.png) + +#### 5. Confirm Staking Transaction + +Click "Stake", review the transaction details in your wallet, and confirm. You will see the green checkmark once the transaction is confirmed on-chain. + +![Stake SSV](/img/stake-ssv-5.png) + +#### 6. Receive cSSV + +Once confirmed, you'll receive cSSV tokens in your wallet and start earning rewards immediately. The changes will be reflected on the dashboard, note the "Staked Balance". + +![Stake SSV](/img/stake-ssv-6.png) + +## Learn More + +- [SSV Staking Overview](README.md) - Full staking mechanism +- [Claim Rewards](claim-rewards.md) - How to claim rewards +- [Unstake SSV](unstake-ssv.md) - Unstaking process +- [Glossary](/learn/glossary.md) - Key terms and definitions diff --git a/docs/ssv-staking/unstake-ssv.md b/docs/ssv-staking/unstake-ssv.md new file mode 100644 index 0000000..da52473 --- /dev/null +++ b/docs/ssv-staking/unstake-ssv.md @@ -0,0 +1,67 @@ +--- +sidebar_position: 4 +--- + +# Unstake SSV + +## Overview + +Unstaking SSV withdraws your staked tokens from the staking contract. The process includes: + +- **7-day cooldown period** - Required waiting time after initiating +- **Oracle weight retention** - Voting weight remains active during cooldown +- **Full withdrawal** - Receive SSV + any unclaimed rewards after cooldown + +:::warning Please note +This process is irreversible. Once initiated, you cannot cancel and rewards stop immediately. You can only have up to 2000 initiated withdrawal requests at the same time. +::: + +## Unstaking Process + +#### 1. Connect Your Wallet + +Navigate to the [SSV Network Web App](https://app.ssv.network/), connect your wallet holding cSSV tokens, and ensure sufficient ETH for gas fees. + +![Unstake SSV](/img/stake-ssv-1.png) + +#### 2. Navigate to Unstaking + +Go to the "Unstake" section. + +![Unstake SSV](/img/unstake-ssv-2.png) + +#### 3. Initiate Unstaking + +Click "Unstake SSV" and specify the amount to unstake. + +![Unstake SSV](/img/unstake-ssv-3.png) + +#### 4. Confirm Transaction + +Read and acknowledge the warnings, then click "Approve Unstake". You'll need to approve in your wallet, and wait for blockchain confirmation. + +
+ Unstake SSV +
+ + +#### 5. Cooldown Period + +During the cooldown period (7 Days), a timer displays the remaining time until withdrawal becomes available. + +See "Withdrawable in 6d 12m 37s..." next to 2500 cSSV on the screenshot below. + +![Unstake SSV](/img/unstake-ssv-5.png) + +#### 6. Finalize Withdrawal + +Once the cooldown period has ended, a "Withdraw" button will appear next to your request. Select "Withdraw" and complete the transaction using your wallet. + +![Unstake SSV](/img/unstake-ssv-6.png) + +**Once the transaction is confirmed on-chian:** +- Original SSV tokens are returned to your wallet +- All rewards are claimed +- cSSV tokens are burned (removed from circulation) +- Oracle weight is removed +- Staking position is closed \ No newline at end of file diff --git a/docs/stakers/README.md b/docs/stakers/README.md index 076f898..981691c 100644 --- a/docs/stakers/README.md +++ b/docs/stakers/README.md @@ -5,7 +5,7 @@ sidebar_position: 1 # Stakers -Stakers using the ssv network come in various forms: staking services/providers, staking pools, or individual ETH holders that supply the initially required capital to enable validators on the beacon chain. To enable the operation of a distributed validator, stakers must pay a fee in SSV to their chosen operators for them to manage their validator(s). +Stakers using the ssv network come in various forms: staking services/providers, staking pools, or individual ETH holders that supply the initially required capital to enable validators on the beacon chain. To enable the operation of a distributed validator, stakers pay fees in native ETH to their chosen operators for them to manage their validator(s). Users that leverage the SSV network’s DVT technology will promote optimal liveness, security, and decentralization for their validator(s). @@ -19,8 +19,8 @@ If you'd like to start by understanding how Distributed Validators work on ssv n Validators are distributed to several operators, forming a cluster. Each cluster has its balance to pay for network and operator fees, so you might want to [learn about cluster balance](/stakers/clusters/cluster-balance) and its caveats. -Practically speaking, there are several ways to interact with a cluster. For example, [adding more SSV to cluster's balance](/stakers/cluster-management/depositing-ssv/), [adding more validators](/stakers/cluster-management/adding-validator-to-existing-cluster), and other actions listed on [the Cluster Management section](/stakers/cluster-management). +Practically speaking, there are several ways to interact with a cluster. For example, [depositing ETH to fund your cluster](/stakers/cluster-management/depositing-eth/), [adding more validators](/stakers/cluster-management/adding-validator-to-existing-cluster), and other actions listed on [the Cluster Management section](/stakers/cluster-management). -Finally, there is an option to automate the onboarding through a script, if you manage a large number of validators. [Check out the example](/docs/developers/quickstart.md) of how to do it using our SDK is the starting place. +Finally, there is an option to automate the onboarding through a script, if you manage a large number of validators. [Check out the developer Quickstart](/docs/developers/README.md) which shows how to automate validator onboarding using our SDK. We suggest to skim through all of the guides on our documentation, to get familiar with all of the concepts and possible actions. If you still have questions, feel free to ask them on the [official Discord channel](https://discord.gg/5vT22pRBrf). \ No newline at end of file diff --git a/docs/stakers/cluster-management/README.md b/docs/stakers/cluster-management/README.md index fc1e1d0..dea5082 100644 --- a/docs/stakers/cluster-management/README.md +++ b/docs/stakers/cluster-management/README.md @@ -7,9 +7,19 @@ sidebar_position: 5 **Follow the guides in this section:** - [**Add validator**](./adding-validator-to-existing-cluster.md) to existing cluster -- [**Deposit SSV**](./depositing-ssv.md) to cluster's balance -- [**Withdraw SSV**](./withdrawing-ssv.md) from cluster's balance -- [**Re-activate a cluster**](./re-activating-a-cluster.md) if your SSV balance went to 0 +- [**Deposit ETH**](./depositing-eth.md) to cluster balance +- [**Withdraw ETH**](./withdrawing-eth.md) from cluster balance +- [**Re-activate a cluster**](./re-activating-a-cluster.md) if your balance went to 0 - [**Update operators**](./update-operators.md) when you need to change one of the operators - [**Exit a validator**](./exiting-a-validator.md) -- [**Remove a validator**](./removing-a-validator.md) \ No newline at end of file +- [**Remove a validator**](./removing-a-validator.md) +- [**Migrate to ETH**](./migrating-to-eth-clusters.md) (for legacy SSV cluster owners) + +:::warning Legacy SSV Clusters +Existing SSV-based clusters are treated as legacy. **This means the following actions are no longer supported:** +- Adding new validators to SSV cluster +- Depositing additional SSV to extend runway +- Removing or exiting validators from SSV clusters + +**The only forward path is [migration to ETH](./migrating-to-eth-clusters.md).** Migration automatically refunds your SSV balance. +::: diff --git a/docs/stakers/cluster-management/adding-validator-to-existing-cluster.md b/docs/stakers/cluster-management/adding-validator-to-existing-cluster.md index 0d33e50..2eed238 100644 --- a/docs/stakers/cluster-management/adding-validator-to-existing-cluster.md +++ b/docs/stakers/cluster-management/adding-validator-to-existing-cluster.md @@ -71,17 +71,13 @@ The next screen presents a summary of your validator setup. ![add-validator-to-cluster](/img/add-validator-to-cluster-10.avif) -By clicking on Register validator, you'll be proposed to sign transactions to confirm your choice and transfer the SSV balance necessary to cover for the operational costs. - -:::info -**Note:** If this is the first time you are registering a validator to ssv.network, you will be required to make two transactions - one to approve the SSV smart contract and another one to register the validator. -::: +By clicking on Register validator, you'll be proposed to sign a transaction to confirm your choice and deposit the ETH necessary to cover operational costs (if additional funding is needed). ![add-validator-to-cluster](/img/add-validator-to-cluster-11.webp) -### SSV Balance deposit +### ETH Balance deposit -Now, finalize the validator registration by signing the transaction and adding SSV tokens to your account balance. +Now, finalize the validator registration by signing the transaction and depositing ETH to your cluster balance.
diff --git a/docs/stakers/cluster-management/depositing-eth.md b/docs/stakers/cluster-management/depositing-eth.md new file mode 100644 index 0000000..982df2c --- /dev/null +++ b/docs/stakers/cluster-management/depositing-eth.md @@ -0,0 +1,48 @@ +--- +title: Deposit ETH +sidebar_position: 2 +--- + +# Depositing ETH to Cluster + +All clusters on SSV Network use native ETH for fee payments to operators and the network. The cluster balance is necessary to reward operators and pay network fees. + +:::tip Operational Runway +Remember to maintain sufficient ETH balance to cover your cluster's operational costs. Monitor your runway regularly to avoid liquidation. + +For more information on cluster balance mechanics, please refer to [the dedicated learning page](/stakers/clusters/cluster-balance). +::: + +#### 1. Connect Web3 Wallet + +Connect your Web3 wallet with the [WebApp](https://app.ssv.network/), use the same address used for validator registration. + +#### 2. Choose the Cluster + +In the My Account page, select an active cluster and then click on the "Deposit" button. + +![Deposit ETH to cluster balance](/img/deposit-eth-2.png) + +#### 3. Enter the Amount + +In the next screen, you'll be asked to enter the amount of ETH you want to deposit. + +Once you enter the amount, click on the _Deposit_ button. + +![Deposit ETH to cluster balance](/img/deposit-eth-3.png) + +#### 4. Sign transaction + +The page will submit a transaction to the SSV Network smart contract. Finalize the deposit to the Cluster by signing the transaction. + +
+ Deposit ETH to cluster balance +
+ +#### 5. Deposit Complete + +You'll be taken back to the Cluster page, where the balance will be updated with the deposited ETH amount. \ No newline at end of file diff --git a/docs/stakers/cluster-management/depositing-ssv.md b/docs/stakers/cluster-management/depositing-ssv.md deleted file mode 100644 index da19c83..0000000 --- a/docs/stakers/cluster-management/depositing-ssv.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Depositing SSV -sidebar_position: 2 ---- - -### Connect your Web3 wallet to the WebApp - -The SSV token is used as as the payment layer of the network and the cluster balance is necessary to reward its operators. - -For more information on this topic, please refer to [the dedicated learning page](/stakers/clusters/cluster-balance). - -Make sure to connect your Web3 wallet with the WebApp, and that the address corresponds with the one you want to manage your Validators with. - -:::info -**Note:** Your account is associated with your Web3 wallet. -::: - -In the My Account page, select an active cluster and then click on the "Deposit" button. - -![deposit-ssv](/img/deposit-ssv-1.avif) - -In the next screen, you'll be asked to enter the amount of SSV you want to deposit - -![deposit-ssv](/img/deposit-ssv-2.avif) - -Once you enter the amount, click on the _Deposit_ button - -![deposit-ssv](/img/deposit-ssv-3.avif) - -The page will attempt to submit a transaction to the SSV Network smart contract, check your Web3 wallet. - -![deposit-ssv](/img/deposit-ssv-4.avif) - -Now, finalize the deposit on the Cluster by signing the transaction. - -
- Deposit SSV -
- -You'll be taken back to the Cluster page, where the balance will be updated with the amount of SSV tokens deposited. - -![deposit-ssv](/img/deposit-ssv-6.avif) \ No newline at end of file diff --git a/docs/stakers/cluster-management/migrating-to-eth-clusters.md b/docs/stakers/cluster-management/migrating-to-eth-clusters.md new file mode 100644 index 0000000..e5a0131 --- /dev/null +++ b/docs/stakers/cluster-management/migrating-to-eth-clusters.md @@ -0,0 +1,84 @@ +--- +title: Migrating to ETH +sidebar_position: 8 +--- + +# Migrating to ETH + +## Overview +Legacy SSV-based clusters should be migrated to ETH payments to continue active operations. Migration is the only path forward for maintaining and modifying existing clusters. + +### What Happens During Migration + +1. **ETH Deposit**: You deposit ETH to fund your cluster's operational runway +2. **SSV Refund**: Your entire SSV balance is automatically refunded to your wallet +3. **Cluster Conversion**: Your cluster switches to ETH-based fee accounting +4. **Continued Operation**: Your validators continue running without interruption + +:::info Automatic SSV Refund +You do **not** need to manually withdraw SSV before migrating. The migration process automatically returns your full SSV balance to your wallet address. +::: + +### Prerequisites + +Before migrating, ensure you have: + +- Access to the wallet that owns the cluster +- Sufficient ETH to cover: + - Initial cluster funding (operational runway) + - Gas fees for the migration transaction + - We recommend depositing enough ETH for at least 90 days of operations to avoid frequent top-ups. + +## Migration Process + +### Via WebApp + +#### 1. Connect Web3 Wallet +Connect your Web3 wallet with the [WebApp](https://app.ssv.network/), use the same address used for validator registration. + +#### 2. Choose the Cluster +Select a non-migrated cluster from the list and click “Switch to ETH”. + +![Migrate cluster to ETH](/img/migrate-eth-1.png) + +#### 3. Acknowledge Fee Warnings +Review and acknowledge the fee warnings and comparison. + +![Migrate cluster to ETH](/img/migrate-eth-4.png) + +#### 4. Enter Effective Balance +Enter the total Effective Balance for all validators in the cluster. The default is 32 ETH per validator. Acknowledge the warnings and continue. + +![Migrate cluster to ETH](/img/migrate-eth-5.png) + +#### 5. Choose Operational Runway +Choose an operational runway based on the new yearly operator fees. + +![Migrate cluster to ETH](/img/migrate-eth-6.png) + +#### 6. Acknowledge Balance Warnings +Review the balance and fee calculation notice. You can read more about [Effective Balance accounting here](/stakers/clusters/effective-balance.md). + +![Migrate cluster to ETH](/img/migrate-eth-7.png) + +#### 7. Switch Cluster to ETH +Review the migration summary and confirm by selecting “Switch Cluster to ETH”. Sign the transaction with your wallet. + +![Migrate cluster to ETH](/img/migrate-eth-8.png) + +#### 8. Finish Migration +After on-chain confirmation, review the post-migration summary. The migration is complete. + +![Migrate cluster to ETH](/img/migrate-eth-9.png) +![Migrate cluster to ETH](/img/migrate-eth-10.png) + +### Via Smart Contract + +If you prefer to migrate directly via the smart contract, use the `migrateClusterToETH()` function in a transaction. Refer to [Developers documentation](/developers/SSV-SDK/module-reference/cluster-module#migrateclustertoeth) for more details. + +**The transaction will:** +1. Validate your cluster snapshot +2. Transfer your SSV balance back to your wallet +3. Accept your ETH deposit +4. Convert the cluster to ETH-based accounting +5. Emit `ClusterMigratedToETH` event \ No newline at end of file diff --git a/docs/stakers/cluster-management/re-activating-a-cluster.md b/docs/stakers/cluster-management/re-activating-a-cluster.md index 7756d8f..8759d84 100644 --- a/docs/stakers/cluster-management/re-activating-a-cluster.md +++ b/docs/stakers/cluster-management/re-activating-a-cluster.md @@ -3,6 +3,8 @@ title: Re-activating a cluster sidebar_position: 4 --- +# Re-activating a cluster + ### Connect your Web3 wallet to the WebApp Make sure to connect your Web3 wallet with the WebApp, and that the address corresponds with the one you want to manage your Validators with. @@ -19,7 +21,7 @@ In the Cluster page, click on the **Reactivate Cluster** button ![reactivate-cluster](/img/reactivate-a-cluster-2.avif) -In the next screen, you'll be asked to choose the cluster runway, which will impact the amount of SSV you will have to deposit to reactivate the cluster. +In the next screen, you'll be asked to choose the cluster runway, which will impact the amount of ETH you will have to deposit to reactivate the cluster. ![reactivate-cluster](/img/reactivate-a-cluster-3.avif) @@ -37,6 +39,6 @@ Now, finalize the validator reactivation by signing the transaction. />
-You'll be taken back to the Cluster page, where the balance will be updated with the amount of SSV tokens deposited. +You'll be taken back to the Cluster page, where the balance will be updated with the amount of ETH deposited. ![reactivate-cluster](/img/reactivate-a-cluster-6.avif) \ No newline at end of file diff --git a/docs/stakers/cluster-management/withdrawing-eth.md b/docs/stakers/cluster-management/withdrawing-eth.md new file mode 100644 index 0000000..e461225 --- /dev/null +++ b/docs/stakers/cluster-management/withdrawing-eth.md @@ -0,0 +1,46 @@ +--- +title: Withdraw ETH +sidebar_position: 3 +--- + +# Withdrawing ETH from Cluster + +You can withdraw excess ETH from your cluster balance at any time, as long as you maintain the minimum [liquidation collateral](/stakers/clusters/cluster-balance.md) required for your cluster. + +:::warning Liquidation Risk +Only withdraw excess balance beyond the liquidation collateral. Withdrawing too much may put your cluster at risk of liquidation if fees accumulate faster than expected. +::: + +#### 1. Connect Web3 Wallet + +Connect your Web3 wallet with the [WebApp](https://app.ssv.network/), use the same address used for validator registration. + +#### 2. Choose the Cluster + +In the My Account page, select an active cluster and then click on the "Withdraw" button. + +![Withdraw ETH from the cluster balance](/img/withdraw-eth-2.png) + +#### 3. Enter the Amount + +In the next screen, you'll be asked to enter the amount of ETH you want to withdraw. If you want to withdraw everything from the cluster balance — you will have to accept Liquidation warnings. + +Once you enter the amount, click on the _Withdraw_ button. + +![Withdraw ETH from the cluster balance](/img/withdraw-eth-3.png) + +#### 4. Sign transaction + +The page will submit a transaction to the SSV Network smart contract. Finalize the withdraw from the Cluster by signing the transaction. + +
+ Withdraw ETH from the cluster balance +
+ +#### 5. Withdraw Complete + +You'll be taken back to the Cluster page, where the balance will be updated with the withdrawn amount. And the withdrawn ETH will be sent to your wallet. \ No newline at end of file diff --git a/docs/stakers/cluster-management/withdrawing-ssv.md b/docs/stakers/cluster-management/withdrawing-ssv.md deleted file mode 100644 index e3e703d..0000000 --- a/docs/stakers/cluster-management/withdrawing-ssv.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Withdrawing SSV -sidebar_position: 3 ---- - -# Withdrawing SSV - -### Connect your Web3 wallet to the WebApp - -Make sure to connect your Web3 wallet with the WebApp, and that the address corresponds with the one you want to manage your Validators with. - -:::info -**Note:** Your account is associated with your Web3 wallet. -::: - -In the My Account page, select an active cluster and then click on the "Withdraw" button. - -![withdraw-ssv](/img/withdraw-ssv-1.avif) - -In the next screen, you'll be asked to enter the amount of SSV you want to withdraw - -![withdraw-ssv](/img/withdraw-ssv-2.avif) - -Once you enter the amount, click on the Withdraw button. Please take a close look at the updated estimated cluster runway. - -![withdraw-ssv](/img/withdraw-ssv-3.avif) - -The page will attempt to submit a transaction to the SSV Network smart contract, check your Web3 wallet. - -Now, finalize the withdrawal from the Cluster by signing the transaction. - -
- Withdraw SSV -
- -You'll be taken back to the Cluster page, where the balance will be updated with the amount of SSV tokens withdrawn. - -![withdraw-ssv](/img/withdraw-ssv-5.avif) \ No newline at end of file diff --git a/docs/stakers/clusters/cluster-balance.md b/docs/stakers/clusters/cluster-balance.md index 3565d57..efcb63b 100644 --- a/docs/stakers/clusters/cluster-balance.md +++ b/docs/stakers/clusters/cluster-balance.md @@ -5,39 +5,39 @@ sidebar_position: 2 # Cluster Balance -With the SSV token serving as the payment layer of the network, the cash flow between stakers and operators is facilitated by maintaining an SSV balance in a cluster. The cluster balance needs to be kept in check to ensure the continued operation of its validator(s) and below it is explained how to calculate the balance of a cluster at a specific blockchain block. +The cluster balance needs to be kept in check to ensure the continued operation of its validator(s). This page explains how to calculate cluster balance at a specific blockchain block. It is important to be aware that the cluster balance must **always be higher than the required** collateral for the cluster, so only the portion of the cluster balance exceeding the Liquidation Collateral can be used to calculate the Operational Runway. ![Operational Runway](/img/cluster-balance-1.avif) -Since operator and network fees are dynamic, the required [**Liquidation Collateral**](../../learn/protocol-overview/tokenomics/liquidations.md#liquidation-collateral) could vary between different clusters. To calculate how much funding is needed as collateral for a cluster, please refer to the [Liquidations page](../../learn/protocol-overview/tokenomics/liquidations.md#liquidators). +Since operator and network fees are dynamic, the required [**Liquidation Collateral**](/learn/tokenomics/liquidations.md#liquidation-collateral) could vary between different clusters. To calculate how much funding is needed as collateral for a cluster, please refer to the [Liquidations page](/learn/tokenomics/liquidations.md). ### Cluster Balance Formula -As explained in the documentation page related to [Payments](../../learn/protocol-overview/tokenomics/payments.md), the cluster balance is affected by three factors, mainly: +As explained in the documentation page related to [Payments](/learn/tokenomics/payments.md), cluster balance is affected by three main factors: * Network fee * Operator fees -* Number of validators +* Effective balance -And to keep track of their changes over time, the concept of [Indexes](../../learn/protocol-overview/tokenomics/payments.md#indexes) have been introduced. This, in turn, means that indexes for network fees and operator fees are necessary to calculate the cluster balance, as well as [the "snapshot" of the cluster status](/developers/tools/ssv-subgraph/subgraph-examples#cluster-snapshot), taken the last time this was updated (the cluster snapshot is also used in smart contract transactions). +To track changes over time, the concept of [Indexes](/learn/tokenomics/payments.md#indexes) has been introduced. Indexes for network fees and operator fees are necessary to calculate the cluster balance, along with [the "snapshot" of the cluster status](/developers/tools/ssv-subgraph/subgraph-examples#cluster-snapshot), taken the last time it was updated (the cluster snapshot is also used in smart contract transactions). #### Cluster balance To calculate the updated cluster balance, given the cluster balance from most recent snapshot, you can use this formula: $$ -balance_n = balance_{snapshot} - (\Delta_{network\ fee} + \Delta_{operators\ fee}) * v_c +balance_n = balance_{snapshot} - (\Delta_{network\ fee} + \Delta_{operators\ fee}) * eb / 32 $$ Legend: -* $$balance_n$$ - cluster balance at block number `n` -* $$\Delta_{network\ fee}$$ - Change in network fees paid since the last snapshot -* $$\Delta_{operators\ fee}$$ - Change in network fees paid since the last snapshot +* $$balance_n$$ - cluster balance at block number `n` in ETH * $$balance_{snapshot}$$ - value of the cluster balance on its latest snapshot -* $$v_c$$ - Validator Count, the number of validators in the cluster +* $$\Delta_{network\ fee}$$ - Change in network fees paid since the last snapshot +* $$\Delta_{operators\ fee}$$ - Change in operator fees paid since the last snapshot +* $$eb$$ - [total effective balance](effective-balance.md) of validators managed by the cluster #### Network fees delta @@ -53,8 +53,8 @@ Legend: * $$\Delta_{network\ fee}$$ - Change in network fees paid since the last snapshot * $$nfi_p$$ - Protocol Network Fee Index, the latest protocol-wide network fee index * $$b$$ - Block number of the latest blockchain block -* $$nf$$ - The current network fee * $$nfb_p$$ - The block number at which the Protocol Network Fee Index was taken +* $$nf$$ - The current network fee * $$nfi_c$$ - Cluster Network Fee Index, the latest network fee index for the given cluster #### Operators fees delta @@ -78,6 +78,20 @@ Have a look at how to collect the necessary data to calculate the balance on the A programmatic example of calculating the cluster balance has been added to the [SSV SDK](/developers/SSV-SDK/module-reference/api-module#getclusterbalanceclusterid-daoaddress-operatorids). +### Burn Rate + +The rate at which a cluster spends ETH per block. It is the sum of all operators' fees with the current network fee, divided by effective balance of a cluster. + +$$ +Burn\;Rate_{cluster} = (\sum(ofi_n) + {nf}) * eb / 32 +$$ + +Legend: + +* $$of_n$$ - The current operator fee for the nth operator +* $$nf$$ - The current network fee +* $$eb$$ - [total effective balance](effective-balance.md) of validators managed by the cluster + ### Operational Runway Any additional funds added to the cluster balance on top of the required collateral will prolong the operation of its validators and are usually referred to as Operational Runway. Users can manage their clusters balance by depositing or withdrawing funds at will, knowing that all extra funds added to the cluster balance will increase its operational runway. @@ -90,8 +104,8 @@ $$ Legend: -* $$Residual\;Balance$$ - Amount of SSV in the cluster balance, exceeding the Liquidation Collateral -* $$Burn\;Rate_{cluster}$$ - The rate at which a cluster spends (denominated in SSV tokens per block) +* $$Residual\;Balance$$ - Amount of ETH in the cluster balance, exceeding the Liquidation Collateral +* $$Burn\;Rate_{cluster}$$ - The rate at which a cluster spends ETH per block ### Deposits diff --git a/docs/stakers/clusters/effective-balance.md b/docs/stakers/clusters/effective-balance.md new file mode 100644 index 0000000..a31c712 --- /dev/null +++ b/docs/stakers/clusters/effective-balance.md @@ -0,0 +1,67 @@ +--- +description: Effective Balance Accounting explained +sidebar_position: 3 +--- + +# Effective Balance Accounting + +Across the SSV Network, fees, cluster runway, and liquidation parameters are calculated based on validators’ actual effective balance. [Under Ethereum’s Pectra validator model](https://consensys.io/blog/ethereum-pectra-upgrade), a single validator can secure the network and earn rewards with an effective balance ranging from 32 to 2048 ETH. + +## Effective Balance Monitoring +This monitoring is performed by the set of [Oracles](/learn/introduction/oracles), periodically fetching validators’ effective balance data from the Beacon Chain and report it on-chain. + +Oracles monitor only validators that have already been registered. During the registration of new validators, stakers may provide the total Effective Balance (EB) of the validators being registered. This information is used solely to improve the accuracy of initial runway estimations. + +Providing an incorrect EB can lead to misleading runway estimates and unexpected fee changes. For example: +1. A validator with an effective balance of 2048 ETH is registered +2. The validator is declared as having 32 ETH during registration +3. Runway estimation is computed based on 32 ETH +4. Fees are deposited according to the underestimated runway +5. Once the oracle reports the actual EB, fees increase by 64× +6. The cluster runway is reduced accordingly, increasing liquidation risk + +## Fees Calculations +Effective balance is used as the billing unit for fee calculation. Fees are defined per 32 ETH of effective balance and scale linearly with a cluster’s total effective balance, as shown below: + +$$ +(f_o + f_n) * Total Effective Balance / 32 +$$ + +#### Legend: + * $$f_o$$ - operator fees *(per 32 ETH)*, representing the combined fees of all operators in the cluster, denominated in _ETH per block_ + * $$f_n$$ - network fees *(per 32 ETH)*, representing fees owed to the SSV network, denominated in _ETH per block_ + * $$Total Effective Balance$$ - the sum of effective balances of all validators in the cluster + +#### Key takeaways: +- Fees scale proportionally with the cluster’s actual effective balance +- The validator count does *not* affect the fee calculation +- Effective balance may be split across validator keys in any manner (see [Examples](#examples)) + +## Examples + +As mentioned above, the fees will scale proportionally to the Total Effective Balance of a cluster. + +#### Example Cluster #1 +- Total Effective Balance: 32 +- Sum of Operators fees: 0.01 ETH +- Network fee: 0.00928 ETH + +Annual fee for the cluster: +$$(0.01+0.00928)*32/32=0.01928 ETH$$ + + +#### Example Cluster #2 +- Total Effective Balance: 95 +- Sum of Operators fees: 0.01 ETH +- Network fee: 0.00928 ETH + +Annual fee for the cluster: +$$(0.01+0.00928)*95/32=0.0572375 ETH$$ + +#### Example Cluster #3 +- Total Effective Balance: 2048 +- Sum Operators fees: 0.01 ETH +- Network fee: 0.00928 ETH + +Annual fee for the cluster: +$$(0.01+0.00928)*2048/32=1.23392 ETH$$ diff --git a/docs/stakers/clusters/reactivation.md b/docs/stakers/clusters/reactivation.md index 75d9b78..55aa72e 100644 --- a/docs/stakers/clusters/reactivation.md +++ b/docs/stakers/clusters/reactivation.md @@ -1,15 +1,15 @@ # Reactivation -The following the educational context behind Cluster Reactivation. To see the actionable steps, please follow [this guide instead](../cluster-management/re-activating-a-cluster.md). +The following the educational context behind Cluster Reactivation. To see the actionable steps, please follow [this guide instead](/stakers/cluster-management/re-activating-a-cluster.md). -In order to reactivate a liquidated cluster, the user must supply the liquidation collateral required for their cluster. It is advised to deposit more than the reactivation amount so the cluster will have an operational runway. Users that only deposit the liquidation collateral may be liquidated soon after because they did not compensate for the operational cost of their cluster’s managed validator(s). +In order to reactivate a [liquidated cluster](/learn/tokenomics/liquidations.md), the user must supply the liquidation collateral required for their cluster. It is advised to deposit more than the reactivation amount so the cluster will have an operational runway. Users that only deposit the liquidation collateral may be liquidated soon after because they did not compensate for the operational cost of their cluster's managed validator(s). -Once reactivated, the clusters’ validator(s) operation will continue. To calculate how much minimal funding (liquidation collateral) is needed to reactivate a cluster: +Once reactivated, the clusters' validator(s) operation will continue. To calculate how much minimal funding (liquidation collateral) is needed to reactivate a cluster: $$ reactivation\;Balance > BurnRate_{cluster} * LTP $$ -* Legend - * $$Burn Rate$$ - the rate at which a cluster spends $SSV per block +#### Legend + * [$$Burn Rate$$](cluster-balance.md#burn-rate) - the rate at which a cluster spends ETH per block * $$LTP$$ - liquidation threshold period diff --git a/docs/stakers/incentivized-mainnet.md b/docs/stakers/incentivized-mainnet.md new file mode 100755 index 0000000..13d1e40 --- /dev/null +++ b/docs/stakers/incentivized-mainnet.md @@ -0,0 +1,38 @@ +--- +description: Incentivized Mainnet +sidebar_position: 2 +--- + +# Incentivized Mainnet + +The Incentivized Mainnet Program (IMP) [is an initiative from SSV Network DAO](https://forum.ssv.network/t/dip-34-incentivized-mainnet-program-revision-3/1908), designed to accelerate the adoption of Distributed Validator Technology (DVT) by rewarding participants with SSV Tokens who operate validators on the SSV Network. Launched in October 2023, the program offers tiered rewards to incentivize early and continued participation. + +Our tiered incentive program fosters accelerated usage of SSV network via rewards. Each validator staked on SSV Mainnet network is eligible for claiming Incentives. You can find more details on [the IMP FAQ page](https://ssv.network/incentivized-mainnet-faq). + +### Reward Tiers +The program tiers are structured according to the effective balance. An Online IM reward calculator can be [found on this page](https://ssv.network/incentivized-mainnet). + +| Tier (Effective Balance) | APR Boost | +|---------------------------|-----------| +| 3,200,032 - 4,000,000 ETH | 7.5% | +| 4,000,032 - 4,800,000 ETH | 6% | +| 4,800,032 - 5,600,000 ETH | 5% | +| 5,600,032 - 6,400,000 ETH | 4.25% | +| 6,400,032 - 7,200,000 ETH | 3.5% | +| 7,200,032 - 8,000,000 ETH | 3% | +| 8,000,032 - 9,600,000 ETH | 2.5% | + +### Reward Distribution Flow +A snapshot is taken of all active validators on the SSV Network, then calculations are made and published on the SSV governance forum. This rewards distribution flow is repeated monthly. + +Usually, the rewards are distributed around the middle of the following month. Updates are posted every month in this SSV Governance Forum thread: Incentivized Mainnet Distribution Details](https://forum.ssv.network/t/incentivized-mainnet-program-distributions/). + +### How to claim rewards +You can claim the rewards on any of the following pages: +- https://www.ssvrewards.com/ +- https://ssvscan.io/claim/ +- https://monitorssv.xyz/claim + +📜 **Mainnet Rewards Distributor Contract Address:** +`0xe16d6138B1D2aD4fD6603ACdb329ad1A6cD26D9f` +Refer to the documentation for details: [SSV Smart Contracts Docs](/developers/smart-contracts#ethereum-mainnet) \ No newline at end of file diff --git a/docs/stakers/quickstart.md b/docs/stakers/quickstart.md index 0afa494..5e58b48 100644 --- a/docs/stakers/quickstart.md +++ b/docs/stakers/quickstart.md @@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem'; # Quickstart The quickest way to engage with ssv network is to distribute and register your validator. Feel free to start with Testnet and then proceed to Mainnet. -In order to run a validator, you'll need to be in possession of its keys, have made the deposit to the Deposit Contract to activate it, and own the necessary amount of SSV tokens to cover operational costs. +In order to run a validator, you'll need to be in possession of its keys, have made the deposit to the Deposit Contract to activate it, and own the necessary amount of ETH to cover operational costs. :::note Don't have validator keys? To learn how to create a new set of validator keys and activate them, [please refer to this guide](/docs/stakers/validator-management/creating-a-new-validator.md). @@ -20,9 +20,9 @@ To learn how to create a new set of validator keys and activate them, [please re At a high level, here is what involved in distributing your validator: 1. [Connect your wallet](#connect-your-web3-wallet-to-webapp) 2. [Select Operators](#select-operators) -3. [Split and register your validator key](#key-splitting) +3. [Split your validator key](#key-splitting) 4. [Set the cluster runway](#validator-operational-runway) -5. [Deposit SSV](#ssv-balance-deposit) +5. [Deposit ETH to finalize](#eth-balance-deposit) ### Connect your Web3 wallet to WebApp @@ -33,15 +33,13 @@ Make sure to connect your Web3 wallet with the WebApp, and that the address corr **Your account is associated with your Web3 wallet**. This wallet will be the owner, so having access to it is vital. It can only be changed by removing validator and register using a new wallet. ::: -When creating a new account, you are presented with the option of _Distribute Validator_ or _Join as an Operator_. +When creating a new account, you can **Create a new cluster** for your validators. -Select _**Distribute a Validator**_. - -![Distribute a validator](/img/distributing-a-val-1.avif) +![Distribute a validator](/img/distributing-a-val-1.png) Accept the disclaimer by clicking _**Next**_ if you have all the pre-requisites. -![Distribute a validator](/img/distributing-a-val-3.avif) +![Distribute a validator](/img/distributing-a-val-3.png) ### Select operators @@ -51,19 +49,15 @@ Now, select four operators to manage your validator. Please note the **Yearly Fe **Important:** [Verified Operators (VOs)](/docs/operators/operator-onboarding/verified-operators.md) are operators that have been granted the **Verified** status by the DAO for completing KYC and providing consistent high-quality service. You can sort the operator list by their daily performance, yearly fee, and # of validators they manage. You can also filter to view only Verified Operators. ::: -![Distribute a validator](/img/distributing-a-val-4.avif) +![Distribute a validator](/img/distributing-a-val-4.png) ### Key splitting The next screen will allow you to generate KeyShares for your validator key. -- On Testnet, this can be done Online, directly on the WebApp, or Offline, on your computer. -- On Mainnet, only the Offline option is available. - -:::success Multiple Keystores -The latest SSV Smart Contract updates added support for [_bulk operations_](/developers/smart-contracts/ssvnetwork#bulkregistervalidatorpublickey-operatorids-shares-amount-cluster), and the latest release of `ssv-keys` has been made compatible with bulk operations. With version 1.1.0 (and above), it is possible to generate keyshares for multiple keystores in a single operation/transaction. -::: +- **On Testnet**, this can be done Online, directly on the WebApp, or Offline, on your computer. +- **On Mainnet, only the Offline** option is available. -![Distribute a validator](/img/distributing-a-val-5.avif) +![Distribute a validator](/img/distributing-a-val-5.png) @@ -79,7 +73,7 @@ The latest SSV Smart Contract updates added support for [_bulk operations_](/dev Once uploaded, if successfully validated, advance to the next screen clicking Next. - ![Distribute a validator](/img/distributing-a-val-10.avif) + ![Distribute a validator](/img/distributing-a-val-10.png) @@ -101,16 +95,22 @@ The latest SSV Smart Contract updates added support for [_bulk operations_](/dev +### Effective Balance input + +For accurate runway estimation, you need to manually input the Effective Balance of your validators. If this won't be done, it will be defaulted to each validator having 32 ETH balance. You can read more about [Effective Balance accounting](/stakers/clusters/effective-balance) for detailed calculations of fees. + +Read the warning on the page, input your Effective Balance and proceed to the next step. + ![Distribute a validator](/img/distributing-a-val-EB.png) ### Validator operational runway -You can select the operational runway period of your validator, in accordance with the **Yearly Fee** of previously selected operators. This will dictate the initial amount of SSV to be deposited in the cluster, but it can always be managed later. +You can select the operational runway period of your validator, in accordance with the **Yearly Fee** of previously selected operators. This will dictate the initial amount of ETH to be deposited in the cluster, but it can always be managed later. -![Distribute a validator](/img/distributing-a-val-11.avif) +![Distribute a validator](/img/distributing-a-val-11.png) -**Please read carefully and understand how fees are managed and the risks of account** [**liquidation**](/docs/learn/glossary.md#liquidation) **if your account balance falls below the** [**Threshold Balance**](/docs/learn/glossary.md#liquidation-collateral)**.** +**Please read carefully and understand how fees are managed and the risks of account** [**liquidation**](/learn/tokenomics/liquidations.md) **if your account balance falls below the** [**Threshold Balance**](/learn/tokenomics/liquidations.md#liquidation-collateral). -![Distribute a validator](/img/distributing-a-val-12.avif) +![Distribute a validator](/img/distributing-a-val-12.png) ### Slashing warning @@ -118,33 +118,31 @@ The following screen alerts you of the potential dangers of registering a valida Please make sure to stop any other running validator setup, if you have any. -![Distribute a validator](/img/distributing-a-val-13.avif) +![Distribute a validator](/img/distributing-a-val-13.png) ### Validator summary The next screen presents a summary of your validator setup. -![Distribute a validator](/img/distributing-a-val-14.avif) - +![Distribute a validator](/img/distributing-a-val-14.png) -By clicking on Register validator(s), you'll be proposed to sign transactions to confirm your choice and transfer the SSV balance necessary to cover for the operational costs. -:::info Two transactions -**Note:** If this is the first time you are registering a validator to ssv.network, you will be required to make two transactions - one to approve the SSV smart contract and another one to register the validator. -::: +By clicking on Register validator(s), you'll be proposed to sign a transaction to confirm your choice and deposit the ETH balance necessary to cover for the operational costs. -### SSV Balance deposit +### ETH Balance deposit -Now, finalize the validator registration by signing the transaction and adding SSV tokens to your account balance. +Now, finalize the validator registration by signing the transaction and adding ETH to your cluster balance.
- Distribute a validator + Distribute a validator
You will need to confirm the transaction in your web3 wallet. -![Distribute a validator](/img/distributing-a-val-16.avif) - Once the transaction has been signed and confirmed by the network, you'll be presented with the summary screen. ![Distribute a validator](/img/distributing-a-val-17.avif) diff --git a/docs/stakers/validator-management/creating-a-new-validator.md b/docs/stakers/validator-management/creating-a-new-validator.md index 6a88a08..6cf5648 100644 --- a/docs/stakers/validator-management/creating-a-new-validator.md +++ b/docs/stakers/validator-management/creating-a-new-validator.md @@ -30,6 +30,7 @@ For this reason, an alternative and shorter route to the Launchpad is to use the * Confidence using the command line, and command line interfaces * ETH (or Hoodi ETH): 32 + ~0.1 for gas fees to activate the validator keys +* Additional ETH to fund your cluster's operational runway for operator fees ### Generate validator keys diff --git a/docs/stakers/validator-management/distributing-a-validator.md b/docs/stakers/validator-management/distributing-a-validator.md index 5dc31da..8be762e 100644 --- a/docs/stakers/validator-management/distributing-a-validator.md +++ b/docs/stakers/validator-management/distributing-a-validator.md @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; # Migrating a validator -In order to distribute a validator you'll need — its keys, have made the deposit to the Deposit Contract to activate it, and own the necessary amount of SSV tokens to cover operational costs. +In order to distribute a validator you'll need — its keys, have made the deposit to the Deposit Contract to activate it, and have sufficient ETH to cover operational costs. :::note Don't have validator keys? To learn how to create a new set of validator keys and activate them, [please refer to this guide](creating-a-new-validator.md). @@ -113,7 +113,7 @@ To avoid losing your keystores to an attacker, follow these best practices: ### Validator operational runway -You can select the operational runway period of your validator, in accordance with the **Yearly Fee** of previously selected operators. This will dictate the initial amount of SSV to be deposited in the cluster, but it can always be managed later. +You can select the operational runway period of your validator, in accordance with the **Yearly Fee** of previously selected operators. This will dictate the initial amount of **ETH** to be deposited in the cluster, but it can always be managed later. ![Distribute a validator](/img/distributing-a-val-11.avif) @@ -138,15 +138,15 @@ The next screen presents a summary of your validator setup. ![Distribute a validator](/img/distributing-a-val-14.avif) -By clicking on Register validator(s), you'll be proposed to sign transactions to confirm your choice and transfer the SSV balance necessary to cover for the operational costs. +By clicking on Register validator(s), you'll be proposed to sign a transaction to confirm your choice and deposit the ETH necessary to cover operational costs. -:::info Two transactions -**Note:** If this is the first time you are registering a validator to ssv.network, you will be required to make two transactions - one to approve the SSV smart contract and another one to register the validator. +:::info ETH Deposit +**Note:** Your transaction will include the ETH amount needed for your selected operational runway. This ETH is deposited into your cluster balance to pay operator and network fees. ::: -### SSV Balance deposit +### ETH Balance deposit -Now, finalize the validator registration by signing the transaction and adding SSV tokens to your account balance. +Now, finalize the validator registration by signing the transaction and depositing ETH to your cluster balance.
Distribute a validator diff --git a/docs/stakers/validator-management/dkg-ceremony.md b/docs/stakers/validator-management/dkg-ceremony.md index 23b3196..7d64473 100644 --- a/docs/stakers/validator-management/dkg-ceremony.md +++ b/docs/stakers/validator-management/dkg-ceremony.md @@ -90,7 +90,7 @@ From the options presented in the next screen, please select DKG ![Distribute a validator](/img/dkg-ceremony-9.avif) :::info -The latest SSV Smart Contract updates added support for [_bulk operations_](../../developers/smart-contracts/ssvnetwork.md#bulkregistervalidatorpublickey-operatorids-shares-amount-cluster), and the latest release of`ssv-dkg` tool has been made compatible with bulk operations. +The latest SSV Smart Contract updates added support for [_bulk operations_](/developers/smart-contracts/ssvnetwork.md#bulkregistervalidatorpublickey-operatorids-shares-cluster), and the latest release of`ssv-dkg` tool has been made compatible with bulk operations. With version 1.1.0 (and above), it is possible to generate keyshares for multiple validators in a single operation. ::: diff --git a/docs/stakers/validators/validator-onboarding.md b/docs/stakers/validators/validator-onboarding.md index 7fb18e6..df8d295 100644 --- a/docs/stakers/validators/validator-onboarding.md +++ b/docs/stakers/validators/validator-onboarding.md @@ -39,38 +39,42 @@ Factors to consider in cluster formation: ### Operational Costs -The associated costs for running validators on the ssv network are determined by **operator fees** and **network fees**. +The associated costs for running validators on the SSV network are determined by **operator fees** and **network fees**, paid in **native ETH**. With the network embracing a free-market approach, where operators set their own fees, the cost for each validator will vary based on its operator setup. -In addition to fees, there’s a minimum balance requirement, known as [liquidation collateral](../clusters/cluster-balance), that has to be deposited for each validator a user runs through the network. +In addition to fees, there's a minimum balance requirement, known as [liquidation collateral](../clusters/cluster-balance), that has to be deposited for each validator a user runs through the network. ### Validator Funding -To carry validators operational costs, the validator's cluster must be funded with an appropriate amount of SSV (see [Cluster Balance](../clusters/cluster-balance.md)). +To cover validator operational costs, your cluster must be funded with an appropriate amount of **ETH** (see [Cluster Balance](../clusters/cluster-balance.md)). -Funding can be made at any time to the cluster’s balance (see [Deposits](../clusters/cluster-balance), but in case the first validator is onboarded to a cluster, the initial funding must be carried with its registration. +Funding can be made at any time to the cluster's balance, but when onboarding the first validator to a new cluster, the initial funding must be provided with the registration transaction. -To calculate how much funding is needed to run a validator within its cluster according to a certain **operation period** and the required **liquidation collateral**: +To calculate how much ETH funding is needed to run a validator within its cluster according to a certain **operation period** and the required **liquidation collateral**: $$ -Required\;Funding = (O1_{fee} + O2_{fee} + O3_{fee} + O4_{fee} + N_{fee}) * (Period + LTP) +Required\;Funding_{ETH} = (O1_{fee} + O2_{fee} + O3_{fee} + O4_{fee} + N_{fee}) * (Period + LTP) $$ Legend: -* $$O1_{fee}$$ to $$O4_{fee}$$ - operator fee (SSV per block) -* $$N_{fee}$$ - network fee (SSV per block) +* $$O1_{fee}$$ to $$O4_{fee}$$ - operator fee (ETH per block) +* $$N_{fee}$$ - network fee (ETH per block) * $$Period$$ - desired operation period (blocks) * $$LTP$$ - liquidation threshold period (blocks) -### Single Validator Funding Example +### Single Validator Funding Example (ETH Cluster) -Assuming there are 100 blocks per day, **operators and network fee** of 0.001 SSV (per block) and a **liquidation period** of 1 month, the **required funding** for 1 year of **operation period** would be: +Assuming there are 7,200 blocks per day, **operator fees** of 0.0000001 ETH per block each, and a **network fee** of 0.00000005 ETH per block, with a **liquidation period** of 30 days, the **required funding** for 365 days of **operation period** would be: $$ -197.5 SSV = ((0.001 + 0.001 + 0.001 + 0.001 + 0.001) * 100 * (365+30)) +ETH_{required} = ((4 \times 0.0000001) + 0.00000005) \times 7,200 \times (365 + 30) $$ -:::info -Please note that maintaining your cluster's operational runway is essential and a user could always deposit more balance to their account, or withdraw as they see fit. -::: +$$ +ETH_{required} \approx 1.278 ETH +$$ + +:::info Operational Runway +Maintaining your cluster's operational runway is essential. You can always deposit more ETH to extend your runway or withdraw excess balance as needed. +::: \ No newline at end of file diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 7517fec..f9dbac1 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -83,6 +83,7 @@ const config: Config = { {to: '/developers/', label: 'Developers', position: 'left'}, {to: '/stakers/', label: 'Stakers', position: 'left'}, {to: '/operators/', label: 'Operators', position: 'left'}, + {to: '/ssv-staking/', label: 'SSV Staking', position: 'left'}, { href: 'https://github.com/ssvlabs', label: 'GitHub', @@ -150,7 +151,9 @@ const config: Config = { const redirectFiles: Record = { '/operators/operator-node/setup-sidecars/configuring-mev': '/operators/operator-node/node-setup/configuring-mev', '/operators/operator-node/setup-sidecars/configuring-primev': '/operators/operator-node/node-setup/configuring-primev', - '/developers/quickstart':'/developers/SSV-SDK/examples/bulk-register-validators' + '/developers/quickstart':'/developers/SSV-SDK/examples/bulk-register-validators', + '/stakers/cluster-management/depositing-ssv': '/stakers/cluster-management/depositing-eth', + '/stakers/cluster-management/withdrawing-ssv': '/stakers/cluster-management/withdrawing-eth' }; for (const [newPath, oldPath] of Object.entries(redirectFolders)) { if (existingPath === newPath || existingPath.startsWith(`${newPath}/`)) { diff --git a/package-lock.json b/package-lock.json index f6615c0..f75a6c8 100644 --- a/package-lock.json +++ b/package-lock.json @@ -179,7 +179,6 @@ "resolved": "https://registry.npmjs.org/@algolia/client-search/-/client-search-5.45.0.tgz", "integrity": "sha512-nxuCid+Nszs4xqwIMDw11pRJPes2c+Th1yup/+LtpjFH8QWXkr3SirNYSD3OXAeM060HgWWPLA8/Fxk+vwxQOA==", "license": "MIT", - "peer": true, "dependencies": { "@algolia/client-common": "5.45.0", "@algolia/requester-browser-xhr": "5.45.0", @@ -305,7 +304,6 @@ "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.28.5.tgz", "integrity": "sha512-e7jT4DxYvIDLk1ZHmU/m/mB19rex9sv0c2ftBtjSBv+kVM/902eh0fINUzD7UwLLNR+jU585GxUJ8/EBfAM5fw==", "license": "MIT", - "peer": true, "dependencies": { "@babel/code-frame": "^7.27.1", "@babel/generator": "^7.28.5", @@ -2095,7 +2093,6 @@ } ], "license": "MIT", - "peer": true, "engines": { "node": ">=18" }, @@ -2118,7 +2115,6 @@ } ], "license": "MIT", - "peer": true, "engines": { "node": ">=18" } @@ -2228,7 +2224,6 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", "license": "MIT", - "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -2650,7 +2645,6 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", "license": "MIT", - "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -3608,7 +3602,6 @@ "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.9.2.tgz", "integrity": "sha512-C5wZsGuKTY8jEYsqdxhhFOe1ZDjH0uIYJ9T/jebHwkyxqnr4wW0jTkB72OMqNjsoQRcb0JN3PcSeTwFlVgzCZg==", "license": "MIT", - "peer": true, "dependencies": { "@docusaurus/core": "3.9.2", "@docusaurus/logger": "3.9.2", @@ -4484,7 +4477,6 @@ "resolved": "https://registry.npmjs.org/@mdx-js/react/-/react-3.1.1.tgz", "integrity": "sha512-f++rKLQgUVYDAtECQ6fn/is15GkEH9+nZPM3MS0RcxVqoTfawHvDlSCH7JbMhAM6uJ32v3eXLvLmLvjGu7PTQw==", "license": "MIT", - "peer": true, "dependencies": { "@types/mdx": "^2.0.0" }, @@ -4788,7 +4780,6 @@ "resolved": "https://registry.npmjs.org/@svgr/core/-/core-8.1.0.tgz", "integrity": "sha512-8QqtOQT5ACVlmsvKOJNEaWmRPmcojMOzCz4Hs2BGG/toAp/K38LcsMRyLp349glq5AzJbCEeimEoxaX6v/fLrA==", "license": "MIT", - "peer": true, "dependencies": { "@babel/core": "^7.21.3", "@svgr/babel-preset": "8.1.0", @@ -5146,7 +5137,6 @@ "resolved": "https://registry.npmjs.org/@types/react/-/react-19.1.9.tgz", "integrity": "sha512-WmdoynAX8Stew/36uTSVMcLJJ1KRh6L3IZRx1PZ7qJtBqT3dYTgyDTx8H1qoRghErydW7xw9mSJ3wS//tCRpFA==", "license": "MIT", - "peer": true, "dependencies": { "csstype": "^3.0.2" } @@ -5488,7 +5478,6 @@ "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.15.0.tgz", "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==", "license": "MIT", - "peer": true, "bin": { "acorn": "bin/acorn" }, @@ -5553,7 +5542,6 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", "license": "MIT", - "peer": true, "dependencies": { "fast-deep-equal": "^3.1.3", "fast-uri": "^3.0.1", @@ -5599,7 +5587,6 @@ "resolved": "https://registry.npmjs.org/algoliasearch/-/algoliasearch-5.45.0.tgz", "integrity": "sha512-wrj4FGr14heLOYkBKV3Fbq5ZBGuIFeDJkTilYq/G+hH1CSlQBtYvG2X1j67flwv0fUeQJwnWxxRIunSemAZirA==", "license": "MIT", - "peer": true, "dependencies": { "@algolia/abtesting": "1.11.0", "@algolia/client-abtesting": "5.45.0", @@ -6063,7 +6050,6 @@ } ], "license": "MIT", - "peer": true, "dependencies": { "baseline-browser-mapping": "^2.9.0", "caniuse-lite": "^1.0.30001759", @@ -7020,7 +7006,6 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", "license": "MIT", - "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -8385,7 +8370,6 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", "license": "MIT", - "peer": true, "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -13036,7 +13020,6 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", "license": "MIT", - "peer": true, "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -13552,7 +13535,6 @@ } ], "license": "MIT", - "peer": true, "dependencies": { "nanoid": "^3.3.11", "picocolors": "^1.1.1", @@ -14456,7 +14438,6 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", "license": "MIT", - "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -15251,7 +15232,6 @@ "resolved": "https://registry.npmjs.org/react/-/react-19.2.3.tgz", "integrity": "sha512-Ku/hhYbVjOQnXDZFv2+RibmLFGwFdeeKHFcOTlrt7xplBnya5OGn/hIRDsqDiSUcfORsDC7MPxwork8jBwsIWA==", "license": "MIT", - "peer": true, "engines": { "node": ">=0.10.0" } @@ -15261,7 +15241,6 @@ "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-19.2.3.tgz", "integrity": "sha512-yELu4WmLPw5Mr/lmeEpox5rw3RETacE++JgHqQzd2dg+YbJuat3jH4ingc+WPZhxaoFzdv9y33G+F7Nl5O0GBg==", "license": "MIT", - "peer": true, "dependencies": { "scheduler": "^0.27.0" }, @@ -15299,7 +15278,6 @@ "resolved": "https://registry.npmjs.org/@docusaurus/react-loadable/-/react-loadable-6.0.0.tgz", "integrity": "sha512-YMMxTUQV/QFSnbgrP3tjDzLHRg7vsbMn8e9HAa8o/1iXoiomo48b7sk/kkmWEuWNDPJVlKSJRB6Y2fHqdJk+SQ==", "license": "MIT", - "peer": true, "dependencies": { "@types/react": "*" }, @@ -15328,7 +15306,6 @@ "resolved": "https://registry.npmjs.org/react-router/-/react-router-5.3.4.tgz", "integrity": "sha512-Ys9K+ppnJah3QuaRiLxk+jDWOR1MekYQrlytiXxC1RyfbdsZkS5pvKAzCCr031xHixZwpnsYNT5xysdFHQaYsA==", "license": "MIT", - "peer": true, "dependencies": { "@babel/runtime": "^7.12.13", "history": "^4.9.0", @@ -17059,7 +17036,6 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", "license": "MIT", - "peer": true, "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -17252,8 +17228,7 @@ "version": "2.8.1", "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", - "license": "0BSD", - "peer": true + "license": "0BSD" }, "node_modules/type-fest": { "version": "2.19.0", @@ -17316,7 +17291,6 @@ "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", "devOptional": true, "license": "Apache-2.0", - "peer": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" @@ -17686,7 +17660,6 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", "license": "MIT", - "peer": true, "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -17885,7 +17858,6 @@ "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.95.0.tgz", "integrity": "sha512-2t3XstrKULz41MNMBF+cJ97TyHdyQ8HCt//pqErqDvNjU9YQBnZxIHa11VXsi7F3mb5/aO2tuDxdeTPdU7xu9Q==", "license": "MIT", - "peer": true, "dependencies": { "@types/estree": "^1.0.5", "@webassemblyjs/ast": "^1.12.1", @@ -18161,7 +18133,6 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", "license": "MIT", - "peer": true, "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", diff --git a/sidebars.ts b/sidebars.ts index 26cc4f0..cb147c4 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -16,6 +16,7 @@ const sidebars: SidebarsConfig = { developersSidebar: [{type: 'autogenerated', dirName: 'developers'}], operatorsSidebar: [{type: 'autogenerated', dirName: 'operators'}], stakersSidebar: [{type: 'autogenerated', dirName: 'stakers'}], + ssvStakingSidebar: [{type: 'autogenerated', dirName: 'ssv-staking'}], }; export default sidebars; diff --git a/static/img/deposit-eth-1.png b/static/img/deposit-eth-1.png new file mode 100644 index 0000000..55f4244 Binary files /dev/null and b/static/img/deposit-eth-1.png differ diff --git a/static/img/deposit-eth-2.png b/static/img/deposit-eth-2.png new file mode 100644 index 0000000..484c7d3 Binary files /dev/null and b/static/img/deposit-eth-2.png differ diff --git a/static/img/deposit-eth-3.png b/static/img/deposit-eth-3.png new file mode 100644 index 0000000..9dbb470 Binary files /dev/null and b/static/img/deposit-eth-3.png differ diff --git a/static/img/deposit-eth-4.png b/static/img/deposit-eth-4.png new file mode 100644 index 0000000..35ea553 Binary files /dev/null and b/static/img/deposit-eth-4.png differ diff --git a/static/img/deposit-ssv-1.avif b/static/img/deposit-ssv-1.avif deleted file mode 100644 index 466513b..0000000 Binary files a/static/img/deposit-ssv-1.avif and /dev/null differ diff --git a/static/img/deposit-ssv-2.avif b/static/img/deposit-ssv-2.avif deleted file mode 100644 index f2742fe..0000000 Binary files a/static/img/deposit-ssv-2.avif and /dev/null differ diff --git a/static/img/deposit-ssv-3.avif b/static/img/deposit-ssv-3.avif deleted file mode 100644 index 8d14586..0000000 Binary files a/static/img/deposit-ssv-3.avif and /dev/null differ diff --git a/static/img/deposit-ssv-4.avif b/static/img/deposit-ssv-4.avif deleted file mode 100644 index 7f316dc..0000000 Binary files a/static/img/deposit-ssv-4.avif and /dev/null differ diff --git a/static/img/deposit-ssv-5.png b/static/img/deposit-ssv-5.png deleted file mode 100644 index 7e993ed..0000000 Binary files a/static/img/deposit-ssv-5.png and /dev/null differ diff --git a/static/img/deposit-ssv-6.avif b/static/img/deposit-ssv-6.avif deleted file mode 100644 index 2526240..0000000 Binary files a/static/img/deposit-ssv-6.avif and /dev/null differ diff --git a/static/img/distributing-a-val-1.png b/static/img/distributing-a-val-1.png new file mode 100644 index 0000000..c78869d Binary files /dev/null and b/static/img/distributing-a-val-1.png differ diff --git a/static/img/distributing-a-val-10.png b/static/img/distributing-a-val-10.png new file mode 100644 index 0000000..50c9e00 Binary files /dev/null and b/static/img/distributing-a-val-10.png differ diff --git a/static/img/distributing-a-val-11.png b/static/img/distributing-a-val-11.png new file mode 100644 index 0000000..e16d045 Binary files /dev/null and b/static/img/distributing-a-val-11.png differ diff --git a/static/img/distributing-a-val-12.png b/static/img/distributing-a-val-12.png new file mode 100644 index 0000000..857cc1e Binary files /dev/null and b/static/img/distributing-a-val-12.png differ diff --git a/static/img/distributing-a-val-13.png b/static/img/distributing-a-val-13.png new file mode 100644 index 0000000..f782ecd Binary files /dev/null and b/static/img/distributing-a-val-13.png differ diff --git a/static/img/distributing-a-val-14.png b/static/img/distributing-a-val-14.png new file mode 100644 index 0000000..fc03879 Binary files /dev/null and b/static/img/distributing-a-val-14.png differ diff --git a/static/img/distributing-a-val-16.png b/static/img/distributing-a-val-16.png new file mode 100644 index 0000000..969d70b Binary files /dev/null and b/static/img/distributing-a-val-16.png differ diff --git a/static/img/distributing-a-val-17.png b/static/img/distributing-a-val-17.png new file mode 100644 index 0000000..9afacc8 Binary files /dev/null and b/static/img/distributing-a-val-17.png differ diff --git a/static/img/distributing-a-val-3.png b/static/img/distributing-a-val-3.png new file mode 100644 index 0000000..3f200c6 Binary files /dev/null and b/static/img/distributing-a-val-3.png differ diff --git a/static/img/distributing-a-val-4.png b/static/img/distributing-a-val-4.png new file mode 100644 index 0000000..e4f5cce Binary files /dev/null and b/static/img/distributing-a-val-4.png differ diff --git a/static/img/distributing-a-val-5.png b/static/img/distributing-a-val-5.png new file mode 100644 index 0000000..5195e61 Binary files /dev/null and b/static/img/distributing-a-val-5.png differ diff --git a/static/img/distributing-a-val-EB.png b/static/img/distributing-a-val-EB.png new file mode 100644 index 0000000..7ef6c5b Binary files /dev/null and b/static/img/distributing-a-val-EB.png differ diff --git a/static/img/migrate-eth-1.png b/static/img/migrate-eth-1.png new file mode 100644 index 0000000..dd4b3c0 Binary files /dev/null and b/static/img/migrate-eth-1.png differ diff --git a/static/img/migrate-eth-10.png b/static/img/migrate-eth-10.png new file mode 100644 index 0000000..7a0e416 Binary files /dev/null and b/static/img/migrate-eth-10.png differ diff --git a/static/img/migrate-eth-2.png b/static/img/migrate-eth-2.png new file mode 100644 index 0000000..4c583ea Binary files /dev/null and b/static/img/migrate-eth-2.png differ diff --git a/static/img/migrate-eth-3.png b/static/img/migrate-eth-3.png new file mode 100644 index 0000000..73ad72c Binary files /dev/null and b/static/img/migrate-eth-3.png differ diff --git a/static/img/migrate-eth-4.png b/static/img/migrate-eth-4.png new file mode 100644 index 0000000..4dcce26 Binary files /dev/null and b/static/img/migrate-eth-4.png differ diff --git a/static/img/migrate-eth-5.png b/static/img/migrate-eth-5.png new file mode 100644 index 0000000..10c7be7 Binary files /dev/null and b/static/img/migrate-eth-5.png differ diff --git a/static/img/migrate-eth-6.png b/static/img/migrate-eth-6.png new file mode 100644 index 0000000..1328476 Binary files /dev/null and b/static/img/migrate-eth-6.png differ diff --git a/static/img/migrate-eth-7.png b/static/img/migrate-eth-7.png new file mode 100644 index 0000000..752cd2d Binary files /dev/null and b/static/img/migrate-eth-7.png differ diff --git a/static/img/migrate-eth-8.png b/static/img/migrate-eth-8.png new file mode 100644 index 0000000..f15bfdd Binary files /dev/null and b/static/img/migrate-eth-8.png differ diff --git a/static/img/migrate-eth-9.png b/static/img/migrate-eth-9.png new file mode 100644 index 0000000..cb703d2 Binary files /dev/null and b/static/img/migrate-eth-9.png differ diff --git a/static/img/stake-ssv-1.png b/static/img/stake-ssv-1.png new file mode 100644 index 0000000..a467857 Binary files /dev/null and b/static/img/stake-ssv-1.png differ diff --git a/static/img/stake-ssv-2.png b/static/img/stake-ssv-2.png new file mode 100644 index 0000000..47d1d9a Binary files /dev/null and b/static/img/stake-ssv-2.png differ diff --git a/static/img/stake-ssv-3.png b/static/img/stake-ssv-3.png new file mode 100644 index 0000000..cb146ca Binary files /dev/null and b/static/img/stake-ssv-3.png differ diff --git a/static/img/stake-ssv-4.png b/static/img/stake-ssv-4.png new file mode 100644 index 0000000..6c71048 Binary files /dev/null and b/static/img/stake-ssv-4.png differ diff --git a/static/img/stake-ssv-5.png b/static/img/stake-ssv-5.png new file mode 100644 index 0000000..7e854fa Binary files /dev/null and b/static/img/stake-ssv-5.png differ diff --git a/static/img/stake-ssv-6.png b/static/img/stake-ssv-6.png new file mode 100644 index 0000000..0f11c72 Binary files /dev/null and b/static/img/stake-ssv-6.png differ diff --git a/static/img/staking-rewards-2.png b/static/img/staking-rewards-2.png new file mode 100644 index 0000000..6efd875 Binary files /dev/null and b/static/img/staking-rewards-2.png differ diff --git a/static/img/staking-rewards-3.png b/static/img/staking-rewards-3.png new file mode 100644 index 0000000..5d4eebd Binary files /dev/null and b/static/img/staking-rewards-3.png differ diff --git a/static/img/tokenomics-readme-1.avif b/static/img/tokenomics-readme-1.avif deleted file mode 100644 index 5913916..0000000 Binary files a/static/img/tokenomics-readme-1.avif and /dev/null differ diff --git a/static/img/tokenomics-readme-1.png b/static/img/tokenomics-readme-1.png new file mode 100644 index 0000000..a0435a2 Binary files /dev/null and b/static/img/tokenomics-readme-1.png differ diff --git a/static/img/unstake-ssv-2.png b/static/img/unstake-ssv-2.png new file mode 100644 index 0000000..26a1132 Binary files /dev/null and b/static/img/unstake-ssv-2.png differ diff --git a/static/img/unstake-ssv-3.png b/static/img/unstake-ssv-3.png new file mode 100644 index 0000000..e319bcd Binary files /dev/null and b/static/img/unstake-ssv-3.png differ diff --git a/static/img/unstake-ssv-4.png b/static/img/unstake-ssv-4.png new file mode 100644 index 0000000..20bd84a Binary files /dev/null and b/static/img/unstake-ssv-4.png differ diff --git a/static/img/unstake-ssv-5.png b/static/img/unstake-ssv-5.png new file mode 100644 index 0000000..1062afd Binary files /dev/null and b/static/img/unstake-ssv-5.png differ diff --git a/static/img/unstake-ssv-6.png b/static/img/unstake-ssv-6.png new file mode 100644 index 0000000..6cf130f Binary files /dev/null and b/static/img/unstake-ssv-6.png differ diff --git a/static/img/unstake-ssv-7.png b/static/img/unstake-ssv-7.png new file mode 100644 index 0000000..d841edb Binary files /dev/null and b/static/img/unstake-ssv-7.png differ diff --git a/static/img/withdraw-eth-2.png b/static/img/withdraw-eth-2.png new file mode 100644 index 0000000..89c336c Binary files /dev/null and b/static/img/withdraw-eth-2.png differ diff --git a/static/img/withdraw-eth-3.png b/static/img/withdraw-eth-3.png new file mode 100644 index 0000000..82af7f0 Binary files /dev/null and b/static/img/withdraw-eth-3.png differ diff --git a/static/img/withdraw-eth-4.png b/static/img/withdraw-eth-4.png new file mode 100644 index 0000000..098acc8 Binary files /dev/null and b/static/img/withdraw-eth-4.png differ diff --git a/static/img/withdraw-ssv-1.avif b/static/img/withdraw-ssv-1.avif deleted file mode 100644 index d2777a0..0000000 Binary files a/static/img/withdraw-ssv-1.avif and /dev/null differ diff --git a/static/img/withdraw-ssv-2.avif b/static/img/withdraw-ssv-2.avif deleted file mode 100644 index beb9ae9..0000000 Binary files a/static/img/withdraw-ssv-2.avif and /dev/null differ diff --git a/static/img/withdraw-ssv-3.avif b/static/img/withdraw-ssv-3.avif deleted file mode 100644 index 5f0bff0..0000000 Binary files a/static/img/withdraw-ssv-3.avif and /dev/null differ diff --git a/static/img/withdraw-ssv-4.png b/static/img/withdraw-ssv-4.png deleted file mode 100644 index 48e7a17..0000000 Binary files a/static/img/withdraw-ssv-4.png and /dev/null differ diff --git a/static/img/withdraw-ssv-5.avif b/static/img/withdraw-ssv-5.avif deleted file mode 100644 index 777a02f..0000000 Binary files a/static/img/withdraw-ssv-5.avif and /dev/null differ diff --git a/yarn.lock b/yarn.lock index f50366e..dff6526 100644 --- a/yarn.lock +++ b/yarn.lock @@ -94,7 +94,7 @@ "@algolia/requester-fetch" "5.45.0" "@algolia/requester-node-http" "5.45.0" -"@algolia/client-search@5.45.0": +"@algolia/client-search@>= 4.9.1 < 6", "@algolia/client-search@5.45.0": version "5.45.0" resolved "https://registry.npmjs.org/@algolia/client-search/-/client-search-5.45.0.tgz" integrity sha512-nxuCid+Nszs4xqwIMDw11pRJPes2c+Th1yup/+LtpjFH8QWXkr3SirNYSD3OXAeM060HgWWPLA8/Fxk+vwxQOA== @@ -174,7 +174,7 @@ resolved "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.28.5.tgz" integrity sha512-6uFXyCayocRbqhZOB+6XcuZbkMNimwfVGFji8CTZnCzOHVGvDqzvitu1re2AU5LROliz7eQPhB8CpAMvnx9EjA== -"@babel/core@^7.21.3", "@babel/core@^7.25.9": +"@babel/core@^7.0.0", "@babel/core@^7.0.0-0", "@babel/core@^7.0.0-0 || ^8.0.0-0 <8.0.0", "@babel/core@^7.12.0", "@babel/core@^7.13.0", "@babel/core@^7.21.3", "@babel/core@^7.25.9", "@babel/core@^7.4.0 || ^8.0.0-0 <8.0.0": version "7.28.5" resolved "https://registry.npmjs.org/@babel/core/-/core-7.28.5.tgz" integrity sha512-e7jT4DxYvIDLk1ZHmU/m/mB19rex9sv0c2ftBtjSBv+kVM/902eh0fINUzD7UwLLNR+jU585GxUJ8/EBfAM5fw== @@ -1651,7 +1651,7 @@ utility-types "^3.10.0" webpack "^5.88.1" -"@docusaurus/plugin-content-docs@3.9.2": +"@docusaurus/plugin-content-docs@*", "@docusaurus/plugin-content-docs@3.9.2": version "3.9.2" resolved "https://registry.npmjs.org/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.9.2.tgz" integrity sha512-C5wZsGuKTY8jEYsqdxhhFOe1ZDjH0uIYJ9T/jebHwkyxqnr4wW0jTkB72OMqNjsoQRcb0JN3PcSeTwFlVgzCZg== @@ -2110,7 +2110,7 @@ "@nodelib/fs.stat" "2.0.5" run-parallel "^1.1.9" -"@nodelib/fs.stat@2.0.5", "@nodelib/fs.stat@^2.0.2": +"@nodelib/fs.stat@^2.0.2", "@nodelib/fs.stat@2.0.5": version "2.0.5" resolved "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz" integrity sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A== @@ -2244,7 +2244,7 @@ "@svgr/babel-plugin-transform-react-native-svg" "8.1.0" "@svgr/babel-plugin-transform-svg-component" "8.0.0" -"@svgr/core@8.1.0": +"@svgr/core@*", "@svgr/core@8.1.0": version "8.1.0" resolved "https://registry.npmjs.org/@svgr/core/-/core-8.1.0.tgz" integrity sha512-8QqtOQT5ACVlmsvKOJNEaWmRPmcojMOzCz4Hs2BGG/toAp/K38LcsMRyLp349glq5AzJbCEeimEoxaX6v/fLrA== @@ -2367,7 +2367,7 @@ "@types/range-parser" "*" "@types/send" "*" -"@types/express@*", "@types/express@^4.17.21": +"@types/express@*", "@types/express@^4.17.13", "@types/express@^4.17.21": version "4.17.25" resolved "https://registry.npmjs.org/@types/express/-/express-4.17.25.tgz" integrity sha512-dVd04UKsfpINUnK0yBoYHDF3xu7xVH4BuDotC/xGuycx4CgbP48X/KF/586bcObxT0HENHXEU8Nqtu6NR+eKhw== @@ -2774,7 +2774,7 @@ acorn-walk@^8.0.0: dependencies: acorn "^8.11.0" -acorn@^8.0.0, acorn@^8.0.4, acorn@^8.11.0, acorn@^8.7.1, acorn@^8.8.2: +"acorn@^6.0.0 || ^7.0.0 || ^8.0.0", acorn@^8, acorn@^8.0.0, acorn@^8.0.4, acorn@^8.11.0, acorn@^8.7.1, acorn@^8.8.2: version "8.15.0" resolved "https://registry.npmjs.org/acorn/-/acorn-8.15.0.tgz" integrity sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg== @@ -2811,7 +2811,7 @@ ajv-keywords@^5.1.0: dependencies: fast-deep-equal "^3.1.3" -ajv@^6.12.5: +ajv@^6.12.5, ajv@^6.9.1: version "6.12.6" resolved "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz" integrity sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g== @@ -2821,7 +2821,7 @@ ajv@^6.12.5: json-schema-traverse "^0.4.1" uri-js "^4.2.2" -ajv@^8.0.0, ajv@^8.9.0: +ajv@^8.0.0, ajv@^8.8.2, ajv@^8.9.0: version "8.17.1" resolved "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz" integrity sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g== @@ -3094,7 +3094,7 @@ braces@^3.0.3, braces@~3.0.2: dependencies: fill-range "^7.1.1" -browserslist@^4.0.0, browserslist@^4.21.10, browserslist@^4.23.0, browserslist@^4.24.0, browserslist@^4.26.0, browserslist@^4.27.0, browserslist@^4.28.0: +browserslist@^4.0.0, browserslist@^4.21.10, browserslist@^4.23.0, browserslist@^4.24.0, browserslist@^4.26.0, browserslist@^4.27.0, browserslist@^4.28.0, "browserslist@>= 4.21.0": version "4.28.1" resolved "https://registry.npmjs.org/browserslist/-/browserslist-4.28.1.tgz" integrity sha512-ZC5Bd0LgJXgwGqUknZY/vkUQ04r8NXnJZ3yYi4vDmSiZmC/pdSN0NbNRPxZpbtO4uAfDUAFffO8IZoM3Gj8IkA== @@ -3117,12 +3117,17 @@ bundle-name@^4.1.0: dependencies: run-applescript "^7.0.0" +bytes@~3.1.2: + version "3.1.2" + resolved "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz" + integrity sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg== + bytes@3.0.0: version "3.0.0" resolved "https://registry.npmjs.org/bytes/-/bytes-3.0.0.tgz" integrity sha512-pMhOfFDPiv9t5jjIXkHosWmkSyQbvsgEVNkz0ERHbuLh2T/7j4Mqqpz523Fe8MVY89KC6Sh/QfS2sM+SjgFDcw== -bytes@3.1.2, bytes@~3.1.2: +bytes@3.1.2: version "3.1.2" resolved "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz" integrity sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg== @@ -3463,11 +3468,6 @@ consola@^3.2.3: resolved "https://registry.npmjs.org/consola/-/consola-3.4.2.tgz" integrity sha512-5IKcdX0nnYavi6G7TtOhwkYzyjfJlatbjMjuLSfE2kYT5pMDOilZ4OvMhi637CcDICTmz3wARPoyhqyX1Y+XvA== -content-disposition@0.5.2: - version "0.5.2" - resolved "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.2.tgz" - integrity sha512-kRGRZw3bLlFISDBgwTSA1TMBFN6J6GWDeubmDE3AF+3+yXL8hTWv8r5rkLbqYXY4RjPk/EzHnClI3zQf1cFmHA== - content-disposition@~0.5.4: version "0.5.4" resolved "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.4.tgz" @@ -3475,6 +3475,11 @@ content-disposition@~0.5.4: dependencies: safe-buffer "5.2.1" +content-disposition@0.5.2: + version "0.5.2" + resolved "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.2.tgz" + integrity sha512-kRGRZw3bLlFISDBgwTSA1TMBFN6J6GWDeubmDE3AF+3+yXL8hTWv8r5rkLbqYXY4RjPk/EzHnClI3zQf1cFmHA== + content-type@~1.0.4, content-type@~1.0.5: version "1.0.5" resolved "https://registry.npmjs.org/content-type/-/content-type-1.0.5.tgz" @@ -3739,6 +3744,13 @@ debounce@^1.2.1: resolved "https://registry.npmjs.org/debounce/-/debounce-1.2.1.tgz" integrity sha512-XRRe6Glud4rd/ZGQfiV1ruXSfbvfJedlV9Y6zOlP+2K04vBYiJEte6stfFkCP03aMnY5tsipamumUjL14fofug== +debug@^4.0.0, debug@^4.1.0, debug@^4.3.1, debug@^4.4.1, debug@4: + version "4.4.3" + resolved "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz" + integrity sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA== + dependencies: + ms "^2.1.3" + debug@2.6.9: version "2.6.9" resolved "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz" @@ -3746,13 +3758,6 @@ debug@2.6.9: dependencies: ms "2.0.0" -debug@4, debug@^4.0.0, debug@^4.1.0, debug@^4.3.1, debug@^4.4.1: - version "4.4.3" - resolved "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz" - integrity sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA== - dependencies: - ms "^2.1.3" - decode-named-character-reference@^1.0.0: version "1.1.0" resolved "https://registry.npmjs.org/decode-named-character-reference/-/decode-named-character-reference-1.1.0.tgz" @@ -3823,22 +3828,22 @@ define-properties@^1.2.1: has-property-descriptors "^1.0.0" object-keys "^1.1.1" -depd@2.0.0, depd@~2.0.0: - version "2.0.0" - resolved "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz" - integrity sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw== - depd@~1.1.2: version "1.1.2" resolved "https://registry.npmjs.org/depd/-/depd-1.1.2.tgz" integrity sha512-7emPTl6Dpo6JRXOXjLRxck+FlLRX5847cLKEn00PLAgc3g2hTZZgr+e4c2v6QpSmLeFP3n5yUo7ft6avBK/5jQ== +depd@~2.0.0, depd@2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz" + integrity sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw== + dequal@^2.0.0: version "2.0.3" resolved "https://registry.npmjs.org/dequal/-/dequal-2.0.3.tgz" integrity sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA== -destroy@1.2.0, destroy@~1.2.0: +destroy@~1.2.0, destroy@1.2.0: version "1.2.0" resolved "https://registry.npmjs.org/destroy/-/destroy-1.2.0.tgz" integrity sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg== @@ -4369,7 +4374,7 @@ figures@^3.2.0: dependencies: escape-string-regexp "^1.0.5" -file-loader@^6.2.0: +file-loader@*, file-loader@^6.2.0: version "6.2.0" resolved "https://registry.npmjs.org/file-loader/-/file-loader-6.2.0.tgz" integrity sha512-qo3glqyTa61Ytg4u73GultjHGjdRyig3tG6lPtyX/jOEJvHif9uB0/OCI2Kif6ctF3caQTW2G5gym21oAsI4pw== @@ -4443,7 +4448,7 @@ fraction.js@^5.3.4: resolved "https://registry.npmjs.org/fraction.js/-/fraction.js-5.3.4.tgz" integrity sha512-1X1NTtiJphryn/uLQz3whtY6jK3fTqoE3ohKs0tT+Ujr1W59oopxmoEh7Lu5p6vBaPbgoM0bzveAW4Qi5RyWDQ== -fresh@0.5.2, fresh@~0.5.2: +fresh@~0.5.2, fresh@0.5.2: version "0.5.2" resolved "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz" integrity sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q== @@ -4459,7 +4464,7 @@ fs-extra@^11.1.1, fs-extra@^11.2.0: fsevents@~2.3.2: version "2.3.3" - resolved "https://registry.yarnpkg.com/fsevents/-/fsevents-2.3.3.tgz#cac6407785d03675a2a5e1a5305c697b347d90d6" + resolved "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz" integrity sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw== function-bind@^1.1.2: @@ -4587,16 +4592,16 @@ got@^12.1.0: p-cancelable "^3.0.0" responselike "^3.0.0" -graceful-fs@4.2.10: - version "4.2.10" - resolved "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.10.tgz" - integrity sha512-9ByhssR2fPVsNZj478qUUbKfmL0+t5BDVyjShtyZZLiK7ZDAArFFfopyOTj0M05wE2tJPisA4iTnnXl2YoPvOA== - graceful-fs@^4.1.2, graceful-fs@^4.1.6, graceful-fs@^4.2.0, graceful-fs@^4.2.11, graceful-fs@^4.2.4, graceful-fs@^4.2.6, graceful-fs@^4.2.9: version "4.2.11" resolved "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz" integrity sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ== +graceful-fs@4.2.10: + version "4.2.10" + resolved "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.10.tgz" + integrity sha512-9ByhssR2fPVsNZj478qUUbKfmL0+t5BDVyjShtyZZLiK7ZDAArFFfopyOTj0M05wE2tJPisA4iTnnXl2YoPvOA== + gray-matter@^4.0.3: version "4.0.3" resolved "https://registry.npmjs.org/gray-matter/-/gray-matter-4.0.3.tgz" @@ -4926,17 +4931,6 @@ http-deceiver@^1.2.7: resolved "https://registry.npmjs.org/http-deceiver/-/http-deceiver-1.2.7.tgz" integrity sha512-LmpOGxTfbpgtGVxJrj5k7asXHCgNZp5nLfp+hWc8QQRqtb7fUy6kRY3BO1h9ddF6yIPYUARgxGOwB42DnxIaNw== -http-errors@2.0.0: - version "2.0.0" - resolved "https://registry.npmjs.org/http-errors/-/http-errors-2.0.0.tgz" - integrity sha512-FtwrG/euBzaEjYeRqOgly7G0qviiXoJWnvEH2Z1plBdXgbyjv34pHTSb9zoeHMyDy33+DWy5Wt9Wo+TURtOYSQ== - dependencies: - depd "2.0.0" - inherits "2.0.4" - setprototypeof "1.2.0" - statuses "2.0.1" - toidentifier "1.0.1" - http-errors@~1.6.2: version "1.6.3" resolved "https://registry.npmjs.org/http-errors/-/http-errors-1.6.3.tgz" @@ -4958,6 +4952,17 @@ http-errors@~2.0.0, http-errors@~2.0.1: statuses "~2.0.2" toidentifier "~1.0.1" +http-errors@2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/http-errors/-/http-errors-2.0.0.tgz" + integrity sha512-FtwrG/euBzaEjYeRqOgly7G0qviiXoJWnvEH2Z1plBdXgbyjv34pHTSb9zoeHMyDy33+DWy5Wt9Wo+TURtOYSQ== + dependencies: + depd "2.0.0" + inherits "2.0.4" + setprototypeof "1.2.0" + statuses "2.0.1" + toidentifier "1.0.1" + http-parser-js@>=0.5.1: version "0.5.10" resolved "https://registry.npmjs.org/http-parser-js/-/http-parser-js-0.5.10.tgz" @@ -5051,15 +5056,25 @@ infima@0.2.0-alpha.45: resolved "https://registry.npmjs.org/infima/-/infima-0.2.0-alpha.45.tgz" integrity sha512-uyH0zfr1erU1OohLk0fT4Rrb94AOhguWNOcD9uGrSpRvNB+6gZXUoJX5J0NtvzBO10YZ9PgvA4NFgt+fYg8ojw== +inherits@^2.0.1, inherits@^2.0.3, inherits@~2.0.3, inherits@~2.0.4, inherits@2.0.4: + version "2.0.4" + resolved "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz" + integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== + inherits@2.0.3: version "2.0.3" resolved "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz" integrity sha512-x00IRNXNy63jwGkJmzPigoySHbaqpNuzKbBOmzK+g2OdZpQ9w+sxCN+VSB3ja7IAge2OP2qpfxTjeNcyjmW1uw== -inherits@2.0.4, inherits@^2.0.1, inherits@^2.0.3, inherits@~2.0.3, inherits@~2.0.4: - version "2.0.4" - resolved "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz" - integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== +ini@^1.3.4: + version "1.3.8" + resolved "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz" + integrity sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew== + +ini@~1.3.0: + version "1.3.8" + resolved "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz" + integrity sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew== ini@2.0.0: version "2.0.0" @@ -5083,16 +5098,16 @@ invariant@^2.2.4: dependencies: loose-envify "^1.0.0" -ipaddr.js@1.9.1: - version "1.9.1" - resolved "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz" - integrity sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g== - ipaddr.js@^2.1.0: version "2.3.0" resolved "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-2.3.0.tgz" integrity sha512-Zv/pA+ciVFbCSBBjGfaKUya/CcGmUHzTydLMaTwrUUEM2DIEO3iZvueGxmacvmN50fGpGVKeTXpb2LcYQxeVdg== +ipaddr.js@1.9.1: + version "1.9.1" + resolved "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz" + integrity sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g== + is-alphabetical@^2.0.0: version "2.0.1" resolved "https://registry.npmjs.org/is-alphabetical/-/is-alphabetical-2.0.1.tgz" @@ -5270,16 +5285,16 @@ is-yarn-global@^0.4.0: resolved "https://registry.npmjs.org/is-yarn-global/-/is-yarn-global-0.4.1.tgz" integrity sha512-/kppl+R+LO5VmhYSEWARUFjodS25D68gvj8W7z0I7OWhUla5xWu8KL6CtB2V0R6yqhnRgbcaREMr4EEM6htLPQ== -isarray@0.0.1: - version "0.0.1" - resolved "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz" - integrity sha512-D2S+3GLxWH+uhrNEcoh/fnmYeP8E8/zHl644d/jdA0g2uyXvy3sb0qxotE+ne0LtccHknQzWwZEzhak7oJ0COQ== - isarray@~1.0.0: version "1.0.0" resolved "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz" integrity sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ== +isarray@0.0.1: + version "0.0.1" + resolved "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz" + integrity sha512-D2S+3GLxWH+uhrNEcoh/fnmYeP8E8/zHl644d/jdA0g2uyXvy3sb0qxotE+ne0LtccHknQzWwZEzhak7oJ0COQ== + isexe@^2.0.0: version "2.0.0" resolved "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz" @@ -6259,12 +6274,17 @@ micromatch@^4.0.2, micromatch@^4.0.4, micromatch@^4.0.5: braces "^3.0.3" picomatch "^2.3.1" +mime-db@^1.54.0: + version "1.54.0" + resolved "https://registry.npmjs.org/mime-db/-/mime-db-1.54.0.tgz" + integrity sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ== + mime-db@1.52.0: version "1.52.0" resolved "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz" integrity sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg== -"mime-db@>= 1.43.0 < 2", mime-db@^1.54.0: +"mime-db@>= 1.43.0 < 2": version "1.54.0" resolved "https://registry.npmjs.org/mime-db/-/mime-db-1.54.0.tgz" integrity sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ== @@ -6274,14 +6294,12 @@ mime-db@~1.33.0: resolved "https://registry.npmjs.org/mime-db/-/mime-db-1.33.0.tgz" integrity sha512-BHJ/EKruNIqJf/QahvxwQZXKygOQ256myeN/Ew+THcAa5q+PjyTTMMeNQC4DZw5AwfvelsUrA6B67NKMqXDbzQ== -mime-types@2.1.18, mime-types@~2.1.17: - version "2.1.18" - resolved "https://registry.npmjs.org/mime-types/-/mime-types-2.1.18.tgz" - integrity sha512-lc/aahn+t4/SWV/qcmumYjymLsWfN3ELhpmVuUFjgsORruuZPVSwAQryq+HHGvO/SI2KVX26bx+En+zhM8g8hQ== - dependencies: - mime-db "~1.33.0" +mime-db@1.52.0: + version "1.52.0" + resolved "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz" + integrity sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg== -mime-types@^2.1.27, mime-types@~2.1.24, mime-types@~2.1.34: +mime-types@^2.1.27: version "2.1.35" resolved "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz" integrity sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw== @@ -6295,6 +6313,27 @@ mime-types@^3.0.1: dependencies: mime-db "^1.54.0" +mime-types@~2.1.17, mime-types@2.1.18: + version "2.1.18" + resolved "https://registry.npmjs.org/mime-types/-/mime-types-2.1.18.tgz" + integrity sha512-lc/aahn+t4/SWV/qcmumYjymLsWfN3ELhpmVuUFjgsORruuZPVSwAQryq+HHGvO/SI2KVX26bx+En+zhM8g8hQ== + dependencies: + mime-db "~1.33.0" + +mime-types@~2.1.24: + version "2.1.35" + resolved "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz" + integrity sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw== + dependencies: + mime-db "1.52.0" + +mime-types@~2.1.34: + version "2.1.35" + resolved "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz" + integrity sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw== + dependencies: + mime-db "1.52.0" + mime@1.6.0: version "1.6.0" resolved "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz" @@ -6345,16 +6384,16 @@ mrmime@^2.0.0: resolved "https://registry.npmjs.org/mrmime/-/mrmime-2.0.0.tgz" integrity sha512-eu38+hdgojoyq63s+yTpN4XMBdt5l8HhMhc4VKLO9KM5caLIBvUm4thi7fFaxyTmCKeNnXZ5pAlBwCUnhA09uw== +ms@^2.1.3, ms@2.1.3: + version "2.1.3" + resolved "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz" + integrity sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA== + ms@2.0.0: version "2.0.0" resolved "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz" integrity sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A== -ms@2.1.3, ms@^2.1.3: - version "2.1.3" - resolved "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz" - integrity sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA== - multicast-dns@^7.2.5: version "7.2.5" resolved "https://registry.npmjs.org/multicast-dns/-/multicast-dns-7.2.5.tgz" @@ -6368,16 +6407,16 @@ nanoid@^3.3.11: resolved "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz" integrity sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w== -negotiator@0.6.3: - version "0.6.3" - resolved "https://registry.npmjs.org/negotiator/-/negotiator-0.6.3.tgz" - integrity sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg== - negotiator@~0.6.4: version "0.6.4" resolved "https://registry.npmjs.org/negotiator/-/negotiator-0.6.4.tgz" integrity sha512-myRT3DiWPHqho5PrJaIRyaMv2kgYf0mUVgBNOYMuCH5Ki1yEiQaf/ZJuQ62nvpc44wL5WDbTX7yGJi1Neevw8w== +negotiator@0.6.3: + version "0.6.3" + resolved "https://registry.npmjs.org/negotiator/-/negotiator-0.6.3.tgz" + integrity sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg== + neo-async@^2.6.2: version "2.6.2" resolved "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz" @@ -6485,7 +6524,7 @@ obuf@^1.0.0, obuf@^1.1.2: resolved "https://registry.npmjs.org/obuf/-/obuf-1.1.2.tgz" integrity sha512-PX1wu0AmAdPqOL1mWhqmlOd8kOIZQwGZw6rh7uby9fTc5lhaOWFLX3I6R1hrF9k3zUY40e6igsLGkDXK92LJNg== -on-finished@2.4.1, on-finished@^2.4.1, on-finished@~2.4.1: +on-finished@^2.4.1, on-finished@~2.4.1, on-finished@2.4.1: version "2.4.1" resolved "https://registry.npmjs.org/on-finished/-/on-finished-2.4.1.tgz" integrity sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg== @@ -6684,11 +6723,6 @@ path-parse@^1.0.7: resolved "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz" integrity sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw== -path-to-regexp@3.3.0: - version "3.3.0" - resolved "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-3.3.0.tgz" - integrity sha512-qyCH421YQPS2WFDxDjftfc1ZR5WKQzVzqsp4n9M2kQhVOo/ByahFoUNJfl58kOcEGfQ//7weFTDhm+ss8Ecxgw== - path-to-regexp@^1.7.0: version "1.9.0" resolved "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.9.0.tgz" @@ -6701,6 +6735,11 @@ path-to-regexp@~0.1.12: resolved "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-0.1.12.tgz" integrity sha512-RA1GjUVMnvYFxuqovrEqZoxxW5NUZqbwKtYz/Tt7nXerk0LbLblQmrsgdeOxV5SFHf0UDggjS/bSeOZwt1pmEQ== +path-to-regexp@3.3.0: + version "3.3.0" + resolved "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-3.3.0.tgz" + integrity sha512-qyCH421YQPS2WFDxDjftfc1ZR5WKQzVzqsp4n9M2kQhVOo/ByahFoUNJfl58kOcEGfQ//7weFTDhm+ss8Ecxgw== + path-type@^4.0.0: version "4.0.0" resolved "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz" @@ -7274,7 +7313,7 @@ postcss-zindex@^6.0.2: resolved "https://registry.npmjs.org/postcss-zindex/-/postcss-zindex-6.0.2.tgz" integrity sha512-5BxW9l1evPB/4ZIc+2GobEBoKC+h8gPGCMi+jxsYvd2x0mjq7wazk6DrP71pStqxE9Foxh5TVnonbWpFZzXaYg== -postcss@^8.4.21, postcss@^8.4.24, postcss@^8.4.33, postcss@^8.5.4: +"postcss@^7.0.0 || ^8.0.1", postcss@^8, postcss@^8.0.3, postcss@^8.0.9, postcss@^8.1.0, postcss@^8.2.2, postcss@^8.4, postcss@^8.4.21, postcss@^8.4.23, postcss@^8.4.24, postcss@^8.4.31, postcss@^8.4.33, postcss@^8.4.6, postcss@^8.5.4: version "8.5.6" resolved "https://registry.npmjs.org/postcss/-/postcss-8.5.6.tgz" integrity sha512-3Ybi1tAuwAP9s0r1UQ2J4n5Y0G05bJkpUIO0/bI9MhwmD70S5aTWbXGBwxHrelT+XM1k6dM0pk+SwNkpTRN7Pg== @@ -7390,16 +7429,21 @@ randombytes@^2.1.0: dependencies: safe-buffer "^5.1.0" -range-parser@1.2.0: - version "1.2.0" - resolved "https://registry.npmjs.org/range-parser/-/range-parser-1.2.0.tgz" - integrity sha512-kA5WQoNVo4t9lNx2kQNFCxKeBl5IbbSNBl1M/tLkw9WCn+hxNBAW5Qh8gdhs63CJnhjJ2zQWFoqPJP2sK1AV5A== +range-parser@^1.2.1: + version "1.2.1" + resolved "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz" + integrity sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg== -range-parser@^1.2.1, range-parser@~1.2.1: +range-parser@~1.2.1: version "1.2.1" resolved "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz" integrity sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg== +range-parser@1.2.0: + version "1.2.0" + resolved "https://registry.npmjs.org/range-parser/-/range-parser-1.2.0.tgz" + integrity sha512-kA5WQoNVo4t9lNx2kQNFCxKeBl5IbbSNBl1M/tLkw9WCn+hxNBAW5Qh8gdhs63CJnhjJ2zQWFoqPJP2sK1AV5A== + raw-body@~2.5.3: version "2.5.3" resolved "https://registry.npmjs.org/raw-body/-/raw-body-2.5.3.tgz" @@ -7460,7 +7504,7 @@ react-loadable-ssr-addon-v5-slorber@^1.0.1: dependencies: "@babel/runtime" "^7.10.3" -"react-loadable@npm:@docusaurus/react-loadable@6.0.0": +react-loadable@*, "react-loadable@npm:@docusaurus/react-loadable@6.0.0": version "6.0.0" resolved "https://registry.npmjs.org/@docusaurus/react-loadable/-/react-loadable-6.0.0.tgz" integrity sha512-YMMxTUQV/QFSnbgrP3tjDzLHRg7vsbMn8e9HAa8o/1iXoiomo48b7sk/kkmWEuWNDPJVlKSJRB6Y2fHqdJk+SQ== @@ -7487,7 +7531,7 @@ react-router-dom@^5.3.4: tiny-invariant "^1.0.2" tiny-warning "^1.0.0" -react-router@5.3.4, react-router@^5.3.4: +react-router@^5.3.4, react-router@>=5, react-router@5.3.4: version "5.3.4" resolved "https://registry.npmjs.org/react-router/-/react-router-5.3.4.tgz" integrity sha512-Ys9K+ppnJah3QuaRiLxk+jDWOR1MekYQrlytiXxC1RyfbdsZkS5pvKAzCCr031xHixZwpnsYNT5xysdFHQaYsA== @@ -7847,7 +7891,7 @@ run-parallel@^1.1.9: dependencies: queue-microtask "^1.2.2" -safe-buffer@5.2.1, safe-buffer@>=5.1.0, safe-buffer@^5.1.0, safe-buffer@~5.2.0: +safe-buffer@^5.1.0, safe-buffer@>=5.1.0, safe-buffer@~5.2.0, safe-buffer@5.2.1: version "5.2.1" resolved "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz" integrity sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ== @@ -7877,7 +7921,25 @@ schema-dts@^1.1.2: resolved "https://registry.npmjs.org/schema-dts/-/schema-dts-1.1.5.tgz" integrity sha512-RJr9EaCmsLzBX2NDiO5Z3ux2BVosNZN5jo0gWgsyKvxKIUL5R3swNvoorulAeL9kLB0iTSX7V6aokhla2m7xbg== -schema-utils@^3.0.0, schema-utils@^3.1.1, schema-utils@^3.2.0: +schema-utils@^3.0.0: + version "3.3.0" + resolved "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz" + integrity sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg== + dependencies: + "@types/json-schema" "^7.0.8" + ajv "^6.12.5" + ajv-keywords "^3.5.2" + +schema-utils@^3.1.1: + version "3.3.0" + resolved "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz" + integrity sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg== + dependencies: + "@types/json-schema" "^7.0.8" + ajv "^6.12.5" + ajv-keywords "^3.5.2" + +schema-utils@^3.2.0: version "3.3.0" resolved "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz" integrity sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg== @@ -7896,6 +7958,11 @@ schema-utils@^4.0.0, schema-utils@^4.0.1, schema-utils@^4.2.0: ajv-formats "^2.1.1" ajv-keywords "^5.1.0" +"search-insights@>= 1 < 3": + version "2.17.3" + resolved "https://registry.npmjs.org/search-insights/-/search-insights-2.17.3.tgz" + integrity sha512-RQPdCYTa8A68uM2jwxoY842xDhvx3E5LFL1LxvxCNMev4o5mLuokczhzjAgGwUZBAmOKZknArSxLKmXtIi2AxQ== + section-matter@^1.0.0: version "1.0.0" resolved "https://registry.npmjs.org/section-matter/-/section-matter-1.0.0.tgz" @@ -7934,15 +8001,15 @@ semver@^7.3.5, semver@^7.3.7, semver@^7.5.4: resolved "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz" integrity sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A== -send@0.19.0: - version "0.19.0" - resolved "https://registry.npmjs.org/send/-/send-0.19.0.tgz" - integrity sha512-dW41u5VfLXu8SJh5bwRmyYUbAoSB3c9uQh6L8h/KtsFREPWpbX1lrljJo186Jc4nmci/sGUZ9a0a0J2zgfq2hw== +send@~0.19.0: + version "0.19.1" + resolved "https://registry.npmjs.org/send/-/send-0.19.1.tgz" + integrity sha512-p4rRk4f23ynFEfcD9LA0xRYngj+IyGiEYyqqOak8kaN0TvNmuxC2dcVeBn62GpCeR2CpWqyHCNScTP91QbAVFg== dependencies: debug "2.6.9" depd "2.0.0" destroy "1.2.0" - encodeurl "~1.0.2" + encodeurl "~2.0.0" escape-html "~1.0.3" etag "~1.8.1" fresh "0.5.2" @@ -7953,15 +8020,15 @@ send@0.19.0: range-parser "~1.2.1" statuses "2.0.1" -send@~0.19.0: - version "0.19.1" - resolved "https://registry.npmjs.org/send/-/send-0.19.1.tgz" - integrity sha512-p4rRk4f23ynFEfcD9LA0xRYngj+IyGiEYyqqOak8kaN0TvNmuxC2dcVeBn62GpCeR2CpWqyHCNScTP91QbAVFg== +send@0.19.0: + version "0.19.0" + resolved "https://registry.npmjs.org/send/-/send-0.19.0.tgz" + integrity sha512-dW41u5VfLXu8SJh5bwRmyYUbAoSB3c9uQh6L8h/KtsFREPWpbX1lrljJo186Jc4nmci/sGUZ9a0a0J2zgfq2hw== dependencies: debug "2.6.9" depd "2.0.0" destroy "1.2.0" - encodeurl "~2.0.0" + encodeurl "~1.0.2" escape-html "~1.0.3" etag "~1.8.1" fresh "0.5.2" @@ -8027,16 +8094,16 @@ set-function-length@^1.2.2: gopd "^1.0.1" has-property-descriptors "^1.0.2" +setprototypeof@~1.2.0, setprototypeof@1.2.0: + version "1.2.0" + resolved "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.2.0.tgz" + integrity sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw== + setprototypeof@1.1.0: version "1.1.0" resolved "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.1.0.tgz" integrity sha512-BvE/TwpZX4FXExxOxZyRGQQv651MSwmWKZGqvmPcRIjDqWub67kTKuIMx43cZZrS/cBBzwBcNDWoFxt2XEFIpQ== -setprototypeof@1.2.0, setprototypeof@~1.2.0: - version "1.2.0" - resolved "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.2.0.tgz" - integrity sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw== - shallow-clone@^3.0.0: version "3.0.1" resolved "https://registry.npmjs.org/shallow-clone/-/shallow-clone-3.0.1.tgz" @@ -8187,7 +8254,7 @@ source-map-support@~0.5.20: buffer-from "^1.0.0" source-map "^0.6.0" -source-map@^0.6.0, source-map@~0.6.0: +source-map@^0.6.0: version "0.6.1" resolved "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz" integrity sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g== @@ -8235,11 +8302,6 @@ srcset@^4.0.0: resolved "https://registry.npmjs.org/srcset/-/srcset-4.0.0.tgz" integrity sha512-wvLeHgcVHKO8Sc/H/5lkGreJQVeYMm9rlmt8PuR1xE31rIuXhuzznUUqAt8MqLhB3MqJdFzlNAfpcWnxiFUcPw== -statuses@2.0.1: - version "2.0.1" - resolved "https://registry.npmjs.org/statuses/-/statuses-2.0.1.tgz" - integrity sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ== - "statuses@>= 1.4.0 < 2": version "1.5.0" resolved "https://registry.npmjs.org/statuses/-/statuses-1.5.0.tgz" @@ -8250,12 +8312,40 @@ statuses@~2.0.1, statuses@~2.0.2: resolved "https://registry.npmjs.org/statuses/-/statuses-2.0.2.tgz" integrity sha512-DvEy55V3DB7uknRo+4iOGT5fP1slR8wQohVdknigZPMpMstaKJQWhwiYBACJE3Ul2pTnATihhBYnRhZQHGBiRw== +statuses@2.0.1: + version "2.0.1" + resolved "https://registry.npmjs.org/statuses/-/statuses-2.0.1.tgz" + integrity sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ== + std-env@^3.7.0: version "3.10.0" resolved "https://registry.npmjs.org/std-env/-/std-env-3.10.0.tgz" integrity sha512-5GS12FdOZNliM5mAOxFRg7Ir0pWz8MdpYm6AY6VPkGpbA7ZzmbzNcBJQ0GPvvyWgcY7QAhCgf9Uy89I03faLkg== -string-width@^4.1.0, string-width@^4.2.0: +string_decoder@^1.1.1: + version "1.3.0" + resolved "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz" + integrity sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA== + dependencies: + safe-buffer "~5.2.0" + +string_decoder@~1.1.1: + version "1.1.1" + resolved "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz" + integrity sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg== + dependencies: + safe-buffer "~5.1.0" + +string-width@^4.1.0: + version "4.2.3" + resolved "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz" + integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== + dependencies: + emoji-regex "^8.0.0" + is-fullwidth-code-point "^3.0.0" + strip-ansi "^6.0.1" + +string-width@^4.2.0: version "4.2.3" resolved "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz" integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== @@ -8273,20 +8363,6 @@ string-width@^5.0.1, string-width@^5.1.2: emoji-regex "^9.2.2" strip-ansi "^7.0.1" -string_decoder@^1.1.1: - version "1.3.0" - resolved "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz" - integrity sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA== - dependencies: - safe-buffer "~5.2.0" - -string_decoder@~1.1.1: - version "1.1.1" - resolved "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz" - integrity sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg== - dependencies: - safe-buffer "~5.1.0" - stringify-entities@^4.0.0: version "4.0.4" resolved "https://registry.npmjs.org/stringify-entities/-/stringify-entities-4.0.4.tgz" @@ -8455,7 +8531,7 @@ to-regex-range@^5.0.1: dependencies: is-number "^7.0.0" -toidentifier@1.0.1, toidentifier@~1.0.1: +toidentifier@~1.0.1, toidentifier@1.0.1: version "1.0.1" resolved "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.1.tgz" integrity sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA== @@ -8480,7 +8556,7 @@ trough@^2.0.0: resolved "https://registry.npmjs.org/trough/-/trough-2.2.0.tgz" integrity sha512-tmMpK00BjZiUyVyvrBK7knerNgmgvcV/KLVyuma/SC+TQN167GrMRciANTz09+k3zW8L8t60jWO1GpfkZdjTaw== -tslib@^2.0.0, tslib@^2.0.3, tslib@^2.6.0: +tslib@^2, tslib@^2.0.0, tslib@^2.0.3, tslib@^2.6.0, tslib@2: version "2.8.1" resolved "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz" integrity sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w== @@ -8515,7 +8591,7 @@ typedarray-to-buffer@^3.1.5: dependencies: is-typedarray "^1.0.0" -typescript@5.9.3: +typescript@>=4.9.5, typescript@5.9.3: version "5.9.3" resolved "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz" integrity sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw== @@ -8897,7 +8973,7 @@ webpackbar@^6.0.1: std-env "^3.7.0" wrap-ansi "^7.0.0" -websocket-driver@>=0.5.1, websocket-driver@^0.7.4: +websocket-driver@^0.7.4, websocket-driver@>=0.5.1: version "0.7.4" resolved "https://registry.npmjs.org/websocket-driver/-/websocket-driver-0.7.4.tgz" integrity sha512-b17KeDIQVjvb0ssuSDF2cYXSg2iztliJ4B9WdsuB6J952qCPKmnVq4DyW5motImXHDC1cBT/1UezrJVsKw5zjg==