Mdex.js 開發包適用於爲Web前端或Node.js應用快速增加對HECO Mdex協議的支持能力。即支持使用自有部署火幣生態鏈區塊鏈節點的應用場景,也支持使用第三方節點的輕量級部署場景。官方下載地址:Mdex.js開發包
1、開發包概述
Mdex.js開發包主要包含以下特性:
- 一鍵部署Mdex協議,便於快速開發與測試
- 支持Mdex協議的全部接口,並提供開發人員友好的API
- 支持HRC20/HRC20、HT/HRC20等各種交易對的流動性添加、移除與兌換交易
- 支持自動做市價格計算與滑點計算
- 支持火幣生態鏈交易gas用量與gas價格的自動估算與手動設定
- 支持EIP712簽名授權,單一交易內完成流動性維護
Mdex.js開發包運行在 JavaScript 環境下,當前版本1.0.0,主要類/接口及關係如下圖所示:
Mdex.js開發包的主要代碼文件清單見官網說明:http://sc.hubwiz.com/codebag/mdex-js/
2、使用示例代碼
2.1 編譯合約
在終端進入項目目錄,執行如下命令編譯Mdex及開發包提供的測試Token合約:
~$ cd ~/mdex.js
~/mdex.js$ bin/build-contracts
執行結果如下:
2.2 部署合約
首先在另一個終端啓動開發私鏈:
~$ ganache-cli -d
然後進入項目demo目錄,執行如下命令部署合約:
~$ cd ~/mdex.js/demo
~/mdex.js/demo$ node deploy-contracts.js
執行結果如下:
注意 :如果需要在火幣生態鏈測試網或者主網部署上述合約, 或者使用其他參數啓動ganache-cli,需要修改config.js中的賬號配置。
2.3 Token授權
代碼demo/token-approve.js
演示瞭如何授權Mdex路由合約代理操作當前賬號的HAPY token和USDT token。
在終端進入項目demo目錄,執行如下命令:
~$ cd ~/mdex.js/demo
~/mdex.js/demo$ node token-approve.js
執行結果如下:
2.4 HRC20/HRC20交易對添加流動性
代碼demo/add-liquidity.js
演示瞭如何爲HRC20/HRC20交易對添加流動性。
在終端進入項目demo目錄,執行如下命令:
~$ cd ~/mdex.js/demo
~/mdex.js/demo$ node add-liquidity.js
執行結果如下:
Mdex協議約定,第一次添加流動性將自動創建交易對 ,之後再次添加 流動性時,演示代碼將首先顯示當前的倉位信息。例如再次執行如下命令:
~/mdex.js/demo$ node add-liquidity.js
執行結果如下:
2.5 HRC20/HRC20交易對移除流動性
代碼demo/remove-liquidity.js
演示瞭如何移除指定的HRC20/HRC20交易對的流動性。
在終端進入項目demo目錄,執行如下命令:
~$ cd ~/mdex.js/demo
~/mdex.js/demo$ node remove-liquidity.js
執行結果如下:
2.6 HRC20/HRC20兌換:以輸入token數量爲基準
代碼demo/swap-exact-tokens-for-tokens.js
演示瞭如何實現以輸入token數量爲基準的HRC20/HRC20兌換。
在終端進入項目demo目錄,執行如下命令:
~$ cd ~/mdex.js/demo
~/mdex.js/demo$ node swap-exact-tokens-for-tokens.js
執行結果如下:
2.7 HRC20/HRC20兌換:以輸出token數量爲基準
代碼demo/swap-tokens-for-exact-tokens.js
演示瞭如何實現以輸出token數量爲基準的HRC20/HRC20兌換。
在終端進入項目demo目錄,執行如下命令:
~$ cd ~/mdex.js/demo
~/mdex.js/demo$ node swap-tokens-for-exact-tokens.js
執行結果如下:
2.8 HT/HRC20交易對添加流動性
代碼demo/add-liquidty-ht.js
演示瞭如何爲HT/HRC20或HRC20/HT交易對添加流動性。
在終端進入項目demo目錄,執行如下命令:
~$ cd ~/mdex.js/demo
~/mdex.js/demo$ node add-liquidity-ht.js
執行結果如下:
第一次添加流動性將自動創建交易對,之後再次添加將首先顯示當前的持倉信息。例如再次執行如下命令:
~mdex.js/demo$ node add-liquidity-ht.js
執行結果如下:
2.9 HT/HRC20交易對移除流動性
代碼demo/remove-liquidity-ht.js
演示瞭如何移除HT/HRC20或HRC20/HT交易對的流動性。
在終端進入項目demo目錄,執行如下命令:
~$ cd ~/mdex.js/demo
~/mdex.js/demo$ node remove-liquidity-ht.js
執行結果如下:
2.10 HT/HRC20兌換:以輸入HT數量爲基準
代碼demo/swap-exact-ht-for-tokens.js
演示瞭如何將指定數量的HT兌換爲HRC20 token。
在終端進入項目demo目錄,執行如下命令:
~$ cd ~/mdex.js/demo
~/mdex.js/demo$ node swap-exact-ht-for-tokens.js
執行結果如下:
2.11 HT/HRC20兌換:以輸出token數量爲基準
代碼demo/swap-ht-for-exact-tokens.js
演示瞭如何將HT兌換爲指定數量的HRC20 token。
在終端進入項目demo目錄,執行如下命令:
~$ cd ~/mdex.js/demo
~/mdex.js/demo$ node swap-ht-for-exact-tokens.js
執行結果如下:
2.12 HRC20/HT兌換:以輸入token數量爲基準
代碼demo/swap-exact-tokens-for-ht.js
演示瞭如何將指定數量的HRC20 token兌換爲HT。
在終端進入項目demo目錄,執行如下命令:
~$ cd ~/mdex.js/demo
~/mdex.js/demo$ node swap-exact-tokens-for-ht.js
執行結果如下:
2.13 HRC20/HT兌換:以輸出HT數量爲基準
代碼demo/swap-tokens-for-exact-ht.js
演示瞭如何將HRC20token兌換爲指定數量的HT。
在終端進入項目demo目錄,執行如下命令:
~$ cd ~/mdex.js/demo
~/mdex.js/demo$ node swap-tokens-for-exact-ht.js
執行結果如下:
3、使用Mdex.js開發包
SwapKit 是開發包的入口,使用這個類可以快速實現如下功能:
- 流動性添加與移除:支持HRC20/HRC20、HRC20/HT、HT/HRC20等各種交易對
- 兌換交易的創建與執行:支持HRC20/HRC20、HRC20/HT、HT/HRC20等各種交易對,支持以輸入或輸出價格爲準
- 用戶倉位查詢:查詢指定賬號在指定交易對的持倉情況,例如持倉數量、佔比等。
3.1 實例化SwapKit
SwapKit實例化需要傳入三個參數:
- 火幣生態鏈節點URL
- Mdex路由合約地址
- 用於執行合約交互的火幣生態鏈賬號的私鑰。
例如,下面的代碼創建一個接入火幣生態鏈主網Mdex協議的SwapKit實例:
const { SwapKit } = require('Mdex.js')
const kit = new SwapKit(
'http://localhost:8545', //火幣生態鏈節點URL
'0x7a250d5630B4...b4c659F2488D', //Mdex路由合約地址
'0x4f3e...3b1d' //默認執行賬號的私鑰
)
3.2 生成流動性添加/移除委託單
由於Mdex協議中涉及到交易滑點處理以及價格預計算,因此Mdex.js提供了一個專門的類 OrderBuilder 用於生成流動性添加/移除委託單。OrderBuilder的實現內置了自動價格計算與滑點計算,因此調用者只需要指定基本的數據即可生成可提交給Mdex合約的流動性添加/移除委託單。
使用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('Mdex.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.NATIVE_TOKEN 表示交易對中的HT,值爲:
0x00000000000000000000000000000000000eeeee
bn(numstr)
是Mdex.js提供的一個創建 BigNumber 對象的快捷函數,其參數爲10進制字符串。- token數量均按最小單位指定
類似的,下面的代碼生成一個流動性移除委託單:
// const { SwapKit, Order, bn } = require('Mdex.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最小值/最大值
3.3 執行流動性委託單
使用SwapKit的 executeOrder() 方法即可執行生成的流動性委託單,最終完成流動性添加/移除交易。例如:
const tx = await kit->executeOrder($trade); //執行委託單
console.log(`txid => ${tx.hash}`) //顯示交易ID
默認情況下,executeOrder()
方法自動估算交易所需的gas限額與gas價格,但可以傳入額外的參數手動設置這兩個值。
例如,下面的代碼以指定的gas參數執行流動性維護單:
// const { bn } = require('Mdex.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 生成兌換交易對象
類似於流動性的添加與移除,在Mdex中的交易對兌換也存在價格自動計算與滑點處理問題。爲此,Mdex.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接收地址
例如,下面的代碼以輸入token數量爲基準生成一個兌換交易對象:
// const { SwapKit, Trade, bn } = require('Mdex.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('Mdex.js')
const opts = {
gasLimit: bn('4000000'), //4 million
gasPrice: bn('200000000000') //200 gwei
}
const tx = await kit.executeTrade(trade, opts) //執行交易
Mdex.js開發包官方鏈接:http://sc.hubwiz.com/codebag/mdex-js/