Node 20 & Renames (#100)

* [node-20] nvmrc & git-action

* [node-20] ethers

* [node-20] ethers 6.12.0

* [node-20] renames

Author: Cast0001

.github/workflows/unit-tests.yml

@@ -19,7 +19,7 @@ jobs:
         with:
           cache: npm
           scope: '@stakewise'
-          node-version: '18.17.0'
+          node-version: '20.12.2'
           registry-url: "https://npm.pkg.github.com"
           cache-dependency-path: "**/package-lock.json"
       - name: Install npm dependencies

.nvmrc

@@ -1 +1 @@
-18.17.0
+20.12.2

README.md

@@ -7,12 +7,12 @@
 The official SDK designed for effortless data retrieval from the StakeWise platform. This SDK provides a streamlined interface over GraphQL requests and contract interactions.
 
 ![Version](https://img.shields.io/npm/v/@stakewise/v3-sdk)
+![Ethers version](https://img.shields.io/badge/ethers-6.11.1-purple)
 ![Size](https://img.shields.io/bundlephobia/min/@stakewise/v3-sdk?label=Size)
 ![Unit Tests](https://github.com/stakewise/v3-sdk/actions/workflows/unit-tests.yml/badge.svg)
 ![GitHub issues](https://img.shields.io/github/issues-raw/stakewise/v3-sdk)
 ![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/stakewise/v3-sdk)
 ![GitHub forks](https://img.shields.io/github/forks/stakewise/v3-sdk)
-![Ethers version](https://img.shields.io/badge/ethers-6.7.1-purple)
 
 ## Table of Contents
 - [Prerequisites](#prerequisites)
@@ -561,12 +561,12 @@ type Output = {
   vaultAdmin: string
   totalAssets: string
   feeRecipient: string
-  whitelister: string
   vaultAddress: string
   mevRecipient: string
   whitelistCount: number
   blocklistCount: number
   imageUrl: string | null
+  whitelistManager: string
   blocklistManager: string
   depositDataManager: string
   isSmoothingPool: boolean
@@ -591,7 +591,7 @@ type Output = {
 | `vaultAdmin`       | Vault administrator address                                   |
 | `totalAssets`      | TVL of Vault                                                  |
 | `feeRecipient`     | Vault fee address                                             |
-| `whitelister`      | Whitelist manager                                             |
+| `whitelistManager` | Whitelist manager                                             |
 | `vaultAddress`     | Address of vault                                              |
 | `mevRecipient`     | Validator fee recipient                                       |
 | `whitelistCount`   | Number of addresses in the [whitelist](#sdkvaultgetwhitelist) |
@@ -1219,34 +1219,34 @@ const gas = await sdk.vault.setDepositDataManager.estimateGas(params)
 
 #### Description:
 
-Updates the vault by authorized personnel such as the vault admin, whitelister, blocklist manager, validators manager, or deposit-data manager.
+Updates the vault by authorized personnel such as the vault admin, whitelistManager, blocklist manager, validators manager, or deposit-data manager.
 
 
 #### Arguments:
 
 | Name             | Type                                         | Required | Access            | Description                                                                                                                 |
 |------------------|----------------------------------------------|----------|-------------------|-----------------------------------------------------------------------------------------------------------------------------|
-| whitelist          | `Array<{ address: string, isNew: boolean }>` | **No** | Whitelister       | List of addresses to update the whitelist. Use `isNew: true` to add a new address, `isNew: false` to remove an existing one. Max count at time - 700 addresses. |
+| whitelistManager   | `Array<{ address: string, isNew: boolean }>` | **No** | whitelistManager  | List of addresses to update the whitelist. Use `isNew: true` to add a new address, `isNew: false` to remove an existing one. Max count at time - 700 addresses. |
 | blocklist          | `Array<{ address: string, isNew: boolean }>` | **No** | Blocklist manager | List of addresses to update the blocklist. Use `isNew: true` to add a new address, `isNew: false` to remove an existing one. Max count at time  - 700 addresses. |
 | depositDataManager | `string` | **No**  | Deposit-data manager | Address of the vault keys manager. Support only **first version** on valults. For second verion use `vault.setDepositDataManager` |
 | validatorsManager  | `string` | **No**  | Admin                | Address of the vault deposit data manager. Support only **second version** on valults. |
-| whitelister        | `string` | **No**  | Admin                | Address of the vault whitelister |
+| whitelistManager   | `string` | **No**  | Admin                | Address of the vault whitelistManager |
 | feeRecipient       | `string` | **No**  | Admin                | Address of the vault fee recipient |
 | validatorsRoot     | `string` | **No**  | Keys manager         | The vault validators merkle tree root. Support only **first version** on valults. For second verion use `vault.setDepositDataRoot` |
 | blocklistManager   | `string` | **No**  | Admin                | The blocklisted vault blocklist manager |
 | metadataIpfsHash   | `string` | **No**  | Admin                | The vault metadata IPFS hash |
-| userAddress        | `string` | **Yes** | -                    | The address of the user making the update (admin, whitelister, blocklist manager or keys manager) |
+| userAddress        | `string` | **Yes** | -                    | The address of the user making the update (admin, whitelist manager, blocklist manager or keys manager) |
 | vaultAddress       | `string` | **Yes** | -                    | The address of the vault  |
 
 #### Example:
 
 ```ts
 // Data to update the vault by admin.
 const params = {
-  whitelister: '0x...',
   feeRecipient: '0x...',
   validatorsRoot: '0x...',
   blocklistManager: '0x...',
+  whitelistManager: '0x...',
   validatorsManager: '0x...',
   depositDataManager: '0x...',
   metadataIpfsHash: '...',
@@ -1261,7 +1261,7 @@ const params = {
   userAddress: '0x...',
 }
 
-// Data to update the private vault by whitelister.
+// Data to update the private vault by whitelist manager.
 // The whitelist contains addresses allowed to stake or mint within
 // the vault.
 const params = {

package.json

@@ -39,7 +39,7 @@
     "staking"
   ],
   "peerDependencies": {
-    "ethers": "^6.7.1"
+    "ethers": "^6.12.0"
   },
   "devDependencies": {
     "@graphql-codegen/cli": "5.0.0",

src/methods/vault/index.ts

@@ -116,7 +116,7 @@ export default {
     */
     claimExitQueue,
     /**
-     * @description Updates the vault by authorized personnel such as the vault admin, whitelister,
+     * @description Updates the vault by authorized personnel such as the vault admin, whitelist manager,
      * blocklist manager, validators manager, or deposit-data manager.
      * @throws Fields validatorsRoot and depositDataManager supported only first version of vaults
      * @see https://github.com/stakewise/v3-sdk/?tab=readme-ov-file#sdkvaultoperate

src/methods/vault/requests/getVault/modifyVault.spec.ts

@@ -67,6 +67,7 @@ describe('modifyVault', () => {
       vaultAddress: '0xeEFFFD4C23D2E8c845870e273861e7d60Df49663',
       feeRecipient: '0xeEFFFD4C23D2E8c845870e273861e7d60Df49663',
       mevRecipient: '0xeEFFFD4C23D2E8c845870e273861e7d60Df49663',
+      whitelistManager: '0xeEFFFD4C23D2E8c845870e273861e7d60Df49663',
       blocklistManager: '0xeEFFFD4C23D2E8c845870e273861e7d60Df49663',
       validatorsManager: '0xeEFFFD4C23D2E8c845870e273861e7d60Df49663',
       depositDataManager: '0xeEFFFD4C23D2E8c845870e273861e7d60Df49663',

src/methods/vault/requests/getVault/modifyVault.ts

@@ -55,6 +55,7 @@ const modifyVault = (input: ModifyVaultInput): ModifiedVault => {
     whitelistCount: Number(whitelistCount),
     keysManager: keysManager ? getAddress(keysManager) : '',
     whitelister: vault.whitelister ? getAddress(vault.whitelister) : '',
+    whitelistManager: vault.whitelister ? getAddress(vault.whitelister) : '',
     validatorsManager: validatorsManager ? getAddress(validatorsManager) : '',
     depositDataManager: depositDataManager ? getAddress(depositDataManager) : '',
     blocklistManager: vault.blocklistManager ? getAddress(vault.blocklistManager) : '',

src/methods/vault/requests/getVault/types.ts

@@ -11,6 +11,7 @@ export type ModifiedVault = Omit<
   | 'mevEscrow'
   | 'keysManager'
   | 'performance'
+  | 'whitelister'
   | 'blocklistCount'
   | 'whitelistCount'
 > & {
@@ -24,9 +25,15 @@ export type ModifiedVault = Omit<
   blocklistCount: number
   whitelistCount: number
   isSmoothingPool: boolean
+  whitelistManager: string
 
   /**
    * @deprecated use depositDataManager
    */
   keysManager: string
+
+  /**
+   * @deprecated use whitelistManager
+  */
+  whitelister: string
 }

src/methods/vault/transactions/operate/checkAccess.ts

@@ -13,7 +13,7 @@ type Action<Input, Output> = (props: Input) => Promise<Output>
 const checkAccess = <Output>(action: Action<Input, Output>) => (
   async (values: Input) => {
     const {
-      blocklist, whitelist, depositDataManager, whitelister, feeRecipient,
+      blocklist, whitelist, depositDataManager, whitelistManager, feeRecipient,
       validatorsRoot, blocklistManager, metadataIpfsHash, validatorsManager,
     } = values
 
@@ -24,16 +24,16 @@ const checkAccess = <Output>(action: Action<Input, Output>) => (
     }
     catch (actionError) {
       const isAdmin = Boolean(
-        whitelister
+        whitelistManager
         || feeRecipient
         || blocklistManager
         || metadataIpfsHash
         || validatorsManager
         || depositDataManager
       )
 
-      const isWhitelister = Boolean(whitelist)
       const isDepositData = Boolean(validatorsRoot)
+      const isWhitelistManager = Boolean(whitelist)
       const isBlocklistManager = Boolean(blocklist)
 
       const checkPromises = []
@@ -48,7 +48,7 @@ const checkAccess = <Output>(action: Action<Input, Output>) => (
           checkDepositDataManagerAccess(values)
         )
       }
-      if (isWhitelister) {
+      if (isWhitelistManager) {
         checkPromises.push(
           checkWhitelisterAccess(values)
         )

src/methods/vault/transactions/operate/common.ts

@@ -18,7 +18,7 @@ import {
 export const commonLogic = async (values: MulticallInput) => {
   const {
     validatorsRoot, blocklistManager, metadataIpfsHash,
-    blocklist, whitelist, depositDataManager, whitelister, feeRecipient,
+    blocklist, whitelist, depositDataManager, whitelistManager, feeRecipient,
     options, contracts, userAddress, vaultAddress, provider, validatorsManager,
   } = values
 
@@ -92,8 +92,8 @@ export const commonLogic = async (values: MulticallInput) => {
     params.push(...depositDataManagerParams)
   }
 
-  if (whitelister) {
-    const whitelisterParams = getWhitelisterParams({ ...baseInput, whitelister })
+  if (whitelistManager) {
+    const whitelisterParams = getWhitelisterParams({ ...baseInput, whitelistManager })
 
     params.push(...whitelisterParams)
   }

src/methods/vault/transactions/util/check/checkWhitelisterAccess.ts

@@ -4,11 +4,11 @@ import type { CheckInput } from './types'
 const checkWhitelisterAccess = async ({ userAddress, vaultAddress, contracts }: CheckInput) => {
   try {
     const vaultContract = await contracts.helpers.createPrivateVault(vaultAddress)
-    const whitelister = await vaultContract.whitelister()
-    const hasAccess = whitelister.toLowerCase() === userAddress.toLowerCase()
+    const whitelistManager = await vaultContract.whitelister()
+    const hasAccess = whitelistManager.toLowerCase() === userAddress.toLowerCase()
 
     if (!hasAccess) {
-      return Promise.reject('User must be the vault whitelister to perform this action')
+      return Promise.reject('User must be the vault whitelist manager to perform this action')
     }
   }
   catch {}

src/methods/vault/transactions/util/params/getWhitelisterParams.ts

@@ -3,17 +3,17 @@ import { vaultMulticall } from '../../../../../contracts'
 
 
 export type SetWhitelisterParams = {
-  whitelister: string
+  whitelistManager: string
 }
 
 const getWhitelisterParams = (values: SetWhitelisterParams) => {
-  const { whitelister } = values
+  const { whitelistManager } = values
 
-  validateArgs.address({ whitelister })
+  validateArgs.address({ whitelistManager })
 
   const params: Parameters<typeof vaultMulticall>[0]['request']['params'] = [
     {
-      method: 'setWhitelister', args: [ whitelister ],
+      method: 'setWhitelister', args: [ whitelistManager ],
     },
   ]