Skip to content

Commit ab34036

Browse files
Yorkchungcheng-chun-yuanYorkBear
authored
Update: 3.1.0 besu network (#113)
* fix: remove ConfigEnvType from Quorum (#107) * feat: build besu network (#112) * feat: refactor bdk command to `bdk eth` * fix: change the commandDir from quorum to eth, and rename test/quorum to test/eth * feat: Build `Besu network` with add, create, delete, down, generate, get, join, up function * fix: add node-private-key-file * chore: bdk besu check function * chore: bdk besu get function * chore: bdk eth network up function * chore: bdk besu generate function * chore: bdk besu add function * chore: bdk besu network join function * chore: add besu validator node * chore: join network with networkType * chore: update unit test * chore: update unit test * chore: update docs * chore: check node exist && fix bugs * chore: fixed packages issue & updated ethers 5 to 6 * chore: update readme --------- Co-authored-by: cheng-chun-yuan <83824908+cheng-chun-yuan@users.noreply.github.com> Co-authored-by: York <166586375+YorkBear@users.noreply.github.com> * feat: update docker compose to version 2 --------- Co-authored-by: Albert_Cheng <83824908+cheng-chun-yuan@users.noreply.github.com> Co-authored-by: York <166586375+YorkBear@users.noreply.github.com>
1 parent 38d7988 commit ab34036

118 files changed

Lines changed: 2150 additions & 1527 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
* @kth-tw @Pianochicken @kidneyweakx
1+
* @kth-tw @yorkchung

‎.nycrc.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@
88
"statements": 0,
99
"include": [
1010
"src/fabric/service/**.ts",
11-
"src/quorum/service/**.ts",
11+
"src/eth/service/**.ts",
1212
"src/wallet/service/**.ts"
1313
],
1414
"exclude": [
1515
"src/fabric/service/Service.abstract.ts",
16-
"src/quorum/service/Service.abstract.ts",
17-
"src/quorum/service/network.ts"
16+
"src/eth/service/Service.abstract.ts",
17+
"src/eth/service/network.ts"
1818
],
1919
"reporter": [
2020
"text-summary",

‎CHANGELOG.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,22 @@
33
這份文件將記錄 BDK 專案的變更日誌
44

55
All notable changes to BDK project will be documented here.
6+
## [v3.1.0](https://github.com/cathayddt/bdk/releases/tag/v3.1.0) - 2024-12-25
7+
8+
### Features
9+
10+
* Build `Besu network` with add, create, delete, down, generate, get, join, up function
11+
* Refactor bdk command to `bdk eth`
12+
* Update ethers 5 to 6
13+
* Update docker compose to version 2
14+
* Build besu network [#112](https://github.com/cathayddt/bdk/issues/112)
15+
16+
### Fixes
17+
18+
* Add node-private-key-file
19+
* Change the commandDir from quorum to eth, and rename test/quorum to test/eth
20+
* Remove ConfigEnvType from Quorum [#107](https://github.com/cathayddt/bdk/issues/107)
21+
622
## [v3.0.0](https://github.com/cathayddt/bdk/releases/tag/v3.0.0) - 2024-03-19
723

824
### Features

‎README.md‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,31 +20,35 @@ BDK streamlines the normally complicated process of creating a blockchain with c
2020
e.g.
2121

2222
```
23-
bdk quorum network create -i
23+
bdk eth network create -i
2424
```
25-
![bdk quorum network create -i](docs/vhs/bdk-quorum-network-create.gif)
25+
#### Quorum
26+
![bdk eth network create -i](docs/vhs/bdk-quorum-network-create.gif)
27+
#### Besu
28+
![bdk eth network create -i](docs/vhs/bdk-besu-network-create.gif)
2629

2730
```bash
2831
bdk fabric network create -i
2932
```
30-
33+
#### Fabric
3134
![bdk fabric network create -i](docs/vhs/bdk-fabric-network-create.gif)
3235

3336
## 版本 (Releases)
3437

3538
| Latest | Stable |
3639
| ---------------- | ---------------- |
37-
| [v3.0.0][v3.0.0] | [v3.0.0][v3.0.0] |
40+
| [v3.1.0][v3.1.0] | [v3.1.0][v3.1.0] |
3841

39-
[v3.0.0]: https://github.com/cathayddt/bdk/releases/tag/v3.0.0
42+
[v3.1.0]: https://github.com/cathayddt/bdk/releases/tag/v3.1.0
4043

4144
[更新內容 (Changelog)](CHANGELOG.md)
4245

4346
## 文件 (Documentation)
4447

4548
- 指令文件 CLI Documentation (Work in Progress)
4649
- [Fabric 使用範例 (Examples)](docs/fabric/EXAMPLE.md)
47-
- [Quorum 使用範例 (Examples)](docs/quorum/EXAMPLE.md)
50+
- [Quorum 使用範例 (Examples)](docs/eth/EXAMPLE.md)
51+
- [Besu 使用範例 (Examples)](docs/eth/EXAMPLE.md)
4852
- [開發指南 (Contributing)](.github/CONTRIBUTING.md)
4953
- [資安通報 (Security Issues)](SECURITY.md)
5054

@@ -54,7 +58,7 @@ bdk fabric network create -i
5458

5559
- [npm + nodejs](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) node v18, npm v9
5660
- [docker](https://docs.docker.com/engine/install)
57-
- [docker-compose](https://docs.docker.com/compose/install) >= 1.27
61+
- [docker-compose](https://docs.docker.com/compose/install) >= 2.20
5862
- [docker-desktop(MacOS)](https://www.docker.com/products/docker-desktop/) Need Allow Docker Sockers in Advanced Options
5963
- eslint (vscode plugin, dev-only)
6064

docs/quorum/COMMANDS.md renamed to docs/eth/COMMANDS.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Quorum 指令文件
1+
# Besu/Quorum 指令文件
22

33
(English version)(Work In Progress)
44

@@ -10,87 +10,87 @@
1010

1111
## Network
1212

13-
### `bdk quorum network add`
13+
### `bdk eth network add`
1414

15-
Description: 新增 Quorum Node
15+
Description: 新增 Besu/Quorum Node
1616

1717
| Options | Type | Description | Required | Default |
1818
| --------------------- | :-----: | ------------------------------ | :------: | ------- |
1919
| --help | boolean | Show help | | |
2020
| --version | boolean | Show version number | | |
2121
| -i, --interactive | boolean | 是否使用 Cathay BDK 互動式問答 | | |
2222

23-
### `bdk quorum network check`
23+
### `bdk eth network check`
2424

25-
Description: 確認 Quorum Node 資訊
25+
Description: 確認 Besu/Quorum Node 資訊
2626

2727
| Options | Type | Description | Required | Default |
2828
| --------------------- | :-----: | ------------------------------ | :------: | ------- |
2929
| --help | boolean | Show help | | |
3030
| --version | boolean | Show version number | | |
3131
| -i, --interactive | boolean | 是否使用 Cathay BDK 互動式問答 | | |
3232

33-
### `bdk quorum network create`
33+
### `bdk eth network create`
3434

35-
Description: 產生 Quorum Network 所需的相關設定檔案並建立網路
35+
Description: 產生 Besu/Quorum Network 所需的相關設定檔案並建立網路
3636

3737
| Options | Type | Description | Required | Default |
3838
| --------------------- | :-----: | ------------------------------ | :------: | ------- |
3939
| --help | boolean | Show help | | |
4040
| --version | boolean | Show version number | | |
4141
| -i, --interactive | boolean | 是否使用 Cathay BDK 互動式問答 | | |
4242

43-
### `bdk quorum network delete`
43+
### `bdk eth network delete`
4444

45-
Description: 刪除現有的 Quorum Network
45+
Description: 刪除現有的 Besu/Quorum Network
4646

4747
| Options | Type | Description | Required | Default |
4848
| --------------------- | :-----: | ------------------------------ | :------: | ------- |
4949
| --help | boolean | Show help | | |
5050
| --version | boolean | Show version number | | |
5151

52-
### `bdk quorum network down`
52+
### `bdk eth network down`
5353

54-
Description: 停止現有的 Quorum Network
54+
Description: 停止現有的 Besu/Quorum Network
5555

5656
| Options | Type | Description | Required | Default |
5757
| --------------------- | :-----: | ------------------------------ | :------: | ------- |
5858
| --help | boolean | Show help | | |
5959
| --version | boolean | Show version number | | |
6060

61-
### `bdk quorum network generate`
61+
### `bdk eth network generate`
6262

63-
Description: 產生 Quorum Network 所需的相關設定檔案
63+
Description: 產生 Besu/Quorum Network 所需的相關設定檔案
6464

6565
| Options | Type | Description | Required | Default |
6666
| --------------------- | :-----: | ------------------------------ | :------: | ------- |
6767
| --help | boolean | Show help | | |
6868
| --version | boolean | Show version number | | |
6969
| -i, --interactive | boolean | 是否使用 Cathay BDK 互動式問答 | | |
7070

71-
### `bdk quorum network get`
71+
### `bdk eth network get`
7272

73-
Description: 取得 Quorum 檔案資訊
73+
Description: 取得 Besu/Quorum 檔案資訊
7474

7575
| Options | Type | Description | Required | Default |
7676
| --------------------- | :-----: | ------------------------------ | :------: | ------- |
7777
| --help | boolean | Show help | | |
7878
| --version | boolean | Show version number | | |
7979
| -i, --interactive | boolean | 是否使用 Cathay BDK 互動式問答 | | |
8080

81-
### `bdk quorum network join`
81+
### `bdk eth network join`
8282

83-
Description: 選擇現有節點加入 Quorum Network
83+
Description: 選擇現有節點加入 Besu/Quorum Network
8484

8585
| Options | Type | Description | Required | Default |
8686
| --------------------- | :-----: | ------------------------------ | :------: | ------- |
8787
| --help | boolean | Show help | | |
8888
| --version | boolean | Show version number | | |
8989
| -i, --interactive | boolean | 是否使用 Cathay BDK 互動式問答 | | |
9090

91-
### `bdk quorum network up`
91+
### `bdk eth network up`
9292

93-
Description: 啟動現有的 Quorum Network
93+
Description: 啟動現有的 Besu/Quorum Network
9494

9595
| Options | Type | Description | Required | Default |
9696
| --------------------- | :-----: | ------------------------------ | :------: | ------- |
@@ -101,19 +101,19 @@ Description: 啟動現有的 Quorum Network
101101

102102
## Explorer
103103

104-
### `bdk quorum explorer create`
104+
### `bdk eth explorer create`
105105

106-
Description: 產生 Quorum Explorer 所需的相關設定檔案
106+
Description: 產生 Besu/Quorum Explorer 所需的相關設定檔案
107107

108108
| Options | Type | Description | Required | Default |
109109
| --------------------- | :-----: | ------------------------------ | :------: | ------- |
110110
| --help | boolean | Show help | | |
111111
| --version | boolean | Show version number | | |
112112
| -i, --interactive | boolean | 是否使用 Cathay BDK 互動式問答 | | |
113113

114-
### `bdk quorum explorer delete`
114+
### `bdk eth explorer delete`
115115

116-
Description: 刪除現有的 Quorum Explorer.
116+
Description: 刪除現有的 Besu/Quorum Explorer.
117117

118118
| Options | Type | Description | Required | Default |
119119
| --------------------- | :-----: | ------------------------------ | :------: | ------- |
@@ -122,9 +122,9 @@ Description: 刪除現有的 Quorum Explorer.
122122

123123
## Backup
124124

125-
### `bdk quorum backup export`
125+
### `bdk eth backup export`
126126

127-
Description: 匯出現有的 Quorum Network
127+
Description: 匯出現有的 Besu/Quorum Network
128128

129129
| Options | Type | Description | Required | Default |
130130
| --------------------- | :-----: | ------------------------------ | :------: | ------- |
@@ -133,9 +133,9 @@ Description: 匯出現有的 Quorum Network
133133
| -i, --interactive | boolean | 是否使用 Cathay BDK 互動式問答 | | |
134134
| -a, --all | boolean | 是否備份所有資料 | | |
135135

136-
### `bdk quorum backup import`
136+
### `bdk eth backup import`
137137

138-
Description: 匯入現有的 Quorum Network
138+
Description: 匯入現有的 Besu/Quorum Network
139139

140140
| Options | Type | Description | Required | Default |
141141
| --------------------- | :-----: | ------------------------------ | :------: | ------- |
@@ -145,28 +145,28 @@ Description: 匯入現有的 Quorum Network
145145

146146
## Cluster
147147

148-
### `bdk quorum cluster apply`
148+
### `bdk eth cluster apply`
149149

150-
Description: 產生 Quorum Cluster 所需的相關設定檔案並建立網路
150+
Description: 產生 Besu/Quorum Cluster 所需的相關設定檔案並建立網路
151151

152152
| Options | Type | Description | Required | Default |
153153
| --------------------- | :-----: | ------------------------------ | :------: | ------- |
154154
| --help | boolean | Show help | | |
155155
| --version | boolean | Show version number | | |
156156

157-
### `bdk quorum cluster delete`
157+
### `bdk eth cluster delete`
158158

159-
Description: 刪除現有的 Quorum Cluster 網路
159+
Description: 刪除現有的 Besu/Quorum Cluster 網路
160160

161161
| Options | Type | Description | Required | Default |
162162
| --------------------- | :-----: | ------------------------------ | :------: | ------- |
163163
| --help | boolean | Show help | | |
164164
| --version | boolean | Show version number | | |
165165
| -i, --interactive | boolean | 是否使用 Cathay BDK 互動式問答 | | |
166166

167-
### `bdk quorum cluster generate`
167+
### `bdk eth cluster generate`
168168

169-
Description: 產生 Quorum Cluster 所需的相關設定檔案
169+
Description: 產生 Besu/Quorum Cluster 所需的相關設定檔案
170170

171171
| Options | Type | Description | Required | Default |
172172
| --------------------- | :-----: | ------------------------------ | :------: | ------- |

0 commit comments

Comments
 (0)