Tech Debt cleanup & refactoring of network service with unit test coverage!

e2e-tests/lib/gatewayAction.ts

@@ -26,6 +26,17 @@ const networkNames = {
   },
 }
 
+const withDrawalNetworkNames = {
+  eth: {
+    toNetwork: 'Ethereum (Sepolia)',
+    fromNetwork: 'Boba (Sepolia)',
+  },
+  bnb: {
+    toNetwork: 'BNB Testnet',
+    fromNetwork: 'Boba BNB Testnet',
+  },
+}
+
 export class GatewayAction {
   basePage: BasePage
   bridgePage: BridgePage
@@ -96,7 +107,7 @@ export class GatewayAction {
     await this.bridgePage.validateAndConfirmBridging({
       amount: amountToBridge,
       token: tokenSymbol,
-      ...networkNames[networkKey],
+      ...withDrawalNetworkNames[networkKey],
       estimatedTime: '7 days',
     })
     await this.bridgePage.reviewAndInitiateWithdrawal()

e2e-tests/pages/bridgePage.ts

@@ -41,7 +41,7 @@ export class BridgePage extends BasePage {
     estimatedTime: string
   }) {
     await expect(this.page.getByTestId('amountToRecieve')).toHaveText(
-      `${Number(amount).toFixed(4)} ${token}`
+      `${parseFloat(Number(amount).toFixed(4))} ${token}`
     )
 
     const estTime = await this.page
@@ -55,7 +55,9 @@ export class BridgePage extends BasePage {
       .textContent()
 
     // TODO: update value with fee calculation.
-    expect(estRecievable).toBe(`${Number(amount).toFixed(4)} ${token}`)
+    expect(estRecievable).toBe(
+      `${parseFloat(Number(amount).toFixed(4))} ${token}`
+    )
   }
 
   async clickToBridge() {

package.json

@@ -11,11 +11,12 @@
     "lint:fix": "yarn lint:check --fix",
     "postinstall": "patch-package",
     "pre-commit": "lint-staged",
+    "listDead": "ts-prune",
     "prebuild": "./bin/release.sh",
     "prepare": "husky install",
     "start": "GENERATE_SOURCEMAP=false react-app-rewired start",
     "test": "TZ=utc react-scripts test --watchAll=false",
-    "test:coverage": "yarn test --coverage",
+    "test:coverage": "yarn test --coverage && jest-coverage-badges output \"./badges\" ",
     "test:u": "yarn test -u",
     "test:w": "yarn test --watchAll=true"
   },
@@ -57,7 +58,6 @@
     "http-browserify": "^1.7.0",
     "https-browserify": "^1.0.0",
     "human-standard-token-abi": "^2.0.0",
-    "lodash.flatten": "^4.4.0",
     "lodash.intersection": "^4.4.0",
     "lodash.isequal": "^4.5.0",
     "lodash.keyby": "^4.6.0",
@@ -95,7 +95,6 @@
     "@testing-library/react": "^12.1.2",
     "@testing-library/react-hooks": "^8.0.1",
     "@types/jest": "^29.5.1",
-    "@types/lodash.flatten": "^4.4.9",
     "@types/lodash.intersection": "^4.4.9",
     "@types/lodash.isequal": "^4.5.6",
     "@types/lodash.keyby": "^4.6.9",
@@ -114,12 +113,13 @@
     "eslint-plugin-testing-library": "^6.2.0",
     "eslint-plugin-unicorn": "^50.0.1",
     "husky": "^8.0.3",
+    "jest-coverage-badges": "^1.1.2",
     "jest-styled-components": "^7.1.1",
     "lint-staged": "^14.0.1",
     "prettier": "^3.0.3",
     "react-app-rewired": "^2.2.1",
     "redux-mock-store": "^1.5.4",
-    "start-server-and-test": "2.0.3",
+    "ts-prune": "^0.10.3",
     "typescript": "^5.1.6"
   },
   "jest": {
@@ -132,14 +132,19 @@
       "src/layout/**/*.tsx",
       "src/util/**/*.ts",
       "src/services/**/*.ts",
+      "src/containers/Home/index.tsx",
       "!src/actions/**/*.ts",
       "!src/api/**/*.ts",
       "!src/selectors/**/*.ts",
       "!src/reducers/**/*.ts",
       "!src/store/**/*.tsx",
-      "!src/containers/Home/index.tsx",
       "!src/**/types.{ts,tsx}",
       "!src/**/style.{ts,tsx}"
+    ],
+    "coverageReporters": [
+      "json-summary",
+      "text",
+      "lcov"
     ]
   },
   "resolutions": {

readme.md

@@ -14,6 +14,13 @@
 
 <br />
 
+# Coverage report
+
+<img src="coverage/badge-lines.svg" alt="Line Coverage"> 
+<img src="coverage/badge-branches.svg" alt="Branch Coverage"> 
+<img src="coverage/badge-functions.svg" alt="Function Coverage"> 
+<img src="coverage/badge-statements.svg" alt="Function Coverage"> 
+
 # Contributing
 
 Follow these instructions to set up your local development environment.

src/actions/daoAction.ts

@@ -17,51 +17,48 @@
   along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
-import networkService from 'services/networkService'
 import { createAction } from './createAction'
 
+import daoService from 'services/dao/dao.service'
+
 export const fetchDaoBalance = () =>
-  createAction('BALANCE/DAO/GET', () => networkService.getDaoBalance())
+  createAction('BALANCE/DAO/GET', () => daoService.loadBobaBalance())
 
 export const fetchDaoVotes = () =>
-  createAction('VOTES/DAO/GET', () => networkService.getDaoVotes())
+  createAction('VOTES/DAO/GET', () => daoService.loadBobaVotes())
 
 export const fetchDaoBalanceX = () =>
-  createAction('BALANCEX/DAO/GET', () => networkService.getDaoBalanceX())
+  createAction('BALANCEX/DAO/GET', () => daoService.loadXBobaBalance())
 
 export const fetchDaoVotesX = () =>
-  createAction('VOTESX/DAO/GET', () => networkService.getDaoVotesX())
+  createAction('VOTESX/DAO/GET', () => daoService.loadXBobaVotes())
 
 export const delegateVotes = ({ recipient }) =>
   createAction('DELEGATE/VOTES/CREATE', () =>
-    networkService.delegateVotes({ recipient })
+    daoService.delegateBobaVotes({ recipient })
   )
 
 export const delegateVotesX = ({ recipient }) =>
   createAction('DELEGATEX/VOTES/CREATE', () =>
-    networkService.delegateVotesX({ recipient })
+    daoService.delegateXBobaVotes({ recipient })
   )
 
 export const getProposalThreshold = () =>
   createAction('PROPOSALTHRESHOLD/GET', () =>
-    networkService.getProposalThreshold()
+    daoService.loadProposalThreshold()
   )
 
 export const fetchDaoProposals = () =>
-  createAction('PROPOSALS/GET', () => networkService.fetchProposals())
+  createAction('PROPOSALS/GET', () => daoService.loadProposals())
 
 export const createDaoProposal = (payload) =>
-  createAction('PROPOSAL/CREATE', () => networkService.createProposal(payload))
+  createAction('PROPOSAL/CREATE', () => daoService.createProposal(payload))
 
 export const queueProposal = (proposalID) =>
-  createAction('PROPOSAL/QUEUE', () => networkService.queueProposal(proposalID))
+  createAction('PROPOSAL/QUEUE', () => daoService.queueProposal(proposalID))
 
 export const executeProposal = (proposalID) =>
-  createAction('PROPOSAL/EXECUTE', () =>
-    networkService.executeProposal(proposalID)
-  )
+  createAction('PROPOSAL/EXECUTE', () => daoService.executeProposal(proposalID))
 
 export const castProposalVote = (payload) =>
-  createAction('PROPOSAL/CAST/VOTE', () =>
-    networkService.castProposalVote(payload)
-  )
+  createAction('PROPOSAL/CAST/VOTE', () => daoService.castVote(payload))

src/actions/earnAction.ts

@@ -17,15 +17,25 @@
   along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
-import networkService from 'services/networkService'
-import { createAction } from './createAction'
 import { BigNumberish } from 'ethers'
+import earnService from 'services/earn/earn.service'
 import { LiquidityPoolLayer } from 'types/earn.types'
+import { createAction } from './createAction'
 
 const getEarnInfoBegin = () => ({
   type: 'GET_EARNINFO',
 })
 
+export const updateWithdrawToken = (withdrawToken: any) => ({
+  type: 'UPDATE_WITHDRAW_TOKEN',
+  payload: withdrawToken,
+})
+
+export const updateWithdrawPayload = (withdrawToken: any) => ({
+  type: 'UPDATE_WITHDRAW_PAYLOAD',
+  payload: withdrawToken,
+})
+
 const getEarnInfoSuccess = (
   L1PoolInfo,
   L1UserInfo,
@@ -39,53 +49,47 @@ const getEarnInfoSuccess = (
 export const getEarnInfo = () => async (dispatch) => {
   dispatch(getEarnInfoBegin())
   const [L1LPInfo, L2LPInfo] = await Promise.all([
-    networkService.getL1LPInfo(),
-    networkService.getL2LPInfo(),
+    earnService.loadL1LpInfo(),
+    earnService.loadL2LpInfo(),
   ])
   dispatch(
     getEarnInfoSuccess(
-      L1LPInfo.poolInfo,
-      L1LPInfo.userInfo,
-      L2LPInfo.poolInfo,
-      L2LPInfo.userInfo
+      (L1LPInfo as any).poolInfo,
+      (L1LPInfo as any).userInfo,
+      (L2LPInfo as any).poolInfo,
+      (L2LPInfo as any).userInfo
     )
   )
 }
 
-export const updateWithdrawToken = (withdrawToken: any) => ({
-  type: 'UPDATE_WITHDRAW_TOKEN',
-  payload: withdrawToken,
-})
-
-export const updateWithdrawPayload = (withdrawToken: any) => ({
-  type: 'UPDATE_WITHDRAW_PAYLOAD',
-  payload: withdrawToken,
-})
-
 export const fetchL1LPBalance = (currency: string) =>
-  createAction('FETCH/L1LPBALANCE', () => networkService.L1LPBalance(currency))
+  createAction('FETCH/L1LPBALANCE', () => earnService.loadL1LpBalance(currency))
 
 export const fetchL2LPBalance = (currency: string) =>
-  createAction('FETCH/L2LPBALANCE', () => networkService.L2LPBalance(currency))
+  createAction('FETCH/L2LPBALANCE', () => earnService.loadL2LpBalance(currency))
 
 export const getReward = (
   currencyAddress: string,
   value_Wei_String: BigNumberish,
   L1orL2Pool: LiquidityPoolLayer
 ) =>
   createAction('EARN/HARVEST', () =>
-    networkService.getReward(currencyAddress, value_Wei_String, L1orL2Pool)
+    earnService.loadReward({
+      currencyAddress,
+      value_Wei_String,
+      L1orL2Pool,
+    })
   )
 
 export const withdrawLiquidity = (
-  currencyAddress: string,
+  currency: string,
   value_Wei_String: string,
   L1orL2Pool: LiquidityPoolLayer
 ) =>
   createAction('EARN/WITHDRAW', () =>
-    networkService.withdrawLiquidity(
-      currencyAddress,
+    earnService.withdrawLiquidity({
+      currency,
+      L1orL2Pool,
       value_Wei_String,
-      L1orL2Pool
-    )
+    })
   )

src/actions/fixedAction.ts

@@ -17,19 +17,19 @@
   along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
-import networkService from 'services/networkService'
+import fixedSavingService from 'services/fixedsaving/fixedSaving.service'
 import { createAction } from './createAction'
 
 export const addFS_Savings = (weiString: string) =>
-  createAction('ADD/FS_SAVINGS', () => networkService.addFS_Savings(weiString))
+  createAction('ADD/FS_SAVINGS', () => fixedSavingService.addSavings(weiString))
 
 export const withdrawFS_Savings = (stakeID: number) =>
   createAction('WITHDRAW/FS_SAVINGS', () =>
-    networkService.withdrawFS_Savings(stakeID)
+    fixedSavingService.withdrawSavings(stakeID)
   )
 
 export const getFS_Saves = () =>
-  createAction('GET/FS_SAVES', () => networkService.getFS_Saves())
+  createAction('GET/FS_SAVES', () => fixedSavingService.loadSavings())
 
 export const getFS_Info = () =>
-  createAction('GET/FS_INFO', () => networkService.getFS_Info())
+  createAction('GET/FS_INFO', () => fixedSavingService.loadAccountSaveInfo())