humanprotocol · portuu3 · Jul 15, 2024 · May 16, 2024 · May 16, 2024 · May 16, 2024
diff --git a/packages/apps/human-app/frontend/.env.example b/packages/apps/human-app/frontend/.env.example
@@ -0,0 +1,64 @@
+# api url
+VITE_API_URL= #string
+# link to privacy policy page 
+VITE_PRIVACY_POLICY_URL= #string
+# link to terms of service
+VITE_TERMS_OF_SERVICE_URL= #string
+# link to help page
+VITE_HUMAN_PROTOCOL_HELP_URL= #string
+# link to human web page
+VITE_HUMAN_PROTOCOL_URL= #string
+# link to human web page in main page navbar
+VITE_NAVBAR__LINK__PROTOCOL_URL= #string
+# link to human web page section in main page navbar
+VITE_NAVBAR__LINK__HOW_IT_WORK_URL= #string
+# capthca site key for captcha other than labeling 
+VITE_H_CAPTCHA_SITE_KEY= #string
+# HMT daily spent limit
+VITE_HMT_DAILY_SPENT_LIMIT= #number
+# daily solved captcha limit
+VITE_DAILY_SOLVED_CAPTCHA_LIMIT= #number
+# capthca url for captcha other than labeling 
+VITE_H_CAPTCHA_EXCHANGE_URL= #string
+# capthca url for labeling 
+VITE_H_CAPTCHA_LABELING_BASE_URL= #string
+# ID of project created with https://cloud.walletconnect.com/sign-in
+VITE_WALLET_CONNECT_PROJECT_ID= #string
+# Dapp name for wallet connect 
+VITE_DAPP_META_NAME= #string
+# Dapp description for wallet connect 
+VITE_DAPP_META_DESCRIPTION= #string
+# Dapp url for wallet connect 
+VITE_DAPP_META_URL= #string 
+# Dapp icons for wallet connect 
+VITE_DAPP_ICONS= #string => lists of icons eg.: icon1,icon2...
+
+# network if network is equl to 'testnet' app will use first tesntet chain from .src/smart-contracts/chains.ts
+# and first mainnet chain for 'mainnet'
+VITE_NETWORK= # mainnet|testnet
+
+## Web3 setup
+# set SC addresses according to https://human-protocol.gitbook.io/hub/human-tech-docs/architecture/components/smart-contracts/contract-addresses
+
+## testnet
+
+# Amoy
+VITE_TESTNET_AMOY_STAKING_CONTRACT=
+VITE_TESTNET_AMOY_HMTOKEN_CONTRACT=
+VITE_TESTNET_AMOY_ETH_KV_STORE_CONTRACT=
+
+## mainnet
+
+# Polygon
+VITE_MAINNET_POLYGON_STAKING_CONTRACT=
+VITE_MAINNET_POLYGON_HMTOKEN_CONTRACT=
+VITE_MAINNET_POLYGON_ETH_KV_STORE_CONTRACT=
+
+## other networks
+# if you wish to add new network follow this instruction:
+# - add your env-s set to .env file
+# - add new env-s to validation schema in: ./src/shared/env.ts
+# - include new valid env-s in: ./src/smart-contracts/contracts.ts
+# - add chain data in: .src/smart-contracts/chains.ts
+
+# all new chains will be available in wallet-connect modal
diff --git a/packages/apps/human-app/frontend/.eslintrc.cjs b/packages/apps/human-app/frontend/.eslintrc.cjs
@@ -0,0 +1,47 @@
+const { resolve } = require('node:path');
+
+const project = resolve(__dirname, 'tsconfig.json');
+
+module.exports = {
+  root: true,
+  extends: [
+    require.resolve('@vercel/style-guide/eslint/browser'),
+    require.resolve('@vercel/style-guide/eslint/typescript'),
+    require.resolve('@vercel/style-guide/eslint/react'),
+    'plugin:prettier/recommended',
+    'plugin:@tanstack/eslint-plugin-query/recommended',
+  ],
+  ignorePatterns: ['dist', '.eslintrc.cjs'],
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    project: ['./tsconfig.json', './tsconfig.node.json'],
+    tsconfigRootDir: __dirname,
+  },
+  plugins: ['react-refresh'],
+  rules: {
+    'react-refresh/only-export-components': [
+      'warn',
+      { allowConstantExport: true },
+    ],
+    'import/extensions': [
+      'error',
+      'ignorePackages',
+      {
+        ts: 'never',
+        tsx: 'never',
+      },
+    ],
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    // allow imports from material react table library
+    camelcase: ['error', { allow: ['MRT_'] }],
+    'react/jsx-pascal-case': ['error', { ignore: ['MRT_'] }],
+  },
+  settings: {
+    'import/resolver': {
+      typescript: {
+        project,
+      },
+    },
+  },
+};
diff --git a/packages/apps/human-app/frontend/.gitignore b/packages/apps/human-app/frontend/.gitignore
@@ -0,0 +1,28 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+!.vscode/settings.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+.env
+.env.local
diff --git a/packages/apps/human-app/frontend/.husky/pre-commit b/packages/apps/human-app/frontend/.husky/pre-commit
@@ -0,0 +1 @@
+npx lint-staged
diff --git a/packages/apps/human-app/frontend/.prettierrc b/packages/apps/human-app/frontend/.prettierrc
@@ -0,0 +1,7 @@
+{
+	"trailingComma": "es5",
+	"semi": true,
+	"singleQuote": true,
+	"tabWidth": 2,
+	"endOfLine": "lf"
+}
diff --git a/packages/apps/human-app/frontend/README.md b/packages/apps/human-app/frontend/README.md
@@ -0,0 +1,90 @@
+# Human app - Frontend
+
+## Build With
+
+| Tool-Name                                                                                                                                                     | Description                     |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
+| [ESlint](https://github.com/vercel/style-guide) with [Prettier plugin](https://github.com/prettier/eslint-plugin-prettier)                                    | Linting and Formatting          |
+| [ESlint Vercel style guide](https://github.com/vercel/style-guide)                                                                                            | eslint config preset            |
+| [Husky](https://typicode.github.io/husky/get-started.html) with [lint-staged](https://github.com/lint-staged/lint-staged?tab=readme-ov-file#-lint-staged----) | pre-commit                      |
+| [TypeScript](https://www.typescriptlang.org/docs/handbook/typescript-in-5-minutes.html)                                                                       | Static typing                   |
+| [Vite](https://vitejs.dev/guide/why.html)                                                                                                                     | Bundler                         |
+| [React](https://react.dev/learn/describing-the-ui)                                                                                                            | Frontend Framework              |
+| [React Router](https://reactrouter.com/en/main/start/tutorial)                                                                                                | Client Side Routing             |
+| [TanStack Query](https://tanstack.com/query/latest/docs/framework/react/overview)                                                                             | Async state management          |
+| [Material UI](https://mui.com/material-ui/getting-started/)                                                                                                   | UI Components                   |
+| [Material Icons](https://mui.com/material-ui/material-icons/)                                                                                                 | Icons                           |
+| [Material React Table](https://www.material-react-table.com/about)                                                                                            | Table component for material ui |
+| [Zod](https://github.com/colinhacks/zod?tab=readme-ov-file#table-of-contents)                                                                                 | Runtime Validations             |
+| [i18next](https://react.i18next.com/getting-started)                                                                                                          | Internationalization Framework  |
+
+## Getting Started
+
+### Prerequisites
+
+- [Node.js minimal v18](https://nodejs.org/en)
+- [pnpm](https://pnpm.io/installation)
+
+### Install Packages
+
+```sh
+yarn install
+```
+
+### Compile and Hot-Reload for Development
+
+```sh
+yarn dev
+```
+
+### Type-Check, Compile and Minify for Production
+
+```sh
+yarn build
+```
+
+### Linting and Formatting
+
+```sh
+yarn lint
+```
+
+### Tests
+
+```sh
+yarn test
+```
+
+## Web3 setup
+
+The Web3 setup is closely tied to contract addresses. The best explanation for this can be found in the `.env.example` file, which shows where to set your smart contract addresses.
+
+`.env.example`
+```
+...
+## Web3 setup
+# set SC addresses according to https://human-protocol.gitbook.io/hub/human-tech-docs/architecture/components/smart-contracts/contract-addresses
+
+## testnet
+
+# Amoy
+VITE_TESTNET_AMOY_STAKING_CONTRACT=
+VITE_TESTNET_AMOY_HMTOKEN_CONTRACT=
+VITE_TESTNET_AMOY_ETH_KV_STORE_CONTRACT=
+
+## mainnet
+
+# Polygon
+VITE_MAINNET_POLYGON_STAKING_CONTRACT=
+VITE_MAINNET_POLYGON_HMTOKEN_CONTRACT=
+VITE_MAINNET_POLYGON_ETH_KV_STORE_CONTRACT=
+
+## other networks
+# if you wish to add new network follow this instruction:
+# - add your env-s set to .env file
+# - add new env-s to validation schema in: ./src/shared/env.ts
+# - include new valid env-s in: ./src/smart-contracts/contracts.ts
+# - add chain data in: .src/smart-contracts/chains.ts
+
+# all new chains will be available in wallet-connect modal
+```
diff --git a/packages/apps/human-app/frontend/index.html b/packages/apps/human-app/frontend/index.html
@@ -0,0 +1,32 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <meta name="description" content="Complete jobs, earn HMT" />
+    <link rel="manifest" href="/manifest.json" />
+    <link rel="icon" href="/favicon.ico" />
+    <title>Human App</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+    <script type="text/javascript" id="zsiqchat">
+      var $zoho = $zoho || {};
+      $zoho.salesiq = $zoho.salesiq || {
+        widgetcode:
+          'siqa18acfe081f579aac3e319f82ebb5e4009c0d32440c1be563e9aadb57830fa90',
+        values: {},
+        ready: function () {},
+      };
+      var d = document;
+      s = d.createElement('script');
+      s.type = 'text/javascript';
+      s.id = 'zsiqscript';
+      s.defer = true;
+      s.src = 'https://salesiq.zohopublic.com/widget';
+      t = d.getElementsByTagName('script')[0];
+      t.parentNode.insertBefore(s, t);
+    </script>
+  </body>
+</html>
diff --git a/packages/apps/human-app/frontend/package.json b/packages/apps/human-app/frontend/package.json
@@ -0,0 +1,75 @@
+{
+  "name": "@human-protocol/human-app-frontend",
+  "private": true,
+  "version": "1.0.0",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "preview": "vite preview",
+    "test": "vitest",
+    "prepare": "husky"
+  },
+  "lint-staged": {
+    "*.{ts,tsx}": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0"
+  },
+  "dependencies": {
+    "@emotion/react": "^11.11.3",
+    "@emotion/styled": "^11.11.0",
+    "@fontsource/inter": "^5.0.17",
+    "@hcaptcha/react-hcaptcha": "^0.3.6",
+    "@hookform/resolvers": "^3.3.4",
+    "@mui/icons-material": "^5.15.7",
+    "@mui/material": "^5.15.7",
+    "@synaps-io/verify-sdk": "^4.0.45",
+    "@tanstack/react-query": "^5.18.1",
+    "@walletconnect/ethereum-provider": "^2.12.2",
+    "@walletconnect/modal": "^2.6.2",
+    "@web3modal/ethers": "^4.1.9",
+    "@web3modal/scaffold-utils": "^4.1.11",
+    "date-fns": "^3.6.0",
+    "ethers": "^6.12.0",
+    "i18next": "^23.8.2",
+    "jwt-decode": "^4.0.0",
+    "lodash": "^4.17.21",
+    "material-react-table": "^2.12.1",
+    "mui-image": "^1.0.7",
+    "query-string": "^9.0.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-hook-form": "^7.50.0",
+    "react-i18next": "^14.0.2",
+    "react-imask": "^7.4.0",
+    "react-number-format": "^5.3.4",
+    "react-router-dom": "^6.22.0",
+    "vite-plugin-svgr": "^4.2.0",
+    "zod": "^3.22.4",
+    "zustand": "^4.5.0"
+  },
+  "devDependencies": {
+    "@tanstack/eslint-plugin-query": "^5.18.1",
+    "@tanstack/react-query-devtools": "^5.18.1",
+    "@testing-library/jest-dom": "^6.4.2",
+    "@testing-library/react": "^14.2.1",
+    "@types/lodash": "^4.14.202",
+    "@types/mui-image": "^1.0.5",
+    "@types/node": "^20.11.16",
+    "@types/react": "^18.2.43",
+    "@types/react-dom": "^18.2.17",
+    "@typescript-eslint/eslint-plugin": "^6.20.0",
+    "@vercel/style-guide": "^5.2.0",
+    "@vitejs/plugin-react": "^4.2.1",
+    "@vitest/ui": "^1.4.0",
+    "eslint": "^8.55.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-react-refresh": "^0.4.5",
+    "husky": "^9.0.10",
+    "jsdom": "^24.0.0",
+    "lint-staged": "^15.2.1",
+    "prettier": "^3.2.5",
+    "typescript": "^5.2.2",
+    "vite": "^5.0.8",
+    "vitest": "^1.2.2"
+  }
+}
diff --git a/packages/apps/human-app/frontend/public/favicon.ico b/packages/apps/human-app/frontend/public/favicon.ico
diff --git a/packages/apps/human-app/frontend/public/manifest.json b/packages/apps/human-app/frontend/public/manifest.json
@@ -0,0 +1,15 @@
+{
+  "short_name": "Human App",
+  "name": "Human App",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}
diff --git a/packages/apps/human-app/frontend/src/api/api-client.ts b/packages/apps/human-app/frontend/src/api/api-client.ts
@@ -0,0 +1,14 @@
+// eslint-disable-next-line import/no-cycle -- cause by refresh token retry
+import { createFetcher } from '@/api/fetcher';
+import { env } from '@/shared/env';
+
+export const apiClient = createFetcher({
+  baseUrl: env.VITE_API_URL,
+  options: () => {
+    const headers = new Headers({ 'Content-Type': 'application/json' });
+
+    return {
+      headers,
+    };
+  },
+});