[project] first commit

Author: bladechen

LEGAL.md

@@ -0,0 +1,7 @@
+Legal Disclaimer
+
+Within this source code, the comments in Chinese shall be the original, governing version. Any comment in other languages are for reference only. In the event of any conflict between the Chinese language version comments and other language version comments, the Chinese language version shall prevail.
+
+法律免责声明
+
+关于代码注释部分，中文注释为官方版本，其它语言注释仅做参考。中文注释可能与其它语言注释存在不一致，当中文注释与其它语言注释存在不一致时，请以中文注释为准。

LICENSE

@@ -178,15 +178,15 @@
    APPENDIX: How to apply the Apache License to your work.
 
       To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
+      boilerplate notice, with the fields enclosed by brackets "{}"
       replaced with your own identifying information. (Don't include
       the brackets!)  The text should be enclosed in the appropriate
       comment syntax for the file format. We also recommend that a
       file or class name and description of purpose be included on the
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright {yyyy} {name of copyright owner}
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -198,4 +198,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

README.md

@@ -0,0 +1,153 @@
+<div align="center">
+  <img alt="am logo" src="https://gw.alipayobjects.com/zos/bmw-prod/3ee4adc7-1960-4dbf-982e-522ac135a0c0.svg" width="250" >
+  <h1 align="center">Antchain Bridge Plugin Server</h1>
+  <p align="center">
+    <a href="http://makeapullrequest.com">
+      <img alt="pull requests welcome badge" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat">
+    </a>
+  </p>
+</div>
+
+# Introduction
+
+Antchain Bridge 插件服务（PluginServer, PS）用于管理异构链插件、完成与中继通信的工作。
+
+- **插件管理能力**
+
+  在开发者完成一个异构链插件开发之后，将该插件打包放到PS的指定路径之下，启动PS即可加载该插件，PS将完成插件和区块链桥接组件（Blockchain Bridge Component, BBC）对象的管理等工作，PS还提供了CLI工具完成诸如插件重新加载、停止等工作。
+
+- **与中继通信**
+
+  将PS注册到一个中继之后，PS会作为一个RPC Server为中继提供服务，PS和中继之间会建立双向认证的TLS连接，确保身份互认和安全性，中继会发送请求要求PS完成BBC对象初始化等工作，并调用BBC的接口，完成与异构链的交互。
+
+# Architecture
+
+下面介绍了中继服务的整体架构。
+
+**以下插件BCOS和插件ChainMaker均为展示用例，代表不同的异构插件实现*
+
+<img src="https://intranetproxy.alipay.com/skylark/lark/0/2023/jpeg/13456461/1677744080321-3622114c-52c2-432c-9ceb-0f3d07c290e4.jpeg" style="zoom:33%;" />
+
+# Get Started
+
+## Build
+
+进入代码的根目录，运行mvn编译即可：
+
+```shell
+mvn clean package
+```
+
+产生的安装包在`ps-bootstrap/target/plugin-server-0.1.0-SNAPSHOT.tar.gz`。
+
+## Configuration
+
+在获得安装包之后，执行解压缩操作，这里以`plugin-server-0.1.0-SNAPSHOT.tar.gz`为例。
+
+```
+tar -zxf plugin-server-0.1.0-SNAPSHOT.tar.gz
+```
+
+进入解压后的目录，可以看到：
+
+```
+cd plugin-server/
+tree .
+.
+├── README.md
+├── bin
+│   ├── init_tls_certs.sh
+│   ├── print.sh
+│   ├── start.sh
+│   └── stop.sh
+├── config
+│   └── application.yml
+└── lib
+    └── ps-bootstrap-0.1.0-SNAPSHOT.jar
+
+
+3 directories, 7 files
+```
+
+首先，初始化PS的TLS秘钥和证书，该脚本将会在项目根目录下创建文件夹`certs`，下面存储了私钥`server.key`、证书`server.crt`、信任的证书`trust.crt`。
+
+```
+./bin/init_tls_certs.sh
+```
+
+然后，在和中继建立连接之前，中继的运维人员应该将中继的证书发送给了您，比如`relayer.crt`，您需要将这个证书添加到`trust.crt`中。
+
+```
+cat relayer.crt >> trust.crt
+```
+
+最后修改您的配置文件，将证书目录配置进去。
+
+```
+vi config/application.yml
+```
+
+依次替换`grpc.server.security.certificate-chain`、`grpc.server.security.private-key`和`grpc.server.security.trustCertCollection`的配置项。  
+下面给出一个例子，示例中诸如`/path/to/certs/server.crt`的具体配置属性值请替换为您的实际路径，`file:`保留：
+
+```yaml
+grpc:
+  server:
+    security:
+      # server certificate
+      certificate-chain: file:/path/to/certs/server.crt
+      # server key
+      private-key: file:/path/to/certs/server.key
+      # Mutual Certificate Authentication
+      trustCertCollection: file:/path/to/certs/trust.crt
+```
+
+然后修改插件库路径，PS将加载这个路径下的插件。修改配置项`pluginserver.plugin.repo`，比如：
+
+```yaml
+pluginserver:
+  plugin:
+    # where to load the hetero-chain plugins
+    repo: /path/to/plugins
+```
+
+将您的插件都放到这个路径下即可。
+
+## Run
+
+在解压包根目录之下，运行一下命令即可：
+
+```
+./bin/start.sh
+```
+
+看到下面的输出即启动成功：
+
+```
+    ___            __   ______ __            _           ____         _      __
+   /   |   ____   / /_ / ____// /_   ____ _ (_)____     / __ ) _____ (_)____/ /____ _ ___
+  / /| |  / __ \ / __// /    / __ \ / __ `// // __ \   / __  |/ ___// // __  // __ `// _ \
+ / ___ | / / / // /_ / /___ / / / // /_/ // // / / /  / /_/ // /   / // /_/ // /_/ //  __/
+/_/  |_|/_/ /_/ \__/ \____//_/ /_/ \__,_//_//_/ /_/  /_____//_/   /_/ \__,_/ \__, / \___/
+                                                                            /____/        
+
+[ INFO ]_[ 2023-03-30 15:11:27.1680160287 ] : start plugin-server now...
+[ INFO ]_[ 2023-03-30 15:11:27.1680160287 ] : plugin-server started successfully
+```
+
+可以通过`bin/stop.sh`关闭服务。
+
+日志文件存储在`log`目录之下。
+
+## Run Test
+
+在运行测试之前，请使用`ps-bootstrap/src/main/resources/scripts/init_tls_certs.sh`生成证书，并将`server.key`和`server.crt` 放到`ps-bootstrap/src/test/resources`之下，运行下述命令即可运行测试用例：
+
+```
+mvn test
+```
+
+# CLI Usage
+
+敬请期待
+