本篇文章為大家展示了Uniswap Python開發(fā)包的概述以及部署使用方法,內(nèi)容簡明扼要并且容易理解,絕對能使你眼前一亮,通過這篇文章的詳細介紹希望你能有所收獲。
為尼金平等地區(qū)用戶提供了全套網(wǎng)頁設(shè)計制作服務(wù),及尼金平網(wǎng)站建設(shè)行業(yè)解決方案。主營業(yè)務(wù)為成都做網(wǎng)站、網(wǎng)站建設(shè)、外貿(mào)營銷網(wǎng)站建設(shè)、尼金平網(wǎng)站設(shè)計,以傳統(tǒng)方式定制建設(shè)網(wǎng)站,并提供域名空間備案等一條龍服務(wù),秉承以專業(yè)、用心的態(tài)度為用戶提供真誠的服務(wù)。我們深信只要達到每一位用戶的要求,就會得到認可,從而選擇與我們長期合作。這樣,我們也可以走得更遠!
Uniswap.py開發(fā)包適用于為Python應(yīng)用快速增加對Uniswap協(xié)議的支持能力。即支持使用自有部署以太坊區(qū)塊鏈節(jié)點的應(yīng)用場景,也支持使用第三方節(jié)點的輕量級部署場景,官方下載地址:Uniswap.py開發(fā)包
Uniswap.py開發(fā)包主要包含以下特性:
一鍵部署Uniswap協(xié)議,便于快速開發(fā)與測試
支持Uniswap協(xié)議的全部接口,并提供開發(fā)人員友好的API
支持ERC20/ERC20、ETH/ERC20等各種交易對的流動性添加、移除與兌換交易
支持自動做市價格計算與滑點計算
支持以太坊交易gas用量與gas價格的自動估算與手動設(shè)定
支持EIP712簽名授權(quán),單一交易內(nèi)完成流動性維護
Uniswap.py開發(fā)包運行在 Python 3.6+環(huán)境下,當前版本1.0.0,主要類/接口及關(guān)系如下圖所示:
Uniswap.py開發(fā)包的主要代碼文件清單見官方說明:http://sc.hubwiz.com/codebag/uniswap-py/
在終端進入項目目錄,執(zhí)行如下命令編譯Uniswap及開發(fā)包提供的測試Token合約:
~$ cd ~/uniswap.py ~/uniswap.py$ bin/build-contracts
執(zhí)行結(jié)果如下:
首先在另一個終端啟動開發(fā)私鏈:
~$ ganache-cli -d
然后進入項目demo目錄,執(zhí)行如下命令部署合約:
~$ cd ~/uniswap.py/demo ~/uniswap.py/demo$ python deploy_contracts.py
執(zhí)行結(jié)果如下:
注意:如果需要在以太坊測試鏈,例如Ropsten、Rinkeby等,或者在主鏈 部署上述合約,或者使用其他參數(shù)啟動ganache-cli,需要修改demo/config.py 中的賬號配置。
代碼token_approve.py
演示了如何授權(quán)Uniswap路由合約代理操作當前賬號的HAPY token和USDT token。
在終端進入項目demo目錄,執(zhí)行如下命令:
~$ cd ~/uniswap.py/demo ~/uniswap.py/demo$ python token_approve.py
執(zhí)行結(jié)果如下:
代碼add_liquidity.py
演示了如何為ERC20/ERC20交易對添加流動性。
在終端進入項目demo目錄,執(zhí)行如下命令:
~$ cd ~/uniswap.py/demo ~/uniswap.py/demo$ python add_liquidity.py
執(zhí)行結(jié)果如下:
Uniswap協(xié)議約定,第一次添加流動性將自動創(chuàng)建交易對,之后再次添加流動性時,演示代碼將首先顯示當前的倉位信息。例如再次執(zhí)行如下命令:
~/uniswap.py/demo$ python add_liquidity.py
執(zhí)行結(jié)果如下:
代碼remove_liquidity.py
演示了如何移除指定的ERC20/ERC20交易對的流動性。
在終端進入項目demo目錄,執(zhí)行如下命令:
~$ cd ~/uniswap.py/demo ~/uniswap.py/demo$ python remove_liquidity.py
執(zhí)行結(jié)果如下:
代碼swap_exact_tokens_for_tokens.py
演示了如何實現(xiàn)以輸入token數(shù)量為基準的ERC20/ERC20兌換。
在終端進入項目demo目錄,執(zhí)行如下命令:
~$ cd ~/uniswap.py/demo ~/uniswap.py/demo$ python swap_exact_tokens_for_tokens.py
執(zhí)行結(jié)果如下:
代碼swap_tokens_for_exact_tokens.py
演示了如何實現(xiàn)以輸出token數(shù)量為基準的ERC20/ERC20兌換。
在終端進入項目demo目錄,執(zhí)行如下命令:
~$ cd ~/uniswap.py/demo ~/uniswap.py/demo$ python swap_tokens_for_exact_tokens.py
執(zhí)行結(jié)果如下:
代碼add_liquidty_eth.py
演示了如何為ETH/ERC20或ERC20/ETH交易對添加流動性。
在終端進入項目demo目錄,執(zhí)行如下命令:
~$ cd ~/uniswap.py/demo ~/uniswap.py/demo$ python add_liquidity_eth.py
執(zhí)行結(jié)果如下:
第一次添加流動性將自動創(chuàng)建交易對,之后再次添加將首先顯示當前的持倉信息。例如再次執(zhí)行如下命令:
~/uniswap.py/demo$ python add_liquidity_eth.py
執(zhí)行結(jié)果如下:
代碼remove_liquidity_eth.py
演示了如何移除ETH/ERC20或ERC20/ETH交易對的流動性。
在終端進入項目demo目錄,執(zhí)行如下命令:
~$ cd ~/uniswap.py/demo ~/uniswap.py/demo$ python remove_liquidity_eth.py
執(zhí)行結(jié)果如下:
代碼swap_exact_eth_for_tokens.py
演示和如何將指定數(shù)量的ETH兌換為ERC20 token。
在終端進入項目demo目錄,執(zhí)行如下命令:
~$ cd ~/uniswap.py/demo ~/uniswap.py/demo$ python swap_exact_eth_for_tokens.py
執(zhí)行結(jié)果如下:
代碼swap_eth_for_exact_tokens.py
演示了如何將ETH兌換為指定數(shù)量的ERC20 token。
在終端進入項目demo目錄,執(zhí)行如下命令:
~$ cd ~/uniswap.py/demo ~/uniswap.py/demo$ python swap_eth_for_exact_tokens.py
執(zhí)行結(jié)果如下:
代碼swap_exact_tokens_for_eth.py
演示了如何將指定數(shù)量的ERC20 token兌換為ETH。
在終端進入項目demo目錄,執(zhí)行如下命令:
~$ cd ~/uniswap.py/demo ~/uniswap.py/demo$ python swap_exact_tokens_for_eth.py
執(zhí)行結(jié)果如下:
代碼swap_tokens_for_exact_eth.py
演示了如何將ERC20token兌換為指定數(shù)量的ETH。
在終端進入項目demo目錄,執(zhí)行如下命令:
~$ cd ~/uniswap.py/demo ~/uniswap.py/demo$ python swap_tokens_for_exact_eth.py
執(zhí)行結(jié)果如下:
SwapKit是開發(fā)包的入口,使用這個類可以快速實現(xiàn)如下功能:
流動性添加與移除:支持ERC20/ERC20、ERC20/ETH、ETH/ERC20等各種交易對
兌換交易的創(chuàng)建與執(zhí)行:支持ERC20/ERC20、ERC20/ETH、ETH/ERC20等各種交易對,支持以輸入或輸出價格為準
用戶倉位查詢:查詢指定賬號在指定交易對的持倉情況,例如持倉數(shù)量、占比等。
SwapKit實例化需要傳入三個參數(shù):
以太坊節(jié)點URL
Uniswap路由合約地址
用于執(zhí)行合約交互的以太坊賬號的私鑰。
例如,下面的代碼創(chuàng)建一個接入以太坊主網(wǎng)Uniswap協(xié)議的SwapKit實例:
from uniswap import SwapKit kit = SwapKit( 'http://localhost:8545', # 以太坊節(jié)點URL '0x7a250d5630B4...b4c659F2488D', # Uniswap路由合約地址 '0x4f3e...3b1d' # 默認執(zhí)行賬號,指定私鑰 );
為了避免混淆各網(wǎng)絡(luò)的Uniswap路由地址,uniswap.py提供了ProtocolMeta
類的靜態(tài)方法getPresetAddress()
來獲取Uniswap官方在以太坊主網(wǎng)和測試網(wǎng)部署的Uniswap協(xié)議合約地址。例如獲取主網(wǎng)的路由合約:
from uniswap import ProtocolMeta routerAddr = ProtocolMeta.getPresetAddress( SwapKit.MAINNET, # 以太坊主網(wǎng) SwapKit.ROUTER # Uniswap路由合約 ); print('router address: %s' % routerAddr) # 0x7a250d5630B4...
ProtocolMeta目前支持的以太坊網(wǎng)絡(luò)及標識見官網(wǎng)說明:http://sc.hubwiz.com/codebag/uniswap-py/
由于Uniswap協(xié)議中涉及到交易滑點處理以及價格預(yù)計算,因此uniswap.py提供了一個專門的類 OrderBuilder用于生成流動性添加/移除委托單。OrderBuilder的實現(xiàn)內(nèi)置了自動價格計算與滑點計算,因此調(diào)用者只需要指定基本的數(shù)據(jù)即可生成可提交給Uniswap合約的流動性添加/移除委托單。
使用SwapKit對象的orderBuilder
睡醒獲取預(yù)創(chuàng)建的OrderBuilder對象,并調(diào)用OrderBuilder的build()
方法生成委托單。例如:
order = ( kit.orderBuilder() # 返回OrderBuilder對象 .... # 參數(shù)設(shè)置 .build() # 生成并返回委托單 )
OrderBuilder對象提供了以下方法用于調(diào)整生成器的行為:
orderType(type):設(shè)置委托單類型,目前支持兩種:
Order.LIQUIDITY_ADD
- 流動性添加委托單
Order.LIQUIDITY_REMOVE
- 流動性移除委托單
tokenA(addr)/ tokenB(addr):交易對的兩個Token地址 用SwapKit.ETH_TOKEN表示以太幣的地址
amountA(bn)/ amountB(bn):兩個token的添加數(shù)量,僅在添加流動時需要設(shè)置
liquidity(bn):LP token數(shù)量,僅在移除流動性時需要設(shè)置
slippage(bn):交易滑點設(shè)置,默認值為5, 表示0.5%的滑點容忍區(qū)間
to(addr):委托單執(zhí)行結(jié)果接收地址
例如,下面的代碼生成一個流動性添加委托單:
from uniswap import SwapKit, Order order = ( kit.orderBuilder # 獲取委托單生成器對象 .orderType(Order.LIQUIDITY_ADD) # 添加流動性 .tokenA('0x...') # 交易對TokenA地址 .tokenB('0x...') # 交易對TokenB地址 .amountA(100000000000000000000) # 以TokenA數(shù)量為基準按市價自動計算TokenB數(shù)量 .slippage(10) # 滑點容忍范圍1% .to(kit.credential.address) # 設(shè)置LP Token的接收地址 .build() # 生成委托單 ) print('amountA => %d' % order.amountA) # TokenA設(shè)置數(shù)量 print('amountB => %d' % order.amountB) # TokenB計算數(shù)量 print('amountAMin => %d' % order.amountAMin) # 滑點處理后的TokenA最小可接受數(shù)量 print('amountBMin => %d' % order.amountAMin) # 滑點處理后的TokenB最小可接受數(shù)量
注意:
使用特殊的 SwapKit.ETH_TOKEN表示交易對中的ETH,值為:0x00000000000000000000000000000000000eEEEE
token數(shù)量均按最小單位指定
類似的,下面的代碼生成一個流動性移除委托單:
order = ( kit.orderBuilder # 獲取委托單生成器對象 .orderType(Order.LIQUIDITY_REMOVE) # 移除流動性 .tokenA('0x...') # 交易對TokenA地址 .tokenB('0x...') # 交易對TokenB地址 .liquidity(10000000000000000000) # 要移除的流動性數(shù)量 .slippage(10) # 滑點容忍范圍1% .to(kit.credential.address) # token接收地址 .build() # 生成委托單 ) print('amountAMin => %d' % order.amountAMin) # 滑點處理后最少應(yīng)收到的TokenA數(shù)量 print('amountBMin => %d' % order.amountAMin) # 滑點處理后最少應(yīng)收到的TokenB數(shù)量
Order對象提供的以下值,有助于在執(zhí)行委托單之前向用戶提供更好的反饋信息:
amountA/amountB:市價計算的tokenA或tokenB理想值
amountAMin/amountAMax:滑點處理后的tokenA最小值/最大值
amountBMin/amountBMax:滑點處理后的tokenB最小值/最大值
使用SwapKit的 executeOrder()方法即可執(zhí)行生成的流動性委托單,最終完成流動性添加/移除交易。例如:
from uniswap import to_hex txid = kit.executeOrder(trade) # 執(zhí)行委托單 print('txid => %s' % to_hex(txid)) # 顯示交易ID
默認情況下,executeOrder()
方法自動估算交易所需的gas限額與gas價格,但可以傳入額外的參數(shù)手動設(shè)置這兩個值。
例如,下面的代碼以指定的gas參數(shù)執(zhí)行流動性維護單:
from uniswap import to_hex opts = { 'gas': 4000000, # 4 million 'gasPrice': 200000000000 # 200 gwei } txid = kit.executeOrder(order, opts) # 執(zhí)行委托單 print('txid => %s' % to_hex(txid)) # 顯示交易ID
使用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']) # 持倉數(shù)量 print('share => %.4f' % info['share']) # 持倉比例
類似于流動性的添加與移除,在Uniswap中的交易對兌換也存在價格自動計算與滑點處理問題。為此,uniswap.py開發(fā)包提供了一個專門的類 TradeBuilder用來簡化這一操作。TradeBuilder內(nèi)置了價格自動計算與滑點處理,因此調(diào)用者只需要設(shè)置基本的參數(shù)即可。
使用SwapKit對象的tradeBuilder
屬性獲取預(yù)創(chuàng)建的TradeBuilder對象,例如:
trade = ( kit.tradeBuilder # 獲取預(yù)創(chuàng)建的兌換交易生成器 ... # 參數(shù)設(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
時需要設(shè)置
amountOut(bn)- 輸出數(shù)量,僅在兌換類型為EXACT_OUTPUT
時需要設(shè)置
slippage(bn)- 交易滑點設(shè)置,默認值5, 表示允許0.5%的滑點
to(addr)- 輸出token接收地址
例如,下面的代碼以輸入token數(shù)量為基準生成一個兌換交易對象:
from uniswap import Trade trade = ( kit.tradeBuilder # 獲取兌換交易生成器 .tradeType(Trade.EXACT_INPUT) # 以輸入token數(shù)量為基準 .tokenIn('0x...') # 輸入token地址 .tokenOut('0x...') # 輸出token地址 .amountIn(10000000000000000000) # 輸入token的數(shù)量 .slippage(10) # 滑點容忍范圍1% .to(kit.credential.address) # 輸出token的接收地址 .build() # 生成兌換交易對象 ) print('amountIn => %d' % trade.amountIn) # 輸入token的設(shè)置數(shù)量 print('amountOut => %d' % trade.amountOut) # 自動做市算法得到的輸出token的數(shù)量 print('amountOutMin => %d' % trade.amountOutMin) # 滑點處理后的應(yīng)收到的輸出token最少數(shù)量
使用SwapKit對象的 executeTrade()方法執(zhí)行指定的兌換交易對象。例如:
from uniswap import to_hex txid = kit.executeTrade(trade) # 執(zhí)行兌換交易 print('txid => %s' % to_hex(txid)) # 顯示交易ID
默認情況下,executeTrade()
方法自動估算交易所需的gas限額與gas價格,但可以傳入額外的參數(shù)手動設(shè)置這兩個值。
例如,下面的代碼使用設(shè)定的gas參數(shù)執(zhí)行兌換交易:
opts = { 'gas': 4000000, # 4 million 'gasPrice': 200000000000 # 200 gwei } txid = kit.executeTrade(trade, opts) # 執(zhí)行交易
上述內(nèi)容就是Uniswap Python開發(fā)包的概述以及部署使用方法,你們學到知識或技能了嗎?如果還想學到更多技能或者豐富自己的知識儲備,歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。