Merge pull request #586 from maroonstar/main

Rewrite Simpletoken.sol with @openzeppelin/contracts

Author: luckyyang

basic/03-web3js-erc20/README.md

@@ -3,8 +3,22 @@ const solc = require('solc');
 
 // Get Path and Load Contract
 const source = fs.readFileSync('SimpleToken.sol', 'utf8');
+function findImports(path) {
+  if (fs.existsSync(path)) {
+    return {
+      contents: fs.readFileSync(path, 'utf8'),
+    };
+  } else if (fs.existsSync('./node_modules/' + path)) {
+    return {
+      contents: fs.readFileSync('./node_modules/' + path, 'utf8'),
+    };
+  } else {
+    return { error: 'File not found' };
+  }
+}
 
 // Compile Contract
+// https://docs.soliditylang.org/en/v0.8.0/using-the-compiler.html#compiler-input-and-output-json-description
 const input = {
   language: 'Solidity',
   sources: {
@@ -21,7 +35,9 @@ const input = {
   },
 };
 
-const tempFile = JSON.parse(solc.compile(JSON.stringify(input)));
+const tempFile = JSON.parse(
+  solc.compile(JSON.stringify(input), { import: findImports })
+);
 const contractFile = tempFile.contracts['SimpleToken.sol']['SimpleToken'];
 
 // Export Contract Data

basic/39-Multicall/contracts/SimpleToken.sol renamed to basic/03-web3js-erc20/SimpleToken-backup.sol

@@ -9,6 +9,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
+    "@openzeppelin/contracts": "^4.4.2",
     "chai": "^4.2.0",
     "dotenv": "^10.0.0",
     "ethereumjs-tx": "^2.1.2",

basic/03-web3js-erc20/SimpleToken.sol

@@ -1,41 +1,52 @@
+# ethersjs-erc20
+
 ## 前言
+
 本样例演示了使用 ethers.js 调用 ERC20 合约的开发流程
 
 ## 代码逻辑
-1) ERC20 合约部署  
-通过 deploy.js 进行部署，样例中链接的测试网为 Kovan, 对应需要使用有 Ether 的账户进行发送
 
-2) 合约调用  
-调用 erc20 的 transfer, balanceof 接口, 验证合约部署结果
+1. ERC20 合约部署  
+   通过 deploy.js 进行部署，样例中链接的测试网为 Kovan, 对应需要使用有 Ether 的账户进行发送
 
-3) 事件监听   
-之后使用 providerContract.once 和 providerContract.on 对 Transfer 事件进行一次和多次的监听
+2. 合约调用  
+   调用 erc20 的 transfer, balanceof 接口, 验证合约部署结果
 
+3. 事件监听  
+   之后使用 providerContract.once 和 providerContract.on 对 Transfer 事件进行一次和多次的监听
 
 ## 测试流程
-1) 安装依赖
-```
-npm install
-```
-
-2) 配置 .env  
-```
-cp .env.example .env
-
-## 修改 .env 中的 INFURA_ID 和 PRIVATE_KEY 为实际的值  
-PRIVATE_KEY=xxxxxxxxxxxxxxxx
-INFURA_ID=yyyyyyyy
-```
-
-3) 执行测试
-```
-node index.js
-```
-
-## 参考文档   
-官方文档: 
-https://docs.ethers.io/v4/api-providers.html  
-https://docs.ethers.io/v5/getting-started/#getting-started--contracts    
-中文文档: 
-https://learnblockchain.cn/docs/ethers.js/api-providers.html  
-http://zhaozhiming.github.io/2018/04/25/how-to-use-ethers-dot-js/
+
+1. 安装依赖
+
+   ```sh
+   npm install
+   ```
+
+2. 配置 .env
+
+   ```sh
+   cp .env.example .env
+
+   ## 修改 .env 中的 INFURA_ID 和 PRIVATE_KEY 为实际的值
+   PRIVATE_KEY=xxxxxxxxxxxxxxxx
+   INFURA_ID=yyyyyyyy
+   ```
+
+3. 执行测试
+
+   ```sh
+   node index.js
+   ```
+
+## 参考文档
+
+官方文档:
+
+- <https://docs.ethers.io/v4/api-providers.html>
+- <https://docs.ethers.io/v5/getting-started/#getting-started--contracts>
+
+中文文档:
+
+- <https://learnblockchain.cn/docs/ethers.js/api-providers.html>
+- <http://zhaozhiming.github.io/2018/04/25/how-to-use-ethers-dot-js/>