Skip to content

README.md

Latest commit

History

History
290 lines (205 loc) · 11.7 KB

README.md

File metadata and controls

290 lines (205 loc) · 11.7 KB
Raw

Python SDK

Build StatusCodeFactorGitHub licenseGitHub issues

Python SDK为FISCO BCOS提供Python API，使用FISCO BCOS Python SDK可以简单快捷的基于FISCO-BCOS进行区块链应用开发。此版本只支持FISCO BCOS 2.0。

关键特性

  • 提供调用FISCO BCOS 2.0 JSON-RPC的Python API。
  • 可基于Channel协议与FISCO BCOS进行通信，保证节点与SDK安全加密通信的同时，可接收节点推送的消息。
  • 支持交易解析功能：包括交易输入、交易输出、Event Log等ABI数据的拼装和解析。
  • 支持合约编译，将sol合约编译成abi和bin文件。
  • 支持基于keystore的账户管理。
  • 支持合约历史查询。

部署Python SDK

环境要求

  • Python环境：python 3.6.3, 3.7.x
  • FISCO BCOS节点：请参考FISCO BCOS安装搭建

依赖软件

  • 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环境符合要求，可跳过)

Linux环境初始化

拉取源代码

git clone https://github.com/FISCO-BCOS/python-sdk

配置环境(安装pyenv和python，若python版本>=3.6.3可跳过本步)

# 获取python版本
python --version
## --------若python版本小于3.6.3，执行下面流程--------------------------------------# 判断python版本，并为不符合条件的python环境安装python 3.7.3的虚拟环境，命名为python-sdk# 若python环境符合要求，可以跳过此步# 若脚本执行出错，请检查是否参考[依赖软件]说明安装了依赖# 提示：安装python-3.7.3可能耗时比较久cd python-sdk && bash init_env.sh -p
## --------若通过bash init_env.sh -p安装了python-sdk虚拟环境，执行下面流程-------------# 激活python-sdk虚拟环境source~/.bashrc && pyenv activate python-sdk && pip install --upgrade pip

Windows环境初始化

在Windows运行Python SDK，需要按照以下步骤安装依赖软件并配置合约编译器：

安装依赖软件

python环境变量配置可参考这里

(注：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)

  • 下载Windows版本solc, 点击这里下载

solc编译器下载成功后，解压，将其中的 solc.exe 文件复制 ${python-sdk}\bin 目录下。若 python-sdk 路为 D:\open-source\python-sdk, 则 solc.exe 文件复制路径为D:\open-source\python-sdk\bin\solc.exe

拉取源代码

打开 git，在任意目录执行如下命令

git clone https://github.com/FISCO-BCOS/python-sdk

配置solc编译器路径

# 修改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依赖

cd 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协议访问节点

# 获取FISCO BCOS节点版本号
./console.py getNodeVersion

SDK使用示例

查看SDK使用方法

windows环境下执行console.py请使用.\console.py或者python console.py

# 查看SDK使用方法
./console.py usage
# 获取节点版本
./console.py getNodeVersion

部署HelloWorld合约

$ ./console.py deploy HelloWorld save INFO >> user input : ['deploy', 'HelloWorld', 'save']
backup [contracts/HelloWorld.abi] to [contracts/HelloWorld.abi.20190807102912]
backup [contracts/HelloWorld.bin] to [contracts/HelloWorld.bin.20190807102912]
INFO >> compile with solc compiler
deploy result for [HelloWorld] is:
{
"blockHash": "0x3912605dde5f7358fee40a85a8b97ba6493848eae7766a8c317beecafb2e279d",
"blockNumber": "0x1",
"contractAddress": "0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce",
"from": "0x95198b93705e394a916579e048c8a32ddfb900f7",
"gasUsed": "0x44ab3",
"input": "0x6080604052...省略若干行...c6f2c20576f726c642100000000000000000000000000",
"logs": [],
"logsBloom": "0x000...省略若干行...0000",
"output": "0x",
"status": "0x0",
"to": "0x0000000000000000000000000000000000000000",
"transactionHash": "0xb291e9ca38b53c897340256b851764fa68a86f2a53cb14b2ecdcc332e850bb91",
"transactionIndex": "0x0"
}
on block : 1,address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce address save to file: bin/contract.ini

调用HelloWorld合约

# 合约地址：0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce# 调用接口：get
$./console.py call HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce get INFO >> user input : ['call', 'HelloWorld', '0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce', 'get']
INFO >> call HelloWorld , address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce, func: get, args:[]
INFO >> call result: ('Hello, World!',)
# 合约名：HelloWorld# 合约地址：0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce# 调用接口：set# 参数："Hello, FISCO"
$ ./console.py sendtx HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce set"Hello, FISCO"
INFO >> user input : ['sendtx', 'HelloWorld', '0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce', 'set', 'Hello, FISCO']
INFO >> sendtx HelloWorld , address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce, func: set, args:['Hello, FISCO']
INFO >> receipt logs : INFO >> transaction hash: 0xc20cbc6b0f28ad8fe1c560c8ce28c0e7eb7719a4a618a81604ac87ac46cc60f0
tx input data detail:
{'name': 'set', 'args': ('Hello, FISCO',), 'signature': 'set(string)'}
receipt output : ()
# 调用get接口获取更新后字符串
$./console.py call HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce get
INFO >> user input : ['call', 'HelloWorld', '0x42883e01ac97a3a5ef8a70c290abe0f67913964e', 'get']
INFO >> call HelloWorld , address: 0x42883e01ac97a3a5ef8a70c290abe0f67913964e, func: get, args:[]
INFO >> call result: 'Hello, FISCO!'

开启命令行自动补全

Python SDK引入argcomplete支持命令行补全，运行如下命令开启此功能(bashrc仅需设置一次，设置之后每次登陆自动生效)，目前仅支持bash，不支持zsh：

echo"eval \"\$(register-python-argcomplete ./console.py)\"">>~/.bashrc
source~/.bashrc

文档

中文

贡献代码

  • 我们欢迎并非常感谢您的贡献，请参阅代码贡献流程。
  • 如项目对您有帮助，欢迎star支持！

加入社区

FISCO BCOS开源社区是国内活跃的开源社区，社区长期为机构和个人开发者提供各类支持与帮助。已有来自各行业的数千名技术爱好者在研究和使用FISCO BCOS。如您对FISCO BCOS开源技术及应用感兴趣，欢迎加入社区获得更多支持与帮助。

License

license

Python SDK的开源协议为MIT License. 详情参考LICENSE。

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
python-sdk/README.md at master · HUCTF/python-sdk · GitHub
Skip to content
README.md
Latest commit
History
History
290 lines (205 loc) · 11.7 KB
README.md
File metadata and controls
290 lines (205 loc) · 11.7 KB
Raw
Python SDK
Build StatusCodeFactorGitHub licenseGitHub issues
Python SDK为FISCO BCOS提供Python API，使用FISCO BCOS Python SDK可以简单快捷的基于FISCO-BCOS进行区块链应用开发。此版本只支持FISCO BCOS 2.0。
关键特性
  • 提供调用FISCO BCOS 2.0 JSON-RPC的Python API。
  • 可基于Channel协议与FISCO BCOS进行通信，保证节点与SDK安全加密通信的同时，可接收节点推送的消息。
  • 支持交易解析功能：包括交易输入、交易输出、Event Log等ABI数据的拼装和解析。
  • 支持合约编译，将sol合约编译成abi和bin文件。
  • 支持基于keystore的账户管理。
  • 支持合约历史查询。
部署Python SDK
环境要求
  • Python环境：python 3.6.3, 3.7.x
  • FISCO BCOS节点：请参考FISCO BCOS安装搭建
依赖软件
  • 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环境符合要求，可跳过)
Linux环境初始化
拉取源代码
git clone https://github.com/FISCO-BCOS/python-sdk
配置环境(安装pyenv和python，若python版本>=3.6.3可跳过本步)
# 获取python版本
python --version
## --------若python版本小于3.6.3，执行下面流程--------------------------------------# 判断python版本，并为不符合条件的python环境安装python 3.7.3的虚拟环境，命名为python-sdk# 若python环境符合要求，可以跳过此步# 若脚本执行出错，请检查是否参考[依赖软件]说明安装了依赖# 提示：安装python-3.7.3可能耗时比较久cd python-sdk && bash init_env.sh -p
## --------若通过bash init_env.sh -p安装了python-sdk虚拟环境，执行下面流程-------------# 激活python-sdk虚拟环境source~/.bashrc && pyenv activate python-sdk && pip install --upgrade pip
Windows环境初始化
在Windows运行Python SDK，需要按照以下步骤安装依赖软件并配置合约编译器：
安装依赖软件
python环境变量配置可参考这里
(注：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)
  • 下载Windows版本solc, 点击这里下载
solc编译器下载成功后，解压，将其中的 solc.exe 文件复制 ${python-sdk}\bin 目录下。若 python-sdk 路为 D:\open-source\python-sdk, 则 solc.exe 文件复制路径为D:\open-source\python-sdk\bin\solc.exe
拉取源代码
打开 git，在任意目录执行如下命令
git clone https://github.com/FISCO-BCOS/python-sdk
配置solc编译器路径
# 修改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依赖
cd 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协议访问节点
# 获取FISCO BCOS节点版本号
./console.py getNodeVersion
SDK使用示例
查看SDK使用方法
windows环境下执行console.py请使用.\console.py或者python console.py
# 查看SDK使用方法
./console.py usage
# 获取节点版本
./console.py getNodeVersion
部署HelloWorld合约
$ ./console.py deploy HelloWorld save INFO >> user input : ['deploy', 'HelloWorld', 'save']
backup [contracts/HelloWorld.abi] to [contracts/HelloWorld.abi.20190807102912]
backup [contracts/HelloWorld.bin] to [contracts/HelloWorld.bin.20190807102912]
INFO >> compile with solc compiler
deploy result for [HelloWorld] is:
{
"blockHash": "0x3912605dde5f7358fee40a85a8b97ba6493848eae7766a8c317beecafb2e279d",
"blockNumber": "0x1",
"contractAddress": "0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce",
"from": "0x95198b93705e394a916579e048c8a32ddfb900f7",
"gasUsed": "0x44ab3",
"input": "0x6080604052...省略若干行...c6f2c20576f726c642100000000000000000000000000",
"logs": [],
"logsBloom": "0x000...省略若干行...0000",
"output": "0x",
"status": "0x0",
"to": "0x0000000000000000000000000000000000000000",
"transactionHash": "0xb291e9ca38b53c897340256b851764fa68a86f2a53cb14b2ecdcc332e850bb91",
"transactionIndex": "0x0"
}
on block : 1,address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce address save to file: bin/contract.ini
调用HelloWorld合约
# 合约地址：0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce# 调用接口：get
$./console.py call HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce get INFO >> user input : ['call', 'HelloWorld', '0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce', 'get']
INFO >> call HelloWorld , address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce, func: get, args:[]
INFO >> call result: ('Hello, World!',)
# 合约名：HelloWorld# 合约地址：0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce# 调用接口：set# 参数："Hello, FISCO"
$ ./console.py sendtx HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce set"Hello, FISCO"
INFO >> user input : ['sendtx', 'HelloWorld', '0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce', 'set', 'Hello, FISCO']
INFO >> sendtx HelloWorld , address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce, func: set, args:['Hello, FISCO']
INFO >> receipt logs : INFO >> transaction hash: 0xc20cbc6b0f28ad8fe1c560c8ce28c0e7eb7719a4a618a81604ac87ac46cc60f0
tx input data detail:
{'name': 'set', 'args': ('Hello, FISCO',), 'signature': 'set(string)'}
receipt output : ()
# 调用get接口获取更新后字符串
$./console.py call HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce get
INFO >> user input : ['call', 'HelloWorld', '0x42883e01ac97a3a5ef8a70c290abe0f67913964e', 'get']
INFO >> call HelloWorld , address: 0x42883e01ac97a3a5ef8a70c290abe0f67913964e, func: get, args:[]
INFO >> call result: 'Hello, FISCO!'
开启命令行自动补全
Python SDK引入argcomplete支持命令行补全，运行如下命令开启此功能(bashrc仅需设置一次，设置之后每次登陆自动生效)，目前仅支持bash，不支持zsh：
echo"eval \"\$(register-python-argcomplete ./console.py)\"">>~/.bashrc
source~/.bashrc
文档
中文
贡献代码
  • 我们欢迎并非常感谢您的贡献，请参阅代码贡献流程。
  • 如项目对您有帮助，欢迎star支持！
加入社区
FISCO BCOS开源社区是国内活跃的开源社区，社区长期为机构和个人开发者提供各类支持与帮助。已有来自各行业的数千名技术爱好者在研究和使用FISCO BCOS。如您对FISCO BCOS开源技术及应用感兴趣，欢迎加入社区获得更多支持与帮助。
License
license
Python SDK的开源协议为MIT License. 详情参考LICENSE。

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
python-sdk/README.md at master · HUCTF/python-sdk · GitHub
Skip to content
README.md
Latest commit
History
History
290 lines (205 loc) · 11.7 KB
README.md
File metadata and controls
290 lines (205 loc) · 11.7 KB
Raw
Python SDK
Build StatusCodeFactorGitHub licenseGitHub issues
Python SDK为FISCO BCOS提供Python API，使用FISCO BCOS Python SDK可以简单快捷的基于FISCO-BCOS进行区块链应用开发。此版本只支持FISCO BCOS 2.0。
关键特性
  • 提供调用FISCO BCOS 2.0 JSON-RPC的Python API。
  • 可基于Channel协议与FISCO BCOS进行通信，保证节点与SDK安全加密通信的同时，可接收节点推送的消息。
  • 支持交易解析功能：包括交易输入、交易输出、Event Log等ABI数据的拼装和解析。
  • 支持合约编译，将sol合约编译成abi和bin文件。
  • 支持基于keystore的账户管理。
  • 支持合约历史查询。
部署Python SDK
环境要求
  • Python环境：python 3.6.3, 3.7.x
  • FISCO BCOS节点：请参考FISCO BCOS安装搭建
依赖软件
  • 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环境符合要求，可跳过)
Linux环境初始化
拉取源代码
git clone https://github.com/FISCO-BCOS/python-sdk
配置环境(安装pyenv和python，若python版本>=3.6.3可跳过本步)
# 获取python版本
python --version
## --------若python版本小于3.6.3，执行下面流程--------------------------------------# 判断python版本，并为不符合条件的python环境安装python 3.7.3的虚拟环境，命名为python-sdk# 若python环境符合要求，可以跳过此步# 若脚本执行出错，请检查是否参考[依赖软件]说明安装了依赖# 提示：安装python-3.7.3可能耗时比较久cd python-sdk && bash init_env.sh -p
## --------若通过bash init_env.sh -p安装了python-sdk虚拟环境，执行下面流程-------------# 激活python-sdk虚拟环境source~/.bashrc && pyenv activate python-sdk && pip install --upgrade pip
Windows环境初始化
在Windows运行Python SDK，需要按照以下步骤安装依赖软件并配置合约编译器：
安装依赖软件
python环境变量配置可参考这里
(注：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)
  • 下载Windows版本solc, 点击这里下载
solc编译器下载成功后，解压，将其中的 solc.exe 文件复制 ${python-sdk}\bin 目录下。若 python-sdk 路为 D:\open-source\python-sdk, 则 solc.exe 文件复制路径为D:\open-source\python-sdk\bin\solc.exe
拉取源代码
打开 git，在任意目录执行如下命令
git clone https://github.com/FISCO-BCOS/python-sdk
配置solc编译器路径
# 修改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依赖
cd 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协议访问节点
# 获取FISCO BCOS节点版本号
./console.py getNodeVersion
SDK使用示例
查看SDK使用方法
windows环境下执行console.py请使用.\console.py或者python console.py
# 查看SDK使用方法
./console.py usage
# 获取节点版本
./console.py getNodeVersion
部署HelloWorld合约
$ ./console.py deploy HelloWorld save INFO >> user input : ['deploy', 'HelloWorld', 'save']
backup [contracts/HelloWorld.abi] to [contracts/HelloWorld.abi.20190807102912]
backup [contracts/HelloWorld.bin] to [contracts/HelloWorld.bin.20190807102912]
INFO >> compile with solc compiler
deploy result for [HelloWorld] is:
{
"blockHash": "0x3912605dde5f7358fee40a85a8b97ba6493848eae7766a8c317beecafb2e279d",
"blockNumber": "0x1",
"contractAddress": "0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce",
"from": "0x95198b93705e394a916579e048c8a32ddfb900f7",
"gasUsed": "0x44ab3",
"input": "0x6080604052...省略若干行...c6f2c20576f726c642100000000000000000000000000",
"logs": [],
"logsBloom": "0x000...省略若干行...0000",
"output": "0x",
"status": "0x0",
"to": "0x0000000000000000000000000000000000000000",
"transactionHash": "0xb291e9ca38b53c897340256b851764fa68a86f2a53cb14b2ecdcc332e850bb91",
"transactionIndex": "0x0"
}
on block : 1,address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce address save to file: bin/contract.ini
调用HelloWorld合约
# 合约地址：0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce# 调用接口：get
$./console.py call HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce get INFO >> user input : ['call', 'HelloWorld', '0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce', 'get']
INFO >> call HelloWorld , address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce, func: get, args:[]
INFO >> call result: ('Hello, World!',)
# 合约名：HelloWorld# 合约地址：0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce# 调用接口：set# 参数："Hello, FISCO"
$ ./console.py sendtx HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce set"Hello, FISCO"
INFO >> user input : ['sendtx', 'HelloWorld', '0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce', 'set', 'Hello, FISCO']
INFO >> sendtx HelloWorld , address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce, func: set, args:['Hello, FISCO']
INFO >> receipt logs : INFO >> transaction hash: 0xc20cbc6b0f28ad8fe1c560c8ce28c0e7eb7719a4a618a81604ac87ac46cc60f0
tx input data detail:
{'name': 'set', 'args': ('Hello, FISCO',), 'signature': 'set(string)'}
receipt output : ()
# 调用get接口获取更新后字符串
$./console.py call HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce get
INFO >> user input : ['call', 'HelloWorld', '0x42883e01ac97a3a5ef8a70c290abe0f67913964e', 'get']
INFO >> call HelloWorld , address: 0x42883e01ac97a3a5ef8a70c290abe0f67913964e, func: get, args:[]
INFO >> call result: 'Hello, FISCO!'
开启命令行自动补全
Python SDK引入argcomplete支持命令行补全，运行如下命令开启此功能(bashrc仅需设置一次，设置之后每次登陆自动生效)，目前仅支持bash，不支持zsh：
echo"eval \"\$(register-python-argcomplete ./console.py)\"">>~/.bashrc
source~/.bashrc
文档
中文
贡献代码
  • 我们欢迎并非常感谢您的贡献，请参阅代码贡献流程。
  • 如项目对您有帮助，欢迎star支持！
加入社区
FISCO BCOS开源社区是国内活跃的开源社区，社区长期为机构和个人开发者提供各类支持与帮助。已有来自各行业的数千名技术爱好者在研究和使用FISCO BCOS。如您对FISCO BCOS开源技术及应用感兴趣，欢迎加入社区获得更多支持与帮助。
License
license
Python SDK的开源协议为MIT License. 详情参考LICENSE。

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
python-sdk/README.md at master · HUCTF/python-sdk · GitHub
Skip to content
README.md
Latest commit
History
History
290 lines (205 loc) · 11.7 KB
README.md
File metadata and controls
290 lines (205 loc) · 11.7 KB
Raw
Python SDK
Build StatusCodeFactorGitHub licenseGitHub issues
Python SDK为FISCO BCOS提供Python API，使用FISCO BCOS Python SDK可以简单快捷的基于FISCO-BCOS进行区块链应用开发。此版本只支持FISCO BCOS 2.0。
关键特性
  • 提供调用FISCO BCOS 2.0 JSON-RPC的Python API。
  • 可基于Channel协议与FISCO BCOS进行通信，保证节点与SDK安全加密通信的同时，可接收节点推送的消息。
  • 支持交易解析功能：包括交易输入、交易输出、Event Log等ABI数据的拼装和解析。
  • 支持合约编译，将sol合约编译成abi和bin文件。
  • 支持基于keystore的账户管理。
  • 支持合约历史查询。
部署Python SDK
环境要求
  • Python环境：python 3.6.3, 3.7.x
  • FISCO BCOS节点：请参考FISCO BCOS安装搭建
依赖软件
  • 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环境符合要求，可跳过)
Linux环境初始化
拉取源代码
git clone https://github.com/FISCO-BCOS/python-sdk
配置环境(安装pyenv和python，若python版本>=3.6.3可跳过本步)
# 获取python版本
python --version
## --------若python版本小于3.6.3，执行下面流程--------------------------------------# 判断python版本，并为不符合条件的python环境安装python 3.7.3的虚拟环境，命名为python-sdk# 若python环境符合要求，可以跳过此步# 若脚本执行出错，请检查是否参考[依赖软件]说明安装了依赖# 提示：安装python-3.7.3可能耗时比较久cd python-sdk && bash init_env.sh -p
## --------若通过bash init_env.sh -p安装了python-sdk虚拟环境，执行下面流程-------------# 激活python-sdk虚拟环境source~/.bashrc && pyenv activate python-sdk && pip install --upgrade pip
Windows环境初始化
在Windows运行Python SDK，需要按照以下步骤安装依赖软件并配置合约编译器：
安装依赖软件
python环境变量配置可参考这里
(注：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)
  • 下载Windows版本solc, 点击这里下载
solc编译器下载成功后，解压，将其中的 solc.exe 文件复制 ${python-sdk}\bin 目录下。若 python-sdk 路为 D:\open-source\python-sdk, 则 solc.exe 文件复制路径为D:\open-source\python-sdk\bin\solc.exe
拉取源代码
打开 git，在任意目录执行如下命令
git clone https://github.com/FISCO-BCOS/python-sdk
配置solc编译器路径
# 修改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依赖
cd 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协议访问节点
# 获取FISCO BCOS节点版本号
./console.py getNodeVersion
SDK使用示例
查看SDK使用方法
windows环境下执行console.py请使用.\console.py或者python console.py
# 查看SDK使用方法
./console.py usage
# 获取节点版本
./console.py getNodeVersion
部署HelloWorld合约
$ ./console.py deploy HelloWorld save INFO >> user input : ['deploy', 'HelloWorld', 'save']
backup [contracts/HelloWorld.abi] to [contracts/HelloWorld.abi.20190807102912]
backup [contracts/HelloWorld.bin] to [contracts/HelloWorld.bin.20190807102912]
INFO >> compile with solc compiler
deploy result for [HelloWorld] is:
{
"blockHash": "0x3912605dde5f7358fee40a85a8b97ba6493848eae7766a8c317beecafb2e279d",
"blockNumber": "0x1",
"contractAddress": "0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce",
"from": "0x95198b93705e394a916579e048c8a32ddfb900f7",
"gasUsed": "0x44ab3",
"input": "0x6080604052...省略若干行...c6f2c20576f726c642100000000000000000000000000",
"logs": [],
"logsBloom": "0x000...省略若干行...0000",
"output": "0x",
"status": "0x0",
"to": "0x0000000000000000000000000000000000000000",
"transactionHash": "0xb291e9ca38b53c897340256b851764fa68a86f2a53cb14b2ecdcc332e850bb91",
"transactionIndex": "0x0"
}
on block : 1,address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce address save to file: bin/contract.ini
调用HelloWorld合约
# 合约地址：0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce# 调用接口：get
$./console.py call HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce get INFO >> user input : ['call', 'HelloWorld', '0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce', 'get']
INFO >> call HelloWorld , address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce, func: get, args:[]
INFO >> call result: ('Hello, World!',)
# 合约名：HelloWorld# 合约地址：0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce# 调用接口：set# 参数："Hello, FISCO"
$ ./console.py sendtx HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce set"Hello, FISCO"
INFO >> user input : ['sendtx', 'HelloWorld', '0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce', 'set', 'Hello, FISCO']
INFO >> sendtx HelloWorld , address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce, func: set, args:['Hello, FISCO']
INFO >> receipt logs : INFO >> transaction hash: 0xc20cbc6b0f28ad8fe1c560c8ce28c0e7eb7719a4a618a81604ac87ac46cc60f0
tx input data detail:
{'name': 'set', 'args': ('Hello, FISCO',), 'signature': 'set(string)'}
receipt output : ()
# 调用get接口获取更新后字符串
$./console.py call HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce get
INFO >> user input : ['call', 'HelloWorld', '0x42883e01ac97a3a5ef8a70c290abe0f67913964e', 'get']
INFO >> call HelloWorld , address: 0x42883e01ac97a3a5ef8a70c290abe0f67913964e, func: get, args:[]
INFO >> call result: 'Hello, FISCO!'
开启命令行自动补全
Python SDK引入argcomplete支持命令行补全，运行如下命令开启此功能(bashrc仅需设置一次，设置之后每次登陆自动生效)，目前仅支持bash，不支持zsh：
echo"eval \"\$(register-python-argcomplete ./console.py)\"">>~/.bashrc
source~/.bashrc
文档
中文
贡献代码
  • 我们欢迎并非常感谢您的贡献，请参阅代码贡献流程。
  • 如项目对您有帮助，欢迎star支持！
加入社区
FISCO BCOS开源社区是国内活跃的开源社区，社区长期为机构和个人开发者提供各类支持与帮助。已有来自各行业的数千名技术爱好者在研究和使用FISCO BCOS。如您对FISCO BCOS开源技术及应用感兴趣，欢迎加入社区获得更多支持与帮助。
License
license
Python SDK的开源协议为MIT License. 详情参考LICENSE。

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
python-sdk/README.md at master · HUCTF/python-sdk · GitHub
Skip to content
README.md
Latest commit
History
History
290 lines (205 loc) · 11.7 KB
README.md
File metadata and controls
290 lines (205 loc) · 11.7 KB
Raw
Python SDK
Build StatusCodeFactorGitHub licenseGitHub issues
Python SDK为FISCO BCOS提供Python API，使用FISCO BCOS Python SDK可以简单快捷的基于FISCO-BCOS进行区块链应用开发。此版本只支持FISCO BCOS 2.0。
关键特性
  • 提供调用FISCO BCOS 2.0 JSON-RPC的Python API。
  • 可基于Channel协议与FISCO BCOS进行通信，保证节点与SDK安全加密通信的同时，可接收节点推送的消息。
  • 支持交易解析功能：包括交易输入、交易输出、Event Log等ABI数据的拼装和解析。
  • 支持合约编译，将sol合约编译成abi和bin文件。
  • 支持基于keystore的账户管理。
  • 支持合约历史查询。
部署Python SDK
环境要求
  • Python环境：python 3.6.3, 3.7.x
  • FISCO BCOS节点：请参考FISCO BCOS安装搭建
依赖软件
  • 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环境符合要求，可跳过)
Linux环境初始化
拉取源代码
git clone https://github.com/FISCO-BCOS/python-sdk
配置环境(安装pyenv和python，若python版本>=3.6.3可跳过本步)
# 获取python版本
python --version
## --------若python版本小于3.6.3，执行下面流程--------------------------------------# 判断python版本，并为不符合条件的python环境安装python 3.7.3的虚拟环境，命名为python-sdk# 若python环境符合要求，可以跳过此步# 若脚本执行出错，请检查是否参考[依赖软件]说明安装了依赖# 提示：安装python-3.7.3可能耗时比较久cd python-sdk && bash init_env.sh -p
## --------若通过bash init_env.sh -p安装了python-sdk虚拟环境，执行下面流程-------------# 激活python-sdk虚拟环境source~/.bashrc && pyenv activate python-sdk && pip install --upgrade pip
Windows环境初始化
在Windows运行Python SDK，需要按照以下步骤安装依赖软件并配置合约编译器：
安装依赖软件
python环境变量配置可参考这里
(注：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)
  • 下载Windows版本solc, 点击这里下载
solc编译器下载成功后，解压，将其中的 solc.exe 文件复制 ${python-sdk}\bin 目录下。若 python-sdk 路为 D:\open-source\python-sdk, 则 solc.exe 文件复制路径为D:\open-source\python-sdk\bin\solc.exe
拉取源代码
打开 git，在任意目录执行如下命令
git clone https://github.com/FISCO-BCOS/python-sdk
配置solc编译器路径
# 修改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依赖
cd 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协议访问节点
# 获取FISCO BCOS节点版本号
./console.py getNodeVersion
SDK使用示例
查看SDK使用方法
windows环境下执行console.py请使用.\console.py或者python console.py
# 查看SDK使用方法
./console.py usage
# 获取节点版本
./console.py getNodeVersion
部署HelloWorld合约
$ ./console.py deploy HelloWorld save INFO >> user input : ['deploy', 'HelloWorld', 'save']
backup [contracts/HelloWorld.abi] to [contracts/HelloWorld.abi.20190807102912]
backup [contracts/HelloWorld.bin] to [contracts/HelloWorld.bin.20190807102912]
INFO >> compile with solc compiler
deploy result for [HelloWorld] is:
{
"blockHash": "0x3912605dde5f7358fee40a85a8b97ba6493848eae7766a8c317beecafb2e279d",
"blockNumber": "0x1",
"contractAddress": "0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce",
"from": "0x95198b93705e394a916579e048c8a32ddfb900f7",
"gasUsed": "0x44ab3",
"input": "0x6080604052...省略若干行...c6f2c20576f726c642100000000000000000000000000",
"logs": [],
"logsBloom": "0x000...省略若干行...0000",
"output": "0x",
"status": "0x0",
"to": "0x0000000000000000000000000000000000000000",
"transactionHash": "0xb291e9ca38b53c897340256b851764fa68a86f2a53cb14b2ecdcc332e850bb91",
"transactionIndex": "0x0"
}
on block : 1,address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce address save to file: bin/contract.ini
调用HelloWorld合约
# 合约地址：0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce# 调用接口：get
$./console.py call HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce get INFO >> user input : ['call', 'HelloWorld', '0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce', 'get']
INFO >> call HelloWorld , address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce, func: get, args:[]
INFO >> call result: ('Hello, World!',)
# 合约名：HelloWorld# 合约地址：0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce# 调用接口：set# 参数："Hello, FISCO"
$ ./console.py sendtx HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce set"Hello, FISCO"
INFO >> user input : ['sendtx', 'HelloWorld', '0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce', 'set', 'Hello, FISCO']
INFO >> sendtx HelloWorld , address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce, func: set, args:['Hello, FISCO']
INFO >> receipt logs : INFO >> transaction hash: 0xc20cbc6b0f28ad8fe1c560c8ce28c0e7eb7719a4a618a81604ac87ac46cc60f0
tx input data detail:
{'name': 'set', 'args': ('Hello, FISCO',), 'signature': 'set(string)'}
receipt output : ()
# 调用get接口获取更新后字符串
$./console.py call HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce get
INFO >> user input : ['call', 'HelloWorld', '0x42883e01ac97a3a5ef8a70c290abe0f67913964e', 'get']
INFO >> call HelloWorld , address: 0x42883e01ac97a3a5ef8a70c290abe0f67913964e, func: get, args:[]
INFO >> call result: 'Hello, FISCO!'
开启命令行自动补全
Python SDK引入argcomplete支持命令行补全，运行如下命令开启此功能(bashrc仅需设置一次，设置之后每次登陆自动生效)，目前仅支持bash，不支持zsh：
echo"eval \"\$(register-python-argcomplete ./console.py)\"">>~/.bashrc
source~/.bashrc
文档
中文
贡献代码
  • 我们欢迎并非常感谢您的贡献，请参阅代码贡献流程。
  • 如项目对您有帮助，欢迎star支持！
加入社区
FISCO BCOS开源社区是国内活跃的开源社区，社区长期为机构和个人开发者提供各类支持与帮助。已有来自各行业的数千名技术爱好者在研究和使用FISCO BCOS。如您对FISCO BCOS开源技术及应用感兴趣，欢迎加入社区获得更多支持与帮助。
License
license
Python SDK的开源协议为MIT License. 详情参考LICENSE。

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
python-sdk/README.md at master · HUCTF/python-sdk · GitHub
Skip to content
README.md
Latest commit
History
History
290 lines (205 loc) · 11.7 KB
README.md
File metadata and controls
290 lines (205 loc) · 11.7 KB
Raw
Python SDK
Build StatusCodeFactorGitHub licenseGitHub issues
Python SDK为FISCO BCOS提供Python API，使用FISCO BCOS Python SDK可以简单快捷的基于FISCO-BCOS进行区块链应用开发。此版本只支持FISCO BCOS 2.0。
关键特性
  • 提供调用FISCO BCOS 2.0 JSON-RPC的Python API。
  • 可基于Channel协议与FISCO BCOS进行通信，保证节点与SDK安全加密通信的同时，可接收节点推送的消息。
  • 支持交易解析功能：包括交易输入、交易输出、Event Log等ABI数据的拼装和解析。
  • 支持合约编译，将sol合约编译成abi和bin文件。
  • 支持基于keystore的账户管理。
  • 支持合约历史查询。
部署Python SDK
环境要求
  • Python环境：python 3.6.3, 3.7.x
  • FISCO BCOS节点：请参考FISCO BCOS安装搭建
依赖软件
  • 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环境符合要求，可跳过)
Linux环境初始化
拉取源代码
git clone https://github.com/FISCO-BCOS/python-sdk
配置环境(安装pyenv和python，若python版本>=3.6.3可跳过本步)
# 获取python版本
python --version
## --------若python版本小于3.6.3，执行下面流程--------------------------------------# 判断python版本，并为不符合条件的python环境安装python 3.7.3的虚拟环境，命名为python-sdk# 若python环境符合要求，可以跳过此步# 若脚本执行出错，请检查是否参考[依赖软件]说明安装了依赖# 提示：安装python-3.7.3可能耗时比较久cd python-sdk && bash init_env.sh -p
## --------若通过bash init_env.sh -p安装了python-sdk虚拟环境，执行下面流程-------------# 激活python-sdk虚拟环境source~/.bashrc && pyenv activate python-sdk && pip install --upgrade pip
Windows环境初始化
在Windows运行Python SDK，需要按照以下步骤安装依赖软件并配置合约编译器：
安装依赖软件
python环境变量配置可参考这里
(注：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)
  • 下载Windows版本solc, 点击这里下载
solc编译器下载成功后，解压，将其中的 solc.exe 文件复制 ${python-sdk}\bin 目录下。若 python-sdk 路为 D:\open-source\python-sdk, 则 solc.exe 文件复制路径为D:\open-source\python-sdk\bin\solc.exe
拉取源代码
打开 git，在任意目录执行如下命令
git clone https://github.com/FISCO-BCOS/python-sdk
配置solc编译器路径
# 修改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依赖
cd 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协议访问节点
# 获取FISCO BCOS节点版本号
./console.py getNodeVersion
SDK使用示例
查看SDK使用方法
windows环境下执行console.py请使用.\console.py或者python console.py
# 查看SDK使用方法
./console.py usage
# 获取节点版本
./console.py getNodeVersion
部署HelloWorld合约
$ ./console.py deploy HelloWorld save INFO >> user input : ['deploy', 'HelloWorld', 'save']
backup [contracts/HelloWorld.abi] to [contracts/HelloWorld.abi.20190807102912]
backup [contracts/HelloWorld.bin] to [contracts/HelloWorld.bin.20190807102912]
INFO >> compile with solc compiler
deploy result for [HelloWorld] is:
{
"blockHash": "0x3912605dde5f7358fee40a85a8b97ba6493848eae7766a8c317beecafb2e279d",
"blockNumber": "0x1",
"contractAddress": "0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce",
"from": "0x95198b93705e394a916579e048c8a32ddfb900f7",
"gasUsed": "0x44ab3",
"input": "0x6080604052...省略若干行...c6f2c20576f726c642100000000000000000000000000",
"logs": [],
"logsBloom": "0x000...省略若干行...0000",
"output": "0x",
"status": "0x0",
"to": "0x0000000000000000000000000000000000000000",
"transactionHash": "0xb291e9ca38b53c897340256b851764fa68a86f2a53cb14b2ecdcc332e850bb91",
"transactionIndex": "0x0"
}
on block : 1,address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce address save to file: bin/contract.ini
调用HelloWorld合约
# 合约地址：0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce# 调用接口：get
$./console.py call HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce get INFO >> user input : ['call', 'HelloWorld', '0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce', 'get']
INFO >> call HelloWorld , address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce, func: get, args:[]
INFO >> call result: ('Hello, World!',)
# 合约名：HelloWorld# 合约地址：0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce# 调用接口：set# 参数："Hello, FISCO"
$ ./console.py sendtx HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce set"Hello, FISCO"
INFO >> user input : ['sendtx', 'HelloWorld', '0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce', 'set', 'Hello, FISCO']
INFO >> sendtx HelloWorld , address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce, func: set, args:['Hello, FISCO']
INFO >> receipt logs : INFO >> transaction hash: 0xc20cbc6b0f28ad8fe1c560c8ce28c0e7eb7719a4a618a81604ac87ac46cc60f0
tx input data detail:
{'name': 'set', 'args': ('Hello, FISCO',), 'signature': 'set(string)'}
receipt output : ()
# 调用get接口获取更新后字符串
$./console.py call HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce get
INFO >> user input : ['call', 'HelloWorld', '0x42883e01ac97a3a5ef8a70c290abe0f67913964e', 'get']
INFO >> call HelloWorld , address: 0x42883e01ac97a3a5ef8a70c290abe0f67913964e, func: get, args:[]
INFO >> call result: 'Hello, FISCO!'
开启命令行自动补全
Python SDK引入argcomplete支持命令行补全，运行如下命令开启此功能(bashrc仅需设置一次，设置之后每次登陆自动生效)，目前仅支持bash，不支持zsh：
echo"eval \"\$(register-python-argcomplete ./console.py)\"">>~/.bashrc
source~/.bashrc
文档
中文
贡献代码
  • 我们欢迎并非常感谢您的贡献，请参阅代码贡献流程。
  • 如项目对您有帮助，欢迎star支持！
加入社区
FISCO BCOS开源社区是国内活跃的开源社区，社区长期为机构和个人开发者提供各类支持与帮助。已有来自各行业的数千名技术爱好者在研究和使用FISCO BCOS。如您对FISCO BCOS开源技术及应用感兴趣，欢迎加入社区获得更多支持与帮助。
License
license
Python SDK的开源协议为MIT License. 详情参考LICENSE。

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
python-sdk/README.md at master · HUCTF/python-sdk · GitHub
Skip to content
README.md
Latest commit
History
History
290 lines (205 loc) · 11.7 KB
README.md
File metadata and controls
290 lines (205 loc) · 11.7 KB
Raw
Python SDK
Build StatusCodeFactorGitHub licenseGitHub issues
Python SDK为FISCO BCOS提供Python API，使用FISCO BCOS Python SDK可以简单快捷的基于FISCO-BCOS进行区块链应用开发。此版本只支持FISCO BCOS 2.0。
关键特性
  • 提供调用FISCO BCOS 2.0 JSON-RPC的Python API。
  • 可基于Channel协议与FISCO BCOS进行通信，保证节点与SDK安全加密通信的同时，可接收节点推送的消息。
  • 支持交易解析功能：包括交易输入、交易输出、Event Log等ABI数据的拼装和解析。
  • 支持合约编译，将sol合约编译成abi和bin文件。
  • 支持基于keystore的账户管理。
  • 支持合约历史查询。
部署Python SDK
环境要求
  • Python环境：python 3.6.3, 3.7.x
  • FISCO BCOS节点：请参考FISCO BCOS安装搭建
依赖软件
  • 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环境符合要求，可跳过)
Linux环境初始化
拉取源代码
git clone https://github.com/FISCO-BCOS/python-sdk
配置环境(安装pyenv和python，若python版本>=3.6.3可跳过本步)
# 获取python版本
python --version
## --------若python版本小于3.6.3，执行下面流程--------------------------------------# 判断python版本，并为不符合条件的python环境安装python 3.7.3的虚拟环境，命名为python-sdk# 若python环境符合要求，可以跳过此步# 若脚本执行出错，请检查是否参考[依赖软件]说明安装了依赖# 提示：安装python-3.7.3可能耗时比较久cd python-sdk && bash init_env.sh -p
## --------若通过bash init_env.sh -p安装了python-sdk虚拟环境，执行下面流程-------------# 激活python-sdk虚拟环境source~/.bashrc && pyenv activate python-sdk && pip install --upgrade pip
Windows环境初始化
在Windows运行Python SDK，需要按照以下步骤安装依赖软件并配置合约编译器：
安装依赖软件
python环境变量配置可参考这里
(注：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)
  • 下载Windows版本solc, 点击这里下载
solc编译器下载成功后，解压，将其中的 solc.exe 文件复制 ${python-sdk}\bin 目录下。若 python-sdk 路为 D:\open-source\python-sdk, 则 solc.exe 文件复制路径为D:\open-source\python-sdk\bin\solc.exe
拉取源代码
打开 git，在任意目录执行如下命令
git clone https://github.com/FISCO-BCOS/python-sdk
配置solc编译器路径
# 修改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依赖
cd 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协议访问节点
# 获取FISCO BCOS节点版本号
./console.py getNodeVersion
SDK使用示例
查看SDK使用方法
windows环境下执行console.py请使用.\console.py或者python console.py
# 查看SDK使用方法
./console.py usage
# 获取节点版本
./console.py getNodeVersion
部署HelloWorld合约
$ ./console.py deploy HelloWorld save INFO >> user input : ['deploy', 'HelloWorld', 'save']
backup [contracts/HelloWorld.abi] to [contracts/HelloWorld.abi.20190807102912]
backup [contracts/HelloWorld.bin] to [contracts/HelloWorld.bin.20190807102912]
INFO >> compile with solc compiler
deploy result for [HelloWorld] is:
{
"blockHash": "0x3912605dde5f7358fee40a85a8b97ba6493848eae7766a8c317beecafb2e279d",
"blockNumber": "0x1",
"contractAddress": "0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce",
"from": "0x95198b93705e394a916579e048c8a32ddfb900f7",
"gasUsed": "0x44ab3",
"input": "0x6080604052...省略若干行...c6f2c20576f726c642100000000000000000000000000",
"logs": [],
"logsBloom": "0x000...省略若干行...0000",
"output": "0x",
"status": "0x0",
"to": "0x0000000000000000000000000000000000000000",
"transactionHash": "0xb291e9ca38b53c897340256b851764fa68a86f2a53cb14b2ecdcc332e850bb91",
"transactionIndex": "0x0"
}
on block : 1,address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce address save to file: bin/contract.ini
调用HelloWorld合约
# 合约地址：0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce# 调用接口：get
$./console.py call HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce get INFO >> user input : ['call', 'HelloWorld', '0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce', 'get']
INFO >> call HelloWorld , address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce, func: get, args:[]
INFO >> call result: ('Hello, World!',)
# 合约名：HelloWorld# 合约地址：0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce# 调用接口：set# 参数："Hello, FISCO"
$ ./console.py sendtx HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce set"Hello, FISCO"
INFO >> user input : ['sendtx', 'HelloWorld', '0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce', 'set', 'Hello, FISCO']
INFO >> sendtx HelloWorld , address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce, func: set, args:['Hello, FISCO']
INFO >> receipt logs : INFO >> transaction hash: 0xc20cbc6b0f28ad8fe1c560c8ce28c0e7eb7719a4a618a81604ac87ac46cc60f0
tx input data detail:
{'name': 'set', 'args': ('Hello, FISCO',), 'signature': 'set(string)'}
receipt output : ()
# 调用get接口获取更新后字符串
$./console.py call HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce get
INFO >> user input : ['call', 'HelloWorld', '0x42883e01ac97a3a5ef8a70c290abe0f67913964e', 'get']
INFO >> call HelloWorld , address: 0x42883e01ac97a3a5ef8a70c290abe0f67913964e, func: get, args:[]
INFO >> call result: 'Hello, FISCO!'
开启命令行自动补全
Python SDK引入argcomplete支持命令行补全，运行如下命令开启此功能(bashrc仅需设置一次，设置之后每次登陆自动生效)，目前仅支持bash，不支持zsh：
echo"eval \"\$(register-python-argcomplete ./console.py)\"">>~/.bashrc
source~/.bashrc
文档
中文
贡献代码
  • 我们欢迎并非常感谢您的贡献，请参阅代码贡献流程。
  • 如项目对您有帮助，欢迎star支持！
加入社区
FISCO BCOS开源社区是国内活跃的开源社区，社区长期为机构和个人开发者提供各类支持与帮助。已有来自各行业的数千名技术爱好者在研究和使用FISCO BCOS。如您对FISCO BCOS开源技术及应用感兴趣，欢迎加入社区获得更多支持与帮助。
License
license
Python SDK的开源协议为MIT License. 详情参考LICENSE。

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
python-sdk/README.md at master · HUCTF/python-sdk · GitHub
Skip to content
README.md
Latest commit
History
History
290 lines (205 loc) · 11.7 KB
README.md
File metadata and controls
290 lines (205 loc) · 11.7 KB
Raw
Python SDK
Build StatusCodeFactorGitHub licenseGitHub issues
Python SDK为FISCO BCOS提供Python API，使用FISCO BCOS Python SDK可以简单快捷的基于FISCO-BCOS进行区块链应用开发。此版本只支持FISCO BCOS 2.0。
关键特性
  • 提供调用FISCO BCOS 2.0 JSON-RPC的Python API。
  • 可基于Channel协议与FISCO BCOS进行通信，保证节点与SDK安全加密通信的同时，可接收节点推送的消息。
  • 支持交易解析功能：包括交易输入、交易输出、Event Log等ABI数据的拼装和解析。
  • 支持合约编译，将sol合约编译成abi和bin文件。
  • 支持基于keystore的账户管理。
  • 支持合约历史查询。
部署Python SDK
环境要求
  • Python环境：python 3.6.3, 3.7.x
  • FISCO BCOS节点：请参考FISCO BCOS安装搭建
依赖软件
  • 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环境符合要求，可跳过)
Linux环境初始化
拉取源代码
git clone https://github.com/FISCO-BCOS/python-sdk
配置环境(安装pyenv和python，若python版本>=3.6.3可跳过本步)
# 获取python版本
python --version
## --------若python版本小于3.6.3，执行下面流程--------------------------------------# 判断python版本，并为不符合条件的python环境安装python 3.7.3的虚拟环境，命名为python-sdk# 若python环境符合要求，可以跳过此步# 若脚本执行出错，请检查是否参考[依赖软件]说明安装了依赖# 提示：安装python-3.7.3可能耗时比较久cd python-sdk && bash init_env.sh -p
## --------若通过bash init_env.sh -p安装了python-sdk虚拟环境，执行下面流程-------------# 激活python-sdk虚拟环境source~/.bashrc && pyenv activate python-sdk && pip install --upgrade pip
Windows环境初始化
在Windows运行Python SDK，需要按照以下步骤安装依赖软件并配置合约编译器：
安装依赖软件
python环境变量配置可参考这里
(注：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)
  • 下载Windows版本solc, 点击这里下载
solc编译器下载成功后，解压，将其中的 solc.exe 文件复制 ${python-sdk}\bin 目录下。若 python-sdk 路为 D:\open-source\python-sdk, 则 solc.exe 文件复制路径为D:\open-source\python-sdk\bin\solc.exe
拉取源代码
打开 git，在任意目录执行如下命令
git clone https://github.com/FISCO-BCOS/python-sdk
配置solc编译器路径
# 修改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依赖
cd 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协议访问节点
# 获取FISCO BCOS节点版本号
./console.py getNodeVersion
SDK使用示例
查看SDK使用方法
windows环境下执行console.py请使用.\console.py或者python console.py
# 查看SDK使用方法
./console.py usage
# 获取节点版本
./console.py getNodeVersion
部署HelloWorld合约
$ ./console.py deploy HelloWorld save INFO >> user input : ['deploy', 'HelloWorld', 'save']
backup [contracts/HelloWorld.abi] to [contracts/HelloWorld.abi.20190807102912]
backup [contracts/HelloWorld.bin] to [contracts/HelloWorld.bin.20190807102912]
INFO >> compile with solc compiler
deploy result for [HelloWorld] is:
{
"blockHash": "0x3912605dde5f7358fee40a85a8b97ba6493848eae7766a8c317beecafb2e279d",
"blockNumber": "0x1",
"contractAddress": "0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce",
"from": "0x95198b93705e394a916579e048c8a32ddfb900f7",
"gasUsed": "0x44ab3",
"input": "0x6080604052...省略若干行...c6f2c20576f726c642100000000000000000000000000",
"logs": [],
"logsBloom": "0x000...省略若干行...0000",
"output": "0x",
"status": "0x0",
"to": "0x0000000000000000000000000000000000000000",
"transactionHash": "0xb291e9ca38b53c897340256b851764fa68a86f2a53cb14b2ecdcc332e850bb91",
"transactionIndex": "0x0"
}
on block : 1,address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce address save to file: bin/contract.ini
调用HelloWorld合约
# 合约地址：0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce# 调用接口：get
$./console.py call HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce get INFO >> user input : ['call', 'HelloWorld', '0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce', 'get']
INFO >> call HelloWorld , address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce, func: get, args:[]
INFO >> call result: ('Hello, World!',)
# 合约名：HelloWorld# 合约地址：0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce# 调用接口：set# 参数："Hello, FISCO"
$ ./console.py sendtx HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce set"Hello, FISCO"
INFO >> user input : ['sendtx', 'HelloWorld', '0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce', 'set', 'Hello, FISCO']
INFO >> sendtx HelloWorld , address: 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce, func: set, args:['Hello, FISCO']
INFO >> receipt logs : INFO >> transaction hash: 0xc20cbc6b0f28ad8fe1c560c8ce28c0e7eb7719a4a618a81604ac87ac46cc60f0
tx input data detail:
{'name': 'set', 'args': ('Hello, FISCO',), 'signature': 'set(string)'}
receipt output : ()
# 调用get接口获取更新后字符串
$./console.py call HelloWorld 0x2d1c577e41809453c50e7e5c3f57d06f3cdd90ce get
INFO >> user input : ['call', 'HelloWorld', '0x42883e01ac97a3a5ef8a70c290abe0f67913964e', 'get']
INFO >> call HelloWorld , address: 0x42883e01ac97a3a5ef8a70c290abe0f67913964e, func: get, args:[]
INFO >> call result: 'Hello, FISCO!'
开启命令行自动补全
Python SDK引入argcomplete支持命令行补全，运行如下命令开启此功能(bashrc仅需设置一次，设置之后每次登陆自动生效)，目前仅支持bash，不支持zsh：
echo"eval \"\$(register-python-argcomplete ./console.py)\"">>~/.bashrc
source~/.bashrc
文档
中文
贡献代码
  • 我们欢迎并非常感谢您的贡献，请参阅代码贡献流程。
  • 如项目对您有帮助，欢迎star支持！
加入社区
FISCO BCOS开源社区是国内活跃的开源社区，社区长期为机构和个人开发者提供各类支持与帮助。已有来自各行业的数千名技术爱好者在研究和使用FISCO BCOS。如您对FISCO BCOS开源技术及应用感兴趣，欢迎加入社区获得更多支持与帮助。
License
license
Python SDK的开源协议为MIT License. 详情参考LICENSE。