Uniswap Python開發包【DEX】

Uniswap.py 開發包適用於爲Python應用快速增加對Uniswap協議的支持能力。即支持使用自有部署以太坊區塊鏈節點的應用場景，也支持使用第三方節點的輕量級部署場景，官方下載地址：Uniswap.py開發包

1、開發包概述

Uniswap.py開發包主要包含以下特性：

• 一鍵部署Uniswap協議，便於快速開發與測試
• 支持Uniswap協議的全部接口，並提供開發人員友好的API
• 支持ERC20/ERC20、ETH/ERC20等各種交易對的流動性添加、移除與兌換交易
• 支持自動做市價格計算與滑點計算
• 支持以太坊交易gas用量與gas價格的自動估算與手動設定
• 支持EIP712簽名授權，單一交易內完成流動性維護

Uniswap.py開發包運行在 Python 3.6+ 環境下，當前版本1.0.0，主要類/接口及關係如下圖所示：

Uniswap.py開發包的主要代碼文件清單見官方說明：http://sc.hubwiz.com/codebag/uniswap-py/

2、使用示例代碼

2.1 編譯合約

在終端進入項目目錄，執行如下命令編譯Uniswap及開發包提供的測試Token合約：

~$ cd ~/uniswap.py
~/uniswap.py$ bin/build-contracts

執行結果如下：

2.2 部署合約

首先在另一個終端啓動開發私鏈：

~$ ganache-cli -d

然後進入項目demo目錄，執行如下命令部署合約：

~$ cd ~/uniswap.py/demo
~/uniswap.py/demo$ python deploy_contracts.py

執行結果如下：

注意 ：如果需要在以太坊測試鏈，例如Ropsten、Rinkeby等，或者在主鏈 部署上述合約，或者使用其他參數啓動ganache-cli，需要修改demo/config.py 中的賬號配置。

2.3 Token授權

代碼token_approve.py演示瞭如何授權Uniswap路由合約代理操作當前賬號的HAPY token和USDT token。

在終端進入項目demo目錄，執行如下命令：

~$ cd ~/uniswap.py/demo
~/uniswap.py/demo$ python token_approve.py

執行結果如下：

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

代碼add_liquidity.py演示瞭如何爲ERC20/ERC20交易對添加流動性。

在終端進入項目demo目錄，執行如下命令：

~$ cd ~/uniswap.py/demo
~/uniswap.py/demo$ python add_liquidity.py

執行結果如下：

Uniswap協議約定，第一次添加流動性將自動創建交易對 ，之後再次添加流動性時，演示代碼將首先顯示當前的倉位信息。例如再次執行如下命令：

~/uniswap.py/demo$ python add_liquidity.py

執行結果如下：

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

代碼remove_liquidity.py演示瞭如何移除指定的ERC20/ERC20交易對的流動性。

在終端進入項目demo目錄，執行如下命令：

~$ cd ~/uniswap.py/demo
~/uniswap.py/demo$ python remove_liquidity.py

執行結果如下：

2.6 ERC20/ERC20兌換：以輸入token數量爲基準

代碼swap_exact_tokens_for_tokens.py演示瞭如何實現以輸入token數量爲基準的ERC20/ERC20兌換。

在終端進入項目demo目錄，執行如下命令：

~$ cd ~/uniswap.py/demo
~/uniswap.py/demo$ python swap_exact_tokens_for_tokens.py

執行結果如下：

2.7 ERC20/ERC20兌換：以輸出token數量爲基準

代碼swap_tokens_for_exact_tokens.py演示瞭如何實現以輸出token數量爲基準的ERC20/ERC20兌換。

在終端進入項目demo目錄，執行如下命令：

~$ cd ~/uniswap.py/demo
~/uniswap.py/demo$ python swap_tokens_for_exact_tokens.py

執行結果如下：

2.8 ETH/ERC20交易對添加流動性

代碼add_liquidty_eth.py演示瞭如何爲ETH/ERC20或ERC20/ETH交易對添加流動性。

在終端進入項目demo目錄，執行如下命令：

~$ cd ~/uniswap.py/demo
~/uniswap.py/demo$ python add_liquidity_eth.py

執行結果如下：

第一次添加流動性將自動創建交易對，之後再次添加將首先顯示當前的持倉信息。例如再次執行如下命令：

~/uniswap.py/demo$ python add_liquidity_eth.py

執行結果如下：

2.9 ETH/ERC20交易對移除流動性

代碼remove_liquidity_eth.py演示瞭如何移除ETH/ERC20或ERC20/ETH交易對的流動性。

在終端進入項目demo目錄，執行如下命令：

~$ cd ~/uniswap.py/demo
~/uniswap.py/demo$ python remove_liquidity_eth.py

執行結果如下：

2.10 ETH/ERC20兌換：以輸入ETH數量爲基準

代碼swap_exact_eth_for_tokens.py演示和如何將指定數量的ETH兌換爲ERC20 token。

在終端進入項目demo目錄，執行如下命令：

~$ cd ~/uniswap.py/demo
~/uniswap.py/demo$ python swap_exact_eth_for_tokens.py

執行結果如下：

2.11 ETH/ERC20兌換：以輸出token數量爲基準

代碼swap_eth_for_exact_tokens.py演示瞭如何將ETH兌換爲指定數量的ERC20 token。

在終端進入項目demo目錄，執行如下命令：

~$ cd ~/uniswap.py/demo
~/uniswap.py/demo$ python swap_eth_for_exact_tokens.py

執行結果如下：

2.12 ERC20/ETH兌換：以輸入token數量爲基準

代碼swap_exact_tokens_for_eth.py演示瞭如何將指定數量的ERC20 token兌換爲ETH。

在終端進入項目demo目錄，執行如下命令：

~$ cd ~/uniswap.py/demo
~/uniswap.py/demo$ python swap_exact_tokens_for_eth.py

執行結果如下：

2.13 ERC20/ETH兌換：以輸出ETH數量爲基準

代碼swap_tokens_for_exact_eth.py演示瞭如何將ERC20token兌換爲指定數量的ETH。

在終端進入項目demo目錄，執行如下命令：

~$ cd ~/uniswap.py/demo
~/uniswap.py/demo$ python swap_tokens_for_exact_eth.py

執行結果如下：

3、使用uniswap.py開發包

SwapKit 是開發包的入口，使用這個類可以快速實現如下功能：

• 流動性添加與移除：支持ERC20/ERC20、ERC20/ETH、ETH/ERC20等各種交易對
• 兌換交易的創建與執行：支持ERC20/ERC20、ERC20/ETH、ETH/ERC20等各種交易對，支持以輸入或輸出價格爲準
• 用戶倉位查詢：查詢指定賬號在指定交易對的持倉情況，例如持倉數量、佔比等。

3.1 實例化SwapKit

SwapKit實例化需要傳入三個參數：

• 以太坊節點URL
• Uniswap路由合約地址
• 用於執行合約交互的以太坊賬號的私鑰。

例如，下面的代碼創建一個接入以太坊主網Uniswap協議的SwapKit實例：

from uniswap import SwapKit

kit = SwapKit(
  'http://localhost:8545',                          # 以太坊節點URL
  '0x7a250d5630B4...b4c659F2488D',                  # Uniswap路由合約地址
  '0x4f3e...3b1d'                                   # 默認執行賬號，指定私鑰
);

3.2 使用ProtocolMeta（可選）

爲了避免混淆各網絡的Uniswap路由地址，uniswap.py 提供了ProtocolMeta類的靜態方法getPresetAddress()來獲取Uniswap官方在以太坊主網和測試網部署的Uniswap協議合約地址。例如獲取主網的路由合約：

from uniswap import ProtocolMeta

routerAddr = ProtocolMeta.getPresetAddress(
  SwapKit.MAINNET,                                   # 以太坊主網  
  SwapKit.ROUTER                                     # Uniswap路由合約
);
print('router address: %s' % routerAddr)             # 0x7a250d5630B4...

ProtocolMeta 目前支持的以太坊網絡及標識見官網說明：http://sc.hubwiz.com/codebag/uniswap-py/

3.3 生成流動性添加/移除委託單

由於Uniswap協議中涉及到交易滑點處理以及價格預計算，因此uniswap.py提供了一個專門的類 OrderBuilder 用於生成流動性添加/移除委託單。OrderBuilder的實現內置了自動價格計算與滑點計算，因此調用者只需要指定基本的數據即可生成可提交給Uniswap合約的流動性添加/移除委託單。

使用SwapKit對象的orderBuilder睡醒獲取預創建的OrderBuilder對象，並調用OrderBuilder的build() 方法生成委託單。例如：

order = (
  kit.orderBuilder()                # 返回OrderBuilder對象 
     ....                           # 參數設置
     .build()                       # 生成並返回委託單
)

OrderBuilder對象提供了以下方法用於調整生成器的行爲：

• orderType(type) ：設置委託單類型，目前支持兩種：
  • Order.LIQUIDITY_ADD - 流動性添加委託單
  • Order.LIQUIDITY_REMOVE - 流動性移除委託單
• tokenA(addr) / tokenB(addr) ：交易對的兩個Token地址 用SwapKit.ETH_TOKEN表示以太幣的地址
• amountA(bn) / amountB(bn) ：兩個token的添加數量，僅在添加流動時需要設置
• liquidity(bn) ：LP token數量，僅在移除流動性時需要設置
• slippage(bn) ：交易滑點設置，默認值爲5， 表示0.5%的滑點容忍區間
• to(addr) ：委託單執行結果接收地址

例如，下面的代碼生成一個流動性添加委託單：

from uniswap import SwapKit, Order

order = (
  kit.orderBuilder                              # 獲取委託單生成器對象
     .orderType(Order.LIQUIDITY_ADD)            # 添加流動性
     .tokenA('0x...')                           # 交易對TokenA地址
     .tokenB('0x...')                           # 交易對TokenB地址
     .amountA(100000000000000000000)            # 以TokenA數量爲基準按市價自動計算TokenB數量
     .slippage(10)                              # 滑點容忍範圍1%
     .to(kit.credential.address)                # 設置LP Token的接收地址
     .build()                                   # 生成委託單 
)
             
print('amountA => %d' % order.amountA)          # TokenA設置數量  
print('amountB => %d' % order.amountB)          # TokenB計算數量 
print('amountAMin => %d' % order.amountAMin)    # 滑點處理後的TokenA最小可接受數量 
print('amountBMin => %d' % order.amountAMin)    # 滑點處理後的TokenB最小可接受數量

注意：

• 使用特殊的 SwapKit.ETH_TOKEN 表示交易對中的ETH，值爲：0x00000000000000000000000000000000000eEEEE
• token數量均按最小單位指定

類似的，下面的代碼生成一個流動性移除委託單：

order = (
  kit.orderBuilder                              # 獲取委託單生成器對象
     .orderType(Order.LIQUIDITY_REMOVE)         # 移除流動性  
     .tokenA('0x...')                           # 交易對TokenA地址 
     .tokenB('0x...')                           # 交易對TokenB地址 
     .liquidity(10000000000000000000)           # 要移除的流動性數量
     .slippage(10)                              # 滑點容忍範圍1%
     .to(kit.credential.address)                # token接收地址
     .build()                                   # 生成委託單 
)

print('amountAMin => %d' % order.amountAMin)   # 滑點處理後最少應收到的TokenA數量 
print('amountBMin => %d' % order.amountAMin)   # 滑點處理後最少應收到的TokenB數量

Order對象提供的以下值，有助於在執行委託單之前向用戶提供更好的反饋信息：

• amountA/amountB ：市價計算的tokenA或tokenB理想值
• amountAMin/amountAMax ：滑點處理後的tokenA最小值/最大值
• amountBMin/amountBMax ：滑點處理後的tokenB最小值/最大值

3.4 執行流動性委託單

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

from uniswap import to_hex

txid = kit.executeOrder(trade)                  # 執行委託單
print('txid => %s' % to_hex(txid))              # 顯示交易ID 

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

例如，下面的代碼以指定的gas參數執行流動性維護單：

from uniswap import to_hex

opts = {
  'gas': 4000000,                                # 4 million
  'gasPrice': 200000000000                       # 200 gwei
}
txid = kit.executeOrder(order, opts)             # 執行委託單
print('txid => %s' % to_hex(txid))               # 顯示交易ID

3.5 查詢倉位信息

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

info = kit.getLiquidityInfo(                      # 查詢持倉信息
  '0x90F8...c9C1',                                # 要查詢的地址
  '0x9956...F4B8',                                # 交易對tokenA地址
  '0x94dF...2Df7'                                 # 交易對tokenB地址
)       

print('total => %d' % info['totalSupply'])        # LP Token總量 
print('balance => %d' % info['balance'])          # 持倉數量
print('share => %.4f' % info['share'])            # 持倉比例

3.6 生成兌換交易對象

類似於流動性的添加與移除，在Uniswap中的交易對兌換也存在價格自動計算與滑點處理問題。爲此，uniswap.py開發包提供了一個專門的類 TradeBuilder用來簡化這一操作。TradeBuilder內置了價格自動計算與滑點處理，因此調用者只需要設置基本的參數即可。

使用SwapKit對象的tradeBuilder屬性獲取預創建的TradeBuilder對象，例如：

trade = (
  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數量爲基準生成一個兌換交易對象：

from uniswap import Trade

trade = (
  kit.tradeBuilder                            # 獲取兌換交易生成器
     .tradeType(Trade.EXACT_INPUT)            # 以輸入token數量爲基準
     .tokenIn('0x...')                        # 輸入token地址
     .tokenOut('0x...')                       # 輸出token地址
     .amountIn(10000000000000000000)          # 輸入token的數量
     .slippage(10)                            # 滑點容忍範圍1%
     .to(kit.credential.address)              # 輸出token的接收地址
     .build()                                 # 生成兌換交易對象
)
             
print('amountIn => %d' % trade.amountIn)          # 輸入token的設置數量
print('amountOut => %d' % trade.amountOut)        # 自動做市算法得到的輸出token的數量
print('amountOutMin => %d' % trade.amountOutMin)  # 滑點處理後的應收到的輸出token最少數量

3.7 執行兌換交易

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

from uniswap import to_hex

txid = kit.executeTrade(trade)                       # 執行兌換交易
print('txid => %s' % to_hex(txid))                   # 顯示交易ID

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

例如，下面的代碼使用設定的gas參數執行兌換交易：

opts = {
  'gas': 4000000,                                     # 4 million
  'gasPrice': 200000000000                            # 200 gwei
}
txid = kit.executeTrade(trade, opts)                  # 執行交易

---

Uniswap.py官方下載鏈接：http://sc.hubwiz.com/codebag/uniswap-py/