Qtum:x86 SimpleABI 协议与 abigen 工具
杨小公子君莫邪
发表于 2022-12-5 05:48:51
154
0
0
这是 Qtum x86 合约的一个轻量级的 ABI。这个 ABI 规范称为 Simple ABI。+ A5 f1 [1 }; N- H1 m1 m
: r. a: p, L8 _2 T% S: a
SimpleABI 只编码字段值(flat values)和简单数组(simple arrays)。它不是智能合约 ABI 的终极状态,只是实现起来非常简单,最重要的是使用起来非常顺手。" n* U- H9 C+ _, H. q% n# G
abigen 可以以下 3 种方式运行:
1
Dispatcher -- 生成代码,用于解码 SCCS 上的 ABI 数据并调用适当的函数
2# I& b* p* L% X: S# C( H
Caller -- 为指定的合约生成代码,可使用 SimpleABI 轻松调用外部合约
39 [4 p! s' k3 h0 `: T. e
Encoder -- 用一系列参数生成合约调用的数据。人们可以简单地用 sendtocontract 等即可调用 SimpleABI 合约0 h* B8 x) m6 G* W6 b Q0 L! g
: r- G) N" T. u0 W k1 z; A6 r
与 Solidity 的区别是什么?/ A& R2 k0 d" @- N& M; ^2 L7 k4 j
Solidity 调用外部合约的 ABI 直接内建在语言中。Solidity 专门用于构建智能合约,因此这么设计是有一定道理的。
但是,x86 VM 支持多种不同的语言,这些语言不是专门为智能合约而设计的。这意味着我们必须在这些现有语言之上构建 ABI。使用复杂的语言分析库等或许可以自动构建适当的 ABI,但很难用,限制大,且不能在语言之间移植。
我们正在设计的这个新VM,应该是可以从你的 C 语言合约调用另一个 C 语言合约,也可以从你的 C++ 合约调用一个 Rust 合约等等。
9 m* Z r/ ]" F3 u: Z
这个 ABI 比 Solidity 的 ABI 简单得多,但与 Solidity 不同,它是显式调用的,即它只能调用在 ABI 文件中直接指定的函数。因此,这个 ABI 往往需要更多的模板代码来处理简单的事情,比如调用函数,甚至只是解码发送的 ABI 数据......所以,一个理想的工具是代码生成。我们可以使用模板代码来生成函数,这样开发人员实际中使用函数只要几行代码。$ ~' R" I4 m8 j- z1 E
9 n2 @3 }# k& a& Z7 O5 N
与 EVM 暴露“调用数据”的方式不一样的是,x86 VM具有“智能合约通信堆栈”(SCCS,smart contract communication stack)。我们只需要一个在合约之间传递和返回数据的栈,没必要解析一个大的扁平字节数组。* d [. i7 J$ }- Z; c. X
# E' k& }. c) _9 |
这大大简化了智能合约的实现,这个 ABI 就是为了利用这一点而设计的。SCCS 可以将每个参数视为栈上的一个子项,而不需要解码一大块数据。这也使得调用合约变得更容易,因为不再需要构造一大块数据。大块数据往往需要分配足够内存,将所有元素放入一个连续的内存区域;而 SCCS 可以使用许多较小的内存实现。
) s- [: R) f* r9 L3 ?+ ~8 |5 M
ABI 规范
ABI 规范很简单,每个函数 1 行。它还充当合约函数前后堆栈的表。即使不使用abigen,这也是一种有用的规范,可以手动实现对合约数据的编码解码的堆栈操作。; z$ v9 i9 v _) x2 m @0 U! B
类似 ERC20 的接口示例:4 G" Y$ T# P" _
ERC20Interface8 v, V: R5 Z' b4 m
# The first non-comment line is the name of the interface and used for all codegen prefixes1 n; k% ]- r# M$ a; l" S# h3 i
# this is a comment
selfBalance -> balance:uint64
address:UniversalAddress balance:fn -> balance:uint64" t; I, N3 q( j
addressTo:UniversalAddress value:uint64 send:fn -> newFromBalance:uint64 newToBalance:uint64
address:UniversalAddress buyTokens:fn -> newBalance:uint64 -- payable
2 B1 g& B% }$ ?3 b% r3 g" k& }
也可以使用数组:. A( b; b( h# A$ h
ArrayExample: ~6 b; E# A2 Q5 B5 C" S+ H
#declares someFunction takes an array of 20 bytes exactly
someData:uint8[20]:fixed someFunction:fn -> void
#declares someFunctionDynamic that takes an array of no more than 20 bytes8 |* ^4 Z' }- F. D) c$ ]
someData:uint8[20]:max someFunctionDynamic:fn -> void
支持的基本类型:5 Z; Y+ b# R* z% P
uint8; m) Q9 E2 {, X8 @
uint16
uint32
uint64* U3 t. N' k2 x/ ]1 T# R
int8
int16
int32
int64
char# u6 G( I* j3 b1 p
void -- 仅对返回数据有效。对应无返回数据
fn -- 特殊* s% f1 k) x0 x& e
更高级的类型:
UniversalAddress
基本类型尽可能传值使用。高级类型传引用。数组传引用,并指向值,值包括高级类型。! U" W- L1 q) `7 {- K
数组类型:
fixed(默认) - 数据必须是指定的确切大小2 t! D" q# B! I! Z* ^8 r
max(指定最大) -数据不能大于指定的大小。如果它较大,则会触发错误+ l3 w! Y/ r# n$ o, o' \ z
dynamic(动态) - 任何长度都有效(使用前 uint8[])有效
clip(截断) - 如果数据大于指定的大小,那么它会被截断,不会触发任何错误
函数编号
函数编号的构造方式与 Solidity 类似。 sha256 哈希由函数行和接口名称组成,哈希值截断到后面 4 个字节作为函数号。* r) ]5 h+ a4 j' i/ B7 @ e
% [& q" P1 w+ B* M# u4 B, a0 g8 Y9 J* C
内存分配
大于 256 字节的数组都使用堆分配而不是栈。
7 I6 o. T# W4 k) Z1 p: |- ~' T7 Q
接口
一个合约可以实现多个接口。每个接口使用该接口名称前缀来生成代码。对于具有相同名称的多个函数,只要它们由不同名称的接口定义,就可以同时存在于一个合约内。
包括其他接口:
MyContract
:interfaces ERC20, ERC721, MyParentContract+ c0 O- H- ?& o- W
abigen 自动查找当前目录中的 ABI 文件名,并实现指定全局接口目录的方法。
语言
现在只支持 C. 之后会支持 Rust。
示例(手动生成) C代码:& O/ H: r5 h! K- ?* Q3 X' _
struct simpletoken_Send_Params{& i( ^2 D: S: X8 E% [5 |0 p5 D
UniversalAddressABI* address;
uint64_t value;/ g/ k8 j& W2 f: m& o! {
};( g& _( R* o0 e- P% p+ `5 w
struct simpletoken_Send_Returns{0 q7 y" P' l. Z( t
uint64_t recvvalue;6 g/ [- q! _( c8 i
uint64_t sendervalue;
};
void decodeABI(){. ?" C6 k. {# a; S2 X+ g2 `
//format: address:address value:uint64 SEND -> sendervalue:uint64 recvvalue:uint64# w* @6 D* L3 Z* N+ N
//format: address:address BALANCE -> balance:uint6" X# U" B7 e! t! n9 `; h
//format: SELFBALANCE -> balance:uint64' O6 Q6 p. t ^3 w4 X, ~
uint32_t function = 0;
if(qtumStackItemCount() == 0){
//fallback function... ( m, U0 k& f4 c7 \; y8 M7 ^
}
QTUM_POP_VAL(function);* y# l9 E; N( D% X5 r
switch(function){
case CONTRACT_SELFBALANCE:
{
uint64_t resBalance;
selfBalance(&resBalance);
QTUM_PUSH_VAL(resBalance);
return;1 U7 b0 Y9 _) l+ S/ m: s0 U/ r6 j
}
case CONTRACT_BALANCE:
{
UniversalAddressABI address;
QTUM_POP_VAL(address);
uint64_t resBalance;
balance(&address, &resBalance);
QTUM_PUSH_VAL(resBalance);+ [2 z* [ H E3 A5 b- m" k- w
return;8 y: t5 E5 n3 T8 O o
}9 A4 k! S% P- ^: J0 g" @5 f% N
case CONTRACT_SEND:
{
struct simpletoken_Send_Params params;' G6 w0 f4 ]3 D8 u1 B
UniversalAddressABI __tmp1;* [' S5 W; s- w$ a' [; J
params.address = &__tmp1;
/ S2 z; @2 [' u ~$ t" m7 c
QTUM_POP_VAL(params.value);6 x* m! H" w% s' U7 e1 |/ _1 x
QTUM_POP_VAL(__tmp1);) ], b7 X0 G: k
struct simpletoken_Send_Returns returns;2 o$ D# A5 J% D/ F% l: N: G$ F
send(¶ms, &returns);) O& f W) o. U# R
QTUM_PUSH_VAL(returns.sendervalue);
QTUM_PUSH_VAL(returns.recvvalue);
return;+ A6 ]( S6 a7 J9 {# n, J/ \- N6 n
}
default:- Z% e/ B/ `8 ?' C
qtumError("Invalid function");
return;4 _7 ]+ g" }' Y! X
}( u! C4 F* R: o( x0 X- @! u0 a
}; _& P5 }2 d' R7 M1 \# \
//format for this:
//address:address value:uint64 SEND -> sendervalue:uint64 recvvalue:uint64$ n3 g2 R+ Z7 K/ K/ E* v' F
struct QtumCallResultABI simpletoken_Send(const UniversalAddressABI* __contract, uint64_t __gasLimit,
const struct simpletoken_Send_Params* params,
struct simpletoken_Send_Returns* returns0 V" }* F( J' P5 x, E- J6 H% e
)1 ]9 X: X! x- Y- M2 f
{& A' x# A* i, T# P4 p. Q+ M
if(__gasLimit == 0){
__gasLimit = QTUM_CALL_GASLIMIT;
}4 n. ~0 B7 {9 o# n! |6 E) v# @
qtumStackClear();1 M* X7 K t( U# {5 m9 |
QTUM_PUSH_VAL(*params->address);
QTUM_PUSH_VAL(params->value);
uint32_t f = CONTRACT_SEND;8 B9 X1 ]. X4 u8 x
QTUM_PUSH_VAL(f);
struct QtumCallResultABI result;
qtumCallContract(__contract, __gasLimit, 0, &result);
if(result.errorCode != 0){: {' J: G4 m2 U5 S
return result;4 W. R% |' }1 }5 g4 r
}% k) q" u0 b. ~7 p% v: {
QTUM_POP_VAL(returns->recvvalue);3 k* _( H$ T" {' D7 [* ?4 t2 H
QTUM_POP_VAL(returns->sendervalue);
return result;
}
- W$ C! O3 n! U/ F J' | o
其他* R' q x. R" n1 P; V, D
对于不支持内置数组大小的语言,不定长数组数组也会有个 "length" 参数暴露给 Caller 和 Dispatcher。
成为第一个吐槽的人