深入浅出,以太坊ABI编码日志的解码全指南

>

在深入解码之前,我们必须先理解两个基本概念：

1. ABI (Application Binary Interface)：可以理解为智能合约与外部世界沟通的“语言规范”，它定义了函数如何接收参数、如何返回结果，以及事件如何组织和数据，ABI编码是一种紧凑、二进制的编码方式，旨在节省链上空间和提高效率。

2. 日志：当智能合约中定义的event被触发时，会产生一条或多条日志记录，这些日志被永久记录在区块链的特定数据结构中，每条日志包含：

   • 地址：触发日志的合约地址。
   • 主题：用于索引和过滤事件，通常包含事件签名的哈希。
   • 数据：经过ABI编码的事件参数（不包括被索引的参数）。

我们的目标就是将日志中的“主题”和“数据”部分，根据合约的ABI定义，还原成最初的事件参数。

解码的完整流程

解码ABI日志通常遵循以下四个步骤,这个过程既可以用手动计算来理解，也可以借助专业的库来轻松实现。

步骤1：获取ABI

解码的第一步,也是最重要的一步，是获取目标智能合约的ABI定义，这个ABI通常是一个JSON数组，详细描述了合约中的所有函数和事件的结构，你可以从以下来源获取：

• 合约源代码：在Solidity源代码中，使用pragma solidity ^0.8.0;等编译指令后，编译器（如solc）会生成包含ABI的输出。
• 区块浏览器：如Etherscan、BscScan等，在合约详情页通常提供“Contract” -> “Contract ABI”部分，可以直接复制。
• 开发环境：使用Hardhat、Truffle等框架时，编译合约后会在artifacts目录下生成包含ABI的JSON文件。

步骤2：获取原始日志数据

你需要从以太坊节点或区块浏览器中获取待解码的原始日志,一条典型的日志数据结构如下（以以太坊JSON-RPC为例）：

{
  "address": "0x1234567890123456789012345678901234567890",
  "topics": [
    "0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925",
    "0x000000000000000000000000f39fd6e51aad88f6f4ce6ab8827279cfffb92266",
    "0x00000000000000000000000070997970c51812dc3a010c7d01b50e0d17dc79c8"
  ],
  "data": "0x000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2000000000000000000000000000000000000000000000000de0b6b3a7640000",
  "blockNumber": "0x5daf6b",
  "transactionHash": "0x1e49c988de538d6b85295a7d1c5f903a265dd22f7bc46d4c3fb6f9989268a02c",
  ...
}

• topics[0]：事件的签名哈希（Keccak-256哈希）。
• topics[1...]：被索引的事件参数，Solidity中，indexed关键字修饰的参数会被存放在这里。
• data：未被索引的事件参数的ABI编码串联。

步骤3：识别事件签名并匹配ABI

1. 计算事件签名：将事件名称和其参数类型列表用括号括起来，然后计算其Keccak-256哈希值，取前4个字节（32位）。

   • 事件Transfer(address indexed from, address indexed to, uint256 value)。
   • 签名字符串为：Transfer(address,address,uint256)。
   • 其哈希值为：0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925。
   • 这个哈希值的前4个字节是 0x8c5be1e5。

2. 匹配ABI：将topics[0]与你在ABI中找到的所有事件的签名哈希进行比对，匹配成功后，你就找到了该日志对应的ABI事件定义，这个定义将告诉你哪些参数被索引了，哪些没有，以及它们的类型和顺序。

步骤4：解码主题和数据

这是解码的核心操作,通常需要借助专门的库来完成，因为手动处理二进制数据非常繁琐。

• 解码 data：

  • data字段包含了所有未被索引的参数，它们是ABI编码后直接拼接在一起的。
  • 根据步骤3中匹配到的事件ABI,按照参数的顺序和类型（如uint256, address, bytes等）对data进行分段解码。
  • data为0x...c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2...de0b6b3a7640000...，根据ABI知道前两个参数是address和uint256，你会分别解码出地址0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2和数值1000000000000000000（即1 ETH）。

• 解码 topics：

  • topics[1...]中存放的是被indexed修饰的参数。
  • 注意：被索引的参数在存储到topics时，其本身不是直接进行ABI编码，而是先进行哈希处理（Keccak-256），这意味着你不能直接从topics中还原出原始值。
  • 这些哈希值的主要目的是用于事件过滤，如果你想从日志中获取被索引参数的原始值，你需要：
    1. 从日志的topics中取出哈希值。
    2. 从ABI中获取该参数的原始类型（如address, uint256等）。
    3. 将你已知的候选值（通过遍历所有地址或某个范围内的数值）进行ABI编码，然后计算其Keccak-256哈希。
    4. 比较计算出的哈希与日志中的哈希是否一致,一致则说明候选值正确。

实战：使用代码解码（以JavaScript和Ethers.js为例）

手动解码非常复杂,在实际开发中，我们几乎总是使用成熟的库，Ethers.js是其中最流行的选择之一。

假设我们有以下ABI和日志：

ABI (简化):

[
  {
    "anonymous": false,
    "inputs": [
      { "indexed": true, "name": "from", "type": "address" },
      { "indexed": true, "name": "to", "type": "address" },
      { "indexed": false, "name": "value", "type": "uint256" }
    ],
    "name": "Transfer",
    "type": "event"
  }
]

原始日志数据:

const log = {
  topics: [
    '0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925',
    '0x000000000000000000000000f39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    '0x00000000000000000000000070997970c51812dc3a010c7d01b50e0d17dc79c8'
  ],
  data: '0x000000000000000000