日前的政策利好將區(qū)塊鏈推向了前所未有風(fēng)口,把區(qū)塊鏈作為核心技術(shù)自主創(chuàng)新重要突破口,加快推動(dòng)區(qū)塊鏈技術(shù)和產(chǎn)業(yè)創(chuàng)新發(fā)展成為了區(qū)塊鏈行業(yè)
日前的政策利好將區(qū)塊鏈推向了前所未有風(fēng)口,“把區(qū)塊鏈作為核心技術(shù)自主創(chuàng)新重要突破口,加快推動(dòng)區(qū)塊鏈技術(shù)和產(chǎn)業(yè)創(chuàng)新發(fā)展”成為了區(qū)塊鏈行業(yè)最新的工作指示。我們感到十分興奮,因?yàn)槲覀円恢倍荚谡_的道路上持續(xù)前行,為這一場(chǎng)區(qū)塊鏈技術(shù)攻堅(jiān)戰(zhàn)厲兵秣馬。
而就在本體 Ontology 2.0 發(fā)布前夕,Ontology v1.8.0于10月29日重磅發(fā)布。經(jīng)過數(shù)月在測(cè)試網(wǎng)上的穩(wěn)定運(yùn)行,Wasm 功能也正式登陸了主網(wǎng)。在往期的技術(shù)視點(diǎn)中,我們已推出多部 Ontology Wasm 相關(guān)教程,社區(qū)伙伴們紛紛表示受益匪淺。本期我們將介紹如何基于 Wasm合約使用 Runtime API,相信你會(huì)有所收獲。
Runtime API 簡(jiǎn)述
Ontology Wasm 合約開發(fā)工具庫(kù) ontology-wasm-cdt-rust 里面 Runtime 模塊封裝了合約與 Ontology 鏈交互的 API 方法。通過這些 API 方法,合約可以獲得鏈上的數(shù)據(jù),或者將合約中的數(shù)據(jù)保存到鏈上,以下是這些 API 方法的簡(jiǎn)單描述。
接下來(lái),我們來(lái)具體講述下這些 API 的使用方法。在此之前,開發(fā)者可以從 GitHub 上 clone 下來(lái)我們的合約模板,然后在lib.rs文件中添加合約邏輯代碼。
Runtime API 使用方法
首先,開發(fā)者僅需要通過下面的方式將 Runtime 模塊引入到當(dāng)前合約中:
use ontio_std::runtime;
然后就可以通過 Runtime 引用以上所有的 API 接口。
1. timestamp()
timestamp()方法獲得當(dāng)前的時(shí)間戳,即返回調(diào)用該函數(shù)的 Unix 時(shí)間,單位為秒。調(diào)用示例:
let t = runtime::timestamp();
一個(gè)簡(jiǎn)單的示例代碼如下:
#![no_std]
extern crate ontio_std as ostd;
use ostd::abi::{Sink, Source};
use ostd::prelude::*;
use ostd::runtime;
fn hello() -> u64 {
runtime::timestamp()//取得當(dāng)前時(shí)間戳
}
#[no_mangle]
fn invoke() {
let input = runtime::input();//獲得輸入方法名和方法參數(shù)
let mut source = Source::new(&input);//構(gòu)造反序列化實(shí)例
let action = source.read().unwrap_or_default();//讀取方法名
let mut sink = Sink::new(16);//構(gòu)造序列化實(shí)例
match action {
"hello" => {
sink.write(hello());//將hello()返回的結(jié)果序列化
}
_ => panic!("unsupported action!")
}
runtime::ret(sink.bytes());//將序列化后的結(jié)果返回給調(diào)用方
}
在下面的 API 方法講述中,我們將省略具體例子,只介紹 API 方法的作用。小伙伴們可以采用類似于上述例子的代碼進(jìn)行試驗(yàn)。
2. block_height
block_height函數(shù)獲得當(dāng)前區(qū)塊鏈網(wǎng)絡(luò)的區(qū)塊高度,調(diào)用示例:
let t = runtime::block_height();
3. address
address 獲得當(dāng)前合約的地址,調(diào)用示例:
let t = runtime::address();
4. caller
caller 獲得調(diào)用方的合約地址,主要用于跨合約調(diào)用的場(chǎng)景,比如合約 A 調(diào)用合約 B 的應(yīng)用場(chǎng)景, 在合約 B 中就可以調(diào)用該方法獲得調(diào)用方合約 A 的地址:
let t = runtime::caller();
5. entry_address
entry_address 獲得入口合約地址,比如有這樣的應(yīng)用場(chǎng)景,合約 A 通過合約 B 調(diào)用合約 C的方法,此時(shí),在合約 C 中就可以通過該方法拿到合約 A 的地址,調(diào)用示例:
let t = runtime::entry_address();
6. current_blockhash
current_blockhash 獲得當(dāng)前區(qū)塊的 hash,示例如下:
let t = runtime::current_blockhash();
7. current_txhash
current_txhash獲得當(dāng)前交易的 hash,示例如下:
let t = runtime::current_txhash();
8. sha256
sha256計(jì)算輸入?yún)?shù)的 hash256值:
let h = runtime::sha256("test");
9. check_witness
check_witness(from)校驗(yàn)是否含有該地址的簽名:
· 驗(yàn)證當(dāng)前的函數(shù)調(diào)用者是不是含有 from 的簽名 。若是(即簽名驗(yàn)證通過),則函數(shù)返回 true;
· 檢查當(dāng)前函數(shù)調(diào)用者是不是一個(gè)合約。若是合約,且是從該合約發(fā)起去執(zhí)行函數(shù),返回 true。即,驗(yàn)證 from 是不是caller的返回值。其中,caller()函數(shù)可以得到調(diào)用當(dāng)前智能合約的合約哈希值。
assert!(runtime::check_witness(from));
10. notify
notify函數(shù)將合約中事件推送到全網(wǎng),并將其內(nèi)容保存到鏈上,調(diào)用方法如下:
runtime::notify("notify".as_bytes())
在合約中推送事件時(shí),可以自定義一個(gè)事件函數(shù),加上#[event]注解即可。我們的工具庫(kù)中提供了該屬性宏,需要通過use ostd::macros::event;引入。示例如下:
use ostd::macros::event;
mod notify {
use super::*;
#[event]
pub fn transfer(from: &Address, to: &Address, amount: U128) {}
}
fn transfer(from: &Address, to: &Address, amount: U128) -> bool {
...
notify::transfer(from, to, amount);
}
11. panic
panic方法可以在合約執(zhí)行發(fā)生致命錯(cuò)誤的時(shí)候立即終止交易的執(zhí)行,然后回滾當(dāng)前的交易。該方法在跨合約調(diào)用的場(chǎng)景很重要,比如在如下的應(yīng)用場(chǎng)景中,合約 A 中的方法 a 調(diào)用合約 B 中的方法 b,其中合約 A 的 a 方法在調(diào)用合約 B 的 b 方法之前會(huì)保存一些數(shù)據(jù)到鏈上,但是在調(diào)用合約 B 的 b 方法時(shí),發(fā)生了致命的錯(cuò)誤,需要回滾合約 A 中 a 方法執(zhí)行過程中保存的數(shù)據(jù),此時(shí)就需要在合約 B 的 b 方法中應(yīng)用panic方法實(shí)現(xiàn)該功能。
runtime::panic("test");
結(jié)語(yǔ)
本文主要講解了 Runtime 模塊的 API,該模塊提供了與鏈交互的功能,其中 notify 用于合約中推送事件,開發(fā)者可以使用自定義事件的方式推送事件,而不是直接使用 notify 方法。use ostd::macros::event屬性宏提供了更加友好的事件推送機(jī)制。在跨合約調(diào)用的過程中,panic方法在異常處理中具有非常重要的。下一期我們將介紹如何實(shí)現(xiàn) Wasm 合約與 NeoVM 合約及 Native 合約之間的相互調(diào)用,歡迎大家關(guān)注學(xué)習(xí)。
Ontology 率先支持 Wasm 合約將會(huì)大大提高混合虛擬機(jī)的性能,也將吸引眾多不同語(yǔ)言的技術(shù)開發(fā)者加入本體社區(qū),共同推進(jìn)區(qū)塊鏈技術(shù)的研發(fā),豐富本體強(qiáng)大的技術(shù)生態(tài)。同時(shí),基于本體強(qiáng)大的技術(shù)研發(fā)團(tuán)隊(duì),也可將現(xiàn)有的優(yōu)秀技術(shù)整合到本體生態(tài)上來(lái),為合約開發(fā)者增加更多選項(xiàng)。歡迎各位技術(shù)伙伴與我們共同前行!(Lucas)