Add recursive decoding for all calldata in params

Author: anastasiarods

packages/transaction-decoder/src/decoding/calldata-decode.ts

@@ -3,10 +3,12 @@ import { isAddress, Hex, getAddress, encodeFunctionData, Address } from 'viem'
 import { getProxyStorageSlot } from './proxies.js'
 import { AbiParams, AbiStore, ContractAbiResult, getAndCacheAbi, MissingABIError } from '../abi-loader.js'
 import * as AbiDecoder from './abi-decode.js'
-import { ProxyType, TreeNode } from '../types.js'
+import { TreeNode } from '../types.js'
 import { PublicClient, RPCFetchError, UnknownNetwork } from '../public-client.js'
-import { sameAddress } from '../helpers/address.js'
-import { MULTICALL3_ADDRESS, SAFE_MULTISEND_ABI, SAFE_MULTISEND_SIGNATURE } from './constants.js'
+import { SAFE_MULTISEND_ABI, SAFE_MULTISEND_SIGNATURE } from './constants.js'
+
+const callDataKeys = ['callData', 'data', '_data']
+const addressKeys = ['to', 'target', '_target']
 
 const decodeBytesRecursively = (
   node: TreeNode,
@@ -18,8 +20,6 @@ const decodeBytesRecursively = (
   AbiStore<AbiParams, ContractAbiResult> | PublicClient
 > =>
   Effect.gen(function* () {
-    const callDataKeys = ['callData', 'data']
-    const addressKeys = ['to', 'target']
     const isCallDataNode =
       callDataKeys.includes(node.name) && node.type === 'bytes' && node.value && node.value !== '0x'
 
@@ -147,20 +147,19 @@ export const decodeMethod = ({
 }) =>
   Effect.gen(function* () {
     const signature = data.slice(0, 10)
-    let proxyType: ProxyType | undefined
+    let implementationAddress: Address | undefined
 
     if (isAddress(contractAddress)) {
       //if contract is a proxy, get the implementation address
       const implementation = yield* getProxyStorageSlot({ address: getAddress(contractAddress), chainID })
 
       if (implementation) {
-        contractAddress = implementation.address
-        proxyType = implementation.type
+        implementationAddress = implementation.address
       }
     }
 
     const abi = yield* getAndCacheAbi({
-      address: contractAddress,
+      address: implementationAddress ?? contractAddress,
       signature,
       chainID,
     })
@@ -171,38 +170,6 @@ export const decodeMethod = ({
       return yield* new AbiDecoder.DecodeError(`Failed to decode method: ${data}`)
     }
 
-    //MULTICALL3: decode the params for the multicall3 contract
-    if (sameAddress(MULTICALL3_ADDRESS, contractAddress) && decoded.params) {
-      const targetAddress = decoded.params.find((p) => p.name === 'target')?.value as Address | undefined
-      const decodedParams = yield* Effect.all(
-        decoded.params.map((p) => decodeBytesRecursively(p, chainID, targetAddress)),
-        {
-          concurrency: 'unbounded',
-        },
-      )
-
-      return {
-        ...decoded,
-        params: decodedParams,
-      }
-    }
-
-    //SAFE CONTRACT: decode the params for the safe smart account contract
-    if (proxyType === 'safe' && decoded.params != null) {
-      const toAddress = decoded.params.find((p) => p.name === 'to')?.value as Address | undefined
-      const decodedParams = yield* Effect.all(
-        decoded.params.map((p) => decodeBytesRecursively(p, chainID, toAddress)),
-        {
-          concurrency: 'unbounded',
-        },
-      )
-
-      return {
-        ...decoded,
-        params: decodedParams,
-      }
-    }
-
     //MULTISEND: decode the params for the multisend contract which is also related to the safe smart account
     if (
       decoded.signature === SAFE_MULTISEND_SIGNATURE &&
@@ -216,6 +183,29 @@ export const decodeMethod = ({
       }
     }
 
+    //Attempt to decode the params recursively if they contain data bytes or tuple params
+    if (decoded.params != null) {
+      const hasCalldataParam = decoded.params.find((p) => callDataKeys.includes(p.name) && p.type === 'bytes')
+      const hasTuppleParams = decoded.params.some((p) => p.type === 'tuple')
+
+      if (hasCalldataParam || hasTuppleParams) {
+        const targetAddressParam = decoded.params.find((p) => addressKeys.includes(p.name))
+        const targetAddress = targetAddressParam?.value as Address | undefined
+
+        const decodedParams = yield* Effect.all(
+          decoded.params.map((p) => decodeBytesRecursively(p, chainID, targetAddress)),
+          {
+            concurrency: 'unbounded',
+          },
+        )
+
+        return {
+          ...decoded,
+          params: decodedParams,
+        }
+      }
+    }
+
     return decoded
   }).pipe(
     Effect.withSpan('CalldataDecode.decodeMethod', {

packages/transaction-decoder/test/constants.ts

@@ -150,6 +150,10 @@ const OTHER = [
     hash: '0x026fdb8b0017ef0e468e6d1627357adb9a8c4b6205ac0049bad80c253c76750c', // Disperse app
     chainID: 1,
   },
+  {
+    hash: '0x36f5c6d053ef3de0a412f871ead797d199d80dbc5ea4ba6ab1b1a211730aea13', //Uniswap Multicall
+    chainID: 1,
+  },
 ] as const
 
 export const TEST_TRANSACTIONS: TXS = [

packages/transaction-decoder/test/mocks/abi-loader-mock.ts

@@ -1,18 +1,22 @@
+/* eslint-disable turbo/no-undeclared-env-vars */
 import { Effect, Layer, Match } from 'effect'
 import fs from 'node:fs'
 import { AbiStore } from '../../src/abi-loader.js'
-// import { FourByteStrategyResolver } from '../../src/effect.js'
-// import { EtherscanStrategyResolver } from '../../src/abi-strategy/index.js'
+import { FourByteStrategyResolver } from '../../src/effect.js'
+import { EtherscanStrategyResolver } from '../../src/abi-strategy/index.js'
 
 export const MockedAbiStoreLive = Layer.succeed(
   AbiStore,
   AbiStore.of({
     strategies: {
-      default: [
-        // Run only when adding a new test case
-        // EtherscanStrategyResolver({ apikey: '' }),
-        // FourByteStrategyResolver(),
-      ],
+      default:
+        process.env.ETHERSCAN_API_KEY != null
+          ? [
+              // Run only when adding a new test case
+              EtherscanStrategyResolver({ apikey: process.env.ETHERSCAN_API_KEY! }),
+              FourByteStrategyResolver(),
+            ]
+          : [],
     },
     set: (key, response) =>
       Effect.gen(function* () {

packages/transaction-decoder/test/mocks/abi/0x00000000000c2e074ec69a0dfb2997ba6c7d2e1e.json

@@ -0,0 +1 @@
+[{"inputs":[{"internalType":"contract ENS","name":"_old","type":"address"}],"payable":false,"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"address","name":"operator","type":"address"},{"indexed":false,"internalType":"bool","name":"approved","type":"bool"}],"name":"ApprovalForAll","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"node","type":"bytes32"},{"indexed":true,"internalType":"bytes32","name":"label","type":"bytes32"},{"indexed":false,"internalType":"address","name":"owner","type":"address"}],"name":"NewOwner","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"node","type":"bytes32"},{"indexed":false,"internalType":"address","name":"resolver","type":"address"}],"name":"NewResolver","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"node","type":"bytes32"},{"indexed":false,"internalType":"uint64","name":"ttl","type":"uint64"}],"name":"NewTTL","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"node","type":"bytes32"},{"indexed":false,"internalType":"address","name":"owner","type":"address"}],"name":"Transfer","type":"event"},{"constant":true,"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"address","name":"operator","type":"address"}],"name":"isApprovedForAll","outputs":[{"internalType":"bool","name":"","type":"bool"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":true,"inputs":[],"name":"old","outputs":[{"internalType":"contract ENS","name":"","type":"address"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":true,"inputs":[{"internalType":"bytes32","name":"node","type":"bytes32"}],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":true,"inputs":[{"internalType":"bytes32","name":"node","type":"bytes32"}],"name":"recordExists","outputs":[{"internalType":"bool","name":"","type":"bool"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":true,"inputs":[{"internalType":"bytes32","name":"node","type":"bytes32"}],"name":"resolver","outputs":[{"internalType":"address","name":"","type":"address"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":false,"inputs":[{"internalType":"address","name":"operator","type":"address"},{"internalType":"bool","name":"approved","type":"bool"}],"name":"setApprovalForAll","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"bytes32","name":"node","type":"bytes32"},{"internalType":"address","name":"owner","type":"address"}],"name":"setOwner","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"bytes32","name":"node","type":"bytes32"},{"internalType":"address","name":"owner","type":"address"},{"internalType":"address","name":"resolver","type":"address"},{"internalType":"uint64","name":"ttl","type":"uint64"}],"name":"setRecord","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"bytes32","name":"node","type":"bytes32"},{"internalType":"address","name":"resolver","type":"address"}],"name":"setResolver","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"bytes32","name":"node","type":"bytes32"},{"internalType":"bytes32","name":"label","type":"bytes32"},{"internalType":"address","name":"owner","type":"address"}],"name":"setSubnodeOwner","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"bytes32","name":"node","type":"bytes32"},{"internalType":"bytes32","name":"label","type":"bytes32"},{"internalType":"address","name":"owner","type":"address"},{"internalType":"address","name":"resolver","type":"address"},{"internalType":"uint64","name":"ttl","type":"uint64"}],"name":"setSubnodeRecord","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"bytes32","name":"node","type":"bytes32"},{"internalType":"uint64","name":"ttl","type":"uint64"}],"name":"setTTL","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":true,"inputs":[{"internalType":"bytes32","name":"node","type":"bytes32"}],"name":"ttl","outputs":[{"internalType":"uint64","name":"","type":"uint64"}],"payable":false,"stateMutability":"view","type":"function"}]

packages/transaction-decoder/test/mocks/abi/0x15dacbea.json

@@ -0,0 +1 @@
+{"name":"transferFrom","type":"function","stateMutability":"nonpayable","inputs":[{"type":"address"},{"type":"address"},{"type":"address"},{"type":"uint256"}],"outputs":[]}

packages/transaction-decoder/test/mocks/abi/0x1f98415757620b543a52e61c46b32eb19261f984.json

@@ -0,0 +1 @@
+[{"inputs":[],"name":"getCurrentBlockTimestamp","outputs":[{"internalType":"uint256","name":"timestamp","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"addr","type":"address"}],"name":"getEthBalance","outputs":[{"internalType":"uint256","name":"balance","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"components":[{"internalType":"address","name":"target","type":"address"},{"internalType":"uint256","name":"gasLimit","type":"uint256"},{"internalType":"bytes","name":"callData","type":"bytes"}],"internalType":"struct UniswapInterfaceMulticall.Call[]","name":"calls","type":"tuple[]"}],"name":"multicall","outputs":[{"internalType":"uint256","name":"blockNumber","type":"uint256"},{"components":[{"internalType":"bool","name":"success","type":"bool"},{"internalType":"uint256","name":"gasUsed","type":"uint256"},{"internalType":"bytes","name":"returnData","type":"bytes"}],"internalType":"struct UniswapInterfaceMulticall.Result[]","name":"returnData","type":"tuple[]"}],"stateMutability":"nonpayable","type":"function"}]

packages/transaction-decoder/test/mocks/abi/0x3a871cdd.json

@@ -0,0 +1 @@
+{"name":"validateUserOp","type":"function","stateMutability":"nonpayable","inputs":[{"type":"tuple","components":[{"type":"address"},{"type":"uint256"},{"type":"bytes"},{"type":"bytes"},{"type":"uint256"},{"type":"uint256"},{"type":"uint256"},{"type":"uint256"},{"type":"uint256"},{"type":"bytes"},{"type":"bytes"}]},{"type":"bytes32"},{"type":"uint256"}],"outputs":[]}

packages/transaction-decoder/test/mocks/abi/0x42f6e389.json

@@ -0,0 +1 @@
+{"name":"isModule","type":"function","stateMutability":"nonpayable","inputs":[{"type":"address"}],"outputs":[]}

packages/transaction-decoder/test/mocks/abi/0x8a8c523c.json

@@ -0,0 +1 @@
+{"name":"enableTrading","type":"function","stateMutability":"nonpayable","inputs":[],"outputs":[]}

packages/transaction-decoder/test/mocks/abi/0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef.json

@@ -0,0 +1 @@
+{"name":"Transfer","type":"event","inputs":[{"type":"address"},{"type":"address"},{"type":"uint256"}]}