feat: create reusable chains package (#3562)

* feat: create reusable chains package

* feat: remove RPC and subgraph URLs from chains package

.changeset/thirty-spies-wink.md

@@ -0,0 +1,5 @@
+---
+"@venusprotocol/evm": minor
+---
+
+create reusable chains package

.github/workflows/cd.yaml

@@ -9,6 +9,11 @@ concurrency:
   group: ${{ github.ref }}
   cancel-in-progress: true
 
+env:
+  VITE_ENV: "ci"
+  VITE_CODEGEN_UNRESTRICTED_NODE_REAL_API_KEY: ${{ secrets.VITE_CODEGEN_UNRESTRICTED_NODE_REAL_API_KEY }}
+  VITE_CODEGEN_UNRESTRICTED_THE_GRAPH_API_KEY: ${{ secrets.VITE_CODEGEN_UNRESTRICTED_THE_GRAPH_API_KEY }}
+
 jobs:
   release:
     runs-on: ubuntu-latest

.github/workflows/ci.yaml

@@ -2,14 +2,16 @@ name: Tests and Checks
 
 on: [pull_request]
 
-env:
-  VITE_ENV: "ci"
-  NODE_OPTIONS: "--max_old_space_size=4096"
-
 concurrency:
   group: ${{ github.ref }}
   cancel-in-progress: true
 
+env:
+  NODE_OPTIONS: "--max_old_space_size=4096"
+  VITE_ENV: "ci"
+  VITE_CODEGEN_UNRESTRICTED_NODE_REAL_API_KEY: ${{ secrets.VITE_CODEGEN_UNRESTRICTED_NODE_REAL_API_KEY }}
+  VITE_CODEGEN_UNRESTRICTED_THE_GRAPH_API_KEY: ${{ secrets.VITE_CODEGEN_UNRESTRICTED_THE_GRAPH_API_KEY }}
+
 jobs:
   checks:
     runs-on: ubuntu-22.04

apps/evm/.env.template

@@ -1,81 +1,23 @@
 # Environment
-
 VITE_NETWORK=testnet
 VITE_ENV=local
 
-# Network-specific
-
-## BSC mainnet
-
-# BSC mainnet
-VITE_RPC_HTTP_URL_BSC_MAINNET=
-VITE_SUBGRAPH_MARKETS_URL_BSC_MAINNET=
-VITE_SUBGRAPH_GOVERNANCE_URL_BSC_MAINNET=
-
-## BSC testnet
-VITE_RPC_HTTP_URL_BSC_TESTNET=
-VITE_SUBGRAPH_MARKETS_URL_BSC_TESTNET=
-VITE_SUBGRAPH_GOVERNANCE_URL_BSC_TESTNET=
-
-## Ethereum
-VITE_RPC_HTTP_URL_ETHEREUM=
-VITE_SUBGRAPH_MARKETS_URL_ETHEREUM=
-VITE_SUBGRAPH_GOVERNANCE_URL_ETHEREUM=
-
-## Sepolia
-VITE_RPC_HTTP_URL_SEPOLIA=
-VITE_SUBGRAPH_MARKETS_URL_SEPOLIA=
-VITE_SUBGRAPH_GOVERNANCE_URL_SEPOLIA=
-
-## opBNB mainnet
-VITE_RPC_HTTP_URL_OPBNB_MAINNET=
-VITE_SUBGRAPH_MARKETS_URL_OPBNB_MAINNET=
-VITE_SUBGRAPH_GOVERNANCE_URL_OPBNB_MAINNET=
-
-## opBNB testnet
-VITE_RPC_HTTP_URL_OPBNB_TESTNET=
-VITE_SUBGRAPH_MARKETS_URL_OPBNB_TESTNET=
-VITE_SUBGRAPH_GOVERNANCE_URL_OPBNB_TESTNET=
-
-# Arbitrum One
-VITE_RPC_HTTP_URL_ARBITRUM_ONE=
-VITE_SUBGRAPH_MARKETS_URL_ARBITRUM_ONE=
-VITE_SUBGRAPH_GOVERNANCE_URL_ARBITRUM_ONE=
-
-## Arbitrum Sepolia
-VITE_RPC_HTTP_URL_ARBITRUM_SEPOLIA=
-VITE_SUBGRAPH_MARKETS_URL_ARBITRUM_SEPOLIA=
-VITE_SUBGRAPH_GOVERNANCE_URL_ARBITRUM_SEPOLIA=
-
-## zkSync
-VITE_RPC_HTTP_URL_ZKSYNC_MAINNET=
-VITE_SUBGRAPH_MARKETS_URL_ZKSYNC_MAINNET=
-VITE_SUBGRAPH_GOVERNANCE_URL_ZKSYNC_MAINNET=
-
-## zkSync Sepolia
-VITE_RPC_HTTP_URL_ZKSYNC_SEPOLIA=
-VITE_SUBGRAPH_MARKETS_URL_ZKSYNC_SEPOLIA=
-VITE_SUBGRAPH_GOVERNANCE_URL_ZKSYNC_SEPOLIA=
-
-# Optimism mainnet
-VITE_RPC_HTTP_URL_OPTIMISM_MAINNET=
-VITE_SUBGRAPH_MARKETS_URL_OPTIMISM_MAINNET=
-VITE_SUBGRAPH_GOVERNANCE_URL_OPTIMISM_MAINNET=
-
-# Optimism Sepolia
-VITE_RPC_HTTP_URL_OPTIMISM_SEPOLIA=
-VITE_SUBGRAPH_MARKETS_URL_OPTIMISM_SEPOLIA=
-VITE_SUBGRAPH_GOVERNANCE_URL_OPTIMISM_SEPOLIA=
-
 # Error reporting
-
 VITE_SENTRY_DSN=
 
 # Analytics
-
 VITE_POSTHOG_API_KEY=
 VITE_POSTHOG_HOST_URL=
 
-# ZyFi
-
+# Zyfi
 VITE_ZYFI_API_KEY=
+
+# NodeReal
+VITE_NODE_REAL_API_KEY=
+## Used at build-time only to generate subgraph types
+VITE_CODEGEN_UNRESTRICTED_NODE_REAL_API_KEY=
+
+# The Graph
+VITE_THE_GRAPH_API_KEY=
+## Used at build-time only to generate subgraph types
+VITE_CODEGEN_UNRESTRICTED_THE_GRAPH_API_KEY=

apps/evm/codegen.config.ts

@@ -0,0 +1,60 @@
+/** @type {import('graphql-config').IGraphQLConfig } */
+
+import { ChainId } from '@venusprotocol/chains/types';
+
+import { getGovernanceSubgraphUrls, getIsolatedPoolsSubgraphUrls } from './src/config/subgraphUrls';
+
+const keys = {
+  nodeRealApiKey: process.env.VITE_CODEGEN_UNRESTRICTED_NODE_REAL_API_KEY!,
+  theGraphApiKey: process.env.VITE_CODEGEN_UNRESTRICTED_THE_GRAPH_API_KEY!,
+};
+
+const isolatedPoolsSubgraphUrls = getIsolatedPoolsSubgraphUrls(keys);
+const governanceSubgraphUrls = getGovernanceSubgraphUrls(keys);
+
+const plugins = ['typescript', 'typed-document-node', 'typescript-operations'];
+
+export const projects = {
+  isolatedPools: {
+    schema: isolatedPoolsSubgraphUrls[ChainId.BSC_MAINNET],
+    documents: ['./src/clients/subgraph/queries/isolatedPools/**/*.graphql'],
+    errorsOnly: true,
+    extensions: {
+      codegen: {
+        generates: {
+          './src/clients/subgraph/gql/generated/isolatedPools.ts': {
+            plugins,
+          },
+        },
+      },
+    },
+  },
+  governanceBsc: {
+    schema: governanceSubgraphUrls[ChainId.BSC_MAINNET],
+    documents: ['./src/clients/subgraph/queries/governanceBsc/**/*.graphql'],
+    errorsOnly: true,
+    extensions: {
+      codegen: {
+        generates: {
+          './src/clients/subgraph/gql/generated/governanceBsc.ts': {
+            plugins,
+          },
+        },
+      },
+    },
+  },
+  governanceNonBsc: {
+    schema: governanceSubgraphUrls[ChainId.ETHEREUM],
+    documents: ['./src/clients/subgraph/queries/governanceNonBsc/**/*.graphql'],
+    errorsOnly: true,
+    extensions: {
+      codegen: {
+        generates: {
+          './src/clients/subgraph/gql/generated/governanceNonBsc.ts': {
+            plugins,
+          },
+        },
+      },
+    },
+  },
+};

apps/evm/package.json

@@ -16,13 +16,13 @@
     "lint:styles": "stylelint 'src/**/*.{css,scss,ts,tsx,js,jsx}'",
     "tsc": "tsc --noEmit",
     "extract-translations": "yarn i18next",
-    "generate-subgraph-types:isolated-pools": "yarn graphql-codegen --config src/config/codegen.ts --project isolatedPools",
-    "generate-subgraph-types:governance-bsc": "yarn graphql-codegen --config src/config/codegen.ts --project governanceBsc",
-    "generate-subgraph-types:governance-non-bsc": "yarn graphql-codegen --config src/config/codegen.ts --project governanceNonBsc",
+    "generate-project-subgraph:project": "dotenvx run -f .env -- yarn graphql-codegen --config codegen.config.ts --project $PROJECT",
+    "generate-subgraph-types:isolated-pools": "PROJECT=isolatedPools yarn generate-project-subgraph:project",
+    "generate-subgraph-types:governance-bsc": "PROJECT=governanceBsc yarn generate-project-subgraph:project",
+    "generate-subgraph-types:governance-non-bsc": "PROJECT=governanceNonBsc yarn generate-project-subgraph:project",
     "generate-subgraph-types": "yarn generate-subgraph-types:isolated-pools && yarn generate-subgraph-types:governance-bsc && yarn generate-subgraph-types:governance-non-bsc",
     "generate-contracts": "rimraf src/libs/contracts/generated/getters && rimraf src/libs/contracts/generated/infos && src/libs/contracts/scripts/generateContractRecords/index.ts && yarn biome format --vcs-use-ignore-file=false --write src/libs/contracts/generated",
     "generate-pancake-swap-tokens": "src/libs/tokens/scripts/generatePancakeSwapTokenRecords/index.ts && yarn biome format --vcs-use-ignore-file=false --write src/libs/tokens/generated/pancakeSwapTokens/bscMainnet.ts",
-    "generate-token-accent-colors": "src/libs/tokens/scripts/generateTokenAccentColors/index.ts && yarn biome format --vcs-use-ignore-file=false --write src/libs/tokens/generated/tokenAccentColors.ts",
     "generate-version-files": "genversion --es6 --semi src/constants/version.ts && src/scripts/generatePublicVersionFile.ts && yarn biome format --vcs-use-ignore-file=false --write public/version.json",
     "generate": "npm-run-all --parallel generate-version-files generate-contracts generate-subgraph-types && yarn generate-pancake-swap-tokens",
     "storybook": "storybook dev -p 6006",
@@ -86,6 +86,7 @@
   "devDependencies": {
     "@biomejs/biome": "1.6.4",
     "@changesets/cli": "^2.27.1",
+    "@dotenvx/dotenvx": "^1.26.2",
     "@ethersproject/abi": "^5.7.0",
     "@ethersproject/abstract-provider": "^5.7.0",
     "@graphprotocol/client-cli": "^3.0.7",
@@ -149,6 +150,7 @@
     "storybook": "^8.4.2",
     "stylelint": "^15.10.3",
     "tailwindcss": "^3.3.3",
+    "tsconfig-paths": "^4.2.0",
     "tsx": "^4.1.2",
     "typechain": "^8.3.1",
     "typescript": "^5.1.6",

apps/evm/src/__mocks__/models/pools.ts

@@ -1,13 +1,13 @@
+import { chainMetadata } from '@venusprotocol/chains';
 import BigNumber from 'bignumber.js';
 
 import apiPoolsResponse from '__mocks__/api/pools.json';
 import { assetData } from '__mocks__/models/asset';
 
 import formatToPool from 'clients/api/queries/getApiPools/formatToPool';
-import { CHAIN_METADATA } from 'constants/chainMetadata';
 import { ChainId, type Pool } from 'types';
 
-const { corePoolComptrollerContractAddress } = CHAIN_METADATA[ChainId.BSC_TESTNET];
+const { corePoolComptrollerContractAddress } = chainMetadata[ChainId.BSC_TESTNET];
 
 export const apiPoolsData = apiPoolsResponse.result.map(apiPoolData =>
   formatToPool({

apps/evm/src/clients/api/queries/getProposal/useGetProposal.ts

@@ -1,11 +1,11 @@
 import { type QueryObserverOptions, useQuery } from '@tanstack/react-query';
+import { chainMetadata } from '@venusprotocol/chains';
 
 import {
   type GetProposalInput,
   type GetProposalOutput,
   getProposal,
 } from 'clients/api/queries/getProposal';
-import { CHAIN_METADATA } from 'constants/chainMetadata';
 import FunctionKey from 'constants/functionKey';
 import { governanceChain } from 'libs/wallet';
 import { callOrThrow } from 'utilities';
@@ -29,7 +29,7 @@ type Options = QueryObserverOptions<
   ]
 >;
 
-const { blockTimeMs: BSC_BLOCK_TIME_MS } = CHAIN_METADATA[governanceChain.id];
+const { blockTimeMs: BSC_BLOCK_TIME_MS } = chainMetadata[governanceChain.id];
 
 export const useGetProposal = (input: TrimmedGetProposalInput, options?: Partial<Options>) => {
   const { data: getProposalMinQuorumVotesData } = useGetProposalMinQuorumVotes();

apps/evm/src/clients/api/queries/getProposalState/useGetProposalState.ts

@@ -1,10 +1,10 @@
 import { type QueryObserverOptions, useQuery } from '@tanstack/react-query';
 
+import { chainMetadata } from '@venusprotocol/chains';
 import getProposalState, {
   type GetProposalStateInput,
   type GetProposalStateOutput,
 } from 'clients/api/queries/getProposalState';
-import { CHAIN_METADATA } from 'constants/chainMetadata';
 import { DEFAULT_REFETCH_INTERVAL_MS } from 'constants/defaultRefetchInterval';
 import FunctionKey from 'constants/functionKey';
 import { useGetGovernorBravoDelegateContract } from 'libs/contracts';
@@ -22,7 +22,7 @@ type Options = QueryObserverOptions<
 >;
 
 const useGetProposalState = (input: TrimmedGetProposalStateInput, options?: Partial<Options>) => {
-  const { blockTimeMs } = CHAIN_METADATA[governanceChain.id];
+  const { blockTimeMs } = chainMetadata[governanceChain.id];
   const governorBravoDelegateContract = useGetGovernorBravoDelegateContract({
     chainId: governanceChain.id,
   });

apps/evm/src/clients/api/queries/getProposals/index.ts

@@ -6,7 +6,7 @@ import {
   getBscProposals,
 } from 'clients/subgraph';
 import type { Proposal_Filter, RemoteProposal } from 'clients/subgraph/gql/generated/governanceBsc';
-import { PROPOSAL_EXECUTION_GRACE_PERIOD_MS } from 'constants/chainMetadata';
+import { PROPOSAL_EXECUTION_GRACE_PERIOD_MS } from 'constants/governance';
 import { type ChainId, type Proposal, ProposalState } from 'types';
 
 export interface GetProposalsInput {

apps/evm/src/clients/api/queries/getProposals/useGetProposals.ts

@@ -1,4 +1,5 @@
 import { type QueryObserverOptions, useQuery } from '@tanstack/react-query';
+import { chainMetadata } from '@venusprotocol/chains';
 
 import useGetBlockNumber from 'clients/api/queries/getBlockNumber/useGetBlockNumber';
 import { useGetProposalMinQuorumVotes } from 'clients/api/queries/getProposalMinQuorumVotes/useGetProposalMinQuorumVotes';
@@ -7,7 +8,6 @@ import {
   type GetProposalsOutput,
   getProposals,
 } from 'clients/api/queries/getProposals';
-import { CHAIN_METADATA } from 'constants/chainMetadata';
 import FunctionKey from 'constants/functionKey';
 import { governanceChain } from 'libs/wallet';
 import { callOrThrow } from 'utilities';
@@ -31,7 +31,7 @@ type Options = QueryObserverOptions<
   ]
 >;
 
-const { blockTimeMs: BSC_BLOCK_TIME_MS } = CHAIN_METADATA[governanceChain.id];
+const { blockTimeMs: BSC_BLOCK_TIME_MS } = chainMetadata[governanceChain.id];
 
 export const useGetProposals = (
   input: TrimmedGetProposalsInput = {},

apps/evm/src/clients/api/queries/getVenusVaiVaultDailyRate/index.spec.ts

@@ -1,7 +1,7 @@
 import BigNumber from 'bignumber.js';
 import { BigNumber as BN } from 'ethers';
 
-import { CHAIN_METADATA } from 'constants/chainMetadata';
+import { chainMetadata } from '@venusprotocol/chains';
 import type { LegacyPoolComptroller } from 'libs/contracts';
 import { ChainId } from 'types';
 
@@ -25,7 +25,7 @@ describe('api/queries/getVenusVaiVaultDailyRate', () => {
     expect(venusVaiVaultRateMock).toHaveBeenCalledTimes(1);
     expect(response).toEqual({
       dailyRateMantissa: new BigNumber(fakeOutput.toString()).times(
-        CHAIN_METADATA[ChainId.BSC_TESTNET].blocksPerDay!,
+        chainMetadata[ChainId.BSC_TESTNET].blocksPerDay!,
       ),
     });
   });

apps/evm/src/clients/subgraph/queries/isolatedPools/getIsolatedPoolParticipantsCount/index.ts

@@ -11,6 +11,6 @@ export interface GetIsolatedPoolParticipantsCountInput {
 export const getIsolatedPoolParticipantsCount = ({
   chainId,
 }: GetIsolatedPoolParticipantsCountInput) =>
-  config.marketsSubgraphUrls[chainId]
-    ? request(config.marketsSubgraphUrls[chainId], IsolatedPoolParticipantsCountDocument)
+  config.isolatedPoolsSubgraphUrls[chainId]
+    ? request(config.isolatedPoolsSubgraphUrls[chainId], IsolatedPoolParticipantsCountDocument)
     : undefined;

apps/evm/src/clients/subgraph/utilities/formatToProposal/formatToRemoteProposal/getRemoteProposalState/__tests__/index.spec.ts

@@ -1,4 +1,4 @@
-import { PROPOSAL_EXECUTION_GRACE_PERIOD_MS } from 'constants/chainMetadata';
+import { PROPOSAL_EXECUTION_GRACE_PERIOD_MS } from 'constants/governance';
 import { ProposalState, RemoteProposalState } from 'types';
 import { getRemoteProposalState } from '..';
 

apps/evm/src/clients/subgraph/utilities/formatToProposal/formatToRemoteProposal/getRemoteProposalState/index.ts

@@ -1,4 +1,4 @@
-import { PROPOSAL_EXECUTION_GRACE_PERIOD_MS } from 'constants/chainMetadata';
+import { PROPOSAL_EXECUTION_GRACE_PERIOD_MS } from 'constants/governance';
 import { ProposalState, RemoteProposalState } from 'types';
 
 export const getRemoteProposalState = ({

apps/evm/src/clients/subgraph/utilities/formatToProposal/formatToRemoteProposal/index.ts

@@ -1,5 +1,5 @@
 import type { NonBscProposalFragment } from 'clients/subgraph/gql/generated/governanceNonBsc';
-import { PROPOSAL_EXECUTION_GRACE_PERIOD_MS } from 'constants/chainMetadata';
+import { PROPOSAL_EXECUTION_GRACE_PERIOD_MS } from 'constants/governance';
 import { CHAIN_IDS_ON_LAYER_ZERO } from 'constants/layerZero';
 import { ProposalState, type RemoteProposal, RemoteProposalState } from 'types';
 import { convertToDate } from 'utilities';

apps/evm/src/clients/subgraph/utilities/formatToProposal/index.ts

@@ -1,7 +1,9 @@
+import { chainMetadata } from '@venusprotocol/chains';
 import BigNumber from 'bignumber.js';
+
 import type { BscProposalFragment } from 'clients/subgraph/gql/generated/governanceBsc';
 import type { NonBscProposalFragment } from 'clients/subgraph/gql/generated/governanceNonBsc';
-import { CHAIN_METADATA, PROPOSAL_EXECUTION_GRACE_PERIOD_MS } from 'constants/chainMetadata';
+import { PROPOSAL_EXECUTION_GRACE_PERIOD_MS } from 'constants/governance';
 import { governanceChain } from 'libs/wallet';
 import {
   type AbstainVoter,
@@ -24,7 +26,7 @@ import {
 import { formatToProposalActions } from './formatToProposalActions';
 import { formatToRemoteProposal } from './formatToRemoteProposal';
 
-const { blockTimeMs: BSC_BLOCK_TIME_MS } = CHAIN_METADATA[governanceChain.id];
+const { blockTimeMs: BSC_BLOCK_TIME_MS } = chainMetadata[governanceChain.id];
 
 export const formatToProposal = ({
   gqlProposal,

apps/evm/src/constants/api.ts → apps/evm/src/config/apiUrls.ts

@@ -1,6 +1,8 @@
 import type { Network } from 'types';
 
-export const apiUrls: Record<Network, string> = {
+export const apiUrls: {
+  [key in Network]: string;
+} = {
   testnet: 'https://testnetapi.venus.io',
   mainnet: 'https://api.venus.io',
   'mainnet-preview': 'https://api-preview.venus.io',