如何進(jìn)行PancakeSwap.JS開發(fā)包的分析

如何進(jìn)行PancakeSwap.JS開發(fā)包的分析，很多新手對(duì)此不是很清楚，為了幫助大家解決這個(gè)難題，下面小編將為大家詳細(xì)講解，有這方面需求的人可以來學(xué)習(xí)下，希望你能有所收獲。

PancakeSwap.js 開發(fā)包適用于為Web前端或Node.js應(yīng)用快速增加對(duì)幣安智能鏈PancakeSwap協(xié)議的支持能力。即支持使用自有部署B(yǎng)SC區(qū)塊鏈節(jié)點(diǎn)的應(yīng)用場(chǎng)景，也支持使用第三方節(jié)點(diǎn)的輕量級(jí)部署場(chǎng)景。官方下載地址：PancakeSwap.js

1、PancakeSwap.js概述

PancakeSwap.js開發(fā)包主要包含以下特性：

• 一鍵部署PancakeSwap協(xié)議，便于快速開發(fā)與測(cè)試

• 支持PancakeSwap協(xié)議的全部接口，并提供開發(fā)人員友好的API

• 支持BEP20/BEP20、BNB/BEP20等各種交易對(duì)的流動(dòng)性添加、移除與兌換交易

• 支持自動(dòng)做市價(jià)格計(jì)算與滑點(diǎn)計(jì)算

• 支持交易gas用量與gas價(jià)格的自動(dòng)估算與手動(dòng)設(shè)定

• 支持EIP712簽名授權(quán)，單一交易內(nèi)完成流動(dòng)性維護(hù)

PancakeSwap.js開發(fā)包運(yùn)行在 JavaScript 環(huán)境下，當(dāng)前版本1.0.0，主要類/接口及關(guān)系如下圖所示：

PancakeSwap.js開發(fā)包的主要代碼文件清單見官網(wǎng)說明：http://sc.hubwiz.com/codebag/pancakeswap-js/

2、使用示例代碼

2.1 編譯合約

在終端進(jìn)入項(xiàng)目目錄，執(zhí)行如下命令編譯pancakeswap及開發(fā)包提供的測(cè)試Token合約：

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

執(zhí)行結(jié)果如下：

2.2 部署合約

首先在另一個(gè)終端啟動(dòng)開發(fā)私鏈：

~$ ganache-cli -d

然后進(jìn)入項(xiàng)目demo目錄，執(zhí)行如下命令部署合約：

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

執(zhí)行結(jié)果如下：

注意 ：如果需要在BSC主鏈或測(cè)試鏈部署上述合約，或者使用其他參數(shù)啟動(dòng)ganache-cli， 需要修改config.js中的賬號(hào)配置。

2.3 Token授權(quán)

代碼demo/token-approve.js演示了如何授權(quán)PancakeSwap路由合約代理操作當(dāng)前賬號(hào)的HAPY token和USDT token。

在終端進(jìn)入項(xiàng)目demo目錄，執(zhí)行如下命令：

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

執(zhí)行結(jié)果如下：

2.4 BEP20/BEP20交易對(duì)添加流動(dòng)性

代碼demo/add-liquidity.js演示了如何為BEP20/BEP20交易對(duì)添加流動(dòng)性。

在終端進(jìn)入項(xiàng)目demo目錄，執(zhí)行如下命令：

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

執(zhí)行結(jié)果如下：

pancakeswap協(xié)議約定，第一次添加流動(dòng)性將自動(dòng)創(chuàng)建交易對(duì) ，之后再次添加流動(dòng)性時(shí)，演示代碼將首先顯示當(dāng)前的倉位信息。例如再次執(zhí)行如下命令：

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

執(zhí)行結(jié)果如下：

2.5 BEP20/BEP20交易對(duì)移除流動(dòng)性

代碼demo/remove-liquidity.js演示了如何移除指定的BEP20/BEP20交易對(duì)的流動(dòng)性。

在終端進(jìn)入項(xiàng)目demo目錄，執(zhí)行如下命令：

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

執(zhí)行結(jié)果如下：

2.6 BEP20/BEP20兌換：以輸入token數(shù)量為基準(zhǔn)

代碼demo/swap-exact-tokens-for-tokens.js演示了如何實(shí)現(xiàn)以輸入token數(shù)量為基準(zhǔn)的BEP20/BEP20兌換。

在終端進(jìn)入項(xiàng)目demo目錄，執(zhí)行如下命令：

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

執(zhí)行結(jié)果如下：

2.7 BEP20/BEP20兌換：以輸出token數(shù)量為基準(zhǔn)

代碼demo/swap-tokens-for-exact-tokens.js演示了如何實(shí)現(xiàn)以輸出token數(shù)量為基準(zhǔn)的BEP20/BEP20兌換。

在終端進(jìn)入項(xiàng)目demo目錄，執(zhí)行如下命令：

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

執(zhí)行結(jié)果如下：

2.8 BNB/BEP20交易對(duì)添加流動(dòng)性

代碼demo/add-liquidty-bnb.js演示了如何為BNB/BEP20或BEP20/BNB交易對(duì)添加流動(dòng)性。

在終端進(jìn)入項(xiàng)目demo目錄，執(zhí)行如下命令：

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

執(zhí)行結(jié)果如下：

第一次添加流動(dòng)性將自動(dòng)創(chuàng)建交易對(duì)，之后再次添加將首先顯示當(dāng)前的持倉信息。例如再次執(zhí)行如下命令：

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

執(zhí)行結(jié)果如下：

2.9 BNB/BEP20交易對(duì)移除流動(dòng)性

代碼demo/remove-liquidity-bnb.js演示了如何移除BNB/BEP20或BEP20/BNB交易對(duì)的流動(dòng)性。

在終端進(jìn)入項(xiàng)目demo目錄，執(zhí)行如下命令：

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

執(zhí)行結(jié)果如下：

2.10 BNB/BEP20兌換：以輸入BNB數(shù)量為基準(zhǔn)

代碼demo/swap-exact-bnb-for-tokens.js演示了如何將指定數(shù)量的BNB兌換為BEP20 token。

在終端進(jìn)入項(xiàng)目demo目錄，執(zhí)行如下命令：

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

執(zhí)行結(jié)果如下：

2.11 BNB/BEP20兌換：以輸出token數(shù)量為基準(zhǔn)

代碼demo/swap-bnb-for-exact-tokens.js演示了如何將BNB兌換為指定數(shù)量的BEP20 token。

在終端進(jìn)入項(xiàng)目demo目錄，執(zhí)行如下命令：

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

執(zhí)行結(jié)果如下：

2.12 BEP20/BNB兌換：以輸入token數(shù)量為基準(zhǔn)

代碼demo/swap-exact-tokens-for-bnb.js演示了如何將指定數(shù)量的BEP20 token兌換為BNB。

在終端進(jìn)入項(xiàng)目demo目錄，執(zhí)行如下命令：

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

執(zhí)行結(jié)果如下：

2.13 BEP20/BNB兌換：以輸出BNB數(shù)量為基準(zhǔn)

代碼demo/swap-tokens-for-exact-bnb.js演示了如何將BEP20token兌換為指定數(shù)量的BNB。

在終端進(jìn)入項(xiàng)目demo目錄，執(zhí)行如下命令：

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

執(zhí)行結(jié)果如下：

3、使用pancakeswap.js開發(fā)包

SwapKit 是開發(fā)包的入口，使用這個(gè)類可以快速實(shí)現(xiàn)如下功能：

• 流動(dòng)性添加與移除：支持BEP20/BEP20、BEP20/BNB、BNB/BEP20等各種交易對(duì)

• 兌換交易的創(chuàng)建與執(zhí)行：支持BEP20/BEP20、BEP20/BNB、BNB/BEP20等各種交易對(duì)，支持以輸入或輸出價(jià)格為準(zhǔn)

• 用戶倉位查詢：查詢指定賬號(hào)在指定交易對(duì)的持倉情況，例如持倉數(shù)量、占比等。

3.1 實(shí)例化SwapKit

SwapKit實(shí)例化需要傳入三個(gè)參數(shù)：

• 幣安智能鏈節(jié)點(diǎn)URL

• pancakeswap路由合約地址

• 用于執(zhí)行合約交互的幣安智能鏈賬號(hào)的私鑰。

例如，下面的代碼創(chuàng)建一個(gè)接入BSC主網(wǎng)pancakeswap協(xié)議的SwapKit實(shí)例：

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

const kit = new SwapKit(
  'https://bsc-dataseed.binance.org',               //幣安智能鏈節(jié)點(diǎn)URL
  '0x05fF2B0DB69458A0750badebc4f9e13aDd608C7F',     //pancakeswap路由合約地址
  '0x4f3e...3b1d'                                   //默認(rèn)執(zhí)行賬號(hào)的私鑰                                 
)

3.2 生成流動(dòng)性添加/移除委托單

由于pancakeswap協(xié)議中涉及到交易滑點(diǎn)處理以及價(jià)格預(yù)計(jì)算，因此pancakeswap.js提供了一個(gè)專門的類 OrderBuilder 用于生成流動(dòng)性添加/移除委托單。OrderBuilder的實(shí)現(xiàn)內(nèi)置了自動(dòng)價(jià)格計(jì)算與滑點(diǎn)計(jì)算，因此調(diào)用者只需要指定基本的數(shù)據(jù)即可生成可提交給pancakeswap合約的流動(dòng)性添加/移除委托單。

使用SwapKit對(duì)象的orderBuilder屬性獲取預(yù)創(chuàng)建的OrderBuilder對(duì)象，并調(diào)用OrderBuilder的異步方法build()生成委托單。例如：

const order = await kit.orderBuilder           //返回OrderBuilder對(duì)象 
                    ......                     //參數(shù)設(shè)置
                    .build()                   //生成并返回委托單

OrderBuilder對(duì)象提供了以下方法用于調(diào)整生成器的行為：

• orderType(type) ：設(shè)置委托單類型，目前支持兩種：

• Order.LIQUIDITY_ADD - 流動(dòng)性添加委托單

• Order.LIQUIDITY_REMOVE - 流動(dòng)性移除委托單

• tokenA(addr) / tokenB(addr) ：交易對(duì)的兩個(gè)Token地址

• amountA(bn) / amountB(bn) ：兩個(gè)token的添加數(shù)量，僅在添加流動(dòng)時(shí)需要設(shè)置

• liquidity(bn) ：LP token數(shù)量，僅在移除流動(dòng)性時(shí)需要設(shè)置

• slippage(bn) ：交易滑點(diǎn)設(shè)置，默認(rèn)值為5， 表示0.5%的滑點(diǎn)容忍區(qū)間

• to(addr) ：委托單執(zhí)行結(jié)果接收地址

例如，下面的代碼生成一個(gè)流動(dòng)性添加委托單：

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

const order = await kit.orderBuilder                         //獲取委托單生成器對(duì)象
                    .orderType(Order.LIQUIDITY_ADD)          //添加流動(dòng)性
                    .tokenA('0x...')                         //交易對(duì)TokenA
                    .tokenB('0x...')                         //交易對(duì)TokenB
                    .amountA(bn('100000000000000000000'))    //以TokenA數(shù)量為基準(zhǔn)按市價(jià)自動(dòng)計(jì)算TokenB數(shù)量
                    .slippage(bn('10'))                      //滑點(diǎn)容忍范圍1%
                    .to(kit.ownerAddress)                    //設(shè)置LP Token的接收地址
                    .build()                                 //生成委托單 
             
console.log(`amountA => ${order.amountA}`)                   //TokenA設(shè)置數(shù)量  
console.log(`amountB => ${order.amountB}`)                   //TokenB計(jì)算數(shù)量 
console.log(`amountAMin => ${order.amountAMin}`)             //滑點(diǎn)處理后的TokenA最小可接受數(shù)量 
console.log(`amountBMin => ${order.amountBMin}`)             //滑點(diǎn)處理后的TokenB最小可接受數(shù)量

注意：

• 使用特殊的 SwapKit.ETH_TOKEN 表示交易對(duì)中的BNB，值為：0x00000000000000000000000000000000000eeeee

• bn(numstr) 是pancakeswap.js提供的一個(gè)創(chuàng)建 BigNumber 對(duì)象 的快捷函數(shù)，其參數(shù)為10進(jìn)制字符串。

• token數(shù)量均按最小單位指定

類似的，下面的代碼生成一個(gè)流動(dòng)性移除委托單：

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

const order = await kit.orderBuilder                          //獲取委托單生成器對(duì)象
                    .orderType(Order.LIQUIDITY_REMOVE)        //移除流動(dòng)性  
                    .tokenA('0x...')                          //交易對(duì)TokenA地址 
                    .tokenB('0x...')                          //交易對(duì)TokenB地址 
                    .liquidity(bn('10000000000000000000'))    //要移除的流動(dòng)性數(shù)量
                    .slippage(bn('10'))                       //滑點(diǎn)容忍范圍1%
                    .to(kit.ownerAddress)                     //token接收地址
                    .build()                                  //生成委托單 

console.log(`amountAMin => ${order.amountAMin}`)              //滑點(diǎn)處理后最少應(yīng)收到的TokenA數(shù)量 
console.log(`amountBMin => ${order.amountAMin}`)              //滑點(diǎn)處理后最少應(yīng)收到的TokenB數(shù)量

Order對(duì)象提供的以下值，有助于在執(zhí)行委托單之前向用戶提供更好的反饋信息：

• amountA/amountB ：市價(jià)計(jì)算的tokenA或tokenB理想值

• amountAMin/amountAMax ：滑點(diǎn)處理后的tokenA最小值/最大值

• amountBMin/amountBMax ：滑點(diǎn)處理后的tokenB最小值/最大值

3.3 執(zhí)行流動(dòng)性委托單

使用SwapKit的 executeOrder() 方法即可執(zhí)行生成的流動(dòng)性委托單，最終完成流動(dòng)性添加/移除交易。例如：

const tx = await kit->executeOrder($trade);              //執(zhí)行委托單
console.log(`txid => ${tx.hash}`)                        //顯示交易ID

默認(rèn)情況下，executeOrder()方法自動(dòng)估算交易所需的gas限額與gas價(jià)格，但可以傳入額外的參數(shù)手動(dòng)設(shè)置這兩個(gè)值。

例如，下面的代碼以指定的gas參數(shù)執(zhí)行流動(dòng)性維護(hù)單：

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

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

3.4 查詢倉位信息

使用SwapKit的 getLiquidityInfo() 方法可以查詢指定賬號(hào)在指定交易對(duì)的倉位信息。例如查詢某地址的持倉情況：

const info = await kit.getLiquidityInfo('0x90F8...c9C1');       //查詢持倉信息

console.log(`total => ${info.totalSupply}`)                     //LP總量 
console.log(`balance => ${info.balance}`)                       //持倉數(shù)量
console.log(`share % => ${info.share}`)                         //持倉比例

3.5 生成兌換交易對(duì)象

類似于流動(dòng)性的添加與移除，在pancakeswap中的交易對(duì)兌換也存在價(jià)格自動(dòng)計(jì)算與滑點(diǎn)處理問題。為此，pancakeswap.js開發(fā)包提供了一個(gè)專門的類 TradeBuilder用來簡(jiǎn)化這一操作。TradeBuilder內(nèi)置了價(jià)格自動(dòng)計(jì)算與滑點(diǎn)處理，因此調(diào)用者只需要設(shè)置基本的參數(shù)即可。

使用SwapKit對(duì)象的tradeBuilder屬性獲取預(yù)創(chuàng)建的TradeBuilder對(duì)象，例如：

const tb = await kit.tradeBuilder              //獲取預(yù)創(chuàng)建的兌換交易生成器
            ......                             //參數(shù)設(shè)置
            .build()                          //生成兌換交易對(duì)象

TradeBuilder提供了以下方法用于調(diào)整生成器的行為：

• tradeType(type) ：兌換類型，可選值為：

• Trade.EXACT_INPUT - 以tokenIn的數(shù)量為基準(zhǔn)

• Trade.EXACT_OUTPUT - 以tokenOut的數(shù)量為基準(zhǔn)

• tokenIn(addr) - 輸入Token的地址

• tokenOut(addr) - 輸出Token的地址

• amountIn(bn) - 輸入數(shù)量，僅在兌換類型為EXACT_INPUT時(shí)需要設(shè)置

• amountOut(bn) - 輸出數(shù)量，僅在兌換類型為EXACT_OUTPUT時(shí)需要設(shè)置

• slippage(bn) - 交易滑點(diǎn)設(shè)置，默認(rèn)值5， 表示允許0.5%的滑點(diǎn)

• to($addr) - 輸出token接收地址

例如，下面的代碼以輸入token數(shù)量為基準(zhǔn)生成一個(gè)兌換交易對(duì)象：

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

const trade = await kit.tradeBuilder                       //獲取兌換交易生成器
                    .tradeType(Trade.EXACT_INPUT)          //以輸入token數(shù)量為基準(zhǔn)
                    .tokenIn('0x...')                      //輸入token
                    .tokenOut('0x...')                     //輸出token
                    .amountIn(bn('10000000000000000000'))  //輸入token的數(shù)量
                    .slippage(bn('10'))                    //滑點(diǎn)容忍范圍1%
                    .to(kit.ownerAddress)                  //輸出token的接收地址
                    .build()                               //生成兌換交易對(duì)象
             
console.log(`amountIn => ${trade.amountIn}`)               //輸入token的設(shè)置數(shù)量
console.log(`amountOut => ${trade.amountOut}`)             //自動(dòng)做市算法得到的輸出token的數(shù)量
console.log(`amountOutMin => ${trade.amountOutMin}`)       //滑點(diǎn)處理后的應(yīng)收到的輸出token最少數(shù)量

3.6 執(zhí)行兌換交易

使用SwapKit對(duì)象的 executeTrade() 方法執(zhí)行指定的兌換交易對(duì)象。例如：

const tx = await kit.executeTrade(trade)                   //執(zhí)行兌換交易
console.log(`txid => ${tx.hash}`)                          //顯示交易ID

默認(rèn)情況下，executeTrade()方法自動(dòng)估算交易所需的gas限額與gas價(jià)格，但可以傳入額外的參數(shù)手動(dòng)設(shè)置這兩個(gè)值。

例如，下面的代碼使用設(shè)定的gas參數(shù)執(zhí)行兌換交易：

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

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

看完上述內(nèi)容是否對(duì)您有幫助呢？如果還想對(duì)相關(guān)知識(shí)有進(jìn)一步的了解或閱讀更多相關(guān)文章，請(qǐng)關(guān)注億速云行業(yè)資訊頻道，感謝您對(duì)億速云的支持。