您可以從事務(wù)觸發(fā)的任何智能合約函數(shù)中發(fā)出事件,它們是以太坊應(yīng)用程序架構(gòu)難題的重要組成部分。
這些事件由一個名稱和最多17個參數(shù)組成,這些參數(shù)的內(nèi)容由發(fā)出函數(shù)提供。參數(shù)可以是索引的,也可以是非索引的;使用索引參數(shù)可以實現(xiàn)高效的鏈外查詢。
例如,如果事件x包含索引字符串參數(shù)y,則在鏈外,我可以使用篩選器檢索y==“foo”的所有事件。
事件存儲為日志而不是EVM存儲,因此,它們具有您應(yīng)該注意的屬性:
· 由于無法從智能合約中訪問:雖然智能合約功能會發(fā)出事件,但智能合約在發(fā)布后無法訪問此事件信息。對于排放合同和任何其他外部合同都是如此。因此,您不能將事件用于跨智能合約通信。
· 事件的費用很便宜!:由于事件存儲為日志,因此與更新EVM存儲狀態(tài)的傳統(tǒng)方法相比,它們是非常便宜的。確切的成本取決于事件規(guī)范和事件中數(shù)據(jù)的大小。
事件的常見用途
異步鏈外觸發(fā)器
大多數(shù)企業(yè)Java開發(fā)人員都熟悉事件總線模式,其中事件被發(fā)布到隊列(如RabByMQ或Amazon SQL)。此模式允許對特定事件感興趣的服務(wù)異步地從總線上使用它們,并執(zhí)行進一步的處理,而不需要在發(fā)布服務(wù)器和使用者服務(wù)之間進行任何耦合。
事件總線模式
服務(wù)可以以類似的方式使用以太坊智能合約事件,以太坊網(wǎng)絡(luò)充當(dāng)一種消息隊列。非鏈服務(wù)可以向節(jié)點注冊一個事件過濾器,然后每次在以太坊網(wǎng)絡(luò)中發(fā)出此事件時都會通知該過濾器。然后,您可以使用這些事件通知作為進一步的鏈外處理的觸發(fā)器,例如更新智能合約狀態(tài)的基于NoSQL的緩存。
以太坊作為“事件總線”
廉價的數(shù)據(jù)存儲用于鏈外消費
如上所述,在事件中存儲數(shù)據(jù)而不是在EVM合同存儲中存儲數(shù)據(jù)要便宜得多。
為了進行比較,稍微深入了解一下細節(jié),將32字節(jié)的數(shù)據(jù)保存到合同存儲需要消耗20000氣體,而發(fā)送一個事件需要消耗375加上每個索引參數(shù)的375氣體,每個字節(jié)的數(shù)據(jù)需要額外的8氣體。
由于這些成本節(jié)約,在事件中存儲從不由鏈上智能合約函數(shù)soley讀取的數(shù)據(jù)是一種常見的模式,而不是在合約存儲中。
一個可能是這種情況的場景示例是一個公證服務(wù),其中IPF哈希被提交到以太坊區(qū)塊鏈以證明創(chuàng)建日期。在發(fā)出包含文檔的IPFS哈希的事件后,如果存在爭議,可以通過查詢合同事件(而不是合同狀態(tài))來驗證鏈外公證的時間戳。
定義和發(fā)出事件
您的以太坊智能合約中的定義、發(fā)送和事件都是一段代碼:
定義
event Notarized(address indexed notary, string documentHash)
在這個例子中,我們定義了一個名為Notarized的事件,帶有索引地址參數(shù),notary和一個非索引字符串參數(shù)documentHash。
發(fā)送
function notarizeDocument(string _documentHash) public {
emit Notarized(msg.sender, _documentHash);
}
emit關(guān)鍵字觸發(fā)一個事件,參數(shù)以類似于函數(shù)調(diào)用的方式傳遞給事件。 這里,公證地址通過msg.sender設(shè)置為事務(wù)發(fā)送方地址,documentHash與被調(diào)用的函數(shù)參數(shù)相同。
使用Web3J監(jiān)聽已發(fā)出的事件
到目前為止,使用web3j監(jiān)聽以太坊智能合約事件的最簡單方法是使用庫的合同包裝器功能。
下面的代碼段連接到本地以太坊節(jié)點,并監(jiān)聽從部署的公證合同發(fā)出的所有公證事件:
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在智能合約中定義的每個事件的便捷方法。此方法采用開始和結(jié)束區(qū)塊參數(shù),并且在此示例中,使用DefaultBlockParameterName.LATEST值指示web3j無限期地繼續(xù)監(jiān)聽新區(qū)塊的事件。如果需要特定的區(qū)塊范圍,可以使用DefaultBlockParameter.valueOf(BigInteger.valueOf(。..))。返回一個Flowable對象,然后可以訂閱該對象,以便對發(fā)出的事件執(zhí)行處理邏輯。
此方法簡化了事件偵聽過程,因為它自動將原始日志消息轉(zhuǎn)換為具有反映已定義事件參數(shù)的字段的對象。如果沒有這個,你必須自己解碼這些值,雖然web3j為此提供了幫助方法,但事情可能會很快變得復(fù)雜。
按索引參數(shù)值過濾
將事件的參數(shù)設(shè)置為indexed有助于通過該參數(shù)值高效地查詢事件。通過手動構(gòu)建ethfilter對象,Web3J支持此查詢。下面是監(jiān)聽特定以太坊地址公證的事件的代碼:
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作為參數(shù),而不是區(qū)塊范圍。此過濾器用于以更精粒度的方式定義要監(jiān)聽的事件,并使用與先前傳遞給方法相同的區(qū)塊范圍構(gòu)建。
還有一些主題在過濾器上設(shè)置。在以太坊過濾器中,第一個主題始終定義為事件簽名的keccak哈希,在我們的案例中,事件簽名為“Notarised(address,string)”。這是在Web3j提供的EventEncoder.encode(。.)方法的幫助下計算的,以及在包裝類中自動生成的事件規(guī)范NOTARIZED_EVENT。
可以使用addOpTIonalTopics(。.)方法添加其他主題,這些主題指定要匹配的索引參數(shù)的值,其順序與事件規(guī)范中定義的順序相同。編碼根據(jù)參數(shù)的類型略有不同,但幸運的是,Web3j提供了TypeEncoder類,它為我們處理這個問題。在提供的示例中,我們僅監(jiān)聽公證值為地址0x00a329c0648769a73afac7f9381e08fb43dbea72的事件。
總結(jié)
對于后端(和前端)服務(wù)來說,事件是以異步方式通知智能合約更改和交互的一種很好的方式,也是一種在以太坊區(qū)塊鏈上存儲不需要智能合約消費的數(shù)據(jù)的經(jīng)濟有效的方式。
與許多以太坊交互一樣,Web3j生成的智能合約包裝器是迄今為止最簡單的方式來訂閱和處理java后端中發(fā)出的事件。