Merge pull request #750 from arc0035/main

[Translation] Fix typos and make English README as default

Author: 0x-stan

README.md

@@ -74,7 +74,7 @@ We have collected a list of classic blockchain-related books to help developers
 
 At the same time, feel free to keep expanding this [book list](./docs/books.md).
 
-**Encryption course**
+**Cryptographic course**
 
 We have collected some crypto courses from top universities and the Ethereum community to help developers systematically understand blockchain and cryptocurrencies.
 - [MIT Online Course: Blockchain and Money by Prof. Gary Gensler](https://ocw.mit.edu/courses/sloan-school-of-management/15-s12-blockchain-and-money-fall-2018/video-lectures/)

basic/41-nft-farming/README-CN.md

@@ -0,0 +1,9 @@
+## NFT Farming
+- NFT farming is all about earning rewards for on-chain activity on a platform.
+## 概述
+- NFT farming，与Defi中的yield farming类似，但其使用的是NFT而非token，近年Onchain APP的发展推动流动性较低的NFT也可以farming。
+- 传统方法的NFT Farming，即就是将NFT质押成某一种特定的token，添加NFT-token的交易对进行farming。
+- 游戏化的NFT Farming，即就是将获取NFT的过程编写成游戏，NFT作为游戏道具，与游戏中设计的Token进行交易转换，通过流动性Farming。
+## 参考链接
+- https://coinquora.com/what-is-nft-farming-and-how-does-nft-farming-work/
+- https://superfarm.com/farms

basic/41-nft-farming/README-en.md

@@ -1,9 +1,15 @@
 ## NFT Farming
 - NFT farming is all about earning rewards for on-chain activity on a platform.
-## 概述
-- NFT farming，与Defi中的yield farming类似，但其使用的是NFT而非token，近年Onchain APP的发展推动流动性较低的NFT也可以farming。
-- 传统方法的NFT Farming，即就是将NFT质押成某一种特定的token，添加NFT-token的交易对进行farming。
-- 游戏化的NFT Farming，即就是将获取NFT的过程编写成游戏，NFT作为游戏道具，与游戏中设计的Token进行交易转换，通过流动性Farming。
-## 参考链接
+
+## Overview
+
+- NFT farming has similiarities to yield farming in DeFi sector but differs in that it involves NFTs as either stakings or rewards: Holders can stake NFTs for FTs and vice versa.As Dapp is developing so fast these years, even illiquid NFT could be used for farming.
+
+- In a traditional manner, NFT Farming requires user to acquire specific token by depositing NFTs, then add it to some NFT-token pairs to farm.
+
+- In a gamefied manner, where the lifecyle of NFTs is encapusulated into games, you can swap in-game items for tokens to do yield farming.
+
+
+## References
 - https://coinquora.com/what-is-nft-farming-and-how-does-nft-farming-work/
 - https://superfarm.com/farms

basic/41-nft-farming/README.md

@@ -1,32 +1,32 @@
 # Merkle Distributor Airdrop
 
-## Introduction
+## 介绍
 
 ### NFT merkle airdrop
 
-This demo introduces 5 methods for NFT-airdrop:
-- Airdrop to specific address
-- A signature implying the beneficiary is submitted to blockchain for verification and airdropping
-- A signature following EIP-712 is submitted to blockchain for verification and airdropping
-- A signature following EIP-712 is submitted to blockchain for verification ,signature check and airdropping
-- A merkle proof is submitted to blockchain for verification and airdropping
+本样例介绍了 5 种 NFT 空投方式
+
+- 直接对特定账户进行空投
+- 线下签名,线上验证通过后空投
+- 线下 EIP-712 方式签名, 线上验证后空投
+- 线下 EIP-712 方式签名, 线上进行 EIP-712 验证, Signature Check
+- 线下生成 Merkle 证明, 线上 Merkle 验证
 
 ### ERC20 merkle airdrop
 
-Kindly refer to 1inch, dydx, uniswap for more details, all the projects utilize merkle proof for airdropping. Please read more for details:
+参考 1inch，dydx，uniswap 都实现 merkle 空投。 具体原理请参考：
 
 - <https://itzone.com.vn/en/article/merkle-airdrop-the-airdrop-solution-for-token-issues/>
 
-### Demo: Red packet
-
-We present a demo in which you can airdrop to your friends on holiday!
+### 抢红包
 
-Please refer to the code: contracts/redpacket
+本样例演示了抢红包合约的功能, 在节假日的时候可以部署相应的合约进行红包发放.
+对应合约路径为 contracts/redpacket
 
-## Demo instruction
+## 合约功能说明
 
 - ERC721Basic
-  The most simple demo where the issuer can airdrop NFT to specific address by calling "mint" :
+  最简单的 NFT 空投合约, 项目方直接调用 mint 接口, 对指定账户投放 NFT
 
   ```js
   //
@@ -36,23 +36,22 @@ Please refer to the code: contracts/redpacket
   ```
 
 - ERC721LazyMint  
-  This is a demo where airdropping happens after verification. Considier the following case: Before the real "mint" is called on blockchain, the issuer firstly send an email containing the token id to the user, who will respond with a signature created with this token id. Then, the issuer wraps user address(fetched from some database), token id and signature as input to calls "redeem" of the NFT contract, which will mint a new NFT to the target user on verification success. 
-
+  经过验证的空投方式. 可能在下面这种场景中出现, 比如项目方准备空投 NFT 给一些用户, 那么项目方先发送一个邮件给该用户, 邮件中包含此 NFT 的 tokenID. 用户收到邮件后, 在线下根据 toukenID 和 账户地址进行签名, 然后发送给项目方. 项目方拿到用户签名后, 调用空投合约的 redeem 接口, 传入 account, tokenId, signature. 其中 account, tokenId 需要从预先保留的项目方数据库中获取, 以验证该用户确实对应该 NFT. 如果验证通过, 则生成一个 NFT 给该用户.
 
   ```js
-  // Signature
+  // 签名
   this.token.signature = await this.accounts[1].signMessage(hashToken(this.token.tokenId, this.token.account));
 
-  // Post the signature to blockchain
+  // 签名上链验证
   await expect(this.registry.redeem(this.token.account, this.token.tokenId, this.token.signature))
     .to.emit(this.registry, 'Transfer')
     .withArgs(ethers.constants.AddressZero, this.token.account, this.token.tokenId);
   ```
 
 - ERC721LazyMintWith712  
-  In the above example, we create signature with a parameter maybe friendly to machine but not that friendly to humans. Moreover, when Metamask pops up for signing we do not know what is being signed. We prefer a more structured, more readable scheme for us to see what data will be signed. EIP-712 address this point; It can display the data to be signed to user, and the generated signature will be verified by smart contract. The whole process is similiar to that in ERC721LazyMint. 
-
-  Here is a example for creating signature by EIP-712:
+  在传统的签名方式中, 我们直接调用签名接口, 传入需要的签名参数, 这个过程中我们无法直观的感知需要签名具体参数意义, 特别是当 MetaMask 弹出提示, 需要你对一笔数据进行签名时, 如果不能结构化的看到需要签名的具体数据, 我们可能会拒绝签名这笔交易.
+  EIP-712 就是在用户签名时把结构化数据展示给他们确认的场景. 之后链上确认签名是否正确, 过程和 ERC721LazyMint 类似
+  链下签名样例如下:
 
   ```js
   // Domain
@@ -75,7 +74,7 @@ Please refer to the code: contracts/redpacket
   ```
 
 - ERC721LazyMintWith712SignatureChecker  
-  This demo is similiar to ERC721LazyMintWith712 but with a SignatureChecker inside.
+  和 ERC721LazyMintWith712 类似, 唯一的区别就是在链上进行验证时, 增加了 SignatureChecker
 
   ```js
   function _verify(address signer, bytes32 digest, bytes memory signature)
@@ -86,96 +85,96 @@ Please refer to the code: contracts/redpacket
   ```
 
 - ERC721MerkleDrop  
-  A merkle proof is generated and sent to blockchain for verification, if valid,  the newly created NTT is minted to specific user.
+  链下生成 Merkle 证明, 之后把 Merkle 证明发送到链上进行验证, 验证通过后, 就会给用户生成相应的 NFT token
 
   ```js
-  // Generate merkle proof offchain
+  // 链下生成 Merkle 证明
   this.token.proof = this.merkleTree.getHexProof(hashToken(this.token.tokenId, this.token.account));
 
-  // Verify the proof and mint to some user. Whole process happens onchain.
+  // 调用链上接口进行验证, 同时生成 NFT token
   await expect(this.registry.redeem(this.token.account, this.token.tokenId, this.token.signature))
     .to.emit(this.registry, 'Transfer')
     .withArgs(ethers.constants.AddressZero, this.token.account, this.token.tokenId);
   ```
 
-## Quickstart
+## 测试流程
 
 ### Merkle airdrop
 
-- Install dependencies
+- 安装依赖
 
   ```bash
   yarn
   ```
 
-- Test
+- 执行测试程序
 
   ```bash
   npx hardhat test
   ```
 
 ### HappyRedPacket
 
-- Setup enviroments
+- 配置环境环境变量
 
   ```shell
   cp .env.exmpale .env
 
-  ## Please configure PRIVATE_KEY, PRIVATE_KEY1, PRIVATE_KEY2,INFURA_ID, PROJECT_ID, TARGET_ACCOUNT in .env
-  ## PRIVATE_KEY is the private key of your wallet account ， while TARGET_ACCOUNT is your wallet address.
-  ## If you want multiple accounts trying to claim the same redpacket, please configures multiple PRIVATE_KEYs.
+  ## 在 .env 文件中配置 PRIVATE_KEY, PRIVATE_KEY1, PRIVATE_KEY2,INFURA_ID, PROJECT_ID, TARGET_ACCOUNT
+  ## 比如有一个账户 A , 那么 PRIVATE_KEY 为账户 A 对应的 PRIVATE_KEY， TARGET_ACCOUNT 为账户 A 对应的账户地址
+  ## 模拟多人抢红包，需要配置三个私钥
   ```
 
-- Install dependencies
+- 安装依赖
 
   ```shell
   yarn
   ```
 
-- Deploy ERC20 smart contract
-   Execute the following command and we take "Token address" from output as address of the deployed contract.
+- 部署 ERC20 合约  
+  执行如下命令，然后获取输出的 "Token address" 值
 
   ```shell
   npx hardhat run scripts/redpacket/1-deploySimpleToken.js --network kovan
 
-  ## Console output
+  ## 输入信息如下:
   Deploying contracts with the account: 0x3238f24e7C752398872B768Ace7dd63c54CfEFEc
   Account balance: 796474026501725149
   Token address: 0xdc6999dC3f818B4f74550569CCC7C82091cA419F
   1000000000
   ```
 
-- Deploy RedPacket smart contract
-  Execute the following command and we take "RedPacket address" from output as address of the deployed contract.
+- 部署 RedPacket 合约  
+  执行如下命令，然后获取输出的 "RedPacket address" 值
 
   ```shell
   npx hardhat run scripts/redpacket/2-deployHappyRedPacket.js --network kovan
 
-  ## Console output
+  ## 输出信息如下:
   Deploying contracts with the account: 0x3238f24e7C752398872B768Ace7dd63c54CfEFEc
   Account balance: 783625061469463255
   RedPacket address: 0x6F35e57a7421F5b04DDb47b67453A5a5Be32e58B
   ```
 
-- Create a red packet  
+- 创建红包  
   ```shell
   npx hardhat run scripts/redpacket/3-createRedPacket.js --network kovan
 
-  ## Console output
+  ## 输出值
   Approve Successfully
   merkleTree Root: 0x5cc6f1ff34a2c6f871d40cdc4559468f96a7ec06d7bf6ab0f9b5aeccc9b33154
   CreationSuccess Event, total: 10000   RedpacketId: 0x45eb11e56a1b699f5e99bd16785c84b73a8257c712e0d1f31306ab1e3423b2e0
   Create Red Packet successfully
   ```
 
-- Claim packet
+- 领取红包
   ```shell
   npx hardhat run scripts/redpacket/4-claimRedpacket.js --network kovan
 
-  ## We can see "Sign Message:" followed by a signature verified by smart contract 
+  ## 得到的输出 "Sign Message:" 即为领取红包时需要输入的签名信息，防止恶意领取
   ```
 
-## References
+## 参考链接
 
 - <https://github.com/Anish-Agnihotri/merkle-airdrop-starter>
 - <https://github.com/OpenZeppelin/workshops/tree/master/06-nft-merkle-drop/contracts>