diff --git a/.gitignore b/.gitignore index 1f93f3d..1d9e5c2 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,10 @@ /build +.DS_Store +.gradle +.idea +gradle +gradlew +gradlew.bat # Compiled class file *.class diff --git a/文档编写说明.txt b/README.md similarity index 79% rename from 文档编写说明.txt rename to README.md index 23ed143..dbdd271 100644 --- a/文档编写说明.txt +++ b/README.md @@ -1,7 +1,12 @@ -# 开发环境安装： - +# 环境依赖安装： +```bash +#视情况使用pip/pip3 pip install sphinx - +pip install recommonmark +pip install sphinx_rtd_theme +pip install sphinx_markdown_tables +pip install sphinx-multiversion +``` # 配置文件说明 ./source/index.rst @@ -13,11 +18,18 @@ pip install sphinx ## 转换成rst，并生成html。 -在./doc/目录下，执行： +执行： ```bash sh toRst.sh ``` +## 生成pdf文件 + +执行： +```bash +make latex +make latexPdf +``` ## diff --git a/source/Introduction.rst b/source/Introduction.rst index d12c18f..549684d 100644 --- a/source/Introduction.rst +++ b/source/Introduction.rst @@ -6,7 +6,7 @@ BDContract介绍 什么是BDContract? ----------------- -北大数瑞是面向大数据场景的数据资源、IoT资源、云资源的管理、调度平台。BDContract是一个可信计算框架，计算逻辑以智能合约的方式表达。通过”随机“和”冗余计算“的方式实现智能合约的可信执行。BDContract在保证智能合约的可用性、可靠性的同时，着重提升执行效率和安全性。 +BDContract是智融云河大数据区块链中，基于北大数瑞开源的智能合约引擎封装的一套软件。是面向大数据场景的数据资源、IoT资源、云资源的管理、调度平台。BDContract是一个可信计算框架，计算逻辑以智能合约的方式表达。通过”随机“和”冗余计算“的方式实现智能合约的可信执行。BDContract在保证智能合约的可用性、可靠性的同时，着重提升执行效率和安全性。 -------------- diff --git a/source/_template/versions.html b/source/_template/versions.html new file mode 100644 index 0000000..28cc588 --- /dev/null +++ b/source/_template/versions.html @@ -0,0 +1,27 @@ +{%- if current_version %} +
+ + Other Versions + v: {{ current_version.name }} + + +
+ {%- if versions.tags %} +
+
Tags
+ {%- for item in versions.tags %} +
{{ item.name }}
+ {%- endfor %} +
+ {%- endif %} + {%- if versions.branches %} +
+
Branches
+ {%- for item in versions.branches %} +
{{ item.name }}
+ {%- endfor %} +
+ {%- endif %} +
+
+{%- endif %} \ No newline at end of file diff --git a/source/conf.py b/source/conf.py index 7babe5d..da1f607 100644 --- a/source/conf.py +++ b/source/conf.py @@ -16,9 +16,9 @@ # -- Project information ----------------------------------------------------- -project = '北大数瑞大数据区块链' -copyright = '2021, Peking University' -author = 'Peking University' +project = '智融云河大数据区块链' +copyright = '2021, ZRYH' +author = 'ZRYH' # The full version, including alpha/beta/rc tags release = 'V1.0' @@ -83,15 +83,16 @@ html_static_path = ['_static'] master_doc = 'index' -latex_elements = { - 'papersize': 'a4paper', + +##latex_elements = { +## 'papersize': 'a4paper', # Additional stuff for the LaTeX preamble. - 'preamble': ''' -\usepackage{xeCJK} -\usepackage{indentfirst} -\setlength{\parindent}{2em} -\setCJKmainfont[BoldFont=STFangsong, ItalicFont=STKaiti]{STSong} -\setCJKsansfont[BoldFont=STHeiti]{STXihei} -\setCJKmonofont{STFangsong} -''', -} +## 'preamble': ''' +##\usepackage{xeCJK} +##\usepackage{indentfirst} +##\setlength{\parindent}{2em} +##\setCJKmainfont[BoldFont=STFangsong, ItalicFont=STKaiti]{STSong} +##\setCJKsansfont[BoldFont=STHeiti]{STXihei} +##\setCJKmonofont{STFangsong} +##''', +##} \ No newline at end of file diff --git a/source/index.rst b/source/index.rst index 06a22c5..63327bd 100644 --- a/source/index.rst +++ b/source/index.rst @@ -3,7 +3,7 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -北大数瑞大数据区块链 文档 +智融云河大数据区块链-智能合约引擎 文档 ====================================== .. toctree:: diff --git a/source/markdown/conf.py b/source/markdown/conf.py new file mode 100644 index 0000000..8f9a4d9 --- /dev/null +++ b/source/markdown/conf.py @@ -0,0 +1,100 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- +project = '北大数瑞大数据区块链' +copyright = '2021, Peking University' +author = 'Peking University' + +# The full version, including alpha/beta/rc tags +release = 'V1.0' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. + +html_theme = "sphinx_rtd_theme" +html_logo="_static/imgs/logo.png" +html_theme_options = { +'logo_only': True +} + +source_parsers = { + '.md': 'recommonmark.parser.CommonMarkParser', +} + +source_suffix = ['.rst', '.md'] + +# source_suffix = { +# '.rst': 'restructuredtext', +# '.txt': 'markdown', +# '.md': 'markdown' +# } + +extensions = [ + 'recommonmark', + 'sphinx_rtd_theme', + 'sphinx_markdown_tables' +] + +html_favicon = "_static/imgs/favicon.ico" +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = 'zh_CN' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +#html_theme = 'alabaster' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +master_doc = 'index' + + +##latex_elements = { +## 'papersize': 'a4paper', + # Additional stuff for the LaTeX preamble. +## 'preamble': ''' +##\usepackage{xeCJK} +##\usepackage{indentfirst} +##\setlength{\parindent}{2em} +##\setCJKmainfont[BoldFont=STFangsong, ItalicFont=STKaiti]{STSong} +##\setCJKsansfont[BoldFont=STHeiti]{STXihei} +##\setCJKmonofont{STFangsong} +##''', +##} \ No newline at end of file diff --git a/source/markdown/index.rst b/source/markdown/index.rst new file mode 100644 index 0000000..63327bd --- /dev/null +++ b/source/markdown/index.rst @@ -0,0 +1,18 @@ +.. BDContract documentation master file, created by + sphinx-quickstart on Mon Nov 25 16:23:38 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +智融云河大数据区块链-智能合约引擎 文档 +====================================== + +.. toctree:: + :maxdepth: 3 + :caption: 目录 + + Introduction.rst + InstallTips.rst + IDEUsage.rst + ContractAPI.rst + YJSInDepth.rst + YJSAPI.rst \ No newline at end of file diff --git a/source/markdown_BDWare/conf.py b/source/markdown_BDWare/conf.py new file mode 100644 index 0000000..8caa5e6 --- /dev/null +++ b/source/markdown_BDWare/conf.py @@ -0,0 +1,108 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- +project = '北大数瑞大数据区块链' +copyright = '2021, Peking University' +author = 'Peking University' + +# The full version, including alpha/beta/rc tags +release = 'V1.0' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. + +html_theme = "sphinx_rtd_theme" +html_logo="_static/imgs/logo.png" +html_theme_options = { +'logo_only': True +} + +source_parsers = { + '.md': 'recommonmark.parser.CommonMarkParser', +} + +source_suffix = ['.rst', '.md'] + +# source_suffix = { +# '.rst': 'restructuredtext', +# '.txt': 'markdown', +# '.md': 'markdown' +# } + +extensions = [ + 'recommonmark', + 'sphinx_rtd_theme', + 'sphinx_markdown_tables', + 'sphinx_multiversion' +] + +html_favicon = "_static/imgs/favicon.ico" +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = 'zh_CN' + +html_sidebars = { + '**': [ + 'versioning.html', + ], +} +smv_latest_version = 'master' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +#html_theme = 'alabaster' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +master_doc = 'index' + + +##latex_elements = { +## 'papersize': 'a4paper', + # Additional stuff for the LaTeX preamble. +## 'preamble': ''' +##\usepackage{xeCJK} +##\usepackage{indentfirst} +##\setlength{\parindent}{2em} +##\setCJKmainfont[BoldFont=STFangsong, ItalicFont=STKaiti]{STSong} +##\setCJKsansfont[BoldFont=STHeiti]{STXihei} +##\setCJKmonofont{STFangsong} +##''', +##} \ No newline at end of file diff --git a/source/markdown_BDWare/index.rst b/source/markdown_BDWare/index.rst new file mode 100644 index 0000000..63327bd --- /dev/null +++ b/source/markdown_BDWare/index.rst @@ -0,0 +1,18 @@ +.. BDContract documentation master file, created by + sphinx-quickstart on Mon Nov 25 16:23:38 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +智融云河大数据区块链-智能合约引擎 文档 +====================================== + +.. toctree:: + :maxdepth: 3 + :caption: 目录 + + Introduction.rst + InstallTips.rst + IDEUsage.rst + ContractAPI.rst + YJSInDepth.rst + YJSAPI.rst \ No newline at end of file diff --git a/source/markdown_ZRYH/ContractAPI.md b/source/markdown_ZRYH/ContractAPI.md new file mode 100644 index 0000000..3226a25 --- /dev/null +++ b/source/markdown_ZRYH/ContractAPI.md @@ -0,0 +1,3511 @@ +# BDContract SDK +除使用可视化的智能合约在线IDE外,用户还可使用WebSocket接口、Http接口、Bash接口来启动和运行合约. + +- - - + +## WebSocketSDK下载与安装 +合约SDK提供javascript版本与java版本的客户端。 + +java客户端的下载链接为:[java source](./_static/BDWareJavaClient.zip)和[jar](./_static/BDWareConfigTool.zip) +可参考java_source下的README.md及测试用例。 + +javascript的下载链接为:[js SDK](./_static/js/createWS.js) +内置的SM2加密库链接:[sm2 SDK](./_static/js/sm2.js) + +### 建立连接 +建立与节点服务器之间的WebSocket连接. + +#### 参数 + +| 字段 | 值 | +| ---------- | ------------------------------------------------------------ | +| url | 建立WebSocket的服务器URL. 使用`http`协议时, 前缀为`ws://`, 如`"ws://localhost:1717/SCIDE/SCExecutor"`; 使用`https`协议时, 前缀为`wss://` | +| msgHandler | 收到服务器WebSocket回复后的回调函数, 用户可自行编写, 也可参考下面提供的示例 | + +#### 请求示例 + +```javascript +var url = "ws://127.0.0.1:1717/SCIDE/SCExecutor";//与Slave节点建立连接 +//var url = "ws://127.0.0.1:1718/NodeCenterWS";//与Manager节点建立连接 +var msgHandler = function(m){ + console.log("recmsg:"); + console.log(m); +}; +var onOpenHandler=undefined; +wssocket = createWssocket(url,onOpenHandler,msgHandler); +``` + +#### 返回结果示例 + +``` +{ + receiveSeg: [Function (anonymous)], + isSending: false, + sendList: [], + monitor: [Function (anonymous)], + send: [Function (anonymous)], + sendNextSegment: [Function (anonymous)], + isOpen: [Function (anonymous)] +} +``` + + + +### ping + +`ping`服务器测试 + +#### 参数 + +| 字段 | 值 | +| ------ | ---- | +| action | ping | + +#### 请求示例 + +``` +var request = {}; +request.action = "ping"; +wssocket.send(JSON.stringify(request)); +``` + +#### 返回结果示例 + +``` +{ + "action":"pong" +} +``` + +### 登录 + +使用Websocket接口调用需要权限的接口时，不论是连接CenterPortal还是NodePortal必须先**登录**。 +登录的流程有3步： + +- 客户端向服务端建立连接，连接建立完成后发送{"action":"getSessionID"}（可在onOpenHandler中实现） +- 服务端收到请求后，会向客户端返回类似{"action":"onGetSessionID","session":"-4959947809200104526_session"}的结果 +- 客户端收到onGetSessionID后,会使用本地的公私钥对sessionID进行签名，并调用login接口 +- 服务端会返回onLogin的结果，data字段返回的是该公钥对应的角色。 + +- - - + +## 用户角色划分 + +### 合约节点的角色划分 + +在合约节点(NodePortal.html)中分为NodeManager/ContractProvider/ContractInstanceManager/ContractUser四类角色。 + +| 角色 | 说明 | +| ----------------------- | ------------------------------------------------------------ | +| NodeManager | 该节点的管理者，拥有用户管理、节点配置等权限 | +| ContractProvider | 拥有编辑合约、开发合约代码、运行调试等权限 | +| ContractInstanceManager | 拥有启、停合约实例、配置合约实例IO等权限 | +| ContractUser | 拥有查看合约实例列表、调用合约等权限 | +| Anonymous | 匿名用户，可以调用合约，可以申请成为ContractProvider/InstanceManager等角色 | + + +| 接口 | 说明 | 角色 | +| ------------------------------- | -------------------- | ----------------------------------------- | +| changeDumpPeriod | 设置备份周期 | ContractInstanceManager; | +| createLedger | 创建账本 | ContractInstanceManager; | +| dumpContract | 手动备份 | ContractInstanceManager; | +| deleteMemoryFile | 删除镜像 | ContractInstanceManager; | +| forkContract | 迁移合约 | ContractInstanceManager; | +| getDumpPeriod | 获取备份周期 | ContractInstanceManager; | +| killAllContract | 停止全部实例 | ContractInstanceManager; | +| killContractProcess | 停止某一实例 | ContractInstanceManager; | +| listMemoryFiles | 列取某一实例的镜像 | ContractInstanceManager; | +| loadMemory | 加载镜像 | ContractInstanceManager; | +| queryContractInstanceDOI | 查询合约实例信息 | ContractInstanceManager; | +| rebuildHashIndex | | ContractInstanceManager; | +| setPermission | | ContractProvider;ContractInstanceManager; | +| startContract | 启动合约 | ContractInstanceManager; | +| startContractBatched | 废弃 | ContractInstanceManager; | +| startContractByYPK | 启动合约 | ContractInstanceManager; | +| startContractInTempZips | 废弃 | ContractInstanceManager; | +| startContractConfig | 启动合约（集群模式） | ContractInstanceManager; | +| updateContract | | ContractInstanceManager; | +| connectTo | 连接合约实例输出流 | ContractInstanceManager;ContractUser; | +| countContractLogGroupByAction | | ContractInstanceManager;ContractUser; | +| countContractLogGroupByCategory | | ContractInstanceManager;ContractUser; | +| getLastLog | 查询日志 | ContractInstanceManager;ContractUser; | +| getLog | 查询日志 | ContractInstanceManager;ContractUser; | +| getLogSize | 查询日志 | ContractInstanceManager;ContractUser; | +| listAllContractProcess | | ContractInstanceManager;ContractUser; | +| listContractProcess | 查询合约实例列表 | ContractInstanceManager;ContractUser; | +| listLeakContractProcess | | ContractInstanceManager;ContractUser; | +| queryContractLogByDate | | ContractInstanceManager;ContractUser; | +| queryContractLogByKey | | ContractInstanceManager;ContractUser; | +| queryContractLogByOffset | | ContractInstanceManager;ContractUser; | +| queryContractLogDetail | | ContractInstanceManager;ContractUser; | +| queryContractLogSize | | ContractInstanceManager;ContractUser; | +| queryNodeLogByDate | | ContractInstanceManager;ContractUser; | +| queryNodeLogByOffset | | ContractInstanceManager;ContractUser; | +| queryNodeLogSize | | ContractInstanceManager;ContractUser; | +| rebuildContractLogIndex | | ContractInstanceManager;ContractUser; | +| rebuildNodeLogIndex | | ContractInstanceManager;ContractUser; | +| changePublic | | ContractProvider; | +| createFile | 新建文件 | ContractProvider; | +| deleteFile | 删除文件 | ContractProvider; | +| distributeContract | | ContractProvider; | +| downloadContract | | ContractProvider; | +| downloadContractFromOtherHost | | ContractProvider; | +| generateAnnotationSample | | ContractProvider; | +| generateAppDataAnalysis | | ContractProvider; | +| generateAppDataSource | | ContractProvider; | +| generateBDCoinEventProject | | ContractProvider; | +| generateBDCoinProject | | ContractProvider; | +| generateBiddingExample | | ContractProvider; | +| generateCSVProject | | ContractProvider; | +| generateContractExecutor | | ContractProvider; | +| generateDAC4BDOA | | ContractProvider; | +| generateDAC4BDOA_persist | | ContractProvider; | +| generateDACSample | | ContractProvider; | +| generateEmptyProject | | ContractProvider; | +| generateEventPublisher | | ContractProvider; | +| generateEventSubscriber | | ContractProvider; | +| generateGasExample | | ContractProvider; | +| generateHello | | ContractProvider; | +| generateHttpExample | | ContractProvider; | +| generateIncentives | | ContractProvider; | +| generateJSONExample | | ContractProvider; | +| generateLedgerExample | | ContractProvider; | +| generateLedgerProject | | ContractProvider; | +| generateLicenceManager | | ContractProvider; | +| generateLoggerExample | | ContractProvider; | +| generateMySQLExample | | ContractProvider; | +| generateMySQLProject | | ContractProvider; | +| generatePostgreSQLSample | | ContractProvider; | +| generateReadme | | ContractProvider; | +| generateRenderSample | | ContractProvider; | +| generateRocksDBSample | | ContractProvider; | +| generateSM2Example | | ContractProvider; | +| generateStaticResource | | ContractProvider; | +| generateTFLinux | | ContractProvider; | +| generategenerateTFMac | | ContractProvider; | +| getProject | | ContractProvider; | +| getTemplateList | | ContractProvider; | +| importContractInstanceCodeByDOI | | ContractProvider; | +| listFile | | ContractProvider; | +| listProject | | ContractProvider; | +| listProjectPermission | | ContractProvider; | +| listProjects | | ContractProvider; | +| renameFile | | ContractProvider; | +| saveFile | | ContractProvider; | +| startContractAsDebug | | ContractProvider; | +| uploadFile | | ContractProvider; | +| compile | | ContractProvider;ContractInstanceManager; | +| evaluates | | ContractProvider;ContractInstanceManager; | +| executeContractP2PTrustfully | | ContractProvider;ContractInstanceManager; | +| getCodeByID | 查询代码 | ContractProvider;ContractInstanceManager; | +| getControlFlowByFileName | | ContractProvider;ContractInstanceManager; | +| getGasValue | | ContractProvider;ContractInstanceManager; | +| listCompiledFiles | | ContractProvider;ContractInstanceManager; | +| queryContractResourceInfo | | ContractProvider;ContractInstanceManager; | +| queryFreeResourceInfo | | ContractProvider;ContractInstanceManager; | +| staticVerifyContract | | ContractProvider;ContractInstanceManager; | +| writeDyjs | | ContractProvider;ContractInstanceManager; | +| authNodeRole | 授权角色 | NodeManager; | +| changeBDledger | 修改账本配置 | NodeManager; | +| changeIpPort | | NodeManager; | +| changeNodeCenter | 修改集群地址 | NodeManager; | +| changeNodeName | | NodeManager; | +| changeIpPort | | NodeManager; | +| changeDOIPConfig | | NodeManager; | +| changeYJSPath | | NodeManager; | +| countNodeLogGroupByCategory | | NodeManager; | +| countRole | | NodeManager; | +| deleteRole | | NodeManager; | +| downloadUUID | 废弃 | NodeManager; | +| getEncodedUUID | 废弃 | NodeManager; | +| getPeerID | | NodeManager; | +| listAllAuthRole | | NodeManager; | +| listNodeInfos | | NodeManager; | +| listUnAuthRole | | NodeManager; | +| loadConfig | | NodeManager; | +| loadNodeConfig | | NodeManager; | +| lockEdit | | NodeManager; | +| unlockEdit | | NodeManager; | +| updateConfig | | NodeManager; | +| uploadLicence | | NodeManager; | +| applyNodeRole | 申请角色 | 任意角色 | +| executeContract | 调用合约 | 任意角色 | +| getConnCount | | 任意角色 | +| getHashAbstractLocally | | 任意角色 | +| getHashLocally | | 任意角色 | +| getNodeRoleDeprecated | 查询当前角色 | 任意角色 | +| getSessionID | | 任意角色 | +| listAdapters | | 任意角色 | +| listTheContractProcess | | 任意角色 | +| login | 登录 | 任意角色 | +| longStr | | 任意角色 | +| ping | | 任意角色 | +| queryDataByHash | | 任意角色 | +| queryDataByHashLocally | | 任意角色 | +| queryHashByOffset | | 任意角色 | +| queryHashByRequestID | | 任意角色 | +| queryHashSize | | 任意角色 | +| queryLedgers | | 任意角色 | +| queryRole | | 任意角色 | +| queryTransactionByHash | | 任意角色 | +| sendTransaction | | 任意角色 | +| setLogStage | | 任意角色 | + +### 合约准入中心角色划分 + +共分为两类角色：CenterManager和NodeManager。其中，CenterManager拥有对集群设置的权限。 +NodeManager可以增加、删除节点等操作。 + +| 接口 | 说明 | 角色 | +| ----------------------------- | ------------ | -------------------------- | +| authNodeManager | | CenterManager; | +| countActionLogByCategory | | CenterManager; | +| countCMLogByCategory | | CenterManager; | +| delete | | CenterManager; | +| listAllUsers | | CenterManager; | +| listApplyList | | CenterManager; | +| listLicence | | CenterManager; | +| queryActionLog | | CenterManager; | +| queryCMLog | | CenterManager; | +| updateLicence | | CenterManager; | +| addNode | | CenterManager;NodeManager; | +| changeNCFile | | CenterManager;NodeManager; | +| changeOtherNC | | CenterManager;NodeManager; | +| createTrustUnit | 创建可信集群 | CenterManager;NodeManager; | +| deleteTrustUnit | | CenterManager;NodeManager; | +| getNCFile | | CenterManager;NodeManager; | +| getNodeTrustUnits | | CenterManager;NodeManager; | +| getOtherNC | | CenterManager;NodeManager; | +| listContractProcess | | CenterManager;NodeManager; | +| listMultiPointContractProcess | | CenterManager;NodeManager; | +| listNodes | | CenterManager;NodeManager; | +| listTrustUnits | | CenterManager;NodeManager; | +| queryUserStat | | CenterManager;NodeManager; | +| stopMultiPointContractProcess | | CenterManager;NodeManager; | +| applyRole | | NodeManager; | +| executeContract | 调用合约 | 任意角色 | +| executeContractTrustfully | | 任意角色 | +| getManagerPubkey | | 任意角色 | +| getNodeRole | | 任意角色 | +| getNodeSessionID | | 任意角色 | +| getRole | | 任意角色 | +| getSessionID | | 任意角色 | +| login | 登录 | 任意角色 | + +- - - + +## 合约节点Http接口 + +`http://xxx.xxx.xxx.xxx:1717/SCIDE/SCManager`为提供Http接口服务的服务器 URL(`xxx.xxx.xxx.xxx:1717`为BDWare SCIDE运行的IP和端口号) , 用户可通过在URL后附加字段参数, 完成以下功能. +`http://xxx.xxx.xxx.xxx:18000/SCIDE/SCManager` 为提供Http接口服务的服务器 + +URL（`xxx.xxx.xxx.xxx:1717` 为BDWare SCIDE运行的IP和端口号），用户可通过在URL后附加字段参数，完成以下功能： + + +### 用户管理类 + +#### ping + +`ping`服务器测试 + +##### 方法 + +GET + +##### 参数 + + +| 字段 | 值 | +| ------ | ---- | +| action | ping | + +##### 请求示例 + +``` +http://127.0.0.1:1717/SCIDE/SCManager?action=ping +``` + +##### 返回结果示例 + +```json +{"data":"pong"} +``` + + +### 合约代码管理类 + + +#### 下载合约项目 + +##### 方法 + +GET + +##### 参数 + + +| 字段 | 值 | +| ----------- | ---------------- | +| action | downloadContract | +| projectName | 合约项目名 | +| isPrivate | 是否在私有目录下 | +| pubKey | 用户公钥 | +| timestamp | 时间戳 | +| sign | 签名 | + + +##### 请求示例 + +``` +http://127.0.0.1:18000/SCIDE/CMManager?action=downloadContract&projectName=BDCoin&isPrivate=false&pubKey=0480204f4ef341359a5f64fcb11baf9ca2e6706ac20cba3 +8b7ff78aa631e97346086e2d48fac2ba7f5b75ccbd19ebf495c0e6f9934d69e3b083da4d42e46c991e0c2ea8bb45d59f31f46d0ec700fb01f2fdd275 +``` + +#### 上传文件 + +##### 方法 + +POST + + +##### 参数 + + +| 字段 | 值 | +| --------- | ---------------- | +| path | 文件上传路径 | +| fileName | 待上传文件名 | +| isPrivate | 是否在私有目录下 | +| order | 第几个数据包 | +| count | 数据包总数 | +| timestamp | 时间戳 | +| sign | 签名 | + + +##### 请求示例 + + +``` +http://127.0.0.1:18000/SCIDE/Upload?path=/TEST/TEST.yjs&fileName=WechatIMG15.jpeg&isPrivate=true&order=0&count=3&pubKey=0480204f4ef341359a5f64fcb11baf9ca2e6706ac20cba36ca83066870cf2c1d5de6df67e24e68dde7934af9b31d94a6084281db3d32d5ce42ab8f75bf799aca05&sign=dd867469f5adf9986e4ea6215febeae50c7d4c3836d002cf8c17050dfca031fd2595ffa8646e9eeae53150d2cbaea690e27d818eaf5cea3632ee1b69c3307a4b631e97346086e2d48fac2ba7f5b75ccbd19ebf495c0e6f9934d69e3b083da4d42e46c991e0c2ea8bb45d59f31f46d0ec700fb01f2fdd275 +``` + +##### 返回结果示例 + +```json +{"status":"true","data":"success"} +``` + +#### 保存合约脚本 + +向服务器发送请求, 向服务器本地保存合约脚本内容. + +##### 方法 + +GET + + +##### 参数 + +| 字段 | 值 | +| ------- | -------------- | +| action | writeDyjs | +| target | 合约脚本文件名 | +| content | 合约脚本内容 | + +##### 请求示例 + +``` +http://127.0.0.1:1717/SCIDE/SCManager?action=writeDyjs&target=testyjs.yjs&content=contract%20shortc%7B%0A%09export%20function%20main(arg)%7B%0A%09%09return%20arg.length%3B%09%0A%09%7D%0A%7D +``` + +##### 返回结果示例 + +```json +{ + "status": false, + "action": "onWriteDyjs", + "data": "success" +} +``` + +后续用户可启动并调用该合约. + + + + + + + +### 合约实例管理类 + +#### 查询合约进程 + +向服务器发送请求, 查询服务器上已经启动的所有合约进程. + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| ------ | ------------------- | +| action | listContractProcess | + +##### 请求示例 + +``` +http://127.0.0.1:1717/SCIDE/SCManager?action=listContractProcess +``` + +##### 返回结果示例 + +```json +{ + "status": false, + "action": "onListContractProcess", + "data": "[\n {\n \"id\": \"-562752842\",\n \"name\": \"shortc\",\n \"port\": \"1626\",\n \"times\": \"0 \",\n \"traffic\": \"32.00 B\",\n \"storage\": \"0.00 B\",\n \"contractStatus\": \"Ready\"\n }\n]" +} +``` + + +#### 启动合约 + +向服务器发送请求, 启动某个合约. + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| ------ | --------------------------------- | +| action | startContract | +| script | 合约脚本内容, 需进行进行URIEncode | + +##### 请求示例 + +``` +http://127.0.0.1:1717/SCIDE/SCManager?action=startContract&script=contract%20shortc%7B%0A%09export%20function%20main(arg)%7B%0A%09%09return%20arg.length%3B%09%0A%09%7D%0A%7D +``` + +##### 返回结果示例 + +```json +{ + "data": "{\"status\":\"Success\",\"result\":\"\"}", + "action": "onStartContract", + "cid": "-562752842", + "executeTime": 1187 +} +``` + + + +#### 调用合约 + +向服务器发送请求, 调用某个合约. + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| -------------------- | --------------------------- | +| action | executeContract | +| contractID | 合约ID | +| withDynamicAnalysis | true/false 是否进行动态分析 | +| operation | 调用合约的方法名 | +| arg | 调用合约的参数 | +| pubkey | 可选，调用者公钥 | +| signature | 可选，签名 | + + +其中pubkey为sm2的公钥，计算方式如下： + +```javascript +//sm2 可从sm2.js中加载获得。 +signature = sm2.doSignature(contractID+"|"+operation+"|"+arg+"|"+pubkey,privateKey); +``` + +##### 请求示例 + +``` +http://127.0.0.1:1717/SCIDE/SCManager?action=executeContract&contractID=-620602333&operation=main&arg=hhh +``` + +##### 返回结果示例 + +```json +{ + "data": "{\"status\":\"Success\",\"result\":\"3\"}", + "action": "onExecuteResult", + "executeTime": "13" +} +``` + + + + +#### 批量启动合约 + +向服务器发送请求, 启动服务器中保存有合约脚本的一系列合约. + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| -------- | ------------------------------------ | +| action | startContractBatched | +| fileList | 合约脚本文件列表(Json数组,URLEncode) | + +##### 请求示例 + +``` +http://127.0.0.1:1717/SCIDE/SCManager?action=startContractBatched&fileList=%5B%20%22EventPuber.yjs%22%2C%20%22EventSuber.yjs%22%2C%20%22LicenceManager.yjs%22%20%5D + +``` + +##### 返回结果示例 + +```json +{"EventPuber.yjs":"{\"status\":\"Success\",\"result\":\"\"}","LicenceManager.yjs":"{\"status\":\"Success\",\"result\":\"\"}","EventSuber.yjs":"{\"status\":\"Success\",\"result\":\"\"}","action":"onStartContract"} + +``` + + + + +#### 启动Zip包合约 + +向服务器发送请求, 启动服务器中包装为`zip`格式的合约. + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| --------- | ----------------------- | +| action | startContractInTempZips | +| owner | 调用者公钥 | +| path | zip合约(路径及)文件名 | +| signature | 调用者签名 | + +##### 请求示例 + +``` +http://127.0.0.1:1717/SCIDE/SCManager?action=startContractInTempZips&owner=0475c7b061f32477c1e228dd04143daf58a5574dc3f6b02bd2857cc794eb92bfe98606dc314049e77fd8714f57a5a481cb470cc759e688fe60d40fc87092165e55&path=traceTest.zip&signature=650d3cad50509682937c253d84da99230e8ea1bcfb9b10f6d18f8888c7c4b6b4%2C72231a6daa078a3ce657c0a2ed38251b7db56cf725beaf86780d4c240b19ccc2 + +``` + +##### 返回结果示例 + +```json +{"data":"verify failed","action":"onStartContract"} + +``` + + + + +#### 获取合约代码 + +向服务器发送请求, 获取某个ID合约的脚本代码. + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| ---------- | ----------- | +| action | getCodeByID | +| contractID | 合约ID | + +##### 请求示例 + +``` +http://127.0.0.1:1717/SCIDE/SCManager?action=getCodeByID&contractID=814046805 + +``` + +##### 返回结果示例 + +```json +{"status":true,"action":"onCodeResult","data":"@LogType(\"Arg\")\ncontract EventSuberAtCHQ{\n\t\n \texport function init(arg){\n\t\tvar result \u003d YancloudUtil.subscribe(\"EventPuberAt3966\",\"abc\",handler);\n // print(\"Handler:\"+handler);\n \t \n \t\treturn result;\n\t}\n \texport function handler(e){\n var ret \u003d \"ReceiveEvent:\";\n\t\tret+\u003d\"\\n\";\n \tprint(ret);\n \tret+\u003dYancloudUtil.executeContract(\"EventPuberAt3966\",\"notify\",\"success\");\n \tprint(ret);\n return ret;\n\t}\n}\n"} + +``` + + + + +#### 保存合约状态 + +向服务器发送请求, 获取节点服务器的状态转移日志. + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| ---------- | ------------ | +| action | dumpContract | +| contractID | 合约ID 或 合约Name= | + +##### 请求示例 + +``` +http://127.0.0.1:18000/SCIDE/SCManager?action=dumpContract&contractID=counter&pubKey=040461417efe01423ba603f71c689387e8aac4aa2a6f7cddfaf22c1d22c40222f7669a054e7ec2e8533b04ccbc7a0e6655ac4ae4acef81a2b1822ec6cabcaf6c1f&sign=3045022004ffd1346b936196f5b13953d2f3e11823a0d0a2d2f6fecea258cef8e20d99c0022100bbc219ed1f56799ba28a763b9e9e47063164e7ceecfbfa752de42f44551ffb83 + +``` + +##### 返回结果示例 + +```json +{"data":"success","size":"3.76 KB","time":"0.03s"} + +``` + + + + +#### 获取合约内存文件列表 + +向服务器发送请求, 获取某子文件夹中的所有内存文件列表. + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| ------ | --------------- | +| action | listMemoryFiles | +| contractID | 合约Id 或 合约Name | + +##### 请求示例 + +``` +http://127.0.0.1:18000/SCIDE/SCManager?action=listMemoryFiles&contractID=-247468535&pubKey=040461417efe01423ba603f71c689387e8aac4aa2a6f7cddfaf22c1d22c40222f7669a054e7ec2e8533b04ccbc7a0e6655ac4ae4acef81a2b1822ec6cabcaf6c1f&sign=3045022075c7268e888b0efdef167a3f4dfc6589d771c6be41b3c0a1dc12d057e811f395022100d44f460d0cc3643e169ef08231e75a1e895646c53295c0ef1d15c3b462a53d6b + +``` + +##### 返回结果示例 + +```json +{"data":["2020-09-23.18:40:38","2020-09-24.16:03:41","2020-09-24.16:58:39","2020-09-24.18:25:47","2020-09-24.18:32:37","2020-09-24.20:54:41","2020-09-24.20:57:39","2020-09-24.21:31:07","2020-09-24.21:32:09","2020-09-24.21:36:11","2020-09-28.15:29:15","2020-09-28.20:28:29","2020-09-28.20:39:46","2020-09-28.21:45:31","2020-09-28.21:49:18","2020-09-28.22:27:34","2020-09-28.22:31:09","2020-09-28.22:32:49","2020-10-07.16:51:06","2020-10-07.16:51:23","2020-10-25.21:09:10","2020-12-14.19:06:53","2021-02-02.10:28:56","2021-02-02.10:31:13"],"action":"onListMemoryFiles"} + +``` + +#### 停止合约 + +向服务器发送请求, 停止某个合约. + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| ---------- | ------------------- | +| action | killContractProcess | +| id | 合约ID | +| *requestID | 请求ID, String类型 | + +`*`表示可选参数 + +##### 请求示例 + +``` +http://127.0.0.1:1717/SCIDE/SCManager?action=killContractProcess&id=-1759263594 + +``` + +##### 返回结果示例 + +```json +{"status":false,"action":"onListContractProcess","data":"[\n {\n \"id\": \"-65051856\",\n \"name\": \"EventSuber\",\n \"port\": \"1631\",\n \"times\": \"0 \",\n \"traffic\": \"32.00 B\",\n \"storage\": \"0.00 B\",\n \"contractStatus\": \"Ready\"\n },\n {\n \"id\": \"814046805\",\n \"name\": \"EventSuberAtCHQ\",\n \"port\": \"1630\",\n \"times\": \"0 \",\n \"traffic\": \"32.00 B\",\n \"storage\": \"0.00 B\",\n \"contractStatus\": \"Ready\"\n },\n {\n \"id\": \"2023975189\",\n \"name\": \"LicenceService\",\n \"port\": \"1632\",\n \"times\": \"0 \",\n \"traffic\": \"32.00 B\",\n \"storage\": \"0.00 B\",\n \"contractStatus\": \"Ready\"\n },\n {\n \"id\": \"-620602333\",\n \"name\": \"shortc\",\n \"port\": \"1627\",\n \"times\": \"0 \",\n \"traffic\": \"0.00 B\",\n \"storage\": \"0.00 B\",\n \"contractStatus\": \"Ready\"\n }\n]"} + +``` + + + + +#### 停止所有合约 + +向服务器发送请求, 停止服务器上启动的所有合约. + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| ------ | --------------- | +| action | killAllContract | + +##### 请求示例 + +``` +http://127.0.0.1:1717/SCIDE/SCManager?action=killAllContract + +``` + +##### 返回结果示例 + +```json +{"status":false,"action":"onKillAllContract","data":"Kill:7357,7541,7548,7555,7584,7585,7591,7598,7609,7612,8440,8442,8444,8521,"} + +``` + +#### 静态分析合约 + +向服务器发送请求, 静态分析合约脚本. + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| ---------- | -------------------- | +| action | staticVerifyContract | +| contractid | 合约ID | +| script | 请求ID, String类型 | + +##### 请求示例 + +``` +http://127.0.0.1:1717/SCIDE/SCManager?action=staticVerifyContract&contractid=943728900&script=contract%20shortc%7B%0A%09export%20function%20main(arg)%7B%0A%09%09return%20arg.length%3B%09%0A%09%7D%0A%7D&path=static.yjs + +``` + +##### 返回结果示例 + +```json +{"data":"{\"status\":\"Success\",\"result\":\"{\\\"main\\\":\\\"Ret:arg \\\"}\"}","action":"onExecuteResult","cid":"943728900","executeTime":54} + +``` + + + +#### 获取合约静态分析流 + +向服务器发送请求, 获取某个合约的静态分析Control Flow. + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| ------ | ------------------------ | +| action | getControlFlowByFileName | +| path | 合约ID | + +##### 请求示例 + +``` +http://127.0.0.1:1717/SCIDE/SCManager?action=getControlFlowByFileName&path=EventSuber.yjs + +``` + +##### 返回结果示例 + +```json +{"init":{"blocks":[{"type":"Continuous","name":"B0","stmts":["\u003dL0\u003d","aload 0","invokevirtual wrp/jdk/nashorn/internal/runtime/ScriptFunction getScope ()Lwrp/jdk/nashorn/internal/runtime/ScriptObject;"],"original":""},{"type":"Continuous","name":"B1","stmts":["\u003dL1\u003d","astore 4"],"original":""},{"type":"Continuous","name":"B2","stmts":["\u003dL2\u003d","aload 4","invokedynamic dyn:getProp|getElem|getMethod:YancloudUtil (Ljava/lang/Object;)Ljava/lang/Object; HANDLE:wrp/jdk/nashorn/internal/runtime/linker/Bootstrap.bootstrap(Ljava/lang/invoke/MethodHandles$Lookup;Ljava/lang/String;Ljava/lang/invoke/MethodType;I)Ljava/lang/invoke/CallSite; (6) 5 "],"original":"\t\tvar result \u003d YancloudUtil.subscribe(\"XiaomiSmartHomeAtPKU\",\"onAirPurifierModeChange\",handler);"},{"type":"Continuous","name":"B3","stmts":["dup","invokedynamic dyn:getMethod|getProp|getElem:subscribe (Ljava/lang/Object;)Ljava/lang/Object; HANDLE:wrp/jdk/nashorn/internal/runtime/linker/Bootstrap.bootstrap(Ljava/lang/invoke/MethodHandles$Lookup;Ljava/lang/String;Ljava/lang/invoke/MethodType;I)Ljava/lang/invoke/CallSite; (6) 0 "],"original":"\t\tvar result \u003d YancloudUtil.subscribe(\"XiaomiSmartHomeAtPKU\",\"onAirPurifierModeChange\",handler);"},{"type":"Continuous","name":"B4","stmts":["swap","ldc XiaomiSmartHomeAtPKU","ldc onAirPurifierModeChange","aload 4","invokedynamic dyn:getProp|getElem|getMethod:handler (Ljava/lang/Object;)Ljava/lang/Object; HANDLE:wrp/jdk/nashorn/internal/runtime/linker/Bootstrap.bootstrap(Ljava/lang/invoke/MethodHandles$Lookup;Ljava/lang/String;Ljava/lang/invoke/MethodType;I)Ljava/lang/invoke/CallSite; (6) 5 "],"original":"\t\tvar result \u003d YancloudUtil.subscribe(\"XiaomiSmartHomeAtPKU\",\"onAirPurifierModeChange\",handler);"},{"type":"Continuous","name":"B5","stmts":["invokedynamic dyn:call:\\\u003dYancloudUtil\\,subscribe (Ljava/lang/Object;Ljava/lang/Object;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Object;)Ljava/lang/Object; HANDLE:wrp/jdk/nashorn/internal/runtime/linker/Bootstrap.bootstrap(Ljava/lang/invoke/MethodHandles$Lookup;Ljava/lang/String;Ljava/lang/invoke/MethodType;I)Ljava/lang/invoke/CallSite; (6) 0 "],"original":"\t\tvar result \u003d YancloudUtil.subscribe(\"XiaomiSmartHomeAtPKU\",\"onAirPurifierModeChange\",handler);"},{"type":"Continuous","name":"B6","stmts":["\u003dL3\u003d","astore 5"],"original":"\t\tvar result \u003d YancloudUtil.subscribe(\"XiaomiSmartHomeAtPKU\",\"onAirPurifierModeChange\",handler);"},{"type":"Continuous","name":"B7","stmts":["\u003dL4\u003d","aload 5","areturn"],"original":" \t\treturn result;"},{"type":"Continuous","name":"B8","stmts":["\u003dL5\u003d"],"original":" \t\treturn result;"},{"type":"Continuous","name":"B9","stmts":["\u003dL6\u003d"],"original":" \t\treturn result;"}],"edges":[{"from":"B0","to":"B1","label":{"label":"e"}},{"from":"B1","to":"B2","label":{"label":"e"}},{"from":"B2","to":"B3","label":{"label":"e"}},{"from":"B3","to":"B4","label":{"label":"e"}},{"from":"B4","to":"B5","label":{"label":"e"}},{"from":"B5","to":"B6","label":{"label":"e"}},{"from":"B6","to":"B7","label":{"label":"e"}},{"from":"B7","to":"B9","label":{"label":"e"}}]},"handler":{"blocks":[{"type":"Continuous","name":"B0","stmts":["\u003dL0\u003d","aload 0","invokevirtual wrp/jdk/nashorn/internal/runtime/ScriptFunction getScope ()Lwrp/jdk/nashorn/internal/runtime/ScriptObject;"],"original":""},{"type":"Continuous","name":"B1","stmts":["\u003dL1\u003d","astore 4"],"original":""},{"type":"Continuous","name":"B2","stmts":["\u003dL2\u003d","ldc ReceiveEvent:","aload 2","invokedynamic dyn:getProp|getElem|getMethod:content (Ljava/lang/Object;)Ljava/lang/Object; HANDLE:wrp/jdk/nashorn/internal/runtime/linker/Bootstrap.bootstrap(Ljava/lang/invoke/MethodHandles$Lookup;Ljava/lang/String;Ljava/lang/invoke/MethodType;I)Ljava/lang/invoke/CallSite; (6) 0 "],"original":" var ret \u003d \"ReceiveEvent:\"+e.content+\" \"+e.type;"},{"type":"Continuous","name":"B3","stmts":["invokestatic wrp/jdk/nashorn/internal/runtime/ScriptRuntime ADD (Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;"],"original":" var ret \u003d \"ReceiveEvent:\"+e.content+\" \"+e.type;"},{"type":"Continuous","name":"B4","stmts":["ldc ","invokestatic wrp/jdk/nashorn/internal/runtime/ScriptRuntime ADD (Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;"],"original":" var ret \u003d \"ReceiveEvent:\"+e.content+\" \"+e.type;"},{"type":"Continuous","name":"B5","stmts":["aload 2","invokedynamic dyn:getProp|getElem|getMethod:type (Ljava/lang/Object;)Ljava/lang/Object; HANDLE:wrp/jdk/nashorn/internal/runtime/linker/Bootstrap.bootstrap(Ljava/lang/invoke/MethodHandles$Lookup;Ljava/lang/String;Ljava/lang/invoke/MethodType;I)Ljava/lang/invoke/CallSite; (6) 0 "],"original":" var ret \u003d \"ReceiveEvent:\"+e.content+\" \"+e.type;"},{"type":"Continuous","name":"B6","stmts":["invokestatic wrp/jdk/nashorn/internal/runtime/ScriptRuntime ADD (Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;"],"original":" var ret \u003d \"ReceiveEvent:\"+e.content+\" \"+e.type;"},{"type":"Continuous","name":"B7","stmts":["\u003dL3\u003d","astore 5"],"original":" var ret \u003d \"ReceiveEvent:\"+e.content+\" \"+e.type;"},{"type":"Continuous","name":"B8","stmts":["\u003dL4\u003d","aload 4","invokedynamic dyn:getMethod|getProp|getElem:print (Ljava/lang/Object;)Ljava/lang/Object; HANDLE:wrp/jdk/nashorn/internal/runtime/linker/Bootstrap.bootstrap(Ljava/lang/invoke/MethodHandles$Lookup;Ljava/lang/String;Ljava/lang/invoke/MethodType;I)Ljava/lang/invoke/CallSite; (6) 5 "],"original":" \tprint(ret);"},{"type":"Continuous","name":"B9","stmts":["getstatic wrp/jdk/nashorn/internal/runtime/ScriptRuntime UNDEFINED Lwrp/jdk/nashorn/internal/runtime/Undefined;","aload 5","invokedynamic dyn:call:print (Ljava/lang/Object;Lwrp/jdk/nashorn/internal/runtime/Undefined;Ljava/lang/Object;)Ljava/lang/Object; HANDLE:wrp/jdk/nashorn/internal/runtime/linker/Bootstrap.bootstrap(Ljava/lang/invoke/MethodHandles$Lookup;Ljava/lang/String;Ljava/lang/invoke/MethodType;I)Ljava/lang/invoke/CallSite; (6) 5 "],"original":" \tprint(ret);"},{"type":"Continuous","name":"B10","stmts":["pop"],"original":" \tprint(ret);"},{"type":"Continuous","name":"B11","stmts":["\u003dL5\u003d","aload 5","areturn"],"original":" return ret;"},{"type":"Continuous","name":"B12","stmts":["\u003dL6\u003d"],"original":" return ret;"},{"type":"Continuous","name":"B13","stmts":["\u003dL7\u003d"],"original":" return ret;"}],"edges":[{"from":"B0","to":"B1","label":{"label":"e"}},{"from":"B1","to":"B2","label":{"label":"e"}},{"from":"B2","to":"B3","label":{"label":"e"}},{"from":"B3","to":"B4","label":{"label":"e"}},{"from":"B4","to":"B5","label":{"label":"e"}},{"from":"B5","to":"B6","label":{"label":"e"}},{"from":"B6","to":"B7","label":{"label":"e"}},{"from":"B7","to":"B8","label":{"label":"e"}},{"from":"B8","to":"B9","label":{"label":"e"}},{"from":"B9","to":"B10","label":{"label":"e"}},{"from":"B10","to":"B11","label":{"label":"e"}},{"from":"B11","to":"B13","label":{"label":"e"}}]}} + +``` + +### 日志查看类 + +#### 合约日志-查询数量 + +##### 方法 + +GET + +contractName为空或是不传入时，则为查询全部合约的条数 + + +##### 参数 + +| 字段 | 值 | +| ------------ | ------------------------ | +| action | queryContractLogSize | +| contractName | 字符串，非必须，合约名称 | + +##### 请求示例 + +``` +http://127.0.0.1:18000/SCIDE/CMManager?action=queryContractLogSize&contractName=NanningDataSource +``` + +##### 返回结果示例 + +```json +{ + "size": 12, + "action": "onQueryContractLogSize", + "status": "success" +} + +``` + +#### 合约日志-根据日期查询 + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| ------------ | ------------------------------------- | +| action | queryContractLogByDate | +| start | long，必须，起始时间 | +| end | long，非必须，若无end，默认为当前时间 | +| contractName | 字符串，非必须，合约名称 | + + +##### 请求示例 + +``` +http://127.0.0.1:18000/SCIDE/CMManager?action=queryContractLogByDate&start=1597296300272&end=1597296305747 +``` + +##### 返回结果 + +```json +{ + "data": [ + { + "action": "executeContract", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "contractID": "-1382208250", + "contractName": "NanningDataSource", + "function": "getMainFrame", + "costTime": "2493", + "totalGas": "0", + "executionGas": "0", + "extraGas": "0", + "date": 1597296300272, + "key": "-8590335427581967208" + }, + { + "action": "executeContract", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "contractID": "-1382208250", + "contractName": "NanningDataSource", + "function": "loadResource", + "costTime": "732", + "totalGas": "0", + "executionGas": "0", + "extraGas": "0", + "date": 1597296301030, + "key": "849660532962309239" + }, + { + "action": "executeContract", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "contractID": "-1382208250", + "contractName": "NanningDataSource", + "function": "loadResource", + "costTime": "4580", + "totalGas": "0", + "executionGas": "0", + "extraGas": "0", + "date": 1597296305745, + "key": "-8003529429500512736" + }, + { + "action": "executeContract", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "contractID": "-1382208250", + "contractName": "NanningDataSource", + "function": "loadResource", + "costTime": "4551", + "totalGas": "0", + "executionGas": "0", + "extraGas": "0", + "date": 1597296305746, + "key": "7604666709899222357" + }, + { + "action": "executeContract", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "contractID": "-1382208250", + "contractName": "NanningDataSource", + "function": "loadResource", + "costTime": "6", + "totalGas": "0", + "executionGas": "0", + "extraGas": "0", + "date": 1597296305751, + "key": "-7561786202695627022" + } + ], + "action": "onQueryRecentContractLog" +} +``` + +#### 合约日志-根据偏移量查询 + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| ------------ | --------------------------------------------- | +| action | queryContractLogByOffset | +| count | long，必须，获取日志条数 | +| offset | long，非必须，若无offset，默认返回最新count条 | +| contractName | 字符串，非必须，合约名称 | + +##### 请求示例 + +``` +http://127.0.0.1:18000/SCIDE/CMManager?action=queryContractLogByOffset&count=5&contractName=NanningDataSource +``` + +##### 返回结果 + +```json +{ + "data": [ + { + "action": "executeContract", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "contractID": "-1382208250", + "contractName": "NanningDataSource", + "function": "loadResource", + "costTime": "4", + "totalGas": "0", + "executionGas": "0", + "extraGas": "0", + "date": 1597296305842, + "key": "-2390672423847654148" + }, + { + "action": "executeContract", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "contractID": "-1382208250", + "contractName": "NanningDataSource", + "function": "isOwner", + "costTime": "4", + "totalGas": "0", + "executionGas": "0", + "extraGas": "0", + "date": 1597296305868, + "key": "6056586201629372511" + }, + { + "action": "executeContract", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "contractID": "-1382208250", + "contractName": "NanningDataSource", + "function": "getApplyList", + "costTime": "6", + "totalGas": "0", + "executionGas": "0", + "extraGas": "0", + "date": 1597296305893, + "key": "3882409580676458151" + }, + { + "action": "executeContract", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "contractID": "-1382208250", + "contractName": "NanningDataSource", + "function": "getAcceptList", + "costTime": "4", + "totalGas": "0", + "executionGas": "0", + "extraGas": "0", + "date": 1597296305908, + "key": "-3437513873417136535" + }, + { + "action": "executeContract", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "contractID": "-1382208250", + "contractName": "NanningDataSource", + "function": "analysisByIndustry", + "costTime": "6", + "totalGas": "0", + "executionGas": "0", + "extraGas": "0", + "signature": "4c2cef1756b2b591ab7eead19d67331e2294c7ba765c72298733c306ada0b6e84afbb6c7b9dba48b9843236ebe67aecb4af09fe58a51eef0e2e89b9f3e5cad02", + "arg": " {\"year\":2018,\"category\":\"工业\",\"indexType\":\"营业额\"}", + "date": 1597296314654, + "key": "203156239086062402" + } + ], + "action": "onQueryRecentContractLog" +} +``` + +#### 合约日志-根据key查询 + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| ------ | --------------------------- | +| action | queryContractLogByKey | +| key | long，必须，该日志对应的key | + +##### 请求示例 + +``` +http://127.0.0.1:18000/SCIDE/CMManager?action=queryContractLogByKey&key=203156239086062402 +``` + +##### 返回结果 + +```json +{ + "data": { + "action": "executeContract", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "contractID": "-1382208250", + "contractName": "NanningDataSource", + "function": "analysisByIndustry", + "costTime": "6", + "totalGas": "0", + "executionGas": "0", + "extraGas": "0", + "signature": "4c2cef1756b2b591ab7eead19d67331e2294c7ba765c72298733c306ada0b6e84afbb6c7b9dba48b9843236ebe67aecb4af09fe58a51eef0e2e89b9f3e5cad02", + "arg": " {\"year\":2018,\"category\":\"工业\",\"indexType\":\"营业额\"}", + "date": 1597296314654 + }, + "action": "onQueryContractLogByKey" +} +``` + +#### 合约日志-按时间段统计调用次数 + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| -------- | -------------------------------------------------------- | +| action | countContractLogGroupByCategory | +| start | long，必须，起始时间 | +| end | 非必须，终止时间，默认为当前 | +| interval | long，非必须，统计间隔 | +| category | 非必须，合约名称以逗号连接，不传入时统计全部合约调用情况 | + +##### 请求示例 + +``` +http://127.0.0.1:18000/SCIDE/CMManager?action=countContractLogGroupByCategory&start=1596758400000&interval=86400000 +``` + +##### 返回结果 + +```json +{ + "start": 1596758400000, + "interval": 86400000, + "action": "onCountContractLogGroupByCategory", + "data": [ + 0, + 0, + 0, + 0, + 0, + 0, + 43, + 14 + ] +} +``` + +#### 账本日志-查询数量 + +查询通过本节点去账本上记录的日志数量 + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| ------------ | ---------------- | +| action | queryHashSize | +| contractName | 非必须，合约名称 | + + + +##### 请求示例 + +``` +http://127.0.0.1:18000/SCIDE/CMManager?action=queryHashSize&contractName=NanningDataSource +``` + +##### 返回结果 + +```json +{ + "count": "2", + "action": "onQueryHashSize" +} +``` + + +#### 账本日志-根据偏移量查询 + +查询x条通过本节点去账本上记录的日志的哈希列表 + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| ------------ | ----------------------------------------------------------- | +| action | queryHashByOffset | +| count | 整数，必须,表示条数 | +| offset | 整数，非必须，表示偏移量，不传入offset则默认返回最新count条 | +| contractName | 字符串，非必须，表示合约名称 | + +##### 请求示例 + +``` +http://127.0.0.1:18000/SCIDE/CMManager?action=queryHashByOffset&count=1&contractName=NanningDataSource +``` + +##### 返回结果 + +```json +{ + "data": [ + { + "hash": "3a6c60621907146b77146c1f2d48700e47520173", + "date": 1597296314658 + } + ], + "action": "onQueryHash", + "status": "success" +} +``` + +#### 账本日志-根据hash查询详情 + +根据hash来查询日志内容 + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| ------ | ------------------------------- | +| action | queryDataByHash | +| hash | 字符串，可通过queryHashByOffset | + +##### 请求示例 + +``` +http://127.0.0.1:18000/SCIDE/CMManager?action=queryDataByHash&count=1&contractName=NanningDataSource&hash=3a6c60621907146b77146c1f2d48700e47520173 +``` + +##### 返回结果 + +```json +{ + "from": "0x3034643139323433323966373263656431343866", + "to": "0x65786563757465436f6e74726163740000000000", + "data": "1597296314655 --> {\"extraGas\":\"0\",\"totalGas\":\"0\",\"executionGas\":\"0\",\"signature\":\"4c2cef1756b2b591ab7eead19d67331e2294c7ba765c72298733c306ada0b6e84afbb6c7b9dba48b9843236ebe67aecb4af09fe58a51eef0e2e89b9f3e5cad02\",\"costTime\":\"6\",\"arg\":\" {\\\\\\\"year\\\\\\\":2018,\\\\\\\"category\\\\\\\":\\\\\\\"工业\\\\\\\",\\\\\\\"indexType\\\\\\\":\\\\\\\"营业额\\\\\\\"}\",\"contractID\":\"-1382208250\",\"action\":\"analysisByIndustry\",\"pubKey\":\"04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd\"}", + "requestID": "1597296314629_6067", + "action": "onQueryDataByHash" +} +``` + +#### 账本日志-根据requestID查询Hash + +根据requestID来查询日志内容，需由开发者保证requestID的唯一性 + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| --------- | ------------------------ | +| action | queryHashByRequestID | +| requestID | 字符串，在发起调用时生成 | + +##### 请求示例 + +``` +http://127.0.0.1:1717/SCIDE/SCManager?action=queryHashByRequestID&requestID=0987654321ab +``` + +#### 节点日志-查询数量 + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| -------- | ---------------------------- | +| action | queryNodeLogSize | +| category | 非必须，不传入时查询全部情况 | + +其中包括：ping、startContract、saveFile等。 + +##### 请求示例 + +``` +http://127.0.0.1:18000/SCIDE/CMManager?action=queryNodeLogSize + +http://127.0.0.1:18000/SCIDE/CMManager?action=queryNodeLogSize&category=login +``` + +##### 返回结果 + +```json +{ + "size": 177, + "action": "onQueryNodeLogSize", + "status": "success" +} +``` + +#### 节点日志-按日期查询 + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| -------- | ---------------------------- | +| action | queryNodeLogByDate | +| start | long，必须，起始日期 | +| end | long，非必须 | +| category | 非必须，不传入时查询全部情况 | + +##### 请求示例 + +``` +http://127.0.0.1:18000/SCIDE/CMManager?action=queryNodeLogByDate&start=1597376006441 + +http://127.0.0.1:18000/SCIDE/CMManager?action=queryNodeLogByDate&start=1596758400000&category=login +``` + +##### 返回结果 + +```json +{ + "data": [ + { + "action": "listAllAuthRole", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "status": "accept", + "date": 1597376006438, + "key": "387355870552374748" + }, + { + "action": "listUnAuthRole", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "status": "accept", + "date": 1597376006441, + "key": "4772693258708933626" + }, + { + "action": "countRole", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "status": "accept", + "date": 1597376006444, + "key": "-6425375229108830572" + }, + { + "action": "loadNodeConfig", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "status": "accept", + "date": 1597376006448, + "key": "-6602401010405792959" + }, + { + "action": "getPeerID", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "status": "accept", + "date": 1597376006449, + "key": "-7006776427870311552" + } + ], + "action": "onQueryNodeLogByDate" +} +``` + +#### 节点日志-按偏移量查询 + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| ------------ | --------------------------------------------- | +| action | queryNodeLogByOffset | +| count | long，必须，获取日志条数 | +| offset | long，非必须，若无offset，默认返回最新count条 | +| contractName | 字符串，非必须，合约名称 | + +##### 请求示例 + +``` +http://127.0.0.1:18000/SCIDE/CMManager?action=queryNodeLogByOffset&count=5 +``` + +##### 返回结果 + +```json +{ + "data": [ + { + "action": "listAllAuthRole", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "status": "accept", + "date": 1597376006438, + "key": "387355870552374748" + }, + { + "action": "listUnAuthRole", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "status": "accept", + "date": 1597376006441, + "key": "4772693258708933626" + }, + { + "action": "countRole", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "status": "accept", + "date": 1597376006444, + "key": "-6425375229108830572" + }, + { + "action": "loadNodeConfig", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "status": "accept", + "date": 1597376006448, + "key": "-6602401010405792959" + }, + { + "action": "getPeerID", + "pubKey": "04d1924329f72ced148f6f333fb985ccbaa31b1e3aacf10be5f43d4a4ff5ad88899a005e79e37fc06993e1d66ada8cf8b711cb36f59538bb7d3e39e70fa9360ddd", + "status": "accept", + "date": 1597376006449, + "key": "-7006776427870311552" + } + ], + "action": "onQueryNodeLogByOffset" +} +``` + +#### 节点日志-按时间段统计调用次数 + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| -------- | -------------------------------------------------- | +| action | countLogGroupByCategory | +| start | long，必须，起始时间 | +| end | 非必须，终止时间，默认为当前 | +| interval | long，非必须，统计间隔 | +| category | 非必须，action以逗号连接，不传入时统计全部调用情况 | + +其中，category中的action为NodePortal的接口的action集合。 +包括：ping、startContract、saveFile等。 + +##### 请求示例 + +``` +http://127.0.0.1:18000/SCIDE/CMManager?action=countNodeLogGroupByCategory&start=1596758400000&interval=86400000 + +http://127.0.0.1:18000/SCIDE/CMManager?action=countNodeLogGroupByCategory&start=1596758400000&interval=86400000&category=ping,startContract +``` + +##### 返回结果 + +```json +{ + "start": 1596758400000, + "interval": 86400000, + "action": "onCountNodeLogGroupByCategory", + "data": [ + 0, + 0, + 0, + 0, + 0, + 0, + 912, + 761 + ] +} +``` + + + + + +#### 输出历史记录日志 + +向服务器发送请求, 获取节点服务器上合约的TimeTravel日志. + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| ------ | ------------------ | +| action | printTimeTravelLog | + +##### 请求示例 + +``` +http://127.0.0.1:1717/SCIDE/SCManager?action=printTimeTravelLog + +``` + +##### 返回结果示例 + +```json +{"status":false,"data":"[CMActions] memory dir \u003d /Users/oliveds/docs/SmartContract/contractExamples/memoryDumps/aa\n[CMActions] memory dir \u003d /Users/oliveds/docs/SmartContract/contractExamples/memoryDumps/aa_1572335939893.dyjs\n[CMActions] memory dir \u003d /Users/oliveds/docs/SmartContract/contractExamples/memoryDumps/memoryDumps\n[CMActions] memory dir \u003d /Users/oliveds/docs/SmartContract/contractExamples/memoryDumps\n[CMActions] memory dir \u003d /Users/oliveds/docs/SmartContract/contractExamples/memoryDumps\n[CMActions] memory dir \u003d /Users/oliveds/docs/SmartContract/contractExamples/memoryDumps/.\n[CMActions] memory dir \u003d /Users/oliveds/docs/SmartContract/contractExamples/memoryDumps/.\n"} + +``` + + + + + +#### 输出节点转移日志 + +向服务器发送请求, 获取节点服务器的状态转移日志. + +##### 方法 + +GET + +##### 参数 + +| 字段 | 值 | +| ------ | ---------------- | +| action | printTransferLog | + +##### 请求示例 + +``` +http://127.0.0.1:1717/SCIDE/SCManager?action=printTransferLog + +``` + +##### 返回结果示例 + +```json +{"status":false,"data":""} + +``` + + + +### 模板生成类 + + + + + + + +- - - + +## 合约节点WebSocket接口 + +### 用户管理类 + +#### 获取Session + +登录前获取session以便进行签名。 + +##### 参数 + +| 字段 | 值 | +| ------ | ------------ | +| action | getSessionID | + +##### 请求示例 + +``` +var req = {}; +req.action = "getSessionID"; +wssocket.send(JSON.stringify(req)); +``` + + +##### 返回结果 + +```json +{ + "action": "onSessionID", + "session": "9782323_session" +} +``` + +#### 用户登录 + +用户进行公私钥身份验证 + +##### 参数 + +| 字段 | 值 | +| ------ | ----- | +| action | login | + +##### 请求示例 + +``` +var loginParam = {}; +loginParam.pubKey = global.sm2Key.publicKey; +loginParam.signature = sm2.doSignature(global.session, + global.sm2Key.privateKey); +loginParam.action = "login"; +wssocket.send(JSON.stringify(loginParam)); +``` + +##### 返回结果 + +```json +{ + "action": "onLogin", + "data": "NodeManager,ContractProvider" +} +``` + +#### 申请角色 + +在节点管理员界面申请可以申请称为合约管理员(ContractInstanceManager)、合约使用者(ContractUser)、合约提供者（ContractProvider) + +##### 参数 + +| 字段 | 值 | +| ------ | ------------- | +| action | applyNodeRole | +|role|申请角色名称| + +##### 请求示例 + +``` +var param = {}; +param.action = "applyNodeRole"; +param.role = "ContractUser"; +wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果 + +``` json +{ + "action": "onApplyRole", + "data": "success" +} + +{ + "action":"onApplyRole", + "data":"already has!" +} +``` + +#### 授权角色 + +##### 参数 + +| 字段 | 值 | +| -------- | -------------------- | +| action | authNodeRole | +| isAccept | bool类型，表示否授权 | +| pubKey | 授权用户公钥 | + + +##### 请求示例 + +``` +var param = {}; +param.action = "authNodeRole"; +param.isAccept = true; +param.pubKey = "xxxxx"; +wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果 + +```json +{ + "action": "onAuthNodeRole", + "data": "success" +} +``` + +#### 删除用户角色 + +##### 参数 + +| 字段 | 值 | +| ------ | ---------- | +| action | deleteRole | +| role | 删除角色名称 | + +##### 请求示例 + +``` +var deleteInfo = {}; +deleteInfo.pubKey = global.authorizedUsers.[publicKey]; +deleteInfo.action = "deleteRole"; +deleteInfo.role="ContractUser"; +wssocket.send(JSON.stringify(deleteInfo)); +``` + +##### 返回结果 + +```json +{ + "action": "onDeleteRole", + "data": "success" +} +``` + +#### 查看授权用户列表 + +查看准入管理员当前组网中已经授权的节点管理员 + +##### 参数 + +| 字段 | 值 | +| ------ | --------------- | +| action | listAllAuthRole | + +##### 请求示例 + +``` +var param = {}; +param.action = "listAllAuthRole"; +wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果 + +```json +{ + "status":false, + "action":"onListAllAuthRole", + "data": + { + "kv":[{"key":"04eafad549d0757cf67f360815e15e157c7428c9ea9fb933f31a5d45bfb6edd9809c5bf6a5f37d7b817207f19fb2d76b7dbdefe38084cd3282e37b9ac39959dfab", + "value":"NodeManager,ContractProvider,ContractUser,ContractInstanceManager"}], + "time":[{"key":"04eafad549d0757cf67f360815e15e157c7428c9ea9fb933f31a5d45bfb6edd9809c5bf6a5f37d7b817207f19fb2d76b7dbdefe38084cd3282e37b9ac39959dfab", + "value":"1617178709933"}] + } +} +``` + +#### 查看申请用户列表 + +##### 参数 + +| 字段 | 值 | +| ------ | -------------- | +| action | listUnAuthRole | + +##### 请求示例 + +``` +var param = {}; +param.action = "listUnAuthRole"; +wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果 + +```json +{ + "action": "onListUnAuthRole", + "kv": [{ + "key": "049999ebd14ff3b96ebf7f7325e1da94a1c4c376573a1dc1cec2b4f7a3b09ed7b07252134e93b6ac2e1853268b82f4b541d34fb42b0182cd61043e99d3489e2cf7", + "value": "ContractProvider,ContractUser" + }], + "time": [{ + "key": "049999ebd14ff3b96ebf7f7325e1da94a1c4c376573a1dc1cec2b4f7a3b09ed7b07252134e93b6ac2e1853268b82f4b541d34fb42b0182cd61043e99d3489e2cf7", + "value": "1587398989914" + }] +} +``` + + +##### 参数(删除) + +| 字段 | 值 | +| ------ | ------------- | +| action | queryUserStat | + +##### 请求示例 + +``` +var param = {}; +param.action = "queryUserStat"; +wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果 + +```json +{ + "action": "onQueryUserStat", + "userListCount": 3, + "applyListCount":0 +} +``` + +### 合约代码管理类 + +#### 获取公共合约文件列表 + +##### 参数 + +| 字段 | 值 | +| ------ | ------------ | +| action | listProjects | + +##### 请求示例 + +``` +var request = {}; +request.action = "listProjects"; +wssocket.send(JSON.stringify(request)); +``` + +##### 返回结果 +```json +{ + "action":"onListProjects", + "data":"[\"AnnotationSample\",\"AppDataAnalysis\",\"AppDataSource\",\"BiddingExample\",\"ContractExecutor\"]", + "executeTime":0, + "isPrivate":false +} + +``` + + +#### 获取私有合约文件列表 + +##### 参数 + +| 字段 | 值 | +| ------ | -------------------- | +| action | listProjects | +| pubKey | 该用户的公钥 | +|isPrivate|true| + +##### 请求示例 + +```javascript +var request = {}; +request.action = "listProjects"; +request.pubKey = "global.sm2.publicKey"; +request.isPrivate=true; +wssocket.send(JSON.stringify(request)); +``` + +##### 返回结果 + +```json +{ + "action":"onListProjects", + "data":"[\"CSVFromTemplate\",\"Empty22\",\"MySQLFromTemplate\",\"test\"]", + "executeTime":0, + "isPrivate":true +} +``` + + +#### 获取合约实例 + +##### 参数 + +| 字段 | 值 | +| ------ | ------------------- | +| action | listContractProcess | + +##### 请求示例 + +``` +var request = {}; +request.action = "listContractProcess"; +wssocket.send(JSON.stringify(request)); +``` + +##### 返回结果 + +```json +{ + "status":false, + "action":"onListContractProcess", + "data":"[{\"id\": \"1658407837\",\"name\": \"BDCoin\",\"port\": \"1617\"}]" +} +``` + + +#### 启动合约 + +##### 参数 + +| 字段 | 值 | +| --------- | ------------- | +| action | startContract | +| owner | pubkey | +| requestID | 当前时间 | +| script | 脚本内容 | +| signature | 签名 | + +##### 请求示例 + +``` +request.action = "startContract"; +request.owner = global.sm2Key.publicKey; +request.requestID = new Date().getTime() + ""; +request.script = global.projectScript; +request.signature = sm2.doSignature("Algorithm|" + request.script + "|" + global.sm2Key.publicKey, global.sm2Key.privateKey); +wssocket.send(JSON.stringify(request)); +``` + +##### 返回结果 + +```json +{ + "data":"{\"needSeq\":false,\"seq\":0,\"status\":\"Success\",\"result\":\"\",\"isInsnLimit\":false,\"totalGas\":0,\"executionGas\":0,\"extraGas\":0,\"size\":0,\"eventRelated\":false}", + "action":"onStartContract", + "cid":"-506393888", + "executeTime":2496, + "responseID":"1617206735696" +} +``` + +#### 分发合约项目 + +##### 参数 + +| 字段 | 值 | +| ------------- | ------------------ | +| action | distributeContract | +| peersID | 集群中节点peer | +| projectName | 合约名 | +| isPrivate | 是否在私有目录 | +| sponsorPeerID | 发起者ID | +| signature | 签名 | + +##### 请求示例 + +```javascript +request.action = "distributeContract"; +request.peersID = peersID; +request.projectName = global.projects[global.lastClickedProjectId]; +request.isPrivate = $("#privateDir-tab").hasClass("active"); +request.sponsorPeerID = global.peerID; +request.signature = sm2.doSignature("DistributeContract|" + request.projectName + "|" + global.sm2Key.publicKey, global.sm2Key.privateKey); +wssocket.send(JSON.stringify(request)); +``` + +##### 返回结果 + +```json +{ + "action":"onDistributeContract", + "progress":"100.00%" +} +``` + +#### 终止合约 + +##### 参数 + +| 字段 | 值 | +| --------- | ------------------- | +| action | killContractProcess | +| id | 合约id | +| requestID | 请求ID | + +##### 请求示例 + +``` +request.action = "killContractProcess"; +request.id = contractid; +request.requestID = new Date().getTime() + ""; +wssocket.send(JSON.stringify(request)); +``` + +##### 返回结果 + +```json +{ + "data": "ContractHandler: exit in 3 seconds!", + "action": "onOutputStream" +} +``` + +#### 终止所有合约 + +##### 参数 + +| 字段 | 值 | +| ------ | --------------- | +| action | killAllContract | + +##### 请求示例 + +``` +request.action = "killAllContract"; +wssocket.send(JSON.stringify(request)); +``` + +##### 返回结果 + +```json +{ + "status":false, + "action":"onKillAllContract", + "data":"Kill:7241,7245," +} +``` + + + +#### 静态分析合约 + +##### 参数 + +| 字段 | 值 | +| ---------- | -------------------- | +| action | staticVerifyContract | +| owner | 用户私钥 | +| isPartial | 是否是部分 | +| contractid | contractid | +| script | 脚本内容 | +| path | 合约文件名 | + + +##### 请求示例 + +```javascript +request.action = "staticVerifyContract"; +request.owner = global.sm2Key.privateKey +request.isPartial = false; +request.contractid = contractid; +request.script = global.projectScript; +request.path = global.projectName; +wssocket.send(JSON.stringify(request)); +``` + +##### 返回结果 + +```json + +{ + "data":"{\"needSeq\":false,\"seq\":0,\"status\":\"Success\",\"result\":{\"hello\":\"Ret:\"},\"isInsnLimit\":false,\"totalGas\":0,\"executionGas\":0,\"extraGas\":0,\"size\":0,\"eventRelated\":false}", + "action":"onStaticVerifyResult", + "cid":"verify", + "executeTime":83 +} +``` + + + +#### 删除合约 + +##### 参数 + +| 字段 | 值 | +| ------ | ---------- | +| action | deleteFile | +| file | fileName | + +##### 请求示例 + +```javascript +request.action = "deleteFile"; +request.file = fileName; +wssocket.send(JSON.stringify(request)); +``` + +##### 返回结果 + +```json +{ + "action":"onDeleteFile", + "data":"success", + "executeTime":0 +} +``` + + + +#### 私有合约传至公共目录 + +##### 参数 + +| 字段 | 值 | +| -------- | ------------ | +| action | changePublic | +| pubkey | 用户公钥 | +| fileName | fileName | + +##### 请求示例 + +```javascript +request.action = "changePublic"; +request.pubkey = pubkey; +request.fileName = fileName; +wssocket.send(JSON.stringify(request)); +``` + +##### 返回结果 + +```json +{ + "action":"onChangePublic", + "data":"success", + "executeTime":0 +} +``` + + + +#### 上传合约 + +##### 参数 + +| 字段 | 值 | +| -------- | ----------- | +| action | UploadFile | +| isAppend | false | +|fileName|fileName| +| path | path | +|isPrivate|true/false| +| content | fileContent(base64编码） | + +##### 请求示例 + +``` +request.action = "uploadFile"; +request.isAppend = false; +request.fileName = "test1.yjs"; +request.path = "test1"; +text="Y29udHJhY3QgdGVzdDF7CglleHBvcnQgZnVuY3Rpb24gaGVsbG8oYXJnKXsgCiAgICAgICAgcmV0dXJuICJ3b3JsZCI7ICAKICAgIH0gICAKfQ==" +request.content = text; +wssocket.send(JSON.stringify(request)); +``` + +##### 返回结果 + +```json +{ + "action":"onUploadFile", + "data":"success", + "executeTime":0 +} +``` + +#### 编译合约 + +##### 参数 + +| 字段 | 值 | +| ---------- | -------------------------- | +| action | compile | +| path | string, 待编译的项目名称 | +| privateTab | bool, 是否为私有目录的项目 | + +##### 请求示例 + +```javascript +var req = {"action":"compile","path":"Hello","privateTab":true} +``` + +##### 返回结果 + +```json +{"result":"Hello_2020-08-17-09:09:40.ypk","action":"onCompile"} +``` + +#### 锁定私有目录 + +锁定某个用户的的私有目录编辑功能 + +##### 参数 + +| 字段 | 值 | +| ------ | ---------------------- | +| action | lockEdit | +| pubKey | string, 要被锁定的公钥 | + +##### 请求示例 + +```javascript +var req = {}; +req.action = "lockEdit"; +req.pubKey = "xxxxxx"; +wssocket.send(JSON.stringify(req)); +``` +```json +{ + "action":"onLockEdit", + "status":"success", + "data":"04c4c855862b53f323e077ccfcc744ecc2c0a04645ed16d99ede8fd5866b38c0670a97ad22c6260d1a4672aba2a5fe229a2d4eba34627c054aab102620afa288c1" +} +``` + + +#### 解锁私有目录 + +解锁某个用户的的私有目录编辑功能 + +##### 参数 + +| 字段 | 值 | +| ------ | ---------------------- | +| action | unLockEdit | +| pubKey | string, 要被锁定的公钥 | + +##### 请求示例 + +```javascript +var req = {}; +req.action = unlockEdit; +req.pubKey = "xxxxxx"; +wssocket.send(JSON.stringify(req)); +``` +```json +{ + "action":"onUnlockEdit", + "status":"success", + "data":"04c4c855862b53f323e077ccfcc744ecc2c0a04645ed16d99ede8fd5866b38c0670a97ad22c6260d1a4672aba2a5fe229a2d4eba34627c054aab102620afa288c1" +} +``` + + +### 合约实例管理类 + +#### 查询合约进程 + +向服务器发送请求, 查询服务器上已经启动的所有合约进程. + +##### 参数 + +| 字段 | 值 | +| ------ | ------------------- | +| action | listContractProcess | + +##### 请求示例 + +```javascript +var request = {}; +request.action = "listContractProcess"; +wssocket.send(JSON.stringify(request)); +``` + +##### 返回结果示例 + +```json +{ + "status": false, + "action": "onListContractProcess", + "data": "[...]" +} +``` + + + +#### 调用合约 + +向服务器发送请求, 调用某个合约. + +##### 参数 + +| 字段 | 值 | +| -------------------- | --------------------------- | +| action | executeContract | +| contractID | 合约ID | +| withDynamicAnalysis | true/false 是否进行动态分析,可选 | +| operation | 调用合约的方法名 | +| arg | 调用合约的参数 | +| pubkey | 调用者公钥,可选 | +| signature | 调用者签名 ,可选 | + +`*`表示可选参数 + +```javascript +//sm2 可从sm2.js中加载获得。 +signature = sm2.doSignature(contractID+"|"+operation+"|"+arg+"|"+pubkey,privateKey); +``` + +##### 请求示例 + +```javascript +var request = {}; +request.action = "executeContract"; +request.contractID = "2073401446"; +request.operation = "main"; +request.arg = "hhhhh"; +wssocket.send(JSON.stringify(request)); +``` + +##### 返回结果示例 + +```json +{ + "needSeq":false, + "seq":0, + "status":"Success", + "result":"world", + "isInsnLimit":false, + "totalGas":0, + "executionGas":0, + "extraGas":0, + "size":0, + "eventRelated":false, + "responseID":"1617211077264_223", + "action":"onExecuteResult", + "executeTime":"5" +} +``` + +#### 输出历史记录日志(删除) + +向服务器发送请求, 获取节点服务器上合约的TimeTravel日志. + +##### 参数 + +| 字段 | 值 | +| ------ | ------------------ | +| action | printTimeTravelLog | + +##### 请求示例 + +```javascript +var request = {}; +request.action = "printTimeTravelLog"; +wssocket.send(JSON.stringify(request)); +``` + +##### 返回结果示例 + +```json +{ + "status": false, + "data": "[CMActions] dumpContract :…t/contractExamples/memoryDumps/LicenceManager\n" +} +``` + + + +#### 输出节点转移日志（删除） + +向服务器发送请求, 获取节点服务器的状态转移日志. + +##### 参数 + +| 字段 | 值 | +| ------ | ---------------- | +| action | printTransferLog | + +##### 请求示例 + +```javascript +var request = {}; +request.action = "printTransferLog"; +wssocket.send(JSON.stringify(request)); +``` + +##### 返回结果示例 + +```json + { + "status": false, + "data": "" +} +``` + + + +#### 合约状态迁移 + +向服务器发送请求, 获取节点服务器的状态转移日志. + +##### 参数 + +| 字段 | 值 | +| ------------ | ------------ | +| action | loadMemory | +| contractName | 合约名称 | +| memoryFile | 合约文件名称 | + +##### 请求示例 + +```javascript +var request = {}; +request.action = "loadMemory"; +request.contractName = "JsonContract"; +request.memoryFile = "2020-03-17.20/42/55"; +wssocket.send(JSON.stringify(request)); +``` + +##### 返回结果示例 + +```json +{ + "data":"success", + "size":"0.00 B", + "action":"onTransferTo", + "time":"0.01s" +} +``` + + + +### 日志查看类 + +#### 查看本地近n日节点日志（删除） + +##### 参数 + +| 字段 | 值 | +| ------ | ---------------- | +| action | listLocalNodeLog | +| date | 当前时间 | + +##### 请求示例 + +``` +request.action = "listLocalNodeLog"; +request.date = new Date().getTime() - 24 * 3600 * 1000 * n; +wssocket.send(JSON.stringify(request)); +``` + +##### 返回结果 + +```json +{ + "data":"[{\"action\":\"login\",\"pubKey\":\"null\",\"status\":\"accept\",\"date\":1583139323822}\",]" +} +``` + + + +#### 查看本地近n日合约日志（删除） + +##### 参数 + +| 字段 | 值 | +| ------ | -------------------- | +| action | listLocalContractLog | +| date | 当前时间 | + +##### 请求示例 + +``` +request.action = "listLocalContractLog"; +request.date = new Date().getTime() - 24 * 3600 * 1000 * n; +wssocket.send(JSON.stringify(request)); +``` + +##### 返回结果 + +```json +{ + "data":"[\"{\"action\":\"startContract\",\"pubKey\":\"04405d7ba358d9234939623ab51ea94ca685e6a1f36ed81fd9630ccba6473e632f163bb30faffd4c91f21e5bace20101d6d6e36c04ac67eea14cc24b4962b84f57\",\"contractID\":\"845581788\",\"contractName\":\"null\",\"date\":1583141525539}\"]" +} +``` + + + + +### 节点配置类 + +#### 获取节点配置信息 + +##### 参数 + +| 字段 | 值 | +| ------ | -------------- | +| action | loadNodeConfig | + +##### 请求示例 + +``` +var param = {}; +param.action = "loadNodeConfig"; +wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果 + +``` +{ + "status": true, + "action": "onLoadNodeConfig", + "data": { + "nodeName": "04BF52213343C147E631B877BCEB17B794230EE551E85F58FA429C4BA03D690778CC384C6916C63DF36CB9E35C7E274FDB4E18491DFE3D611D347856D441CACC5AF9090B515F02AFC2DFBF56461EC83B5A4CD342466360D6CF82E6E40B637430AC4A329CCBC798DAF7D526AF9E3B3600E0BEA1BFAB8C160EF90128FAF67B19E45F37664F1E4B", + "licence": "04AADCC7103CD02626D228AFFBEF53F8242ECA4DDD6F179D30B622440666715CFBB6FD1D3678A2B25812DEA9917073E79A65F7ADE517F784DC76288EFCEB37ECAA1025E6903540702F729DA1C2ECCD93F4E6FAFCE40DF443E7FD74387169D0C6D927C7BB12882D0471C8D3E6F31B0316A42FC38F6DD9978D4351B23B2AD63E2244909E98F51185D32CB99B4AE4E22D3AB4C04027BB", + "expireTime": "Wed Aug 26 09:43:08 CST 2020", + "nodes": "[\"node1\",\"node2\",\"node3\"]", + "yjsPath": "/Users/xxx/docs/BDWareHttp/generatedlib/yjs.jar", + "nodeCenter": "ws://127.0.0.1:1719/SCIDE/NodeCenter" + } +} + +{ + "status":true, + "action":"onLoadNodeConfig", + "data":{ + "nodeName":"Node_180", + "peerID":"", + "masterAddress":"39.104.201.40:21031", + "licence":"04AADCC7103C", + "doipConfig":"{\\"LHSProxyAddress\\":\\"http://39.104.201.40:21042/\\",\\"ownerHandle\\":\\"86.5000.470/dou.TEST\\",\\"certPath\\":\\"keys/dou.TEST.keystore\\",\\"certPassword\\":\\"123456\\",\\"repoID\\":\\"86.5000.470/doip.vcg9Mu1gSq_bdw\\",\\"listeners\\":\\"[{\\\\\\"url\\\\\\":\\\\\\"tcp://39.104.201.40:21032\\\\\\",\\\\\\"protocolVersion\\\\\\":\\\\\\"2.1\\\\\\",\\\\\\"messageFormat\\\\\\":\\\\\\"packet\\\\\\"}]\\",\\"serviceDescription\\":\\"test local Contract Repository\\",\\"serviceName\\":\\"ContractEngine021\\"}", + "clusterConnected":"false", + "nodePubKey":"0492d974b8a5b473d0ed2c81800917f76e2a1ec3666067888c85fe6922a672223f2083f95402ae13a744df58deabbe7206c4a317dd14296b0d3941a26ca4e34dc5", + "ipPort":"", + "bdledger":"39.108.56.240:18091,39.108.56.12:1809139.104.70.160:18091 47.98.247.70:18091 47.98.248.208:18091 39.104.77.165:18091 47.98.249.131:18091", + "yjsPath":"/data/bdwaas/bdcontract/yjs.jar", + "nodeCenter":"ws://39.104.201.21040/SCIDE/NodeCenter" + } +} +``` + + +#### 修改节点配置 + +##### 参数 + +| 字段 | 值 | +| ------ | -------------- | +| action | updateConfig | +| key | 要改的配置项 | +| val | 要更改的目标值 | + +其中，key的可选项包括： + +| key的示 | val示例 | 说明 | +| ------------- | ----------------------------------- | ------------------------------- | +| yjsPath | /User/xxx/cp/yjs.jar | 合约进程启动所需的jar | +| dataChain | 192.168.1.8:18090,182.173.2.3:18091 | 账本节点的ip与端口 | +| nodeCenter | ws://127.0.0.1:18002 | CenterPortal所在的ip/端口 | +| nodeName | Node_180 | 字符串类型 | +| masterAddress | 192.168.3.2:18001 | 该NodePortal节点的ip和的TCP端口 | + +其中NodePortal的TCP端口为Node的http/ws端口号+1。 + + +#### 修改节点名称 + +##### 参数 + +| 字段 | 值 | +| ------ | -------------- | +| action | changeNodeName | +| data | 新的节点名称 | + +##### 请求示例 + +``` +var param = {}; +param.action = "changeNodeName"; +param.data = "NewNodeName"; +wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果 + +```json +{ + "status": true, + "action": "onChangeNodeName", + "data": true +} +``` + + + +#### 修改节点YJS路径 + +##### 参数 + +| 字段 | 值 | +| ------ | --------------------- | +| action | changeYJSPath | +| data | 节点服务器yjs.jar路径 | + +##### 请求示例 + +``` +var param = {}; +param.action = "changeYJSPath"; +param.data = "/Users/xxx/docs/BDWareHttp/generatedlib/yjs.jar"; +wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果 + +```json +{ + "status": true, + "action": "onChangeYJSPath", + "data": true +} +``` + + + +#### 修改NodeCenter + +##### 参数 + +| 字段 | 值 | +| ------ | ----------------------------------------- | +| action | changeNodeCenter | +| data | 节点服务器要连接的NodeCenterWebSocket路径 | + +##### 请求示例 + +``` +var param = {}; +param.action = "changeNodeCenter"; +param.data = "ws://127.0.0.1:1719/SCIDE/NodeCenter"; +wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果 + +```json +{ + "status": true, + "action": "onChangeNodeCenter", + "data": true +} +``` + + + +#### 修改账本节点 + +##### 参数 + +| 字段 | 值 | +| ------ | --------------------------- | +| action | changeBDledger | +| data | 数链节点的IP:port,用","隔开 | + +##### 请求示例 + +``` +var param = {}; +param.action = "changeBDledger"; +param.data = "39.108.56.240:18091,39.108.56.12:18091"; +wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果 + +```json +{ + "status": true, + "action": "onChangeBDledger", + "data": true +} +``` + + + +#### 上传节点Licence + +##### 参数 + +| 字段 | 值 | +| ------ | ----------------------- | +| action | uploadLicence | +| data | 节点服务器的Licence内容 | + +##### 请求示例 + +``` +var param = {}; +param.action = "uploadLicence"; +param.data = "04AADCC7103C"; +wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果 + +```json +{ + "status": true, + "action": "onUploadLicence", + "data": true +} +``` + + + +#### 获取节点ID + +##### 参数 + +| 字段 | 值 | +| ------ | --------- | +| action | getNodeID | + +##### 请求示例 + +``` +var param = {}; +param.action = "getNodeID"; +wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果 + +```json +{ + "status": true, + "action": "onGetNodeID", + "data": "0431…d3a92e1184bbc5817ebda5c2ad498e4ff1d240009b4f06d" +} +``` + + + +#### 获取节点所在的可信执行集群 + +##### 参数 + +| 字段 | 值 | +| ---------- | ------------------------------------------------ | +| action | getNodeTrustUnits | +| data | 节点ID | +| msgHandler | 收到回复的回调函数, 可使用"建立连接"的msgHandler | +| ws | 节点所属的NodeCenter的WebSocket地址 | + +##### 请求示例 + +``` +centerportalws = createWssocket("ws://127.0.0.1:1718/NodeCenterWS",function() { +var param = {}; +param.action = "getNodeTrustUnits"; +param.data = "0431e311bd70840fe69965e2cabea97fafe99f2133953c01abb9bd7cb62af42f8283f474d203051e920d3a92e1184bbc5817ebda5c2ad498e4ff1d240009b4f06d"; +centerportalws.send(JSON.stringify(param)); +}, msgHandler); +``` + +##### 返回结果 + +```json +{ + "data": [{ + "key": "0475c7b061...65e55_4063665700873624164", + "value": "[\"04541429c11b094…40009b4f06d\"]" + }], + "action": "onGetNodeTrustUnits" +} +``` + +### 模板生成类 + +#### 获取合约模板列表 + +##### 参数 + +| 字段 | 值 | +| ------ | --------------- | +| action | getTemplateList | + +##### 请求示例 + +``` javascript +req={}; +req.action = "getTemplateList"; +wssocket.send(JSON.stringify(req)); +``` + +##### 返回结果 + +``` json +{ + "data": [ + { + "formDesc": { + "dbPWD": { + "label": "密码", + "type": "input" + }, + "contractName": { + "label": "合约名称", + "type": "input" + }, + "accessPolicy": { + "label": "访问控制策略", + "type": "input", + "option": [ + { + "text": "无访问控制", + "value": "NAC" + }, + { + "text": "直接访问控制", + "value": "DAC" + }, + { + "text": "基于角色的访问控制", + "value": "RBAC" + } + ] + }, + "dbUserName": { + "label": "用户名", + "type": "input" + }, + "fieldList": { + "label": "字段名", + "type": "tag" + }, + "dbUrl": { + "label": "数据库链接", + "type": "input" + }, + "tableName": { + "label": "表名", + "type": "input" + } + }, + "apiName": "generateMySQLProject" + }, + { + "formDesc": { + "contractName": { + "label": "合约名称", + "type": "input" + }, + "accessPolicy": { + "label": "访问控制策略", + "type": "input", + "option": [ + { + "text": "无访问控制", + "value": "NAC" + }, + { + "text": "直接访问控制", + "value": "DAC" + }, + { + "text": "基于角色的访问控制", + "value": "RBAC" + } + ] + } + }, + "apiName": "generateEmptyProject" + } + ], + "action": "onTemplateList" +} +``` + +#### 空白合约模板 + +##### 参数 + +| 字段 | 值 | +| ------------ | ----------------------------- | +| action | generateEmptyProject | +| contractName | 字符串类型，合约名称 | +| isPrivate | 布尔类型，是否为私有项目 | +| accessPolicy | 若为"DAC"，则实现直接访问控制 | + +##### 请求示例 + +```javascript +var req = {}; +req.contractName = "Empty22"; +req.action = "generateEmptyProject"; +req.accessPolicy = "DAC"; +//wssocket为建立好的连接 +wssocket.send(JSON.stringify(req)); +``` + +##### 返回结果 +```json +{ + "action":"onListProjects", + "data":"[\"AnnotationSample\",\"AppDataAnalysis\",\"AppDataSource\"]", + "executeTime":0, + "isPrivate":false +} +``` + +#### MySQL接入合约 + +##### 参数 + +| 字段 | 值 | +| ------------- | ------------------------------------------------------ | +| action | generateMySQLProject | +| contractName | 字符串类型，合约名称 | +| isPrivate | 布尔类型，是否为私有项目 | +| dbUrl | 字符串类型，数据库的URI | +| dbUserName | 字符串类型，数据库的用户名 | +| dbPWD | 字符串类型，数据库密码 | +| accessPolicy | 若为"DAC"，则实现直接访问控制，若为"NAC"则没有访问控制 | +| tableName | 字符串类型，数据库的表名 | +| fieldList | 字符串列表，数据库的字段列表 | +| defaultAccept | 布尔值，表示申请时是否默认有权 | + +##### 请求示例 + +```javascript +var req = {}; +req.contractName = "MySQLFromTemplate"; +req.action = "generateMySQLProject"; +req.pubKey = global.sm2Key.publicKey; +req.isPrivate = true; +req.tableName = "data"; +req.dbUrl = "jdbc:mysql://xxx:xxx/xxx"; +req.dbUserName = "loushuai"; +req.dbPWD = "loushuai"; +req.fieldList = [{"name":"名字","code":"*"}]; +req.basicInfo={"type":"所属分类","name":"资源名称"}; +req.accessPolicy = "DAC"; +req.defaultAccept = true; +//global.wssocket为建立好的连接 +global.wssocket.send(JSON.stringify(req)); +``` + +##### 返回结果 +```json +{ + "action":"onListProjects", + "data":"[\"CSVFromTemplate\",\"Empty22\",\"Hello\",\"MySQLFromTemplate\",\"test\"]", + "executeTime":0, + "isPrivate":true +} +``` +#### CSV接入合约 + +##### 参数 + +| 字段 | 值 | +| ----------------- | ------------------------------------------------------ | +| action | generateCSVProject | +| contractName | 字符串类型，合约名称 | +| base64EncodedData | 字符串类型，通过base64编码后的CSV文件内容 | +| isPrivate | 可选字段，布尔类型，是否为私有项目 | +| accessPolicy | 若为"DAC"，则实现直接访问控制，若为"NAC"则没有访问控制 | +| defaultAccept | 可选字段，布尔值，表示申请时是否默认有权 | + +##### 请求示例 + +```javascript +var req = {}; +req.contractName = "CSVFromTemplate"; +req.action = "generateCSVProject"; +req.pubKey = global.sm2Key.publicKey; +req.isPrivate = true; +req.tableName = "data"; +req.accessPolicy = "DAC"; +req.defaultAccept = true; +req.base64EncodedData = "bmFtZSwgc2NvcmUsCmphY2ssIDkwLApsdWN5LCA5MQo="; +//global.wssocket为建立好的连接 +global.wssocket.send(JSON.stringify(req)); +``` +##### 返回结果 +```json +{ + "action":"onListProjects", + "data":"[\"CSVFromTemplate\",\"Empty22\",\"Hello\",\"MySQLFromTemplate\",\"test\"]", + "executeTime":0, + "isPrivate":true +} +``` + +- - - + +## 路由节点WebSocket接口 + +### 用户管理类 + +#### 获取Session + +登录前获取session以便进行签名。 + +##### 参数 + +| 字段 | 值 | +| ------ | ------------ | +| action | getSessionID | + +##### 请求示例 + +``` +var req = {}; +req.action = "getSessionID"; +wssocket.send(JSON.stringify(req)); +``` + + +##### 返回结果 + +```json +{ + "action": "onSessionID", + "session": "9782323_session" +} +``` + + +#### 用户登录 + +用户进行公私钥身份验证，需先调用"getSessionID"获取sessionID以便于签名。 + +##### 参数 + +| 字段 | 值 | +| ------ | ----- | +| action | login | + +##### 请求示例 + +``` +var loginParam = {}; +loginParam.pubKey = global.sm2Key.publicKey; +loginParam.signature = sm2.doSignature(global.session, + global.sm2Key.privateKey); +loginParam.action = "login"; +wssocket.send(JSON.stringify(loginParam)); +``` + +##### 返回结果示例 + +```json +{ + "action": "onLogin", + "data": "CenterManager" +} +``` + + + +#### 用户获取当前角色(删除) + +用户根据登录时的公钥获取对应的角色，如果是第一次登录则此时的公钥默认称为准入管理员 + +##### 参数 + +| 字段 | 值 | +| ------ | ------- | +| action | getRole | + +##### 请求示例 + +``` +var param = {}; +param.action = "getRole"; +wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果示例 + +```json +{ + "action": "onGetRole", + "data": "CenterManager" +} +``` + +#### 申请角色 + +在准入管理员界面可以申请称为组网中某个节点的节点管理员 + +##### 参数 + +| 字段 | 值 | +| ------ | --------- | +| action | applyRole | +|role|申请的角色名称| + +##### 请求示例 + +``` +var param = {}; +param.action = "applyRole"; +param.role=" +wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果示例 + +```json +{ + "action": "onApplyRole", + "data": "failed" +} +``` + + +#### 添加节点 + +##### 参数 + +| 字段 | 值 | +| ---------- | ---------------- | +| action | addNode | +| nodePubKey | 要添加的节点公钥 | + +#### 请求示例 + +``` +var req = {}; +//某节点的publicKey可通过连接该节点，并通过"获取节点配置信息"接口获取 +req.nodePubKey = publicKey; +req.action = "addNode"; +wssocket.send(JSON.stringify(req)); +``` + + +#### 删除用户角色 + +##### 参数 + +| 字段 | 值 | +| ------ | -------------- | +| action | delete | +| pubKey | 对应用户的公钥 | + +##### 请求示例 + +``` +var deleteInfo = {}; +deleteInfo.pubKey = user.publicKey; +deleteInfo.action = "delete"; +wssocket.send(JSON.stringify(deleteInfo)); +``` + +##### 返回结果示例 + +```json +{ + "action": "onDelete", + "data": "success" +} +``` + +#### 查看授权用户列表 + +查看准入管理员当前组网中已经授权的节点管理员 + +##### 参数 + +| 字段 | 值 | +| ------ | ------------ | +| action | listAllUsers | + +##### 请求示例 + +``` +var param = {}; +param.action = "onListAllUsers"; +wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果示例 + +```json +{ + "action": "onListAllUsers", + "kv": { + "key": "049999ebd14ff3b96ebf7f7325e1da94a1c4c376573a1dc1cec2b4f7a3b09ed7b07252134e93b6ac2e1853268b82f4b541d34fb42b0182cd61043e99d3489e2cf7", + "value": " NodeManager" + }, + "time": { + "key": "049999ebd14ff3b96ebf7f7325e1da94a1c4c376573a1dc1cec2b4f7a3b09ed7b07252134e93b6ac2e1853268b82f4b541d34fb42b0182cd61043e99d3489e2cf7", + "value": 1587398989914 + } +} +``` + +#### 查看申请用户列表 + +##### 参数 + +| 字段 | 值 | +| ------ | ------------- | +| action | listApplyList | + +##### 请求示例 + +``` +var param = {}; +param.action = "onListApplyList"; +wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果 + +```json +{ + "action": "onListApplyList", + "kv": { + "key": "04b00f32eab70c78d1b43738f190d326d36c021af2124acefe6d057016b11ea31c750bb473e565c9d89e4993a44f4d30adf447d3026a21ff4b3b64cef523074ef7", + "value": " NodeManager" + }, + "time": { + "key": "04b00f32eab70c78d1b43738f190d326d36c021af2124acefe6d057016b11ea31c750bb473e565c9d89e4993a44f4d30adf447d3026a21ff4b3b64cef523074ef7", + "value": 1587398989914 + } +} +``` + +#### 查看用户类型分布 + +##### 参数 + +| 字段 | 值 | +| ------ | ------------- | +| action | queryUserStat | + +##### 请求示例 + +``` +var param = {}; +param.action = "onQueryUserStat"; +wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果示例 + +```json +{ + "action": "onQueryUserStat", + "userListCount": 3, + "applyListCount":0 +} +``` + +### 节点管理类 + +#### 查看节点列表 + +查看该用户有权限查看的节点列表(仅准入管理员及合约管理者可用) + +##### 参数 + +| 字段 | 值 | +| ------ | --------- | +| action | listNodes | + +##### 请求示例 + +``` +var param = {}; +param.action = "listNodes"; +wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果 + +```json +{ + "offline": [{ + "key": "0431e31...40009b4f06d", + "value": "0431e311bd708...b4f06d" + }], + "action": "onListNodes", + "online": [{ + "contracts": [], + "pubKey": "0431e311...09b4f06d", + "nodeName": "NewNodeName", + "udpID": "528822126", + "cimanager": "" + }] +} +``` + + +#### 查看可信执行集群列表 + +查看该用户有权限查看的节点列表(仅中心管理员及合约管理者可用) + +##### 参数 + +| 字段 | 值 | +| ------ | -------------- | +| action | listTrustUnits | + +##### 请求示例 + +``` +var param = {}; +param.action = "listTrustUnits"; +wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果 + +```json +{ + "data": [{ + "key": "0470b2f27f4f6…1cb855f1ecec11", + "value": "[...]" + }], + "action": "onListTrustUnits" +} +``` + + +#### 建立可信执行集群 + +##### 参数 + +| 字段 | 值 | +| ------ | ---------------------- | +| action | createTrustUnit | +| data | 节点公钥组成的Json数组 | +| Msg | 集群名称 | + +##### 请求示例 + +``` +var param = {}; +param.action = "createTrustUnit"; +param.data = "[\"382r0934309t...\",\"345343rr3f34...\"]"; +param.msg = "newUnit1"; +global.wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果 + +```json +{ + "action": "onCreateTrustUnit", + "status": "Success" +} +``` + + +#### 删除可信执行集群 + +##### 参数 + +| 字段 | 值 | +| ------ | --------------- | +| action | deleteTrustUnit | +| data | 可信执行集群ID | + +##### 请求示例 + +``` +var param = {}; +param.action = "deleteTrustUnit"; +param.data = "0475d34rf3434..._1583410158761"; +global.wssocket.send(JSON.stringify(param)); +``` + +##### 返回结果 + +```json +{ + "action": "onDeleteTrustUnit", + "status": "Success" +} +``` + + + +### 日志查看类 + +#### 查看组网管理操作的统计 + +##### 参数 + +| 字段 | 值 | +| ------ | -------------- | +| action | queryActionLog | +| date | 当前时间 | + +##### 请求示例 + +``` +request.action = "onQueryActionLog"; +request.date = new Date().getTime() - 24 * 3600 * 1000 * n; +wssocket.send(JSON.stringify(request)); +``` + +##### 返回结果 + +```json +{ "action":"onQueryActionLog", + "data":"[{\"action\":\"login\",\"pubKey\":\"null\",\"status\":\"accept\",\"date\":1583139323822}\",]" +} +``` + + + +#### 查看本地近n日合约日志 + +##### 参数 + +| 字段 | 值 | +| ------ | -------------------- | +| action | listLocalContractLog | +| date | 当前时间 | + +##### 请求示例 + +``` +request.action = "listLocalContractLog"; +request.date = new Date().getTime() - 24 * 3600 * 1000 * n; +wssocket.send(JSON.stringify(request)); +``` + +##### 返回结果 + +```json +{ + "data":"[\"{\"action\":\"startContract\",\"pubKey\":\"04405d7b...\",\"contractID\":\"845581788\",\"contractName\":\"null\",\"date\":1583141525539}\"]" +} +``` + + +- - - + +## Bash接口 + +已废弃。可使用BDWareConfigTool代替。 +通过命令行发送Socket指令, 执行调用`ContractController`类中方法, 完成以下功能. (需要在本机的`1615`端口运行`ContractManager`实例) + +![Bash接口功能示意图](./_static/imgs/bash-api.png) + +### 指令 + +```bash +java -jar yjs.jar function_name arguments + +``` + +`function_name`为调用的方法名; + +`arguments`为方法参数. + +### 启动合约 + +#### 参数 + +`function_name`为`startContract`; + +`arguments`为启动合约需要的参数, 包括合约类型`type`, 合约ID`id`, 合约脚本`script`. + +#### 指令示例 + +```bash +java -jar yjs.jar startContract "{\"type\":\"Algorigthm\",\"id\":\"656565\",\"script\":\"contract c{function main(arg){return arg/1.0+1;}}\"}" +``` + +### 调用合约 + +#### 参数 + +`function_name`为`executeContract`; + +`arguments`为调用合约需要的参数, 包括调用参数`arg`, 合约ID`contractID`. + +#### 指令示例 + +```bash +java -jar yjs.jar executeContract "{\"arg\":\"http://www.baidu.com\",\"contractID\":\"656564\"}" +``` + +### 停止合约 + +#### 参数 + +`function_name`为`stopContract`; + +`arguments`为调用合约需要的参数, 即合约ID`contractID`. + +#### 指令示例 + +```bash +java -jar yjs.jar stopContract "{\"arg\":\"http://www.baidu.com\",\"contractID\":\"656564\"}" +``` + +### 停止全部合约 + +#### 参数 + +`function_name`为`stopAllContracts`. + +#### 指令示例 + +```bash +java -jar yjs.jar stopAllContracts +``` + +### 查询全部合约 + +#### 参数 + +`function_name`为`listContracts`. + +#### 指令示例 + +```bash +java -jar yjs.jar listContracts +``` + \ No newline at end of file diff --git a/source/markdown_ZRYH/IDEUsage.md b/source/markdown_ZRYH/IDEUsage.md new file mode 100644 index 0000000..08568fe --- /dev/null +++ b/source/markdown_ZRYH/IDEUsage.md @@ -0,0 +1,439 @@ +# BDContract管理界面 + +- - - + +## 合约节点管理界面 + +该界面的使用地址为：[NodePortal.html](/NodePortal.html) + + +### 用户管理菜单 +用户管理为登录用户提供查看当前用户分布情况和用户活跃情况统计等。 + +#### 概览 +![nodeUserManager](./_static/imgs/nodeUserManager.jpg) +节点用户管理页面一共有四个模块：用户情况、用户活跃统计、授权用户管理、未授权用户管理。 + +#### 用户类型分布 +主要统计当前节点管理员所拥有的四种角色的数量：合约提供者、合约管理员、合约使用者 +![userList](./_static/imgs/userList.jpg) + +#### 用户活跃统计 +![userActive](./_static/imgs/userActive.jpg) +统计30天之内**登录**、**授权**、**申请**的次数 + +#### 当前用户信息 +![nodeInfo](./_static/imgs/nodeInfo.jpg) + * 在这个文本框中可以查看当前用户的公私钥，如果其他用户想要用自己的公私钥登录节点管理员界面，可以将自己的公私钥复制到这个文本框中。 + * 将自己的公私钥复制完成之后要点击**导入公钥**，将公钥加入到节点管理员本地 + * 然后在**本地公钥**中可以看见公钥的前五位，选择自己的公钥，将在**我的权限**中展示出当前选择的公钥的角色，如果是还没有在中心管理员认证的节点则默认为**Anonymous** + * 如果不是节点管理员，想要加入某个中心管理员的网络，那么要在中心管理员所在的用户管理中用自己的公私钥导入后进行认证。 + * 如果想要行使更多关于合约的操作，则需要认证不同的角色：合约管理员、合约使用者、合约提供者，然后进行**角色认证** + +#### 授权与非授权用户列表 +![roleAuth](./_static/imgs/roleAuth.jpg) + 在节点管理员认证角色之后，节点管理员登录会在**未授权角色管理**表格中看见带有公钥的申请信息，如果同意，则点击**授权**，如果不同意点击**忽略**就可以。 + 授权之后将在**授权角色管理**表格中看见授权后的节点列表。如果节点管理员想要移除某个节点的角色，则在授权角色管理列表中**删除**即可。 + +### 合约代码管理菜单 + +![codeManageMenu](./_static/imgs/codeManageMenu.png) + + + +#### 合约文件 + +![codeManage1](./_static/imgs/codeManage1.png) + +在合约代码管理菜单中，用户可以看到公共合约以及个人私有合约。 +![codeManage1-1](./_static/imgs/codeManage1-1.png) + +对于公共合约，节点管理员可以对其中文件进行删除和上传操作，可以对合约项目进行下载和删除操作。 +![codeManage1-2](./_static/imgs/codeManage1-2.png) + +对于私有合约，合约提供者可以对其中文件进行删除和上传操作，可以对合约项目进行下载、删除和传至公共合约目录操作。 + +以下是对合约文件进行操作的示例。 + +#### 上传文件 +![codeManage6](./_static/imgs/codeManage6.png) + +#### 删除 +![codeManage5](./_static/imgs/codeManage5.png) + +#### 传至公共 +![codeManage7](./_static/imgs/codeManage7.png) + +#### 下拉框 + +![codeManage2](./_static/imgs/codeManage2.png) + +四个下拉框中，可以分别对合约状态保存模式、已启动合约实例、节点所在集群以及结果校验方式进行选择。 + + + +#### 按钮操作 + +![codeManage3](./_static/imgs/codeManage3.png) + +#### 启动 + +在文件列表中选择合约文件之后，在合约运行模式中选择“单节点执行”，点击启动按钮，会启动指定文件，并在结果显示框中显示返回结果。 + + + +#### 启动P2P集群合约 + +在文件列表中选择合约文件之后，在合约运行模式中选择该可信合约运行的合约集群，点击启动按钮，会在该集群的所有节点上启动指定文件，并在结果显示框中显示返回结果。 + + + +#### 启动全部 + +在合约运行模式中选择“单节点执行”，点击启动全部按钮，会启动合约文件列表中所有合约。 + + + +#### 停止P2P集群合约 + +在已启动合约实例的下拉框中选择一个合约实例，在合约运行模式中选择该可信合约运行的合约集群，点击停止按钮，会在该集群的所有节点上终止这个合约进程。 + + + +#### 停止 + +在已启动合约实例的下拉框中选择一个合约实例，点击停止按钮，会终止这个合约进程。 + + + +#### 停止全部 + +点击停止全部按钮，会停止该节点上运行的所有合约实例。 + + + +#### 静态分析 + +在合约文件列表中选择合约文件，并在合约实例下拉框中选择合约实例，点击静态分析按钮，会对该合约进行静态分析，并在结果显示框中显示返回结果。 + + + +#### 分发合约 + +在合约文件列表中选择合约项目，并在合约运行模式中选择一个集群，点击分发合约按钮，会将该合约项目打包为ypk分发给这个集群中的所有节点。 + + + + +#### 返回结果 + +![codeManage4](./_static/imgs/codeManage4.png) + +返回结果显示中显示一些操作的返回结果。 + + + +#### 合约权限配置 + +在启动合约之后，如果当前用户的角色可以查看已经启动合约进程，那么在选定查看合约进程时将会在右下方展示当前合约的IO权限。 +![permissionShow](./_static/imgs/permissionShow.png) + +如果选中的合约没有IO权限，则在当前权限的展示框中提示**当前合约没有IO权限** +![nullPermission](./_static/imgs/nullPermission.png) + +当前用户是合约管理员时可以对已有的合约IO权限进行修改。系统会提示修改后合约将有可能不会正常运行，如果还是确定要取消，那么点击**确定** 即可，反之点击**关闭** +![updatePermission](./_static/imgs/updatePermission.png) + +点击关闭或者打开之后，下一次查看同一个合约代码的进程将会默认显示最近一次修改之后的IO权限。 +![closePermission](./_static/imgs/closePermission.png) + +### 合约实例管理菜单 + +![nodeInstancesPage](./_static/imgs/nodeInstancesPage.png) + +合约实例管理菜单显示了该节点当前的所有合约实例, 用户可查看合约实例的状态, 并对合约实例进行执行或状态迁移的操作. + +#### 合约实例列表 + +![nodeInstancesList](./_static/imgs/nodeInstancesList.png) + +该列表显示了当前节点的所有合约实例信息, 包括合约ID, 合约名称, 合约类型合约状态, 合约进程端口, 合约调用次数, 合约流量, 及合约占用内存, 集群合约的结果校验模式. + +#### 合约实例执行 + +![chooseInstance](./_static/imgs/chooseInstance.png) + +用户可在合约实例的选择下拉框中选择合约实例, 对该合约实例进行操作. + +![intanceExecute](./_static/imgs/intanceExecute.png) + +选择合约实例后, 用户可在"方法"的下拉框中选择该合约的方法名, 在"参数"输入框中输入方法的参数, 点击"执行". + +用户还可点击"动态分析执行"进行带有动态分析结果的执行. + +若该合约为单点合约, 则合约在单点执行; 若该合约为集群合约, 则该合约在该集群的所有节点上执行. + +#### 合约实例执行结果 + +![executeResult](./_static/imgs/executeResult.png) + +合约实例的执行完成后的结果显示在"执行结果"区域中, 包括该次执行的ID, 执行成功/失败, 执行时间, 及执行结果. + +![analysisExecuteResult](./_static/imgs/analysisExecuteResult.png) + +若该合约的执行方式为"动态分析执行", 则结果框内除执行结果, 还会显示该次执行的动态分析结果. + +#### 合约状态迁移 + +![memoryDump](./_static/imgs/memoryDump.png) + +对于支持用户手动迁移的合约实例, 用户可点击"本地状态保存"对合约实例的状态进行保存, 或从合约的TimeTravel列表中选择已保存的合约实例, 将合约状态迁移到对应时刻. + + + +### 日志管理菜单 +![logMenu](./_static/imgs/logMenu.png) + +该菜单是对该节点本地节点日志以及合约日志的统计结果展示。 + +其中，节点管理员可以查看节点日志的相关数据；合约管理者及合约使用者可以查看该节点本地合约日志的相关数据。 + + + +#### 日志统计图 + +![log1](./_static/imgs/log1.png) + +#### 各类平台操作百分比 + +该图默认显示近2日各类平台操作占比的饼图，其中平台操作分为登陆类、用户类、日志类、合约类、维护类以及其他类这六类。可在节点日志详情的右上角的时间范围框中填写想要查看的日志时间范围，修改之后，各类平台操作百分比会同步更新。 + + + +#### 各类合约操作百分比 + +合约操作分为启动、终止、静态分析和执行这四类，该图为近2日对各类合约操作占比的饼图。可在合约日志详情的右上角的时间范围框中填写想要查看的日志时间范围，修改之后，各类合约操作百分比会同步更新。 + + + + +#### 每日平台使用统计 + +该图为近2日平台操作次数统计的折线图。可在节点日志详情的右上角的时间范围框中填写想要查看的日志时间范围，修改之后，每日平台使用统计折线图会同步更新。 + + + + +#### 每日合约使用统计 + +该图为近2日对该节点上合约的操作次数统计的折线图。可在合约日志详情的右上角的时间范围框中填写想要查看的日志时间范围，修改之后，每日合约使用统计折线图会同步更新。 + + + + +#### 日志详情 + + + +#### 节点日志详情 +![log2](./_static/imgs/log2.png) + +节点日志详情表是对节点日志中所有数据的展示。可以点击表格中相关按钮按使得日志数据按不同方式进行排序，并且可以在表格右上角输入关键词进行相关日志搜索。可在右上角的时间范围框中填写想要查看的日志时间范围，修改之后，各类平台操作百分比和每日平台使用统计会同步更新。 + + + +#### 合约日志详情 +![log3](./_static/imgs/log3.png) + +合约日志详情表是对合约日志中所有数据的展示。可以点击表格中相关按钮按使得日志数据按不同方式进行排序，并且可以在表格右上角输入关键词进行相关日志搜索。可在右上角的时间范围框中填写想要查看的日志时间范围，修改之后，各类合约操作百分比和每日合约使用统计会同步更新。 + + + +### 节点管理菜单 + +![nodeConfig](./_static/imgs/nodeConfig.png) + +节点管理菜单显示了该节点的配置信息及所属可信执行集群信息. + +#### 节点配置 + +![nodeConfigChange](./_static/imgs/nodeConfigChange.png) + +节点管理员可查看该节点的配置信息, 包括节点名称, 节点YJS路径, 节点的网络中心节点, 节点管理员还可对以上配置进行修改. + +若节点管理员修改了节点的网络中心, 该节点后重新想改节点连接, 整个页面刷新重载. + +#### 节点可信执行集群列表 + +![nodeUnits](./_static/imgs/nodeUnits.png) + +节点管理员可查看节点所属的可信执行集群信息, 包括集群创建者, 集群ID, 集群中节点数目, 集群中节点的信息. + +- - - + +#### 节点Licence配置 + +![nodeLicence](./_static/imgs/nodeLicence.png) + +用户可以查看该节点的Licence及过期时间, 还可申请Licence, 上传Licence, 保存节点UUID. + +## 智能合约在线编辑器 + +### 用户与账号 + +#### 创建账号 + +#### 申请授权 + + +### 创建项目 + +#### 新建文件 + +#### 上传文件 + +### 启动合约 +![contractMode](./_static/imgs/contractMode.png) + +####正常模式 +点击左侧启动按钮，以正常模式启动合约。 + +####debug模式 +点击右侧debug按钮，以debug模式启动合约。目前约定debug模式合约通过executeContract调用正常模式合约时，返回正常模式合约文档中的返回结果示例。 + +### 调用合约 + +###生成文档 +![genReadme](./_static/imgs/genReadme.png) + +启动合约后点击"生成文档"按钮，可以通过各export函数的@Description / @Param / @Result 对合约进行调用及结果返回，从而生成合约的说明文档。 + +- - - + +## 路由准入管理界面 + +### 权限申请与授权 + +### 仪表盘 +仪表盘为提供对准入节点中用户数量，合约数量，节点数量的概览。 + +### 整体视图 +![dashboard](./_static/imgs/dashboard.jpg) +一共分为四个模块，一个模块是用户、合约、节点数量的概览，然后分别是这三个数量的详细分类的数据统计情况。 + +### 节点数目 +![node](./_static/imgs/node.jpg) +当前在线和离线节点统计 + +### 用户类型分布 +![userAll](./_static/imgs/userAll.jpg) +当前准入节点所在组网中的节点管理员、准入管理员的数量和申请中节点的数量 + +### 合约调用情况 +![contract](./_static/imgs/contract.jpg) +当前准入节点所在组网中所有合约中事件、多点执行、ws调用、Http调用的折线统计图。 + +### 用户管理 +用户管理为登录用户提供查看当前用户分布情况和用户活跃情况统计等。 + +### 概览 +![centerManager](./_static/imgs/centerManager.jpg) +用户管理页面一共有四个模块。 + + +### 用户类型分布 +主要统计当前中心管理员所管理的网络中有多少节点管理员，多少个中心管理以及申请节点管理员的数量 +![userList](./_static/imgs/userList.jpg) + +### 30天内的申请情况统计 +![userApplyGraph](./_static/imgs/userApplyGraph.jpg) +统计30天之内申请节点管理员的数量和授权成为节点管理员的数量 + +### 当前用户信息 +![authNodeManager](./_static/imgs/authNodeManager.jpg) + * 在这个文本框中可以查看当前用户的公私钥，如果其他用户想要用自己的公私钥登录中心管理员界面，可以将自己的公私钥复制到这个文本框中。 + * 将自己的公私钥复制完成之后要点击**导入公钥**，将公钥加入到中心管理员本地 + * 然后在**本地公钥**中可以看见公钥的前五位，选择自己的公钥，将在**我的权限**中展示出当前选择的公钥的角色，如果是中心管理员则拥有中心管理员的一切权限。 + * 如果不是中心管理员或者节点管理员，想要加入当前中心管理员的网络，那么可以在下面的选择框中选中节点管理员，进行**角色认证**。 + +### 授权与非授权用户列表 + 在中心管理员当前用户信息申请之后，中心管理员登录会在**未授权用户管理**表格中看见带有公钥的申请信息，如果同意，则点击**授权**，如果不同意点击**忽略**就可以，此时这个申请就无效。 +![authMan](./_static/imgs/authMan.jpg) + 授权之后将在**授权用户管理**表格中看见授权后的节点列表。如果中心管理员想要移除某个节点管理员的某项角色，则在授权用户管理列表中选择相应的角色，然后点击**删除**即可删除选中的角色。 +![authMana](./_static/imgs/authMana.jpg) + +### 节点管理 + +![centerNodePage](./_static/imgs/centerNodePage.png) + +节点管理为Manager对连接到自己的Cluster节点进行管理的页面, 仅Manager管理员及合约管理者可见. Manager管理员及合约管理者可在本页面查看节点信息, 并管理可信执行集群. + +### 概览 + +![centerNodePreview](./_static/imgs/centerNodePreview.png) + +概览中显示了该Manager节点所管理的所有节点的统计信息, 包括总节点数量, 总合约数量, 总订阅事件数量, 及可信执行集群数量, 右侧的饼图则为节点的分别处于Online/Offline的数量统计. + +### 节点列表 + +![centerNodeList](./_static/imgs/centerNodeList.png) + +节点列表显示了用户有权限查看的节点信息(Manager管理员可查看全部节点, 合约管理者可查看自己负责管理的Online节点). 包括节点的名称, 状态, 合约数目, 订阅事件数目, 用于节点间P2P通信的PeerID, 用于节点间UDP通信的UDPID, 及节点公钥. + +### 可信执行集群列表 + +![centerNodeUnits](./_static/imgs/centerNodeUnits.png) + +可信执行集群列表显示了用户有权限查看的可信执行集群信息(Manager管理员可查看全部集群, 合约管理者可查看自己创建的集群). 包括集群的创建者, 集群ID, 集群中节点数目, 以及集群中节点的信息. + +用户可点击列表表项的"删除"按钮, 将该集群删除. + +### 创建可信执行集群 + +![centerNodeUnitCreate](./_static/imgs/centerNodeUnitCreate.png) + +用户可以通过多选节点, 创建新的可信执行集群. 用户可以选择的节点为自己有权限查看的节点, 即Manager管理员从全部节点中选择, 合约管理者可从自己负责管理的Online节点中选择). 选择后点击提交, 即可看到创建成功的提示信息, 该集群将随即显示在可信执行集群列表中. 集群名称由创建者选取, 不能含有双引号, 该名称为合约管理者选择集群时的可见标识. + +### 日志管理 +日志管理主要展示准入节点的各项日志信息，一共分为六个模块。 +### 概览 +![log](./_static/imgs/log.jpg) + +### 管理操作分类统计（2日） +![operator](./_static/imgs/operator.jpg) +两日内所有管理类操作的统计饼图，管理类操作主要分为登录类、日志类、维护类、用户类。 + +### 管理操作每日统计（2日） +![everyLog](./_static/imgs/everyLog.jpg) +两日内管理类所有的操作每日操作统计 + +### 合约操作分类统计（2日） +![contractLog](./_static/imgs/contractLog.jpg) +两日内合约操作分类统计饼图，合约操作主要分为连接类和状态更新类。 + +### 合约操作每日统计（2日） +![contracteveryLog](./_static/imgs/contracteveryLog.jpg) +两日内合约操作数量折线统计图。 + +### 管理操作日志列表 +![opList](./_static/imgs/opList.jpg) +管理操作日志的详细信息列表。包括日志时间，管理操作名称，操作对应的节点公钥。默认展示范围是两天，可以自定义获取日志的天数。 + +### 合约操作日志列表 +![contractList](./_static/imgs/contractList.jpg) +合约操作日志详细信息列表。包括日志产生时间，合约操作名称，合约操作节点公钥。默认展示范围是两天，可以自定义获取日志的天数。 + +### 设置 + +设置页面是节点证书的状态展示以及配置节点证书 + +### 概览 +![set](./_static/imgs/set.jpg) + +### 证书状态 +![licence](./_static/imgs/licence.jpg) +证书状态主要包括许可到期时间和许可节点数量。 + +### 配置证书 +![plicence](./_static/imgs/plicence.jpg) +配置证书模块可以下载节点ID文件或者输入证书信息进行提交。 diff --git a/source/markdown_ZRYH/InstallTips.md b/source/markdown_ZRYH/InstallTips.md new file mode 100644 index 0000000..a5d6857 --- /dev/null +++ b/source/markdown_ZRYH/InstallTips.md @@ -0,0 +1,190 @@ +# BDContract安装说明 + + +- - - + +## 依赖环境的安装 +1.安装Java1.8环境。 + +例如，在Ubuntu下使用apt-get进行安装： + +```bash +apt-get install openjdk-8-jre +``` +在Centos环境下，使用yum进行安装： + +```bash +yum install java-1.8.0-openjdk +``` + +如果是离线环境，可先下载openjdk的安装包后进行离线安装。 + +Ubuntu下 +```bash +dpkg -i jdk-8uxxxxx.deb +``` + +在Centos环境下，使用yum进行离线安装： +```bash +yum localinstall jdk-8u271-linux-xxx.rpm +``` + +2.安装wget与unzip。 +例如，在Ubuntu下使用apt-get进行安装： + +```bash +apt-get install unzip +apt-get install wget +``` + +- - - + +## 网络拓扑说明 + +部署数瑞智能合约引擎最小仅需一个节点，此时可用作调试、测试，不能通过多节点模式来实现可信的计算。 +单节点部署时，可通过配置账本实现"防抵赖"的计算，但不能实现"难篡改"的计算。 + +多节点部署时可参考下图，包含三种逻辑节点，同一虚拟机可安装一至三种节点。 + +1）账本节点。即数瑞图式账本。 + +2）合约节点。运行代码逻辑，并通过内存缓存实现高响应的模块。与其他合约节点组成可信计算网络。 + +3）路由节点。各个合约节点的路由信息。一般单个路由节点可支持最高1000合约节点。可视情况部署多个路由节点，并在路由节点之间配置实现更大规模的节点组网。 + +一般地，同一虚拟机下，会部署**合约节点与账本节点**。 + +![deploytopology](_static/imgs/deploytopology.png) + +- - - + +## 智能合约节点安装 + +打开[安装包下载链接](https://public.internetapi.cn/?dir=releases/bdcontract/newest) +其中，下载`bdserver-lite.zip`或`bdserver.zip`，其中，`bdserver.zip`包含更多示例和文档。 +下载之后解压并启动。 + +```bash +unzip -d ./bdserver bdserver-lite.zip +cd bdserver +chmod +x *.sh +sh cmstart.sh +``` + +- - - + +## 路由准入节点安装 + +打开[安装包下载链接](https://public.internetapi.cn/?dir=releases/bdcontract/newest) +其中，下载`bdserver-cluster.zip`。 +下载之后解压并启动。 + +```bash +unzip -d ./bdcluster bdserver-cluster.zip +cd bdcluster +chmod +x *.sh +sh ncstart.sh +``` + +- - - + +## 文件说明 + +### 智能合约节点 + +![bdserver目录](_static/imgs/dirstructure.png) + +该目录下的文件说明： + +1.cmstart.sh 该脚本用于启动合约引擎。合约引擎默认监听8080端口，可通过修改cmstart.sh来修改合约引擎的监听端口。 + +2.BDWareProjectDir 该目录存放了本节点的所有合约项目。 + +3.WebContent 该目录存放了本节点的前端代码。 + +4.cp, 该目录存放了yjs.jar，为启动合约实例所需的jar。 + +5.bdserver.jar 对外提供http/websocket的服务器逻辑。 + +6.updateContract.sh 用于升级的脚本。 + +### 路由准入节点 + +安装脚本会自动下载安装并解压为bdcluster目录。 +该目录下的文件说明： + +1.ncstart.sh 该脚本用于启动节点准入中心。默认监听1718端口。可通过修改ncstart.sh来修改监听的端口。 + +2.WebContent 该目录存放了准入中心的前端代码。 + +3.bdcluster.jar 准入中心的后端。 + +- - - + +## 升级流程 + +### 合约节点 + +在命令行中输入： + +```bash +sh updateContract.sh +``` + +亦可通过[public.internetapi.cn](https://public.internetapi.cn/?dir=releases/bdcontract)，下载最新文件，单独升级yjs.zip/bdserver-jar.zip/AgentWebContent来升级。 + +### 路由准入节点 + +```bash +sh updateCluster.sh +``` +亦可通过[public.internetapi.cn](https://public.internetapi.cn/?dir=releases/bdcontract)，下载最新文件，单独升级bdserver-cluster.zip/ClusterWebContent.zip来升级。 + +- - - + +## 使用说明 + +### 通过参考界面使用 +当保留了WebContent目录的情况下，可使用浏览器进行配置。 +更多请使用见左侧文档[BDContract参考界面使用说明](./IDEUsage.html)。 + +#### BDWare OnlineIDE +打开[BDWare OnlineIDE](../OnlineIDE.html)。 + +#### BDWare NodePortal +打开[BDWare NodePortal](../NodePortal.html)。 + +如需组网，使用跨节点功能，则需安装路由准入中心。并按以下步骤进行配置。涉及两组公私钥。 +第一组公私钥为合约节点的、有NodeManager权限的公私钥。 +第二组公私钥为路由准入节点的、有CenterManager权限的公私钥。 + +1.打开NodePortal.html，复制该节点的NodeManager公私钥。 + +2.打开CenterPortal.html，点击右上角，将上述的NodeManager公私钥导入；并选择"NodeManager"进行身份认证。 + +3.在CenterPortal.html中切换CenterManager的公私钥，点左侧的"用户管理"，通过NodeManager的认证请求。 + +4.使用NodeManager权限的公私钥打开NodePortal.html，点击：“节点管理”菜单，并配置加入网络。 +其中，加入网络的格式为:ws://centerportal的ip:端口+1。 +![配置示例](_static/imgs/config.png) + + +### 通过SDK使用 + +#### 基础知识 + +[Websocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) + +[Sm2加密的使用](https://github.com/JuneAndGreen/sm-crypto) + +#### SDK下载 + +1. Java版本的客户端下载：[BDWareJavaClient](_static/BDWareJavaClient.zip)。具体使用说明请下载后解压，查看README.md，并参考[ContractAPI](./ContractAPI.html)。 + +2.Javascript版本的客户端下载:[BDWareWebClient](_static/BDWareWebClient.zip)。具体使用说明请下载后解压，查看README.md，并参考[ContractAPI](./ContractAPI.html)。 + +3.配置工具[BDWareConfigTool](_static/BDWareConfigTool.zip)。具体说明请下载后解压，使用以下命令查看帮助： + +``` bash +java -jar java-client.jar -h +``` \ No newline at end of file diff --git a/source/markdown_ZRYH/Introduction.md b/source/markdown_ZRYH/Introduction.md new file mode 100644 index 0000000..532218b --- /dev/null +++ b/source/markdown_ZRYH/Introduction.md @@ -0,0 +1,218 @@ +# BDContract介绍 + +- - - + +## 什么是BDContract? +BDContract是智融云河大数据区块链中，基于北大数瑞开源的智能合约引擎封装的一套软件。是面向大数据场景的数据资源、IoT资源、云资源的管理、调度平台。BDContract是一个可信计算框架，计算逻辑以智能合约的方式表达。通过”随机“和”冗余计算“的方式实现智能合约的可信执行。BDContract在保证智能合约的可用性、可靠性的同时，着重提升执行效率和安全性。 + + +- - - + +## 特点 + +0. 支持多种执行模式，权衡可用性、可靠性、正确性和效率。 +1. 接入各种数据源。 +2. 支持合约的细粒度监测。 +3. 支持合约的状态。 +4. 访问控制。 +5. 支撑跨语言调用。 + + +- - - + +## 更新日志 + +* **v1.4.5** 2021年6月29日 + - 稳定性提升 + - HTTP服务端的URIPath优化 + - 支持以Http方式进行静态资源文件加载 + +* **v1.4.4** 2021年6月15日 + - 修复了getContractMeta时没优先返回RUNNING/HANGED的合约的问题 + - 实现了HomomorphicEncrypt的逻辑 + +* **v1.4.3** 2021年6月9日 + - 修复SSL Renegotiate Bug + - 实现内存不足时自动Hangup-Resume + - 实现contract meta的硬盘持久化 + +* **v1.4.1** 2021年5月26日 + - 实现了事件机制中的事件语义，支持“至少一次”、“至多一次”和“只有一次” + - 优化了合约模板 + - 增加模板配置文件 + - 优化了MockTemplate注解 + +* **v1.4.0** 2021年5月9日 + - 优化了ACTemplate + - 完善了DoRepo的配置联动 + +* **v1.3.9** 2021年4月22日 + - 修复了doipConfig在updateConfig中不支持的bug + - test-tool支持了sudo + - 优化了contract-template中的ACTemplate模板 + +* **v1.3.6** 2021年4月21日 + - 修复了docker中无法获取cpuid的问题 + +* **v1.3.6** 2021年4月16日 + - 修复了部分bug + - 修复了GRPCPool线程数量不足导致排队的bug + - 修复了requestID分配在压力测试下可能重复的bug + +* **v1.3.5** 2021年3月31日 + - 修复了部分bug + - http的合约调用部分增加了简单拥塞控制策略 + - 稳定性提升 + +* **v1.3.0** 2021年2月1日 + - 优化心跳机制 + - 修复部分Bug + - 更新SM2/SM3库 + - 更新前端签名计算方式 + +* **v1.2.0** 2020年12月11日 + - 优化了多节点执行模式 + - 优化了合约master路由的逻辑 + - 修复了部分bug + - 修复文件系统相关的漏洞 + +* **v1.1.0** 2020年9月 + - 支持https，并更新了该部分文档 + + +* **v1.0.9** 2020年8月27日 + - 完善IO相关工具类的文档 + - 优化合约模板：DAC持久化 + + +* **v1.0.7** 2020年8月13日 + - 优化合约日志、账本接口 + - 优化相关接口的文档 + - 提供合约模板的websocket接口 + - 自动编译bug修复 + +* **v1.0.5** 2020年7月25日 + - 弱化NC的中心化作用，集群点对点连接。 + - 优化bdwareclient + - TODO MemoryDurable + +* **v1.0.2** 2020年7月22日 + - 修复CentOS7下Too Many Opened Files的Bug + - 修复权限Bug + - 增加权限说明 + - 修复MySQLUtil的bug + - 升级BDLedger版本 + +* **v1.0.1** 2020年7月5日 + - 更新了NodePortal/CenterPortal的UI。 + - 修改了编译流程，在NodePortal中可查看编译结果，在OnlineIDE中可手动/启动时编译 + - 修改了合约分发逻辑，以编译后ypk作为分发的文件 + - 支持public目录下的ypk在多节点模式下执行时，合约故障自动恢复 + +* **v0.99** 2020年6月22日 + - 自定义合约方法的计费 + - 新增了GasExample、Incentives示例 + - 在客户端实现了"校验多点结果"，并优化了结果返回的方式 + - 修复断线重连后无权限提示 + +* **v0.97** 2020年5月25日 + - cpu等资源的计量：gas机制 + - onlineIDE.html 支持上传多个文件 + - udp方式组网进行多点执行[无定序消息] + - bdwareclient.html，修复只包含计算逻辑的调用示例生成前缀错误 + +* **v0.95** 2020年5月19日 + - 修复了onlineIDE.html在的pathname有前缀时不能正确跳转bdwareclient的bug。 + - 修复了bdwareclient的pathname有前缀时自动提取url的bug。 + - 启用了合约的权限 + - 增加了NodePortal.html/OnlineIDE.html和bdwareclient.html中无权限时的提醒 + +* **v0.90** 2020年5月9日 + - 更改了yjs.jar/bdserver.jar的打包方式 + - 更新了install.sh/update.sh + - onlineIDE的修改后提醒 + - onlineIDE标签页自适应宽度 + - 文件接口隔离 + + +* **v0.8** 2020年4月26日 + - 完善文档界面和优化SDK提供方式 + - 数瑞Web客户端，客户端中所有的数据处理和如何对处理后的数据进行渲染均来自合约调用，实现可信Web应用。 + +* **v0.78** 2020年4月13日 + - 合约调用DAC示例 + - 支持动态修改IO权限 + - 支持合约状态自定义备份（定时）策略 + - 修复部分页面bug + - 日志展示优化 + - 优化账本日志展示 + - 启用部分权限访问控制 + + +* **v0.7** 2020年3月25日 + - 支持多种角色的访问控制 + - 更新了UI + +* **v0.6** 2020年2月14日 + - 优化了合约进程间的通讯 + - 尝试接入P2P网络 + +* **v0.5** 2019年12月10日 + - 完善了3种智能合约状态记录-回放策略 + - 支持了最简单的多点执行算法（不同步） + +* **v0.45** 2019年9月2日 + - 初步实现PBFT算法 + +* **v0.4** 2019年5月10日 + - 支持memory dump + +* **v0.35** 2019年4月26日 + - 实现合约的静态分析框架 + - 支持事件的发布-订阅 + +* **v0.3** 2019年1月8日 + - 支持账本数据的接入 + - 合约状态上链 + +* **v0.2** 2018年10月9日 + - 支持Python包的自动生成 + - 支持合约打包为ypk + - 支持文件、数据库等数据的接入 + +* **v0.1** 2018年8月6日 + - 定义了智能合约的语法 + - 基于nashorn引擎，实现了智能合约的执行 + +- - - + +## 使用开源项目说明 +BDWareContract项目站在了许多巨人的肩膀上，感谢这些开源项目。 + +本项目的智能合约后端使用了以下开源库。 + +| 名称 | Licence类型 | 说明 | +| ------ | ---------- | ---- | +| [Project Nashorn](https://openjdk.java.net/projects/nashorn/) | [GPLv2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) | 使用了该项目的编译器，可以将js函数编译为java字节码 | +| [ASM OW2](https://projects.ow2.org/view/asm/) | [BSD](https://en.wikipedia.org/wiki/BSD_licenses#4-clause_license_(original_%22BSD_License%22)) with attribution | 基于asm的TreeAPI与VisitorAPI实现合约的静态分析框架 | +| [Netty](https://netty.io/) | [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0) | 使用netty作为Http/Websocket的服务端 | +| [gRPC](https://grpc.io/) | [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0) | 使用gRPC与BDWareLedger通讯 | +| [RocksDB](https://github.com/facebook/rocksdb) | [GPLv2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) | 后台数据库 | +| [ANTLR](https://github.com/antlr/antlr4) | [BSD](https://en.wikipedia.org/wiki/BSD_licenses#4-clause_license_(original_%22BSD_License%22)) | 对合约脚本的词法分析与语法分析 | +| [SM2Java](https://github.com/PopezLotado/SM2Java) | [无](https://github.com/PopezLotado/SM2Java/blob/master/README.md) | 国密SM2 Java语言实现 | + + + +本项目的智能合约前端使用了以下开源库。 + +| 名称 | Licence类型 | 说明 | +| ------ | ---------- | ---- | +| [Bootstrap](https://getbootstrap.com/) | [MIT](https://github.com/twbs/bootstrap/blob/master/LICENSE) | 前端的排版、样式 | +| [jQuery](https://jquery.org/) | [MIT](https://jquery.org/license/) | 用于操作DOM的javascript库 | +| [jQueryUI](https://jqueryui.com/) | [MIT](https://jquery.org/license/) | 前端UI构件库 | +| [DataTables](https://datatables.net/) | [MIT](https://datatables.net/license/mit) | 表格样式 | +| [CodeMirror](https://codemirror.net/) | [MIT](https://codemirror.net/LICENSE) | 代码编辑框样式 | +| [eCharts](https://echarts.apache.org/zh/index.html) | [ApacheV2](https://www.apache.org/licenses/) | 统计图表 | +| [sm-crypto](https://github.com/JuneAndGreen/sm-crypto) | [MIT](https://github.com/JuneAndGreen/sm-crypto/blob/master/LICENCE_MIT) | 国密SM2 javascript语言实现 | + +本项目的文档使用[Sphinx](https://www.sphinx-doc.org/en/master/)生成，感谢[readthedocs](https://readthedocs.org/)提供文档样式。 \ No newline at end of file diff --git a/source/markdown_ZRYH/YJSAPI.md b/source/markdown_ZRYH/YJSAPI.md new file mode 100644 index 0000000..add6503 --- /dev/null +++ b/source/markdown_ZRYH/YJSAPI.md @@ -0,0 +1,1341 @@ +# YJS SDK +## YJS Build-in API + +### 内置对象 Global + + +### 内置对象 requester +该内置对象在export function里面会有值，仅当合约调用签名验证通过。 + + +### 执行合约 executeContract + +参数： + +``` bash +action:executeContract; +contractID:合约的id或名称均可； +operation:调用合约的方法名； +arg: 参数；格式为JSON字符串，有action与arg两个字段。 +``` + +可选参数： + +```bash +requestID:字符串类型，自行生成，用于查询hash +``` + +使用示例： + +```javascript + + function testExecutorContract(arg){ + var ret = JSON.parse(executeContract("ElemeProvider","queryDB",arg)); + if (ret.status == "Success"){ + return JSON.parse(ret.result); + }else return null; + } +``` +### 订阅事件主题 subscribe + +参数 + +``` bash +contractID：字符串类型 合约id或名称均可。 +event：字符串类型 +handler：方法名，该方法必须接受Event（内含字段topic和content）类型的唯一变量为参数；可以不是export方法 +``` + +使用示例： + +```javascript +export function init(arg) { + YancloudUtil.subscribe("topic", handler); + print("Handler: " + handler); +} + +function handler(e) { + print("topic: " + e.topic); + print("content: " + e.content); +} + +``` + +### 发布事件 pubEvent + +参数 + +``` bash +topic：字符串类型，发布的事件主题 +content：字符串类型，发布的事件内容 +``` +使用示例： + +```javascript +export function pub1(arg) { + YancloudUtil.pubEvent("topic", arg); + return "done"; +} +``` + +也可以在合约开头声明事件，则事件名即为事件主题，此时可直接使用事件作为方法名发布事件 + +```javascript +event topic; +export function pub2(arg) { + topic(arg); + return "done"; +} +``` + +该写法与上面的`pub1`等价。 + +### 发布带语义事件 pubEventConstraint + +参数 + +``` bash +topic：字符串类型，发布的事件主题 +content：字符串类型，发布的事件内容 +semantics：枚举类型，作为字符串输入，事件语义 +``` + +事件语义参数 ++ AT_LEAST_ONCE：至少一次，默认语义 ++ AT_MOST_ONCE：至多一次 ++ ONLY_ONCE：只有一次 + +使用示例： + +```javascript +export function pub1(arg) { + YancloudUtil.pubEventConstraint("topic", arg, "AT_MOST_ONCE"); + return "done"; +} +``` + +也可以在合约开头声明事件，则事件名即为事件主题，此时可直接使用事件作为方法名按声明的语义发布事件 + +```javascript +event AT_MOST_ONCE topic; +export function pub2(arg) { + topic(arg); + return "done"; +} +``` + +该写法与上面的`pub1`等价。 + +事先声明的事件无论是否声明语义，都可以用后缀s作为方法名的方式调用，发布任意语义的事件： + +```javascript +event topic; +export function pub3(arg) { + topics(arg, "AT_MOST_ONCE"); + return "done"; +} +``` + +该写法与上面的`pub1, pub2`等价。 + +*不带事件语义声明事件时，语义默认为至少一次（AT_LEAST_ONCE）。* + +### 访问资源文件 + +通过Global.Resources去加载ypk内部的资源文件。 + +#### loadAsInputStream + +参数： + + ```bash + path：字符串类型 需要加载文件的地址 + ``` + 使用示例： + + ```javascript + var file = Global.Resources.loadAsInputStream("/deleteit.txt"); + ``` + +#### loadAsScanner + +参数： + + ```bash + path：字符串类型 需要加载文件的地址 + ``` + + 使用示例： + + ```javascript + var scanner = Global.Resources.loadAsScanner("/local.txt"); + ``` +### YancloudUtil + +提供了一些内置的工具方法。 + +#### getKeyPair + +参数： +``` +无 +``` + +使用示例： + +``` +var keyPair = YancloudUtil.getKeyPair(); +//该类型为SM2KeyPair类型， +print(keyPair.getPublicKeyStr()); +print(keyPair.getPrivateKeyStr()); +print(keyPair.toJson()); +``` + + +## YJS Build-in Annotation + +### @Access + +设置合约的调用是否需要签名，这里分为两种，需签名和无签名。 +其中，"verified"表示需要签名。其他则表示无需签名。 + +``` +@Access("verified") +export function easy(arg){ + return "true"; +} +``` + +### @LogType + +LogType注解通过参数的方式声明合约或函数的需要记录的日志类型。 + +其中，Arg表示日志中记录合约执行的参数；Result表示记录合约执行的返回结果；Branch表示记录合约执行分支。 + +例如 ，通过如下LogType注解来声明函数 + +``` +@LogType("Arg","Result","Branch") +export function easy(arg){ + Global.a = "a"; + Global.b = "b"; + if(arg > 0) + return Global.a; + else + return Global.b; +} +``` + +### @LogLocation + +该注解可以修饰`contract`或`function`。 +设置日志存储的位置。参数中指定为“dataware”则存储在账本和本地，如果没有指定为“dataware”则仅存储在本地。 +例如，通过如下LogLocation设置存储位置。 + +在BaaS平台中，可以指定账本名称，BaaS平台默认账本为default,使用 +`@LogLocation("bdledger:default")`。如想保存到自定义的账本，比如，"abc"账本，就使用 +`@LogLocation("bdledger:abc")` + +``` +@LogLocation("dataware") +export function easy(arg){ + Global.a = "a"; +} +``` + + +### @Permission +该注解只能修饰`contract` +设置合约中调用的工具类的权限，包括File、Http、MySQL、MongoDB、RocksDB等工具类。如果合约中用到了以上工具类，需要在注解中添加对应的授权字段，默认只有YJS自带的YancloudUtil;如果没有添加则会抛出"未授权工具类"的异常。 +这6种工具类的详细说明在本小节后续中有说明。 + +``` +@Permission("Http","File") +contract HttpPermission { + export function main(args){ + var http=HttpUtil.httpGet(args); + var dir="adf/adfas/"; + var file=FileUtil.getDir(dir); + return YancloudUtil.currentTimeMillis(); + } +} +``` + +### @Description +该注解可以修饰`contract`或`function`。 +传入合约及函数的简介，可用于生成说明文档中关于exported函数的介绍。 + +``` +@Description("返回数据条目，无需参数") +export function count(args){ + var sql = "select count(*) from data;"; + var conn = getConn(); + var statement = conn.createStatement(); + var resultSet = statement.executeQuery(sql); + var c = {}; + resultSet.next(); + c.count = resultSet.getLong(1); + return JSON.stringify(c); +} +``` + +### @Param +该注解可以修饰`function`。 +提供调用函数的参数示例，也为生成说明文档中的返回结果提供默认参数。 +``` +@Param({"offset":0,"count":100}) +export function get(args){ + var offset = args.offset; + var count = args.count; + ... +} +``` +### @MockTemplate +该注解可以修饰`function`。 +提供函数的返回模拟数据模板,用于描述返回值的格式.若加此注解在debug方式调用时，返回按照此格式生成的模拟数据。 + + +####支持的字段类型 +``` +@integer 整数 +@string 字符串 +@boolean 布尔值 +@date @time @datatime +@word 单词 @cword 中文单词 +@first @last 英文姓，名 +@cfirst @clast @cname 中文姓，名，全名 +@url @domin @ip @email +@region @province @city @county 地区，省，市，县 +…… +详细格式可以参考http://mockjs.com/examples.html +``` +####注意：模板的格式为{‘result’:模板} +```json +//返回一个对象包含如下字段 +@MockTemplate({'result':{'id':'@integer','email':'@email','password':'@string','name':'@name'}}) +//返回 +{"password":"3ZLc","name":"William Young","id":36097783842688,"email":"d.fuunwe@gqnr.to"}" + + +//返回元素个数为1-5个之间的一个数组，数组的每个元素都是上述格式的一个对象 +{'result|1-5':[{'id':'@integer','email':'@email','password':'@string','name':'@name'}]} +//返回 +[ + {"password":"dO]wW","name":"Jeffrey Lopez","id":1783453207480410,"email":"a.ckokgxrga@hgiesugi.bb"}, + {"password":"BQYRL","name":"Brian Moore","id":4310212972071102,"email":"k.lbpxocydrh@msgnjtox.na"}, + {"password":"Gw1","name":"Susan Jackson","id":7766580783668916,"email":"h.zjgusl@htce.cr"} +] +``` +``` +@MockTemplate({'result':{'id':'@integer','email':'@email','password':'@string','name':'@name'}}) +export function count(args){ + var sql = "select count(*) from data;"; + var conn = getConn(); + var statement = conn.createStatement(); + var resultSet = statement.executeQuery(sql); + var c = {}; + resultSet.next(); + c.count = resultSet.getLong(1); + return JSON.stringify(c); +} +``` +### @Result +该注解可以修饰`function`。 +提供函数的返回结果示例，若加此注解则生成说明文档时将直接返回此结果而不使用默认参数调用函数。 +``` +@Result(666) +export function count(args){ + var sql = "select count(*) from data;"; + var conn = getConn(); + var statement = conn.createStatement(); + var resultSet = statement.executeQuery(sql); + var c = {}; + resultSet.next(); + c.count = resultSet.getLong(1); + return JSON.stringify(c); +} +``` +### @Cost +该注解可以修饰`function`。 +提供函数的cpu计量功能。 +``` +@Cost({"countGas":true}) +export function .... + + +``` + +## IO工具类 + +### 概览 + +|IO工具类名称|说明| +|---|---| +| [FileUtil](./YJSAPI.html#fileutil) | 文件操作相关的类 | +| [LedgerUtil](./YJSAPI.html#ledgerutil) | 账本操作相关的类 | +| [HttpUtil](./YJSAPI.html#httputil) | Http接口相关的类 | +| [DOIPUtil](./YJSAPI.html#doiputil) | DoIP相关的类 | +| [MySQLUtil](./YJSAPI.html#mysqlutil) | 连接mysql数据库 | +| [MongoDBUtil](./YJSAPI.html#mongodbutil) | MongoDB连接相关的类 | +| [RocksDBUtil](./YJSAPI.html#rocksdbutil) | RocksDB（基于本地文件的k-v数据库） | +| [BDWareTimeSeriesDBUtil](./YJSAPI.html#BDWareTimeSeriesDBUtil) | 基于本地文件的时间序列数据库 | + + +### FileUtil +可以使用@Permission("File")来引入FileUtil对象。 + +``` +@Permission("File") +contract FileSample { +... +} +``` + +该对象支持以下方法： + +#### copyTo + +可以复制文件和目录。第一个参数是source，第二个参数是destination。 + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | src | 类型为String | +| 2 | dest | 类型为String | + +##### 使用示例 + +```javascript +var ret = FileUtil.copyTo("./source.txt","./dest.txt"); +``` + +#### getContent + +获取文件的文本内容，当文件不存在时，返回```undefined```。 + +##### 参数 + +| 序号 | 参数 | 说明 | +| --- | --- | --- | +| 1 | path | 类型为String | + +##### 使用示例 + +```javascript +var ret = FileUtil.getContent("./source.txt"); +``` +#### getDir + +获取文件所在的文件夹名，输入参数为字符串。 + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | path | 类型为String | + +##### 使用示例 +```javascript +var ret = FileUtil.getDir("./parent/src.txt"); +// ret 为 "./parent/"; +``` + +#### getFileName + +获取文件名。输入参数为字符串。 + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | path | 类型为String | + +##### 使用示例 + +```javascript +var ret = FileUtil.getFileName("./parent/src.txt"); +// ret 为 "src.txt" +``` + + +#### openFileAsPrinter + +以PrintStream的形式打开文件。 +返回结果是```java.io.PrintStream```类型。 + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | path | 文件名，类型为String | +| 2 | isAppend| 类型为boolean，表示是否往文件末尾添加 | + +##### 使用示例 + +```javascript +var ret = FileUtil.openFileAsPrinter("./parent/src.txt",true); +ret.println("hello"); +ret.close(); +``` + +### LedgerUtil + +可以使用@Permission("Ledger")来引入LedgerUtil对象。 +``` +@Permission("Ledger") +contract LedgerExample{ +... +} +``` + +#### getClient + +获取一个连接客户端，一个参数，为对象类型。 +返回结果为LedgerClient类型，用于后续的查询账本等操作。 + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | address | 包含ip和端口两个字段 | + +##### 使用示例 + +```javascript +var address = {}; +address.ip = "127.0.0.1"; +address.port = 18091; +var ledgerClient = LedgerUtil.getClient(address); +``` + +#### queryByHash + +根据Hash查询Transaction。 +返回结果为对象，包含from、to、type和data四个字段，均为String类型。 +其中data为按utf-8编码解析字节数组，如果存证时用的不是utf8编码，可能返回乱码。 + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | client | 通过getClient方法获得的对象 | +| 2 | info | 对象类型，有两个字段ledger和hash，均为字符串类型 | + +##### 使用示例 + +```javascript +// ... ledgerClient = LedgerUtil.getClient(...); +var info = {}; +info.ledger = "bdcontract"; +info.hash = "4d3b75750835092a50085127702669615b602e53"; +var ret = LedgerUtil.queryByHash(ledgerClient,info); +print(ret.from); +print(ret.to); +print(ret.type); +print(ret.data); +``` + +#### sendTransaction + +存证数据。 + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | client | 通过getClient方法获得的对象 | +| 2 | info | 对象类型，有from\to\data三个字段，均为String类型 | + +##### 使用示例 + +```javascript +// ... ledgerClient = LedgerUtil.getClient(...); +var info = {}; +info.ledger = "bdcontract"; +info.from = "b60e8dd61c5d32be8058bb8eb970870f07233155"; +info.to = "b60e8dd61c5d32be8058bb8eb970870f07233155"; +info.data = "hello world"; +var ret = LedgerUtil.sendTransaction(ledgerClient,info); +//ret为存证的哈希值 +print(ret); +``` + +### HttpUtil + +可以使用@Permission("Http")来引入HttpUtil对象。 +``` +@Permission("Http") +contract HttpExample{ +... +} +``` + +#### createAPIGate + +配合手机的元邦使用，当手机安装元邦且安装了API 接口后，可成为数据来源。 + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | ip | 字符串类型，ip，端口默认为6161 | + +##### 使用示例 + +```javascript +var ret = HttpUtil.createAPIGate("192.168.4.4"); +ret.get("com.tencent.mm","sendMsg","msg"); +print(ret); +``` + +#### createAPIGate + +配合手机的元邦使用，当手机安装元邦且安装了API 接口后，可成为数据来源。 + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | ip | 字符串类型，ip| +| 2 | port | 字符串类型，端口 | + +##### 使用示例 + +```javascript +var ret = HttpUtil.createAPIGate("192.168.4.4", "6161"); +ret.get("com.tencent.mm","sendMsg","msg"); +print(ret); +``` + +#### get + +发起Http的get请求。 +返回结果为对象类型，包含response和responseCode两个字段。 + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | url | 字符串，表示url类型 | + +##### 使用示例 + +```javascript +var ret = HttpUtil.get("https://www.baidu.com"); +print(ret.responseCode); +print(ret.response); +``` + +#### post +发起Http的post请求。 +返回结果为对象类型，包含response和responseCode两个字段。 + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | args | 对象类型，有url，headers和data三个字段。其中，args.headers为对象类型。| + +##### 使用示例 + +```javascript +var req = {}; +req.url = "https://www.baidu.com"; +req.data = "hello"; +req.header = {}; +req.header.Accept = "application/json"; +req.header["Content-Type"] = "application/json"; +var ret = HttpUtil.post(req); +print(ret.resposeCode); +print(ret.response); +``` + +### DOIPUtil + +可以使用@Permission("DOIP")来引入DOIPUtil对象。 +``` +@Permission("DOIP") +contract DOIPExample{ + ... +} +``` + +#### call +调用一个DO + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | arg0 | 字符串类型, 目标DO标识| +| 2 | arg1 | 字符串类型, 输入参数字符串| + +##### 使用示例 + +```javascript +var ret = DOIPUtil.call("86.5000.470/do.hello","inputString"); +``` +#### create +向一个Repository创建一个字符串类型DO + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | arg0 | 字符串类型, 目标Repo标识| +| 2 | arg1 | 对象类型,包括doID,doBody字段| + +##### 使用示例 + +```javascript +var digitalObject = JSON.parse("{\"doID\":\"86.5000.470/do.hello\",\"doBody\":\"hello world\"}"); +var ret = DOIPUtil.create("86.5000.470/repo.localTcpRepo",digitalObject); +``` +#### delete +从一个Repository中删除DO + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | arg0 | 字符串类型 目标DO标识| +| 2 | arg1 | 字符串类型 目标Repo标识| + +##### 使用示例 + +```javascript +var ret = DOIPUtil.delete("86.5000.470/do.hello","86.5000.470/repo.localTcpRepo"); +``` +#### hello +获取目标Repository的DOIP服务信息 + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | arg0 | 字符串类型 目标Repo标识| + +##### 使用示例 + +```javascript +var ret = DOIPUtil.hello("86.5000.470/repo.localTcpRepo"); +``` +#### listOperation +获取目标DO支持的DOIP操作 + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | arg0 | 字符串类型 目标DO标识| + +##### 使用示例 + +```javascript +var ret = DOIPUtil.listOperation("86.5000.470/do.hello"); +``` +#### register +向LHS注册一个DO，返回分配的标识 + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | arg0 | 字符串类型 DO所在Repo标识| +| 2 | arg1 | 字符串类型 DO格式描述字符串| + +##### 使用示例 + +```javascript +var ret = DOIPUtil.register("86.5000.470/repo.localTcpRepo","String"); +``` +#### reregister +修改LHS中DO的注册信息 + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | arg0 | 字符串类型 目标DO标识| +| 2 | arg1 | 字符串类型 DO所在Repo标识| +| 3 | arg2 | 字符串类型 DO格式描述字符串| + +##### 使用示例 + +```javascript +var ret = DOIPUtil.reregister("86.5000.470/do.hello","86.5000.470/repo.localTcpRepo","String"); +``` +#### retrieve +获取一个DO + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | arg0 | 字符串类型 目标DO标识| + +##### 使用示例 + +```javascript +var ret = DOIPUtil.retrieve("86.5000.470/do.hello"); +``` +### test +测试DOIPUtils是否可用 +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | arg0 | 字符串类型 任意字符串| + +##### 使用示例 + +```javascript +var ret = DOIPUtil.test("hello"); +``` +#### update +更新目标DO + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | arg0 | JS对象,包括doID,doBody字段| + +##### 使用示例 + +```javascript +var digitalObject = JSON.parse("{\"doID\":\"86.5000.470/do.hello\",\"doBody\":\"hello world\"}"); +var ret = DOIPUtil.update(digitalObject); +``` + + + +### SQLUtil + +可以使用@Permission("SQL")来引入SQLUtil对象。 +可支持MySQL/PostgreSQL/Oracle/GuassDB200等SQL数据库。 +需要将对应的jdbc的jar上传到项目中。 +例如，要使用mysql，可上传mysql-connector-java-8.0.24.jar + +``` +@Permission("SQL") +oracle MySQLExample{ +... +} +``` + +#### initDriver + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | driverClass | 字符串类型 | + +##### 使用示例 + +```javascript + //使用mysql + SQLUtil.initDriver("com.mysql.cj.jdbc.Driver"); + //使用postgresql + SQLUtil.initDriver("org.postgresql.Driver"); + //使用oracle + SQLUtil.initDriver("oracle.jdbc.OracleDriver"); +``` + +#### getConnection + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | URL | 字符串类型，jdbc连接 | +| 2 | usrName | 字符串类型，用户名 | +| 3 | pwd | 字符串类型，密码 | + + +##### 使用示例 + +```javascript +var url = "jdbc:mysql://xx.xx.xx:port/tableName"; +var usrName = "xxx"; +var pwd = "xxx"; +//配置好用户名和密码，url格式为ip或域名+端口，中间以”:”隔开。 +var conn = SQLUtil.getConnection(url,usrName,pwd); +//获取数据库连接 +var sql = "select * from newele.data"; +//创建查询语句 +var statement = conn.createStatement(); +var resultSet = statement.executeQuery(sql); +var waimailist = []; +//解析查询结果 +var meta = resultSet.getMetaData(); +for (;resultSet.next();){ + var line = {}; + for (var j=1;j<=meta.getColumnCount();j++){ + line[meta.getColumnName(j)] = resultSet.getString(j); + } + waimailist.push(line); +} +``` + +其中，getConnection方法返回的对象通过反射机制绑定到了Java的一个java.util.Connection对象。因此，可以查看： + +以了解如何进行Mysql数据库操作。 + + +### MongoDBUtil + +可以使用@Permission("MongoDB")来引入MongoDBUtil对象。 +``` +@Permission("MongoDB") +contract MongoDBExample{ +... +} +``` + +#### getConnection + + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | URL | 字符串类型 数据库的URL | +| 2 | port | 整数类型 端口号 | +| 3 | dbName | 字符串类型 数据库的名称 | +| 4 | usrName | 字符串类型 数据库的用户名 | +| 5 | pwd | 字符串类型 数据库的密码 | + + +##### 使用示例 + +**注意：port为整型，其他参数为String类型** + +```javascript +var client = MongoDBUtil.getConnection(url,port,dbName,usrName,pwd); +//获取数据库对象 +var db = client.getDatabase("yancloud"); +var collection = db.getCollection("containers"); +var iter = collection.find().iterator(); +var ret =""; +for (;iter.hasNext();){ + ret+=iter.next().toJson(); + ret+="\n"; +} +``` + +其中，getMongoDBClient对象通过反射机制绑定到了Java的一个com.mongodb.MongoClient对象。因此，可以查看： + + +以了解该对象的更多方法和使用方式。 + +### RocksDBUtil + +使用@Permission("RocksDB")来引入RocksDBUtil对象。 + +``` +@Permission("RocksDB") +contract RocksDBSample { +... +} +``` + +#### loadDB + +通过loadDB来加载一个RocksDB数据库。 +加载后，可进行get/delete/put等操作。 + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | path | 字符串类型 数据库部署的路径 | +| 2 | readOnly | 布尔类型 数据库只读 | + +##### 使用示例 + +``` +@Permission("RocksDB") +@Description("这是个使用RocksDB的参考代码") +contract RocksDBSample{ + function onCreate(){ + Global.rocksdb = RocksDBUtil.loadDB("./dbdir/","false"); + } + @Description("示例参数: {\"key\":\"abc\",\"value\":\"def\"}") + export function put(arg){ + arg = JSON.parse(arg); + Global.rocksdb.put(arg.key,arg.value); + return "success"; + } + @Description("示例参数: \"abc\"}") + export function get(arg){ + return Global.rocksdb.get(arg); + return "failed"; + } + @Description("示例参数: \"abc\"") + export function deleteKey(arg){ + return Global.rocksdb.delete(arg); + } + @Description("遍历KV库，无需参数") + export function iter(arg){ + var iter = Global.rocksdb.newIterator(); + var obj = undefined; + var ret = { + }; + for (iter.seekToFirst();(obj=Global.rocksdb.getNext(iter))!=undefined;){ + ret[obj.key]=obj.value; + } + return JSON.stringify(ret) + } +} +``` + +### BDWareTimeSeriesDBUtil + +使用示例 + +``` +@Permission("BDWareTimeSeriesDB") +contract BDWareTimeDBExample{ + function onCreate(arg){ + Global.dbutil = BDWareTimeSeriesDBUtil.getConnection(); + } + + export function put(arg){ + //第一个参数为表名，第二个参数为要放的value，时间戳自动打。 + Global.dbutil.put("defaultTable",arg); + return "success"; + } + @Param + export function getCount(arg){ + return Global.dbutil.getCount("defaultTable"); + } + @Param(1617254937373) + export function queryByStartTime(arg){ + var startDate = java.lang.Long.valueOf(arg); + //查询从开始时刻startDate到最新的数据 + var list = Global.dbutil.query("defaultTable",startDate); + var ret=[]; + print("DBUtil"+Global.dbutil+" list:"+list+" list.size"+list.size()); + var i=0; + for (i=0;i"+list.get(i)); + ret.push(list.get(i)); + } + return ret; + } + + @Description("示例参数: {\"offset\":1,\"len\":1}") + @Param({"offset":1,"len":1}) + export function queryByOffset(arg){ + var offsetLen = JSON.parse(arg); + //可配合getCount使用，查询第offset至offset+len条数据 + var list = Global.dbutil.queryByOffset("defaultTable",offsetLen.offset,offsetLen.len); + var ret=[]; + print("DBUtil"+Global.dbutil+" list:"+list+" list.size"+list.size()); + var i=0; + for (i=0;i"+list.get(i)); + ret.push(list.get(i)); + } + return ret; + } +} + +``` + + +## 加解密工具类 + + +### SM2 +可以使用@Permission("SM2")来引入SM2Util对象。 + +``` +@Permission("SM2") +contract SM2Sample { +... +} +``` + +#### generateKeyPair +生成公私钥。 + +##### 参数 +无参数。 + +##### 使用示例 + +```javascript +var ret = SM2Util.generateKeyPair(); +print(ret.publicKey); +print(ret.privateKey); +return JSON.stringify(ret); +``` + +#### sign + +签名。 + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | content | 字符串类型 要进行签名的内容 | +| 2 | keyPair | sm2 | + + +##### 使用示例 + +``` +var keypair = SM2Util.generateKeyPair(); +var ret = SM2Util.sign("Hello",keypair); +print(ret.status); +//如果status是success +print(ret.signature); +//如果status是failed +print(ret.message); +``` + +#### verify + +验签。 + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | content | 字符串类型 待验签的内容 | +| 2 | signature | 字符串类型 签名 | +| 3 | publicKey | 字符串类型 公钥 | + +##### 使用示例 + +```javascript +var ret = SM2Util.verify("Hello","....签名","...公钥"); +// 验证通过时，result为true，status为success +// 失败时，result为failed，status为failed +print(ret.status); +print(ret.result); +``` + +#### encrypt + +sm2加密。 + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | content | 字符串类型 待验签的内容 | +| 3 | publicKey | 字符串类型 公钥 | + +##### 使用示例 + +```javascript +var ret = SM2Util.encrypt("Hello","...公钥"); +print(ret); +``` +#### decrypt + +sm2解密。 + +##### 参数 + +| 序号 | 参数 | 说明 | +|---|---|---| +| 1 | content | 字符串类型 待验签的内容 | +| 3 | privateKey | 字符串类型 公钥 | + +##### 使用示例 + +```javascript +var ret = SM2Util.decrypt("Hello","...私钥"); +print(ret); +``` + + + +## 多线程工具类 + +### AsyncUtil + +可以使用@Permission("Async")来引入AsyncUtil对象。 +``` +@Permission("Async") +contract AsyncExample{ + export function longTimeTask(arg){ + var a = { + }; + a.count = 100; + AsyncUtil.postFunction(taskFun,a); + } + function taskFun(arg){ + Global.progress = 0; + for (var i=0;i + +* Number + +* Math + +* Date + +* RegExp + +* Error + +* JSON + +## YJS应用框架 + +### ypk项目组成 +如之前描述，ypk中可存放静态资源文件（html/css/js)，在智能合约中声明loadResource方法，可返回静态资源文件。 +基于loadResource，本项目提供了一个yjs应用框架。 +该框架可以将合约ypk中的(html/css/js)文件通过executeContract调用，加载至前端并展示。 + +### 函数约定 + +| 序号 | 合约函数名 | 说明 | +|---|---|---| +| 1 | needRender | 不会被调用，有该函数表示需要渲染前端 | +| 2 | getMainFrame | 无参数，返回结果为String类型，表示主页的html文件路径 | +| 3 | loadResource | 参数为String，以文本形式，返回相对路径下的静态资源文件 | + +### 加载流程 +前端加载的参数会解析至global.urlparam。 +包括以下参数： +``` +//global.urlparam对象示例 +{ + "contract":"TrustedStorage0899", //表示合约ID或是合约的名称 + + "keys":{ //表示当前登录者的密钥对 + "privateKey":"ff38dd04710...", + "publicKey":"04fc228..." + }, + "nodeAddr":"022.node.internetapi.cn:21030" //节点的ip+端口 +} +``` + +加载前会先建立与nodeAddr的websocket连接。 +连接建立后，加载流程分为两步： +第一步是用当前的publickey-privatekey登录。登录过程详见`BDContract SDK` 的 `合约节点WebSocket接口` +登录之后，会获取合约的信息。 +并存放于global.currentContract对象。 + +第二步，是根据global.currentContract对象中，是否有needRender方法， +如果有，就会进入加载前端代码的流程。 +具体为1.执行executeCurrentContract("getMainFrame") 获取页面的html，append至mainDIV之后， +会解析所有` + + +``` +示例的资源文件"/html/hello.js"如下： + +```javascript +var queryDataFromContract = function(){ + //第一个参数为函数名，第二个为参数，第三个参数为回调。 + var data = executeCurrentContract("query","abc",function(argg){ + $("#resultText")[0].innerHTML = argg.result; + }); +} +``` + +参考示例： + + + + +### YJS-Python + +TODO + diff --git a/source/markdown_ZRYH/conf.py b/source/markdown_ZRYH/conf.py new file mode 100644 index 0000000..27683b6 --- /dev/null +++ b/source/markdown_ZRYH/conf.py @@ -0,0 +1,100 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- +project = '智融云河大数据区块链' +copyright = '2021, ZRYH' +author = 'ZRYH' + +# The full version, including alpha/beta/rc tags +release = 'V1.0' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. + +html_theme = "sphinx_rtd_theme" +html_logo="_static/imgs/logo.png" +html_theme_options = { +'logo_only': True +} + +source_parsers = { + '.md': 'recommonmark.parser.CommonMarkParser', +} + +source_suffix = ['.rst', '.md'] + +# source_suffix = { +# '.rst': 'restructuredtext', +# '.txt': 'markdown', +# '.md': 'markdown' +# } + +extensions = [ + 'recommonmark', + 'sphinx_rtd_theme', + 'sphinx_markdown_tables' +] + +html_favicon = "_static/imgs/favicon.ico" +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = 'zh_CN' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +#html_theme = 'alabaster' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +master_doc = 'index' + + +##latex_elements = { +## 'papersize': 'a4paper', + # Additional stuff for the LaTeX preamble. +## 'preamble': ''' +##\usepackage{xeCJK} +##\usepackage{indentfirst} +##\setlength{\parindent}{2em} +##\setCJKmainfont[BoldFont=STFangsong, ItalicFont=STKaiti]{STSong} +##\setCJKsansfont[BoldFont=STHeiti]{STXihei} +##\setCJKmonofont{STFangsong} +##''', +##} \ No newline at end of file diff --git a/source/markdown_ZRYH/index.rst b/source/markdown_ZRYH/index.rst new file mode 100644 index 0000000..63327bd --- /dev/null +++ b/source/markdown_ZRYH/index.rst @@ -0,0 +1,18 @@ +.. BDContract documentation master file, created by + sphinx-quickstart on Mon Nov 25 16:23:38 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +智融云河大数据区块链-智能合约引擎 文档 +====================================== + +.. toctree:: + :maxdepth: 3 + :caption: 目录 + + Introduction.rst + InstallTips.rst + IDEUsage.rst + ContractAPI.rst + YJSInDepth.rst + YJSAPI.rst \ No newline at end of file diff --git a/toRst.sh b/toRst.sh index 674449d..9734c3c 100644 --- a/toRst.sh +++ b/toRst.sh @@ -6,14 +6,27 @@ rm -rf InstallTips.rst rm -rf Introduction.rst rm -rf YJSAPI.rst rm -rf YJSInDepth.rst +rm -rf conf.py +rm -rf index.rst -pandoc ./markdown/ContractAPI.md -f markdown -t rst -o ContractAPI.rst -pandoc ./markdown/IDEUsage.md -f markdown -t rst -o IDEUsage.rst -pandoc ./markdown/InstallTips.md -f markdown -t rst -o InstallTips.rst -pandoc ./markdown/Introduction.md -f markdown -t rst -o Introduction.rst -pandoc ./markdown/YJSAPI.md -f markdown -t rst -o YJSAPI.rst -pandoc ./markdown/YJSInDepth.md -f markdown -t rst -o YJSInDepth.rst - +if [ $# -lt 1 ]; then + export src=./markdown +elif [ $1 == "zryh" ] ; then + export src=./markdown_ZRYH +elif [ $1 == "bdware" ] ; then + export src=./markdown_BDWare +else + echo "error arguments, use ./markdown" + export src=./markdown +fi +cp ${src}/conf.py ./conf.py +cp ${src}/index.rst ./index.rst +pandoc ${src}/ContractAPI.md -f markdown -t rst -o ContractAPI.rst +pandoc ${src}/IDEUsage.md -f markdown -t rst -o IDEUsage.rst +pandoc ${src}/InstallTips.md -f markdown -t rst -o InstallTips.rst +pandoc ${src}/Introduction.md -f markdown -t rst -o Introduction.rst +pandoc ${src}/YJSAPI.md -f markdown -t rst -o YJSAPI.rst +pandoc ${src}/YJSInDepth.md -f markdown -t rst -o YJSInDepth.rst cd .. make clean make html