🗺 Epic: unit tests for hooks in v4

[ShravanSunder]

Current status

We have tests that use a wrapper with a ethers/hardhat provider and a mock connector. The connector uses sinon js for mocking. There are tests for about 9 contexts and EthersAppContext.

Overall Strategy

• We want tests for all hooks.
• We want to test the functions and helpers
• useEthersContext needs tests for context key
• We want to test hooks with update options.
  • I think choosing two hooks, useTokenBalance and useContractReader, and testing update options with that would be sufficient for tests that integrate hardhat and wrapper and the update options are being respected.
  • For other tests, we should mock useQuery or useEthersUpdater and make sure it is just getting the update options specified.
• We should test override per hook

Hook test strategy

• Tests for the functionality of the hook
• Test update options: mock useQuery and useEthersUpdater to make sure it is receiving the right values
  • 3 as BlockNumberInterval
  • polling
• If the hook has an override: We should have two test per-hook that has the override option:
  • (1) mock useEthersContext and check if it receives the key properly
  • (2) make sure the hook works with the override adaptor.
• If hooks are useTokenBalance or useContractReader we should have full functionality of updates in addition to mocking as mentioned in the overall strategy. Test update options with that would be sufficient for tests that integrate hardhat and wrapper and the update options are being respected.

Code standards

• follow current standards:
  • describe ('Give....')
  • test ('When xxxx; then xxx')
  • useTokenBalance is a great example!

Test issues

Add tests for Contexts

• Add tests for contractContextFactory.ts #117
• v4 Update tests for ethers context and override options #152

Add hook tests

• Fix the existing tests for the changes in eth-hooksv4 #116
• Add test for new useContractReader #122
• v4 tests: useTokenBalance #76
• v4 tests: useAreSignerEqual #136
• v4 tests: update useBalance tests as per epic strategy #137
• v4 tests: useContractExistsAtAddress #138
• v4 tests: update useContractLoader.tests.ts with tests for override #139
• v4 tests: useEthersAdaptorFromProviderOrSigners.ts #140
• v4 tests: useEthersUpdater #141
• v4 tests: update useEventListener tests as per epic strategy #142
• v4 tests: useGasPrice #145
• v4 tests: update useNonce as per epic strategy #143
• v4 tests: useSignerAddress #144
• v4 tests: useSignerChainId #146
• v4 tests: update useTimestamp as per epic strategy #147
• v4 tests: useDexEthPrice #148
• v4 tests: useDexTokenList #149
• v4 tests: useResolveEnsAddress #150
• v4 tests: useResolveEnsName #151

Function tests

• v4 tests: ethersHelper.ts - isValidEthersAdaptor #153
• v4 tests: hookHelpers.ts - ethersOverride, checkUpdateOptions, mergeDefaultUpdateOptions, processQueryOptions #154
• v4 tests: keyHelpers.ts #155
• v4 tests asyncHelpers.ts #156
• v4 tests contractConnectors.ts - extractHardhatContracts, extractExternalContracts #157