web3j教程:过滤器(Filters)和事件(Events)

web3j过滤器提供以太坊网络发生的某些事件的通知,对java和安卓程序员来说很有用。在Ethereum以太坊中支持三类过滤器:

  • 块滤波器(Block filters)
  • 未决交易过滤器(Pending transaction filters)
  • 主题过滤器(Topic filters)

块过滤器和未决交易过滤器提供了在网络上创建新交易或块的通知。

主题过滤器更灵活。允许根据提供的特定标准创建过滤器。

不幸的是,除非你使用WebSocket连接到Geth,否则通过JSON-RPC API来处理过滤器是一个繁琐的过程,这里需要轮询以太坊客户端,以便了解HTTP和IPC所请求的实时同步特征,是否有任何新的更新到你的过滤器。此外,块和交易过滤器只提供交易或区块链hash值,因此需要进一步的请求来获得hash对应的实际交易或块。

web3j的过滤器解决了这些问题,因此你有一个完全异步的基于事件的API来处理过滤器。它使用RXJava的可观测性Observables,它提供了与事件协同工作的一致API,这有助于通过功能组合将JSON-RPC调用链接在一起。

注:Infura不支持过滤器。

块和交易过滤器

接收所有新块把它们添加到区块链(false参数指定我们只需要块就ok,而不需要嵌入交易):

1
2
3
Subscription subscription = web3j.blockObservable(false).subscribe(block -> {
...
});

接收所有新交易,把它们添加到块链:

1
2
3
Subscription subscription = web3j.transactionObservable().subscribe(tx -> {
...
});

接收所有待提交交易并提交到网络(即在它们被分组在一起之前):

1
2
3
Subscription subscription = web3j.pendingTransactionObservable().subscribe(tx -> {
...
});

不再需要的时候取消订阅unsubscribe

1
subscription.unsubscribe();

另外还提供了其他回调,它们简单地提供了块或交易hash,这些细节涉及Web3JRX接口。

再现过滤器

webjs还提供用于再现块和交易历史的过滤器。

从区块链再现一系列块:

1
2
3
4
5
Subscription subscription = web3j.replayBlocksObservable(
<startBlockNumber>, <endBlockNumber>, <fullTxObjects>)
.subscribe(block -> {
...
});

再现包含在一个块范围内的单个交易:

1
2
3
4
5
Subscription subscription = web3j.replayTransactionsObservable(
<startBlockNumber>, <endBlockNumber>)
.subscribe(tx -> {
...
});

也可以获得Web3J再现最新的块,并在你看过后提供通知(通过提交Observable):

1
2
3
4
5
Subscription subscription = web3j.catchUpToLatestBlockObservable(
<startBlockNumber>, <fullTxObjects>, <onCompleteObservable>)
.subscribe(block -> {
...
});

或者,也可以在你再现最新的块后,通知新创建的后续块:

1
2
3
4
5
Subscription subscription = web3j.catchUpToLatestAndSubscribeToNewBlocksObservable(
<startBlockNumber>, <fullTxObjects>)
.subscribe(block -> {
...
});

如上所述,并包含在块内的交易:

1
2
3
4
5
Subscription subscription = web3j.catchUpToLatestAndSubscribeToNewTransactionsObservable(
<startBlockNumber>)
.subscribe(tx -> {
...
});

所有上述过滤器都是通过Web3JRX接口导出的。

主题过滤器和EVM事件

主题过滤器捕获在网络中发生的以太坊虚拟机(EVM)事件的细节。这些事件是由智能合约创建的,并存储在与智能合约相关联的交易日志中。

solidity文档提供了EVM事件的良好概述。

使用EthFilter类型指定希望应用于过滤器的主题。这可以包括希望应用过滤器的智能合约的地址。你还可以提供特定的主题进行筛选。其中单个主题表示智能合约上的索引参数:

1
2
3
EthFilter filter = new EthFilter(DefaultBlockParameterName.EARLIEST,
DefaultBlockParameterName.LATEST, <contract-address>)
[.addSingleTopic(...) | .addOptionalTopics(..., ...) | ...];

然后可以使用类似于上面的块和交易过滤器的语法创建该过滤器:

1
2
3
web3j.ethLogObservable(filter).subscribe(log -> {
...
});

过滤器主题只能引用索引的Solidity事件参数。不可能对非索引事件参数进行筛选。此外,对于可变长度数组类型(如字符串和字节)的任何索引事件参数,它们的值的Keccak-256 hash 存储在EVM日志上。不可能使用它们的全部值来存储或筛选。

如果创建一个没有与之相关联的主题的过滤器实例,则在网络中发生的所有EVM事件都将由过滤器捕获。

操作组合注记

除了send()sendAsync之外,所有JSON-RPC方法在web3j中都实现了支持observable()方法来创建可观察的异步执行请求。这使得将JSON-RPC调用组合成新的函数是非常容易和直接的。

例如, blockObservable本身由许多单独的JSON-RPC调用组成:

1
2
3
4
5
6
public Observable<EthBlock> blockObservable(
boolean fullTransactionObjects, long pollingInterval) {
return this.ethBlockHashObservable(pollingInterval)
.flatMap(blockHash ->
web3j.ethGetBlockByHash(blockHash, fullTransactionObjects).observable());
}

在这里,我们首先创建一个可观察的,它提供每个新创建的块的块哈希的通知。然后,我们使用flatMap调用ethGetBlockByHash,以获得完整的块细节,这是传递给可观察者的订阅服务器的细节。

进一步的例子

请参阅ObservableIT,进一步举例说明。

对于使用手动筛选器API的演示,可以查看EventFilterIT

  • web3j教程,主要是针对java和android程序员进行区块链以太坊开发的web3j开发详解。
  • 以太坊教程,主要介绍智能合约与dapp应用开发,适合入门。
  • 以太坊开发,主要是介绍使用node.js、mongodb、区块链、ipfs实现去中心化电商DApp实战,适合进阶。
  • php以太坊,主要是介绍使用php进行智能合约开发交互,进行账号创建、交易、转账、代币开发以及过滤器和事件等内容。

汇智网原创翻译,转载请标明出处。这里是原文