|
| 1 | +import { GasFeeToken } from '@metamask/transaction-controller'; |
| 2 | +import { Hex } from '@metamask/utils'; |
| 3 | + |
| 4 | +import { useIsGaslessSupported } from './useIsGaslessSupported'; |
| 5 | +import { useHasInsufficientBalance } from '../useHasInsufficientBalance'; |
| 6 | +import { useIsGaslessLoading } from './useIsGaslessLoading'; |
| 7 | +import { renderHookWithProvider } from '../../../../../util/test/renderWithProvider'; |
| 8 | +import { useTransactionMetadataRequest } from '../transactions/useTransactionMetadataRequest'; |
| 9 | +import { selectUseTransactionSimulations } from '../../../../../selectors/preferencesController'; |
| 10 | + |
| 11 | +jest.mock('./useIsGaslessSupported'); |
| 12 | +jest.mock('../useHasInsufficientBalance'); |
| 13 | +jest.mock('../transactions/useTransactionMetadataRequest'); |
| 14 | +jest.mock('../../../../../selectors/preferencesController'); |
| 15 | + |
| 16 | +const mockedUseIsGaslessSupported = jest.mocked(useIsGaslessSupported); |
| 17 | +const mockedUseHasInsufficientBalance = jest.mocked(useHasInsufficientBalance); |
| 18 | +const mockedUseTransactionMetadataRequest = jest.mocked( |
| 19 | + useTransactionMetadataRequest, |
| 20 | +); |
| 21 | +const mockSelectUseTransactionSimulations = jest.mocked( |
| 22 | + selectUseTransactionSimulations, |
| 23 | +); |
| 24 | + |
| 25 | +async function runHook({ |
| 26 | + simulationEnabled, |
| 27 | + gaslessSupported, |
| 28 | + insufficientBalance, |
| 29 | + pending = false, |
| 30 | + isSmartTransaction = true, |
| 31 | + gasFeeTokens, |
| 32 | + excludeNativeTokenForFee, |
| 33 | + selectedGasFeeToken, |
| 34 | +}: { |
| 35 | + simulationEnabled: boolean; |
| 36 | + gaslessSupported: boolean; |
| 37 | + insufficientBalance: boolean; |
| 38 | + pending?: boolean; |
| 39 | + isSmartTransaction?: boolean; |
| 40 | + gasFeeTokens?: GasFeeToken[]; |
| 41 | + excludeNativeTokenForFee?: boolean; |
| 42 | + selectedGasFeeToken?: Hex; |
| 43 | +}) { |
| 44 | + mockedUseIsGaslessSupported.mockReturnValue({ |
| 45 | + isSupported: gaslessSupported, |
| 46 | + isSmartTransaction, |
| 47 | + pending, |
| 48 | + }); |
| 49 | + mockedUseHasInsufficientBalance.mockReturnValue({ |
| 50 | + hasInsufficientBalance: insufficientBalance, |
| 51 | + nativeCurrency: 'USD', |
| 52 | + }); |
| 53 | + mockedUseTransactionMetadataRequest.mockReturnValue({ |
| 54 | + gasFeeTokens, |
| 55 | + excludeNativeTokenForFee, |
| 56 | + selectedGasFeeToken, |
| 57 | + } as unknown as ReturnType<typeof useTransactionMetadataRequest>); |
| 58 | + mockSelectUseTransactionSimulations.mockReturnValue(simulationEnabled); |
| 59 | + const { result } = renderHookWithProvider(useIsGaslessLoading); |
| 60 | + return result.current; |
| 61 | +} |
| 62 | + |
| 63 | +describe('useIsGaslessLoading', () => { |
| 64 | + beforeEach(() => { |
| 65 | + jest.clearAllMocks(); |
| 66 | + }); |
| 67 | + |
| 68 | + it('returns true if pending', async () => { |
| 69 | + const result = await runHook({ |
| 70 | + simulationEnabled: true, |
| 71 | + gaslessSupported: true, |
| 72 | + insufficientBalance: true, |
| 73 | + pending: true, |
| 74 | + }); |
| 75 | + |
| 76 | + expect(result.isGaslessLoading).toBe(true); |
| 77 | + }); |
| 78 | + |
| 79 | + it('returns false if simulation is disabled', async () => { |
| 80 | + const result = await runHook({ |
| 81 | + simulationEnabled: false, |
| 82 | + gaslessSupported: true, |
| 83 | + insufficientBalance: true, |
| 84 | + }); |
| 85 | + |
| 86 | + expect(result.isGaslessLoading).toBe(false); |
| 87 | + }); |
| 88 | + |
| 89 | + it('returns false if gasless is not supported', async () => { |
| 90 | + const result = await runHook({ |
| 91 | + simulationEnabled: true, |
| 92 | + gaslessSupported: false, |
| 93 | + insufficientBalance: true, |
| 94 | + }); |
| 95 | + |
| 96 | + expect(result.isGaslessLoading).toBe(false); |
| 97 | + }); |
| 98 | + |
| 99 | + it('returns false if there is no insufficient balance', async () => { |
| 100 | + const result = await runHook({ |
| 101 | + simulationEnabled: true, |
| 102 | + gaslessSupported: true, |
| 103 | + insufficientBalance: false, |
| 104 | + }); |
| 105 | + |
| 106 | + expect(result.isGaslessLoading).toBe(false); |
| 107 | + }); |
| 108 | + |
| 109 | + it('returns true if gas fee tokens are undefined (still loading)', async () => { |
| 110 | + const result = await runHook({ |
| 111 | + simulationEnabled: true, |
| 112 | + gaslessSupported: true, |
| 113 | + insufficientBalance: true, |
| 114 | + gasFeeTokens: undefined, // this triggers loading |
| 115 | + }); |
| 116 | + |
| 117 | + expect(result.isGaslessLoading).toBe(true); |
| 118 | + }); |
| 119 | + |
| 120 | + it('returns false if gas fee tokens are present', async () => { |
| 121 | + const result = await runHook({ |
| 122 | + simulationEnabled: true, |
| 123 | + gaslessSupported: true, |
| 124 | + insufficientBalance: true, |
| 125 | + gasFeeTokens: [{ tokenAddress: '0x123' }] as unknown as GasFeeToken[], |
| 126 | + }); |
| 127 | + |
| 128 | + expect(result.isGaslessLoading).toBe(false); |
| 129 | + }); |
| 130 | + |
| 131 | + it('returns false if gas fee tokens is an empty array', async () => { |
| 132 | + const result = await runHook({ |
| 133 | + simulationEnabled: true, |
| 134 | + gaslessSupported: true, |
| 135 | + insufficientBalance: true, |
| 136 | + gasFeeTokens: [], |
| 137 | + }); |
| 138 | + |
| 139 | + expect(result.isGaslessLoading).toBe(false); |
| 140 | + }); |
| 141 | + |
| 142 | + it('returns false if gas fee tokens are present and dont match selectedGasFeeToken (non-reg)', async () => { |
| 143 | + const result = await runHook({ |
| 144 | + simulationEnabled: true, |
| 145 | + gaslessSupported: true, |
| 146 | + insufficientBalance: true, |
| 147 | + gasFeeTokens: [{ tokenAddress: '0x123' }] as unknown as GasFeeToken[], |
| 148 | + selectedGasFeeToken: '0x456', |
| 149 | + }); |
| 150 | + |
| 151 | + expect(result.isGaslessLoading).toBe(false); |
| 152 | + }); |
| 153 | + |
| 154 | + it('returns true if gas fee tokens are present and dont match selectedGasFeeToken with excludeNativeTokenForFee being true (Tempo)', async () => { |
| 155 | + const result = await runHook({ |
| 156 | + simulationEnabled: true, |
| 157 | + gaslessSupported: true, |
| 158 | + insufficientBalance: true, |
| 159 | + gasFeeTokens: [{ tokenAddress: '0x123' }] as unknown as GasFeeToken[], |
| 160 | + selectedGasFeeToken: '0x456', |
| 161 | + excludeNativeTokenForFee: true, |
| 162 | + }); |
| 163 | + |
| 164 | + expect(result.isGaslessLoading).toBe(true); |
| 165 | + }); |
| 166 | + |
| 167 | + it('returns false if gas fee tokens are present AND match selectedGasFeeToken with excludeNativeTokenForFee being true (Tempo)', async () => { |
| 168 | + const result = await runHook({ |
| 169 | + simulationEnabled: true, |
| 170 | + gaslessSupported: true, |
| 171 | + insufficientBalance: true, |
| 172 | + gasFeeTokens: [ |
| 173 | + { tokenAddress: '0x123' }, |
| 174 | + { tokenAddress: '0x789' }, |
| 175 | + ] as unknown as GasFeeToken[], |
| 176 | + // Matches the first one |
| 177 | + selectedGasFeeToken: '0x123', |
| 178 | + excludeNativeTokenForFee: true, |
| 179 | + }); |
| 180 | + |
| 181 | + expect(result.isGaslessLoading).toBe(false); |
| 182 | + }); |
| 183 | + |
| 184 | + it('returns false if gas fee tokens are present AND selectedGasFeeToken is undefined with excludeNativeTokenForFee being true (Tempo)', async () => { |
| 185 | + const result = await runHook({ |
| 186 | + simulationEnabled: true, |
| 187 | + gaslessSupported: true, |
| 188 | + insufficientBalance: true, |
| 189 | + gasFeeTokens: [{ tokenAddress: '0x123' }] as unknown as GasFeeToken[], |
| 190 | + selectedGasFeeToken: undefined, |
| 191 | + excludeNativeTokenForFee: true, |
| 192 | + }); |
| 193 | + |
| 194 | + expect(result.isGaslessLoading).toBe(false); |
| 195 | + }); |
| 196 | + |
| 197 | + it('returns false if gas fee tokens is empty array with excludeNativeTokenForFee being true (Tempo)', async () => { |
| 198 | + const result = await runHook({ |
| 199 | + simulationEnabled: true, |
| 200 | + gaslessSupported: true, |
| 201 | + insufficientBalance: true, |
| 202 | + gasFeeTokens: [] as unknown as GasFeeToken[], |
| 203 | + selectedGasFeeToken: '0x456', |
| 204 | + excludeNativeTokenForFee: true, |
| 205 | + }); |
| 206 | + |
| 207 | + expect(result.isGaslessLoading).toBe(false); |
| 208 | + }); |
| 209 | +}); |
0 commit comments