ERC20合约交易监听的PHP实现代码

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: EthMon开发包用于监听以太坊ERC20代币合约的转账交易,官方下载地址:http://sc.hubwiz.com/codebag/ethmon-php/。1、开发包概述EthMon代币交易监听开发包特点如下:监听以太坊合约日志中指定地址发生的代币转入/转出交易自定义代币交易发生时的业...

EthMon开发包用于监听以太坊ERC20代币合约的转账交易,官方下载地址:
http://sc.hubwiz.com/codebag/ethmon-php/

1、开发包概述

EthMon代币交易监听开发包特点如下:

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

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

uml

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

文件路径 说明
ethtool/src/ EthMon源代码目录
ethtool/src/EthMon.php EthMon入口类
ethtool/src/EthApi.php 以太坊API基类
ethtool/src/EthApiEtherscan.php EthApi的Etherscan继承类
ethtool/src/EthApiWeb3.php EthApi的Web3继承类
ethtool/src/LogParser.php 以太坊日志解析类
ethtool/src/IEventListener.php EthMon事件监听器接口
demo/ EthMon演示代码目录
demo/EthMon-es-demo.php 使用Etherscan接口的EthMon演示
demo/EthMon-web3-demo.php 使用Web3/Infura接口的EthMon演示
demo/getLogs-es-demo.php 使用Etherscan接口的getLogs演示
demo/getLogs-web3-demo.php 使用Web3/Infura接口的getLogs演示
demo/LogParser-demp.php LogParser演示
demo/etherscan-key 演示代码用的api key - etherscan
demo/infura-key 演示代码用的api key - infura
vendor/ 第三方依赖包
composer.json composer配置文件

EthMon官方下载地址:http://sc.hubwiz.com/codebag/ethmon-php/

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);    //不建议,可能失败

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

EthMon官方下载地址:http://sc.hubwiz.com/codebag/ethmon-php/

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
目录
相关文章
|
1月前
|
IDE PHP 开发工具
PHP中的类型提示与严格模式:提高代码可维护性
随着PHP语言的发展,开发者对代码的可读性、可维护性和可靠性有了更高的要求。PHP中的类型提示(Type Hinting)和严格模式(Strict Mode)为开发者提供了更强的类型检查机制,有助于提升代码质量和减少潜在的错误,尤其是在大型项目中。
|
2月前
|
安全 程序员 PHP
PHP中的异常处理:提升代码的健壮性
【10月更文挑战第8天】在编程的世界中,错误和异常是不可避免的。它们就像路上的坑洼,可能会让我们的程序“跌倒”。但是,如果我们能够正确地处理这些异常,就可以让我们的程序更加稳健,就像我们学会了如何在坑洼的路上稳稳地行走一样。本文将介绍PHP中的异常处理机制,以及如何使用它来提升我们的代码质量。
|
3月前
|
设计模式 数据库连接 PHP
PHP中的设计模式:提升代码的可维护性与扩展性在软件开发过程中,设计模式是开发者们经常用到的工具之一。它们提供了经过验证的解决方案,可以帮助我们解决常见的软件设计问题。本文将介绍PHP中常用的设计模式,以及如何利用这些模式来提高代码的可维护性和扩展性。我们将从基础的设计模式入手,逐步深入到更复杂的应用场景。通过实际案例分析,读者可以更好地理解如何在PHP开发中应用这些设计模式,从而写出更加高效、灵活和易于维护的代码。
本文探讨了PHP中常用的设计模式及其在实际项目中的应用。内容涵盖设计模式的基本概念、分类和具体使用场景,重点介绍了单例模式、工厂模式和观察者模式等常见模式。通过具体的代码示例,展示了如何在PHP项目中有效利用设计模式来提升代码的可维护性和扩展性。文章还讨论了设计模式的选择原则和注意事项,帮助开发者在不同情境下做出最佳决策。
|
3月前
|
存储 Java 数据库连接
php学习笔记-代码基本语法-day01
本文是关于PHP编程语言的基础语法学习笔记,内容包括PHP的介绍、注释风格、数据类型、命名规范、常量和变量的使用,以及变量和常量相关的常用函数。文中详细解释了PHP的基本语法元素和一些易混淆的概念,如传值赋值与传址赋值、可变变量,以及如何检查变量是否已定义或为空。
php学习笔记-代码基本语法-day01
|
10天前
|
PHP 开发者 容器
PHP命名空间深度解析:避免命名冲突与提升代码组织####
本文深入探讨了PHP中命名空间的概念、用途及最佳实践,揭示其在解决全局命名冲突、提高代码可维护性方面的重要性。通过生动实例和详尽分析,本文将帮助开发者有效利用命名空间来优化大型项目结构,确保代码的清晰与高效。 ####
15 1
|
16天前
|
供应链 安全 NoSQL
PHP 互斥锁:如何确保代码的线程安全?
在多线程和高并发环境中,确保代码段互斥执行至关重要。本文介绍了 PHP 互斥锁库 `wise-locksmith`,它提供多种锁机制(如文件锁、分布式锁等),有效解决线程安全问题,特别适用于电商平台库存管理等场景。通过 Composer 安装后,开发者可以利用该库确保在高并发下数据的一致性和安全性。
30 6
|
13天前
|
PHP 开发者 UED
探索PHP中的异常处理:提升代码的健壮性
在PHP开发中,优雅地处理错误和异常是确保应用稳定性和用户体验的关键。本文将通过深入浅出的方式,介绍如何在PHP中实现有效的异常处理机制,包括异常的基本概念、如何抛出和捕获异常,以及最佳实践。准备好让你的代码变得更加健壮和可靠吧!
15 2
|
24天前
|
PHP 开发者
PHP中的异常处理:提升代码的健壮性
【10月更文挑战第40天】在PHP编程中,异常处理是确保应用稳定性的关键。本文将引导你理解异常处理的重要性,掌握如何在PHP中捕获和处理异常,以及如何通过自定义异常类来增强代码的错误管理能力。我们将一起探索如何利用PHP的异常处理机制,打造一个更加健壮和可靠的应用程序。
|
2月前
|
设计模式 算法 数据库连接
PHP中的设计模式:提高代码的可维护性和扩展性
【10月更文挑战第13天】 本文将探讨PHP中常见的设计模式及其在实际项目中的应用。通过对比传统编程方式,我们将展示设计模式如何有效地提高代码的可维护性和扩展性。无论是单例模式确保类的单一实例,还是观察者模式实现对象间的松耦合,每一种设计模式都为开发者提供了解决特定问题的最佳实践。阅读本文后,读者将能更好地理解和应用这些设计模式,从而提升PHP编程的效率和质量。
|
2月前
|
设计模式 SQL 安全
PHP中的设计模式:单例模式的深入探索与实践在PHP开发领域,设计模式是解决常见问题的高效方案集合。它们不是具体的代码,而是一种编码和设计经验的总结。单例模式作为设计模式中的一种,确保了一个类仅有一个实例,并提供一个全局访问点。本文将深入探讨单例模式的基本概念、实现方式及其在PHP中的应用。
单例模式在PHP中的应用广泛,尤其在处理数据库连接、日志记录等场景时,能显著提高资源利用率和执行效率。本文从单例模式的定义出发,详细解释了其在PHP中的不同实现方法,并探讨了使用单例模式的优势与注意事项。通过对示例代码的分析,读者将能够理解如何在PHP项目中有效应用单例模式。