14 |
15 | 具体部署可以参考《WeBASE管理平台使用说明》中[手动搭建](../WeBASE-Console-Suit/index.html#id9)部分。
16 |
17 | ## 2、使用手册
18 | WeBASE管理平台的使用请查看[使用手册](../WeBASE-Console-Suit/index.html)。
19 |
--------------------------------------------------------------------------------
/docs/WeBASE-Install/index.md:
--------------------------------------------------------------------------------
1 | # 安装部署
2 |
3 | **硬件要求：**
4 |
5 | | 配置 | 最低配置 | 推荐配置 |
6 | | ---- | -------- | -------- |
7 | | CPU | 1.5GHz | 2.4GHz |
8 | | 内存 | 4GB | 8GB |
9 | | 核心 | 1核 | 4核 |
10 | | 带宽 | 1Mb | 10Mb |
11 |
12 |
13 | 快速入门：开发者只需要搭建节点和节点前置服务(WeBASE-Front)，就可通过WeBASE-Front的合约编辑器进行合约的编辑，编译，部署，调试。
14 |
15 | 一键部署：通过一键脚本，可以搭建一个WeBASE的基础环境，可以方便用户体验WeBASE核心功能如：区块浏览，节点查看，合约IDE，交易审计，私钥管理。
16 |
17 | 企业部署：在生产环境中，建议用户参考详细安装，部署全部功能，保证系统高效和稳定。
18 |
19 | 可视化部署：先部署 WeBASE 服务，然后通过可视化的界面操作来部署区块链底层（FISCO-BCOS 节点），完成区块链的部署操作，适用于本机部署，多主机部署场景。
20 |
21 | ```eval_rst
22 | .. toctree::
23 | :maxdepth: 1
24 |
25 | ../WeBASE-Install/developer.md
26 | ../WeBASE/install.md
27 | ../WeBASE-Install/enterprise.md
28 | ../WeBASE-Install/visual_deploy.md
29 | ../WeBASE-Install/docker_install.md
30 | ../WeBASE-Install/upgrade.md
31 | ../WeBASE/mirror.md
32 |
33 | ```
34 |
--------------------------------------------------------------------------------
/docs/WeBASE-Node-Manager/README.md:
--------------------------------------------------------------------------------
1 | # 概要介绍
2 |
3 | ## 1. 功能说明
4 |
5 | WeBASE-Node-Manager可以是处理前端页面所有web请求，管理各个节点的状态，管理链上所有智能合约，对区块链的数据进行统计、分析，对异常交易的审计，私钥管理等，含有如下功能模块：
6 |
7 | | 序号 | 模块 | 描述 |
8 | |-------|---------------------------|----------------------|
9 | | 1 | 前置管理模块 | 维护关联WeBASE-Front服务信息 |
10 | | 2 | 交易信息模块 | 查看交易信息 |
11 | | 3 | 帐号管理模块 | 维护系统登录账号信息 |
12 | | 4 | 区块管理模块 | 查看区块信息 |
13 | | 5 | 合约管理模块 | 维护合约信息 |
14 | | 6 | 服务器监控 | 监控节点服务器状态与邮件告警 |
15 | | 7 | 审计模块 | 查看异常合约及异常用户信息 |
16 | | 8 | 群组信息模块 | 查看群组信息 |
17 | | 9 | 节点管理模块 | 查看节点信息 |
18 | | 10 | 角色管理模块 | 查看系统登录用户的角色信息 |
19 | | 11 | 用户管理模块 | 维护密钥信息 |
20 | | 12 | 合约方法管理模块 | 维护合约abi文件中所包含的的方法信息 |
21 | | 13 | 系统管理模块 | 预编译API，包含权限管理，节点管理，CNS管理等信息 |
22 | | 14 | 证书管理模块 | 查看sdk证书、节点证书等信息 |
23 | | 15 | 订阅事件模块 | 查看已订阅的链上事件通知信息 |
24 | | 16 | 可视化部署模块 | 可视化部署底层区块链服务以及节点的管理 |
25 | | 17 | 应用管理模块 | 维护应用接入信息 |
26 |
27 | ## 2. 国密支持
28 |
29 | WeBASE-Node-Manager v1.2.2+已支持 [国密版FISCO-BCOS](https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/manual/guomi_crypto.html)，使用WeBASE-Front v1.2.2及以上版本
30 |
31 | WeBASE-Node-Manager具体需要适配国密版FISCO-BCOS与WeBASE-Front的地方有：
32 | - 在配置文件`application.yml/applicationContext.xml`中开启sdk的国密开关；
33 | - 国密版部署初始化数据库时，执行国密版的初始化脚本`script/gm/webase-gm.sh`；
34 |
35 | 安装详情可查看下一章节的[WeBASE-Node-Manager部署说明](install.html)
36 |
--------------------------------------------------------------------------------
/docs/WeBASE-Node-Manager/index.md:
--------------------------------------------------------------------------------
1 | # 节点管理服务
2 |
3 | ```eval_rst
4 | .. toctree::
5 | :maxdepth: 1
6 |
7 | README.md
8 | install.md
9 | interface.md
10 | upgrade.md
11 | appendix.md
12 | ```
13 |
--------------------------------------------------------------------------------
/docs/WeBASE-Node-Manager/install_FAQ.md:
--------------------------------------------------------------------------------
1 | ## 常见问题解答
2 |
3 | ### 一般问题
4 | * 问：执行shell脚本报下面错误：
5 | ```
6 | [app@VM_96_107_centos deployInputParam]$ bash start.sh
7 | start.sh: line 2: $'\r': command not found
8 | start.sh: line 8: $'\r': command not found
9 | start.sh: line 9: $'\r': command not found
10 | start.sh: line 10: $'\r': command not found
11 | ```
12 | 答：这是编码问题，在脚本的目录下执行转码命令：
13 | ```shell
14 | dos2unix *.sh
15 | ```
16 |
17 |
18 | ### 数据库问题
19 | * 问：执行数据库初始化脚本抛出异常：
20 | ```
21 | ERROR 2003 (HY000): Can't connect to MySQL server on '127.0.0.1' (110)
22 | ```
23 | 答：MySQL没有开通该帐号的远程访问权限，登录MySQL，执行如下命令，其中TestUser改为你的帐号
24 | ```
25 | GRANT ALL PRIVILEGES ON *.* TO 'TestUser'@'%' IDENTIFIED BY '此处为TestUser的密码’' WITH GRANT OPTION;
26 | ```
27 |
28 |
29 | ### 服务搭建问题
30 | * 问：执行构建命令`gradle build -x test`抛出异常：
31 | ```
32 | A problem occurred evaluating root project 'WeBASE-Node-Manager'.
33 | Could not find method compileOnly() for arguments [[org.projectlombok:lombok:1.18.2]] on root project 'WeBASE-Node-Manager'.
34 | ```
35 | 答：
36 | 方法1、已安装的Gradle版本过低，升级Gradle版本到4.10以上即可。
37 | 方法2、直接使用命令：`./gradlew build -x test`
38 |
39 |
40 | * 问：服务能正常运行，但调用获取验证码接口就报错，然后服务就停止：
41 | ```
42 | symbol lookup error: /lib64/libfontconfig.so.1: undefined symbol: FT_Get_Advances
43 | ```
44 | 答：
45 | 1、尽量选择【[sunJDK](https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)】，而不是openJDK（有些服务器受有影响）
46 | 2、检查jdk的位数是否跟当前系统支持的一致。
47 | 3、安装gcc和gcc-c++
48 |
49 | ```
50 | yum -y install gcc
51 | yum -y install gcc-c++
52 | ```
53 |
54 | * 问：服务报错：
55 | ```
56 | -bash: /opt/java/jdk1.8.0_211/bin/java: /lib/ld-linux.so.2: bad ELF interpreter: No such file or directory
57 | ```
58 | 答：安装libgcc.i686：
59 | ```
60 | yum install libgcc.i686 --setopt=protected_multilib=false
61 | ```
62 |
63 | * 问：集群环境下，成功的登录，但登录状态无效：
64 |
65 | 答：更改nginx服务配置文件，加上ip_hash,如：
66 |
67 | ```
68 | upstream /mgr {
69 | server localhost:80;
70 | server 127.0.0.1:80;
71 | ip_hash;
72 | }
73 | ```
--------------------------------------------------------------------------------
/docs/WeBASE-Sign/README.md:
--------------------------------------------------------------------------------
1 | # 概要介绍
2 |
3 | ## 功能介绍
4 | 本系统为签名服务子系统。功能：管理公私钥、对数据进行签名。
5 |
6 | ## 国密支持
7 |
8 | WeBASE-Sign v1.2.2+已支持 [国密版FISCO-BCOS](https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/manual/guomi_crypto.html)，使用WeBASE v1.2.2及以上版本
9 |
10 | **本系统同时支持国密与非国密，分别提供了ECDSA与国密两类接口，可生成/管理ECDSA和国密公私钥用户，可对数据进行国密或非国密的签名**
11 |
12 |
--------------------------------------------------------------------------------
/docs/WeBASE-Sign/index.md:
--------------------------------------------------------------------------------
1 | # 签名服务
2 |
3 | ```eval_rst
4 | .. toctree::
5 | :maxdepth: 1
6 |
7 | README.md
8 | install.md
9 | interfaces.md
10 | upgrade.md
11 | appendix.md
12 | ```
--------------------------------------------------------------------------------
/docs/WeBASE-Sign/install.md:
--------------------------------------------------------------------------------
1 | # 部署说明
2 |
3 | ## 1. 前提条件
4 |
5 | | 环境 | 版本 |
6 | | ------ | ------------------- |
7 | | Java | Java1.8或以上版本 |
8 | | 数据库 | MySQL-5.6或以上版本 |
9 |
10 | 备注：安装说明请参看 [附录-1](./appendix.html#id2)。
11 |
12 |
13 |
14 | ## 2. 拉取代码
15 |
16 | 执行命令：
17 | ```shell
18 | git clone https://github.com/WeBankBlockchain/WeBASE-Sign.git
19 |
20 | # 若因网络问题导致长时间下载失败，可尝试以下命令
21 | git clone https://gitee.com/WeBank/WeBASE-Sign.git
22 | ```
23 |
24 | 进入目录：
25 |
26 | ```
27 | cd WeBASE-Sign
28 | ```
29 |
30 | ## 3. 编译代码
31 |
32 | 方式一：如果服务器已安装Gradle，且版本为gradle-4.10至gradle-6.x版本
33 |
34 | ```shell
35 | gradle build -x test
36 | ```
37 | 方式二：如果服务器未安装Gradle，或者版本不是gradle-4.10至gradle-6.x版本，使用gradlew编译
38 | ```shell
39 | chmod +x ./gradlew && ./gradlew build -x test
40 | ```
41 | 构建完成后，会在根目录WeBASE-Sign下生成已编译的代码目录dist。
42 |
43 |
44 | ## 4. 数据库初始化
45 | ```
46 | #登录MySQL:
47 | mysql -u ${your_db_account} -p${your_db_password} 例如：mysql -u root -p123456
48 | #新建数据库：
49 | CREATE DATABASE IF NOT EXISTS {your_db_name} DEFAULT CHARSET utf8 COLLATE utf8_general_ci;
50 | ```
51 |
52 | ## 5. 修改配置
53 |
54 | （1）进入dist目录
55 |
56 | ```
57 | cd dist
58 | ```
59 |
60 | dist目录提供了一份配置模板conf_template：
61 |
62 | ```
63 | 根据配置模板生成一份实际配置conf。初次部署可直接拷贝。
64 | 例如：cp conf_template conf -r
65 | ```
66 |
67 | （2）修改配置（根据实际情况修改）：
68 |
69 | ```shell
70 | vi conf/application.yml
71 | ```
72 |
73 | ```
74 | server:
75 | # 本工程服务端口，端口被占用则修改
76 | port: 5004
77 | context-path: /WeBASE-Sign
78 |
79 | spring:
80 | datasource:
81 | # 数据库连接信息
82 | url: jdbc:mysql://127.0.0.1:3306/webasesign?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf8
83 | # 数据库用户名
84 | username: "dbUsername"
85 | # 数据库密码
86 | password: "dbPassword"
87 | driver-class-name: com.mysql.cj.jdbc.Driver
88 |
89 | constant:
90 | # aes加密key(16位)，如启用，各互联的子系统的加密key需保持一致
91 | aesKey: EfdsW23D23d3df43
92 |
93 | ```
94 |
95 |
105 |
106 | ## 5. 服务启停
107 |
108 | 在dist目录下执行：
109 |
110 | ```shell
111 | 启动：bash start.sh
112 | 停止：bash stop.sh
113 | 检查：bash status.sh
114 | ```
115 | **备注**：服务进程起来后，需通过日志确认是否正常启动，出现以下内容表示正常；如果服务出现异常，确认修改配置后，重启提示服务进程在运行，则先执行stop.sh，再执行start.sh。
116 |
117 | ```
118 | ...
119 | Application() - main run success...
120 | ```
121 |
122 | ## 6. 查看日志
123 |
124 | 在dist目录查看：
125 | ```shell
126 | 全量日志：tail -f log/WeBASE-Sign.log
127 | 错误日志：tail -f log/WeBASE-Sign-error.log
128 | ```
--------------------------------------------------------------------------------
/docs/WeBASE-Sign/upgrade.md:
--------------------------------------------------------------------------------
1 | # 升级说明
2 |
3 | WeBASE-Sign升级的兼容性说明，请结合[WeBASE-Sign Changelog](https://github.com/WeBankBlockchain/WeBASE-Sign)进行阅读
4 |
5 | WeBASE-Sign升级的必须步骤：
6 | 1. 备份已有文件或数据，下载新的安装包（可参考[安装包下载](../WeBASE/mirror.html#install_package)）
7 | 2. 使用新的安装包，并将旧版本yml已有配置添加到新版本yml中；可通过`diff aFile bFile`命令对比新旧yml的差异
8 | 3. 查看[签名服务升级文档](../WeBASE-Sign/upgrade.html)中对应版本是否需要修改数据表，若不需要升级则跳过
9 | 3.1 若需要升级数据表，首先使用`mysqldump`命令备份数据库
10 | 3.2 按照升级文档指引，操作数据表
11 | 4. `bash stop.sh && bash start.sh`重启
12 |
13 | 各个版本的具体修改可参考下文
14 |
15 | #### v1.5.3
16 | - 新增私钥托管与签名服务Docker镜像，`webasepro/webase-sign:v1.5.3`
17 |
18 |
19 | #### v1.5.0
20 |
21 | - 支持导出私钥，增加配置项`supportPrivateKeyTransfer: true`，接口支持私钥传输（aes加密后的私钥），配置项为`false`时不支持导出
22 | - jar包升级：mysql-connector-java:8.0.22、bcprov-jdk15on:1.67
23 | - 修复ECDSA签名结果序列化bug
24 |
25 | #### v1.4.3
26 | - 增加数据签名接口
27 |
28 | #### v1.4.2
29 | - 使用新版java-sdk替换web3sdk
30 |
31 | #### v1.4.0
32 | - 增加返回 WeBASE-Sign 版本号接口
33 | - 默认Aes加密模式由`ECB`改为更安全的`CBC`，同时支持在yml配置中选择CBC与ECB
34 |
35 | #### v1.3.2
36 | - 移除Fastjson，替换为Jackson 2.11.0。
37 | - 升级web3sdk为2.4.1，并升级springboot等依赖项
38 |
39 | #### v1.3.1
40 | - 新增`/user/import`接口，支持导入私钥，详情参考[接口文档](./interfaces.html)
41 | - 新增`Credential`实例的缓存机制，优化签名性能
42 |
43 | #### v1.3.0
44 |
45 | ##### 私钥数据表字段更新
46 | - WeBASE-Sign的tb_user表新增两个字段: 私钥用户的唯一业务编号`signUserId`，和私钥用户所属应用编号`appId`
47 |
48 | **升级操作说明**
49 |
50 | 如果WeBASE-Sign中有已存在的私钥数据，则在`tb_user`表新增列`sign_user_id`和`app_id`后，还需要赋予其初始值，且`sign_user_id`需赋予唯一值
51 |
52 | 登陆mysql后，进入到相应database中，以`webasesign`的database为例；
53 | ```
54 | mysql -uroot -p123456
55 |
56 | // mysql 命令行
57 | mysql> use webasesign;
58 |
59 | // 在tb_user中添加列
60 | mysql> alter table tb_user add column sign_user_id varchar(64) not null;
61 | mysql> alter table tb_user add column app_id varchar(64) not null;
62 |
63 | // 添加sign_user_id的唯一约束
64 | mysql> alter table tb_user add unique key unique_uuid (sign_user_id);
65 |
66 | ```
67 |
68 | **如果仅将WeBASE-Node-Manager的私钥迁移至WeBASE-Sign中，则无需进行下面的sign_user_id赋值操作**
69 |
70 | 如果有已存在的user的sign_user_id和app_id赋值，sign_user_id赋予唯一的随机值即可；
71 |
72 | ```
73 | // app_id可以设置为一样，也可根据user具体标签赋予不同的app_id值
74 | mysql> update tb_user set app_id = 'app_default' where 1=1;
75 | // 为每个user的sign_user_id设置一个唯一的随机值
76 | mysql> update tb_user set sign_user_id = '{yourValue}'' where user_id = '{yourUserId}';
77 | ```
78 |
79 |
80 | ##### API更新
81 | - WeBASE-Sign的新建私钥接口`/user/newUser`需传入`signUserId`, `appId`才可新建用户，且可以传值`encryptType`指定该用户的类型为ECDSA或国密算法；
82 |
83 | 值得注意的是，现在WeBASE-Sign新建私钥用户后，不再返回`privateKey字段`，即私钥不离开WeBASE-Sign数据库。
84 |
85 | - WeBASE-Sign的数据签名接口`/sign`传参修改，原用的`userId`改为传入`signUserId`，签名时会根据user的类型选择ECDSA或国密算法进行签名；
86 |
87 | - WeBASE-Sign新增停用用户的接口`/user`(DELETE)，可根据`signUserId`停用相应用户；
88 |
--------------------------------------------------------------------------------
/docs/WeBASE-Stat/README.md:
--------------------------------------------------------------------------------
1 | # 概要介绍
2 | WeBASE-Stat为微众区块链中间件平台-数据统计服务子系统，统计数据服务以前置为基础，拉取CPU、内存、IO、群组大小、群组gas、群组网络流量的数据，记录数据库。主要包括以下模块：
3 |
4 | | 序号 | 模块 | 描述 |
5 | | ---- | -------- | ------------------------------------------------------------ |
6 | | 1 | 前置管理 | 维护WeBASE-Front服务信息，可以新增、查询和删除前置（调用请查看接口说明1） |
7 | | 2 | 群组管理 | 查询前置群组信息（调用请查看接口说明2） |
8 | | 3 | 数据管理 | 查询统计数据信息（调用请查看接口说明3）、定时拉取数据（后台定时处理） |
9 |
10 | 部署和接口说明如下：
11 |
12 | - [部署说明](./install.md)
13 |
14 | - [接口说明](./interface.md)
15 |
--------------------------------------------------------------------------------
/docs/WeBASE-Stat/index.md:
--------------------------------------------------------------------------------
1 | # 数据统计服务
2 |
3 | ```eval_rst
4 | .. toctree::
5 | :maxdepth: 1
6 |
7 | README.md
8 | install.md
9 | interface.md
10 | appendix.md
11 | ```
12 |
--------------------------------------------------------------------------------
/docs/WeBASE-Stat/install.md:
--------------------------------------------------------------------------------
1 | # 部署说明
2 |
3 | ## 1. 前提条件
4 |
5 | | 序号 | 软件 |
6 | | ---- | ------------------- |
7 | | 1 | FISCO-BCOS 2.7+|
8 | | 2 | WeBASE-Front 1.4.0+|
9 | | 3 | MySQL5.6或以上版本 1.4.0+|
10 | | 4 | Java8或以上版本 |
11 |
12 |
13 | ## 2. 注意事项
14 | * Java推荐使用[OracleJDK](https://www.oracle.com/technetwork/java/javase/downloads/index.html)，[JDK配置指引](./appendix.html#jdk)
15 | * 安装mysql可以参考 [mysql安装示例](./appendix.html#mysql)
16 | * 在服务搭建的过程中，如碰到问题，请查看 [常见问题解答](./appendix.html#q&a)
17 | * 安全温馨提示： 强烈建议设置复杂的数据库登录密码，且严格控制数据操作的权限和网络策略
18 |
19 | ## 3. 拉取代码
20 | 执行命令：
21 | ```shell
22 | git clone https://github.com/WeBankBlockchain/WeBASE-Stat.git
23 |
24 | # 若因网络问题导致长时间下载失败，可尝试以下命令
25 | git clone https://gitee.com/WeBank/WeBASE-Stat.git
26 | ```
27 | 进入目录：
28 |
29 | ```shell
30 | cd WeBASE-Stat
31 | ```
32 |
33 | ## 4. 编译代码
34 |
35 | 方式一：如果服务器已安装Gradle，且版本为gradle-4.10至gradle-6.x版本。
36 | * 安装gradle可以参考 [gradle安装示例](./appendix.html#gradle)
37 |
38 | ```shell
39 | gradle build -x test
40 | ```
41 |
42 | 方式二：如果服务器未安装Gradle，或者版本不是gradle-4.10至gradle-6.x版本，使用gradlew编译
43 |
44 | ```shell
45 | chmod +x ./gradlew && ./gradlew build -x test
46 | ```
47 |
48 | 构建完成后，会在根目录WeBASE-Stat下生成已编译的代码目录dist。
49 |
50 | ## 5. 数据库初始化
51 | ### 5.1 新建数据库
52 | ```
53 | #登录MySQL: 例如：mysql -u root -p123456
54 | mysql -u ${your_db_account} -p${your_db_password}
55 | #新建数据库：默认数据库名为webasestat
56 | CREATE DATABASE IF NOT EXISTS {your_db_name} DEFAULT CHARSET utf8 COLLATE utf8_general_ci;
57 | ```
58 |
59 | ## 6. 服务配置及启停
60 |
61 | ### 6.1 服务配置修改
62 | （1）回到dist目录，dist目录提供了一份配置模板conf_template：
63 |
64 | ```
65 | 根据配置模板生成一份实际配置conf。初次部署可直接拷贝。
66 | 例如：cp conf_template conf -r
67 | ```
68 |
69 | （2）修改服务配置，完整配置项说明请查看 [配置说明](./appendix.html#application-yml)
70 | ```shell
71 | 修改服务端口：sed -i "s/5008/${your_server_port}/g" conf/application.yml
72 | 修改数据库IP：sed -i "s/127.0.0.1/${your_db_ip}/g" conf/application.yml
73 | 修改数据库端口：sed -i "s/3306/${your_db_port}/g" conf/application.yml
74 | 修改数据库名称：sed -i "s/webasestat/${your_db_name}/g" conf/application.yml
75 | 修改数据库用户：sed -i "s/defaultAccount/${your_db_account}/g" conf/application.yml
76 | 修改数据库密码：sed -i "s/defaultPassword/${your_db_password}/g" conf/application.yml
77 | ```
78 |
79 | ### 6.2 服务启停
80 | 在dist目录下执行：
81 | ```shell
82 | 启动：bash start.sh
83 | 停止：bash stop.sh
84 | 检查：bash status.sh
85 | ```
86 | **备注**：服务进程起来后，需通过日志确认是否正常启动，出现以下内容表示正常；如果服务出现异常，确认修改配置后，重启。如果提示服务进程在运行，则先执行stop.sh，再执行start.sh。
87 |
88 | ```
89 | ...
90 | Application() - main run success...
91 | ```
92 |
93 | ## 7. 访问
94 |
95 | 可以通过swagger查看调用接口：
96 |
97 | ```
98 | http://{deployIP}:{deployPort}/WeBASE-Stat/swagger-ui.html
99 | 示例：http://localhost:5008/WeBASE-Stat/swagger-ui.html
100 | ```
101 |
102 | **备注：**
103 |
104 | - 部署服务器IP和服务端口需对应修改，网络策略需开通
105 |
106 | ## 8. 查看日志
107 |
108 | 在dist目录查看：
109 | ```shell
110 | 全量日志：tail -f log/WeBASE-Stat.log
111 | 错误日志：tail -f log/WeBASE-Stat-error.log
112 | ```
113 |
--------------------------------------------------------------------------------
/docs/WeBASE-Training-Class/index.md:
--------------------------------------------------------------------------------
1 | # WeBASE实训课程案例
2 |
3 | WeBASE智能合约的实训课程案例集，可结合WeBASE完成实训课程与题目设计。
4 |
5 |
6 | ```eval_rst
7 | .. toctree::
8 | :maxdepth: 1
9 |
10 | ./index.md
11 | ./training/01-HelloWorld.md
12 | ./training/02-Transfer.md
13 | ./training/03-Evidence.md
14 |
15 | ```
16 |
--------------------------------------------------------------------------------
/docs/WeBASE-Training-Class/training/02-Transfer.md:
--------------------------------------------------------------------------------
1 | # 实训二：实现积分转账合约
2 |
3 | 使用Solidity语言编写一个Asset积分合约，合约包含一个address变量记录发行者issuer、一个mapping(address => uint256)变量balances记录各地址的余额、一个issue方法和一个send方法。
4 | 1. 构造函数初始化issuer变量为合约部署者
5 | 2. 提供issue方法给特定账户地址发行一定数量的积分，且只有部署合约的issuer才能调用isser方法
6 | 3. 提供send方法将调用方余额转账给接收方
7 |
8 | 例：
9 | ```js
10 | pragma solidity ^0.4.25;
11 | contract Asset {
12 | address public issuer;
13 | mapping (address => uint) public balances;
14 |
15 | constructor() ...
16 | function issue() public ...
17 | function send() public ...
18 | }
19 | ```
20 |
21 | ## 实验步骤：
22 | #### 1）准备好区块链运行环境
23 | 使用FISCO BCOS搭建4节点的区块链，也可用系统自带的区块链。
24 |
25 | #### 2）编写智能合约
26 | 可使用系统自带的智能合约IDE编写智能合约
27 |
28 | **提交方式：**
29 | - 提交智能合约源码
30 |
31 | #### 3）编译部署智能合约
32 | 合约IDE进行编译、部署
33 |
34 | **提交方式：**
35 | - 提交合约部署成功后的交易回执截图
36 | - 提交部署成功后的智能合约截图，截图应包含合约地址
37 | - 调用合约，获取合约的issuer变量的值，提交截图
38 | - 调用issue方法，给一个地址如Alice私钥发行100个积分，提交截图
39 | - 调用合约，获取合约的balances变量中Alice的余额值，提交截图
40 |
41 |
42 | #### 4）向部署的智能合约发送交易
43 | 编写一个区块链应用程序，可以通过SDK连接区块链节点，并向智能合约发送交易。
44 |
45 | **提交方式：**
46 | - 提交Asset合约Java类截图
47 | - 调用Asset的合约Java类send方法的源代码
48 | - 通过Java调用Asset合约Java类的send方法，向issuer转账1个积分，在控制台输出交易哈希，截图并提交
49 | - 通过Java调用Asset合约Java类，获取issuer的余额，在控制台输出issuer地址和余额值，截图并提交
50 | - 通过合约IDE获取issuer余额，截图并提交
51 |
52 | #### 5）通过区块链浏览器查看交易
53 |
54 | 发送的交易（交易哈希）可通过系统自带的区块链浏览器展示，确认在哪个区块中。
55 |
56 | ## 参考答案：
57 | #### 1）准备好区块链运行环境
58 | 略
59 | #### 2） 编写智能合约
60 | - 要求constructor设置issuer为合约部署者msg.sender
61 | - 要求issue方法入参包含接收方address类型变量，以及发行数量uint类型
62 | - 要求issue方法中校验该方法调用者msg.sender必须是issuer
63 | - 要求issue方法给mapping变量中的接收方地址增加余额
64 | - 要求send方法入参包含接收方address类型变量，以及发行数量uint类型
65 | - 要求send方法在mapping中扣减发送方余额，且增加接收方余额
66 | - 可选项：要求send方法在扣减发送方余额前，校验发送方余额是否满足
67 |
68 | 合约源码参考答案（实现方式不唯一）
69 | ```js
70 | pragma solidity ^0.4.25;
71 |
72 | contract Asset {
73 | address public issuer;
74 | mapping (address => uint) public balances;
75 | constructor() {
76 | // 设置issuer为部署者
77 | issuer = msg.sender;
78 | }
79 | function issue(address receiver, uint amount) public {
80 | // 调用者必须是issuer
81 | if (msg.sender != issuer) return;
82 | // 增加余额
83 | balances[receiver] += amount;
84 | }
85 | function send(address receiver, uint amount) public {
86 | if (balances[msg.sender] < amount) return;
87 | balances[msg.sender] -= amount;
88 | balances[receiver] += amount;
89 | }
90 | }
91 | ```
92 |
93 | #### 3）编译部署智能合约
94 | - 要求提交成功部署合约的截图，截图包含合约的ABI，BIN和部署得到的合约地址
95 |
96 | #### 4）向部署的智能合约发送交易
97 | 使用其他编程语言实现以上功能也可，需要截图源码与调用截图
98 | - 要求提交Asset合约Java类截图，可参考WeBASE导出Java类或导出Java项目
99 | - 要求提交调用Asset的合约Java类send方法的源代码
100 | - 要求提交调用Asset的send方法，向issuer转账1个积分，并在控制台输出该交易返回的交易回执，提交交易回执截图
101 | - 要求提交调用Asset获取issuer的余额，输出issuer地址和余额值的截图
102 | - 要求提交通过合约IDE获取issuer余额的截图
103 |
104 | #### 5）通过区块链浏览器查看交易
105 | 根据步骤2可以得到在Java端调用Asset的send方法后，得到的交易哈希。拿到交易哈希后，可以通过区块链浏览器，查看交易哈希对应的交易回执的详情。
106 | - 要求区块链浏览器上查询的交易哈希与上文调用的交易哈希一致、交易的被调用方to为上文部署的合约地址
107 | - 要求交易回执的状态为成功（此处为0x0）
108 |
109 | 下图以WeBASE-Front为例，查看交易回执
110 | 
111 |
112 |
113 |
--------------------------------------------------------------------------------
/docs/WeBASE-Transaction/README.md:
--------------------------------------------------------------------------------
1 | # 概要介绍
2 |
3 | ## 功能介绍
4 |
5 | 本系统为交易上链代理子系统。主要接收无状态交易请求，缓存到数据库中，再异步上链。本系统可大幅提升吞吐量，解决区块链的tps瓶颈。
6 |
7 | 
8 |
9 | 主要功能：合约编译；交易请求处理，交易分为合约部署和普通的合约调用请求。
10 |
11 | 合约编译：上传合约文件zip压缩包（压缩包里的每个合约的文件名要和合约名一致，合约引用需使用“./xxx.sol”），返回合约编译信息。
12 |
13 | 合约部署：交易服务子系统会将合约部署请求信息缓存到数据库，通过轮询服务向节点发送交易请求，确保合约成功部署。
14 |
15 | 合约调用：分为无状态交易上链（非constant方法）和交易结果查询（constant方法）。
16 | 无状态交易上链是交易服务子系统会将交易请求信息缓存到数据库，通过轮询服务向节点发送交易请求，确保交易成功上链。
17 | 交易结果查询是交易服务子系统会同步向节点发送交易请求，返回结果。
18 |
19 | 交易上链数据签名支持以下三种模式：
20 |
21 | - 本地配置私钥签名
22 | - 本地随机私钥签名
23 | - 调用[WeBASE-Sign](https://github.com/WeBankBlockchain/WeBASE-Sign)进行签名
24 |
25 | 本工程支持单机部署，也支持分布式任务多活部署（使用分布式任务的话需部署Zookeeper）。
26 |
27 | ## 国密支持
28 |
29 | WeBASE-Transaction v1.2.2+已支持 [国密版FISCO-BCOS](https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/manual/guomi_crypto.html)，使用WeBASE v1.2.2及以上版本
30 |
31 | 具体需要适配国密版FISCO-BCOS的地方有：
32 | - 开启web3sdk的国密开关：修改`application.properties`中的`encryptType`改为`1`；
33 | - 合约编译支持国密版：
34 | - WeBASE-Transaction编译国密版智能合约，v1.3.1+版本已支持自动切换国密版soclJ jar包；
35 |
36 | 安装详情可查看下一章节的[WeBASE-Transaction部署说明](../WeBASE-Transaction/install.html)
--------------------------------------------------------------------------------
/docs/WeBASE-Transaction/architecture.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/WeBankBlockchain/WeBASE-Doc/2ec43b4f81302504ba039785a39f53868a3ceb4e/docs/WeBASE-Transaction/architecture.png
--------------------------------------------------------------------------------
/docs/WeBASE-Transaction/index.md:
--------------------------------------------------------------------------------
1 | # 交易服务
2 |
3 | ```eval_rst
4 | .. toctree::
5 | :maxdepth: 1
6 |
7 | README.md
8 | install.md
9 | interface.md
10 | appendix.md
11 | ```
12 |
13 |
--------------------------------------------------------------------------------
/docs/WeBASE-Web/README.md:
--------------------------------------------------------------------------------
1 | ## 概要介绍
2 |
3 | ### 功能说明
4 |
5 | 本项目是区块链中间件平台WeBASE管理平台，使用框架`vue-cli`。
6 |
7 | 支持FISCO-BCOS 2.0以上版本，支持群组和群组切换。具体功能有：
8 |
9 | 1. **区块链数据概览**，可以查看区块链的节点、区块、交易、合约信息。点击左上角交易信息和区块信息界面，可以跳转到区块或交易信息列表页，交易信息支持input解码和event解码。
10 |
11 | 2. **节点管理**，可以查看前置列表、节点列表、修改节点共识状态。可以查看链上的所有群组和节点，查看前置所在服务器状态相关信息，管理节点的共识状态。
12 |
13 | 3. **合约管理**，提供图形化合约IDE、查询已部署合约列表、合约CNS查询以及预编译合约的CRUD功能。编译、部署合约后该合约会被保存。
14 |
15 | 4. **私钥管理**，管理所有可以发交易的帐号，公钥用户是其他机构的帐号，无法在本机构发交易，可以通过手动绑定和自动同步获取。私钥用户为本机构发交易的用户。
16 |
17 | 5. **系统管理**，提供权限管理、系统配置管理、证书管理的功能。权限管理可以控制私钥用户的权限范围，证书管理可以查看链的相关证书。
18 |
19 | 6. **系统监控**，系统监控包含了节点监控、主机监控与异常告警。监控整条链所有机构所有用户发送交易行为，查看是否有异常用户和异常合约，并在异常状态下通过告警邮件通知运维管理员。
20 |
21 | 7. **交易审计**，主要监控整条链所有机构所有用户发送交易行为，查看是否有异常用户和异常合约。
22 |
23 | 8. **订阅事件**，查看前置已订阅的链上事件通知信息列表。
24 |
25 | 9. **帐号管理**，只有admin帐号才能查看此功能，可以新增帐号（登录此系统帐号）、修改密码、修改账户邮箱等等。
26 |
27 | 10. **群组管理**，动态管理群组，可以创建新群组、将节点加入已有群组、删除群组数据等
28 |
29 | ### 国密支持
30 |
31 | WeBASE-Web v1.2.2+已支持国密功能，使用[WeBASE-Node-Manager v1.2.2](../WeBASE-Node-Manager/index.html)，使用[WeBASE-Front v1.2.2](../WeBASE-Front/index.html)及以上版本
32 |
33 | WeBASE-Web将根据WeBASE-Node-Manager的版本，自动在国密与非国密之间切换，合约编译、合约部署、调用合约、发送交易等功能均已支持国密。
34 |
35 | ### solidity v0.5.1和v0.6.10支持
36 |
37 | WeBASE-Web v1.4.2+已支持solidity `v0.5.1`和`v0.6.10`，可在合约IDE中的左上角进行版本切换
--------------------------------------------------------------------------------
/docs/WeBASE-Web/appendix.md:
--------------------------------------------------------------------------------
1 | ## 附录
2 | ### 1 安装nginx
3 | #### 1.1 下载nginx依赖
4 | 在安装nginx前首先要确认系统中安装了gcc、pcre-devel、zlib-devel、openssl-devel。如果没有，请执行命令
5 |
6 | yum -y install gcc pcre-devel zlib-devel openssl openssl-devel
7 | 执行命令时注意权限问题，如遇到，请加上sudo
8 | #### 1.2 下载nginx
9 | nginx下载地址：https://nginx.org/download/（下载最新稳定版本即可）
10 | 或者使用命令：
11 |
12 | wget http://nginx.org/download/nginx-1.9.9.tar.gz (版本号可换)
13 | 将下载的包移动到/usr/local/下
14 | #### 1.3 安装nginx
15 | ##### 1.3.1 解压
16 | tar -zxvf nginx-1.9.9.tar.gz
17 |
18 | ##### 1.3.2 进入nginx目录
19 |
20 | cd nginx-1.9.9
21 | ##### 1.3.3 配置
22 |
23 | ./configure --prefix=/usr/local/nginx
24 |
25 | ##### 1.3.4 make
26 |
27 | make
28 | make install
29 | ##### 1.3.5 测试是否安装成功
30 | 使用命令：
31 |
32 | /usr/local/nginx/sbin/nginx -t
33 | 正常情况的信息输出：
34 |
35 | nginx: the configuration file /usr/local/nginx/conf/nginx.conf syntax is ok
36 | nginx: configuration file /usr/local/nginx/conf/nginx.conf test is successful
37 |
38 | ##### 1.3.6 nginx几个常见命令
39 | ```shell
40 | /usr/local/nginx/sbin/nginx -s reload # 重新载入配置文件
41 | /usr/local/nginx/sbin/nginx -s reopen # 重启 Nginx
42 | /usr/local/nginx/sbin/nginx -s stop # 停止 Nginx
43 | ps -ef | grep nginx # 查看nginx进程
44 | ```
45 |
46 |
47 | ### 2 常见问题
48 | #### 2.1 出现“登录错误”怎么排查问题
49 | 登录时出现“登录错误”，请一一排查：
50 | 1. WeBASE-Node-Manager服务是否启动成功，
51 | 2. WeBASE-Node-Manager的数据库是否正常，
52 | 3. nginx代理是否存在错误。
53 |
54 |
55 | #### 2.2 登录页面的验证码加载不出来
56 | * 进入 `webase-node-mgr` 目录下，执行 `bash status.sh` 检查服务是否启动，如果服务没有启动，运行 `bash start.sh` 启动服务；
57 |
58 | * 如果服务已经启动，按照如下修改日志级别
59 | * `webase-node-mgr/conf/application.yml`
60 |
61 | ```
62 | #log config
63 | logging:
64 | level:
65 | com.webank.webase.node.mgr: debug
66 | ```
67 |
68 | * `webase-node-mgr/conf/log/log4j2.xml`
69 |
70 | ```
71 |