BakerySwap.js如何操作?

Posted 2021-09-10 diuxie

1 编译合约
在终端进入项目目录，执行如下命令编译bakeryswap及开发包提供的测试Token合约：

~$ cd ~/bakeryswap.js
~/bakeryswap.js$ bin/build-contracts

执行结果如下：

在这里插入图片描述

2 部署合约
首先在另一个终端启动开发私链：

~$ ganache-cli -d

然后进入项目demo目录，执行如下命令部署合约：

~$ cd ~/bakeryswap.js/demo
~/bakeryswap.js/demo$ node deploy-contracts.js

执行结果如下：

在这里插入图片描述

注意 ：如果需要在BSC主链或测试链部署上述合约，或者使用其他参数启动ganache-cli， 需要修改config.js中的账号配置。

3 Token授权
代码demo/token-approve.js演示了如何授权bakeryswap路由合约代理操作当前账号的HAPY token和USDT token。

在终端进入项目demo目录，执行如下命令：

~$ cd ~/bakeryswap.js/demo
~/bakeryswap.js/demo$ node token-approve.js

执行结果如下：

在这里插入图片描述

4 BEP20/BEP20交易对添加流动性
代码demo/add-liquidity.js演示了如何为BEP20/BEP20交易对添加流动性。

在终端进入项目demo目录，执行如下命令：

~$ cd ~/bakeryswap.js/demo
~/bakeryswap.js/demo$ node add-liquidity.js

执行结果如下：

在这里插入图片描述

bakeryswap协议约定，第一次添加流动性将自动创建交易对 ，之后再次添加流动性时，演示代码将首先显示当前的仓位信息。例如再次执行如下命令：

~/bakeryswap.js/demo$ node add-liquidity.js

执行结果如下：

在这里插入图片描述

5 BEP20/BEP20交易对移除流动性
代码demo/remove-liquidity.js演示了如何移除指定的BEP20/BEP20交易对的流动性。

在终端进入项目demo目录，执行如下命令：

~$ cd ~/bakeryswap.js/demo
~/bakeryswap.js/demo$ node remove-liquidity.js

执行结果如下：

在这里插入图片描述

6 BEP20/BEP20兑换：以输入token数量为基准
代码demo/swap-exact-tokens-for-tokens.js演示了如何实现以输入token数量为基准的BEP20/BEP20兑换。

在终端进入项目demo目录，执行如下命令：

~$ cd ~/bakeryswap.js/demo
~/bakeryswap.js/demo$ node swap-exact-tokens-for-tokens.js

执行结果如下：

在这里插入图片描述

7 BEP20/BEP20兑换：以输出token数量为基准
代码demo/swap-tokens-for-exact-tokens.js演示了如何实现以输出token数量为基准的BEP20/BEP20兑换。

在终端进入项目demo目录，执行如下命令：

~$ cd ~/bakeryswap.js/demo
~/bakeryswap.js/demo$ node swap-tokens-for-exact-tokens.js

执行结果如下：

在这里插入图片描述

8 BNB/BEP20交易对添加流动性
代码demo/add-liquidty-bnb.js演示了如何为BNB/BEP20或BEP20/BNB交易对添加流动性。

在终端进入项目demo目录，执行如下命令：

~$ cd ~/bakeryswap.js/demo
~/bakeryswap.js/demo$ node add-liquidity-bnb.js

执行结果如下：

在这里插入图片描述

第一次添加流动性将自动创建交易对，之后再次添加将首先显示当前的持仓信息。例如再次执行如下命令：

~/bakeryswap.js/demo$ node add-liquidity-bnb.js

执行结果如下：

在这里插入图片描述

9 BNB/BEP20交易对移除流动性
代码demo/remove-liquidity-bnb.js演示了如何移除BNB/BEP20或BEP20/BNB交易对的流动性。

在终端进入项目demo目录，执行如下命令：

~$ cd ~/bakeryswap.js/demo
~/bakeryswap.js/demo$ node remove-liquidity-bnb.js

执行结果如下：

在这里插入图片描述

10 BNB/BEP20兑换：以输入BNB数量为基准
代码demo/swap-exact-bnb-for-tokens.js演示了如何将指定数量的BNB兑换为BEP20 token。

在终端进入项目demo游戏目录，执行如下命令：

~$ cd ~/bakeryswap.js/demo
~/bakeryswap.js/demo$ node swap-exact-bnb-for-tokens.js

执行结果如下：

在这里插入图片描述

11 BNB/BEP20兑换：以输出token数量为基准
代码demo/swap-bnb-for-exact-tokens.js演示了如何将BNB兑换为指定数量的BEP20 token。

在终端进入项目demo目录，执行如下命令：

~$ cd ~/bakeryswap.js/demo
~/bakeryswap.js/demo$ node swap-bnb-for-exact-tokens.js

执行结果如下：

在这里插入图片描述

12 BEP20/BNB兑换：以输入token数量为基准
代码demo/swap-exact-tokens-for-bnb.js演示了如何将指定数量的BEP20 token兑换为www.cungun.comBNB。

在终端进入项目demo目录，执行如下命令：

~$ cd ~/bakeryswap.js/demo
~/bakeryswap.js/demo$ node swap-exact-tokens-for-bnb.js

执行结果如下：

在这里插入图片描述

13 BEP20/BNB兑换：以输出BNB数量为基准
代码demo/swap-tokens-for-exact-bnb.js演示了如何将BEP20 token兑换为指定数量的BNB。

在终端进入项目demo目录，执行如下命令：

~$ cd ~/bakeryswap.js/demo
~/bakeryswap.js/demo$ node swap-tokens-for-exact-bnb.js

执行结果如下：

在这里插入图片描述

14实例化SwapKit
SwapKit实例化需要传入三个参数：

币安智能链节点URL
bakeryswap路由合约地址
用于执行合约交互的币安智能链账号的私钥。
例如，下面的代码创建一个接入BSC主网bakeryswap协议的SwapKit实例：

const { SwapKit } = require(\'bakeryswap.js\')

const kit = new SwapKit(
\'https://bsc-dataseed.binance.... //币安智能链节点URL
\'0xCDe540d7eAFE93aC5fE6233Bee57E1270D3E330F\', //BSC主链bakeryswap路由合约地址
\'0x4f3e...3b1d\' //默认执行账号的私钥
)

15 生成流动性添加/移除委托单
由于bakeryswap协议中涉及到交易滑点处理以及价格预计算，因此bakeryswap.js提供了一个专门的类 OrderBuilder 用于生成流动性添加/移除委托单。OrderBuilder的实现内置了自动价格计算与滑点计算，因此调用者只需要指定基本的数据即可生成可提交给bakeryswap合约的流动性添加/移除委托单。

使用SwapKit对象的orderBuilder属性获取预创建的OrderBuilder对象，并调用OrderBuilder的异步方法build()生成委托单。例如：

const order = await kit.orderBuilder //返回OrderBuilder对象

                ......                     //参数设置
                .build()                   //生成并返回委托单

OrderBuilder对象提供了以下方法用于调整生成器的行为：

orderType(type) ：设置委托单类型，目前支持两种：
Order.LIQUIDITY_ADD - 流动性添加委托单
Order.LIQUIDITY_REMOVE - 流动性移除委托单
tokenA(addr) / tokenB(addr) ：交易对的两个Token地址
amountA(bn) / amountB(bn) ：两个token的添加数量，仅在添加流动时需要设置
liquidity(bn) ：LP token数量，仅在移除流动性时需要设置
slippage(bn) ：交易滑点设置，默认值为5， 表示0.5%的滑点容忍区间
to(addr) ：委托单执行结果接收地址
例如，下面的代码生成一个流动性添加委托单：

// const { SwapKit, Order, bn } = require(\'bakeryswap.js\')

const order = await kit.orderBuilder //获取委托单生成器对象

                .orderType(Order.LIQUIDITY_ADD)          //添加流动性
                .tokenA(\'0x...\')                         //交易对TokenA
                .tokenB(\'0x...\')                         //交易对TokenB
                .amountA(bn(\'100000000000000000000\'))    //以TokenA数量为基准按市价自动计算TokenB数量
                .slippage(bn(\'10\'))                      //滑点容忍范围1%
                .to(kit.ownerAddress)                    //设置LP Token的接收地址
                .build()                                 //生成委托单 
         

console.log(amountA => ${order.amountA}) //TokenA设置数量
console.log(amountB => ${order.amountB}) //TokenB计算数量
console.log(amountAMin => ${order.amountAMin}) //滑点处理后的TokenA最小可接受数量
console.log(amountBMin => ${order.amountBMin}) //滑点处理后的TokenB最小可接受数量

注意：

使用特殊的 SwapKit.ETH_TOKEN 表示交易对中的BNB，值为：0x00000000000000000000000000000000000eeeee
bn(numstr) 是bakeryswap.js提供的一个创建 BigNumber 对象 的快捷函数，其参数为10进制字符串。
token数量均按最小单位指定
类似的，下面的代码生成一个流动性移除委托单：

// const { SwapKit, Order, bn } = require(\'bakeryswap.js\')

const order = await kit.orderBuilder //获取委托单生成器对象

                .orderType(Order.LIQUIDITY_REMOVE)        //移除流动性  
                .tokenA(\'0x...\')                          //交易对TokenA地址 
                .tokenB(\'0x...\')                          //交易对TokenB地址 
                .liquidity(bn(\'10000000000000000000\'))    //要移除的流动性数量
                .slippage(bn(\'10\'))                       //滑点容忍范围1%
                .to(kit.ownerAddress)                     //token接收地址
                .build()                                  //生成委托单 

console.log(amountAMin => ${order.amountAMin}) //滑点处理后最少应收到的TokenA数量
console.log(amountBMin => ${order.amountAMin}) //滑点处理后最少应收到的TokenB数量

Order对象提供的以下值，有助于在执行委托单之前向用户提供更好的反馈信息：

amountA/amountB ：市价计算的tokenA或tokenB理想值
amountAMin/amountAMax ：滑点处理后的tokenA最小值/最大值
amountBMin/amountBMax ：滑点处理后的tokenB最小值/最大值
16执行流动性委托单
使用SwapKit的 executeOrder() 方法即可执行生成的流动性委托单，最终完成流动性添加/移除交易。例如：

const tx = await kit->executeOrder($trade); //执行委托单
console.log(txid => ${tx.hash}) //显示交易ID

默认情况下，executeOrder()方法自动估算交易所需的gas限额与gas价格，但可以传入额外的参数手动设置这两个值。

例如，下面的代码以指定的gas参数执行流动性维护单：

// const { bn } = require(\'bakeryswap.js\')

const opts = {
gasLimit: bn(\'4000000\'), //4 million
gasPrice: bn(\'200000000000\') //200 gwei
}
const tx = await kit.executeOrder(order, opts) //执行委托单

17 查询仓位信息
使用SwapKit的 getLiquidityInfo() 方法可以查询指定账号在指定交易对的仓位信息。例如查询某地址的持仓情况：

const info = await kit.getLiquidityInfo(\'0x90F8...c9C1\'); //查询持仓信息

console.log(total => ${info.totalSupply}) //LP总量
console.log(balance => ${info.balance}) //持仓数量
console.log(share % => ${info.share}) //持仓比例

18 生成兑换交易对象
类似于流动性的添加与移除，在bakeryswap中的交易对兑换也存在价格自动计算与滑点处理问题。为此，bakeryswap.js开发包提供了一个专门的类 TradeBuilder用来简化这一操作。TradeBuilder内置了价格自动计算与滑点处理，因此调用者只需要设置基本的参数即可。

使用SwapKit对象的tradeBuilder属性获取预创建的TradeBuilder对象，例如：

const tb = await kit.tradeBuilder //获取预创建的兑换交易生成器

        ......                             //参数设置
        .build()                          //生成兑换交易对象

TradeBuilder提供了以下方法用于调整生成器的行为：

tradeType(type) ：兑换类型，可选值为：
Trade.EXACT_INPUT - 以tokenIn的数量为基准
Trade.EXACT_OUTPUT - 以tokenOut的数量为基准
tokenIn(addr) - 输入Token的地址
tokenOut(addr) - 输出Token的地址
amountIn(bn) - 输入数量，仅在兑换类型为EXACT_INPUT时需要设置
amountOut(bn) - 输出数量，仅在兑换类型为EXACT_OUTPUT时需要设置
slippage(bn) - 交易滑点设置，默认值5， 表示允许0.5%的滑点
to($addr) - 输出token接收地址