快速安装¶
环境要求¶
依赖软件
- Ubuntu:
sudo apt install -y zlib1g-dev libffi6 libffi-dev wget git
- CentOS:
sudo yum install -y zlib-devel libffi-devel wget git
- MacOs:
brew install wget npm git
Python环境要求
- 支持版本:
- python 3.6.3
- 3.7.x
部署Python SDK¶
环境要求¶
- Python环境:python 3.6.3, 3.7.x
- FISCO BCOS节点:请参考FISCO BCOS安装搭建
初始化环境(若python环境符合要求,可跳过)¶
Linux环境初始化¶
拉取源代码
git clone https://github.com/FISCO-BCOS/python-sdk
配置环境
注解
bash init_env.sh -p
主要功能是安装pyenv,并使用pyenv安装名称为python-sdk
的python-3.7.3虚拟环境- 若python环境符合要求,可以跳过此步
- 若脚本执行出错,请检查是否参考[依赖软件]说明安装了依赖
- 安装python-3.7.3可能耗时比较久
- 此步骤仅需初始化一遍,再次登录直接使用命令
pyenv activate python-sdk
激活python-sdk
虚拟环境即可
# 判断python版本,并为不符合条件的python环境安装python 3.7.3的虚拟环境,命名为python-sdk
# 若python环境符合要求,可以跳过此步
# 若脚本执行出错,请检查是否参考[依赖软件]说明安装了依赖
# 提示:安装python-3.7.3可能耗时比较久
cd python-sdk && bash init_env.sh -p
# 激活python-sdk虚拟环境
source ~/.bashrc && pyenv activate python-sdk && pip install --upgrade pip
Windows环境初始化¶
在Windows运行Python SDK,需要按照以下步骤安装依赖软件并配置合约编译器:
安装依赖软件
注解
- Microsoft Visual C++ 14.0 is required. Get it with “Microsoft Visual C++ Build Tools”解决方法: https://visualstudio.microsoft.com/downloads (注意选择vs 2005即14.0版)或 https://pan.baidu.com/s/1ZmDUGZjZNgFJ8D14zBu9og 提取码: zrby
- solc编译器下载成功后,解压,将其中的
solc.exe
文件复制${python-sdk}\bin
目录下,若python-sdk路径为D:\\open-source\\python-sdk
, 则solc.exe
文件复制路径为D:\\open-source\\python-sdk\\bin\\solc.exe
- 直接安装Python-3.7.x和git软件 python环境变量配置可参考这里
- Visual C++ 14.0库
- 下载Windows版本solc, 点击这里下载
拉取源代码
打开 git,在任意目录执行如下命令
git clone https://github.com/FISCO-BCOS/python-sdk
配置solc编译器
修改client_config.py.template
,配置solc
编译器路径,solc二进制下载请参考bcos_solc.py
中的描述,并将client_config.py.template
拷贝为client_config.py
。
# 修改client_config.py.template:
# 配置solc编译器路径,若solc存放路径为D:\\open-source\\python-sdk\\bin\\solc.exe,则solc_path配置如下:
solc_path = "D:\\open-source\\python-sdk\\bin\\solc.exe"
# 将client_config.py.template拷贝到client_config.py
安装Python SDK依赖¶
pip install -r requirements.txt
若因网络原因,安装依赖失败,可使用清华的pip源下载,安装命令如下:
pip install -i https://pypi.tuna.tsinghua.edu.cn/simple -r requirements.txt
初始化配置(Windows环境可跳过)¶
# 该脚本执行操作如下:
# 1. 拷贝client_config.py.template->client_config.py
# 2. 安装solc编译器
bash init_env.sh -i
若MacOS环境solc安装较慢,可在python-sdk目录下执行如下命令安装solcjs,python-sdk自动从该路径加载nodejs编译器:
# 安装编译器
npm install solc@v0.4.25
若没有执行以上初始化步骤,需要将contracts/
目录下的sol
代码手动编译成bin
和abi
文件并放置于contracts
目录,才可以部署和调用相应合约。合约编译可以使用remix
配置Channel通信协议¶
Python SDK支持使用Channel协议与FISCO BCOS节点通信,通过SSL加密通信保障SDK与节点通信的机密性。
设SDK连接的节点部署在目录~/fisco/nodes/127.0.0.1
目录下,则通过如下步骤使用Channel协议:
配置Channel信息
在节点目录下的 config.ini 文件中获取 channel_listen_port, 这里为20200
[rpc]
listen_ip=0.0.0.0
channel_listen_port=20200
jsonrpc_listen_port=8545
切换到python-sdk目录,修改 client_config.py 文件中channel_host
为实际的IP,channel_port
为上步获取的channel_listen_port
:
channel_host = "127.0.0.1"
channel_port = 20200
配置证书
# 若节点与python-sdk位于不同机器,请将节点sdk目录下所有相关文件拷贝到bin目录
# 若节点与sdk位于相同机器,直接拷贝节点证书到SDK配置目录
cp ~/fisco/nodes/127.0.0.1/sdk/* bin/
配置证书路径
注解
client_config.py
的channel_node_cert
和channel_node_key
选项分别用于配置SDK证书和私钥release-2.1.0
版本开始,SDK证书和私钥更新为sdk.crt
和sdk.key
,配置证书路径前,请先检查上步拷贝的证书名和私钥名,并将channel_node_cert
配置为SDK证书路径,将channel_node_key
配置为SDK私钥路径
检查从节点拷贝的sdk证书路径,若sdk证书和私钥路径分别为bin/sdk.crt
和bin/sdk.key
,则client_config.py
中相关配置项如下:
channel_node_cert = "bin/sdk.crt" # 采用channel协议时,需要设置sdk证书,如采用rpc协议通信,这里可以留空
channel_node_key = "bin/sdk.key" # 采用channel协议时,需要设置sdk私钥,如采用rpc协议通信,这里可以留空
若sdk证书和私钥路径分别为bin/node.crt
和bin/node.key
,则client_config.py
中相关配置项如下:
channel_node_cert = "bin/node.crt" # 采用channel协议时,需要设置sdk证书,如采用rpc协议通信,这里可以留空
channel_node_key = "bin/node.key" # 采用channel协议时,需要设置sdk私钥,如采用rpc协议通信,这里可以留空
使用Channel协议访问节点
注解
windows环境下执行console.py请使用 .\console.py
或者 python console.py
# 获取FISCO BCOS节点版本号
./console.py getNodeVersion
开启命令行自动补全¶
Python SDK引入argcomplete支持命令行补全,运行如下命令开启此功能(bashrc仅需设置一次,设置之后每次登陆自动生效)
注解
- 此步骤仅需设置一次,设置之后以后每次登陆自动生效
- 请在 bash环境 下执行此步骤
- 目前仅支持bash,不支持zsh
echo "eval \"\$(register-python-argcomplete ./console.py)\"" >> ~/.bashrc
source ~/.bashrc