chore(protocol-staking): clean, improve and add tasks

Author: melanciani

protocol-contracts/staking/.env.example

@@ -7,7 +7,7 @@ MAINNET_RPC_URL=
 SEPOLIA_RPC_URL=
 
 # ----------------------------------------------------------------------------
-# ProtocolStaking deployment
+# ProtocolStaking deployment and configuration
 # ----------------------------------------------------------------------------
 # Address of the underlying staking ERC20
 ZAMA_TOKEN_ADDRESS=0x0000000000000000000000000000000000000001
@@ -25,6 +25,10 @@ PROTOCOL_STAKING_COPRO_VERSION=1
 # Cooldown period in seconds before unstaked tokens can be released
 PROTOCOL_STAKING_COPRO_COOLDOWN_PERIOD=604800 # 7 days
 
+# Initial reward rate
+# Note: The reward rate is in tokens (using 18 decimals) per second
+PROTOCOL_STAKING_COPRO_REWARD_RATE=10000000000000000
+
 # ----------------------------------------------------------------------------
 # KMS
 # ----------------------------------------------------------------------------
@@ -35,8 +39,12 @@ PROTOCOL_STAKING_KMS_VERSION=1
 # Cooldown period in seconds before unstaked tokens can be released
 PROTOCOL_STAKING_KMS_COOLDOWN_PERIOD=604800 # 7 days
 
+# Initial reward rate
+# Note: The reward rate is in tokens (using 18 decimals) per second
+PROTOCOL_STAKING_KMS_REWARD_RATE=10000000000000000
+
 # ----------------------------------------------------------------------------
-# OperatorStaking deployment
+# OperatorStaking deployment and configuration 
 # ----------------------------------------------------------------------------
 # ----------------------------------------------------------------------------
 # Coprocessor
@@ -49,11 +57,20 @@ OPERATOR_STAKING_COPRO_TOKEN_NAME_0="OperatorStakingCopro1"
 OPERATOR_STAKING_COPRO_TOKEN_SYMBOL_0="stZAMAcopro1"
 OPERATOR_STAKING_COPRO_OWNER_ADDRESS_0="0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC"  # accounts[2] (address)
 
+# OperatorRewarder coprocessor 1
+# Initial owner fee
+# Note: The owner fee is in basis points (in 1/100th of a percent, so 10000 = 100.00%)
+OPERATOR_REWARDER_COPRO_OWNER_FEE_0=2000
+
 # OperatorStaking coprocessor 2
 OPERATOR_STAKING_COPRO_TOKEN_NAME_1="OperatorStakingCopro2"
 OPERATOR_STAKING_COPRO_TOKEN_SYMBOL_1="stZAMAcopro2"
 OPERATOR_STAKING_COPRO_OWNER_ADDRESS_1="0x90F79bf6EB2c4f870365E785982E1f101E93b906"  # accounts[3] (address)
 
+# OperatorRewarder coprocessor 2
+# Initial owner fee
+# Note: The owner fee is in basis points (in 1/100th of a percent, so 10000 = 100.00%)
+OPERATOR_REWARDER_COPRO_OWNER_FEE_1=1000
 
 # ----------------------------------------------------------------------------
 # KMS
@@ -66,23 +83,27 @@ OPERATOR_STAKING_KMS_TOKEN_NAME_0="OperatorStakingKms1"
 OPERATOR_STAKING_KMS_TOKEN_SYMBOL_0="stZAMAkms1"
 OPERATOR_STAKING_KMS_OWNER_ADDRESS_0="0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC"  # accounts[2] (address)
 
+# OperatorRewarder KMS 1
+# Initial owner fee
+# Note: The owner fee is in basis points (in 1/100th of a percent, so 10000 = 100.00%)
+OPERATOR_REWARDER_KMS_OWNER_FEE_0=1500
+
 # OperatorStaking KMS 2
 OPERATOR_STAKING_KMS_TOKEN_NAME_1="OperatorStakingKms2"
 OPERATOR_STAKING_KMS_TOKEN_SYMBOL_1="stZAMAkms2"
 OPERATOR_STAKING_KMS_OWNER_ADDRESS_1="0x90F79bf6EB2c4f870365E785982E1f101E93b906"  # accounts[3] (address)
 
-# OperatorStaking KMS 3
-OPERATOR_STAKING_KMS_TOKEN_NAME_1="OperatorStakingKms3"
-OPERATOR_STAKING_KMS_TOKEN_SYMBOL_1="stZAMAkms3"
-OPERATOR_STAKING_KMS_OWNER_ADDRESS_1="0x15d34AAf54267DB7D7c367839AAf71A00a2C6A65"  # accounts[4] (address)
+# OperatorRewarder KMS 2
+# Initial owner fee
+# Note: The owner fee is in basis points (in 1/100th of a percent, so 10000 = 100.00%)
+OPERATOR_REWARDER_KMS_OWNER_FEE_1=1000
 
-# ----------------------------------------------------------------------------
-# Post-deployment configuration
-# ----------------------------------------------------------------------------
-# ProtocolStaking initial reward rate
-# Note: The reward rate is in tokens (using 18 decimals) per second
-PROTOCOL_STAKING_REWARD_RATE=10000000000000000
+# OperatorStaking KMS 3
+OPERATOR_STAKING_KMS_TOKEN_NAME_2="OperatorStakingKms3"
+OPERATOR_STAKING_KMS_TOKEN_SYMBOL_2="stZAMAkms3"
+OPERATOR_STAKING_KMS_OWNER_ADDRESS_2="0x15d34AAf54267DB7D7c367839AAf71A00a2C6A65"  # accounts[4] (address)
 
-# OperatorRewarder initial owner fee
+# OperatorRewarder KMS 3
+# Initial owner fee
 # Note: The owner fee is in basis points (in 1/100th of a percent, so 10000 = 100.00%)
-OPERATOR_REWARDER_OWNER_FEE=1000
+OPERATOR_REWARDER_KMS_OWNER_FEE_2=500

protocol-contracts/staking/.gitignore

@@ -42,6 +42,7 @@ build/site
 # only used to package @openzeppelin/contracts
 contracts/build/
 contracts/README.md
+.openzeppelin
 
 # temporary artifact from solidity-coverage
 allFiredEvents

protocol-contracts/staking/hardhat.config.ts

@@ -1,7 +1,9 @@
 import './tasks/accounts';
 import './tasks/addEligibleAccount';
 import './tasks/deployment';
+import './tasks/deposit';
 import './tasks/ownership';
+import './tasks/setOwnerFee';
 import './tasks/setRewardRate';
 import './tasks/verify';
 import '@nomicfoundation/hardhat-chai-matchers';
@@ -46,7 +48,7 @@ if (accounts == null) {
 
 const config: HardhatUserConfig = {
   solidity: {
-    version: '0.8.29',
+    version: '0.8.27',
     settings: {
       optimizer: {
         enabled: true,
@@ -56,11 +58,11 @@ const config: HardhatUserConfig = {
     },
   },
   networks: {
-    'mainnet': {
+    mainnet: {
       url: process.env.MAINNET_RPC_URL || '',
       accounts,
     },
-    'testnet': {
+    testnet: {
       url: process.env.SEPOLIA_RPC_URL || '',
       accounts,
     },

protocol-contracts/staking/tasks/addEligibleAccount.ts

@@ -5,6 +5,7 @@ import {
   getProtocolStakingKMSProxyAddress,
   getAllOperatorStakingKMSAddresses,
 } from './utils/getAddresses';
+import { wait } from './utils/time';
 import { task, types } from 'hardhat/config';
 import { HardhatRuntimeEnvironment } from 'hardhat/types';
 
@@ -28,8 +29,7 @@ task('task:addOperatorAsEligibleInProtocolStaking')
     types.string,
   )
   .setAction(async function ({ operatorStakingAddress, protocolStakingProxyAddress }, hre: HardhatRuntimeEnvironment) {
-    const { ethers, deployments, network, getNamedAccounts } = hre;
-    const { log } = deployments;
+    const { ethers, network, getNamedAccounts } = hre;
 
     // Get the deployer account
     const { deployer } = await getNamedAccounts();
@@ -45,17 +45,23 @@ task('task:addOperatorAsEligibleInProtocolStaking')
     // Add the operator as eligible
     await protocolStaking.addEligibleAccount(operatorStakingAddress);
 
-    log(`Operator ${operatorStakingAddress} added as eligible in protocol staking contract at 
-        address ${protocolStakingProxyAddress} on network ${network.name}`);
+    console.log(
+      [
+        `👉 Added operator as eligible:`,
+        `  - Operator staking address: ${operatorStakingAddress}`,
+        `  - Protocol staking proxy address: ${protocolStakingProxyAddress}`,
+        `  - Added by manager (deployer): ${deployer}`,
+        `  - Network: ${network.name}`,
+        '',
+      ].join('\n'),
+    );
   });
 
 // Add all coprocessor operators as eligible in the coprocessor protocol staking contract
 // Example usage:
 // npx hardhat task:addAllCoproOperatorsAsEligible --network testnet
 task('task:addAllCoproOperatorsAsEligible').setAction(async function (_, hre: HardhatRuntimeEnvironment) {
-  const { log } = hre.deployments;
-
-  log('Adding all coprocessor operators as eligible in the coprocessor protocol staking contract...');
+  console.log('Adding all coprocessor operators as eligible in the coprocessor protocol staking contract...\n');
 
   const operatorStakingAddresses = await getAllOperatorStakingCoproAddresses(hre);
   const protocolStakingCoproProxyAddress = await getProtocolStakingCoproProxyAddress(hre);
@@ -66,16 +72,19 @@ task('task:addAllCoproOperatorsAsEligible').setAction(async function (_, hre: Ha
       operatorStakingAddress,
       protocolStakingProxyAddress: protocolStakingCoproProxyAddress,
     });
+
+    if (i < operatorStakingAddresses.length - 1) {
+      // Wait for 5 seconds before adding the next operator as eligible in order to avoid underpriced transaction issues
+      await wait(5);
+    }
   }
 });
 
 // Add all KMS operators as eligible in the KMS protocol staking contract
 // Example usage:
 // npx hardhat task:addAllKMSOperatorsAsEligible --network testnet
 task('task:addAllKMSOperatorsAsEligible').setAction(async function (_, hre: HardhatRuntimeEnvironment) {
-  const { log } = hre.deployments;
-
-  log('Adding all KMS operators as eligible in the KMS protocol staking contract...');
+  console.log('Adding all KMS operators as eligible in the KMS protocol staking contract...\n');
 
   const operatorStakingAddresses = await getAllOperatorStakingKMSAddresses(hre);
   const protocolStakingKmsProxyAddress = await getProtocolStakingKMSProxyAddress(hre);
@@ -85,17 +94,23 @@ task('task:addAllKMSOperatorsAsEligible').setAction(async function (_, hre: Hard
       operatorStakingAddress,
       protocolStakingProxyAddress: protocolStakingKmsProxyAddress,
     });
+
+    if (i < operatorStakingAddresses.length - 1) {
+      // Wait for 5 seconds before adding the next operator as eligible in order to avoid underpriced transaction issues
+      await wait(5);
+    }
   }
 });
 
 // Add all operators as eligible in the relevant protocol staking contracts (coprocessor and KMS)
 // Example usage:
 // npx hardhat task:addAllOperatorsAsEligible --network testnet
 task('task:addAllOperatorsAsEligible').setAction(async function (_, hre: HardhatRuntimeEnvironment) {
-  const { log } = hre.deployments;
-
-  log('Adding all operators as eligible in the protocol staking contract...');
+  console.log('Adding all operators as eligible in the protocol staking contract...\n');
 
   await hre.run('task:addAllCoproOperatorsAsEligible');
+
+  await wait(5);
+
   await hre.run('task:addAllKMSOperatorsAsEligible');
 });