add plasma and pos test for polygon

Author: liberhe

Example29-layer2-matic/package.json

@@ -6,6 +6,7 @@
     "chai": "^4.3.4",
     "ethereum-waffle": "^3.3.0",
     "ethers": "^5.3.1",
-    "hardhat": "^2.3.3"
+    "hardhat": "^2.3.3",
+    "@maticnetwork/maticjs": "2.0.43"
   }
 }

Example29-layer2-matic/principle.md

@@ -0,0 +1,36 @@
+# Polygon
+
+[matic官方文档](https://docs.matic.network/docs/develop/getting-started)
+
+## 原理
+Currently, developers can use Plasma for specific state transitions for which Plasma predicates have been written such as ERC20, ERC721, asset swaps or other custom predicates. For arbitrary state transitions, they can use PoS. Or both! This is made possible by Matic's hybrid construction.
+POS chain
+Plasma chain （Plasma Bridge）
+
+A bridge is basically a set of contracts that help in moving assets from the root chain to the child chain. 
+However, there are certain restrictions on the child token and there is a 7-day withdrawal period associated with all exits/withdraws from Matic to Ethereum on the Plasma bridge
+7天延迟从matic撤回主网
+
+The PoS Bridge is more flexible and features faster withdrawals.
+pos更快
+secured by a robust set of external validators.
+
+两部分 主链/ 子链
+
+L1- L2 交互
+1 状态同步  验证着周期提供所有交易的hash到主链， 检查点用于验证发生在matic上的任何交易，
+2
+马蹄的验证者需要持续监控链上合约 称为状态发送者  
+
+
+
+
+## 参考链接
+
+https://www.yuque.com/docs/share/8e737364-c380-418e-af21-0f07095fe900
+
+使用教程: https://cloud.tencent.com/developer/article/1828250
+
+hardhat: https://docs.matic.network/docs/develop/hardhat/
+
+https://medium.com/pinata/how-to-create-layer-2-nfts-with-polygon-and-ipfs-aef998ff8ef2

Example29-layer2-matic/readme.md

@@ -23,3 +23,6 @@ https://www.yuque.com/docs/share/8e737364-c380-418e-af21-0f07095fe900
 hardhat: https://docs.matic.network/docs/develop/hardhat/
 
 https://medium.com/pinata/how-to-create-layer-2-nfts-with-polygon-and-ipfs-aef998ff8ef2
+
+https://github.com/maticnetwork/matic.js/tree/master/examples  maticjs
+

Example29-layer2-matic/scripts/plasma.js

@@ -0,0 +1,56 @@
+
+const { waffle } = require("hardhat");
+
+const utils = require('./utils')
+
+async function execute() {
+    const { matic, network } = await utils.getMaticClient()
+    const { from } = utils.getAccount()
+    
+    const token = network.Main.Contracts.Tokens.MaticWeth
+    const amount = matic.web3Client.web3.utils.toWei('1.567')
+    
+    // deposit
+    await matic.depositEther(token, from, amount).then((res) => {
+    console.log("deposit hash: ", res.transactionHash)
+    })
+    //When a token is deposited from Ethereum to Matic, a process called state sync mechanism comes into play that eventually mints the tokens for the user on the Matic chain
+    
+    // transfer
+    const recipient = "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266";
+    
+    const amount1 = matic.web3Client.web3.utils.toWei("1.23");
+    
+    await matic.transferEther(recipient, amount1, { from, parent: false })
+        .then((res) => {
+            console.log("Transfer hash: ", res.transactionHash);
+        });
+
+     //withdraw
+    // 1 burn
+    const amount2 = matic.web3Client.web3.utils.toWei("5.678");
+    
+    await matic.startWithdraw(token, amount2, { from }).then((res) => {
+        console.log("Burn hash: ", res.transactionHash);
+    });
+    
+    // wait 30m
+    
+    //This function can be called only after the checkpoint is included in the main chain
+    // 2 confirm-withdraw
+    const txHash = "<>";
+    await matic.withdraw(txHash, { from, gas: "7000000" }).then((res) => {
+        console.log("Confirm withdraw hash: ", res.transactionHash);
+    });
+    
+    //Process Exit
+    await matic.processExits(token, { from, gas: 7000000 }).then((res) => {
+        console.log("Exit hash: ", res.transactionHash);
+    });
+    
+    
+    
+    
+}
+
+execute().then(_ => process.exit(0))

Example29-layer2-matic/scripts/pos.js

@@ -0,0 +1,40 @@
+
+const { waffle } = require("hardhat");
+
+async function main() {
+    const [owner] = await ethers.getSigners();
+    console.log("owner address ",owner.address)
+    let result = await owner.getBalance();
+    console.log("balance ", ethers.utils.formatEther(result))
+    
+    const parentProvider = 'https://goerli.infura.io/v3/0aae8358bfe04803b8e75bb4755eaf07'
+    const maticProvider = 'https://polygon-mumbai.infura.io/v3/0aae8358bfe04803b8e75bb4755eaf07'
+    // for mumbai testnet
+    const maticPOSClient = new MaticPOSClient({
+        network: "testnet",
+        version: "mumbai",
+        parentProvider: parentProvider,
+        maticProvider: maticProvider});
+    
+    //deposit
+    await maticPOSClient.depositEtherForUser(from, amount, {
+        from,
+        gasPrice: "10000000000",
+    });
+    //  takes about ~5-7 minutes.
+    
+    //burn
+    await maticPOSClient.burnERC20(childToken, amount, { from });
+    
+    
+    await maticPOSClient.exitERC20(burnTxHash, { from });
+}
+
+// We recommend this pattern to be able to use async/await everywhere
+// and properly handle errors.
+main()
+    .then(() => process.exit(0))
+    .catch(error => {
+        console.error(error);
+        process.exit(1);
+    });

Example29-layer2-matic/scripts/utis.js

@@ -0,0 +1,41 @@
+const bn = require("bn.js");
+const HDWalletProvider = require("@truffle/hdwallet-provider");
+
+const Network = require("@maticnetwork/meta/network");
+const Matic = require("@maticnetwork/maticjs").default;
+
+const SCALING_FACTOR = new bn(10).pow(new bn(18));
+
+async function getMaticClient(_network = "testnet", _version = "mumbai") {
+	const network = new Network(_network, _version);
+	const { from } = getAccount();
+	const matic = new Matic({
+		network: _network,
+		version: _version,
+		parentProvider: new HDWalletProvider(
+			process.env.PRIVATE_KEY,
+			network.Main.RPC
+		),
+		maticProvider: new HDWalletProvider(
+			process.env.PRIVATE_KEY,
+			network.Matic.RPC
+		),
+		parentDefaultOptions: { from },
+		maticDefaultOptions: { from },
+	});
+	await matic.initialize();
+	return { matic, network };
+}
+
+function getAccount() {
+	if (!process.env.PRIVATE_KEY || !process.env.FROM) {
+		throw new Error("Please set the PRIVATE_KEY/FROM env vars");
+	}
+	return { privateKey: process.env.PRIVATE_KEY, from: process.env.FROM };
+}
+
+module.exports = {
+	SCALING_FACTOR,
+	getMaticClient,
+	getAccount,
+};