Skip to content

Commit e5757fa

Browse files
committed
fix doc
1 parent 966acbd commit e5757fa

File tree

10 files changed

+17
-14
lines changed

10 files changed

+17
-14
lines changed

basic/01-web3js-deploy/README-cn.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ https://ithelp.ithome.com.tw/articles/10202794 在成功创建 Infura Project
1414
- 同时在 BiliBili 上有上传本样例代码的讲解演示:
1515
https://www.bilibili.com/video/BV1Y44y1r7E6/
1616

17-
--测试Node版本:v20.11.0
17+
- 测试Node版本:v20.11.0
1818

1919
## 合约功能说明
2020
constructor: 构造函数, 用于部署合约时调用, 同时在其中初始化了公共变量 number 的值

basic/01-web3js-deploy/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Through this basic task, you can learn the processes of compiling and deploying
2727

2828
- If you know Chinese, you can check these tasks on [BILIBILI](https://www.bilibili.com/video/BV1Y44y1r7E6/).
2929

30-
--Node Version:v20.11.0
30+
- Node Version:v20.11.0
3131

3232
# Getting Started
3333

basic/02-web3js-transaction/README-cn.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
## 前言
33
通过本样例代码,开发者了解到如何对交易进行签名,发送,接收交易回执,验证交易执行结果。同时,样例也提供了事件监听的逻辑代码,开发者可以了解如何对一个事件进行一次或多次监听
44

5-
--测试Node版本:v20.11.0
65

76
## 合约功能说明
87
constructor: 构造函数, 用于部署合约时调用, 同时在其中初始化了公共变量 number 的值
98
increment: 增值函数, 根据传入的数值 ( _value ), 对公共变量 number 进行增值 ( number + _value )
109
reset: 重置函数, 用于重置公共变量 number 的值为 0
1110
getNumber: 查询函数, 用于查询公共变量 number 当前的数值
1211

13-
## 测试流程
12+
## 测试流程
1413
1) 安装依赖
15-
```
14+
```js
1615
npm install
16+
// 本教程使用的 node 版本为 v20.11.0
1717
```
1818

1919
2) 配置 .env

basic/02-web3js-transaction/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ You can't use `.sol` files directly, you need to compile it to binary file first
3030
3131
```js
3232
// Load contract
33+
// please use node v20.11.0 to run following commands
3334
const source = fs.readFileSync("Incrementer.sol", "utf8");
3435
```
3536
### Compile the smart contract file

basic/03-web3js-erc20/README-cn.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
本样例演示了 ERC20 合约的基本调用, 让开发者了解 ERC20 合约的基本接口
66

7-
--测试Node版本:v20.11.0
87

98
## SimpleToken 合约功能说明
109

@@ -25,8 +24,9 @@
2524

2625
1. 安装依赖
2726

28-
```sh
27+
```js
2928
npm install
29+
// 本教程使用的 node 版本为 v20.11.0
3030
```
3131

3232
2. 配置 .env

basic/03-web3js-erc20/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ This basic task is to show how to interact with ERC20 contract, so the developer
3939
4040
You can't use `.sol` files directly, you need to compile it to binary file firstly.
4141
42+
4243
1. Load the smart contract file `SimpleToken.sol` into `source` variable.
4344
4445
```js

basic/04-web3js-truffle/README-CN.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ truffle 开发框架提供了很多功能,简化了我们的开发、编译、
1717
- 可配的构建流程,支持持续集成。
1818
- 支持外部脚本的执行
1919

20-
--Node Version:v20.11.0
2120

2221
## 文件说明
2322

@@ -39,8 +38,9 @@ truffle 开发框架提供了很多功能,简化了我们的开发、编译、
3938

4039
## 测试流程
4140
1. 安装 truffle
42-
```bash
41+
```js
4342
npm install -g truffle
43+
// 本教程使用的 node 版本为 v20.11.0
4444
```
4545

4646
如果下载速度过慢,可配置taobao的镜像地址来进行加速。

basic/04-web3js-truffle/README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@
1313
- Configurable build pipeline with support for tight integration.
1414
- External script runner that executes scripts within a Truffle environment.
1515

16-
--Node Version:v20.11.0
17-
1816
### [Truffle Quickstart](https://www.trufflesuite.com/docs/truffle/quickstart)
1917

2018
## Introduction about Project
@@ -40,8 +38,9 @@
4038

4139
1. Install `Truffle`
4240

43-
```bash
41+
```js
4442
npm install -g truffle
43+
// please use node v20.11.0
4544
```
4645

4746
> Note: If you are live in mainland China, you can change the registry to `taobao`:

basic/05-ethersjs-erc20/README-CN.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,9 @@
2121

2222
1. 安装依赖
2323

24-
```sh
24+
```js
2525
npm install
26+
// 本教程使用的 node 版本为 v20.11.0
2627
```
2728

2829
2. 配置 .env

basic/05-ethersjs-erc20/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,9 @@ Difference between `web3.js` and `ethers.js` can be seen [here](./web3-vs-ethers
2121

2222
1. Install dependencies
2323

24-
```bash
24+
```js
2525
npm install
26+
// please use node v20.11.0
2627
```
2728

2829
2. Config `.env`

0 commit comments

Comments
 (0)