Ethers 102

I've been revisiting ethers.js recently to refresh my understanding of the details and to write a simple tutorial called "WTF Ethers" for beginners.

Twitter: @0xAA_Science

Community: Website wtf.academy | WTF Solidity | discord | WeChat Group Application

All the code and tutorials are open-sourced on GitHub: github.com/WTFAcademy/WTF-Ethers

In this lesson, we will use a pending transaction as an example to demonstrate how to decode transaction details.

Pending Transaction

A pending transaction is a transaction sent by a user but has not been included in a block by a miner yet. It appears in the mempool (transaction memory pool). For more information about the mempool, you can refer to the # WTF Ethers 19: Listening to the Mempool.

Below is an example of a pending transaction that transafers an ERC20 token. You can view the transaction details on etherscan:

The box at the bottom indicates the input data of this transaction, which seems like random hexadecimal data. In fact, it encodes the calldata of the transaction, including the called function and the input parameters. By clicking the Decode Input Data button on etherscan, we can decode this data:

After decoding, we can see the function called by this transaction and its input parameters.

Interface Class

ethers.js provides the Interface class for decoding transaction data. Declaring a Interface is similar as declaring a abi, for example:

const iface = ethers.Interface([
    "function balanceOf(address) public view returns(uint)",
    "function transfer(address, uint) public returns (bool)",
    "function approve(address, uint256) public returns (bool)"
]);

Decoding Transaction Data

Now let's write a script to decode the data of a pending transaction.

1. Create a provider and a wallet. It is recommended to use a wss connection instead of http when listening to transactions.

   // Prepare the alchemy API, you can refer to https://github.com/AmazingAng/WTF-Solidity/blob/main/Topics/Tools/TOOL04_Alchemy/readme.md 
   const ALCHEMY_MAINNET_WSSURL = 'wss://eth-mainnet.g.alchemy.com/v2/oKmOQKbneVkxgHZfibs-iFhIlIAl6HDN';
   const provider = new ethers.WebSocketProvider(ALCHEMY_MAINNET_WSSURL);
   let network = provider.getNetwork()
   network.then(res => console.log(`[${(new Date).toLocaleTimeString()}] Connected to chain ID ${res.chainId}`));

   复制代码

2. Create an Interface object for decoding transaction details.

   const iface = new ethers.Interface([
   "function transfer(address, uint) public returns (bool)",
   ])

   复制代码

3. Get the function selector.

   const functionSignature = 'transfer(address,uint)'
   const selector = iface.getSighash(functionSignature)
   console.log(`Function selector is ${selector}`)

   复制代码

4. Listen for pending ERC20 transfer transactions, retrieve the transaction details, and decode them:

   provider.on('pending', async (txHash) => {
   if (txHash) {
       const tx = await provider.getTransaction(txHash)
       j++
       if (tx !== null && tx.data.indexOf(selector) !== -1) {
           console.log(`[${(new Date).toLocaleTimeString()}] Detected the ${j + 1}th pending transaction: ${txHash}`)
           console.log(`Printing decoded transaction details: ${JSON.stringify(iface.parseTransaction(tx), null, 2)}`)
           console.log(`Transfer destination address: ${iface.parseTransaction(tx).args[0]}`)
           console.log(`Transfer amount: ${ethers.utils.formatEther(iface.parseTransaction(tx).args[1])}`)
           provider.removeListener('pending', this)
       }
   }})

   复制代码
   

5. Decoding transaction parameters:

   

Summary

In this lesson, we use Interface object to decode pending transactions on Uniswap.