update readm.md

translate doc to english
Cuteprob · May 4, 2022 · d15588c · d15588c
1 parent a0853a2
commit d15588c
Show file tree

Hide file tree

Showing 8 changed files with 326 additions and 64 deletions.
diff --git a/basic/28-optimism-layer2/README-CN.md b/basic/28-optimism-layer2/README-CN.md
@@ -0,0 +1,64 @@
+# Optimism 
+## 简介 
+Optimistic Rollups（OR）是一种第二层解决方案，也就是说不直接在以太坊基础层中构建，而是基于以太坊进行构建。好处在于可以规模化运行智能合约，同时还能受到共享以太坊的安全性。其构造类似于Plasma，虽然无法达到Plasma几近无限的扩容能力，OR选择使用与EVM兼容的OVM（Optimistic虚拟机），使其能够像以太坊一样运作。
+
+其名称“Opmistic Rollup”源自于这个解决方案本身的特征。之所以采用“Optimistic”（乐观），是因为聚合者仅发布最少量的所需信息，而无需提供任何证明，前提是聚合者没有实施欺诈行为，且仅在发生欺诈时提供证明。之所以使用“Rollups”，是因为交易以捆绑形式提交到主链（也即，交易被rolled-up）  
+
+## 测试步骤  
+- URI ETH 跨链  
+Optimism 测试网络链接的是 kovan 网, 在 Optimistic 测试网路上进行交易前, 需要把 kovan 网络的 ETH 经过跨链桥跨到 optimism. 
+访问 Optimism 的 gateway, 选择 "Deposite" , 在其中输入跨链的 ETH 数量   
+<center><img src="https://github.com/Dapp-Learning-DAO/Dapp-Learning-Arsenal/blob/main/images/basic/28-optimism-layer2/deposite.png?raw=true" /></center>
+
+
+- 等待资产跨链成功  
+需要等待 5 分钟左右才能完成 ETH 的跨链转移.  
+跨链成功后, 会出现如下提示  
+<center><img src="https://github.com/Dapp-Learning-DAO/Dapp-Learning-Arsenal/blob/main/images/basic/28-optimism-layer2/deposite_success.png?raw=true" /></center>
+
+- 查看余额  
+ETH 转移成功后, 可以从 metaMask 查看 Optimism 网络上的余额  
+<center><img src="https://github.com/Dapp-Learning-DAO/Dapp-Learning-Arsenal/blob/main/images/basic/28-optimism-layer2/balance.png?raw=true" /></center> 
+
+- 安装依赖  
+```bash
+yarn
+```
+
+- 配置环境变量   
+复制 .env.example 文件为 .env 文件, 然后配置其中的 PRIVATE_KEY,INFURA_ID  
+
+- 创建合约   
+```bash
+❯ npx hardhat run scripts/deploy.js --network optimism
+Deploying contracts with the account: 0xa3F2Cf140F9446AC4a57E9B72986Ce081dB61E75
+Account balance: 1500000000000000000
+Token address: 0x0d29e73F0b1AE67e28495880636e2407e41480F2
+```
+
+- 脚本 ETH 跨链到 Optimism 网络    
+上面除来可以通过 Optimism 的界面进行跨梁外, 还可以通过调用合约的方式进行 ETH 跨链  
+调用如下脚本, 通过调用合约的方式进行 ETH 跨链
+```
+npx hardhat run scripts/deposit-eth.js --network kovan
+
+## 调用结束后, 等待大约 5 分钟, 就可以发现 metaMask 上, Optimism 网络上账户余额增加了 0.0001 ETH
+```
+
+- 脚本 ETH 跨链到 Kovan 网络    
+跨链到 Optimism 链上的 ETH 还可以跨回 Kovan 链. 
+调用如下脚本, 通过调用合约的方式进行 ETH 跨链
+```
+npx hardhat run scripts/withdraw-eth.js --network optimism
+
+## 调用结束后, 等待大约 5 分钟, 就可以发现 metaMask 上, kovan 网络上账户余额增加了 0.0001 ETH
+```
+
+
+## 参考文档  
+optimism 官方 github: https://github.com/ethereum-optimism/optimism-tutorial  
+Optimistic Rollup 合约介绍:  https://medium.com/plasma-group/ethereum-smart-contracts-in-l2-optimistic-rollup-2c1cef2ec537  
+Optimism Rollup原理解析: https://zhuanlan.zhihu.com/p/350541979  
+Optimism 跨链桥: https://gateway.optimism.io/  
+Optimism Kovan deposite proxy 合约: https://kovan.etherscan.io/address/0x22f24361d548e5faafb36d1437839f080363982b#code  
+Optimism Kovan withdraw proxy 合约: https://kovan-optimistic.etherscan.io/address/0x4200000000000000000000000000000000000010   
diff --git a/basic/28-optimism-layer2/readme.md b/basic/28-optimism-layer2/readme.md
@@ -1,64 +1,65 @@
 # Optimism 
-## 简介 
-Optimistic Rollups（OR）是一种第二层解决方案，也就是说不直接在以太坊基础层中构建，而是基于以太坊进行构建。好处在于可以规模化运行智能合约，同时还能受到共享以太坊的安全性。其构造类似于Plasma，虽然无法达到Plasma几近无限的扩容能力，OR选择使用与EVM兼容的OVM（Optimistic虚拟机），使其能够像以太坊一样运作。
+## Abstract   
+Optimistic Rollups（OR）is a Layer2 solution，which means it's not an independent chain，but relys on Ethereum mainnet。The benefits of such construction are that it can not only run smart contracts at scale，but also enjoys the benefit of Ethereum security，just similar to Plasma，but have less capacity of transactions。OR chooses to use OVM（Optimistic Virtual Machine）compatible with EVM，allowing contracts to have same behavior on both sides.
 
-其名称“Opmistic Rollup”源自于这个解决方案本身的特征。之所以采用“Optimistic”（乐观），是因为聚合者仅发布最少量的所需信息，而无需提供任何证明，前提是聚合者没有实施欺诈行为，且仅在发生欺诈时提供证明。之所以使用“Rollups”，是因为交易以捆绑形式提交到主链（也即，交易被rolled-up）  
+The name "Opmistic Rollup" comes from the characteristics of the solution itself。 Optimistic means less infomation for aggregator to publish ，and no need to provide any proof。 Rollup means transactions are submitted to L1 in bundles。 
 
-## 测试步骤  
-- URI ETH 跨链  
-Optimism 测试网络链接的是 kovan 网, 在 Optimistic 测试网路上进行交易前, 需要把 kovan 网络的 ETH 经过跨链桥跨到 optimism. 
-访问 Optimism 的 gateway, 选择 "Deposite" , 在其中输入跨链的 ETH 数量   
+## Test steps   
+### ETH cross-chain with Optimism gateway    
+- Deposite ETH to Optimistic     
+Optimism testnet links to Kovan testnet。 Before we send transactions to Optimistic， we need to deposite ETH to Optimistic first。  
+Visit Optimism gateway，then choose "Deposite" ，and input ETH amount     
 <center><img src="https://github.com/Dapp-Learning-DAO/Dapp-Learning-Arsenal/blob/main/images/basic/28-optimism-layer2/deposite.png?raw=true" /></center>
 
 
-- 等待资产跨链成功  
-需要等待 5 分钟左右才能完成 ETH 的跨链转移.  
-跨链成功后, 会出现如下提示  
+- Waiting for deposite finish    
+If deposite successfully，you'll see following message on the web page  
 <center><img src="https://github.com/Dapp-Learning-DAO/Dapp-Learning-Arsenal/blob/main/images/basic/28-optimism-layer2/deposite_success.png?raw=true" /></center>
 
-- 查看余额  
-ETH 转移成功后, 可以从 metaMask 查看 Optimism 网络上的余额  
+- Check Balance    
+After ETH deposite successfully，check balance on Optimistic with MetaMask     
 <center><img src="https://github.com/Dapp-Learning-DAO/Dapp-Learning-Arsenal/blob/main/images/basic/28-optimism-layer2/balance.png?raw=true" /></center> 
 
-- 安装依赖  
+- Install dependencies    
 ```bash
 yarn
 ```
 
-- 配置环境变量   
-复制 .env.example 文件为 .env 文件, 然后配置其中的 PRIVATE_KEY,INFURA_ID  
+- Config env parameters     
+Use template .env.example to create .env ，then config PRIVATE_KEY && INFURA_ID in it    
 
-- 创建合约   
+- Deploy Contract   
 ```bash
 ❯ npx hardhat run scripts/deploy.js --network optimism
 Deploying contracts with the account: 0xa3F2Cf140F9446AC4a57E9B72986Ce081dB61E75
 Account balance: 1500000000000000000
 Token address: 0x0d29e73F0b1AE67e28495880636e2407e41480F2
 ```
 
-- 脚本 ETH 跨链到 Optimism 网络    
-上面除来可以通过 Optimism 的界面进行跨梁外, 还可以通过调用合约的方式进行 ETH 跨链  
-调用如下脚本, 通过调用合约的方式进行 ETH 跨链
+### ETH cross-chain with script       
+- Deposite ETH to Optimism with script  
+In addition to do cross-chain through UI，we can also do it with script。      
+In the following script，by calling cross-chain contract on Kovan side， ETH will be deposited to Optimism。  
 ```
 npx hardhat run scripts/deposit-eth.js --network kovan
 
-## 调用结束后, 等待大约 5 分钟, 就可以发现 metaMask 上, Optimism 网络上账户余额增加了 0.0001 ETH
+## It will takes about 5 minuts to finish the deposite，then it will add 0.0001 ETH to your account on Optimism side  
 ```
 
-- 脚本 ETH 跨链到 Kovan 网络    
-跨链到 Optimism 链上的 ETH 还可以跨回 Kovan 链. 
-调用如下脚本, 通过调用合约的方式进行 ETH 跨链
+- Withdraw ETH to Kovan       
+After deposite ETH to Optimism，we can also withdraw it back to Kovan。  
+Similar to deposite，we just call cross-chain contract on Optimism side，ETH will be withdrawed to Kovan。 
 ```
 npx hardhat run scripts/withdraw-eth.js --network optimism
 
-## 调用结束后, 等待大约 5 分钟, 就可以发现 metaMask 上, kovan 网络上账户余额增加了 0.0001 ETH
+## It will takes about 5 minuts to finish the withdraw，then it will add 0.0001 ETH to your account on Kovan side 
 ```
 
 
-## 参考文档  
-optimism 官方 github: https://github.com/ethereum-optimism/optimism-tutorial  
-Optimistic Rollup 合约介绍:  https://medium.com/plasma-group/ethereum-smart-contracts-in-l2-optimistic-rollup-2c1cef2ec537  
-Optimism Rollup原理解析: https://zhuanlan.zhihu.com/p/350541979  
-Optimism 跨链桥: https://gateway.optimism.io/  
-Optimism Kovan deposite proxy 合约: https://kovan.etherscan.io/address/0x22f24361d548e5faafb36d1437839f080363982b#code  
-Optimism Kovan withdraw proxy 合约: https://kovan-optimistic.etherscan.io/address/0x4200000000000000000000000000000000000010   
+## References    
+optimism github: https://github.com/ethereum-optimism/optimism-tutorial     
+Optimistic Rollup contracts:  https://medium.com/plasma-group/ethereum-smart-contracts-in-l2-optimistic-rollup-2c1cef2ec537      
+Optimism Rollup Principle Explanation : https://zhuanlan.zhihu.com/p/350541979    
+Optimism Cross Bridge : https://gateway.optimism.io/   
+Optimism Kovan deposite proxy contract : https://kovan.etherscan.io/address/0x22f24361d548e5faafb36d1437839f080363982b#code      
+Optimism Kovan withdraw proxy contract : https://kovan-optimistic.etherscan.io/address/0x4200000000000000000000000000000000000010   
diff --git a/basic/29-Polygon(matic)-layer2/README-CN.md b/basic/29-Polygon(matic)-layer2/README-CN.md
@@ -0,0 +1,114 @@
+# Polygon
+
+Polygon 的目标不是提供一两个扩展解决方案，而是创建一个生态系统，使其能够轻松连接多个不同的扩展解决方案——从具有不同共识机制的侧链到第二层网络，如 Plasma、Optimistic rollups 和 ZK rollups。  
+
+Polygon 支持与以太坊兼容的两种区块链网络：独立网络（stand-alone network）和安全链（secured chain）
+- 独立网络依赖于它们自己的安全性，例如，它们可以有自己的共识模型，如权益证明（PoS）或委托权益证明（DPoS）  
+- 安全链使用“安全即服务”模型。它可以由以太坊直接提供，例如通过 Plasma 使用的欺诈证明（fraud proofs），或由专业验证节点提供。这些验证节点运行在 Polygon 生态系统中，可以被多个项目共享——这个概念类似于波卡的共享安全模型
+
+当谈到 Polygon 的架构时，我们需要关注的主要要点是它被刻意地设计成通用和抽象的。这允许其他希望扩展的应用程序选择最适合其需求的扩展解决方案。
+
+<center><img src="https://github.com/Dapp-Learning-DAO/Dapp-Learning-Arsenal/blob/main/images/basic/29-Polygon(matic)-layer2/matic.jpeg?raw=true" /></center>
+
+<br/>
+<br/>
+
+## Polygon 扩容方案
+
+<center>
+    <img src="https://img.chainnews.com/material/images/a0172d4158f8e2529fd3d04d8142e818.jpg-article" alt="matic.jpeg" style="zoom:50%;" />
+</center>
+
+## Matic Plasma Chain
+
+---
+
+[(Polygon Plasma Chain)](https://docs.matic.network/docs/develop/ethereum-matic/plasma/getting-started) Plasma 允许使用者将交易从主链转移到子链，从而实现快速和廉价的交易。Plasma 的一个缺点是用户从第 2 层网络中提取资金需要很长的等待时间。Plasma 不能用于扩展通用的智能合约。
+
+## Matic PoS Chain
+
+---
+
+[(Polygon PoS Chain)](https://docs.matic.network/docs/develop/ethereum-matic/pos/getting-started/) Matic PoS Chain 是一个未经许可的侧链，它与以太坊链并行运行。该链由具有自身验证节点的权益证明共识机制来保护。尽管 Matic PoS Chain 有自己的共识机制，但在验证节点 staking 和检查点方面，它也依赖于以太坊的安全性。
+
+## Polygon Hermez ZKRollup
+
+---
+
+[(Hermez ZKEvm)](https://www.chainnews.com/articles/018319341743.htm) 基于简洁的有效性证明（又称零知识证明）的以太坊第 2 层解决方案，在以太坊上定期提交和验证。
+
+## Polygon SDK
+
+---
+
+[(Polygon SDK)](https://polygon.technology/polygon-sdk/) 一个模块化和可扩展的框架，用于构建兼容 Ethereum 的区块链网络，用 Golang 编写。
+
+## Polygon Avail
+
+---
+
+[(Polygon Data Avail)](https://blog.polygon.technology/introducing-avail-by-polygon-a-robust-general-purpose-scalable-data-availability-layer-98bc9814c048) Avail 是一个通用的、可扩展的、专注于数据可用性的区块链，针对独立链、侧链和链外扩展解决方案。
+
+<br/>
+<br/>
+
+# 参考资源
+
+## 1 综合资源
+
+---
+
+### Polygon 介绍
+
+- [Polygon 精简介绍](https://biquan365.com/12636.html)
+- [Polygon 基础介绍和使用教程](https://www.yuque.com/docs/share/8e737364-c380-418e-af21-0f07095fe900)
+- [Polygon 架构](https://docs.matic.network/docs/contribute/matic-architecture)
+- [Polygon 上的 Meta-transactions](https://docs.matic.network/docs/develop/metatransactions/getting-started)
+- [Matic Network 白皮书中文版](https://www.chainnews.com/articles/022315243415.htm)
+
+### 官方网站
+
+- [Polygon 官网](https://polygon.technology/)
+- [Polygon 网络浏览器](https://polygonscan.com/)
+- [Polygon 文档](https://docs.matic.network/)
+- [Awesome Polygon (所有在 Polygon 网络上部署的项目)](http://awesomepolygon.com/)
+
+### 开发者入口
+
+- [Polygon 开发入门](https://docs.matic.network/docs/develop/getting-started)
+- [Matic 主网](https://rpc-mainnet.maticvigil.com)
+- [Mumbai 测试网](https://rpc-mumbai.maticvigil.com)
+- [Polygon 测试币](https://faucet.matic.network/)
+
+## 2 Polygon 申请
+
+---
+
+- [Polygon 官宣申请表](https://airtable.com/shrDaWf1UYNzkhTbg)
+- [Polygon Grant 申请](https://polygon.technology/developer-support-program/)
+
+## 3 Polygon 开发者资源
+
+---
+
+### How to
+
+- [如何使用预言机](https://docs.matic.network/docs/develop/oracles/getting-started)
+- [如何使用 Chainlink](https://docs.matic.network/docs/develop/oracles/chainlink)
+- [如何接入支付工具](https://docs.matic.network/docs/develop/fiat-on-ramp)
+- [如何使用 TheGraph](https://docs.matic.network/docs/develop/graph)
+- [如何使用 hardhat](https://docs.matic.network/docs/develop/hardhat/)
+- [如何设置 Infura RPC](https://www.youtube.com/watch?v=jz6idHfMGvk)
+
+### 工具
+
+- [Gas 费预测](https://docs.matic.network/docs/develop/tools/matic-gas-station/#usage)
+- [Polygon 网络浏览器的 APIs](https://polygonscan.com/apis)
+- [Matic.js SDK](https://github.com/maticnetwork/matic.js)
+- [Alchemy 开发者工具套件](https://www.alchemy.com/)
+- [Decentology Dapp 模版](https://dappstarter.decentology.com/)
+
+### 教程
+
+- [在 Polygon 上创建 NFT，资产部署在 IPFS 上](https://medium.com/pinata/how-to-create-layer-2-nfts-with-polygon-and-ipfs-aef998ff8ef2)
+- [以太坊二层 Polygon 网络 NFT 开发教程](https://cloud.tencent.com/developer/article/1828250)
diff --git a/basic/30-zksync-layer2/README-CN.md b/basic/30-zksync-layer2/README-CN.md
@@ -0,0 +1,87 @@
+# zksync 介绍   
+zkSync是一种无需信任的协议，用于在以太坊上进行可扩展的低成本支付，由 zkRollup 技术提供支持。它使用零知识证明和链上数据可用性来确保用户的资金安全，就像这些资产从未离开过主网一样。 
+
+## zkSync2.0
+zkSync发布了2.0测试网，开始支持智能合约。这里有一个简单的dApp例子，大家可以进行体验。
+https://github.com/Dapp-Learning-DAO/Dapp-Learning/tree/main/basic/30-zksync-layer2/zkSync2.0-examples
+
+## ZK-Rollup
+zkRollup在链下利用Merkle tree存储账户状态，由Operator收集用户的交易，交易收集完成后Operator会执行每个交易（校验余额，校验nonce，校验签名，执行状态转换），当交易执行完成后会产生一个新的Merkle tree Root，为了证明链下状态转移是正确的，Operator会在交易执行完成后生成一个零知识证明的proof。
+Operator执行交易后本地的merkle tree root会由prev state root转换成post state root。  
+<center><img src="https://github.com/Dapp-Learning-DAO/Dapp-Learning-Arsenal/blob/main/images/basic/30-zksync-layer2/zkrollup.png?raw=true" /></center>
+
+## 基本架构
+
+zkSync 的基本组成有：
+
+- zkSync smart contract：部署在以太坊网络上的 Solidity 智能合约，用于管理用户 balances 并验证 zkSync network 操作的正确性。
+
+- Prover application：为 a worker application，用于创建 a proof for an executed block。  
+  Prover application 会从 Server application 中获取有效的 jobs，当有新的区块时，Server application 将提供 a witness（input data to generate a proof），然后 Prover application 开始工作。当 proof 生成后，Prover application 会将该 proof 报告给 Server application，Server application 再将该 proof 发布给 zkSync 智能合约。
+
+- Prover application 可看成是 on-demand worker，当 Server application 负载很高时，允许有多个 Prover applications，当没有交易输入时则没有 Prover application。
+生成 proof 是非常消耗资源的工作，因此，运行 Prover application 的机器应具有现代 CPU 和大量的 RAM。
+
+- Server application：运行 zkSync 网络的节点。
+Server application 的职能主要有：  
+1）监测智能合约上的 onchain operations（如存款）  
+2）接收交易  
+3）生成 zkSync 上的区块  
+4）为 executed blocks 发起 proof 生成申请  
+5）将数据发布到 zkSync smart contract    
+
+## 操作流程  
+### 手工存入 ETH 到 zksync   
+- 登陆 [zksync 测试网](https://wallet.zksync.io/?network=rinkeby)  并链接 metaMask 钱包  
+
+- 选择 "Add Funds"   
+
+- 输入存入金额, 然后点击 "Add Funds"  
+
+- 存入成功  
+
+- 点击 "OK" 查看 rinkeby zkSync 上的余额  
+
+- 在 [zkscan](https://rinkeby.zkscan.io/) 上查看交易信息  
+
+### 使用 JS 在 zkSync 上发送交易  
+- 安装依赖 
+```shell
+yarn
+``` 
+
+- 配置环境变量  
+```shell
+cp .env.example .env
+
+## 在 .env 文件配置 PRIVATE_KEY , INFURA_API_KEY 
+```
+
+- 执行测试脚本  
+```shell
+npx hardhat run scripts/main.js
+```
+
+## 参考链接  
+github: https://github.com/matter-labs/zksync  
+zkSync 基本原理: https://zhuanlan.zhihu.com/p/363029544  
+zkSync 源码分析: https://www.jianshu.com/u/ac3aed07477e  
+L2 - zkSync源代码导读: https://zhuanlan.zhihu.com/p/343212894   
+Layer 2 扩容方案及用例综述: https://mp.weixin.qq.com/s/TxZ5W9rx6OF8qB4ZU9XrKA   
+各个 Layer 2 方案比较及考虑点:  https://blog.matter-labs.io/evaluating-ethereum-l2-scaling-solutions-a-comparison-framework-b6b2f410f955  
+zkSync 官网: https://zksync.io/  
+zkSync twitter: https://twitter.com/zksync  
+zkSync discord: https://discord.com/invite/px2aR7w  
+zkSync telegram: https://t.me/zksync  
+深入理解 Plasma: https://learnblockchain.cn/2018/10/20/plasma-framework   
+7大扩容方案: https://picture.iczhiku.com/weixin/message1625468135177.html  
+rinkeby 桥:  https://rinkeby.zksync.io  
+ZKSync 协议介绍: https://www.jianshu.com/p/8821f1e63dc9  
+zkSync rinkeby scan: https://rinkeby.zkscan.io/  
+NFT 上传: https://app.pinata.cloud/  
+zigzag 介绍:  https://docs.zigzag.exchange/  
+一文读懂 Layer2 方案 zkSync 基本原理：https://zhuanlan.zhihu.com/p/363029544
+zksync 源码分析： https://www.jianshu.com/u/ac3aed07477e  
+李星L2 - zkSync源代码导读： https://zhuanlan.zhihu.com/p/343212894  
+以太坊 Layer 2 扩容方案及用例综述： https://mp.weixin.qq.com/s/TxZ5W9rx6OF8qB4ZU9XrKA
+zkSync2.0 example : https://v2-docs.zksync.io/dev/guide/hello-world.html