From 68a3065f8aa4fdee537337137cfc88b7f1a79af4 Mon Sep 17 00:00:00 2001 From: ywy2090 <912554887@qq.com> Date: Mon, 19 Sep 2022 19:56:48 +0800 Subject: [PATCH] add python-sdk (#1543) --- 3.x/zh_CN/docs/develop/sdk/c_sdk/api.md | 25 +++++++++++++++---- 3.x/zh_CN/docs/develop/sdk/index.md | 1 + .../docs/develop/sdk/python_sdk/index.md | 17 +++++++++++++ 3 files changed, 38 insertions(+), 5 deletions(-) create mode 100644 3.x/zh_CN/docs/develop/sdk/python_sdk/index.md diff --git a/3.x/zh_CN/docs/develop/sdk/c_sdk/api.md b/3.x/zh_CN/docs/develop/sdk/c_sdk/api.md index 504f528b8..c13ead577 100644 --- a/3.x/zh_CN/docs/develop/sdk/c_sdk/api.md +++ b/3.x/zh_CN/docs/develop/sdk/c_sdk/api.md @@ -650,21 +650,36 @@ - 参数: - `sdk`: `sdk`指针 - `group`: 请求群组ID - - `params`: 请求参数 - - `callback`: 回调函数 + - `params`: 请求参数,c风格JSON字符串 + - addresses: 字符串数组,订阅Event的合约地址列表,为空时表示所有的合约 + - fromBlock: 整形,初始区块,-1表示从当前最高块开始 + - toBlock: 整形,结束区块,-1表示不限制区块高度,已经是最高块时也继续等待新的区块 + - topics: 字符串数组,订阅的topic列表,为空时表示所有的topic + + 示例: + + ```shell + { + "addresses": ["6849F21D1E455e9f0712b1e99Fa4FCD23758E8F1"], + "fromBlock": -1, + "toBlock": -1, + "topics": [] + } + ``` + - `context`: 回调上下文 - 返回: - - 合约事件订阅的任务id + - 合约事件订阅的任务id,c风格字符串 ### `bcos_event_sub_unsubscribe_event` - 原型: - `void bcos_event_sub_unsubscribe_event(void* sdk, const char* id)` - 功能: - - 去掉合约事件订阅 + - 取消合约事件订阅 - 参数: - `sdk`: `sdk`指针 - - `id`: 合约事件订阅的任务id + - `id`: 合约事件订阅的任务id,`bcos_event_sub_subscribe_event`的返回值 ## 6. 工具类 diff --git a/3.x/zh_CN/docs/develop/sdk/index.md b/3.x/zh_CN/docs/develop/sdk/index.md index de3251455..f2eeb43e2 100644 --- a/3.x/zh_CN/docs/develop/sdk/index.md +++ b/3.x/zh_CN/docs/develop/sdk/index.md @@ -25,6 +25,7 @@ FISCO BCOS 3.0版本的多语言SDK设计采用**分层架构**实现,从下 java_sdk/index.md c_sdk/index.md + python_sdk/index.md cert_config.md ``` diff --git a/3.x/zh_CN/docs/develop/sdk/python_sdk/index.md b/3.x/zh_CN/docs/develop/sdk/python_sdk/index.md new file mode 100644 index 000000000..3b19a092b --- /dev/null +++ b/3.x/zh_CN/docs/develop/sdk/python_sdk/index.md @@ -0,0 +1,17 @@ +# Python SDK + +标签:``Python SDK`` ``区块链应用`` + +---- + +Python SDK为[FISCO BCOS](https://github.com/FISCO-BCOS/FISCO-BCOS/tree/master)提供Python API,使用FISCO BCOS Python SDK可以简单快捷的基于FISCO-BCOS进行区块链应用开发。 + +2022.09版本同时支持FISCO BCOS 2.x / 3.x。与3.x相关的技术说明参见 [FISCO BCOS 3.x 开发介绍](https://github.com/FISCO-BCOS/python-sdk/blob/master/README_bcos3.md) + +**Python SDK定位为开发版本,持续迭代,供使用Python语言开发FISCO BCOS应用的开发者参考。企业级应用推荐使用 Java SDK** + +如需将Python SDK用于正式环境,请认真阅读和理解代码,掌握相关知识点,按自己的需求进行二次开发并**严谨测试**后上线。 + +如有任何问题,欢迎到社区提问交流,或修改扩展提交pr,共建项目。 + +安装配置环境,使用Python SDK进行应用开发请参见[【github链接】](https://github.com/FISCO-BCOS/python-sdk) [【gitee链接】](https://gitee.com/FISCO-BCOS/python-sdk)