Merge branch 'gnosis-network' of github.com:stakewise/v3-sdk into gnosis-network

Author: Cast0001

README.md

@@ -317,13 +317,14 @@ Fetch the whitelist for private vaults. Only addresses included in this list are
 
 #### Arguments:
 
-| Name | Type              | Type        | Description |
-|------|-------------------|-------------|---|
-| vaultAddress | `string`          | **Yes** | - |
-| orderDirection | `'asc' \| 'desc'` | **No** | Sort, by default `desc` (descending order) |
-| search | `string`          | **No** | Filters results by the address field |
-| limit | `number`          | **No** | Limit the number of addresses, default is 100 |
-| skip | `number`          | **No** | Skip the number of addresses, default is 0 |
+| Name | Type              | Type        | Description                                                                                                                                  |
+|------|-------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------|
+| vaultAddress | `string`          | **Yes** | -                                                                                                                                   |
+| addressIn | `string[]`   | **No** | Filters results to include only addresses in the provided list. Helps to check, for example, if several addresses are added to the whitelist |
+| orderDirection | `'asc' \| 'desc'` | **No** | Specifies the sorting order. Defaults to `desc` (descending order)                                                                 |
+| search | `string`        | **No** | Filters results by the address field                                                                                                         |
+| limit | `number`         | **No** | Limits the number of addresses returned. Defaults to 100                                                                                     |
+| skip | `number`          | **No** | Skips the specified number of addresses. Defaults to 0                                                                                       |
 
 #### Returns:
 
@@ -359,13 +360,14 @@ Fetch the blocklist for blocklisted vaults. Addresses included in this list are
 
 #### Arguments:
 
-| Name | Type          | Type        | Description |
-|------|---------------|-------------|---|
-| vaultAddress | `string`      | **Yes** | - |
-| orderDirection | `'asc' \| 'desc'` | **No** | Sort, by default `desc` (descending order) |
-| search | `string`      | **No** | Filters results by the address field |
-| limit | `number`      | **No** | Limit the number of addresses, default is 100 |
-| skip | `number`      | **No** | Skip the number of addresses, default is 0 |
+| Name | Type              | Type        | Description                                                                                                                                |
+|------|-------------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------|
+| vaultAddress | `string`  | **Yes** | -                                                                                                                                          |
+| addressIn | `string[]`   | **No** | Filters results to include only addresses in the provided list. Helps to check, for example, if all OFAC addresses are added to the blocklist |
+| orderDirection | `'asc' \| 'desc'` | **No** | Specifies the sorting order. Defaults to `desc` (descending order)                                                                                               |
+| search | `string`        | **No** | Filters results by the address field                                                                                                       |
+| limit | `number`         | **No** | Limits the number of addresses returned. Defaults to 100                                                                                              |
+| skip | `number`          | **No** | Skips the specified number of addresses. Defaults to 0                                                                                                 |
 
 #### Returns:
 

src/methods/vault/requests/getBlocklist/index.ts

@@ -1,3 +1,4 @@
+import { isAddress } from 'ethers'
 import type { BlocklistAccountsQueryVariables, BlocklistAccountsQueryPayload } from '../../../../graphql/subgraph/vault'
 import { apiUrls, validateArgs } from '../../../../utils'
 import graphql from '../../../../graphql'
@@ -11,11 +12,20 @@ type GetBlocklistInput = {
   search?: string
   limit?: number
   skip?: number
+  addressIn?: BlocklistAccountsQueryVariables['where']['address_in']
   options: StakeWise.Options
 }
 
+const validateList = (addressIn: string[]) => {
+  const isValid = addressIn.every((address) => isAddress(address))
+
+  if (!isValid) {
+    throw new Error('The "addressIn" argument must be an array of valid addresses')
+  }
+}
+
 const getBlocklist = (input: GetBlocklistInput) => {
-  const { vaultAddress, orderDirection, search, limit, skip, options } = input
+  const { vaultAddress, orderDirection, search, limit, skip, addressIn, options } = input
 
   validateArgs.address({ vaultAddress })
 
@@ -37,11 +47,16 @@ const getBlocklist = (input: GetBlocklistInput) => {
     }
   }
 
+  if (typeof addressIn !== 'undefined') {
+    validateArgs.array({ addressIn })
+    validateList(addressIn)
+  }
+
   const vault = vaultAddress.toLowerCase()
 
   const where = search
-    ? { vault, address_contains: search.toLowerCase() } as BlocklistAccountsQueryVariables['where']
-    : { vault } as BlocklistAccountsQueryVariables['where']
+    ? { vault, address_in: addressIn, address_contains: search.toLowerCase() } as BlocklistAccountsQueryVariables['where']
+    : { vault, address_in: addressIn } as BlocklistAccountsQueryVariables['where']
 
   return graphql.subgraph.vault.fetchBlocklistAccountsQuery<ModifiedBlocklist>({
     url: apiUrls.getSubgraphqlUrl(options),

src/methods/vault/requests/getWhitelist/index.ts

@@ -1,3 +1,4 @@
+import { isAddress } from 'ethers'
 import type { WhitelistAccountsQueryVariables, WhitelistAccountsQueryPayload } from '../../../../graphql/subgraph/vault'
 import { apiUrls, validateArgs } from '../../../../utils'
 import graphql from '../../../../graphql'
@@ -11,12 +12,20 @@ type GetWhitelistInput = {
   search?: string
   limit?: number
   skip?: number
+  addressIn?: WhitelistAccountsQueryVariables['where']['address_in']
   options: StakeWise.Options
 }
 
+const validateList = (addressIn: string[]) => {
+  const isValid = addressIn.every((address) => isAddress(address))
+
+  if (!isValid) {
+    throw new Error('The "addressIn" argument must be an array of valid addresses')
+  }
+}
 
 const getWhitelist = (input: GetWhitelistInput) => {
-  const { vaultAddress, orderDirection, search, limit, skip, options } = input
+  const { vaultAddress, orderDirection, search, limit, skip, addressIn, options } = input
 
   validateArgs.address({ vaultAddress })
 
@@ -38,11 +47,16 @@ const getWhitelist = (input: GetWhitelistInput) => {
     }
   }
 
+  if (typeof addressIn !== 'undefined') {
+    validateArgs.array({ addressIn })
+    validateList(addressIn)
+  }
+
   const vault = vaultAddress.toLowerCase()
 
   const where = search
-    ? { vault, address_contains: search.toLowerCase() } as WhitelistAccountsQueryVariables['where']
-    : { vault } as WhitelistAccountsQueryVariables['where']
+    ? { vault, address_in: addressIn, address_contains: search.toLowerCase() } as WhitelistAccountsQueryVariables['where']
+    : { vault, address_in: addressIn } as WhitelistAccountsQueryVariables['where']
 
   return graphql.subgraph.vault.fetchWhitelistAccountsQuery<ModifiedWhitelist>({
     url: apiUrls.getSubgraphqlUrl(options),