Conflux引入了一些内置的内部合约,以便更好地进行系统维护和链上治理。而本文档将介绍如何使用这些内部合约。
后续文档使用 js-conflux-sdk 作为案例
一、通过赞助使用合约的方法
Conflux实现了一种赞助机制以补贴用户使用智能合约。因此,一个账户余额为0的新用户,只要执行赞助(通常由Dapps的运营商赞助),就能够直接调用智能合约。 通过引入内置的 SponsorControl 合约已记录对智能合约的赞助信息。
SponsorControl 智能合约为每个用户建立的合约维护以下信息:
sponsor_for_gas
: 为提供燃料费用补贴的账户;sponsor_for_collateral
: 为提供存放抵押补贴的账户;sponsor_balance_for_gas
: 可用于燃料费用补贴的余额;sponsor_balance_for_collateral
: 可用于存放抵押补贴的余额;sponsor_limit_for_gas_fee
: 赞助者愿意为每笔交易提供的资助上限;whitelist
: 为合约愿意资助的正常账户清单,特殊的全0地址特指所有的正常账户。只有合约本身才有权更改该清单。
有两类资源可以被赞助:燃料费用及存储抵押物。
- 对于燃料费用: 如果一笔交易使用非空的
sponsor_for_gas
调用智能合约且交易发送者处于合约的whitelist
列表内,且交易指定的燃料费用在sponsor_limit_for_gas_fee
范围内,交易的燃料消耗将从合约的sponsor_balance_for_gas
中支付(如果足够的话),而不是由交易发送者的账户余额支付,如果sponsor_balance_for_gas
无法承担燃料消耗,则交易失败。否则,交易发送者应支付燃料费用。 - 对于存储抵押物: 如果一笔交易使用非空的
sponsor_balance_for_collateral
调用智能合约且交易发送者处于合约的whitelist
列表内,在执行交易的过程中抵押担保物将从智能合约的sponsor_balance_for_collateral
中扣除,并将这些修改后的存储条目所有者相应设置为合约地址。 否则,交易发送方应在执行过程中支付抵押担保物。
1、赞助更新
可以通过调用SponsorControl合同来更新燃料赞助费用和抵押担保物。要替换合约中的 sponsor_for_gas
,新的赞助人应当向合约转移比当前合约 sponsor_balance_for_gas
更多的资金,并为 sponsor_limit_for_gas_fee
设定一个新值。除非原有的 sponsor_limit_for_gas_fee
无法负担赞助,否则, sponsor_limit_for_gas_fee
的新值应不低于原有赞助者设置的限额。而且,转入的资金应当是新限额的1000倍及以上,这样至少可以补贴 1000
个调用C的交易。 如满足上述条件,则剩余的 sponsor_balance_for_gas
将退还给之前的赞助账户 sponsor_for_gas
,随后根据新赞助商的规范更新 sponsor_balance_for_gas
, sponsor_balance_for_gas
,及 sponsor_limit_for_gas_fee
。
对 sponsor_for_collateral
的替换操作与上文描述非常类似,只是没有类似于燃料费用的限制。新的赞助人应当向C转入比现有赞助人提供的资金更多的资金作为合约的抵押担保物。那么当前赞助人 sponsor_for_collateral
的担保物将被全额退还,如 sponsor_balance_for_collateral
与合约使用的抵押担保总额之和,此外两个抵押担保字段均按照新赞助人的要求进行相应的变更。一个合约账户允许成为赞助人。
2、赞助接口
内建的合约地址为 0x8ad036480160591706c831f0da19d1a424e39469
。 内部合约的abi可以在 这里以及 这里获取。
set_sponsor_for_gas(address contract, uint upper_bound)
:如果有人希望向合约地址contract
赞助燃料费用, 他/她(也可以是合约账户)可以在调用该函数的同时向地址0x8ad036480160591706c831f0da19d1a424e39469
传输代币。 参数upper_bound
是指赞助者为单笔交易支付的燃料费用上限。 传输的代币量至少为参数upper_bound
的1000倍。赞助者可能会被赞助更多代币同时设置更高的上界参数的赞助者所替换。当前赞助者也可以调用该函数并向该合约传输更多代币。在当前赞助者账户余额小于参数upper_bound
时 ,upper_bound
值将被动态调低。set_sponsor_for_collateral(address contract_addr)
: 如果有人希望向地址为contract
的合约赞助担保金,他/她(也可以是合约账户)可以在调用该函数的同时向地址0x8ad036480160591706c831f0da19d1a424e39469
传输代币。赞助者可能会被传输更多代币的新赞助者替换而当前赞助者也可通过调用该函数向合约传输更多代币。add_privilege(address[] memory)
: 合约可通过调用该函数向白名单中加入部分正常账户地址。这意味着,若sponsor_for_gas
被设置,合约会向白名单内的账户支付燃料费用,若sponsor_for_collateral
被设置,则合约会向白名单内账户支付担保金。合约可通过使用特殊地址0x0000000000000000000000000000000000000000
,能够将所有账户加入到白名单中。remove_privilege(address[] memory)
:合约可通过调用该函数从白名单中移除正常账户。
当调用函数时的交易值 set_sponsor_for_gas
及 set_sponsor_for_collateral
代表发送者(新赞助者)愿意支付的代币数量。每个合约通过调用 add_privilege
及 remove_privilege
来维护它的白名单列表 whitelist
。
3、赞助样例
假设有一个如下所示的简单合约。
pragma solidity >=0.4.15;
import "https://github.com/Conflux-Chain/conflux-rust/blob/master/internal_contract/contracts/SponsorWhitelistControl.sol";
contract CommissionPrivilegeTest {
mapping(uint => uint) public ss;
// 添加白名单
function add(address account) public payable {
SponsorWhitelistControl cpc = SponsorWhitelistControl(0x8ad036480160591706c831f0DA19D1a424e39469);
address[] memory a = new address[](1);
a[0] = account;
cpc.add_privilege(a);
}
// 移除白名单
function remove(address account) public payable {
SponsorWhitelistControl cpc = SponsorWhitelistControl(0x8ad036480160591706c831f0DA19D1a424e39469);
address[] memory a = new address[](1);
a[0] = account;
cpc.remove_privilege(a);
}
// 测试支付
function foo() public payable {
}
// 测试支付
function par_add(uint start, uint end) public payable {
for (uint i = start; i < end; i++) {
ss[i] = 1;
}
}
}
部署合约后,地址为 contract_addr
,如果有人希望赞助燃料费用,他/她可以发送如下交易:
const PRIVATE_KEY = '0xxxxxxx';
const cfx = new Conflux({
url: 'http://testnet-jsonrpc.conflux-chain.org:12537',
defaultGasPrice: 100,
defaultGas: 1000000,
logger: console,
});
const account = cfx.Account(PRIVATE_KEY); // create account instance
const sponsor_contract_addr = '0x8ad036480160591706c831f0da19d1a424e39469';
const sponsor_contract = cfx.Contract({
abi: require('./contracts/sponsor.abi.json'),
address: sponsor_contract_addr,
});
// 赞助燃料
sponsor_contract.set_sponsor_for_gas(contract_addr, your_upper_bound).sendTransaction({
from: account,
value: your_sponsor_value
}).confirmed();
// 赞助存储抵押物
sponsor_contract.set_sponsor_for_collateral(contract_addr, your_upper_bound).sendTransaction({
from: account,
value: your_sponsor_value
}).confirmed();
至于赞助者的存储抵押物,只需要更换 set_sponsor_for_gas(contract_addr, your_upper_bound)
函数为 set_sponsor_for_collateral(contract_addr)
函数并使用。
通过使用 add_privilege
和 remove_privilege
为合约维护白名单 whitelist
。含有全0的特殊地址 0x0000000000000000000000000000000000000000
意味着任何人都在 whitelist
内。 需要谨慎的使用它。
// 添加
you_contract.add(white_list_addr).sendTransaction({
from: account,
})
// 移除
you_contract.remove(white_list_addr).sendTransaction({
from: account,
})
在这一操作后,在调用 you_contract.foo()
或 you_contract.par_add(1, 10)
时存在于 whiltelist
内的账户将不再支付任何费用。
二、管理
引入 AdminControl 合约的目的是为了更好地维护其他智能合约,特别是那些没有适当销毁程序而临时生成的智能合约:它记录了每个用户建立的智能合约的管理员,并根据相应管理员的要求进行销毁处理。
智能合约的默认管理员是合约的创建者,即使合约创建的交易发送者α。智能合约的当前管理员可通过向AdminControl合约发送请求,将其权限转移给另一个普通账户。合约账户不允许成为其他合约的管理者,因为这种机制主要是用于试探性的维护。任何带有自定义授权规则的长期管理都应该在合约内部实现,如作为处理销毁请求的特定功能。
在任何时候,现有合同的管理人addr
都有权通过调用AdminControl申请销毁合约。但是,如果用于存储合同的抵押物不为零,或 addr
不是合约的当前管理者,则该请求将被拒绝。如果 addr
是合约的当前管理者,且合约中的存储抵押品为零,则销毁请求会被接受,且处理流程如下:
- 合约余额将退还给
addr
; - 合约中的
sponsor_balance_for_gas
会退还给sponsor_for_gas
; - 合约中的
sponsor_balance_for_collateral
会退还给sponsor_for_collateral
; - 合约的内部状态将被解除,并将相应的抵押物退还给拥有者;
- 该合约从世界范围内删除。
1、管理接口
合约地址为 0x8060de9e1568e69811c4a398f92c3d10949dc891
。 内部合约的abi可以在这里以及这里获取。
set_admin(address contract, address admin)
: 设置admin
为合约contract
的管理员。函数调用者应为合约contract
的管理员且账号状态正常。调用者要确保contract
字段确实写入了合约地址且admin
字段是正常的账户地址。否则,调用失败。destroy(address contract)
: 销毁合约contract
。函数调用者应为合约contract
的管理员且账号状态正常。 若合约抵押担保非0,则销毁合约失败.否则,合约contract
的balance
退还给现任管理者处。sponsor_balance_for_gas
将会退还到sponsor_for_gas
,sponsor_balance_for_collateral
则会退还到sponsor_for_collateral
。
2、管理样例
考虑到您已经部署了一个合约,其地址为 contract_addr
。管理员可以调用 AdminControl.set_admin(contract_addr, new_admin)
以修改管理员,及调用 AdminControl.destroy(contract_addr)
以销毁合约。
const PRIVATE_KEY = '0xxxxxxx';
const cfx = new Conflux({
url: 'http://testnet-jsonrpc.conflux-chain.org:12537',
defaultGasPrice: 100,
defaultGas: 1000000,
logger: console,
});
const account = cfx.Account(PRIVATE_KEY); // create account instance
const admin_contract_addr = '0x8060de9e1568e69811c4a398f92c3d10949dc891';
const admin_contract = cfx.Contract({
abi: require('./contracts/admin.abi.json'),
address: admin_contract_addr,
});
// 修改管理员
admin_contract.set_admin(contract_addr, new_admin).sendTransaction({
from: account,
}).confirmed();
// 销毁智能合约
admin_contract.destroy(contract_addr).sendTransaction({
from: account,
}).confirmed();
三、权益质押机制
Conflux引入权益质押机制的原因有两个:一、权益机制提供了一种对占用存储空间更好的收费方式(相比于“一次付费,永久占用”)。二、该机制还有助于定义分散治理中的投票权。
在高层,Conflux实现了一个内置的Staking 合约,记录所有账户的权益信息。通过向该合约发送交易,用户(包括外部用户和智能合约)可以存入/提取资金,也被称为合约内的权益。质押资金的利息在提款时发放,其数量取决于提款金额和质押时长。
1、利率
目前的年化利率为4%。
复利是以区块的颗粒度来实现的。
执行由账户 addr
在区块 B
发送的交易,并在区块 B'
提取价值 v
的资金,其利息计算公式如下:
interest issued = v * (4% / 63072000)^T
其中 T = BlockNo(B)−BlockNo(B')
是以区块数目衡量的质押时长,而 63072000
是在区块生成时间为 0.5
秒前提下 365
天生成区块数目的期望值。
2、质押以获取投票权益
详细请看Conflux Protocol Specification.
3、质押接口
合约地址为 0x843c409373ffd5c0bec1dddb7bec830856757b65
。内部合约的abi信息可以在这里以及这里获取。
deposit(uint amount)
:调用者可以通过调用该函数将部分代币存入Conflux内嵌的权益质押合约。目前的年化利率为4%。withdraw(uint amount)
: 调用者可通过调用该函数从Conflux内嵌的权益质押合约中提取代币。运行该函数将会触发利息结算。权益质押资金和利息将会按先申请先服务的顺序及时转入到用户账户中。vote_lock(uint amount, uint unlock_block_number)
:该函数与Conflux的投票权益相关。权益质押用户可以通过选择投票数额及锁定的到期日锁定一定数目的CFX费用。参数unlock_block_number
会以创世区块产生以来的区块数目度量。
4、质押样例
const PRIVATE_KEY = '0xxxxxxx';
const cfx = new Conflux({
url: 'http://testnet-jsonrpc.conflux-chain.org:12537',
defaultGasPrice: 100,
defaultGas: 1000000,
logger: console,
});
const account = cfx.Account(PRIVATE_KEY); // create account instance
const staking_contract_addr = '0x843c409373ffd5c0bec1dddb7bec830856757b65';
const staking_contract = cfx.Contract({
abi: require('./contracts/staking.abi.json'),
address: staking_contract_addr,
});
// 存储质押
staking_contract.deposit(your_number_of_tokens).sendTransaction({
from: account,
}).confirmed();
// 撤回质押
staking_contract.withdraw(your_number_of_tokens).sendTransaction({
from: account,
}).confirmed();
// 锁定质押
staking_contract.vote_lock(your_number_of_tokens, your_unlock_block_number).sendTransaction({
from: account,
}).confirmed();