手把手教你Wasm合约开发(C++篇)
放弃六月们
发表于 2023-1-9 00:14:24
181
0
0
一、Hello World6 W9 b; ~- w' K
按照惯例,我们还是从一个 Hello world 开始5 V ?& c8 D2 X2 G+ g$ v/ Q3 W
#include#include: P: l4 d$ i/ q! q2 R9 R4 R
using namespace ontio;class hello:public contract {0 x w C' x9 b" s& D, T3 I( C
public:
using contract::contract:
void sayHello(){
printf("hello world!");2 o o2 O7 u3 P' @+ w3 j
}' w5 c- ^% Q( B/ |8 K8 g4 m# i% X, {! z
};
ONTIO_DISPATCH(hello, (sayHello));9 ^( u, H4 _; Q2 }) Q
1.1 合约入口
Ontology Wasm CDT 编译器已经对入口和参数解析进行了封装,所以开发者不需要重新定义入口方法。接下来是定义合约的对外接口,这是智能合约对外提供服务的方法。
ONTIO_DISPATCH(hello, (sayHello));
在上面的例子中, 我们暂时只支持 sayHello 这个方法:
printf("hello world!");
这个“Hello world!”会在节点的日志中以调试信息打印出来。在实际的应用中, printf 只能用作调试的目的, 一个实际的智能合约,需要实现更多更复杂的功能。
1.2 智能合约 API$ o' T1 }# W [3 y6 P1 C& Z X
Ontology Wasm 提供如下 API 与区块链的底层进行交互:$ s' e* X5 |% F1 \& t/ r% }/ Y8 k
二、红包合约" |8 B8 T$ w2 q- E% U
下面我们通过一个更加复杂的例子来演示如何通过这些 API 来开发一个完整的 Wasm 智能合约。% v5 |. D- }; o4 A$ f8 C" P
很多情况下我们都会通过各种 App,如微信等聊天工具发红包。我们可以给朋友发送红包,也可以抢其他人发送的红包,收到的钱会记入到个人微信账户中。
类似于微信的流程,我们将尝试创建一个智能合约。用户使用该合约,可以发送 ONT,ONG 或者是标准的 OEP-4的 Token 资产红包给他的朋友们,而朋友们抢到的红包可以直接转入到他们的钱包账户中。 X J9 Y( u8 e' `2 O0 z1 h4 o- j
2.1 创建合约& T- s6 ^2 W* P$ d. H
首先,我们需要新建合约的源文件,暂且命名为 redEnvelope.cpp。这个合约我们需要三个接口:1 G* i4 n2 v4 Q5 ^3 I4 y7 w0 A8 ?
createRedEnvelope: 创建红包
queryEnvelope: 查询红包信息) _) |& ]% U9 }5 s" M
claimEnvelope: 抢红包
#include
using namespace ontio;
class redEnvelope: public contract{
}
ONTIO_DISPATCH(redEnvelope, (createRedEnvelope)(queryEnvelope)(claimEnvelope));
我们需要在存储中保存一些关键的数据。在智能合约中, 数据以 KV 的形式保存在该合约的上下文空间中,这些数据的 KEY 需要设置前缀以便于后面的查询。下面定义了三个不同的前缀供使用:' t6 b- t8 f a% r' K" b; B
std::string rePrefix = "RE_PREFIX_";0 S) ?3 b, s3 z5 [
std::string sentPrefix = "SENT_COUNT_";
std::string claimPrefix = "CLAIM_PREFIX_"4 b! n2 N, `0 l4 G
因为我们的合约支持 ONT 和 ONG 这两种 Ontology 的原生资产, 我们可以预先定义好这两种资产的合约地址。不同于标准的智能合约, Ontology 原生合约(native contract)的合约地址是固定的,而不是根据合约代码的 hash 计算而来的。6 B) R5 e: W$ L& h+ p7 Q
address ONTAddress = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1};' {1 [" @ ~/ e/ I& R" ~# m, j
address ONGAddress = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,2};
我们需要在合约中保存红包的信息, 如红包的资产信息(token 的合约地址, 红包的总金额, 红包的个数等等)
struct receiveRecord{- B. g3 l/ O Q- e$ ]0 h9 X3 O
address account; //用户地址
asset amount; //抢到的金额( C' n# F1 o& P- [
ONTLIB_SERIALIZE(receiveRecord,(account)(amount))
};3 r+ R4 ?7 p- M+ m/ x+ h
struct EnvelopeStruct{
address tokenAddress; //资产token的地址
asset totalAmount; //红包总金额
asset totalPackageCount; //红包总数
asset remainAmount; //当前剩余的金额& X' B7 `0 r3 m) i
asset remainPackageCount; //当前剩余的红包数
std::vector records; //已经抢完的记录
ONTLIB_SERIALIZE( EnvelopeStruct, (tokenAddress)(totalAmount)(totalPackageCount)(remainAmount)(remainPackageCount)(records) ). k% n7 I) n' ~9 j
};
其中,
ONTLIB_SERIALIZE(receiveRecord,(account)(amount))- q: f' _1 r& y& `! T
是由 Ontology Wasm CDT 定义的宏操作,用于在将 struct 存储前进行序列化的操作。
2.2 创建红包
准备工作差不多了,下面我们开始开发具体的接口逻辑。
创建红包需要指定创建者地址, 红包数量, 红包金额和资产的合约地址:
bool createRedEnvelope(address owner,asset packcount, asset amount,address tokenAddr ){" u' v9 p3 n) G% i
return true;
}
检查是否有创建者的签名, 否则交易回滚退出:
ontio_assert(check_witness(owner),"checkwitness failed");: n( v; R; U/ p- d$ E6 j
NOTE: ontio_assert(expr, errormsg):当 expr 为 false 时, 抛出异常并退出。' H/ n& x$ O" a
如果红包资产是 ONT,由于 ONT 的不可分割性(最小为1个 ONT), 红包的金额要大于或等于红包的数量,保证每个红包最少有1个 ONT:2 K5 T& {! h- G, y+ P* t T! l
if (isONTToken(tokenAddr)){+ S0 S1 s# a2 q
ontio_assert(amount >= packcount,"ont amount should greater than packcount");
}+ `6 y& ^# {; ^7 s- y3 M& ~2 R! x6 s
对于每个红包的创建者,我们需要记录一下他发送红包的总数量:- q& d {" k, x, J1 k2 B1 \
key sentkey = make_key(sentPrefix,owner.tohexstring());
asset sentcount = 0;
storage_get(sentkey,sentcount);
sentcount += 1;8 G* l2 k# m+ Z
storage_put(sentkey,sentcount);/ h1 J; U) \- T3 T' x! x( h
生成红包 hash, 这个 hash 就是之后标识这个红包的唯一 ID:) z* C/ _8 H. ?4 U# b
' @: u! w6 u+ e" j2 L* O4 @
H256 hash ;/ C0 I# W8 R. r2 a, q M
hash256(make_key(owner,sentcount),hash) ;
key rekey = make_key(rePrefix,hash256ToHexstring(hash));
根据 token 资产的类型,将资产转入合约中,self_address()可以取得当前执行的合约地址, 我们根据用户输入的 token 类型,将指定数量的 token 转入合约:
address selfaddr = self_address();9 i, ?5 n4 {3 J" I
if (isONTToken(tokenAddr)){
bool result = ont::transfer(owner,selfaddr ,amount);* M% `' T: s& |: u1 }( R' ^
ontio_assert(result,"transfer native token failed!");
}else if (isONGToken(tokenAddr)){
bool result = ong::transfer(owner,selfaddr ,amount);
ontio_assert(result,"transfer native token failed!");
}else{
std::vector params = pack(std::string("transfer"),owner,selfaddr,amount);. _0 [* Q- M; q- z2 u) I" ~
bool res;
call_contract(tokenAddr,params, res );
ontio_assert(res,"transfer oep4 token failed!");! y* T5 {* M. F! s' [
}
NOTE 1:对于 ONT 和 ONG 这两种原生资产, Ontology Wasm CDT 提供了ont::transfer API 进行转账操作;而 OEP-4类的资产,需要按照普通的跨合约调用方法来转账。
NOTE 2:和普通的钱包地址一样, 合约地址也可以接受任意类型的资产。但是合约地址是由合约编译后的二进制代码 hash 产生的,所以没有对应的私钥,也就无法随意操作合约中的资产,如果你没有在合约中设置对资产的操作,就意味着你将无法控制这部分资产。
将合约的信息保存在存储中:4 ~: ` @: O$ e- s8 H" ]/ t
struct EnvelopeStruct es ;
es.tokenAddress = tokenAddr;
es.totalAmount = amount;
es.totalPackageCount = packcount;
es.remainAmount = amount;
es.remainPackageCount = packcount;: c$ I* Y. E# C0 v, A+ A
es.records = {};
storage_put(rekey, es);5 t. H9 }- @) b/ ?$ ?+ g( f
发送创建红包的事件。对于智能合约的调用是一个异步的过程,合约会在执行成功后发送一个事件来通知客户端执行结果,这个事件的格式可以由合约的编写者来指定。! S' K" ?( q$ t
char buffer [100];/ j; F# k. K; v: ?) s. c' }
sprintf(buffer, "{\"states\":[\"%s\", \"%s\", \"%s\"]}","createEnvelope",owner.tohexstring().c_str(),hash256ToHexstring(hash).c_str());
notify(buffer);6 K/ J& q$ B$ k6 T8 P
return true;" M6 j+ c: q+ h! ]+ O
一个简单的红包就创建完成了, 下一步我们需要实现如何查询这个红包的信息.# f6 Y0 B& {& x* @
2.3 查询红包
查询红包的逻辑非常简单, 只需要将存储中的红包信息取出并格式化返回即可:# Y/ l) ^$ r0 L! s/ \+ O' h
std::string queryEnvelope(std::string hash){
key rekey = make_key(rePrefix, hash);$ l1 j! ] u3 |( }
struct EnvelopeStruct es;& B O5 ^, v# e$ N0 B
storage_get(rekey, es);7 ~, c/ `4 |: m) X" l0 y
return formatEnvelope(es);' q+ o2 H7 A1 E4 f! D9 Y
}- D/ P1 Y/ J ?8 P
NOTE:对于智能合约的只读操作(例如查询), 可以通过预执行(pre-exec)来读取结果。不同于普通的合约调用,预执行不需要钱包的签名,同时也就无需花费 ONG。最后,其他用户可以根据 hash(红包的 ID)来领取(抢)这个红包了。% Y# }. T+ z6 b6 O3 J
2.4 领取红包
我们已经把资产成功地转入到智能合约中了, 接下来就可以把这个红包的 ID 发送给你的朋友们让他们去抢红包了。8 j/ X; Q' X2 A' ~1 x
领取红包需要输入领取人的账户和红包的hash:7 D, O1 O: r. i' c: R
! e& s1 S7 A9 I9 B( U% I
bool claimEnvelope(address account, std::string hash){. y9 w7 r" M2 @; _
return true;6 K$ } R9 t" A8 U) r6 ^% X4 |
}
同样, 我们需要验证领取账户的签名, 不允许替其他人抢红包, 而且每个账户每个红包只能抢一次:2 W/ n2 t" t; Z/ H0 {8 @) i9 ^/ B
ontio_assert(check_witness(account),"checkwitness failed");# F6 {2 `% a: z8 h" h
key claimkey = make_key(claimPrefix,hash,account);
asset claimed = 0 ;
storage_get(claimkey,claimed);2 \$ e- f( x: ^" f% A9 n4 Q
ontio_assert(claimed == 0,"you have claimed this Envelope!");/ _) h5 @5 i. ]1 V1 q/ W: V# V
按照 hash 从存储中取出红包的信息, 判断这个红包是否没有被抢完:
key rekey = make_key(rePrefix,hash);
struct EnvelopeStruct es;! E; ?6 T- C" K3 X1 v: ^5 S T
storage_get(rekey,es);: t- ~5 W W. p- e
ontio_assert(es.remainAmount > 0, "the Envelope has been claimed over!");
ontio_assert(es.remainPackageCount > 0, "the Envelope has been claimed over!");) ~* {! k& g+ p9 @' M* y- U- C
新建一条领取的记录:
struct receiveRecord record ;# U& X' r. C% u% e0 K. \
record.account = account;
asset claimAmount = 0;
计算本次领取红包的资产数量。如果是最后一个红包, 数量为剩余的金额, 否则根据当前区块 hash 计算随机数,确定本次领取的数量, 并更新红包信息:9 \2 k A D' T4 u$ `# x
% `' _: @2 f5 R1 E" u+ d
if (es.remainPackageCount == 1){! _0 i% t/ H& w
claimAmount = es.remainAmount;. ^9 A% t; E& k8 d2 y
record.amount = claimAmount;
}else{
H256 random = current_blockhash() ;
char part[8];
memcpy(part,&random,8);2 I/ C) @- L% I o3 N" A8 U- W
uint64_t random_num = *(uint64_t*)part;
uint32_t percent = random_num % 100 + 1;% I. v! o3 c; }* w3 t8 Y: U
claimAmount = es.remainAmount * percent / 100;
//ont case
if (claimAmount == 0){. p- n& h, `9 u! I
claimAmount = 1;
}else if(isONTToken(es.tokenAddress)){
if ( (es.remainAmount - claimAmount) 根据计算结果, 将对应资产从合约中转到领取的账户:
address selfaddr = self_address();" x; U) n! o0 }( X; j6 d1 Q
if (isONTToken(es.tokenAddress)){
bool result = ont::transfer(selfaddr,account ,claimAmount);
ontio_assert(result,"transfer ont token failed!");
} else if (isONGToken(es.tokenAddress)){
bool result = ong::transfer(selfaddr,account ,claimAmount);; I9 C6 B0 Y9 E* J1 |! Q. }! u
ontio_assert(result,"transfer ong token failed!");* @1 M, n1 O0 I7 [& Z$ p' a5 P
} else{
std::vector params = pack(std::string("transfer"),selfaddr,account,claimAmount);' n6 f d# [1 n+ I, q% m
bool res = false;, E. {% T' ?3 i3 {* A2 S
call_contract(es.tokenAddress,params, res );
ontio_assert(res,"transfer oep4 token failed!");/ j' U0 c5 A* _
}8 H- d2 D7 P8 t$ L# e
记录领取的信息, 将更新后的红包信息写回存储并发送通知事件: t6 }. w5 N9 w7 |+ f; ]) U
storage_put(claimkey,claimAmount);5 R1 O' P2 N/ o1 z
storage_put(rekey,es);
char buffer [100];7 Y2 g7 j2 J5 p, {1 S1 k
std::sprintf(buffer, "{\"states\":[\"%s\",\"%s\",\"%s\",\"%lld\"]}","claimEnvelope",hash.c_str(),account.tohexstring().c_str(),claimAmount);/ j/ a# W9 |/ d) x, f9 y. X v* I
notify(buffer);; B$ v% A5 ^( c6 c( q. f
return true;
如前面所说,这个合约只能通过 claimEnvelope 这个接口将资产转出合约。所以,合约中的资产是安全的,任何人都无法随意的取走里面的资产。% W2 T7 K- C' B( A+ E7 p2 Z
至此, 一个简单的红包合约逻辑完成, 完整的合约代码如下:https://github.com/JasonZhouPW/pubdocs/blob/master/redEnvelope.cpp$ f$ D5 C) Q% I2 t- P. ~* }; k+ h2 i
2.5 合约测试2 a$ j( A- \, ^6 ?1 ~6 U0 p4 q
合约测试可以有两种方法:
使用 CLI) [6 W! I N9 h! p3 g, Y1 P
请参考:https://github.com/ontio/ontology-wasm-cdt-cpp/blob/master/How_To_Run_ontologywasm_node.md0 h, ^- j$ S1 _( f. C# B' X
使用 Golang SDK
请参考:https://github.com/ontio/ontology-wasm-cdt-cpp/blob/master/example/other/main.go5 M0 d& W, _8 T* C$ x) L
三、总结2 C$ f) S N, }+ N8 V/ ?4 F: b0 |
本示例只是为了展示如何编写一个完整的 Wasm 智能合约, 如何通过调用 API 和底层的区块链进行交互。如果要作为正式的产品, 还需要解决红包的隐私问题: 所有人都可以通过监控合约的事件来取得红包的 hash, 意味着每个人都可以抢这个红包。一种比较简单的解决方法,就是在创建红包时指定哪些账户能够领取。如果有兴趣, 您也可以尝试修改测试一下。
我们欢迎更多的 Wasm 技术爱好者加入本体开发社区,共同打造技术生态。
成为第一个吐槽的人