Intro to zk sync

README.md

@@ -1,2 +1,29 @@
 # cryptozombies-lesson-code
-cryptozomebie lesson code
+
+![CryptoZombies](https://user-images.githubusercontent.com/13703497/69648502-c8f3db80-10ae-11ea-9d52-ce4d4bbc426a.jpeg)
+
+
+## Overview
+This repository contains source codes for [Cryptozombies](https://cryptozombies.io/en/) lessons.
+
+The source codes are divided into `courses` and `chapters` as folders and chapters contain Solidity sample codes for each `lesson`.
+
+> _NOTE: Lesson 7, 8, 9 has been removed and currently no source code is available for those lessons._
+
+## How To Use
+You can simply clone the project to your local storage with following command:
+
+```
+git clone https://github.com/loomnetwork/cryptozombies-lesson-code.git
+```
+
+Or fork it to modify the sample codes for your own study.
+
+If you found any error in the codes while you study, Feel free to submit pull requests or issues.
+
+>_WARNING: Please note that these codes are just sample codes, so DO NOT use them on production._
+
+## License
+[![License shields](https://img.shields.io/badge/License-GPL%20v3-blue)](https://www.gnu.org/licenses/gpl-3.0)
+
+This project is licensed under the GNU General Public License v3.0. See the [LICENSE](https://github.com/loomnetwork/cryptozombies-lesson-code/blob/master/LICENSE) file for details.

lesson-17/chapter-10/src/bob.js

@@ -0,0 +1,8 @@
+(async () => {
+  const ethers = require('ethers')
+  const zksync = require('zksync')
+  const utils = require('./utils')
+
+  const zkSyncProvider = await utils.getZkSyncProvider(zksync, process.env.NETWORK_NAME);
+  const ethersProvider = await utils.getEthereumProvider(ethers, process.env.NETWORK_NAME);
+})()

lesson-17/chapter-10/src/utils.js

@@ -0,0 +1,120 @@
+async function getZkSyncProvider(zksync, networkName) {
+    let zkSyncProvider;
+    try {
+        zkSyncProvider = await zksync.getDefaultProvider(networkName);
+    } catch(error) {
+        console.log('Unable to connect to zkSync.')
+        console.log(error)
+    }
+    return zkSyncProvider;
+}
+
+async function getEthereumProvider (ethers, networkName) {
+  let ethersProvider
+  try {
+    // eslint-disable-next-line new-cap
+    ethersProvider = new ethers.getDefaultProvider(networkName)
+  } catch (error) {
+    console.log('Could not connect to Rinkeby')
+    console.log(error)
+  }
+  return ethersProvider
+}
+
+async function initAccount(rinkebyWallet, zkSyncProvider, zksync)
+{
+    const zkSyncWallet = await zksync.Wallet.fromEthSigner(rinkebyWallet, zkSyncProvider);
+    return zkSyncWallet;
+}
+
+async function registerAccount (wallet)
+{
+  console.log(`Registering the ${wallet.address()} account on zkSync`)
+  if(!await wallet.isSigningKeySet())
+  {
+      if (await wallet.getAccountId() === undefined)
+      {
+        throw new Error('Unknown account')
+      }
+      const changePubkey = await wallet.setSigningKey();
+      await changePubkey.awaitReceipt();
+  }
+  console.log(`Account ${wallet.address()} registered`)
+}
+
+async function depositToZkSync(zkSyncWallet, token, amountToDeposit, ethers)
+{
+    const deposit = await zkSyncWallet.depositToSyncFromEthereum({
+        depositTo: zkSyncWallet.address(),
+        token: token,
+        amount: ethers.utils.parseEther(amountToDeposit)
+      });
+    try {
+        await deposit.awaitReceipt();
+    } catch (error) {
+        console.log('Error while awaiting confirmation from the zkSync operators.');
+        console.log(error);
+    }
+}
+
+async function transfer (from, toAddress, amountToTransfer, transferFee, token, zksync, ethers) {
+    const closestPackableAmount = zksync.utils.closestPackableTransactionAmount(ethers.utils.parseEther(amountToTransfer));
+    const closestPackableFee = zksync.utils.closestPackableTransactionFee(ethers.utils.parseEther(transferFee));
+
+    const transfer = await from.syncTransfer({
+        to: toAddress,
+        token: token,
+        amount: closestPackableAmount,
+        fee: closestPackableFee
+    });
+    const transferReceipt = await transfer.awaitReceipt();
+    console.log('Got transfer receipt.');
+    console.log(transferReceipt);
+}
+
+async function getFee(transactionType, address, token, zkSyncProvider, ethers)
+{
+    const feeInWei = await zkSyncProvider.getTransactionFee(transactionType, address, token);
+    return ethers.utils.formatEther(feeInWei.totalFee.toString());
+}
+
+async function withdrawToEthereum (wallet, amountToWithdraw, withdrawalFee, token, zksync, ethers)
+{
+    const closestPackableAmount = zksync.utils.closestPackableTransactionAmount(ethers.utils.parseEther(amountToWithdraw));
+    const closestPackableFee = zksync.utils.closestPackableTransactionFee(ethers.utils.parseEther(withdrawalFee));
+    const withdraw = await wallet.withdrawFromSyncToEthereum({
+        ethAddress: wallet.address(),
+        token: token,
+        amount: closestPackableAmount,
+        fee: closestPackableFee
+    });
+    await withdraw.awaitVerifyReceipt();
+    console.log('ZKP verification is complete')
+}
+
+async function displayZkSyncBalance(wallet, ethers)
+{
+    const state = await wallet.getAccountState();
+    if(state.committed.balances.ETH) {
+        console.log(`Commited ETH balance for ${wallet.address()}: ${ethers.utils.formatEther(state.committed.balances.ETH)}`);
+    } else {
+        console.log(`Commited ETH balance for ${wallet.address()}: 0`);
+    }
+    if(state.verified.balances.ETH) {
+        console.log(`Verified ETH balance for ${wallet.address()}: ${ethers.utils.formatEther(state.verified.balances.ETH)}`);
+    } else {
+        console.log(`Verified ETH balance for ${wallet.address()}: 0`);
+    }
+}
+
+module.exports = {
+  getZkSyncProvider,
+  getEthereumProvider,
+  depositToZkSync,
+  registerAccount,
+  displayZkSyncBalance,
+  transfer,
+  withdrawToEthereum,
+  getFee,
+  initAccount
+}

lesson-17/chapter-11/src/bob.js

@@ -0,0 +1,13 @@
+(async () => {
+  const ethers = require('ethers')
+  const zksync = require('zksync')
+  const utils = require('./utils')
+
+  const zkSyncProvider = await utils.getZkSyncProvider(zksync, process.env.NETWORK_NAME);
+  const ethersProvider = await utils.getEthereumProvider(ethers, process.env.NETWORK_NAME);
+
+  const bobRinkebyWallet = new ethers.Wallet(process.env.BOB_PRIVATE_KEY, ethersProvider);
+  console.log(`Bob's Rinkeby address is: ${bobRinkebyWallet.address}`);
+  console.log(`Bob's initial balance on Rinkeby is: ${ethers.utils.formatEther(await bobRinkebyWallet.getBalance())}`);
+  const bobZkSyncWallet = await utils.initAccount(bobRinkebyWallet, zkSyncProvider, zksync);
+})()

lesson-17/chapter-11/src/utils.js

@@ -0,0 +1,120 @@
+async function getZkSyncProvider(zksync, networkName) {
+    let zkSyncProvider;
+    try {
+        zkSyncProvider = await zksync.getDefaultProvider(networkName);
+    } catch(error) {
+        console.log('Unable to connect to zkSync.')
+        console.log(error)
+    }
+    return zkSyncProvider;
+}
+
+async function getEthereumProvider (ethers, networkName) {
+  let ethersProvider
+  try {
+    // eslint-disable-next-line new-cap
+    ethersProvider = new ethers.getDefaultProvider(networkName)
+  } catch (error) {
+    console.log('Could not connect to Rinkeby')
+    console.log(error)
+  }
+  return ethersProvider
+}
+
+async function initAccount(rinkebyWallet, zkSyncProvider, zksync)
+{
+    const zkSyncWallet = await zksync.Wallet.fromEthSigner(rinkebyWallet, zkSyncProvider);
+    return zkSyncWallet;
+}
+
+async function registerAccount (wallet)
+{
+  console.log(`Registering the ${wallet.address()} account on zkSync`)
+  if(!await wallet.isSigningKeySet())
+  {
+      if (await wallet.getAccountId() === undefined)
+      {
+        throw new Error('Unknown account')
+      }
+      const changePubkey = await wallet.setSigningKey();
+      await changePubkey.awaitReceipt();
+  }
+  console.log(`Account ${wallet.address()} registered`)
+}
+
+async function depositToZkSync(zkSyncWallet, token, amountToDeposit, ethers)
+{
+    const deposit = await zkSyncWallet.depositToSyncFromEthereum({
+        depositTo: zkSyncWallet.address(),
+        token: token,
+        amount: ethers.utils.parseEther(amountToDeposit)
+      });
+    try {
+        await deposit.awaitReceipt();
+    } catch (error) {
+        console.log('Error while awaiting confirmation from the zkSync operators.');
+        console.log(error);
+    }
+}
+
+async function transfer (from, toAddress, amountToTransfer, transferFee, token, zksync, ethers) {
+    const closestPackableAmount = zksync.utils.closestPackableTransactionAmount(ethers.utils.parseEther(amountToTransfer));
+    const closestPackableFee = zksync.utils.closestPackableTransactionFee(ethers.utils.parseEther(transferFee));
+
+    const transfer = await from.syncTransfer({
+        to: toAddress,
+        token: token,
+        amount: closestPackableAmount,
+        fee: closestPackableFee
+    });
+    const transferReceipt = await transfer.awaitReceipt();
+    console.log('Got transfer receipt.');
+    console.log(transferReceipt);
+}
+
+async function getFee(transactionType, address, token, zkSyncProvider, ethers)
+{
+    const feeInWei = await zkSyncProvider.getTransactionFee(transactionType, address, token);
+    return ethers.utils.formatEther(feeInWei.totalFee.toString());
+}
+
+async function withdrawToEthereum (wallet, amountToWithdraw, withdrawalFee, token, zksync, ethers)
+{
+    const closestPackableAmount = zksync.utils.closestPackableTransactionAmount(ethers.utils.parseEther(amountToWithdraw));
+    const closestPackableFee = zksync.utils.closestPackableTransactionFee(ethers.utils.parseEther(withdrawalFee));
+    const withdraw = await wallet.withdrawFromSyncToEthereum({
+        ethAddress: wallet.address(),
+        token: token,
+        amount: closestPackableAmount,
+        fee: closestPackableFee
+    });
+    await withdraw.awaitVerifyReceipt();
+    console.log('ZKP verification is complete')
+}
+
+async function displayZkSyncBalance(wallet, ethers)
+{
+    const state = await wallet.getAccountState();
+    if(state.committed.balances.ETH) {
+        console.log(`Commited ETH balance for ${wallet.address()}: ${ethers.utils.formatEther(state.committed.balances.ETH)}`);
+    } else {
+        console.log(`Commited ETH balance for ${wallet.address()}: 0`);
+    }
+    if(state.verified.balances.ETH) {
+        console.log(`Verified ETH balance for ${wallet.address()}: ${ethers.utils.formatEther(state.verified.balances.ETH)}`);
+    } else {
+        console.log(`Verified ETH balance for ${wallet.address()}: 0`);
+    }
+}
+
+module.exports = {
+  getZkSyncProvider,
+  getEthereumProvider,
+  depositToZkSync,
+  registerAccount,
+  displayZkSyncBalance,
+  transfer,
+  withdrawToEthereum,
+  getFee,
+  initAccount
+}

lesson-17/chapter-12/src/bob.js

@@ -0,0 +1,25 @@
+(async () => {
+  const ethers = require('ethers')
+  const zksync = require('zksync')
+  const utils = require('./utils')
+  const SLEEP_INTERVAL = process.env.SLEEP_INTERVAL || 5000
+
+  const zkSyncProvider = await utils.getZkSyncProvider(zksync, process.env.NETWORK_NAME);
+  const ethersProvider = await utils.getEthereumProvider(ethers, process.env.NETWORK_NAME);
+
+  const bobRinkebyWallet = new ethers.Wallet(process.env.BOB_PRIVATE_KEY, ethersProvider);
+  console.log(`Bob's Rinkeby address is: ${bobRinkebyWallet.address}`);
+  console.log(`Bob's initial balance on Rinkeby is: ${ethers.utils.formatEther(await bobRinkebyWallet.getBalance())}`);
+  const bobZkSyncWallet = await utils.initAccount(bobRinkebyWallet, zkSyncProvider, zksync);
+
+  process.on('SIGINT', () => {
+    console.log('Disconnecting')
+    // Disconnect
+    process.exit()
+  })
+  setInterval(async () => {
+    await utils.displayZkSyncBalance(bobZkSyncWallet, ethers);
+    console.log('---')
+  }, SLEEP_INTERVAL)
+
+})()