Merge pull request #1 from lidofinance/feature/add-ssv-fee-factory

feat: ssv fee

Author: avsetsin

package.json

@@ -16,5 +16,6 @@
   },
   "devDependencies": {
     "esbuild": "^0.19.8"
-  }
+  },
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }

public/index.html

@@ -52,14 +52,14 @@ <h1>0x split contract</h1>
 						</label>
 					</div>
 				</div>
-				<div class="form-row form-row-cluster-type form-row-hidden">
+				<div class="form-row form-row-wrapper-contract-type form-row-hidden">
 					<div class="form-label">
-						<label for="cluster-type-super-cluster">Cluster type</label>
+						<label for="wrapper-contract-type">Wrapper charges</label>
 					</div>
 					<div class="form-input">
-						<select name="cluster-type" id="cluster-type-super-cluster">
-							<option value="ssv">SSV</option>
-							<option value="obol">Obol</option>
+						<select name="wrapper-contract-type" id="wrapper-contract-type">
+							<option value="wrapperWithFee">1% fee to DVT provider</option>
+							<option value="wrapperWithoutFee">no fee</option>
 						</select>
 					</div>
 				</div>
@@ -85,7 +85,8 @@ <h1>Wrapper contract <cite>(cluster reward address)<cite>
 					</div>
 					<div class="form-input">
 						<select name="cluster-type" id="cluster-type">
-							<option value="ssv">SSV</option>
+							<option value="ssvWithFee">SSV with fee</option>
+							<option value="ssvWithoutFee">SSV without fee</option>
 							<option value="obol">Obol</option>
 						</select>
 					</div>

readme.md

@@ -32,7 +32,7 @@ flowchart LR;
 
 The UI allows deploying 2 contracts from factories:
 
-**Split Сontract**. A contract that distributes rewards to participants. It uses the 0xSplit factory [0x2ed6c4B5dA6378c7897AC67Ba9e43102Feb694EE](https://etherscan.io/address/0x2ed6c4B5dA6378c7897AC67Ba9e43102Feb694EE) for contract deployment.
+**Split Contract**. A contract that distributes rewards to participants. It uses the 0xSplit factory [0x2ed6c4B5dA6378c7897AC67Ba9e43102Feb694EE](https://etherscan.io/address/0x2ed6c4B5dA6378c7897AC67Ba9e43102Feb694EE) for contract deployment.
 
 **Wrapper Contract**. The contract that is specified as the `rewardAddress` of a node operator. Wraps `stETH` rewards to `wstETH` and sends it to the split contract.
 

src/constants.ts

@@ -6,11 +6,13 @@ export const contracts = {
   wrapperFactory: {
     1: {
       obol: '0xA9d94139A310150Ca1163b5E23f3E1dbb7D9E2A6',
-      ssv: '0x3df147bd18854bfa03291034666469237504d4ca',
+      ssvWithoutFee: '0x3df147bd18854bfa03291034666469237504d4ca',
+      ssvWithFee: '0x2bc222eda59056d7049f3746083c18550fec4e7f',
     },
     17000: {
       obol: '0x934ec6b68ce7cc3b3e6106c686b5ad808ed26449',
-      ssv: '0xB7f465f1bd6B2f8DAbA3FcA36c5F5E49E0812F37',
+      ssvWithoutFee: '0xB7f465f1bd6B2f8DAbA3FcA36c5F5E49E0812F37',
+      ssvWithFee: 'not_supported',
     },
   },
   treasury: {
@@ -19,7 +21,7 @@ export const contracts = {
   },
 };
 
-export const treasuryShareByProvider = {
-  obol: 285714,
-  ssv: 250000,
+export const treasuryShareByType = {
+  wrapperWithoutFee: 250000,
+  wrapperWithFee: 285714,
 };

src/elements.ts

@@ -3,8 +3,10 @@ export const splitAddressElement = document.getElementById('split-address') as H
 export const clusterAddressesElement = document.getElementById('cluster-addresses') as HTMLInputElement;
 export const clusterIsSuperClusterElement = document.getElementById('cluster-is-super-cluster') as HTMLInputElement;
 
-export const superClusterTypeElement = document.getElementById('cluster-type-super-cluster') as HTMLSelectElement;
-export const clusterRowClusterType = document.getElementsByClassName('form-row-cluster-type')[0] as HTMLDivElement;
+export const wrapperContractTypeElement = document.getElementById('wrapper-contract-type') as HTMLSelectElement;
+export const wrapperContractTypeRowElement = document.getElementsByClassName(
+  'form-row-wrapper-contract-type',
+)[0] as HTMLDivElement;
 
 export const clusterFormWrapperElement = document.getElementById('cluster-form-wrapper') as HTMLFormElement;
 export const clusterFormSplitElement = document.getElementById('cluster-form-split') as HTMLFormElement;

src/form-split.ts

@@ -14,7 +14,7 @@ import {
   clusterAddressesElement,
   splitAddressElement,
   clusterIsSuperClusterElement,
-  clusterRowClusterType,
+  wrapperContractTypeRowElement,
 } from './elements';
 import './gnosis-owners';
 
@@ -79,8 +79,8 @@ const handleSubmitSplit = (event) => {
 clusterFormSplitElement.addEventListener('submit', handleSubmitSplit);
 clusterIsSuperClusterElement.addEventListener('change', () => {
   if (clusterIsSuperClusterElement.checked) {
-    clusterRowClusterType.classList.remove('form-row-hidden');
+    wrapperContractTypeRowElement.classList.remove('form-row-hidden');
   } else {
-    clusterRowClusterType.classList.add('form-row-hidden');
+    wrapperContractTypeRowElement.classList.add('form-row-hidden');
   }
 });

src/utils.ts

@@ -1,8 +1,8 @@
 import { BrowserProvider, Eip1193Provider, JsonRpcSigner, isAddress } from 'ethers';
 import { modal } from './modal';
-import { contracts, treasuryShareByProvider } from './constants';
+import { contracts, treasuryShareByType } from './constants';
 import { Contract } from 'ethers';
-import { superClusterTypeElement } from './elements';
+import { wrapperContractTypeElement } from './elements';
 
 export const distributeEvenly = (total: number, participants: number): number[] => {
   if (participants <= 0) {
@@ -27,10 +27,10 @@ export const calcDistributionForRegularCluster = (accounts: string[], totalShare
 };
 
 export const calcDistributionForSuperCluster = (accounts: string[], totalShares: number, chainId: number) => {
-  const splitType = superClusterTypeElement.value;
-  validateSplitType(splitType, chainId);
+  const wrapperContractType = wrapperContractTypeElement.value;
+  validateWrapperContractType(wrapperContractType);
 
-  const treasuryShare = treasuryShareByProvider[splitType];
+  const treasuryShare = treasuryShareByType[wrapperContractType];
   const treasuryAddress = contracts.treasury[chainId];
   validateAddress(treasuryAddress);
 
@@ -114,6 +114,14 @@ export const validateSplitType = (splitType: string, chainId: number) => {
   }
 };
 
+export const validateWrapperContractType = (wrapperContractType: string) => {
+  const allowedTypes = new Set(Object.keys(treasuryShareByType));
+
+  if (!allowedTypes.has(wrapperContractType)) {
+    throw new Error(`unknown wrapper contract type "${wrapperContractType}"`);
+  }
+};
+
 export const checkDuplicates = (accounts: string[]) => {
   const uniqueAccounts = new Set(accounts.map((address) => address.toLocaleLowerCase()));