Merge pull request #73 from eonian-core/feature/add-contract-graph-api-mock

Add contract Graph API mock

Author: LeoVS09

.github/workflows/check-api-compatibility.yaml

@@ -0,0 +1,47 @@
+name: Check dApp API compatibility
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "packages/web/schema.graphql"
+  
+  pull_request:
+    branches:
+      - main
+    types:
+      - opened
+      - synchronize
+    paths:
+      - "packages/web/schema.graphql"
+
+jobs:
+  check:
+    name: Check GraphQL schema compatibility
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Setup NodeJS
+        uses: actions/setup-node@v2
+        with:
+          node-version: "16"
+          cache: "yarn"
+
+      - name: Install dependencies
+        run: yarn --ignore-scripts
+
+      - name: Generate types
+        run: |-
+          cd packages/web
+          yarn gen:gql-types
+
+      - name: Build dApp
+        run: |-
+          cd packages/web
+          yarn build
+

.github/workflows/verify-dapp.yaml

@@ -0,0 +1,45 @@
+name: Verify dApp
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "packages/web/**"
+  
+  pull_request:
+    branches:
+      - main
+    types:
+      - opened
+      - synchronize
+    paths:
+      - "packages/web/**"
+
+jobs:
+  # Add linting job after migration to nextjs version with given fix https://github.com/vercel/next.js/issues/44424
+  
+  test:
+    name: Test dApp
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Setup NodeJS
+        uses: actions/setup-node@v2
+        with:
+          node-version: "16"
+          cache: "yarn"
+
+      - name: Install dependencies
+        run: yarn --ignore-scripts
+
+      - name: Run tests
+        run: |-
+          cd packages/web
+          yarn test:ci
+
+

.github/workflows/on-pr-for-contracts.yaml renamed to .github/workflows/verify-smart-contracts.yaml

@@ -1,6 +1,12 @@
-name: Verify Contracts PR
+name: Verify Smart Contracts
 
 on:
+  push:
+    branches:
+      - main
+    paths:
+      - "packages/contracts/**"
+  
   pull_request:
     branches:
       - main

README.md

@@ -6,6 +6,8 @@ Yield Aggregator dApp and protocol for safe and high reward liquidity mining
 
 This mono-repository contains protocol contracts and dApp code, as well as all related packages.
 
+For a list of known development issues related to Lerna monorepo, see [development.md](https://github.com/eonian-core/farm/tree/main/development.md).
+
 ### Structure
 
 * `packages/contracts` - Protocol contracts.
@@ -43,6 +45,9 @@ yarn
 * `yarn test:contracts` - Test only contracts
 * `dev:contracts` - Set up a development environment for contracts. Watch file changes and rerun tests.
 
+
+
+
 ## Deployment
 
 The deployment process focused on implementing GitOps practices. Basically, it means all master (main) builds go to production directly. For a web application, PRs also deploy to a preview environment.

development.md

@@ -0,0 +1,32 @@
+# Known Development Issues
+
+## Installation of dependencies
+
+Fail during installation of dependency in one of the packages.
+Example `error An unexpected error occurred: "expected workspace package to exist for \"yargs\"".`
+
+Issue still not fixed by yarn: https://github.com/yarnpkg/yarn/issues/7734.
+
+### Solution
+
+Go to the root directory and run `yarn workspace [package-name] add ...` to add the package. Use `@eonian/web` as the package name for the web package and `@eonian/contracts` for the contracts package.
+
+## Graphql types code generation
+
+Fail during code generation of graphql types.
+Example:
+
+```bash
+Cannot use GraphQLScalarType "BigDecimal" from another module or realm.
+Ensure that there is only one instance of "graphql" in the node_modules
+```
+
+Remove `nohoist` from the root `package.json`, delete node_modules in root and all packages, and run `yarn` again. Be aware, removing `nohoist` can cause failures in contracts package.
+
+## Jest is not working properly with ESM modules
+
+Jest is not working properly with ESM modules. It fails to run tests by using the normal `jest` command in the web package.
+
+### Solution
+
+Add a command which enables ESM modules for node and then run jest. For web package it is `yarn jest`

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "root",
+  "name": "eonian",
   "private": true,
   "scripts": {
     "bootstrap": "lerna bootstrap --use-workspaces",
@@ -20,10 +20,6 @@
       "packages/*"
     ],
     "nohoist": [
-      "**/ts-node",
-      "**/ts-node/**",
-      "**/typescript",
-      "**/typescript/**",
       "**/typechain",
       "**/typechain/**",
       "**/@typechain",
@@ -44,5 +40,9 @@
     "generate-lockfile": "^0.0.12",
     "lerna": "^5.1.6",
     "nx": "^14.3.6"
+  },
+  "dependencies": {
+    "glob": "^8.0.1",
+    "yargs": "^17.6.2"
   }
 }

packages/web/.env

@@ -1,4 +1,9 @@
+# Feature Flags
+
 NEXT_PUBLIC_FEATURE_FAQ_PAGE=true
 NEXT_PUBLIC_FEATURE_COMMUNITY_PAGE=true
 NEXT_PUBLIC_FEATURE_MISSION_PAGE=true
 NEXT_PUBLIC_FEATURE_SECURITY_PAGE=true
+
+# API
+NEXT_PUBLIC_GRAPH_URL=http://localhost:4000

packages/web/README.md

@@ -18,18 +18,38 @@ yarn dev
 
 It will start
 
-* NextJS application at [http://localhost:3000](http://localhost:3000) and open page automatically
+* NextJS application at [http://localhost:3000](http://localhost:3000) and the open page automatically
 * Storybook at [http://localhost:6006](http://localhost:6006) or another port of it is busy
 
 ### Storybook
 
-For development of components and independent screens there used Stroybook.
-To start it locally use the following command:
+For the development of components and independent screens, there used Storybook.
+To start it locally, use the following command:
 
 ```bash
 yarn storybook
 ```
 
+### GraphQl API
+
+For querying data from the blockchain and other services, there used GraphQL API.
+
+#### Mocking Server
+
+The mocking server allows mocking this API for development purposes. To start it locally, use the following command:
+
+```bash
+yarn mock
+```
+
+#### Generate Introspection Types
+
+To generate types for the GraphQL API, use the following command:
+
+```bash
+yarn gen:gql-types
+```
+
 ### CDN
 
 * <https://vercel.com/eonian/farm-app> - Web app project in Vercel

packages/web/app/api/apollo.client.ts

@@ -0,0 +1,12 @@
+import { ApolloClient, InMemoryCache, MutationOptions, OperationVariables, QueryOptions } from '@apollo/client';
+
+export const client = new ApolloClient({
+    uri: process.env.GRAPH_URL || 'http://localhost:4000/',
+    cache: new InMemoryCache(),
+});
+
+export const query = async <T = any, TVariables extends OperationVariables = OperationVariables>(options: QueryOptions<TVariables, T>) => 
+    client.query<T, TVariables>(options);
+
+export const mutate = async <TData = any, TVariables extends OperationVariables = OperationVariables, TContext extends Record<string, any> = Record<string, any>, TCache extends InMemoryCache = InMemoryCache>(options: MutationOptions<TData, TVariables, TContext>) =>
+    client.mutate<TData, TVariables, TContext, TCache>(options);

packages/web/app/api/get-vaults.query.ts

@@ -0,0 +1,31 @@
+import { gql } from '@apollo/client';
+import { query } from './apollo.client';
+import {GetVaultsQuery} from './gql/graphql';
+
+export const GetVaults = gql`
+  query GetVaults {
+    vaults {
+      underlyingAsset {
+        address
+        name
+        symbol
+        decimals
+      }
+      totalBalance
+      interestRate
+      lastHarvestTime
+      address
+      name
+      symbol
+      decimals
+    }
+  }
+`;
+
+export type {GetVaultsQuery}
+
+/** 
+ * Get list of Vaults 
+ * @example getVaults().then(console.log)
+ * */
+export const getVaults = () => query<GetVaultsQuery>({ query: GetVaults })