技术视点 | 如何基于 Wasm合约使用 Runtime API ?

技术视点 | 如何基于 Wasm合约使用 Runtime API ?

本体Ontology 发布在 海盗号 11825

经过数月在测试网上的稳定运行,Wasm 功能正式登陆主网。在往期的技术视点中,我们已推出多部 Ontology Wasm 相关教程,社区伙伴们纷纷表示受益匪浅。

本期我们将介绍如何基于 Wasm合约使用 Runtime API,相信你会有所收获。

图 | 网络
Runtime API 简述

Ontology Wasm 合约开发工具库 ontology-wasm-cdt-rust 里面 Runtime 模块封装了合约与 Ontology 链交互的 API 方法。通过这些 API 方法,合约可以获得链上的数据,或者将合约中的数据保存到链上,以下是这些 API 方法的简单描述。

接下来,我们来具体讲述下这些 API 的使用方法。在此之前,开发者可以从 GitHub 上 clone 下来我们的合约模板,然后在lib.rs文件中添加合约逻辑代码。
Runtime API 使用方法

首先,开发者仅需要通过下面的方式将 Runtime 模块引入到当前合约中:
use ontio_std::runtime;
然后就可以通过 Runtime 引用以上所有的 API 接口。

1. timestamp() 

timestamp()方法获得当前的时间戳,即返回调用该函数的 Unix 时间,单位为秒。调用示例:

let t = runtime::timestamp();
一个简单的示例代码如下:
#![no_std]
extern crate ontio_std as ostd;
use ostd::abi::{Sink, Source};
use ostd::prelude::*;
use ostd::runtime;

fn hello() -> u64 { runtime::timestamp()//取得当前时间戳 }

#[no_mangle] fn invoke() { let input = runtime::input();//获得输入方法名和方法参数 let mut source = Source::new(&input);//构造反序列化实例 let action = source.read().unwrap_or_default();//读取方法名 let mut sink = Sink::new(16);//构造序列化实例 match action { "hello" => { sink.write(hello());//将hello()返回的结果序列化 } _ => panic!("unsupported action!") } runtime::ret(sink.bytes());//将序列化后的结果返回给调用方 }


在下面的 API 方法讲述中,我们将省略具体例子,只介绍 API 方法的作用。小伙伴们可以采用类似于上述例子的代码进行试验。

2. block_height

block_height函数获得当前区块链网络的区块高度,调用示例:

let t = runtime::block_height();
3. address
address 获得当前合约的地址,调用示例:
let t = runtime::address();
4. caller

caller 获得调用方的合约地址,主要用于跨合约调用的场景,比如合约 A 调用合约 B 的应用场景, 在合约 B 中就可以调用该方法获得调用方合约 A 的地址:

let t = runtime::caller();
5. entry_address

entry_address 获得入口合约地址,比如有这样的应用场景,合约 A 通过合约 B 调用合约 C的方法,此时,在合约 C 中就可以通过该方法拿到合约 A 的地址,调用示例:
let t = runtime::entry_address();
6. current_blockhash

current_blockhash 获得当前区块的 hash,示例如下:

let t = runtime::current_blockhash();
7. current_txhash

current_txhash获得当前交易的 hash,示例如下:
let t = runtime::current_txhash();
8. sha256

sha256计算输入参数的 hash256值:

let h = runtime::sha256("test");
9. check_witness

check_witness(from)校验是否含有该地址的签名:
  • 验证当前的函数调用者是不是含有 from 的签名 。若是(即签名验证通过),则函数返回 true;
  • 检查当前函数调用者是不是一个合约。若是合约,且是从该合约发起去执行函数,返回 true。即,验证 from 是不是caller的返回值。其中,caller()函数可以得到调用当前智能合约的合约哈希值。
assert!(runtime::check_witness(from));
10. notify
notify函数将合约中事件推送到全网,并将其内容保存到链上,调用方法如下:
runtime::notify("notify".as_bytes())
在合约中推送事件时,可以自定义一个事件函数,加上#[event]注解即可。我们的工具库中提供了该属性宏,需要通过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方法可以在合约执行发生致命错误的时候立即终止交易的执行,然后回滚当前的交易。该方法在跨合约调用的场景很重要,比如在如下的应用场景中,合约 A 中的方法 a 调用合约 B 中的方法 b,其中合约 A 的 a 方法在调用合约 B 的 b 方法之前会保存一些数据到链上,但是在调用合约 B 的 b 方法时,发生了致命的错误,需要回滚合约 A 中 a 方法执行过程中保存的数据,此时就需要在合约 B 的 b 方法中应用panic方法实现该功能。
runtime::panic("test");
结语

本文主要讲解了 Runtime 模块的 API,该模块提供了与链交互的功能,其中 notify 用于合约中推送事件,开发者可以使用自定义事件的方式推送事件,而不是直接使用 notify 方法。use ostd::macros::event属性宏提供了更加友好的事件推送机制。在跨合约调用的过程中,panic方法在异常处理中具有非常重要的。
下一期我们将介绍如何实现 Wasm 合约与 NeoVM 合约及 Native 合约之间的相互调用,欢迎大家关注学习。

文章标签: 区块链技术
评论
登录 账号发表你的看法,还没有账号?立即免费 注册