@abmprotocl/dotbtc-plugin-mcd 中文文档教程
dai-plugin-mcd
一个 Dai.js 插件,用于与 多抵押 Dai 合约
Example usage
import { McdPlugin, ETH, REP, DAI } from '@makerdao/dai-plugin-mcd';
import Maker from '@makerdao/dai';
import { createCurrency } from '@makerdao/currency';
import { tokenAddress, tokenAbi } from 'someOtherTokenData';
const TOK = createCurrency('TOK');
const maker = await Maker.create('http', {
// ...other configuration...
plugins: [
[
McdPlugin,
{
// omit this option to get the default set:
// ETH-A, ETH-B, REP-A
cdpTypes: [
{ currency: ETH, ilk: 'ETH-A' },
{ currency: REP, ilk: 'REP-A' },
{ currency: TOK, ilk: 'TOK-Z', address: tokenAddress, abi: tokenAbi },
]
}
]
]
});
await maker.service('proxy').ensureProxy();
const cdpManager = maker.service('mcd:cdpManager');
const cdp1 = await cdpManager.openLockAndDraw('REP-A', REP(50), DAI(1000));
const cdp2 = await cdpManager.openLockAndDraw('ETH-A', ETH(50), DAI(1000));
const cdp3 = await cdpManager.openLockAndDraw('TOK-Z', TOK(50), DAI(1000));
请访问 docs.makerdao.com 获取更多文档。
Developer notes
MCD 合约将每秒的稳定费存储在一个名为 tax
的变量中 作为 1.X _ 10^27 形式的数字(例如 1000000000472114805215157978
),以及 称为 repo
的变量中的基本利率,形式为 0.X _ 10^27 的数字。
在此插件中,getAnnualStabilityFee()
和获取 getAnnualBaseRate
函数将这些值转换为返回年度的十进制表示 率(例如 0.015
和 0.01
)。
从顶级 dai.js 目录运行测试。
Local Development
由于 Babel7 处理转译的方式,在本地开发和导入此插件时无法使用 yarn link
。 我们建议改用 yalc。 我们还发现名为 sane 的观察器工具很有用。
运行步骤:
- In this directory run
sane "yalc publish && cd [INSERT THE DIRECTORY OF THE PROJECT THAT IS IMPORTING THIS PLUGIN] && yalc link @makerdao/dai-plugin-mcd" src --wait=3
dai-plugin-mcd
A Dai.js plugin for interacting with the multi-collateral dai contracts
Example usage
import { McdPlugin, ETH, REP, DAI } from '@makerdao/dai-plugin-mcd';
import Maker from '@makerdao/dai';
import { createCurrency } from '@makerdao/currency';
import { tokenAddress, tokenAbi } from 'someOtherTokenData';
const TOK = createCurrency('TOK');
const maker = await Maker.create('http', {
// ...other configuration...
plugins: [
[
McdPlugin,
{
// omit this option to get the default set:
// ETH-A, ETH-B, REP-A
cdpTypes: [
{ currency: ETH, ilk: 'ETH-A' },
{ currency: REP, ilk: 'REP-A' },
{ currency: TOK, ilk: 'TOK-Z', address: tokenAddress, abi: tokenAbi },
]
}
]
]
});
await maker.service('proxy').ensureProxy();
const cdpManager = maker.service('mcd:cdpManager');
const cdp1 = await cdpManager.openLockAndDraw('REP-A', REP(50), DAI(1000));
const cdp2 = await cdpManager.openLockAndDraw('ETH-A', ETH(50), DAI(1000));
const cdp3 = await cdpManager.openLockAndDraw('TOK-Z', TOK(50), DAI(1000));
Please visit docs.makerdao.com for more documentation.
Developer notes
The MCD contracts store the stability fee per second in a variable called tax
as a number in the form 1.X _ 10^27 (e.g. 1000000000472114805215157978
), and the base rate in a variable called repo
as a number in the form 0.X _ 10^27.
In this plugin, the getAnnualStabilityFee()
and get getAnnualBaseRate
functions convert those values to return a decimal representation of the yearly rates (e.g. 0.015
and 0.01
).
Run the tests from the top-level dai.js directory.
Local Development
Due to the way that Babel7 handles transpilation it is not possible to use yarn link
when locally developing this plugin, and importing it. We recommend using yalc instead. We've also found that a watcher tool called sane is helpful.
Steps to Run:
- In this directory run
sane "yalc publish && cd [INSERT THE DIRECTORY OF THE PROJECT THAT IS IMPORTING THIS PLUGIN] && yalc link @makerdao/dai-plugin-mcd" src --wait=3