http://www.tnmanning.com

在Java中监听以太坊智能合约事件

什么是智能合约事件?

您可以从事务触发的任何智能合约函数中发出事件,它们是以太坊应用程序架构难题的重要组成部分。

这些事件由一个名称和最多17个参数组成,这些参数的内容由发出函数提供。参数可以是索引的,也可以是非索引的;使用索引参数可以实现高效的链外查询。

例如,如果事件x包含索引字符串参数y,则在链外,我可以使用筛选器检索y==“foo”的所有事件。(稍后将详细介绍过滤器)

事件存储为日志而不是EVM存储,因此,它们具有您应该注意的属性:

· 由于无法从智能合约中访问:虽然智能合约功能会发出事件,但智能合约在发布后无法访问此事件信息。对于排放合同和任何其他外部合同都是如此。因此,您不能将事件用于跨智能合约通信。

· 事件的费用很便宜!:由于事件存储为日志,因此与更新EVM存储状态的传统方法相比,它们是非常便宜的。确切的成本取决于事件规范和事件中数据的大小。

事件的常见用途

异步链外触发器

大多数企业Java开发人员都熟悉事件总线模式,其中事件被发布到队列(如RabByMQ或Amazon SQL)。此模式允许对特定事件感兴趣的服务异步地从总线上使用它们,并执行进一步的处理,而不需要在发布服务器和使用者服务之间进行任何耦合。

事件总线模式

在Java中监听以太坊智能合约事件

服务可以以类似的方式使用以太坊智能合约事件,以太坊网络充当一种消息队列。非链服务可以向节点注册一个事件过滤器,然后每次在以太坊网络中发出此事件时都会通知该过滤器。然后,您可以使用这些事件通知作为进一步的链外处理的触发器,例如更新智能合约状态的基于NoSQL的缓存。

以太坊作为“事件总线”

廉价的数据存储用于链外消费

如上所述,在事件中存储数据而不是在EVM合同存储中存储数据要便宜得多。

为了进行比较,稍微深入了解一下细节,将32字节的数据保存到合同存储需要消耗20000气体,而发送一个事件需要消耗375加上每个索引参数的375气体,每个字节的数据需要额外的8气体。

由于这些成本节约,在事件中存储从不由链上智能合约函数soley读取的数据是一种常见的模式,而不是在合约存储中。

一个可能是这种情况的场景示例是一个公证服务,其中IPF哈希被提交到以太坊大发3d以证明创建日期。在发出包含文档的IPFS哈希的事件后,如果存在争议,可以通过查询合同事件(而不是合同状态)来验证链外公证的时间戳。

定义和发出事件

您的以太坊智能合约中的定义、发送和事件都是一段代码:

定义

event Notarized(address indexed notary, string documentHash)

在这个例子中,我们定义了一个名为Notarized的事件,带有索引地址参数,notary和一个非索引字符串参数documentHash。

发送

function notarizeDocument(string _documentHash) public {
        emit Notarized(msg.sender, _documentHash);
}

emit关键字触发一个事件,参数以类似于函数调用的方式传递给事件。 这里,公证地址通过msg.sender设置为事务发送方地址,documentHash与被调用的函数参数相同。

使用Web3J监听已发出的事件

到目前为止,使用web3j监听以太坊智能合约事件的最简单方法是使用库的合同包装器功能。

下面的代码段连接到本地以太坊节点,并监听从部署的公证合同发出的所有公证事件:

Web3j web3j = Web3j.build(new HttpService("http://localhost:8545"));

//Deploys a notary contract via wrapper
final Notary notaryContract = deployNotaryContract(web3j);

notaryContract
        .notarizedEventFlowable(DefaultBlockParameterName.EARLIEST, DefaultBlockParameterName.LATEST)
        .subscribe(event -> {
            final String notary = event.notary;
            final String documentHash = event.documentHash;

            //Perform processing based on event values
        });

自动生成的合同包装器代码包含使用命名模式<event-name> EventFlowable在智能合约中定义的每个事件的便捷方法。此方法采用开始和结束区块参数,并且在此示例中,使用DefaultBlockParameterName.LATEST值指示web3j无限期地继续监听新区块的事件。如果需要特定的区块范围,可以使用DefaultBlockParameter.valueOf(BigInteger.valueOf(...))。返回一个Flowable对象,然后可以订阅该对象,以便对发出的事件执行处理逻辑。

此方法简化了事件侦听过程,因为它自动将原始日志消息转换为具有反映已定义事件参数的字段的对象。如果没有这个,你必须自己解码这些值,虽然web3j为此提供了帮助方法,但事情可能会很快变得复杂。

按索引参数值过滤

将事件的参数设置为indexed有助于通过该参数值高效地查询事件。通过手动构建ethfilter对象,Web3J支持此查询。下面是监听特定以太坊地址公证的事件的代码:

final EthFilter ethFilter = new EthFilter(DefaultBlockParameterName.EARLIEST, DefaultBlockParameterName.LATEST,
                notaryContract.getContractAddress());

ethFilter.addSingleTopic(EventEncoder.encode(notaryContract.NOTARIZED_EVENT));
ethFilter.addOptionalTopics("0x" + TypeEncoder.encode(new Address("0x00a329c0648769a73afac7f9381e08fb43dbea72")));

notaryContract
        .notarizedEventFlowable(ethFilter)
        .subscribe(event -> {
            final String notary = event.notary;
            final String documentHash = event.documentHash;

            //Perform processing based on event values
        });

notarizedEventFlowable被重载,并且可以接受EthFilter作为参数,而不是区块范围。此过滤器用于以更精粒度的方式定义要监听的事件,并使用与先前传递给方法相同的区块范围构建。

还有一些主题在过滤器上设置。在以太坊过滤器中,第一个主题始终定义为事件签名的keccak哈希,在我们的案例中,事件签名为“Notarised(address,string)”。这是在Web3j提供的EventEncoder.encode(..)方法的帮助下计算的,以及在包装类中自动生成的事件规范NOTARIZED_EVENT。

可以使用addOptionalTopics(..)方法添加其他主题,这些主题指定要匹配的索引参数的值,其顺序与事件规范中定义的顺序相同。编码根据参数的类型略有不同,但幸运的是,Web3j提供了TypeEncoder类,它为我们处理这个问题。在提供的示例中,我们仅监听公证值为地址0x00a329c0648769a73afac7f9381e08fb43dbea72的事件。

总结

对于后端(和前端)服务来说,事件是以异步方式通知智能合约更改和交互的一种很好的方式,也是一种在以太坊大发3d上存储不需要智能合约消费的数据的经济有效的方式。

与许多以太坊交互一样,Web3j生成的智能合约包装器是迄今为止最简单的方式来订阅和处理java后端中发出的事件。

关键词: Java  以太坊智能合约  

郑重声明:本文版权归原作者所有,转载文章仅为传播更多信息之目的,如作者信息标记有误,请第一时间联系我们修改或删除,多谢。