IOTA 系统中 SCU 区块链的轻量级包。
项目描述
SCoinAPI 文档
包装概览
scoinAPI 是一个 Python 包，提供快速、简化和管理角色权限的功能。它旨在成为访问 SCoin 系统方法的基础包，而不是编写一个没有完全理解的方法。除此之外，在 SCoin 系统中创建角色很容易上手。此外，此包将在真实 API 更新后自动更新。
入门
-
什么是 scoinAPI？
IOTA 系统中 SCU 区块链的轻量级包。 -
谁可以使用 scoinAPI ？
SCoin系统的开发者。 -
如何安装软件包？
运行以下命令进行安装：$ pip install SCoinAPI
-
SCoin系统的作用是什么？
存在三个角色，即中央银行、银行和零售商。 -
每个角色有什么区别？
每个角色都有不同的权限来访问该方法。 -
如何导入包？
根据角色导入包：-
中央银行
from SCoinAPI import centralbank cb = centralbank.Central_Bank()
-
银行
from SCoinAPI import bank bk = bank.Bank()
-
零售商
from SCoinAPI import retailer rt = retailer.Retailer()
-
-
SCoin 系统中有哪些层？
SCoin 系统中的层表示用户的角色。(a) 第 1 层 = 中央银行 (b) 第 2 层 = 银行或零售商
SCoin系统中每个角色的方法
-
中央银行
- 连接测试
- 发送令牌
- 获取平衡
- create_did
- get_did
- 验证令牌
- 发送令牌
- 发送令牌
- 移除层1
- get_transactions_by_timestamp
- get_user_by_timestamp
- 获取信息
- set_central_bank
- get_all_cluster [待开发]
- 桥梁 [ 待删除 ]
- 快照 [待删除]
- get_enseed [待开发]
-
银行
-
零售商
API 参考
-
连接测试
-
描述 ：
为了测试真正的 API 连接，我们正在服务。 -
参数 ：
- l(str) : 可选，设置真正的API链接，如果它已经改变。
-
返回：
状态和消息的字典。 -
用法 ：
r = cb.connection_test()
-
-
发送令牌
-
描述 ：
在 SCoin 系统的两个用户之间进行交易，但它只适用于第 1 层用户。 -
参数 ：
- password(str) ：用户的密码。
- sen(str) : 发件人的用户名。
- rev(str) : 接收者的用户名。
- num(int) : 交易金额。
- method(str) : 可选，用户方法，默认值为 light。
- description(any) : 可选，交易的元数据。
- l(str) : 可选，设置真正的API链接，如果它已经改变。
-
返回：
状态、响应数据和消息的字典。 -
用法 ：
r = cb.send_token('SENDER_PASSWORD','SENDER','RECEIVABLE',20)
-
-
发送令牌
-
描述 ：
SCoin系统的两个用户之间进行交易，可用于基本交易。 -
参数 ：
- password(str) ：用户的密码。
- sen(str) : 发件人的用户名。
- rev(str) : 接收者的用户名。
- num(int) : 交易金额。
- method(str) : 可选，用户方法，默认值为 light。
- description(any) : 可选，交易的元数据。
- l(str) : 可选，设置真正的API链接，如果它已经改变。
-
返回：
状态、响应数据和消息的字典。 -
用法 ：
r = cb.send_tokens('SENDER_PASSWORD','SENDER','RECEIVABLE',20)
-
-
获取平衡
-
描述 ：
通过用户的做得到用户的余额。 -
参数 ：
- name(str) ：用户所做的。
- l(str) : 可选，设置真正的API链接，如果它已经改变。
-
返回：
状态、响应数据和消息的字典。 -
用法 ：
r = cb.get_balance('USERNAME')
-
-
create_did
-
描述 ：
在 SCoin 系统中创建用户。 -
参数 ：
- name(str) ：用户所做的。
- password(str) ：用户的密码。
- method(str) : 可选，用户方法，默认值为 light。
- description(any) : 可选，交易的元数据。
- l(str) : 可选，设置真正的API链接，如果它已经改变。
- pub_key(str) ：可选，RSA公钥或端点，如果该字段为空，服务将生成一个密钥对。
-
返回：
状态、响应数据和消息的字典。 -
用法 ：
r = cb.create_did('DID','PASSWORD')
-
-
get_did
-
描述 ：
通过哈希值（pub_key）获取用户的详细信息。 -
参数 ：
- hash_(str) : 用户做的公钥。
- l(str) : 可选，设置真正的API链接，如果它已经改变。
-
返回：
状态、响应数据和消息的字典。 -
用法 ：
r = cb.get_did('HASH_VALUE')
-
-
验证令牌
-
描述 ：
验证自我令牌。 -
参数 ：
- name(str) ：用户所做的。
- password(str) ：用户的密码。
- token(str) : 要验证的 token 的哈希值。
- l(str) : 可选，设置真正的API链接，如果它已经改变。
-
返回：
状态和消息的字典。 -
用法 ：
r = cb.verify_token('DID','PASSWORD','HASH_VALUE')
-
-
移除层1
-
描述 ：
将用户的权限降级到二层。 -
参数 ：
- name(str) : 用户确实被降级了。
- password(str) : 要降级的用户密码。
- l(str) : 可选，设置真正的API链接，如果它已经改变。
-
返回：
状态和消息的字典。 -
用法 ：
r = cb.remove_layer1('DID','PASSWORD','HASH_VALUE')
-
-
get_transactions_by_timestamp
-
描述 ：
在特定时间范围内获取交易。 -
参数 ：
- start_time(int) ：开始时间。
- end_time(int) ：结束时间。
- l(str) : 可选，设置真正的API链接，如果它已经改变。
-
返回：
状态、响应数据和消息的字典。 -
用法 ：
r = cb.get_transactions_by_timestamp(0,10000000)
-
-
get_user_by_timestamp
-
描述 ：
在特定时间范围内获取注册用户。 -
参数 ：
- start_time(int) ：开始时间。
- end_time(int) ：结束时间。
- l(str) : 可选，设置真正的API链接，如果它已经改变。
-
返回：
状态、响应数据和消息的字典。 -
用法 ：
r = cb.get_user_by_timestamp(0,10000000)
-
-
获取信息
-
描述 ：
获取注册用户总数。 -
参数 ：
- l(str) : 可选，设置真正的API链接，如果它已经改变。
-
返回：
状态、响应数据和消息的字典。 -
用法 ：
r = cb.get_info()
-
-
set_central_bank
-
描述 ：
将用户的权限升级到layer-1。 -
参数 ：
- name(str) : 用户需要升级。
- password(str) : 要升级的用户密码。
- l(str) : 可选，设置真正的API链接，如果它已经改变。
-
返回：
状态和消息的字典。 -
用法 ：
r = cb.set_central_bank('DID','PASSWORD')
-
如果您有任何问题，请联系以下信息。
- LINE : nus_jie
- 电子邮件：sefx5ever@gmail.com
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个，请了解有关安装包的更多信息。
源分布
SCoinAPI-1.2.3.tar.gz
（8.3 kB
查看哈希）
内置分布
SCoinAPI-1.2.3-py3-none-any.whl
（8.5 kB
查看哈希）