合约子钱包

学习本文档前,你需要对 FIBOS 和 fibos.js 有一定的了解。假如你对 FIBOS 和 fibos.js 不了解,请参阅 快速入门

为什么要用合约子钱包

场景一

假设有这样一个业务场景,公司 A 发布了一款产品叫做 FO 单车,使用 FO 单车需要使用 FO 单车通证付款,且FO 单车通证可以与 FO 通证进行互相兑换。用户 A 想要使用 FO 单车,那么他就要在 FO 单车平台注册一个账户并向其中充入一定数量的 FO 单车通证。每使用一次 FO 单车,需要进行一次支付,但是每次支付都需要用户输入密码,影响了用户的体验。那么有什么好的解决方案呢?

合约子钱包就能解决这个问题,我们可以这样理解,平台相当于合约,子钱包相当于平台账户。当用户想要使用 FO 单车时,就往子钱包中充入 FO 单车通证,合约会被授权可以对你的子钱包中的余额进行操作。这样每次使用完单车后,合约会自动扣款,就不需要用户再去手动操作了。当用户不再需要使用 FO 单车时,将 FO 单车通证从子钱包中提出即可。

场景二

假设 A 和 B 竞猜,各自投入 50 个 FO 通证,但是没有人来裁判竞猜结果,两人都可以耍赖,这时候该怎么办呢?

合约子钱包也能解决这个问题,A 和 B 需要一个第三方平台 C 来监管。A 和 B 在竞猜之前分别把 50 个 FO 通证打到 C 平台的账户中,平台可以对 A 和 B 账户的通证进行操作,当结果出来之后。平台直接将输的一方的通证打入到获胜的一方。

上述两个场景中,给大家简单的展示了合约子钱包的用法。还有更多合约子钱包的用法等着大家去发掘,下面给大家讲解一下合约子钱包三个接口的用法。

合约子钱包的三种用法

前提条件:用户 nmslwsndhjyz 发行了一个合约,以及精度为四位小数,名字叫做 ADC 的智能通证。用户 tteesstt1122 通过 兑换 持有 1000 个 ADC 流通通证。

充值

接口

1
2
3
4
5
void token::ctxrecharge(
account_name owner, //账户拥有者
extended_asset quantity, //充值通证数量
string memo //附言
)

实例

1
2
3
4
5
6
7
//初始化 fibos 客户端
...
let ctx = fibos.contractSync('eosio.token');
let r = ctx.ctxrechargeSync('tteesstt1122', '100.0000 [email protected]', 'ctxrecharge', {
authorization: 'tteesstt1122'
})
console.notice(r);

上述代码中,tteesstt1122 调用 ctxrechargeSync 方法给自己的合约子钱包中充入了200个 ADC 智能通证。

充值成功后,我们可以调用如下的方法分别来查询流通通证余额和合约子钱包的余额。

查询可用余额:

1
2
3
4
//初始化 fibos 客户端
...
let r = fibos.getTableRowsSync(true, 'eosio.token', 'nmslwsndhjyz', 'accounts')
console.notice(r);

查询合约子钱包余额:

1
2
3
4
//初始化 fibos 客户端
...
let s = fibos.getTableRowsSync(true, 'eosio.token', 'nmslwsndhjyz', 'ctxaccounts')
console.notice(s);

提现

接口

1
2
3
4
5
void token::ctxextract(
account_name owner,//账户拥有者
extended_asset quantity, //提现通证数量
string memo //附言
)

实例

1
2
3
4
5
6
7
//初始化 fibos 客户端
...
let ctx = fibos.contractSync('eosio.token');
let r = ctx.ctxextractSync('tteesstt1122', '100.0000 [email protected]', 'ctxextract', {
authorization: 'tteesstt1122'
})
console.notice(r);

调用 ctxextractSync 方法将自己的合约子钱包中的100个通证提回到流通通证余额中。

转账

接口

1
2
3
4
5
6
void token::ctxtransfer(
account_name from, //通证转出方
account_name to, //通证转入方
extended_asset quantity, //通证数量
string memo //附言
)

实例

1
2
3
ctx.ctxtransferSync('tteesstt1122', 'tteesstt2222', '50.0000 [email protected]', 'ctxtransfer', {
authorization: 'nmslwsndhjyz'
})

ADC 合约发行者 nmslwsndhjyz 调用转账方法将 ttteesstt1122 用户合约子钱包中的 50 个 ADC 通证转到了用户 tteesstt2222 的合约子钱包中。

小试牛刀

了解了上面的关于合约子钱包的充值、提现、转账三个 API 之后,我们可以实现很多功能。比如场景一中的 FO 单车,在用户进行充值后,用户的合约子钱包便有了相应的资产。想象一下,用户骑行后,将单车锁上便可离开。用户的资产在合约中进行相关结算之后,调用合约子钱包的 ctxtransfer 这个 action 将用户的子钱包中相应资产进行扣除,全程不需要用户的参与和等待,十分方便。下面,让我们使用 JavaScript 合约来实现这个功能!

在这个合约中,我们只需要实现一个最基础的功能,便是在用户使用完单车后进行扣费,假设骑行 1 分钟需要消耗 1 FOBIKE 通证,那么根据时长便可结算处用户需要支付的资产数量。接着,在合约中使用合约的权限调用eosio.token合约的ctxtransfer这个 action,将用户的合约子钱包资产转账至合约发布者的合约子钱包资产中,以达到对用户资产扣除目的。

我们将这个 action 命名为 settle,用于结算。保存下面的代码至 contract.js,作为合约代码文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
exports.settle = (user, minutes) => {
assert.isTrue(minutes > 0, 'minutes must be positive');

let quantity = (minutes * 10n).toString();
quantity = {
quantity: `${quantity}.0000 FOBIKE`,
contract: 'fobikeissuer'
};

trans.send_inline('eosio.token', 'ctxtransfer', {
from: user,
to: 'fobikeissuer',
quantity: quantity,
memo: `${user} pays for FO Bike`
}, [{
'actor': 'fobikeissuer',
'permission': 'active'
}]);
};

以及abi文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
'version': 'eosio::abi/1.0',
'structs': [{
'name': 'settle',
'base': '',
'fields': [{
'name': 'user',
'type': 'name'
}, {
'name': 'minutes',
'type': 'uint64'
}]
}],
'actions': [{
'name': 'settle',
'type': 'settle',
'ricardian_contract': ''
}]
}

关于 JavaScript 合约如何发布,请参考 快速入门

通过上面的 JavaScript 合约,我们可以看到,assert.isTrue(minutes > 0, 'minutes must be positive');用于判断骑行时间的正确性。然后我们根据骑行时长计算出用户所需支付的通证数量,构造了一个extended_asset对象,作为参数,使用send_inline的方式调用eosio.token合约的ctxtransfer,将用户的子钱包资产转账至合约的发布者(fobikeissuer)的子钱包资产中。(关于合约之间的调用,下一期的文档我们会详细介绍,敬请期待!)

这样,一个最简单的用于扣费的 JavaScript 合约就完成了。关于合约子钱包,还有很多有趣的玩法,欢迎大家踊跃发言,让我们共同进步!