Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix readme #1043

Merged
merged 1 commit into from
Mar 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions basic/01-web3js-deploy/README-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ https://ithelp.ithome.com.tw/articles/10202794 在成功创建 Infura Project
- 同时在 BiliBili 上有上传本样例代码的讲解演示:
https://www.bilibili.com/video/BV1Y44y1r7E6/

- 测试Node版本:v20.11.0

## 合约功能说明
constructor: 构造函数, 用于部署合约时调用, 同时在其中初始化了公共变量 number 的值
Expand All @@ -24,8 +23,9 @@ getNumber: 查询函数, 用于查询公共变量 number 当前的数值

## 测试流程:
1) 安装依赖
```
```js
npm install
// 本教程使用的 node 版本为 v20.11.0
```

2) 配置 .env
Expand Down
10 changes: 5 additions & 5 deletions basic/01-web3js-deploy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ Through this basic task, you can learn the processes of compiling and deploying

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

- Node Version:v20.11.0

# Getting Started

Expand All @@ -40,14 +39,15 @@ Through this basic task, you can learn the processes of compiling and deploying

## How to run it

1. Install dependencies: `npm install`
2. Copy the configuration file: `cp .env.example .env`
3. Edit the configuration file: `vim .env`, copy your project ID and private key to the `.env` file
1. Please use node v20.11.0 to run following commands
2. Install dependencies: `npm install`
3. Copy the configuration file: `cp .env.example .env`
4. Edit the configuration file: `vim .env`, copy your project ID and private key to the `.env` file
```text
PRIVATE_KEY=YOUR_PRIVATE_KEY
INFURA_ID=YOUR_PROJECT_ID
```
4. Run the `index.js` file: `node index.js`
5. Run the `index.js` file: `node index.js`

# Interpret the Code in `index.js`

Expand Down
11 changes: 5 additions & 6 deletions basic/02-web3js-transaction/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
# Abstract
The demo code provides developers with an overview of how to sign, send, and receive receipt of transactions, and verify the results of their execution. The sample also provides the event monitoring code so that the developer can understand how to listen to an event one or more times.

--Node Version:v20.11.0

# Getting Started

## Understanding The Functions of the [Smart Contract](Incrementer.sol)
Expand All @@ -14,14 +12,15 @@ The demo code provides developers with an overview of how to sign, send, and rec

## How to run it

1. Install dependencies: `npm install`
2. Copy the configuration file: `cp .env.example .env`
3. Edit the configuration file: `vim .env`, copy your project ID and private key to the `.env` file.
1. Please use node v20.11.0 to run following commands
2. Install dependencies: `npm install`
3. Copy the configuration file: `cp .env.example .env`
4. Edit the configuration file: `vim .env`, copy your project ID and private key to the `.env` file.
```text
PRIVATE_KEY=YOUR_PRIVATE_KEY
INFURA_ID=YOUR_PROJECT_ID
```
4. Run the `index.js` file: `node index.js`
5. Run the `index.js` file: `node index.js`

# Interpret Source Code
## `compile.js`
Expand Down
11 changes: 5 additions & 6 deletions basic/03-web3js-erc20/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

This basic task is to show how to interact with ERC20 contract, so the developer can understand the basic interface of ERC20 contract.

--Node Version:v20.11.0

## Getting started
### SimpleToken contract function description

Expand All @@ -24,14 +22,15 @@ This basic task is to show how to interact with ERC20 contract, so the developer


### How to run it
1. Install dependencies: `npm install`
2. Copy the configuration file: `cp .env.example .env`
3. Edit the configuration file: `vim .env`, copy your project ID and private key to the `.env` file.
1. Please use node v20.11.0 to run following commands
2. Install dependencies: `npm install`
3. Copy the configuration file: `cp .env.example .env`
4. Edit the configuration file: `vim .env`, copy your project ID and private key to the `.env` file.
```text
PRIVATE_KEY=YOUR_PRIVATE_KEY
INFURA_ID=YOUR_PROJECT_ID
```
4. Run the `index.js` file: `node index.js`
5. Run the `index.js` file: `node index.js`

## Interpret Source Code

Expand Down
Loading