Merge pull request #8 from kostysh/refactor/remove-zksync

refactor: 💡 Fallback repo from zkSync to Hardhat

Author: kostysh

.env.example

@@ -1,2 +1,17 @@
 NODE_ENV=test
-INFURA_API_KEY=<KEY>
+
+# network specific node uri : `"ETH_NODE_URI_" + networkName.toUpperCase()`
+ETH_NODE_URI_MAINNET=https://eth-mainnet.alchemyapi.io/v2/<apiKey>
+# generic node uri (if no specific found) :
+ETH_NODE_URI=https://{{networkName}}.infura.io/v3/<apiKey>
+
+# network specific mnemonic : `"MNEMONIC_ " + networkName.toUpperCase()`
+MNEMONIC_MAINNET=<mnemonic for mainnet>
+# generic mnemonic (if no specific found):
+MNEMONIC=<mnemonic>
+
+# coinmarketcap api key for gas report
+COINMARKETCAP_API_KEY=
+
+# etherscan api key
+ETHERSCAN_API_KEY=

.gitattributes

@@ -0,0 +1,3 @@
+*.sol linguist-language=Solidity
+*.ts linguist-language=Typescript
+* text=auto eol=lf

.github/workflows/test.yml

@@ -21,4 +21,4 @@ jobs:
       - name: Lint
         run: yarn lint
       - name: Test
-        run: yarn test:src
+        run: yarn test:src && yarn test:contracts

.solcover.js

@@ -0,0 +1,3 @@
+module.exports = {
+  skipFiles: ['test'],
+};

contracts/DealsRegistry.sol

@@ -333,36 +333,39 @@ abstract contract DealsRegistry is
   ) external {
     address buyer = _msgSender();
 
-    bytes32 offerHash = _hashTypedDataV4(hash(offer));
-    Supplier storage supplier = suppliers[offer.supplierId];
-
-    // Supplier who created an offer must be registered
-    if (supplier.signer == address(0)) {
-      revert InvalidSupplier();
-    }
+    /// @dev variable scoping used to avoid stack too deep errors
+    {
+      bytes32 offerHash = _hashTypedDataV4(hash(offer));
+      Supplier storage supplier = suppliers[offer.supplierId];
+
+      // Supplier who created an offer must be registered
+      if (supplier.signer == address(0)) {
+        revert InvalidSupplier();
+      }
 
-    // Checking ECDSA/AA signature is valid
-    if (!supplier.signer.isValidSignatureNow(offerHash, signs[0])) {
-      revert InvalidOfferSignature();
-    }
+      // Checking ECDSA/AA signature is valid
+      if (!supplier.signer.isValidSignatureNow(offerHash, signs[0])) {
+        revert InvalidOfferSignature();
+      }
 
-    // Not-enabled suppliers are not allowed to accept deals
-    // So, we cannot allow to create such a deal
-    if (!supplier.enabled) {
-      revert DisabledSupplier();
-    }
+      // Not-enabled suppliers are not allowed to accept deals
+      // So, we cannot allow to create such a deal
+      if (!supplier.enabled) {
+        revert DisabledSupplier();
+      }
 
-    // Deal can be created only once
-    if (deals[offer.id].offer.id == offer.id) {
-      revert DealExists();
-    }
+      // Deal can be created only once
+      if (deals[offer.id].offer.id == offer.id) {
+        revert DealExists();
+      }
 
-    bytes32 paymentHash = hash(paymentOptions);
+      bytes32 paymentHash = hash(paymentOptions);
 
-    // payment options provided with argument must be the same
-    // as signed in the offer
-    if (paymentHash != offer.paymentHash) {
-      revert InvalidPaymentOptions();
+      // payment options provided with argument must be the same
+      // as signed in the offer
+      if (paymentHash != offer.paymentHash) {
+        revert InvalidPaymentOptions();
+      }
     }
 
     uint256 price;

contracts/Market.sol

@@ -168,8 +168,7 @@ contract Market is Ownable, Pausable, DealsRegistry, ERC721Token {
       // Prevent transfer of token when this is not allowed by the offer
       // or the deal is in the non-transferrable status
       if (
-        !offerDeal.offer.transferable ||
-        offerDeal.status != DealStatus.Claimed
+        !offerDeal.offer.transferable || offerDeal.status != DealStatus.Claimed
       ) {
         revert TokenTransferNotAllowed();
       }

contracts/utils/SignatureUtils.sol

@@ -7,7 +7,7 @@ library SignatureUtils {
   /// @dev Splits signature into v/r/s form
   function split(
     bytes memory signature
-  ) public pure returns (uint8 v, bytes32 r, bytes32 s) {
+  ) internal pure returns (uint8 v, bytes32 r, bytes32 s) {
     if (signature.length == 65) {
       assembly {
         r := mload(add(signature, 0x20))

contracts/utils/StringUtils.sol

@@ -5,7 +5,7 @@ library StringUtils {
   function equal(
     string memory s1,
     string memory s2
-  ) public pure returns (bool) {
+  ) internal pure returns (bool) {
     return keccak256(abi.encodePacked(s1)) == keccak256(abi.encodePacked(s2));
   }
 }

coverage.json

@@ -0,0 +1,63 @@
+/* eslint-disable @typescript-eslint/unbound-method */
+import { HardhatRuntimeEnvironment } from 'hardhat/types';
+import { DeployFunction } from 'hardhat-deploy/types';
+import { eip712name, eip712version, minDeposit } from '../test/contracts/setup';
+
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
+  const { network, deployments, getNamedAccounts } = hre;
+
+  if (!['hardhat', 'localhost'].includes(network.name)) {
+    return;
+  }
+
+  const { deploy } = deployments;
+  const { owner } = await getNamedAccounts();
+
+  // Simple ERC20 token
+  const erc20 = await deploy('MockERC20Dec18', {
+    from: owner,
+    args: ['STABLE', 'STABLE', owner],
+    log: true,
+    autoMine: true,
+  });
+
+  if (erc20.newlyDeployed) {
+    console.log(
+      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+      `MockERC20Dec18 (erc20) was deployed at: ${erc20.address} using ${erc20.receipt?.gasUsed} gas`,
+    );
+  }
+
+  // ERC20 token with permit
+  const lif = await deploy('MockERC20Dec18Permit', {
+    from: owner,
+    args: ['LIF', 'LIF', owner],
+    log: true,
+    autoMine: true,
+  });
+
+  if (lif.newlyDeployed) {
+    console.log(
+      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+      `MockERC20Dec18Permit (lif) was deployed at: ${lif.address} using ${lif.receipt?.gasUsed} gas`,
+    );
+  }
+
+  // Market
+  const market = await deploy('Market', {
+    from: owner,
+    args: [owner, eip712name, eip712version, lif.address, minDeposit],
+    log: true,
+    autoMine: true,
+  });
+
+  if (market.newlyDeployed) {
+    console.log(
+      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+      `Market was deployed at: ${market.address} using ${market.receipt?.gasUsed} gas`,
+    );
+  }
+};
+
+export default func;
+func.tags = ['MockERC20Dec18', 'MockERC20Dec18Permit', 'Market'];