@glowlabs-org/utils 0.0.8 → 0.1.1

package/src/index.ts

@@ -1,258 +1,3 @@
-export * from "./types/index";
+export * from "./lib/create-weekly-report/types/index";
 export * from "./constants/index";
-import MerkleTree from "merkletreejs";
-import { BigNumber, ethers } from "ethers";
-
-import { formatUnits, parseUnits } from "viem";
-import { Farm, GCAServerResponse } from "./types";
-import { hashLeaf } from "./hash-leaf";
-
-export type ApiRes = {
-  filteredFarms: Farm[];
-  rawData: GCAServerResponse;
-  multiplier: number;
-};
-
-export type MerkleLeafIntermediary = {
-  wallet: string;
-  glowWeight: number;
-  usdgWeight: number;
-};
-
-export type FinalLeaf = {
-  wallet: string;
-  glowWeight: string;
-  usdgWeight: string;
-};
-
-/**
- * @dev This is actually not as intuitive as it seems.
- * Glow actually has 18 decimals, but glow weight is based on the amount of protocol fees (USDC) that the farm paid
- * Therefore, the weight is based on the amount of USDC that was paid, which has 6 decimals
- */
-const GLOW_WEIGHT_DECIMAL_PRECISION = 6;
-
-/**
- * @dev This is actually not as intuitive as it seems.
- * USDG weight is based on the amount of carbon credits produced, but the max value of a weight is ((2*64)-1) / 5 so we need to choose sensible precision to make sure that number never overflows
- */
-const USDG_WEIGHT_DECIMAL_PRECISION = 6;
-export type CreateWeeklyReportArgs = {
-  week: number;
-  gcaUrls: string[];
-  apiUrl: string;
-};
-// const GCA_URLS = ["http://95.217.194.59:35015"];
-async function getFarmsForWeek(args: CreateWeeklyReportArgs): Promise<ApiRes> {
-  const { week: weekNumber, gcaUrls, apiUrl } = args;
-  const url = apiUrl;
-  // const url = "http://0.0.0.0:3005/headline_farm_stats";
-  const body = {
-    urls: gcaUrls,
-    week_number: weekNumber,
-    with_full_data: true,
-    include_unassigned_farms: false,
-    with_raw_data: true,
-  };
-
-  const res = await fetch(url, {
-    method: "POST",
-    body: JSON.stringify(body),
-    headers: {
-      "Content-Type": "application/json",
-    },
-  });
-  if (!res.ok) {
-    const errorText = await res.text();
-    throw new Error(
-      `Failed to fetch farms for week ${weekNumber}: ${
-        errorText || res.statusText
-      }`
-    );
-  }
-  const _json = await res.json();
-  return _json as ApiRes;
-}
-
-export async function createWeeklyReport(args: CreateWeeklyReportArgs) {
-  const map = new Map<string, MerkleLeafIntermediary>();
-
-  function addValueToMap(
-    key: string,
-    value: MerkleLeafIntermediary,
-    map: Map<string, MerkleLeafIntermediary>
-  ) {
-    if (map.has(key)) {
-      //+= everything
-      const existingValue = map.get(key)!;
-      existingValue.glowWeight += value.glowWeight;
-      existingValue.usdgWeight += value.usdgWeight;
-      map.set(key, existingValue);
-    } else {
-      map.set(key, value);
-    }
-  }
-  const apiResposne = await getFarmsForWeek(args);
-  const farms = apiResposne.filteredFarms;
-  const rawData = apiResposne.rawData;
-  let totalCreditsProduced: number = 0;
-  //log the total farms in farms
-  for (const farm of farms) {
-    // const {
-    //   shortId,
-    //   payoutWallet,
-    //   installerGlowFeePercent,
-    //   installerUsdgFeePercent,
-    // } = farm;
-    // const key = farm.payoutWallet;
-    // farm.carbonCreditsProduced =
-    farm.status === "Unassigned" ? 0 : farm.carbonCreditsProduced;
-    console.log(farm.status);
-    if (farm.carbonCreditsProduced < 0) {
-      throw new Error("Carbon credits produced is less than 0");
-    }
-    totalCreditsProduced += farm.carbonCreditsProduced;
-    // const value = {
-    //   wallet: payoutWallet,
-    //   glowWeight: farm.weeklyPayment * (1 - installerGlowFeePercent),
-    //   usdgWeight: farm.carbonCreditsProduced * (1 - installerUsdgFeePercent),
-    // };
-
-    // const installerKey = farm.installerWallet;
-    // const installerValue = {
-    //   wallet: farm.installerWallet,
-    //   glowWeight: farm.weeklyPayment * installerGlowFeePercent,
-    //   usdgWeight: farm.carbonCreditsProduced * installerUsdgFeePercent,
-    // };
-    if (!farm.rewardSplits) throw new Error("No reward splits");
-    const sumOfRewardSplitsGlowWeight = farm.rewardSplits.reduce(
-      (acc, rewardSplit) => acc + rewardSplit.glowSplitPercent,
-      0
-    );
-    const sumOfRewardSplitsUSDGWeight = farm.rewardSplits.reduce(
-      (acc, rewardSplit) => acc + rewardSplit.usdgSplitPercent,
-      0
-    );
-    if (sumOfRewardSplitsGlowWeight !== 1)
-      throw new Error("Glow weight splits do not add up to 1");
-    if (sumOfRewardSplitsUSDGWeight !== 1)
-      throw new Error("USDG weight splits do not add up to 1");
-    for (const rewardSplit of farm.rewardSplits) {
-      const value = {
-        wallet: rewardSplit.walletAddress,
-        glowWeight: farm.weeklyPayment * rewardSplit.glowSplitPercent,
-        usdgWeight: farm.carbonCreditsProduced * rewardSplit.usdgSplitPercent,
-      };
-
-      addValueToMap(rewardSplit.walletAddress, value, map);
-    }
-    //   addValueToMap(key, value, map);
-    // addValueToMap(installerKey, installerValue, map);
-  }
-
-  const merkleLeaves = Array.from(map.values());
-  const finalLeaves: FinalLeaf[] = merkleLeaves.map(
-    ({ wallet, glowWeight, usdgWeight }) => ({
-      wallet,
-      glowWeight: parseUnits(
-        glowWeight.toString(),
-        GLOW_WEIGHT_DECIMAL_PRECISION
-      ).toString(),
-      usdgWeight: parseUnits(
-        usdgWeight.toString(),
-        USDG_WEIGHT_DECIMAL_PRECISION
-      ).toString(),
-    })
-  );
-  const leaves = finalLeaves.map((leaf) =>
-    hashLeaf({
-      address: leaf.wallet,
-      glowWeight: leaf.glowWeight,
-      usdcWeight: leaf.usdgWeight,
-    })
-  );
-
-  const tree = new MerkleTree(leaves, ethers.utils.keccak256, { sort: true });
-  const root = tree.getHexRoot();
-
-  const totalGlowWeightFinalizedLeavesSum = finalLeaves.reduce(
-    (acc, { glowWeight }) => acc.add(glowWeight),
-    ethers.BigNumber.from(0)
-  );
-  const totalGCCWeightFinalizedLeavesSum = finalLeaves.reduce(
-    (acc, { usdgWeight }) => acc.add(usdgWeight),
-    ethers.BigNumber.from(0)
-  );
-
-  const headlineStats = {
-    weekNumber: args.week,
-    totalCreditsProduced,
-    totalCreditsProducedBN: parseUnits(
-      totalCreditsProduced.toString(),
-      18
-    ).toString(),
-    totalGlowWeightInFinalized: totalGlowWeightFinalizedLeavesSum.toString(),
-    totalGlowWeightHuman: formatUnits(
-      BigInt(totalGlowWeightFinalizedLeavesSum.toString()),
-      GLOW_WEIGHT_DECIMAL_PRECISION
-    ).toString(),
-    totalUSDGWeightInFinalized: totalGCCWeightFinalizedLeavesSum.toString(),
-    totalUSDGWeightHuman: formatUnits(
-      BigInt(totalGCCWeightFinalizedLeavesSum.toString()),
-      USDG_WEIGHT_DECIMAL_PRECISION
-    ).toString(),
-    root: root,
-  };
-
-  const farmsWithMerkleProofs = finalLeaves.map((leaf) => {
-    const hashedLeaf = hashLeaf({
-      address: leaf.wallet,
-      glowWeight: leaf.glowWeight,
-      usdcWeight: leaf.usdgWeight,
-    });
-    const proof = tree.getHexProof(hashedLeaf);
-    const isValid = tree.verify(proof, hashedLeaf, root);
-    if (!isValid) {
-      throw new Error("Invalid proof");
-    }
-    return {
-      ...leaf,
-      proof,
-    };
-  });
-
-  //-----------------------------------------------------//
-  //-Some invariant tests in case something got messed up//
-  //-----------------------------------------------------//
-  //Make sure that the sum of all the glow weight is equal to the sum of all the glow weight in the final leaves
-  let forLoopedGlowWeightSum: ethers.BigNumber = ethers.BigNumber.from(0);
-  for (const farm of farmsWithMerkleProofs) {
-    forLoopedGlowWeightSum = forLoopedGlowWeightSum.add(
-      BigNumber.from(farm.glowWeight)
-    );
-  }
-
-  if (!forLoopedGlowWeightSum.eq(totalGlowWeightFinalizedLeavesSum)) {
-    throw new Error("Glow weight sum is not equal");
-  }
-
-  //do the same for gcc
-  let forLoopedGCCWeightSum: ethers.BigNumber = ethers.BigNumber.from(0);
-  for (const farm of farmsWithMerkleProofs) {
-    forLoopedGCCWeightSum = forLoopedGCCWeightSum.add(
-      BigNumber.from(farm.usdgWeight)
-    );
-  }
-
-  if (!forLoopedGCCWeightSum.eq(totalGCCWeightFinalizedLeavesSum)) {
-    throw new Error("GCC weight sum is not equal");
-  }
-
-  return {
-    headlineStats,
-    finalLeaves,
-    farmsWithMerkleProofs,
-    farms,
-    rawData,
-  };
-}
+export { createWeeklyReport } from "./lib/create-weekly-report/index";