以太坊交易监听PHP开发包

1、开发包概述

EthMon开发包用于监听以太坊ERC20代币合约的转账交易，特点如下：

• 监听以太坊合约日志中指定地址发生的代币转入/转出交易
• 自定义代币交易发生时的业务逻辑
• 即支持标准的Web3接口（例如Infura），也支持Etherscan非标接口

EthMon运行于PHP 7.1+环境下，主要类以及其关系如下图所示：

EthMon的主要代码文件清单如下：

2、使用说明

在开始之前，请使用自己的API KEY替换以下文件的内容

• demo/etherscan-key
• demo/infura-key

EthMon是开发包的入口类，调用其scanBlocks()方法可以扫描指定区间 的以太坊区块，提取并解析其中的合约日志，当匹配监听的地址后，调用 事件监听器（IEventListener接口实现对象）的handleEvent()方法并 传入解析后的事件对象。

2.1 IEventListener

调用者的程序需要在IeventListener接口的实现类中封装自己的业务逻辑， 例如写入数据库等等。下面的代码实现了一个基本的事件监听器 —— 只是简单地 在屏幕显示输出事件对象的内容：

class EzListener implements IEventListener{
  function handleEvent($event){
    var_dump($event);
  }
}

handleEvent()方法的参数是一个StdClass对象，结构如下：

• block：交易所在区块号
• txhash：交易哈希
• contract：触发事件的合约地址
• name：事件名称，例如：Transfer
• flow：资金流向，可能值：inbound - 转入 ， outbound - 转出
• params：事件参数数组，成员依次为：
  • 转出地址，字符串
  • 转入地址，字符串
  • 代币数量，BigInteger，可以调用toString()方法将其转换为字符串

一旦定义好事件监听器，就可以按如下步骤设置并启动监听：

2.2 创建EthMon对象

创建EthMon实例需要传入一个EthApi对象，例如使用EthApiWeb3对象：

$ethApi = new EthApiWeb3('https://mainnet.infura.io/v3/<your-api-key>');
$em = new EthMon($ethApi);

2.3 设置要监听的代币合约

创建了EthMon实例后，需要调用watchToken()方法设置要监听的代币合约，例如 监听BNB代币合约：

$em->watchToken('0xb8c77482e45f1f44de1745f52c74426c631bdd52');

2.4 添加要监听的代币交易相关地址

使用EthMon实例的watchAddress()方法添加要监听的代币交易相关地址。例如 下面的代码监听地址0xd3705916ce7e2c43806e0e0707c4b9d6f27e9ab2收到代币 的事件：

$em->watchAddress('0xd3705916ce7e2c43806e0e0707c4b9d6f27e9ab2',EthMon::FLOW_IN);

而下面的代码监听地址0x6c6cbbb3ef3d690de7aa0525b5e6c2ffe7aed6a5转出代币 的事件：

$em->watchAddress('0x6c6cbbb3ef3d690de7aa0525b5e6c2ffe7aed6a5',EthMon::FLOW_OUT);

当希望监听一个地址的转入/转出代币事件时，使用EthMon::FLOW_INOUT标志：

$em->watchAddress('0xd3705916ce7e2c43806e0e0707c4b9d6f27e9ab2',EthMon::FLOW_INOUT);

2.5 添加事件监听器

调用EthMon实例的addEventListener()方法添加一个事件监听器对象，当EthMon的 scanBlocks()扫描区块时，将在满足条件时调用这些事件监听器。

例如，下面的代码添加我们之前定义的EzListener类的实例对象：

$em->addEventListener(new EzListener);

2.6 扫描区块链

需要周期性地调用EthMon的scanBlocks()方法来扫描区块链以便跟踪新的代币交易日志， scanBlocks()的两个参数分别用来指定扫描的起始区块号和结束区块号，当使用特殊的 latest字符串时，表示使用最新的区块。

例如，下面的代码每隔5秒钟扫描一次最新的区块：

while(true){
  $em->scanBlocks('latest','latest');
  sleep(5);
}

虽然起止区块号都可以使用任意整数值，但由于Etherscan和Web3的返回记录数量都有 限制，因此不建议一次扫描多个区块。例如下面的代码试图扫描从8500000到8500404 的405个区块：

$em->scanBlocks(8500000,8500404);    //不建议，可能失败

建议逐块扫描，同时考虑到第三方服务的访问频次限制，在两次扫描期间进行适当的 延时处理。