Uniswap Python开发包的概述以及部署使用方法

发布时间:2021-10-09 17:27:33 作者:柒染
来源:亿速云 阅读:361

本篇文章为大家展示了Uniswap Python开发包的概述以及部署使用方法,内容简明扼要并且容易理解,绝对能使你眼前一亮,通过这篇文章的详细介绍希望你能有所收获。

Uniswap.py 开发包适用于为Python应用快速增加对Uniswap协议的支持能力。即支持使用自有部署以太坊区块链节点的应用场景,也支持使用第三方节点的轻量级部署场景,官方下载地址:Uniswap.py开发包

1、开发包概述

Uniswap.py开发包主要包含以下特性:

Uniswap.py开发包运行在 Python 3.6+ 环境下,当前版本1.0.0,主要类/接口及关系如下图所示:

Uniswap Python开发包的概述以及部署使用方法

Uniswap.py开发包的主要代码文件清单见官方说明:http://sc.hubwiz.com/codebag/uniswap-py/

2、使用示例代码

2.1 编译合约

在终端进入项目目录,执行如下命令编译Uniswap及开发包提供的测试Token合约:

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

执行结果如下:

Uniswap Python开发包的概述以及部署使用方法

2.2 部署合约

首先在另一个终端启动开发私链:

~$ ganache-cli -d

然后进入项目demo目录,执行如下命令部署合约:

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

执行结果如下:

Uniswap Python开发包的概述以及部署使用方法

注意 :如果需要在以太坊测试链,例如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

执行结果如下:

Uniswap Python开发包的概述以及部署使用方法

2.4 ERC20/ERC20交易对添加流动性

代码add_liquidity.py演示了如何为ERC20/ERC20交易对添加流动性。

在终端进入项目demo目录,执行如下命令:

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

执行结果如下:

Uniswap Python开发包的概述以及部署使用方法

Uniswap协议约定,第一次添加流动性将自动创建交易对 ,之后再次添加流动性时,演示代码将首先显示当前的仓位信息。例如再次执行如下命令:

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

执行结果如下:

Uniswap Python开发包的概述以及部署使用方法

2.5 ERC20/ERC20交易对移除流动性

代码remove_liquidity.py演示了如何移除指定的ERC20/ERC20交易对的流动性。

在终端进入项目demo目录,执行如下命令:

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

执行结果如下:

Uniswap Python开发包的概述以及部署使用方法

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

执行结果如下:

Uniswap Python开发包的概述以及部署使用方法

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

执行结果如下:

Uniswap Python开发包的概述以及部署使用方法

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 Python开发包的概述以及部署使用方法

第一次添加流动性将自动创建交易对,之后再次添加将首先显示当前的持仓信息。例如再次执行如下命令:

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

执行结果如下:

Uniswap Python开发包的概述以及部署使用方法

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

执行结果如下:

Uniswap Python开发包的概述以及部署使用方法

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

执行结果如下:

Uniswap Python开发包的概述以及部署使用方法

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

执行结果如下:

Uniswap Python开发包的概述以及部署使用方法

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

执行结果如下:

Uniswap Python开发包的概述以及部署使用方法

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

执行结果如下:

Uniswap Python开发包的概述以及部署使用方法

3、使用uniswap.py开发包

SwapKit 是开发包的入口,使用这个类可以快速实现如下功能:

3.1 实例化SwapKit

SwapKit实例化需要传入三个参数:

例如,下面的代码创建一个接入以太坊主网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对象提供了以下方法用于调整生成器的行为:

例如,下面的代码生成一个流动性添加委托单:

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最小可接受数量

注意:

类似的,下面的代码生成一个流动性移除委托单:

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对象提供的以下值,有助于在执行委托单之前向用户提供更好的反馈信息:

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提供了以下方法用于调整生成器的行为:

例如,下面的代码以输入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 Python开发包的概述以及部署使用方法,你们学到知识或技能了吗?如果还想学到更多技能或者丰富自己的知识储备,欢迎关注亿速云行业资讯频道。

推荐阅读:
  1. 大数据技术学习路线,该怎么学?
  2. 3G手机视频对讲开发包

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

上一篇:数据库索引优秀的原因有哪些

下一篇:创建索引的方法步骤有哪些

相关阅读

您好,登录后才能下订单哦!

密码登录
登录注册
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》