[remove duplicates] update white/block list requests

jest.config.ts

@@ -6,7 +6,7 @@ const config: Config = {
   maxWorkers: 1, // Fixed https://github.com/jestjs/jest/issues/11617#issuecomment-1028651059
   rootDir: './src',
   preset: 'ts-jest',
-  resetMocks: true,
+  resetMocks: false,
   testEnvironment: 'node',
   testMatch: [ '**/*.spec.ts' ],
   collectCoverageFrom: [ 'src/**/*.ts' ],

src/index.ts

@@ -5,7 +5,8 @@ import { constants } from './utils'
 export * from './utils/enums'
 export { createContract } from './contracts'
 export { default as StakeWiseSDK } from './StakeWiseSDK'
-export { wrapAbortPromise, AbortPromise } from './modules/gql-module'
+export { default as localStorage } from './modules/local-storage'
+export { wrapAbortPromise, AbortPromise, AbortRequest } from './modules/gql-module'
 
 export {
   configs,

src/methods/utils/getListVariables.ts

@@ -0,0 +1,66 @@
+import { isAddress } from 'ethers'
+import { validateArgs } from '../../utils'
+import { StakeWiseSubgraphGraph } from '../../types/graphql/subgraph'
+
+
+export type GetListVariablesInput = {
+  vaultAddress: string
+  orderDirection?: StakeWiseSubgraphGraph.OrderDirection
+  search?: string
+  limit?: number
+  skip?: number
+  addressIn?: string[]
+}
+
+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 getListVariables = <T>(input: GetListVariablesInput): T => {
+  const { vaultAddress, orderDirection, search, limit, skip, addressIn } = input
+
+  validateArgs.address({ vaultAddress })
+
+  if (typeof skip !== 'undefined') {
+    validateArgs.number({ skip })
+  }
+
+  if (typeof limit !== 'undefined') {
+    validateArgs.number({ limit })
+  }
+
+  if (typeof search !== 'undefined') {
+    validateArgs.string({ search })
+  }
+
+  if (typeof orderDirection !== 'undefined') {
+    if (![ 'asc', 'desc' ].includes(orderDirection)) {
+      throw new Error(`The "orderDirection" argument must be "asc" or "desc"`)
+    }
+  }
+
+  if (typeof addressIn !== 'undefined') {
+    validateArgs.array({ addressIn })
+    validateList(addressIn as string[])
+  }
+
+  const vault = vaultAddress.toLowerCase()
+
+  const where = search
+    ? { vault, address_in: addressIn, address_contains: search.toLowerCase() }
+    : { vault, address_in: addressIn }
+
+  return {
+    where,
+    skip: skip || 0,
+    limit: limit || 100,
+    orderDirection: orderDirection || 'desc',
+  } as T
+}
+
+
+export default getListVariables

src/methods/utils/index.ts

@@ -1,6 +1,8 @@
 export type { BaseInput } from './types'
 export { default as getFiatRates } from './getFiatRates'
 export { default as getTransactions } from './getTransactions'
+export type { GetListVariablesInput } from './getListVariables'
+export { default as getListVariables } from './getListVariables'
 export { default as getFiatRatesByDay } from './getFiatRatesByDay'
 export { default as getStakewiseStats } from './getStakewiseStats'
 export { default as getPermitSignature } from './getPermitSignature'

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

@@ -1,71 +1,23 @@
-import { isAddress } from 'ethers'
 import type { BlocklistAccountsQueryVariables, BlocklistAccountsQueryPayload } from '../../../../graphql/subgraph/vault'
-import { apiUrls, validateArgs } from '../../../../utils'
+import { apiUrls } from '../../../../utils'
 import graphql from '../../../../graphql'
 import { ModifiedBlocklist } from './types'
 import modifyBlocklist from './modifyBlocklist'
+import { getListVariables, GetListVariablesInput } from '../../../utils'
 
 
-type GetBlocklistInput = {
-  vaultAddress: string
-  orderDirection?: BlocklistAccountsQueryVariables['orderDirection']
-  search?: string
-  limit?: number
-  skip?: number
-  addressIn?: BlocklistAccountsQueryVariables['where']['address_in']
+type GetBlocklistInput = GetListVariablesInput & {
   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, addressIn, options } = input
-
-  validateArgs.address({ vaultAddress })
-
-  if (typeof skip !== 'undefined') {
-    validateArgs.number({ skip })
-  }
-
-  if (typeof limit !== 'undefined') {
-    validateArgs.number({ limit })
-  }
-
-  if (typeof search !== 'undefined') {
-    validateArgs.string({ search })
-  }
-
-  if (typeof orderDirection !== 'undefined') {
-    if (![ 'asc', 'desc' ].includes(orderDirection)) {
-      throw new Error(`The "orderDirection" argument must be "asc" or "desc"`)
-    }
-  }
-
-  if (typeof addressIn !== 'undefined') {
-    validateArgs.array({ addressIn })
-    validateList(addressIn as string[])
-  }
-
-  const vault = vaultAddress.toLowerCase()
+  const { options, ...rest } = input
 
-  const where = search
-    ? { vault, address_in: addressIn, address_contains: search.toLowerCase() } as BlocklistAccountsQueryVariables['where']
-    : { vault, address_in: addressIn } as BlocklistAccountsQueryVariables['where']
+  const variables = getListVariables<BlocklistAccountsQueryVariables>(rest)
 
   return graphql.subgraph.vault.fetchBlocklistAccountsQuery<ModifiedBlocklist>({
     url: apiUrls.getSubgraphqlUrl(options),
-    variables: {
-      where,
-      skip: skip || 0,
-      limit: limit || 100,
-      orderDirection: orderDirection || 'desc',
-    },
+    variables,
     modifyResult: (data: BlocklistAccountsQueryPayload) => modifyBlocklist({ data }),
   })
 }

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

@@ -1,71 +1,23 @@
-import { isAddress } from 'ethers'
 import type { WhitelistAccountsQueryVariables, WhitelistAccountsQueryPayload } from '../../../../graphql/subgraph/vault'
-import { apiUrls, validateArgs } from '../../../../utils'
+import { apiUrls } from '../../../../utils'
 import graphql from '../../../../graphql'
 import { ModifiedWhitelist } from './types'
 import modifyWhitelist from './modifyWhitelist'
+import { getListVariables, GetListVariablesInput } from '../../../utils'
 
 
-type GetWhitelistInput = {
-  vaultAddress: string
-  orderDirection?: WhitelistAccountsQueryVariables['orderDirection']
-  search?: string
-  limit?: number
-  skip?: number
-  addressIn?: WhitelistAccountsQueryVariables['where']['address_in']
+type GetWhitelistInput = GetListVariablesInput & {
   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, addressIn, options } = input
-
-  validateArgs.address({ vaultAddress })
-
-  if (typeof skip !== 'undefined') {
-    validateArgs.number({ skip })
-  }
-
-  if (typeof limit !== 'undefined') {
-    validateArgs.number({ limit })
-  }
-
-  if (typeof search !== 'undefined') {
-    validateArgs.string({ search })
-  }
-
-  if (typeof orderDirection !== 'undefined') {
-    if (![ 'asc', 'desc' ].includes(orderDirection)) {
-      throw new Error(`The "orderDirection" argument must be "asc" or "desc"`)
-    }
-  }
-
-  if (typeof addressIn !== 'undefined') {
-    validateArgs.array({ addressIn })
-    validateList(addressIn as string[])
-  }
-
-  const vault = vaultAddress.toLowerCase()
+  const { options, ...rest } = input
 
-  const where = search
-    ? { vault, address_in: addressIn, address_contains: search.toLowerCase() } as WhitelistAccountsQueryVariables['where']
-    : { vault, address_in: addressIn } as WhitelistAccountsQueryVariables['where']
+  const variables = getListVariables<WhitelistAccountsQueryVariables>(rest)
 
   return graphql.subgraph.vault.fetchWhitelistAccountsQuery<ModifiedWhitelist>({
     url: apiUrls.getSubgraphqlUrl(options),
-    variables: {
-      where,
-      skip: skip || 0,
-      limit: limit || 100,
-      orderDirection: orderDirection || 'desc',
-    },
+    variables,
     modifyResult: (data: WhitelistAccountsQueryPayload) => modifyWhitelist({ data }),
   })
 }

src/modules/gql-module/abortCallback.ts

@@ -14,8 +14,6 @@ class AbortCallback {
 
   then(onSuccess: (data: any) => any, onError?: (error: any) => any) {
     if (this.isAborted) {
-      const dummyPromise = new Promise(() => {})
-
       return new AbortCallback(dummyPromise, this.onAbort)
     }