repchain/README.md
zhengls 60aa1ab417
update README.md.
更新UI图

Signed-off-by: zhengls <737016271@qq.com>
2023-02-17 01:15:17 +00:00

61 lines
5.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# RepChain
[RepChain文档](https://gitee.com/BTAJL/repchain/attach_files) [单机多节点部署](https://iscas1-my.sharepoint.cn/:v:/g/personal/zhengls_iscas1_partner_onmschina_cn/EaghaEdYxndOm1f7H01RNVoBRqWm7v5kCFXUZ4QwVVP7Wg?e=fIa58e) [多机多节点部署](https://iscas1-my.sharepoint.cn/:v:/g/personal/zhengls_iscas1_partner_onmschina_cn/Ebk4-kDPg25KjE-9oSBKTuEBwD9pTJeQAgal_AYquLPHzg?e=D9tQNF)
## 参考阅读
- [akka](https://akka.io/) ——系统内部模块采用akka actor实现
- [akka remoting security](http://doc.akka.io/docs/akka/current/scala/remoting.html) ——节点之间安全通信采用akka Remote支持的TLS
- [akka serialization](http://doc.akka.io/docs/akka/current/scala/serialization.html)——节点之间消息交互采用protobuf序列化
- [scalaPB](https://scalapb.github.io/)——从proto定义生成Scala类的工具
- [protobufjs](https://github.com/dcodeIO/ProtoBuf.js/)——在web端根据proto定义反序列化protobuf字节流
- [swagger-scala](https://github.com/swagger-api/swagger-scala-module)——API支持Swagger UI
- [json4s](https://github.com/json4s/json4s)——在API层提供输入对象的json反序列化返回结果的json序列化
- [d3.js-force layout](https://github.com/d3/d3-3.x-api-reference/blob/master/Force-Layout.md)——入/离网节点的自动布局
- [leveldb for java](https://github.com/dain/leveldb)——存取Blocks、Transactions索引
- [java security](http://docs.oracle.com/javase/8/docs/technotes/guides/security/index.html)——hash、签名、密钥对及证书管理均采用jdk内置方法
## 安装
- install [zuluJdk11+](https://www.azul.com/downloads/zulu-community/?&architecture=x86-64-bit&package=jdk)
- install [Python](http://www.python.org/downloads/)
- install [Scala](https://www.scala-lang.org/download/)
- install [SBT](http://www.scala-sbt.org/release/docs/Setup.html)
- install [Idea IDE](https://www.jetbrains.com/idea/download/#section=windows)
- install [keystore-explorer](http://keystore-explorer.org/) ——用于生成密钥对的工具,非必须
- install [protobuf editor](https://github.com/Enide/polyglot-maven-editors)——编辑protobuf定义工具非必须
## 分层架构
![RepChain系统分层图](https://images.gitee.com/uploads/images/2021/1108/113550_715354a6_1598833.png "RepChain系统分层图.png")
- 数据层负责数据格式定义数据结构采用Protocol Buffers定义文件并以此为基础实现数据的交换、验证、存储、读取及检索
- 网络层采用JDK内置的TLS实现支持入网许可验证在此基础上进行去中心化的gossip组网网络传播支持P2P和Pub/Sub两种方式
- 共识层完成区块的输入共识和输出共识。采用兼顾实时性和安全性的CFRD算法既照顾到交易的实时性要求又能在一定程度防止节点串通作弊输入共识对入块的交易顺序达成一致输出共识对交易顺序执行的结果达成一致
- 合约层:为合约执行提供上下文环境,支持合约的动态部署、运行时加载和编译执行
- API层提供外部接口允许第三方应用以Restful的形式与系统交互并允许开发者通过Swagger UI进行在线测试。API层提供交易签名提交、区块和交易检索等基本功能
- 监控层:在区块链网络中收集事件/日志,并将其以Protocol Buffers的格式推送至Web端,以H5图形技术进行实时状态的可视化展示和日志回放
## 运行
- ` 下载项目到本地`
- git clone https://gitee.com/BTAJL/repchain.git
- `导入`
- 打开Idea IDEFile->New->Project or Project from VersionControl
- 使用Idea的sbt插件导入
- 使用sbt shell 进行compile
- 右键单击 rep.app.Repchain.scalaRun 'RepChain'(单机组网4个节点)
- 运行配置VM参数 -Dlogback.configurationFile=conf/logback.xml (使logback配置生效)
- 查看实时图 http://localhost:8081/web/g1.html
![实时状态图](https://images.gitee.com/uploads/images/2020/0114/174424_b02748a4_1598833.gif)
- 查看API http://localhost:8081/swagger/index.html
![Swagger-UI](![输入图片说明](swagger-ui.png))
## 修改配置
- 生成RepChain节点密钥对及信任证书列表见[《RepChain开发者指南》](https://gitee.com/BTAJL/repchain/attach_files/235993/download) 2.1.5
- 制作创世区块(见[《RepChain开发者指南》](https://gitee.com/BTAJL/repchain/attach_files/235993/download) 2.1.6
- 调整系统配置参数(见[《RepChain开发者指南》](https://gitee.com/BTAJL/repchain/attach_files/235993/download) 2.1.7
## 打包
- assembly
- 打包成jar包进行分布式部署
## 示范应用
- [BAR](https://gitee.com/linkel/bar)(Base App of RepChain):提供了通用的基础功能实现,区块链应用实施者既可以直接复用其提供的功能, 也可以在其源代码的基础上进行开发快速开发自己的DAppp
- [SBR](https://gitee.com/JayTsang/bar)(Storage Based on RepChain)基于BAR开发的可举证云存储应用示例
- [CRBB](https://gitee.com/linkel/CRBBV1.0)(Copyright Register Based on Blockchain)基于RepChain的数字版权登记保护应用示例