[feat][*][v0.2.1] release v0.2.1 (#16)

* [feat][scripts][0.2.1] improvement for the start scripts

* [doc][*][0.2.1] update description about start.sh into README

* [fix][*][0.2.1] wrong default for `HOST_IP` in cli start.sh

* [refactor][*][0.2.1] add `WorkingDirectory` to `plugin-server.service`

* [fix][*][v0.2.1] downgrade fastjson version to `1.2.83_noneautotype`

* [feat][*][v0.2.1]: add txHash to ProvableLedgerData

[refactor][*][v0.2.1] update version to `v0.2.1`

---------

Co-authored-by: dawn-to-dusk <[email protected]>

Author: zouxyan

README.md

@@ -66,16 +66,17 @@ tree .
 ├── README.md
 ├── bin
 │   ├── init_tls_certs.sh
+│   ├── plugin-server.service
 │   ├── print.sh
 │   ├── start.sh
 │   └── stop.sh
 ├── config
 │   └── application.yml
 └── lib
-    └── ps-bootstrap-x.x.x.jar
+    └── ps-bootstrap-x.x.x.jar
 
 
-3 directories, 7 files
+3 directories, 8 files
 ```
 
 首先，初始化PS的TLS秘钥和证书，该脚本将会在项目根目录下创建文件夹`certs`，下面存储了私钥`server.key`、证书`server.crt`、信任的证书`trust.crt`。
@@ -124,6 +125,59 @@ pluginserver:
 
 ## 运行
 
+### 作为系统服务运行
+
+在解压包根目录之下，可以找到`start.sh`脚本。
+
+如下可以打印帮助信息：
+
+```
+./bin/start.sh -h
+
+ start.sh — Start the plugin server
+
+ Usage:
+   start.sh <params>
+
+ Examples:
+  1. start in system service mode：
+   start.sh -s
+  2. start in application mode:
+   start.sh
+
+ Options:
+   -s         run in system service mode.
+   -h         print help information.
+```
+
+运行如下命令，会自动将插件服务启动为系统服务：
+
+```
+./bin/start.sh -s
+```
+
+看到下面的输出即启动成功：
+
+```
+    ___            __   ______ __            _           ____         _      __
+   /   |   ____   / /_ / ____// /_   ____ _ (_)____     / __ ) _____ (_)____/ /____ _ ___
+  / /| |  / __ \ / __// /    / __ \ / __ `// // __ \   / __  |/ ___// // __  // __ `// _ \
+ / ___ | / / / // /_ / /___ / / / // /_/ // // / / /  / /_/ // /   / // /_/ // /_/ //  __/
+/_/  |_|/_/ /_/ \__/ \____//_/ /_/ \__,_//_//_/ /_/  /_____//_/   /_/ \__,_/ \__, / \___/
+                                                                            /____/        
+
+[ INFO ]_[ 2023-06-20 20:57:06.168 ] : running in system service mode
+[ INFO ]_[ 2023-06-20 20:57:06.168 ] : plugin-server started successfully
+```
+
+可以通过下面命令查看系统服务状态：
+
+```
+systemctl status plugin-server.service
+```
+
+### 作为普通进程运行
+
 在解压包根目录之下，运行一下命令即可：
 
 ```

pom.xml

@@ -19,27 +19,37 @@
 
     <properties>
         <java.version>8</java.version>
-        <pluginserver.version>0.2.0</pluginserver.version>
+        <pluginserver.version>0.2.1</pluginserver.version>
         <grpc-starter.version>2.13.1.RELEASE</grpc-starter.version>
         <netty-tcnative-boringssl-static.version>2.0.59.Final</netty-tcnative-boringssl-static.version>
         <protobuf.version>3.19.1</protobuf.version>
         <protobuf-plugin.version>0.6.1</protobuf-plugin.version>
         <grpc.version>1.42.2</grpc.version>
         <jakarta.annotation-api.version>1.3.5</jakarta.annotation-api.version>
         <junit.version>4.13.2</junit.version>
-        <antchain-bridge.sdk.version>0.1.1</antchain-bridge.sdk.version>
+        <antchain-bridge.sdk.version>0.1.2</antchain-bridge.sdk.version>
         <jline.version>3.3.0</jline.version>
         <groovy.version>3.0.17</groovy.version>
         <commons-cli.version>1.5.0</commons-cli.version>
         <hutool.version>5.8.10</hutool.version>
-        <fastjson.version>2.0.21</fastjson.version>
+        <fastjson.version>1.2.83_noneautotype</fastjson.version>
         <pf4j.version>3.8.0</pf4j.version>
         <slf4j.version>1.7.28</slf4j.version>
     </properties>
 
+    <repositories>
+        <repository>
+            <id>github</id>
+            <url>https://maven.pkg.github.com/AntChainOpenLab/*</url>
+            <snapshots>
+                <enabled>true</enabled>
+            </snapshots>
+        </repository>
+    </repositories>
+
     <groupId>com.alipay.antchain.bridge</groupId>
     <artifactId>antchain-bridge-pluginserver</artifactId>
-    <version>0.2.0</version>
+    <version>0.2.1</version>
 
     <name>antchain-bridge-pluginserver</name>
     <description>antchain-bridge-pluginserver</description>

ps-bootstrap/desc_tar.xml

@@ -19,6 +19,7 @@
             <outputDirectory>${file.separator}bin</outputDirectory>
             <includes>
                 <include>*.sh</include>
+                <include>plugin-server.service</include>
             </includes>
         </fileSet>
         <fileSet>

ps-bootstrap/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.alipay.antchain.bridge</groupId>
         <artifactId>antchain-bridge-pluginserver</artifactId>
-        <version>0.2.0</version>
+        <version>0.2.1</version>
     </parent>
 
     <artifactId>ps-bootstrap</artifactId>
@@ -35,6 +35,7 @@
                 <includes>
                     <include>**/application.yml</include>
                     <include>**/*.xml</include>
+                    <include>**/banner.txt</include>
                 </includes>
                 <!-- 是否替换@xx@表示的maven properties属性值 -->
                 <filtering>true</filtering>

ps-bootstrap/src/main/resources/banner.txt

@@ -0,0 +1,8 @@
+${AnsiColor.BLUE}${AnsiStyle.BOLD}
+    ___            __   ______ __            _           ____         _      __
+   /   |   ____   / /_ / ____// /_   ____ _ (_)____     / __ ) _____ (_)____/ /____ _ ___
+  / /| |  / __ \ / __// /    / __ \ / __ `// // __ \   / __  |/ ___// // __  // __ `// _ \
+ / ___ | / / / // /_ / /___ / / / // /_/ // // / / /  / /_/ // /   / // /_/ // /_/ //  __/
+/_/  |_|/_/ /_/ \__/ \____//_/ /_/ \__,_//_//_/ /_/  /_____//_/   /_/ \__,_/ \__, / \___/
+                                                                            /____/
+                                  plugin-server @project.version@

ps-bootstrap/src/main/resources/scripts/init_tls_certs.sh

@@ -1,5 +1,21 @@
 #!/bin/bash
 
+#
+# Copyright 2023 Ant Group
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# 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.
+#
+
 CURR_DIR="$(cd `dirname $0`; pwd)"
 source ${CURR_DIR}/print.sh
 

ps-bootstrap/src/main/resources/scripts/plugin-server.service

@@ -0,0 +1,28 @@
+#
+# Copyright 2023 Ant Group
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# 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.
+#
+
+[Unit]
+Description=start shell script
+StartLimitIntervalSec=0
+
+[Service]
+ExecStart=@@START_CMD@@
+Restart=always
+RestartSec=5
+WorkingDirectory=@@WORKING_DIR@@
+
+[Install]
+WantedBy=multi-user.target

ps-bootstrap/src/main/resources/scripts/print.sh

@@ -1,3 +1,19 @@
+#
+# Copyright 2023 Ant Group
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# 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.
+#
+
 RED='\033[0;31m'
 GREEN='\033[0;32m'
 BLUE='\033[0;34m'
@@ -23,26 +39,26 @@ function print_hint() {
 }
 
 function log_info() {
-  NOW=`date "+%Y-%m-%d %H:%M:%S.%s" | cut -b 1-23`
-  INFO_PREFIX=`printf "${GREEN}\033[4m[ INFO ]${NC}"`
+  NOW=$(date "+%Y-%m-%d %H:%M:%S.%s" | cut -b 1-23)
+  INFO_PREFIX=$(printf "${GREEN}\033[4m[ INFO ]${NC}")
 
-  INFO=`printf "_${LIGHT_GRAY}[ %s ]${NC} : %s" "${NOW}" "$1"`
+  INFO=$(printf "_${LIGHT_GRAY}[ %s ]${NC} : %s" "${NOW}" "$1")
   echo "${INFO_PREFIX}${INFO}"
 }
 
 function log_warn() {
-  NOW=`date "+%Y-%m-%d %H:%M:%S.%s" | cut -b 1-23`
-  WARN_PREFIX=`printf "${YELLOW}\033[4m[ WARN ]${NC}"`
+  NOW=$(date "+%Y-%m-%d %H:%M:%S.%s" | cut -b 1-23)
+  WARN_PREFIX=$(printf "${YELLOW}\033[4m[ WARN ]${NC}")
 
-  INFO=`printf "_${LIGHT_GRAY}[ %s ]${NC} : %s" "${NOW}" "$1"`
+  INFO=$(printf "_${LIGHT_GRAY}[ %s ]${NC} : %s" "${NOW}" "$1")
   echo "${WARN_PREFIX}${INFO}"
 }
 
 function log_error() {
-  NOW=`date "+%Y-%m-%d %H:%M:%S.%s" | cut -b 1-23`
-  ERROR_PREFIX=`printf "${RED}\033[4m[ ERROR ]${NC}"`
+  NOW=$(date "+%Y-%m-%d %H:%M:%S.%s" | cut -b 1-23)
+  ERROR_PREFIX=$(printf "${RED}\033[4m[ ERROR ]${NC}")
 
-  INFO=`printf "_${LIGHT_GRAY}[ %s ]${NC} : %s" "${NOW}" "$1"`
+  INFO=$(printf "_${LIGHT_GRAY}[ %s ]${NC} : %s" "${NOW}" "$1")
   echo "${ERROR_PREFIX}${INFO}"
 }
 
@@ -54,4 +70,4 @@ function print_title() {
   echo '/_/  |_|/_/ /_/ \__/ \____//_/ /_/ \__,_//_//_/ /_/  /_____//_/   /_/ \__,_/ \__, / \___/'
   echo '                                                                            /____/        '
   echo
-}
+}