BakerySwap.js開發(fā)包使用教程

這篇文章主要講解了“BakerySwap.js開發(fā)包使用教程”,文中的講解內(nèi)容簡單清晰,易于學習與理解,下面請大家跟著小編的思路慢慢深入,一起來研究和學習“BakerySwap.js開發(fā)包使用教程”吧!

創(chuàng)新互聯(lián)建站-專業(yè)網(wǎng)站定制、快速模板網(wǎng)站建設、高性價比怒江州網(wǎng)站開發(fā)、企業(yè)建站全套包干低至880元,成熟完善的模板庫,直接使用。一站式怒江州網(wǎng)站制作公司更省心,省錢,快速模板網(wǎng)站建設找我們,業(yè)務覆蓋怒江州地區(qū)。費用合理售后完善,十載實體公司更值得信賴。

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

1、開發(fā)包概述

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

  • 一鍵部署B(yǎng)akerySwap協(xié)議,便于快速開發(fā)與測試

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

  • 支持BEP20/BEP20、BNB/BEP20等各種交易對的流動性添加、移除與兌換交易

  • 支持自動做市價格計算與滑點計算

  • 支持交易gas用量與gas價格的自動估算與手動設定

  • 支持EIP712簽名授權,單一交易內(nèi)完成流動性維護

BakerySwap.js開發(fā)包運行在 JavaScript環(huán)境下,當前版本1.0.0,主要類/接口及關系如下圖所示: BakerySwap.js開發(fā)包使用教程

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

2、使用示例代碼

2.1 編譯合約

在終端進入項目目錄,執(zhí)行如下命令編譯bakeryswap及開發(fā)包提供的測試Token合約:

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

執(zhí)行結果如下:

BakerySwap.js開發(fā)包使用教程

2.2 部署合約

首先在另一個終端啟動開發(fā)私鏈:

~$ ganache-cli -d

然后進入項目demo目錄,執(zhí)行如下命令部署合約:

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

執(zhí)行結果如下:

BakerySwap.js開發(fā)包使用教程

注意:如果需要在BSC主鏈或測試鏈部署上述合約,或者使用其他參數(shù)啟動ganache-cli, 需要修改config.js中的賬號配置。

2.3 Token授權

代碼demo/token-approve.js演示了如何授權bakeryswap路由合約代理操作當前賬號的HAPY token和USDT token。

在終端進入項目demo目錄,執(zhí)行如下命令:

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

執(zhí)行結果如下:

BakerySwap.js開發(fā)包使用教程

2.4 BEP20/BEP20交易對添加流動性

代碼demo/add-liquidity.js演示了如何為BEP20/BEP20交易對添加流動性。

在終端進入項目demo目錄,執(zhí)行如下命令:

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

執(zhí)行結果如下:

BakerySwap.js開發(fā)包使用教程

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

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

執(zhí)行結果如下:

BakerySwap.js開發(fā)包使用教程

2.5 BEP20/BEP20交易對移除流動性

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

在終端進入項目demo目錄,執(zhí)行如下命令:

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

執(zhí)行結果如下:

BakerySwap.js開發(fā)包使用教程

2.6 BEP20/BEP20兌換:以輸入token數(shù)量為基準

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

在終端進入項目demo目錄,執(zhí)行如下命令:

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

執(zhí)行結果如下:

BakerySwap.js開發(fā)包使用教程

2.7 BEP20/BEP20兌換:以輸出token數(shù)量為基準

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

在終端進入項目demo目錄,執(zhí)行如下命令:

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

執(zhí)行結果如下:

BakerySwap.js開發(fā)包使用教程

2.8 BNB/BEP20交易對添加流動性

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

在終端進入項目demo目錄,執(zhí)行如下命令:

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

執(zhí)行結果如下:

BakerySwap.js開發(fā)包使用教程

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

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

執(zhí)行結果如下:

BakerySwap.js開發(fā)包使用教程

2.9 BNB/BEP20交易對移除流動性

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

在終端進入項目demo目錄,執(zhí)行如下命令:

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

執(zhí)行結果如下:

BakerySwap.js開發(fā)包使用教程

2.10 BNB/BEP20兌換:以輸入BNB數(shù)量為基準

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

在終端進入項目demo目錄,執(zhí)行如下命令:

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

執(zhí)行結果如下:

BakerySwap.js開發(fā)包使用教程

2.11 BNB/BEP20兌換:以輸出token數(shù)量為基準

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

在終端進入項目demo目錄,執(zhí)行如下命令:

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

執(zhí)行結果如下:

BakerySwap.js開發(fā)包使用教程

2.12 BEP20/BNB兌換:以輸入token數(shù)量為基準

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

在終端進入項目demo目錄,執(zhí)行如下命令:

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

執(zhí)行結果如下:

BakerySwap.js開發(fā)包使用教程

2.13 BEP20/BNB兌換:以輸出BNB數(shù)量為基準

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

在終端進入項目demo目錄,執(zhí)行如下命令:

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

執(zhí)行結果如下:

BakerySwap.js開發(fā)包使用教程

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

SwapKit是開發(fā)包的入口,使用這個類可以快速實現(xiàn)如下功能:

  • 流動性添加與移除:支持BEP20/BEP20、BEP20/BNB、BNB/BEP20等各種交易對

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

  • 用戶倉位查詢:查詢指定賬號在指定交易對的持倉情況,例如持倉數(shù)量、占比等。

3.1 實例化SwapKit

SwapKit實例化需要傳入三個參數(shù):

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

  • bakeryswap路由合約地址

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

例如,下面的代碼創(chuàng)建一個接入BSC主網(wǎng)bakeryswap協(xié)議的SwapKit實例:

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

const kit = new SwapKit(
  'https://bsc-dataseed.binance.org',               //幣安智能鏈節(jié)點URL
  '0xCDe540d7eAFE93aC5fE6233Bee57E1270D3E330F',     //BSC主鏈bakeryswap路由合約地址
  '0x4f3e...3b1d'                                   //默認執(zhí)行賬號的私鑰                                 
)

3.2 生成流動性添加/移除委托單

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

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

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

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

  • orderType(type):設置委托單類型,目前支持兩種:

    • Order.LIQUIDITY_ADD - 流動性添加委托單

    • Order.LIQUIDITY_REMOVE - 流動性移除委托單

  • tokenA(addr)/ tokenB(addr):交易對的兩個Token地址

  • amountA(bn)/ amountB(bn):兩個token的添加數(shù)量,僅在添加流動時需要設置

  • liquidity(bn):LP token數(shù)量,僅在移除流動性時需要設置

  • slippage(bn):交易滑點設置,默認值為5, 表示0.5%的滑點容忍區(qū)間

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

例如,下面的代碼生成一個流動性添加委托單:

// 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數(shù)量為基準按市價自動計算TokenB數(shù)量
                    .slippage(bn('10'))                      //滑點容忍范圍1%
                    .to(kit.ownerAddress)                    //設置LP Token的接收地址
                    .build()                                 //生成委托單 
             
console.log(`amountA => ${order.amountA}`)                   //TokenA設置數(shù)量  
console.log(`amountB => ${order.amountB}`)                   //TokenB計算數(shù)量 
console.log(`amountAMin => ${order.amountAMin}`)             //滑點處理后的TokenA最小可接受數(shù)量 
console.log(`amountBMin => ${order.amountBMin}`)             //滑點處理后的TokenB最小可接受數(shù)量

注意:

  • 使用特殊的 SwapKit.ETH_TOKEN表示交易對中的BNB,值為:0x00000000000000000000000000000000000eeeee

  • bn(numstr) 是bakeryswap.js提供的一個創(chuàng)建 BigNumber 對象 的快捷函數(shù),其參數(shù)為10進制字符串。

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

類似的,下面的代碼生成一個流動性移除委托單:

// 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'))    //要移除的流動性數(shù)量
                    .slippage(bn('10'))                       //滑點容忍范圍1%
                    .to(kit.ownerAddress)                     //token接收地址
                    .build()                                  //生成委托單 

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

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

  • amountA/amountB:市價計算的tokenA或tokenB理想值

  • amountAMin/amountAMax:滑點處理后的tokenA最小值/最大值

  • amountBMin/amountBMax:滑點處理后的tokenB最小值/最大值

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

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

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

默認情況下,executeOrder()方法自動估算交易所需的gas限額與gas價格,但可以傳入額外的參數(shù)手動設置這兩個值。

例如,下面的代碼以指定的gas參數(shù)執(zhí)行流動性維護單:

// const { bn } = require('bakeryswap.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()方法可以查詢指定賬號在指定交易對的倉位信息。例如查詢某地址的持倉情況:

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 生成兌換交易對象

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

使用SwapKit對象的tradeBuilder屬性獲取預創(chuàng)建的TradeBuilder對象,例如:

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

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

  • tradeType(type):兌換類型,可選值為:

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

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

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

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

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

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

  • slippage(bn)- 交易滑點設置,默認值5, 表示允許0.5%的滑點

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

例如,下面的代碼以輸入token數(shù)量為基準生成一個兌換交易對象:

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

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

3.6 執(zhí)行兌換交易

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

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

默認情況下,executeTrade()方法自動估算交易所需的gas限額與gas價格,但可以傳入額外的參數(shù)手動設置這兩個值。

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

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

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

bakeryswap.js官方下載鏈接:http://sc.hubwiz.com/codebag/bakeryswap-js/

感謝各位的閱讀,以上就是“BakerySwap.js開發(fā)包使用教程”的內(nèi)容了,經(jīng)過本文的學習后,相信大家對BakerySwap.js開發(fā)包使用教程這一問題有了更深刻的體會,具體使用情況還需要大家實踐驗證。這里是創(chuàng)新互聯(lián),小編將為大家推送更多相關知識點的文章,歡迎關注!

網(wǎng)頁標題:BakerySwap.js開發(fā)包使用教程
本文鏈接:http://muchs.cn/article6/jcppig.html

成都網(wǎng)站建設公司_創(chuàng)新互聯(lián),為您提供網(wǎng)站設計公司、營銷型網(wǎng)站建設網(wǎng)頁設計公司、小程序開發(fā)關鍵詞優(yōu)化、網(wǎng)站改版

廣告

聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉載內(nèi)容為主,如果涉及侵權請盡快告知,我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場,如需處理請聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉載,或轉載時需注明來源: 創(chuàng)新互聯(lián)

手機網(wǎng)站建設