【eos全家桶系列】eos系统合约介绍 — 提案合约eosio.msig (下)

96
guaiguaihw
2018.09.10 11:12* 字数 1374

简介

本篇将为大家介绍eosio.msig的源码实现,合约代码库详见:eosio.msig。eosio.msig主要有propose、approve、unapprove、cancel、exec、invalidate这几种方法,下面会详细逐一介绍每种方法的功能和实现细节。

主要合约方法

eosio.msig合约,在eosio.msig.hpp头文件中,主要定义了以下六个合约方法:

- propose:提出提案

- approve:通过提案

- unapprove:不通过提案

- cancel:取消提案

- exec:执行提案

- invalidate:撤回对之前所有该账户通过、但未被最终执行的提案的通过授权

eosio.msig合约头文件

propose方法

propose方法主要功能是提出提案,对应上篇提到的 `cleos multisig propose` 命令,传参如下:

- proposer:提案账户

- proposal_name:提案名

- requested:提案通过所需权限

- trx:提案具体执行的交易内容

为了节省资源开销,propose方法并不会根据 `cleos multisig propose` 传入的参数一一做解析,而是直接解析input data

propose方法获取提案详细内容

之后,会做一系列前置检验工作:proposer提案账户授权是否正确、交易是否超时、propose_name是否存在、提案通过所需权限是否正确等

propose的前置检验

之后,将提案和提案合约的内容存表,将提案通过所需的权限存入requested_approvals表中,我们上篇文章所提到 `cleos get table eosio.msig <proposer account> approvals` 命令查询的就是这张表

propose提案数据、提案所需通过权限存表

approve方法

approve方法的主要功能是通过提案,对应上篇提到的 `cleos multisig approve` 命令,传参如下:

- proposer:提案人

- proposal_name:提案名

- permissions:使用哪个权限批准这个提案

首先,系统会查找提案合约内容,查找 requested_approvals 表中需要通过的权限中,是否有和传入permission匹配项。若有匹配项,将此权限加入 provided_approvals 表,即表示该权限通过此提案,并从 requested_approvals 表中移除该权限。

approve方法实现细节

unapprove方法

unapprove方法的主要功能是不通过提案,对应上篇提到的 `cleos multisig unapprove` 命令,传参如下:

- proposer:提案人

- proposal_name:提案名

- permissions:使用哪个权限拒绝这个提案

首先,系统会查找提案合约内容,查找 provided_approvals 表中通过的权限中,是否有和传入permission匹配项。若有匹配项,将此权限加入requested_approvals 表,即表示该权限还没通过此提案,并从 provided_approvals 表中移除该权限。

unapprove方法实现细节

cancel方法

cancel方法的主要功能是取消提案,对应上篇提到的 `cleos multisig cancel` 命令,传参如下:

- proposer:提案账户

- proposal_name:提案名

- canceler:取消账户

首先,先查找表获取提案内容。如果canceler账户和提案账户不同,则在提案交易过期之前,canceler都不能取消提案。若能取消,将提案从表中移除。

cancel方法实现细节


exec方法

exec方法的主要功能是执行提案,对应上篇提到的 `cleos multisig exec` 命令,传参如下:

- proposer:提案账户

- proposal_name:提案名

- executer:执行账户

首先,需要做前置检查,检查交易是否过期

前置检查

然后,查 provided_approvals 表获取通过提案交易的权限们,对比 inv_table 表,如果权限不在 inv_table 表中或者 last_invalidation_time 已经小于当前时间,代表权限有效,放入approvals表中。inv_table 表的用途在下一个invalidate方法中介绍

获取通过提案的权限们

最后,执行提案。如果交易执行权限检验无误,会发起一个defer延迟合约,去执行提案交易。如果执行成功,`cleos get actions <executer account>` 会产生两条actions,一条是exec的交易,一条是提案执行的交易。

exec方法的详细实现

invalidate方法

invalidate方法的主要功能是:如果account之前通过的提案还未执行,就可以使用该方法将提案一键设置为无效。这个方法主要是解决:账户权限变更时,之前通过但未执行的提案一旦执行会盗取账户权限的问题,详见issue。该方法传参如下:

- account:提案的批准账户

该功能的实现非常简单,首先,inv_table 是用来存放权限的,它的两个字段 accountlast_invalidation_time 分别是账户名和账户权限最近失效时间。last_invalidation_time 时间之前,account的提案批准权限都不可用,在该时间之后account的提案批准权限才能生效。

因此,如果想使account之前审批通过的所有提案都失效的话,就将 last_invalidation_time 设置为当前时间即可。exec方法在执行之前会检查 inv_table,则包含在 inv_table 中的account,即便批准了该提案,该批准也会作废

invalidate方法实现细节

后记

不好意思,最近因为杂七杂八的事情,很久没更新博文,以后会更新的稍微勤快点,请各位看客见谅。eosio.msig合约的介绍就到这里。后面的文章,将为大家介绍eosio.system合约,该合约是投票选举超级节点的核心合约,尽请期待!

日记本