如何使用Rust進(jìn)行Wasm合約開(kāi)發(fā)

Ontology Wasm 自從上線測(cè)試網(wǎng)以來(lái)，得到了社區(qū)開(kāi)發(fā)人員的極大關(guān)注。因?yàn)檫@項(xiàng)技術(shù)使得業(yè)務(wù)邏輯復(fù)雜的 dApp 合約上鏈成本降低，極大豐富 dApp 生態(tài)。

Ontology Wasm 目前支持使用 Rust 和 C++兩種語(yǔ)言開(kāi)發(fā)。其中 Rust 語(yǔ)言對(duì) Wasm 的支持更好，生成的字節(jié)碼更加精簡(jiǎn)，可以進(jìn)一步降低合約調(diào)用的費(fèi)用。那么如何使用 Rust 進(jìn)行 Ontology 的合約開(kāi)發(fā)？

一、使用 Rust 進(jìn)行 Wasm 合約開(kāi)發(fā)

1.1 新建合約

Cargo 是開(kāi)發(fā) Rust 程序時(shí)一款不可多得的項(xiàng)目構(gòu)建和包管理工具，它可以幫助開(kāi)發(fā)者更好地組織代碼和第三方庫(kù)依賴。新建一個(gè) Ontology Wasm 空合約，僅只需要執(zhí)行下面的命令：

cargo new --lib hello-world

其生成的項(xiàng)目結(jié)構(gòu)是：

|-Cargo.toml

|-src

|-lib.rs

其中，Cargo.toml 文件用來(lái)配置項(xiàng)目基本信息和依賴庫(kù)信息等，文件中的［lib］段必須設(shè)置成 crate-type = ［“cdylib”］；而 lib.rs 文件用來(lái)編寫(xiě)合約邏輯代碼。另外，需要在配置文件 Cargo.toml 的［dependencies］段中加入依賴項(xiàng)設(shè)置：

ontio-std={https://github.com/ontio/ontology-wasm-cdt-rust}

利用這個(gè)依賴項(xiàng)，開(kāi)發(fā)者可以調(diào)用與本體區(qū)塊鏈交互的接口以及參數(shù)序列化等工具。

1.2 合約入口函數(shù)

每個(gè)程序都有一個(gè)入口函數(shù)，比如我們常見(jiàn)的 main 函數(shù)，但是合約并沒(méi)有 main 函數(shù)。在用 Rust 開(kāi)發(fā) Wasm 合約時(shí)，默認(rèn)用 invoke 函數(shù)作為合約執(zhí)行的入口函數(shù)。將 Rust 源代碼編譯成虛擬機(jī)可以執(zhí)行的字節(jié)碼時(shí)，會(huì)對(duì) Rust 中的函數(shù)名進(jìn)行混淆。為了防止編譯器生成多余的字節(jié)碼，減小合約大小，invoke 函數(shù)要加上#［no_mangle］注解。

Invoke 函數(shù)如何獲得交易執(zhí)行的參數(shù)？ontio_std 庫(kù)提供了 runtime：：input（）函數(shù)用于接收交易執(zhí)行的參數(shù)，開(kāi)發(fā)者可以使用 ZeroCopySource 對(duì)接收到的字節(jié)數(shù)組進(jìn)行反序列化。其中，讀出來(lái)的第一個(gè)字節(jié)數(shù)組是調(diào)用的方法名，后面讀到的是方法參數(shù)。

合約執(zhí)行結(jié)果是如何返回？ontio_std 庫(kù)提供的runtime：：ret 函數(shù)可以將方法執(zhí)行結(jié)果返回出去。

一個(gè)完整的 invoke 函數(shù)如下：

#［no_mangle］

pub fn invoke（） {

let input = runtime：：input（）;

let mut source = ZeroCopySource：：new（&input）;

let action： &［u8］ = source.read（）.unwrap（）;

let mut sink = Sink：：new（12）;

match action {

b“hello” =》 sink.write（say_hello（）），

_ =》 panic?。ā皍nsupported action！”），

}

runtime：：ret（sink.bytes（））

}

1.3 合約數(shù)據(jù)序列化和反序列化

在合約開(kāi)發(fā)過(guò)程中，開(kāi)發(fā)者總會(huì)遇到序列化和反序列化的問(wèn)題，即如何把一個(gè) struct 類型的數(shù)據(jù)保存到數(shù)據(jù)庫(kù)中以及從數(shù)據(jù)庫(kù)中讀到的字節(jié)數(shù)組如何進(jìn)行反序列化以獲得 struct 類型的數(shù)據(jù)。

Ontio_std 庫(kù)提供了 Decoder 和 Encoder 接口對(duì)數(shù)據(jù)進(jìn)行序列化和反序列化。Struct 結(jié)構(gòu)體的字段也要實(shí)現(xiàn) Decoder 和 Encoder 接口，這樣該 struct 才可以實(shí)現(xiàn)序列化和反序列化。在對(duì)各種數(shù)據(jù)類型進(jìn)行序列化的時(shí)候，需要用到 Sink 實(shí)例。Sink 實(shí)例有個(gè)集合類型的字段 buf，該字段存的是字節(jié)類型數(shù)據(jù)，所有序列化的數(shù)據(jù)都會(huì)存到 buf 中。

對(duì)于固定長(zhǎng)度的數(shù)據(jù)（例如：byte、u16、u32和 u64等），直接將該數(shù)據(jù)轉(zhuǎn)換字節(jié)數(shù)組然后存入 buf 中；對(duì)于長(zhǎng)度不固定的數(shù)據(jù)，序列化時(shí)需要先序列化長(zhǎng)度，然后序列化數(shù)據(jù)（例如不知大小的無(wú)符號(hào)整數(shù)，包括 u16、u32或 u64等）。

反序列化和序列化正好相反。對(duì)于所有的序列化方法，都有對(duì)應(yīng)的反序列化方法。反序列化需要用到 Source 實(shí)例。該實(shí)例有兩個(gè)字段 buf 和 pos。Buf 用來(lái)存儲(chǔ)要反序列化的數(shù)據(jù)，pos 用來(lái)存儲(chǔ)當(dāng)前讀取的位置。讀取指定類型數(shù)據(jù)的時(shí)候，如果知道其長(zhǎng)度，可以直接讀；對(duì)于長(zhǎng)度未知的數(shù)據(jù)，要先讀出來(lái)長(zhǎng)度，然后再讀內(nèi)容。

1.4 訪問(wèn)和更新鏈上的數(shù)據(jù)

Ontology-wasm-cdt-rust 已經(jīng)封裝了鏈上數(shù)據(jù)的操作方法，能夠方便開(kāi)發(fā)者實(shí)現(xiàn)鏈上數(shù)據(jù)的增刪改查等操作。其中：

? database：：get（key） 用來(lái)從鏈上查詢數(shù)據(jù)， key 要求實(shí)現(xiàn) AsRef 接口。

? database：：put（key， value） 用來(lái)將數(shù)據(jù)存到鏈上，key 要求實(shí)現(xiàn) AsRef 接口，value 要求實(shí)現(xiàn) Encoder 接口。

? database：：delete（key） 用來(lái)從鏈上刪除數(shù)據(jù)，key 要求實(shí)現(xiàn) AsRef 接口。

1.5 合約測(cè)試

合約方法執(zhí)行時(shí)需要訪問(wèn)鏈上的數(shù)據(jù)并且需要相應(yīng)的虛擬機(jī)進(jìn)行執(zhí)行合約字節(jié)碼，所以一般需要將合約部署到鏈上才能進(jìn)行相關(guān)測(cè)試。但這樣的測(cè)試方法比較麻煩。為了使開(kāi)發(fā)者更方便地測(cè)試合約，ontio_std 庫(kù)提供了 mock 測(cè)試模塊。該模塊提供了鏈上數(shù)據(jù)的模擬，方便開(kāi)發(fā)者對(duì)合約中的方法進(jìn)行單元測(cè)試。

具體案例可參考：

https://github.com/ontio/ontology-wasm-cdt-rust/blob/master/examples/oep5token/src/test.rs

1.6 調(diào)試合約

開(kāi)發(fā)者可以使用 console：：debug（msg） 在合約調(diào)試過(guò)程中輸出相關(guān)調(diào)試信息。其中， msg 信息會(huì)在節(jié)點(diǎn) log 日志里打印出來(lái)。這里有個(gè)前置條件，即 Ontology 本地測(cè)試節(jié)點(diǎn)啟動(dòng)的時(shí)候日志級(jí)別需要設(shè)置為 debug 模式。

另外， 開(kāi)發(fā)者也可以使用 runtime：：notify（msg） 在合約調(diào)試過(guò)程中輸出相關(guān)調(diào)試信息。該方法會(huì)將打印出來(lái)的信息保存到鏈上，可以通過(guò) getSmartCodeEvent 方法從鏈上查詢。

二、 總結(jié)

Ontology 作為領(lǐng)先公鏈，率先支持 Wasm 合約，為 Wasm 技術(shù)的成熟貢獻(xiàn)力量。同時(shí)，我們也歡迎更多的 Wasm 技術(shù)愛(ài)好者加入本體開(kāi)發(fā)社區(qū)，共同打造技術(shù)生態(tài)。