|
| 1 | +import type { V1TransactionByHashResponse } from '@metamask/core-backend'; |
| 2 | +import { |
| 3 | + TransactionStatus, |
| 4 | + TransactionType, |
| 5 | +} from '@metamask/transaction-controller'; |
| 6 | +import { |
| 7 | + APPROVE_FUNCTION_SIGNATURE, |
| 8 | + TRANSFER_FUNCTION_SIGNATURE, |
| 9 | +} from '../../../../util/transactions'; |
| 10 | +import { normalizeTransaction } from './adapters'; |
| 11 | + |
| 12 | +describe('normalizeTransaction', () => { |
| 13 | + const address = '0x0000000000000000000000000000000000000001'; |
| 14 | + const otherAddress = '0x0000000000000000000000000000000000000002'; |
| 15 | + const contractAddress = '0x00000000000000000000000000000000000000aa'; |
| 16 | + |
| 17 | + const buildTransaction = ( |
| 18 | + overrides: Partial<V1TransactionByHashResponse> = {}, |
| 19 | + ): V1TransactionByHashResponse => |
| 20 | + ({ |
| 21 | + hash: '0xhash', |
| 22 | + timestamp: '2024-01-01T00:00:00Z', |
| 23 | + chainId: 1, |
| 24 | + blockNumber: 100, |
| 25 | + blockHash: '0xblock', |
| 26 | + gas: 21000, |
| 27 | + gasUsed: 21000, |
| 28 | + gasPrice: '1000000000', |
| 29 | + effectiveGasPrice: '1000000000', |
| 30 | + nonce: 0, |
| 31 | + cumulativeGasUsed: 21000, |
| 32 | + value: '1000', |
| 33 | + to: otherAddress, |
| 34 | + from: address, |
| 35 | + methodId: '0x', |
| 36 | + isError: false, |
| 37 | + ...overrides, |
| 38 | + }) as unknown as V1TransactionByHashResponse; |
| 39 | + |
| 40 | + it('normalizes a simple outgoing send', () => { |
| 41 | + const meta = normalizeTransaction(address, buildTransaction()); |
| 42 | + |
| 43 | + expect(meta).toEqual( |
| 44 | + expect.objectContaining({ |
| 45 | + hash: '0xhash', |
| 46 | + id: '0xhash-1', |
| 47 | + chainId: '0x1', |
| 48 | + status: TransactionStatus.confirmed, |
| 49 | + type: TransactionType.simpleSend, |
| 50 | + isTransfer: false, |
| 51 | + networkClientId: '', |
| 52 | + toSmartContract: false, |
| 53 | + verifiedOnBlockchain: false, |
| 54 | + blockNumber: '100', |
| 55 | + time: Date.parse('2024-01-01T00:00:00Z'), |
| 56 | + error: undefined, |
| 57 | + transferInformation: undefined, |
| 58 | + }), |
| 59 | + ); |
| 60 | + expect(meta.txParams).toEqual( |
| 61 | + expect.objectContaining({ |
| 62 | + chainId: '0x1', |
| 63 | + from: address, |
| 64 | + to: otherAddress, |
| 65 | + value: '0x3e8', |
| 66 | + gas: '0x5208', |
| 67 | + gasPrice: '0x3b9aca00', |
| 68 | + gasUsed: '0x5208', |
| 69 | + nonce: '0x0', |
| 70 | + }), |
| 71 | + ); |
| 72 | + }); |
| 73 | + |
| 74 | + it('marks the transaction as failed when isError is true', () => { |
| 75 | + const meta = normalizeTransaction( |
| 76 | + address, |
| 77 | + buildTransaction({ isError: true }), |
| 78 | + ); |
| 79 | + |
| 80 | + expect(meta.status).toBe(TransactionStatus.failed); |
| 81 | + expect(meta.error).toBeInstanceOf(Error); |
| 82 | + expect(meta.error?.message).toBe('Transaction failed'); |
| 83 | + }); |
| 84 | + |
| 85 | + it('marks an outgoing transaction with no `to` and calldata as deployContract', () => { |
| 86 | + const meta = normalizeTransaction( |
| 87 | + address, |
| 88 | + buildTransaction({ |
| 89 | + to: undefined as unknown as string, |
| 90 | + methodId: '0xabcdef', |
| 91 | + }), |
| 92 | + ); |
| 93 | + |
| 94 | + expect(meta.type).toBe(TransactionType.deployContract); |
| 95 | + }); |
| 96 | + |
| 97 | + it('classifies an incoming transaction', () => { |
| 98 | + const meta = normalizeTransaction( |
| 99 | + address, |
| 100 | + buildTransaction({ from: otherAddress, to: address }), |
| 101 | + ); |
| 102 | + |
| 103 | + expect(meta.type).toBe(TransactionType.incoming); |
| 104 | + }); |
| 105 | + |
| 106 | + it('detects ERC20 transfer method', () => { |
| 107 | + const meta = normalizeTransaction( |
| 108 | + address, |
| 109 | + buildTransaction({ |
| 110 | + methodId: TRANSFER_FUNCTION_SIGNATURE, |
| 111 | + value: '0', |
| 112 | + }), |
| 113 | + ); |
| 114 | + |
| 115 | + expect(meta.type).toBe(TransactionType.tokenMethodTransfer); |
| 116 | + }); |
| 117 | + |
| 118 | + it('detects ERC20 approve method', () => { |
| 119 | + const meta = normalizeTransaction( |
| 120 | + address, |
| 121 | + buildTransaction({ |
| 122 | + methodId: APPROVE_FUNCTION_SIGNATURE, |
| 123 | + value: '0', |
| 124 | + }), |
| 125 | + ); |
| 126 | + |
| 127 | + expect(meta.type).toBe(TransactionType.tokenMethodApprove); |
| 128 | + }); |
| 129 | + |
| 130 | + it('classifies a contract interaction when calldata has value', () => { |
| 131 | + const meta = normalizeTransaction( |
| 132 | + address, |
| 133 | + buildTransaction({ |
| 134 | + methodId: '0xdeadbeef', |
| 135 | + value: '1000', |
| 136 | + }), |
| 137 | + ); |
| 138 | + |
| 139 | + expect(meta.type).toBe(TransactionType.contractInteraction); |
| 140 | + }); |
| 141 | + |
| 142 | + it('extracts transfer information for an incoming token transfer and rewrites txParams', () => { |
| 143 | + const meta = normalizeTransaction( |
| 144 | + address, |
| 145 | + buildTransaction({ |
| 146 | + from: otherAddress, |
| 147 | + to: contractAddress, |
| 148 | + value: '0', |
| 149 | + valueTransfers: [ |
| 150 | + { |
| 151 | + from: otherAddress, |
| 152 | + to: address, |
| 153 | + amount: '5000', |
| 154 | + contractAddress, |
| 155 | + decimal: 6, |
| 156 | + symbol: 'USDC', |
| 157 | + }, |
| 158 | + ], |
| 159 | + } as Partial<V1TransactionByHashResponse>), |
| 160 | + ); |
| 161 | + |
| 162 | + expect(meta.isTransfer).toBe(true); |
| 163 | + expect(meta.transferInformation).toEqual({ |
| 164 | + amount: '5000', |
| 165 | + contractAddress, |
| 166 | + decimals: 6, |
| 167 | + symbol: 'USDC', |
| 168 | + }); |
| 169 | + expect(meta.txParams.to).toBe(address); |
| 170 | + expect(meta.txParams.value).toBe('0x1388'); |
| 171 | + }); |
| 172 | +}); |
0 commit comments