events - 订阅合约事件
优质
小牛编辑
123浏览
2023-12-01
订阅指定的合约事件。
调用:
myContract.events.MyEvent([options][, callback])
参数:
- options - Object: 可选,用于部署的选项,包含以下字段:
- filter - Object : 可选,按索引参数过滤事件。例如 {filter: {myNumber: [12,13]}} 表示 “myNumber” 为12或13的所有事件
- fromBlock - Number: 可选,仅监听该选项指定编号的块中发生的事件
- topics - Array : 可选,用来手动为事件过滤器设定主题。如果设置过filter属性和事件签名,那么(topic[0])将不会自动设置
- callback - Function: 可选,该回调函数触发时,其第二给参数为事件对象,第一个参数为错误对象
返回值:
EventEmitter: 事件发生器,声明有以下事件:
- "data" 返回 Object: 接收到新的事件时触发,参数为事件对象
- "changed" 返回 Object: 当事件从区块链上移除时触发,该事件对象将被添加额外的属性"removed: true"
- "error" 返回 Object: 当发生错误时触发
返回的事件对象结构如下:
- event - String: 事件名称
- signature - String|Null: 事件签名,如果是匿名事件,则为null
- address - String: 事件源地址
- returnValues - Object: 事件返回值,例如 {myVar: 1, myVar2: '0x234...'}.
- logIndex - Number: 事件在块中的索引位置
- transactionIndex - Number: 事件在交易中的索引位置
- transactionHash 32 Bytes - String: 事件所在交易的哈希值
- blockHash 32 Bytes - String: 事件所在块的哈希值,pending的块该值为 null
- blockNumber - Number: 事件所在块的编号,pending的块该值为null
- raw.data - String: 该字段包含未索引的日志参数
- raw.topics - Array: 最多可保存4个32字节长的主题字符串数组。主题1-3 包含事件的索引参数
示例代码:
myContract.events.MyEvent({
filter: {myIndexedParam: [20,23], myOtherIndexedParam: '0x123456789...'}, // Using an array means OR: e.g. 20 or 23
fromBlock: 0
}, function(error, event){ console.log(event); })
.on('data', function(event){
console.log(event); // same results as the optional callback above
})
.on('changed', function(event){
// remove event from local database
})
.on('error', console.error);
// event output example
> {
returnValues: {
myIndexedParam: 20,
myOtherIndexedParam: '0x123456789...',
myNonIndexParam: 'My String'
},
raw: {
data: '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385',
topics: ['0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7', '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385']
},
event: 'MyEvent',
signature: '0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7',
logIndex: 0,
transactionIndex: 0,
transactionHash: '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385',
blockHash: '0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7',
blockNumber: 1234,
address: '0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'
}