Merge pull request #23 from kostysh/refactor/no-ethers-src

refactor: 💡 Ethers removed from exports; Types for ethers-v6

Author: kostysh

.eslintignore

@@ -11,3 +11,5 @@ cache-zk
 artifacts
 cache
 ./**/*.sol
+typechain
+typechainV6

.gitignore

@@ -18,4 +18,5 @@ cache-zk
 artifacts
 cache
 typechain
+typechainV6
 network/volumes

.lintstagedrc

@@ -1,4 +1,4 @@
 {
-  "*.{ts,js}": ["prettier --write", "eslint --cache --fix"],
+  "*.{ts,js}": ["prettier --write", "eslint --config ./.eslintrc --ignore-path ./.eslintignore --cache --fix"],
   "*.md": ["prettier --write"]
 }

.prettierignore

@@ -13,3 +13,4 @@ artifacts
 cache
 network
 typechain
+typechainV6

deploy/001.ts

@@ -9,7 +9,7 @@ import {
   protocolFee,
   retailerFee,
   minDeposit,
-} from '../src';
+} from '../utils/constants';
 
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const { network, deployments, getNamedAccounts } = hre;

deploy/002.ts

@@ -9,7 +9,7 @@ import {
   protocolFee,
   retailerFee,
   minDeposit,
-} from '../src';
+} from '../utils/constants';
 
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const { network, deployments, getNamedAccounts } = hre;

package.json

@@ -89,14 +89,15 @@
     "typechain": "^8.1.1",
     "@typechain/hardhat": "^6.1.6",
     "@typechain/ethers-v5": "^10.2.1",
+    "@typechain/ethers-v6": "^0.3.2",
     "dotenv": "^16.0.3"
   },
   "dependencies": {
     "@openzeppelin/contracts-upgradeable": "^4.8.3"
   },
   "scripts": {
     "build:contracts": "hardhat compile",
-    "build:src": "rm -rf ./lib && tsc -p ./tsconfig.build.json",
+    "build:src": "rm -rf ./lib && typechain --target=ethers-v6 --out-dir typechainV6 artifacts/**/Config.json artifacts/**/EntitiesRegistry.json artifacts/**/Market.json && tsc -p ./tsconfig.build.json",
     "test:contracts": "hardhat test",
     "test:src": "mocha -t 60000 --extension spec.ts test/src",
     "lint": "solhint . && eslint --ext .ts",

src/constants.ts

@@ -1,20 +1,18 @@
-import { utils, BigNumber } from 'ethers';
-
-// utils.solidityKeccak256(
+// ethers.solidityPackedKeccak256(
 //   ['string'],
 //   ['PaymentOption(bytes32 id,uint256 price,address asset)'],
 // );
 export const PAYMENT_OPTION_TYPE_HASH =
   '0x2f8fc0b3ad3f58f6deb367673d38e4112a3c8c64de033c5b780b84ef8f67cde6';
 
-// utils.solidityKeccak256(
+// ethers.solidityPackedKeccak256(
 //   ['string'],
 //   ['CancelOption(uint256 time,uint256 penalty)'],
 // );
 export const CANCEL_OPTION_TYPE_HASH =
   '0x8ea27057ea8a0239f02c8b75748218a035a5a2a2a0785b53aaa99af91ff538c5';
 
-// utils.solidityKeccak256(
+// ethers.solidityPackedKeccak256(
 //   ['string'],
 //   [
 //     'Offer(bytes32 id,uint256 expire,bytes32 supplierId,uint256 chainId,bytes32 requestHash,bytes32 optionsHash,bytes32 paymentHash,bytes32 cancelHash,bool transferable,uint256 checkIn)',
@@ -23,28 +21,11 @@ export const CANCEL_OPTION_TYPE_HASH =
 export const OFFER_TYPE_HASH =
   '0xcf2addd2f89a78825d3f130a17e47b4e9963adfd09837fa9c454569faa073354';
 
-// utils.solidityKeccak256(
+// ethers.solidityPackedKeccak256(
 //   ['string'],
 //   [
 //     'Voucher(bytes32 id,address signer)',
 //   ],
 // );
 export const CHECK_IN_TYPE_HASH =
   '0xf811d7f3ddb148410001929e2cbfb7fea8779b9349b7c2f650fa91840528d69c';
-
-// Protocol entities types (kinds) as object
-export const kinds = {
-  supplier: utils.formatBytes32String('supplier'),
-  retailer: utils.formatBytes32String('retailer'),
-};
-
-// Protocol entities types (kinds) as values array
-export const kindsArr = Object.values(kinds);
-
-// Protocol defaults
-export const eip712name = 'Market';
-export const eip712version = '1';
-export const minDeposit = BigNumber.from('1000000000000000000000');
-export const claimPeriod = BigNumber.from('60');
-export const protocolFee = BigNumber.from('1');
-export const retailerFee = BigNumber.from('1');

test/contracts/EntitiesRegistry.test.ts

@@ -1,6 +1,6 @@
 import { expect } from 'chai';
 import { BigNumber, constants } from 'ethers';
-import { minDeposit, kinds } from '../../src';
+import { minDeposit, kinds } from '../../utils/constants';
 import { randomId, createSupplierId, createPermitSignature } from './utils';
 import { User, setup, registerEntity } from './setup';
 

test/contracts/Market.test.ts

@@ -2,8 +2,8 @@ import { expect } from 'chai';
 import { BigNumber, constants } from 'ethers';
 import { ethers } from 'hardhat';
 import { TransferEventObject } from '../../typechain/contracts/Market';
-import { kinds } from '../../src';
-import { Offer } from '../../src/types';
+import { kinds } from '../../utils/constants';
+import { Offer } from '../../utils/types';
 import {
   structEqual,
   buildRandomOffer,