如何进行PancakeSwap.JS开发包的分析

发布时间:2021-12-14 09:27:20 作者:柒染
来源:亿速云 阅读:280

如何进行PancakeSwap.JS开发包的分析,很多新手对此不是很清楚,为了帮助大家解决这个难题,下面小编将为大家详细讲解,有这方面需求的人可以来学习下,希望你能有所收获。

PancakeSwap.js 开发包适用于为Web前端或Node.js应用快速增加对币安智能链PancakeSwap协议的支持能力。即支持使用自有部署BSC区块链节点的应用场景,也支持使用第三方节点的轻量级部署场景。官方下载地址:PancakeSwap.js

1、PancakeSwap.js概述

PancakeSwap.js开发包主要包含以下特性:

PancakeSwap.js开发包运行在 JavaScript 环境下,当前版本1.0.0,主要类/接口及关系如下图所示:

如何进行PancakeSwap.JS开发包的分析

PancakeSwap.js开发包的主要代码文件清单见官网说明:http://sc.hubwiz.com/codebag/pancakeswap-js/

2、使用示例代码

2.1 编译合约

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

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

执行结果如下:

如何进行PancakeSwap.JS开发包的分析

2.2 部署合约

首先在另一个终端启动开发私链:

~$ ganache-cli -d

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

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

执行结果如下:

如何进行PancakeSwap.JS开发包的分析

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

2.3 Token授权

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

在终端进入项目demo目录,执行如下命令:

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

执行结果如下:

如何进行PancakeSwap.JS开发包的分析

2.4 BEP20/BEP20交易对添加流动性

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

在终端进入项目demo目录,执行如下命令:

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

执行结果如下:

如何进行PancakeSwap.JS开发包的分析

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

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

执行结果如下:

如何进行PancakeSwap.JS开发包的分析

2.5 BEP20/BEP20交易对移除流动性

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

在终端进入项目demo目录,执行如下命令:

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

执行结果如下:

如何进行PancakeSwap.JS开发包的分析

2.6 BEP20/BEP20兑换:以输入token数量为基准

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

在终端进入项目demo目录,执行如下命令:

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

执行结果如下:

如何进行PancakeSwap.JS开发包的分析

2.7 BEP20/BEP20兑换:以输出token数量为基准

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

在终端进入项目demo目录,执行如下命令:

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

执行结果如下:

如何进行PancakeSwap.JS开发包的分析

2.8 BNB/BEP20交易对添加流动性

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

在终端进入项目demo目录,执行如下命令:

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

执行结果如下:

如何进行PancakeSwap.JS开发包的分析

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

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

执行结果如下:

如何进行PancakeSwap.JS开发包的分析

2.9 BNB/BEP20交易对移除流动性

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

在终端进入项目demo目录,执行如下命令:

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

执行结果如下:

如何进行PancakeSwap.JS开发包的分析

2.10 BNB/BEP20兑换:以输入BNB数量为基准

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

在终端进入项目demo目录,执行如下命令:

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

执行结果如下:

如何进行PancakeSwap.JS开发包的分析

2.11 BNB/BEP20兑换:以输出token数量为基准

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

在终端进入项目demo目录,执行如下命令:

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

执行结果如下:

如何进行PancakeSwap.JS开发包的分析

2.12 BEP20/BNB兑换:以输入token数量为基准

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

在终端进入项目demo目录,执行如下命令:

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

执行结果如下:

如何进行PancakeSwap.JS开发包的分析

2.13 BEP20/BNB兑换:以输出BNB数量为基准

代码demo/swap-tokens-for-exact-bnb.js演示了如何将BEP20token兑换为指定数量的BNB。

在终端进入项目demo目录,执行如下命令:

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

执行结果如下:

如何进行PancakeSwap.JS开发包的分析

3、使用pancakeswap.js开发包

SwapKit 是开发包的入口,使用这个类可以快速实现如下功能:

3.1 实例化SwapKit

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

例如,下面的代码创建一个接入BSC主网pancakeswap协议的SwapKit实例:

const { SwapKit } = require('pancakeswap.js')

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

3.2 生成流动性添加/移除委托单

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

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

const order = await kit.orderBuilder           //返回OrderBuilder对象 
                    ......                     //参数设置
                    .build()                   //生成并返回委托单

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

例如,下面的代码生成一个流动性添加委托单:

// const { SwapKit, Order, bn } = require('pancakeswap.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最小可接受数量

注意:

类似的,下面的代码生成一个流动性移除委托单:

// const { SwapKit, Order, bn } = require('pancakeswap.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对象提供的以下值,有助于在执行委托单之前向用户提供更好的反馈信息:

3.3 执行流动性委托单

使用SwapKit的 executeOrder() 方法即可执行生成的流动性委托单,最终完成流动性添加/移除交易。例如:

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

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

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

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

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

3.4 查询仓位信息

使用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}`)                         //持仓比例

3.5 生成兑换交易对象

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

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

const tb = await kit.tradeBuilder              //获取预创建的兑换交易生成器
            ......                             //参数设置
            .build()                          //生成兑换交易对象

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

例如,下面的代码以输入token数量为基准生成一个兑换交易对象:

// const { SwapKit, Trade, bn } = require('pancakeswap.js')

const trade = await kit.tradeBuilder                       //获取兑换交易生成器
                    .tradeType(Trade.EXACT_INPUT)          //以输入token数量为基准
                    .tokenIn('0x...')                      //输入token
                    .tokenOut('0x...')                     //输出token
                    .amountIn(bn('10000000000000000000'))  //输入token的数量
                    .slippage(bn('10'))                    //滑点容忍范围1%
                    .to(kit.ownerAddress)                  //输出token的接收地址
                    .build()                               //生成兑换交易对象
             
console.log(`amountIn => ${trade.amountIn}`)               //输入token的设置数量
console.log(`amountOut => ${trade.amountOut}`)             //自动做市算法得到的输出token的数量
console.log(`amountOutMin => ${trade.amountOutMin}`)       //滑点处理后的应收到的输出token最少数量

3.6 执行兑换交易

使用SwapKit对象的 executeTrade() 方法执行指定的兑换交易对象。例如:

const tx = await kit.executeTrade(trade)                   //执行兑换交易
console.log(`txid => ${tx.hash}`)                          //显示交易ID

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

例如,下面的代码使用设定的gas参数执行兑换交易:

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

const opts = {
  gasLimit: bn('4000000'),                                  //4 million
  gasPrice: bn('200000000000')                              //200 gwei
}
const tx = await kit.executeTrade(trade, opts)              //执行交易

看完上述内容是否对您有帮助呢?如果还想对相关知识有进一步的了解或阅读更多相关文章,请关注亿速云行业资讯频道,感谢您对亿速云的支持。

推荐阅读:
  1. 死磕 java并发包之LongAdder源码分析
  2. 前端发开中如何进行性能优化

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

上一篇:CDH6中的第三方库有什么用

下一篇:集群JournalNode服务重启导致NameNode挂掉的示例分析

相关阅读

您好,登录后才能下订单哦!

密码登录
登录注册
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》