➕ Add queryParams to useToken hook (#1037)

.changeset/cold-garlics-relate.md

@@ -0,0 +1,5 @@
+---
+'@usedapp/core': patch
+---
+
+Add queryParams to useToken hook

packages/core/src/hooks/useToken.test.tsx

@@ -1,27 +1,51 @@
-import { Contract } from 'ethers'
+import { BigNumber, Contract } from 'ethers'
 import { useToken } from '..'
 import { expect } from 'chai'
 import type { Config } from '../constants'
 import {
   renderDAppHook,
   deployMockToken,
   MOCK_TOKEN_INITIAL_BALANCE,
+  SECOND_MOCK_TOKEN_INITIAL_BALANCE,
   TestingNetwork,
   setupTestingConfig,
 } from '../testing'
 
 describe('useToken', async () => {
   let token: Contract
+  let secondToken: Contract
   let config: Config
   let network1: TestingNetwork
+  let network2: TestingNetwork
 
   beforeEach(async () => {
-    ;({ config, network1 } = await setupTestingConfig())
+    ;({ config, network1, network2 } = await setupTestingConfig())
     token = await deployMockToken(network1.deployer)
+    secondToken = await deployMockToken(network2.deployer, SECOND_MOCK_TOKEN_INITIAL_BALANCE)
   })
 
   it('returns correct token constants', async () => {
-    const { result, waitForCurrent } = await renderDAppHook(() => useToken(token.address), {
+    await testMultiChainUseToken(token)
+  })
+
+  it('setting chainId on query params returns correct token constants from non-default chain', async () => {
+    await testMultiChainUseToken(secondToken, SECOND_MOCK_TOKEN_INITIAL_BALANCE, network2.chainId)
+  })
+
+  it('should not throw error when token address is Falsy', async () => {
+    const { result } = await renderDAppHook(() => useToken(null), {
+      config,
+    })
+    expect(result.error).to.be.undefined
+    expect(result.current).to.be.undefined
+  })
+
+  const testMultiChainUseToken = async (
+    contract: Contract,
+    totalSupply: BigNumber = MOCK_TOKEN_INITIAL_BALANCE,
+    chainId?: number
+  ) => {
+    const { result, waitForCurrent } = await renderDAppHook(() => useToken(contract.address, { chainId }), {
       config,
     })
     await waitForCurrent((val) => val !== undefined)
@@ -30,16 +54,8 @@ describe('useToken', async () => {
       name: 'MOCKToken',
       symbol: 'MOCK',
       decimals: 18,
-      totalSupply: MOCK_TOKEN_INITIAL_BALANCE,
+      totalSupply,
     }
     expect(JSON.parse(JSON.stringify(result.current))).to.deep.equal(JSON.parse(JSON.stringify(res)))
-  })
-
-  it('should not throw error when token address is Falsy', async () => {
-    const { result } = await renderDAppHook(() => useToken(null), {
-      config,
-    })
-    expect(result.error).to.be.undefined
-    expect(result.current).to.be.undefined
-  })
+  }
 })

packages/core/src/hooks/useToken.ts

@@ -1,4 +1,4 @@
-import { ERC20Interface } from '../constants'
+import { ERC20Interface, QueryParams } from '../constants'
 import { Falsy } from '../model/types'
 import { TokenInfo } from '../model/TokenInfo'
 import { Call, useCalls } from './useCall'
@@ -7,6 +7,7 @@ import { Contract } from 'ethers'
 /**
  * Returns name, symbol, decimals and token supply of a given token.
  * @param tokenAddress address of a token contract.
+ * @param queryParams see {@link QueryParams}.
  * @returns a token info object (see {@link TokenInfo}) or `undefined` if all four methods don't exist on a token.
  * @public
  * @example
@@ -22,7 +23,7 @@ import { Contract } from 'ethers'
  *   </>
  * ) : null
  */
-export function useToken(tokenAddress: string | Falsy): TokenInfo | undefined {
+export function useToken(tokenAddress: string | Falsy, queryParams: QueryParams = {}): TokenInfo | undefined {
   const partialCall = tokenAddress && {
     contract: new Contract(tokenAddress, ERC20Interface),
     address: tokenAddress,
@@ -31,7 +32,7 @@ export function useToken(tokenAddress: string | Falsy): TokenInfo | undefined {
   const args = ['name', 'symbol', 'decimals', 'totalSupply'].map(
     (method): Call | Falsy => partialCall && { ...partialCall, method }
   )
-  const [name, symbol, decimals, totalSupply] = useCalls(args)
+  const [name, symbol, decimals, totalSupply] = useCalls(args, queryParams)
 
   if (!name && !symbol && !decimals && !totalSupply) {
     return undefined