Goerli mumbai (#292)

* refactor to root/child contract structure

* add rootsdk
- fix tests

* integrate with maticjs

* replace ChildERC20 to a mock

* Add license and compiler version

* Fix test pipeline

* FIx test

* Fix vesting contract test

* Only run unit test

* Clean `PermissionedExchange` in other contracts

* Skip exchange and airdropper test

* Fix maintenance test

* clean up fx portal stuff

* fix ts

* add solidity version for polygondest

* fix enum order

* fix test pipeline

* Fix exchange test

* Update doc

---------

Co-authored-by: mzxyz <8177474+mzxyz@users.noreply.github.com>

Author: ianhe8x

.env_template

@@ -1,3 +1,5 @@
-ENDPOINT=http://127.0.0.1:8545
-SEED=test test test test test test test test test test test junk
+CHILD_ENDPOINT=http://127.0.0.1:8545
+ROOT_ENDPOINT
+PK=
 ETHERSCAN_API_KEY=sjdkkdndnkdssnj
+POLYGONSCAN_API_KEY=

.github/workflows/pr.yml

@@ -19,4 +19,4 @@ jobs:
     - name: lint
       run: yarn lint
     - name: test
-      run: yarn test
+      run: yarn test:all

README.md

@@ -94,13 +94,14 @@ To verify the contracts deployment, run the following cmd to verify specific typ
 
 ### test
 
-`yarn test`
+Single Test
+`yarn test ./test/SQToken.test.ts`
 
 Note: After contract upgrade, should run below again.
 
 ```
     yarn build
-    yarn test
+    yarn test:all
     yarn mocha test/Staking.test.ts
     ...
 ```
@@ -119,13 +120,15 @@ Note: After contract upgrade, should run below again.
 
 Example
 ```shell
-yarn upgrade --testnet PlanManager
+yarn upgrade --network testnet --check-only=false --target child
+yarn upgrade --network testnet --check-only=false --target root
 ```
 
-### Verify Contract on Polygonscan
+### Verify Contract on Polygonscan / etherscan
 ```
 # set up ETHERSCAN_API_KEY in .env 
-yarn hardhat publish --deployment publish/kepler.json --network kepler 
+yarn hardhat publishChild --deployment publish/testnet.json --network testnet --networkpair testnet
+yarn hardhat publishRoot --deployment publish/testnet.json --network goerli --networkpair testnet
 ```
 
 ### Debug Script
@@ -158,3 +161,13 @@ You can find all revert code details at `./public/revertcode.json`
 ```
 https://wiki.polygon.technology/docs/pos/design/bridge/ethereum-polygon/getting-started/
 ```
+
+Deposit usually takes more than 20 min
+Withdraw takes moer than 40 min
+
+### Withdraw token
+For some rpcs, eth_getRootHash is not available, in that case, we should use withdrawExitFaster
+
+### TODOs
+to support L1&L2 token pair mode, we can not burn token in l2 (bridge layer) according to the standard-bridge doc. 
+Instead, we either can avoid burn token but switch to taking a fee to treasury, or we need to call cross chain transfer for burn token.

contracts/ConsumerHost.sol

@@ -147,7 +147,7 @@ contract ConsumerHost is Initializable, OwnableUpgradeable, IConsumer, ERC165 {
      */
     function collectFee(address account, uint256 amount) external onlyOwner {
         require(fee >= amount, 'C002');
-        IERC20(settings.getSQToken()).safeTransfer(account, amount);
+        IERC20(settings.getContractAddress(SQContracts.SQToken)).safeTransfer(account, amount);
         fee -= amount;
     }
 
@@ -197,7 +197,7 @@ contract ConsumerHost is Initializable, OwnableUpgradeable, IConsumer, ERC165 {
      * @notice Approve host can use consumer balance
      */
     function approve() external {
-        require(!(IEraManager(settings.getEraManager()).maintenance()), 'G019');
+        require(!(IEraManager(settings.getContractAddress(SQContracts.EraManager)).maintenance()), 'G019');
         Consumer storage consumer = consumers[msg.sender];
         consumer.approved = true;
         emit Approve(msg.sender);
@@ -207,7 +207,7 @@ contract ConsumerHost is Initializable, OwnableUpgradeable, IConsumer, ERC165 {
      * @notice Disapprove host can use consumer balance
      */
     function disapprove() external {
-        require(!(IEraManager(settings.getEraManager()).maintenance()), 'G019');
+        require(!(IEraManager(settings.getContractAddress(SQContracts.EraManager)).maintenance()), 'G019');
         Consumer storage consumer = consumers[msg.sender];
         consumer.approved = false;
         emit Disapprove(msg.sender);
@@ -218,11 +218,11 @@ contract ConsumerHost is Initializable, OwnableUpgradeable, IConsumer, ERC165 {
      * @param amount the amount
      */
     function deposit(uint256 amount, bool isApprove) external {
-        require(!(IEraManager(settings.getEraManager()).maintenance()), 'G019');
+        require(!(IEraManager(settings.getContractAddress(SQContracts.EraManager)).maintenance()), 'G019');
         // transfer the balance to contract
-        IERC20 sqt = IERC20(settings.getSQToken());
+        IERC20 sqt = IERC20(settings.getContractAddress(SQContracts.SQToken));
         sqt.safeTransferFrom(msg.sender, address(this), amount);
-        sqt.safeIncreaseAllowance(settings.getStateChannel(), amount);
+        sqt.safeIncreaseAllowance(settings.getContractAddress(SQContracts.StateChannel), amount);
 
         Consumer storage consumer = consumers[msg.sender];
         consumer.balance += amount;
@@ -239,12 +239,12 @@ contract ConsumerHost is Initializable, OwnableUpgradeable, IConsumer, ERC165 {
      * @param amount the amount
      */
     function withdraw(uint256 amount) external {
-        require(!(IEraManager(settings.getEraManager()).maintenance()), 'G019');
+        require(!(IEraManager(settings.getContractAddress(SQContracts.EraManager)).maintenance()), 'G019');
         Consumer storage consumer = consumers[msg.sender];
         require(consumer.balance >= amount, 'C002');
 
         // transfer the balance to consumer
-        IERC20(settings.getSQToken()).safeTransfer(msg.sender, amount);
+        IERC20(settings.getContractAddress(SQContracts.SQToken)).safeTransfer(msg.sender, amount);
         consumer.balance -= amount;
 
         emit Withdraw(msg.sender, amount, consumer.balance);
@@ -262,7 +262,7 @@ contract ConsumerHost is Initializable, OwnableUpgradeable, IConsumer, ERC165 {
         uint256 amount,
         bytes memory callback
     ) external {
-        require(msg.sender == settings.getStateChannel(), 'G011');
+        require(msg.sender == settings.getContractAddress(SQContracts.StateChannel), 'G011');
         (address consumer, bytes memory sign) = abi.decode(callback, (address, bytes));
         if (channels[channelId] == address(0)) {
             channels[channelId] = consumer;
@@ -280,7 +280,7 @@ contract ConsumerHost is Initializable, OwnableUpgradeable, IConsumer, ERC165 {
             bytes32 payload = keccak256(abi.encode(channelId, amount, nonce));
             bytes32 hash = keccak256(abi.encodePacked('\x19Ethereum Signed Message:\n32', payload));
             address sConsumer = ECDSA.recover(hash, sign);
-            require(sConsumer == consumer || IConsumerRegistry(settings.getConsumerRegistry()).isController(consumer, sConsumer), 'C006');
+            require(sConsumer == consumer || IConsumerRegistry(settings.getContractAddress(SQContracts.ConsumerRegistry)).isController(consumer, sConsumer), 'C006');
             info.nonce = nonce + 1;
 
             require(sConsumer == sender, 'C010');
@@ -300,7 +300,7 @@ contract ConsumerHost is Initializable, OwnableUpgradeable, IConsumer, ERC165 {
      * @param amount the amount back to consumer
      */
     function claimed(uint256 channelId, uint256 amount) external {
-        require(msg.sender == settings.getStateChannel(), 'G011');
+        require(msg.sender == settings.getContractAddress(SQContracts.StateChannel), 'G011');
 
         address consumer = channels[channelId];
         Consumer storage info = consumers[consumer];
@@ -328,7 +328,7 @@ contract ConsumerHost is Initializable, OwnableUpgradeable, IConsumer, ERC165 {
         if (signerIndex[sConsumer] > 0) {
             return true;
         }
-        return channels[channelId] == sConsumer || IConsumerRegistry(settings.getConsumerRegistry()).isController(channels[channelId], sConsumer);
+        return channels[channelId] == sConsumer || IConsumerRegistry(settings.getContractAddress(SQContracts.ConsumerRegistry)).isController(channels[channelId], sConsumer);
     }
 
     /**

contracts/DisputeManager.sol

@@ -77,7 +77,7 @@ contract DisputeManager is IDisputeManager, Initializable, OwnableUpgradeable {
     ) external {
         require(disputeIdByIndexer[_indexer].length <= 20, 'D001');
         require(_deposit >= minimumDeposit, 'D002');
-        IERC20(settings.getSQToken()).safeTransferFrom(msg.sender, address(this), _deposit);
+        IERC20(settings.getContractAddress(SQContracts.SQToken)).safeTransferFrom(msg.sender, address(this), _deposit);
 
         Dispute storage dispute = disputes[nextDisputeId];
         dispute.disputeId = nextDisputeId;
@@ -103,7 +103,7 @@ contract DisputeManager is IDisputeManager, Initializable, OwnableUpgradeable {
             require(newDeposit > dispute.depositAmount, 'D005');
             uint256 rewardAmount = newDeposit - dispute.depositAmount;
             require(rewardAmount <= indexerSlashAmount, 'D005');
-            IStakingManager(settings.getStakingManager()).slashIndexer(dispute.indexer, indexerSlashAmount);
+            IStakingManager(settings.getContractAddress(SQContracts.StakingManager)).slashIndexer(dispute.indexer, indexerSlashAmount);
         } else if (state == DisputeState.Rejected) {
             //reject dispute, slash fisherman
             require(newDeposit < dispute.depositAmount, 'D005');
@@ -113,7 +113,7 @@ contract DisputeManager is IDisputeManager, Initializable, OwnableUpgradeable {
         }
 
         dispute.state = state;
-        IERC20(settings.getSQToken()).safeTransfer(dispute.fisherman, newDeposit);
+        IERC20(settings.getContractAddress(SQContracts.SQToken)).safeTransfer(dispute.fisherman, newDeposit);
 
         uint256[] memory ids = disputeIdByIndexer[dispute.indexer];
         delete disputeIdByIndexer[dispute.indexer];

contracts/IndexerRegistry.sol

@@ -139,7 +139,7 @@ contract IndexerRegistry is Initializable, OwnableUpgradeable, Constants {
 
         metadata[msg.sender] = _metadata;
         setInitialCommissionRate(msg.sender, rate);
-        IStakingManager(settings.getStakingManager()).stake(msg.sender, amount);
+        IStakingManager(settings.getContractAddress(SQContracts.StakingManager)).stake(msg.sender, amount);
 
         emit RegisterIndexer(msg.sender, amount, _metadata);
     }
@@ -149,12 +149,12 @@ contract IndexerRegistry is Initializable, OwnableUpgradeable, Constants {
      *  This function will call unstake for Indexer to make sure indexer unstaking all staked SQT Token after unregister.
      */
     function unregisterIndexer() external onlyIndexer {
-        require(IProjectRegistry(settings.getProjectRegistry()).numberOfDeployments(msg.sender) == 0, 'IR004');
+        require(IProjectRegistry(settings.getContractAddress(SQContracts.ProjectRegistry)).numberOfDeployments(msg.sender) == 0, 'IR004');
 
         delete metadata[msg.sender];
         delete controllers[msg.sender];
 
-        IStakingManager stakingManager = IStakingManager(settings.getStakingManager());
+        IStakingManager stakingManager = IStakingManager(settings.getContractAddress(SQContracts.StakingManager));
         uint256 amount = stakingManager.getAfterDelegationAmount(msg.sender, msg.sender);
         stakingManager.unstake(msg.sender, amount);
 
@@ -216,11 +216,11 @@ contract IndexerRegistry is Initializable, OwnableUpgradeable, Constants {
      * when indexer do registration. The commissionRate need to apply at once.
      */
     function setInitialCommissionRate(address indexer, uint256 rate) private {
-        IRewardsStaking rewardsStaking = IRewardsStaking(settings.getRewardsStaking());
+        IRewardsStaking rewardsStaking = IRewardsStaking(settings.getContractAddress(SQContracts.RewardsStaking));
         require(rewardsStaking.getTotalStakingAmount(indexer) == 0, 'RS001');
         require(rate <= PER_MILL, 'IR006');
 
-        uint256 eraNumber = IEraManager(settings.getEraManager()).safeUpdateAndGetEra();
+        uint256 eraNumber = IEraManager(settings.getContractAddress(SQContracts.EraManager)).safeUpdateAndGetEra();
         commissionRates[indexer] = CommissionRate(eraNumber, rate, rate);
 
         emit SetCommissionRate(indexer, rate);
@@ -233,8 +233,8 @@ contract IndexerRegistry is Initializable, OwnableUpgradeable, Constants {
     function setCommissionRate(uint256 rate) external onlyIndexer {
         require(rate <= PER_MILL, 'IR006');
 
-        uint256 eraNumber = IEraManager(settings.getEraManager()).safeUpdateAndGetEra();
-        IRewardsStaking(settings.getRewardsStaking()).onICRChange(msg.sender, eraNumber + 2);
+        uint256 eraNumber = IEraManager(settings.getContractAddress(SQContracts.EraManager)).safeUpdateAndGetEra();
+        IRewardsStaking(settings.getContractAddress(SQContracts.RewardsStaking)).onICRChange(msg.sender, eraNumber + 2);
 
         CommissionRate storage commissionRate = commissionRates[msg.sender];
         if (commissionRate.era < eraNumber) {
@@ -247,7 +247,7 @@ contract IndexerRegistry is Initializable, OwnableUpgradeable, Constants {
     }
 
     function getCommissionRate(address indexer) external view returns (uint256) {
-        uint256 era = IEraManager(settings.getEraManager()).eraNumber();
+        uint256 era = IEraManager(settings.getContractAddress(SQContracts.EraManager)).eraNumber();
         CommissionRate memory rate = commissionRates[indexer];
         if ((rate.era + 1) < era) {
             return rate.valueAfter;

contracts/PermissionedExchange.sol

@@ -228,12 +228,12 @@ contract PermissionedExchange is Initializable, OwnableUpgradeable {
      * @param _amount The amount to trade.
      */
     function trade(uint256 _orderId, uint256 _amount) public {
-        require(!(IEraManager(settings.getEraManager()).maintenance()), 'G019');
+        require(!(IEraManager(settings.getContractAddress(SQContracts.EraManager)).maintenance()), 'G019');
         ExchangeOrder storage order = orders[_orderId];
-        if (order.tokenGet == settings.getSQToken()) {
+        if (order.tokenGet == settings.getContractAddress(SQContracts.SQToken)) {
             require(tradeQuota[order.tokenGet][msg.sender] >= _amount, 'PE005');
         }
-        if (order.tokenGive == settings.getSQToken()) {
+        if (order.tokenGive == settings.getContractAddress(SQContracts.SQToken)) {
             require(_amount <= tradeLimitation, 'PE012');
             accumulatedTrades[msg.sender] = accumulatedTrades[msg.sender] + _amount;
             require(accumulatedTrades[msg.sender] <= tradeLimitationPerAccount, 'PE013');
@@ -243,7 +243,7 @@ contract PermissionedExchange is Initializable, OwnableUpgradeable {
         require(amount > 0, 'PE007');
         require(amount <= order.tokenGiveBalance, 'PE008');
         order.tokenGiveBalance -= amount;
-        if (order.tokenGet == settings.getSQToken()) {
+        if (order.tokenGet == settings.getContractAddress(SQContracts.SQToken)) {
             tradeQuota[order.tokenGet][msg.sender] -= _amount;
         }
         if (order.pairOrderId != 0){
@@ -262,7 +262,7 @@ contract PermissionedExchange is Initializable, OwnableUpgradeable {
      * @param _orderId The order id to settle.
      */
     function settleExpiredOrder(uint256 _orderId) public {
-        require(!(IEraManager(settings.getEraManager()).maintenance()), 'G019');
+        require(!(IEraManager(settings.getContractAddress(SQContracts.EraManager)).maintenance()), 'G019');
         ExchangeOrder memory order = orders[_orderId];
         require(order.expireDate != 0, 'PE009');
         require(order.expireDate < block.timestamp, 'PE010');

contracts/PlanManager.sol

@@ -154,7 +154,7 @@ contract PlanManager is Initializable, OwnableUpgradeable, IPlanManager {
      * @param deploymentId project deployment Id on plan
      */
     function createPlan(uint256 price, uint256 templateId, bytes32 deploymentId) external {
-        require(!(IEraManager(settings.getEraManager()).maintenance()), 'G019');
+        require(!(IEraManager(settings.getContractAddress(SQContracts.EraManager)).maintenance()), 'G019');
         require(price > 0, 'PM005');
         require(getPlanTemplate(templateId).active, 'PM006');
         require(limits[msg.sender][deploymentId] < limit, 'PM007');
@@ -171,7 +171,7 @@ contract PlanManager is Initializable, OwnableUpgradeable, IPlanManager {
      * @param planId Plan id to remove
      */
     function removePlan(uint256 planId) external {
-        require(!(IEraManager(settings.getEraManager()).maintenance()), 'G019');
+        require(!(IEraManager(settings.getContractAddress(SQContracts.EraManager)).maintenance()), 'G019');
         require(plans[planId].indexer == msg.sender, 'PM008');
 
         bytes32 deploymentId = plans[planId].deploymentId;
@@ -188,7 +188,7 @@ contract PlanManager is Initializable, OwnableUpgradeable, IPlanManager {
      * @param deploymentId project deployment Id
      */
     function acceptPlan(uint256 planId, bytes32 deploymentId) external {
-        require(!(IEraManager(settings.getEraManager()).maintenance()), 'G019');
+        require(!(IEraManager(settings.getContractAddress(SQContracts.EraManager)).maintenance()), 'G019');
         Plan memory plan = plans[planId];
         require(plan.active, 'PM009');
         if (plan.deploymentId != bytes32(0)) {
@@ -201,7 +201,7 @@ contract PlanManager is Initializable, OwnableUpgradeable, IPlanManager {
         //stable price mode
         PlanTemplateV2 memory template = getPlanTemplate(plan.templateId);
         require(template.active, 'PM006');
-        uint256 sqtPrice = IPriceOracle(settings.getPriceOracle()).convertPrice(template.priceToken, settings.getSQToken(), plan.price);
+        uint256 sqtPrice = IPriceOracle(settings.getContractAddress(SQContracts.PriceOracle)).convertPrice(template.priceToken, settings.getContractAddress(SQContracts.SQToken), plan.price);
 
         // create closed service agreement contract
         ClosedServiceAgreementInfo memory agreement = ClosedServiceAgreementInfo(
@@ -216,10 +216,10 @@ contract PlanManager is Initializable, OwnableUpgradeable, IPlanManager {
         );
 
         // deposit SQToken into serviceAgreementRegistry contract
-        IERC20(settings.getSQToken()).transferFrom(msg.sender, settings.getServiceAgreementRegistry(), sqtPrice);
+        IERC20(settings.getContractAddress(SQContracts.SQToken)).transferFrom(msg.sender, settings.getContractAddress(SQContracts.ServiceAgreementRegistry), sqtPrice);
 
         // register the agreement to service agreement registry contract
-        IServiceAgreementRegistry registry = IServiceAgreementRegistry(settings.getServiceAgreementRegistry());
+        IServiceAgreementRegistry registry = IServiceAgreementRegistry(settings.getContractAddress(SQContracts.ServiceAgreementRegistry));
         registry.createClosedServiceAgreement(agreement, true);
     }
 
@@ -244,7 +244,7 @@ contract PlanManager is Initializable, OwnableUpgradeable, IPlanManager {
             return v2templates[templateId];
         } else {
             PlanTemplate memory v1template = templates[templateId];
-            return PlanTemplateV2(v1template.period, v1template.dailyReqCap, v1template.rateLimit, settings.getSQToken(), v1template.metadata, v1template.active);
+            return PlanTemplateV2(v1template.period, v1template.dailyReqCap, v1template.rateLimit, settings.getContractAddress(SQContracts.SQToken), v1template.metadata, v1template.active);
         }
     }
 }

contracts/ProjectRegistry.sol

@@ -69,7 +69,7 @@ contract ProjectRegistry is Initializable, OwnableUpgradeable, ERC721Upgradeable
     /// @dev MODIFIER
     /// @notice only indexer can call
     modifier onlyIndexer() {
-        require(IIndexerRegistry(settings.getIndexerRegistry()).isIndexer(msg.sender), 'G002');
+        require(IIndexerRegistry(settings.getContractAddress(SQContracts.IndexerRegistry)).isIndexer(msg.sender), 'G002');
         _;
     }
 
@@ -226,7 +226,7 @@ contract ProjectRegistry is Initializable, OwnableUpgradeable, ERC721Upgradeable
 
         require(currentStatus == ServiceStatus.READY, 'PR005');
         require(
-            !IServiceAgreementExtra(settings.getServiceAgreementExtra()).hasOngoingClosedServiceAgreement(
+            !IServiceAgreementExtra(settings.getContractAddress(SQContracts.ServiceAgreementExtra)).hasOngoingClosedServiceAgreement(
                 msg.sender,
                 deploymentId
             ),