@glowlabs-org/utils 0.2.96 → 0.2.97

package/dist/esm/index.js

@@ -13,8 +13,8 @@ import { parseUnits, formatUnits } from 'viem';
 import { MerkleTree } from 'merkletreejs';
 import { solidityPackedKeccak256, keccak256 } from 'ethers';
 import Decimal from 'decimal.js';
-import { H as HUB_URL, U as USDG_WEIGHT_DECIMAL_PRECISION, G as GLOW_WEIGHT_DECIMAL_PRECISION, M as MAX_WEIGHT } from './farms-router-BCnakF0d.js';
-export { C as ControlRouter, F as FarmsRouter, K as KickstarterRouter, R as RegionRouter, W as WalletsRouter, u as useForwarder, a as useOffchainFractions } from './farms-router-BCnakF0d.js';
+import { H as HUB_URL, U as USDG_WEIGHT_DECIMAL_PRECISION, G as GLOW_WEIGHT_DECIMAL_PRECISION, M as MAX_WEIGHT } from './farms-router-Da1P3B8g.js';
+export { C as ControlRouter, F as FarmsRouter, K as KickstarterRouter, R as RegionRouter, W as WalletsRouter, u as useForwarder, a as useOffchainFractions } from './farms-router-Da1P3B8g.js';
 
 const GENESIS_TIMESTAMP = 1700352000;
 

package/dist/esm/lib/control-api/farms-router.d.ts

@@ -1,4 +1,5 @@
-import type { SponsoredFarm } from "../types";
+import type { SponsoredFarm, EstimateRewardScoreParams, RewardScoreResponse } from "../types";
 export declare function FarmsRouter(baseUrl: string): {
     readonly fetchSponsoredFarms: (sponsorWallet?: string) => Promise<SponsoredFarm[]>;
+    readonly estimateRewardScore: (params: EstimateRewardScoreParams) => Promise<RewardScoreResponse>;
 };

package/dist/esm/lib/types/index.d.ts

@@ -383,4 +383,68 @@ export interface WalletDetails {
     ownedFarms: WalletFarmInfo[];
     purchasedFarms: WalletFarmInfo[];
 }
+export interface EstimateRewardScoreParams {
+    userId: string;
+    sponsorSplitPercent: number;
+    protocolDepositAmount: string;
+    paymentCurrency: PaymentCurrency;
+    adjustedWeeklyCarbonCredits: number;
+    zone: {
+        id: number;
+        name?: string;
+    };
+}
+export interface RewardScoreResponse {
+    rewardScore: number;
+    userWeeklyPdRewards: string;
+    userWeeklyPdRewardsUsd: string;
+    userWeeklyGlwRewards: string;
+    userWeeklyGlwValueUsd: string;
+    userEstimatedWeeklyCash: string;
+    userProtocolDeposit: string;
+    userGlowSplitPercent: string;
+    userDepositSplitPercent: string;
+    glwPriceUsd6: string;
+    regionInfo: {
+        regionId: number;
+        regionName: string;
+        existingFarmCount: number;
+        existingTotalDepositsUsd: string;
+        currencyBreakdown: {
+            currency: string;
+            protocolDepositSum: string;
+            carbonCreditProductionSum: string;
+        }[];
+        regionGctlStaked: string;
+        totalGctlStakedAllRegions: string;
+    };
+}
+export interface EstimateRewardScoreApiResponse {
+    rewardScore: number;
+    userWeeklyPdRewards: string;
+    userWeeklyPdRewardsUsd: string;
+    userWeeklyGlwRewards: string;
+    userWeeklyGlwValueUsd: string;
+    userEstimatedWeeklyCash: string;
+    userProtocolDeposit: string;
+    userGlowSplitPercent: string;
+    userDepositSplitPercent: string;
+    glwPriceUsd6: string;
+    regionInfo: {
+        regionId: number;
+        regionName: string;
+        existingFarmCount: number;
+        existingTotalDepositsUsd: string;
+        currencyBreakdown: {
+            currency: string;
+            protocolDepositSum: string;
+            carbonCreditProductionSum: string;
+        }[];
+        regionGctlStaked: string;
+        totalGctlStakedAllRegions: string;
+    };
+}
+export interface EstimateRewardScoreErrorResponse {
+    error: string;
+}
 export type { MintedEvent as ControlMintedEvent };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glowlabs-org/utils",
-  "version": "0.2.96",
+  "version": "0.2.97",
   "description": "A library containing all typechain types and addresses relating to the glow guarded launch",
   "keywords": [],
   "author": "",

package/src/lib/control-api/farms-router.ts

@@ -1,7 +1,13 @@
 "use strict";
 
-import type { SponsoredFarm } from "../types";
-import type { SponsoredFarmsResponse } from "../types";
+import type {
+  SponsoredFarm,
+  SponsoredFarmsResponse,
+  EstimateRewardScoreParams,
+  RewardScoreResponse,
+  EstimateRewardScoreApiResponse,
+  EstimateRewardScoreErrorResponse,
+} from "../types";
 
 function parseApiError(error: unknown): string {
   if (!error) return "Unknown error";
@@ -38,7 +44,36 @@ export function FarmsRouter(baseUrl: string) {
     }
   };
 
+  const estimateRewardScore = async (
+    params: EstimateRewardScoreParams
+  ): Promise<RewardScoreResponse> => {
+    try {
+      // First try to get the success response
+      const data = await request<
+        EstimateRewardScoreApiResponse | EstimateRewardScoreErrorResponse
+      >("/farms/estimate-reward-score", {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: JSON.stringify(params),
+      });
+
+      // Check if it's an error response
+      if ("error" in data) {
+        throw new Error(data.error);
+      }
+
+      // At this point, TypeScript knows it's EstimateRewardScoreApiResponse
+      // All fields are required in the success response based on the API spec
+      return data as RewardScoreResponse;
+    } catch (error) {
+      throw new Error(parseApiError(error));
+    }
+  };
+
   return {
     fetchSponsoredFarms,
+    estimateRewardScore,
   } as const;
 }

package/src/lib/types/index.ts

@@ -469,6 +469,75 @@ export interface WalletDetails {
   purchasedFarms: WalletFarmInfo[];
 }
 
+// ----------------------------- Farms Reward Score ---------------------------
+export interface EstimateRewardScoreParams {
+  userId: string;
+  sponsorSplitPercent: number;
+  protocolDepositAmount: string;
+  paymentCurrency: PaymentCurrency;
+  adjustedWeeklyCarbonCredits: number;
+  zone: {
+    id: number;
+    name?: string;
+  };
+}
+
+export interface RewardScoreResponse {
+  rewardScore: number;
+  userWeeklyPdRewards: string;
+  userWeeklyPdRewardsUsd: string;
+  userWeeklyGlwRewards: string;
+  userWeeklyGlwValueUsd: string;
+  userEstimatedWeeklyCash: string;
+  userProtocolDeposit: string;
+  userGlowSplitPercent: string;
+  userDepositSplitPercent: string;
+  glwPriceUsd6: string;
+  regionInfo: {
+    regionId: number;
+    regionName: string;
+    existingFarmCount: number;
+    existingTotalDepositsUsd: string;
+    currencyBreakdown: {
+      currency: string;
+      protocolDepositSum: string;
+      carbonCreditProductionSum: string;
+    }[];
+    regionGctlStaked: string;
+    totalGctlStakedAllRegions: string;
+  };
+}
+
+export interface EstimateRewardScoreApiResponse {
+  rewardScore: number;
+  userWeeklyPdRewards: string;
+  userWeeklyPdRewardsUsd: string;
+  userWeeklyGlwRewards: string;
+  userWeeklyGlwValueUsd: string;
+  userEstimatedWeeklyCash: string;
+  userProtocolDeposit: string;
+  userGlowSplitPercent: string;
+  userDepositSplitPercent: string;
+  glwPriceUsd6: string;
+  regionInfo: {
+    regionId: number;
+    regionName: string;
+    existingFarmCount: number;
+    existingTotalDepositsUsd: string;
+    currencyBreakdown: {
+      currency: string;
+      protocolDepositSum: string;
+      carbonCreditProductionSum: string;
+    }[];
+    regionGctlStaked: string;
+    totalGctlStakedAllRegions: string;
+  };
+}
+
+export interface EstimateRewardScoreErrorResponse {
+  error: string;
+}
+
 // ---------------------------------------------------------------------------
 // Barrel exports (convenience)
 // ---------------------------------------------------------------------------