@glowlabs-org/utils 0.2.106 → 0.2.108

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

@@ -1,6 +1,29 @@
-import type { SponsoredFarm, EstimateRewardScoreParams, RewardScoreResponse, EstimateRewardScoresBatchParams, EstimateRewardScoresBatchResponse } from "../types";
+/**
+ * # Farms Router
+ *
+ * This router handles operations related to solar farms.
+ *
+ * ## Endpoints
+ *
+ * ### GET `/farms/sponsored`
+ * Returns all sponsored farms, optionally filtered by sponsor wallet.
+ *
+ * ### GET `/farms/wallet/:walletAddress/farms-with-rewards`
+ * Returns all farms where the specified wallet address has reward splits,
+ * along with their calculated weekly rewards for that wallet.
+ *
+ * ### POST `/farms/estimate-reward-score`
+ * Calculates the reward score for a potential marketplace farm based on its
+ * parameters and current region data.
+ *
+ * ### POST `/farms/estimate-reward-scores-batch`
+ * Calculates reward scores for multiple potential marketplace farms.
+ * Each farm is calculated independently as if joining the protocol by itself.
+ */
+import type { SponsoredFarm, EstimateRewardScoreParams, RewardScoreResponse, EstimateRewardScoresBatchParams, EstimateRewardScoresBatchResponse, FarmWithRewards } from "../types";
 export declare function FarmsRouter(baseUrl: string): {
     readonly fetchSponsoredFarms: (sponsorWallet?: string) => Promise<SponsoredFarm[]>;
+    readonly fetchWalletFarmsWithRewards: (walletAddress: string) => Promise<FarmWithRewards[]>;
     readonly estimateRewardScore: (params: EstimateRewardScoreParams) => Promise<RewardScoreResponse>;
     readonly estimateRewardScoresBatch: (params: EstimateRewardScoresBatchParams) => Promise<EstimateRewardScoresBatchResponse>;
 };

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

@@ -247,7 +247,6 @@ export interface SponsoredFarm {
     protocolDepositUSDC6Decimals: string;
     protocolDepositPaidAmount: string;
     protocolDepositPaidCurrency: string;
-    protocolDepositPayerWallet: string | null;
     builtEpoch: number;
     builtAt: string;
     afterInstallPictures: {
@@ -372,7 +371,6 @@ export interface WalletFarmInfo {
     adjustedWeeklyCarbonCredits: string;
     protocolDepositPaidAmount: string;
     protocolDepositPaidCurrency: string;
-    protocolDepositPayerWallet: string | null;
     builtEpoch: number;
     builtAt: string;
 }
@@ -440,4 +438,17 @@ export type BatchRewardScoreResult = BatchRewardScoreSuccessResult | BatchReward
 export interface EstimateRewardScoresBatchResponse {
     results: BatchRewardScoreResult[];
 }
+export interface UserWeeklyRewards {
+    protocolDepositRewards: string;
+    glwInflationRewards: string;
+    userGlowSplitPercent: string;
+    userDepositSplitPercent: string;
+}
+export interface FarmWithRewards extends SponsoredFarm {
+    userWeeklyRewards: UserWeeklyRewards;
+}
+export interface WalletFarmsWithRewardsResponse {
+    farms: FarmWithRewards[];
+    totalFarms: number;
+}
 export type { MintedEvent as ControlMintedEvent };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glowlabs-org/utils",
-  "version": "0.2.106",
+  "version": "0.2.108",
   "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,5 +1,28 @@
 "use strict";
 
+/**
+ * # Farms Router
+ *
+ * This router handles operations related to solar farms.
+ *
+ * ## Endpoints
+ *
+ * ### GET `/farms/sponsored`
+ * Returns all sponsored farms, optionally filtered by sponsor wallet.
+ *
+ * ### GET `/farms/wallet/:walletAddress/farms-with-rewards`
+ * Returns all farms where the specified wallet address has reward splits,
+ * along with their calculated weekly rewards for that wallet.
+ *
+ * ### POST `/farms/estimate-reward-score`
+ * Calculates the reward score for a potential marketplace farm based on its
+ * parameters and current region data.
+ *
+ * ### POST `/farms/estimate-reward-scores-batch`
+ * Calculates reward scores for multiple potential marketplace farms.
+ * Each farm is calculated independently as if joining the protocol by itself.
+ */
+
 import type {
   SponsoredFarm,
   SponsoredFarmsResponse,
@@ -8,6 +31,8 @@ import type {
   EstimateRewardScoreErrorResponse,
   EstimateRewardScoresBatchParams,
   EstimateRewardScoresBatchResponse,
+  WalletFarmsWithRewardsResponse,
+  FarmWithRewards,
 } from "../types";
 
 function parseApiError(error: unknown): string {
@@ -45,6 +70,23 @@ export function FarmsRouter(baseUrl: string) {
     }
   };
 
+  const fetchWalletFarmsWithRewards = async (
+    walletAddress: string
+  ): Promise<FarmWithRewards[]> => {
+    try {
+      if (!walletAddress) {
+        throw new Error("Wallet address is required");
+      }
+
+      const data = await request<WalletFarmsWithRewardsResponse>(
+        `/farms/wallet/${encodeURIComponent(walletAddress)}/farms-with-rewards`
+      );
+      return data.farms ?? [];
+    } catch (error) {
+      throw new Error(parseApiError(error));
+    }
+  };
+
   const estimateRewardScore = async (
     params: EstimateRewardScoreParams
   ): Promise<RewardScoreResponse> => {
@@ -95,6 +137,7 @@ export function FarmsRouter(baseUrl: string) {
 
   return {
     fetchSponsoredFarms,
+    fetchWalletFarmsWithRewards,
     estimateRewardScore,
     estimateRewardScoresBatch,
   } as const;

package/src/lib/types/index.ts

@@ -307,7 +307,7 @@ export interface SponsoredFarm {
   protocolDepositUSDC6Decimals: string;
   protocolDepositPaidAmount: string;
   protocolDepositPaidCurrency: string;
-  protocolDepositPayerWallet: string | null;
+
   builtEpoch: number;
   builtAt: string;
   afterInstallPictures: {
@@ -457,7 +457,7 @@ export interface WalletFarmInfo {
   adjustedWeeklyCarbonCredits: string;
   protocolDepositPaidAmount: string;
   protocolDepositPaidCurrency: string;
-  protocolDepositPayerWallet: string | null;
+
   builtEpoch: number;
   builtAt: string; // ISO 8601
 }
@@ -539,6 +539,23 @@ export interface EstimateRewardScoresBatchResponse {
   results: BatchRewardScoreResult[];
 }
 
+// ----------------------------- Wallet Farm Rewards ---------------------------
+export interface UserWeeklyRewards {
+  protocolDepositRewards: string; // User's weekly protocol deposit rewards in the farm's payment currency
+  glwInflationRewards: string; // User's weekly GLW inflation rewards (18 decimals)
+  userGlowSplitPercent: string; // User's GLW split percentage (6 decimals)
+  userDepositSplitPercent: string; // User's deposit split percentage (6 decimals)
+}
+
+export interface FarmWithRewards extends SponsoredFarm {
+  userWeeklyRewards: UserWeeklyRewards;
+}
+
+export interface WalletFarmsWithRewardsResponse {
+  farms: FarmWithRewards[];
+  totalFarms: number;
+}
+
 // ---------------------------------------------------------------------------
 // Barrel exports (convenience)
 // ---------------------------------------------------------------------------