New chain config/common

packages/common/package.json

@@ -20,6 +20,7 @@
     "@ethersproject/abstract-signer": "^5.7.0",
     "@ethersproject/providers": "^5.7.2",
     "@gitcoinco/passport-sdk-types": "^0.2.0",
+    "@grants-labs/gitcoin-chain-data": "1.0.39",
     "@openzeppelin/merkle-tree": "^1.0.2",
     "@rainbow-me/rainbowkit": "^0.12.16",
     "@spruceid/didkit-wasm": "0.3.0-alpha0",
@@ -31,6 +32,7 @@
     "eslint-config-gitcoin": "workspace:*",
     "ethers": "^5.6.5",
     "framer-motion": "^10.12.7",
+    "gitcoin-chain-data": "link:@types/grants-labs/gitcoin-chain-data",
     "markdown-it": "^13.0.1",
     "moment-timezone": "^0.5.45",
     "react": "^18.2.0",

packages/common/src/allo/allo.ts

@@ -7,12 +7,12 @@ import {
   RoundCategory,
   UpdateRoundParams,
   MatchingStatsData,
-  VotingToken,
 } from "../types";
 import { Result } from "./common";
 import { AlloOperation } from "./operation";
 import { TransactionReceipt } from "./transaction-sender";
 import { PermitSignature } from "./voting";
+import { TToken } from "@grants-labs/gitcoin-chain-data";
 
 export type CreateRoundArguments = {
   roundData: {
@@ -114,7 +114,7 @@ export interface Allo {
   donate: (
     publicClient: PublicClient,
     chainId: ChainId,
-    token: VotingToken,
+    token: TToken,
     groupedVotes: Record<string, Hex[]>,
     groupedAmounts: Record<string, bigint> | bigint[],
     nativeTokenAmount: bigint,

packages/common/src/allo/backends/allo-v1.ts

@@ -15,13 +15,12 @@ import {
 } from "viem";
 import { AnyJson, ChainId, TransactionBuilder } from "../..";
 import { parseChainId } from "../../chains";
-import { payoutTokens } from "../../payoutTokens";
+// import { payoutTokens } from "../../payoutTokens";
 import {
   RoundCategory,
   UpdateAction,
   UpdateRoundParams,
   MatchingStatsData,
-  VotingToken,
 } from "../../types";
 import ProgramFactoryABI from "../abis/allo-v1/ProgramFactory";
 import MRC_ABI from "../abis/allo-v1/multiRoundCheckout";
@@ -57,6 +56,8 @@ import MerklePayoutStrategyImplementationABI from "../abis/allo-v1/MerklePayoutS
 import { BigNumber } from "ethers";
 import DirectPayoutStrategyImplementation from "../abis/allo-v1/DirectPayoutStrategyImplementation";
 import { hexZeroPad } from "ethers/lib/utils.js";
+import { getTokensByChainId } from "@grants-labs/gitcoin-chain-data";
+import { TToken } from "@grants-labs/gitcoin-chain-data/dist/types";
 
 function createProjectId(args: {
   chainId: number;
@@ -110,7 +111,7 @@ export class AlloV1 implements Allo {
   async donate(
     publicClient: PublicClient,
     chainId: ChainId,
-    token: VotingToken,
+    token: TToken,
     groupedVotes: Record<string, Hex[]>,
     groupedAmounts: Record<string, bigint> | bigint[],
     nativeTokenAmount: bigint,
@@ -491,8 +492,8 @@ export class AlloV1 implements Allo {
             args.roundData.applicationsEndTime
               ? dateToEthereumTimestamp(args.roundData.applicationsEndTime)
               : args.roundData.roundEndTime
-              ? dateToEthereumTimestamp(args.roundData.roundEndTime)
-              : maxUint256,
+                ? dateToEthereumTimestamp(args.roundData.roundEndTime)
+                : maxUint256,
             dateToEthereumTimestamp(args.roundData.roundStartTime),
             args.roundData.roundEndTime
               ? dateToEthereumTimestamp(args.roundData.roundEndTime)
@@ -505,13 +506,17 @@ export class AlloV1 implements Allo {
         if (isQF) {
           // Ensure tokenAmount is normalized to token decimals
           const tokenAmount = args.roundData.matchingFundsAvailable ?? 0;
-          const pyToken = payoutTokens.filter(
+
+          // Note: uses the new SDK
+          const tokens = getTokensByChainId(this.chainId);
+          const payoutTokens = tokens;
+          const payoutToken = payoutTokens.filter(
             (t) =>
               t.address.toLowerCase() === args.roundData.token.toLowerCase()
           )[0];
           parsedTokenAmount = parseUnits(
             tokenAmount.toString(),
-            pyToken.decimal
+            payoutToken.decimals
           );
         }
 

packages/common/src/allo/backends/allo-v2.ts

@@ -22,7 +22,7 @@ import {
 } from "data-layer";
 import { Abi, Address, Hex, PublicClient, getAddress, zeroAddress } from "viem";
 import { AnyJson, ChainId } from "../..";
-import { UpdateRoundParams, MatchingStatsData, VotingToken } from "../../types";
+import { UpdateRoundParams, MatchingStatsData } from "../../types";
 import { Allo, AlloError, AlloOperation, CreateRoundArguments } from "../allo";
 import {
   Result,
@@ -46,6 +46,7 @@ import { StandardMerkleTree } from "@openzeppelin/merkle-tree";
 import { buildUpdatedRowsOfApplicationStatuses } from "../application";
 import { BigNumber, utils } from "ethers";
 import { Distribution } from "@allo-team/allo-v2-sdk/dist/strategies/DonationVotingMerkleDistributionStrategy/types";
+import { TToken } from "@grants-labs/gitcoin-chain-data/dist/types";
 
 function getStrategyAddress(strategy: RoundCategory, chainId: ChainId): string {
   let strategyAddresses;
@@ -151,7 +152,7 @@ export class AlloV2 implements Allo {
   async donate(
     publicClient: PublicClient,
     chainId: ChainId,
-    token: VotingToken,
+    token: TToken,
     groupedVotes: Record<string, Hex[]>,
     groupedAmounts: Record<string, bigint> | bigint[],
     nativeTokenAmount: bigint,

packages/common/src/allo/voting.ts

@@ -1,4 +1,4 @@
-import { VotingToken } from "../types";
+import { TToken } from "@grants-labs/gitcoin-chain-data/dist/types";
 
 export type PermitSignature = {
   v: number;
@@ -11,11 +11,8 @@ export type PermitSignature = {
  *
  * Old DAI permit type is only implemented on Ethereum and Polygon PoS. Check /docs/DAI.md for more info.
  * */
-export const getPermitType = (token: VotingToken): PermitType => {
-  if (
-    /DAI/i.test(token.name) &&
-    ([1, 137, 11155111].includes(token.chainId))
-  ) {
+export const getPermitType = (token: TToken): PermitType => {
+  if (/DAI/i.test(token.code) && [1, 137, 11155111].includes(token.chainId)) {
     return "dai";
   } else {
     return "eip2612";

packages/common/src/chains.test.ts

@@ -5,36 +5,43 @@ import { ChainId } from "./chain-ids";
 test("Valid input: number", () => {
   const input = 137;
   const result = parseChainId(input);
+
   expect(result).toBe(ChainId.POLYGON);
 });
 
 test("Valid input: string (number as string)", () => {
   const input = "80001";
   const result = parseChainId(input);
+
   expect(result).toBe(ChainId.POLYGON_MUMBAI);
 });
 
 test("Invalid input: string (non-existent enum name)", () => {
   const input = "NON_EXISTENT_CHAIN";
+
   expect(() => parseChainId(input)).toThrow("Invalid chainId " + input);
 });
 
 test("Invalid input: string (non-numeric string)", () => {
   const input = "invalid";
+
   expect(() => parseChainId(input)).toThrow("Invalid chainId " + input);
 });
 
 test("Invalid input: number (non-existent enum value)", () => {
   const input = 999;
+
   expect(() => parseChainId(input)).toThrow("Invalid chainId " + input);
 });
 
 test("Invalid input: null", () => {
   const input = null;
+
   expect(() => parseChainId(input as any)).toThrow("Invalid chainId null");
 });
 
 test("Invalid input: undefined", () => {
   const input = undefined;
+
   expect(() => parseChainId(input as any)).toThrow("Invalid chainId undefined");
 });