@glowlabs-org/utils 0.2.154 → 0.2.155

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-C0g4hf2Z.js';
-export { C as ControlRouter, F as FarmsRouter, d as KICKSTARTER_STATUS, K as KickstarterRouter, O as OFF_CHAIN_PAYMENT_CURRENCIES, P as PAYMENT_CURRENCIES, b as REGIONS, R as RegionRouter, S as STAKING_DIRECTIONS, T as TRANSFER_TYPES, W as WalletsRouter, c as configureSentry, u as useForwarder, a as useOffchainFractions } from './farms-router-C0g4hf2Z.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-BYpMNa_b.js';
+export { C as ControlRouter, F as FarmsRouter, d as KICKSTARTER_STATUS, K as KickstarterRouter, O as OFF_CHAIN_PAYMENT_CURRENCIES, P as PAYMENT_CURRENCIES, b as REGIONS, R as RegionRouter, S as STAKING_DIRECTIONS, T as TRANSFER_TYPES, W as WalletsRouter, c as configureSentry, u as useForwarder, a as useOffchainFractions } from './farms-router-BYpMNa_b.js';
 
 const GENESIS_TIMESTAMP = 1700352000;
 

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

@@ -28,11 +28,12 @@
  * Calculates mining scores for existing farms that are already live on the protocol.
  * The mining score represents the return on investment for a miner based on the farm's total GLW rewards.
  */
-import type { SponsoredFarm, EstimateRewardScoreParams, RewardScoreResponse, EstimateRewardScoresBatchParams, EstimateRewardScoresBatchResponse, FarmWithRewards, FarmRewardSplit, MiningScoresBatchParams, MiningScoresBatchResponse } from "../types";
+import type { SponsoredFarm, EstimateRewardScoreParams, RewardScoreResponse, EstimateRewardScoresBatchParams, EstimateRewardScoresBatchResponse, FarmWithRewards, FarmRewardSplit, MiningScoresBatchParams, MiningScoresBatchResponse, FarmWeeklyRewardsResponse, FarmWeeklyRewardsQuery } from "../types";
 export declare function FarmsRouter(baseUrl: string): {
     readonly fetchFarmRewardSplits: (farmId: string) => Promise<FarmRewardSplit[]>;
     readonly fetchSponsoredFarms: (sponsorWallet?: string) => Promise<SponsoredFarm[]>;
     readonly fetchWalletFarmsWithRewards: (walletAddress: string) => Promise<FarmWithRewards[]>;
+    readonly fetchFarmWeeklyRewards: (farmId: string, query?: FarmWeeklyRewardsQuery) => Promise<FarmWeeklyRewardsResponse>;
     readonly estimateRewardScore: (params: EstimateRewardScoreParams) => Promise<RewardScoreResponse>;
     readonly estimateRewardScoresBatch: (params: EstimateRewardScoresBatchParams) => Promise<EstimateRewardScoresBatchResponse>;
     readonly calculateMiningScoresBatch: (params: MiningScoresBatchParams) => Promise<MiningScoresBatchResponse>;

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

@@ -1,4 +1,4 @@
-import type { RegionWithMetadata, ActivationConfig, ActivationEvent, RegionDetails, SponsoredFarm, ActiveRegionsSummaryResponse, RecentRegionActivityResponse, InstallerApplicationPayload, InstallerApplicationResponse } from "../types";
+import type { RegionWithMetadata, ActivationConfig, ActivationEvent, RegionDetails, SponsoredFarm, ActiveRegionsSummaryResponse, RecentRegionActivityResponse, InstallerApplicationPayload, InstallerApplicationResponse, RegionWeeklyRewardsResponse, RegionWeeklyRewardsQuery } from "../types";
 export declare function RegionRouter(baseUrl: string): {
     readonly fetchRegions: (params?: {
         isActive?: boolean;
@@ -9,6 +9,7 @@ export declare function RegionRouter(baseUrl: string): {
     readonly fetchRegionSolarFarms: (regionId: number) => Promise<SponsoredFarm[]>;
     readonly fetchActiveSummary: () => Promise<ActiveRegionsSummaryResponse>;
     readonly fetchRecentActivity: () => Promise<RecentRegionActivityResponse>;
+    readonly fetchRegionWeeklyRewards: (regionId: number, query?: RegionWeeklyRewardsQuery) => Promise<RegionWeeklyRewardsResponse>;
     readonly getRegionByCode: (code: string) => RegionWithMetadata | null;
     readonly applyInstallerCertification: (payload: InstallerApplicationPayload) => Promise<InstallerApplicationResponse>;
     readonly regions: RegionWithMetadata[];

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

@@ -1,8 +1,8 @@
-import type { ControlWallet, WalletDetails } from "../types";
-import type { MintedEvent, StakedEvent } from "../types";
+import type { ControlWallet, WalletDetails, MintedEvent, StakedEvent, WalletWeeklyRewardsResponse, WeeklyRewardsQuery } from "../types";
 export declare function WalletsRouter(baseUrl: string): {
     readonly fetchAllWallets: () => Promise<ControlWallet[]>;
     readonly fetchWalletByAddress: (wallet: string) => Promise<WalletDetails>;
     readonly fetchWalletMintedEvents: (wallet: string, page?: number, limit?: number) => Promise<MintedEvent[]>;
     readonly fetchWalletStakeEvents: (wallet: string, page?: number, limit?: number, regionId?: number) => Promise<StakedEvent[]>;
+    readonly fetchWalletWeeklyRewards: (wallet: string, query?: WeeklyRewardsQuery) => Promise<WalletWeeklyRewardsResponse>;
 };

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

@@ -478,7 +478,9 @@ export interface WalletFarmInfo {
     protocolDepositPaidAmount: string;
     protocolDepositPaidCurrency: string;
     builtEpoch: number;
-    builtAt: string;
+    builtAt?: string;
+    glowSplitPercent6Decimals: string;
+    depositSplitPercent6Decimals: string;
 }
 export interface WalletDetails {
     wallet: string;
@@ -489,6 +491,80 @@ export interface WalletDetails {
     regions: WalletRegionStakeTotal[];
     ownedFarms: WalletFarmInfo[];
 }
+export interface WeeklyReward {
+    weekNumber: number;
+    paymentCurrency: PaymentCurrency;
+    protocolDepositRewardsReceived: string;
+    glowInflationTotal: string;
+}
+export interface WeeklyRewardsSummary {
+    totalProtocolDepositRewardsReceived: string;
+    totalGlowInflation: string;
+    weeksActive: number;
+}
+export interface WalletWeeklyRewardsResponse {
+    wallet: string;
+    summary: WeeklyRewardsSummary;
+    rewards: WeeklyReward[];
+}
+export interface WeeklyRewardsQuery {
+    startWeek?: number;
+    endWeek?: number;
+    paymentCurrency?: PaymentCurrency;
+    limit?: number;
+}
+export interface FarmWeeklyReward {
+    weekNumber: number;
+    paymentCurrency: PaymentCurrency;
+    protocolDepositPaidTotal: string;
+    glowInflationTotal: string;
+    expectedProductionTotal: string;
+    protocolDepositRewardsDistributed: string;
+}
+export interface FarmWeeklyRewardsSummary {
+    totalProtocolDepositPaid: string;
+    totalGlowInflation: string;
+    totalExpectedProduction: string;
+    weeksActive: number;
+}
+export interface FarmWeeklyRewardsResponse {
+    farmId: string;
+    summary: FarmWeeklyRewardsSummary;
+    rewards: FarmWeeklyReward[];
+}
+export interface FarmWeeklyRewardsQuery {
+    startWeek?: number;
+    endWeek?: number;
+    paymentCurrency?: PaymentCurrency;
+    limit?: number;
+}
+export interface RegionWeeklyReward {
+    weekNumber: number;
+    paymentCurrency: PaymentCurrency;
+    protocolDepositPaidTotal: string;
+    glowInflationTotal: string;
+    expectedProductionTotal: string;
+    protocolDepositRewardsDistributed: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface RegionWeeklyRewardsSummary {
+    totalProtocolDepositPaid: string;
+    totalGlowInflation: string;
+    totalExpectedProduction: string;
+    weeksActive: number;
+}
+export interface RegionWeeklyRewardsResponse {
+    regionId: number;
+    summary: RegionWeeklyRewardsSummary;
+    rewards: RegionWeeklyReward[];
+}
+export interface RegionWeeklyRewardsQuery {
+    startWeek?: number;
+    endWeek?: number;
+    paymentCurrency?: PaymentCurrency;
+    limit?: number;
+}
 export interface EstimateRewardScoreParams {
     userId: string;
     sponsorSplitPercent: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glowlabs-org/utils",
-  "version": "0.2.154",
+  "version": "0.2.155",
   "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

@@ -46,6 +46,8 @@ import type {
   FarmRewardSplit,
   MiningScoresBatchParams,
   MiningScoresBatchResponse,
+  FarmWeeklyRewardsResponse,
+  FarmWeeklyRewardsQuery,
 } from "../types";
 import {
   sentryAddBreadcrumb,
@@ -128,6 +130,36 @@ export function FarmsRouter(baseUrl: string) {
     }
   };
 
+  const fetchFarmWeeklyRewards = async (
+    farmId: string,
+    query?: FarmWeeklyRewardsQuery
+  ): Promise<FarmWeeklyRewardsResponse> => {
+    try {
+      if (!farmId) {
+        throw new Error("Farm ID is required");
+      }
+
+      const params = new URLSearchParams();
+      if (query?.startWeek !== undefined)
+        params.set("startWeek", query.startWeek.toString());
+      if (query?.endWeek !== undefined)
+        params.set("endWeek", query.endWeek.toString());
+      if (query?.paymentCurrency)
+        params.set("paymentCurrency", query.paymentCurrency);
+      if (query?.limit !== undefined)
+        params.set("limit", query.limit.toString());
+
+      const queryString = params.toString();
+      const path = `/farms/${encodeURIComponent(farmId)}/weekly-rewards${
+        queryString ? `?${queryString}` : ""
+      }`;
+
+      return await request<FarmWeeklyRewardsResponse>(path);
+    } catch (error) {
+      throw new Error(parseApiError(error));
+    }
+  };
+
   const estimateRewardScore = async (
     params: EstimateRewardScoreParams
   ): Promise<RewardScoreResponse> => {
@@ -236,6 +268,7 @@ export function FarmsRouter(baseUrl: string) {
     fetchFarmRewardSplits,
     fetchSponsoredFarms,
     fetchWalletFarmsWithRewards,
+    fetchFarmWeeklyRewards,
     estimateRewardScore,
     estimateRewardScoresBatch,
     calculateMiningScoresBatch,

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

@@ -12,6 +12,8 @@ import type {
   RecentRegionActivityResponse,
   InstallerApplicationPayload,
   InstallerApplicationResponse,
+  RegionWeeklyRewardsResponse,
+  RegionWeeklyRewardsQuery,
 } from "../types";
 
 // ---------------------------------------------------------------------------
@@ -145,6 +147,32 @@ export function RegionRouter(baseUrl: string) {
       }
     };
 
+  const fetchRegionWeeklyRewards = async (
+    regionId: number,
+    query?: RegionWeeklyRewardsQuery
+  ): Promise<RegionWeeklyRewardsResponse> => {
+    try {
+      const params = new URLSearchParams();
+      if (query?.startWeek !== undefined)
+        params.set("startWeek", query.startWeek.toString());
+      if (query?.endWeek !== undefined)
+        params.set("endWeek", query.endWeek.toString());
+      if (query?.paymentCurrency)
+        params.set("paymentCurrency", query.paymentCurrency);
+      if (query?.limit !== undefined)
+        params.set("limit", query.limit.toString());
+
+      const queryString = params.toString();
+      const path = `/regions/weekly-rewards/${regionId}${
+        queryString ? `?${queryString}` : ""
+      }`;
+
+      return await request<RegionWeeklyRewardsResponse>(path);
+    } catch (error) {
+      throw new Error(parseApiError(error));
+    }
+  };
+
   const applyInstallerCertification = async (
     payload: InstallerApplicationPayload
   ): Promise<InstallerApplicationResponse> => {
@@ -218,6 +246,7 @@ export function RegionRouter(baseUrl: string) {
     fetchRegionSolarFarms,
     fetchActiveSummary,
     fetchRecentActivity,
+    fetchRegionWeeklyRewards,
     getRegionByCode,
     applyInstallerCertification,
 

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

@@ -1,7 +1,14 @@
 "use strict";
 
-import type { ControlWallet, WalletsResponse, WalletDetails } from "../types";
-import type { MintedEvent, StakedEvent } from "../types";
+import type {
+  ControlWallet,
+  WalletsResponse,
+  WalletDetails,
+  MintedEvent,
+  StakedEvent,
+  WalletWeeklyRewardsResponse,
+  WeeklyRewardsQuery,
+} from "../types";
 
 function parseApiError(error: unknown): string {
   if (!error) return "Unknown error";
@@ -85,10 +92,37 @@ export function WalletsRouter(baseUrl: string) {
     }
   };
 
+  const fetchWalletWeeklyRewards = async (
+    wallet: string,
+    query?: WeeklyRewardsQuery
+  ): Promise<WalletWeeklyRewardsResponse> => {
+    try {
+      const params = new URLSearchParams();
+      if (query?.startWeek !== undefined)
+        params.set("startWeek", query.startWeek.toString());
+      if (query?.endWeek !== undefined)
+        params.set("endWeek", query.endWeek.toString());
+      if (query?.paymentCurrency)
+        params.set("paymentCurrency", query.paymentCurrency);
+      if (query?.limit !== undefined)
+        params.set("limit", query.limit.toString());
+
+      const queryString = params.toString();
+      const path = `/wallets/address/${encodeURIComponent(wallet)}/weekly-rewards${
+        queryString ? `?${queryString}` : ""
+      }`;
+
+      return await request<WalletWeeklyRewardsResponse>(path);
+    } catch (error) {
+      throw new Error(parseApiError(error));
+    }
+  };
+
   return {
     fetchAllWallets,
     fetchWalletByAddress,
     fetchWalletMintedEvents,
     fetchWalletStakeEvents,
+    fetchWalletWeeklyRewards,
   } as const;
 }

package/src/lib/types/index.ts

@@ -573,7 +573,9 @@ export interface WalletFarmInfo {
   protocolDepositPaidCurrency: string;
 
   builtEpoch: number;
-  builtAt: string; // ISO 8601
+  builtAt?: string; // ISO 8601
+  glowSplitPercent6Decimals: string; // Wallet's GLW reward split (6 decimals)
+  depositSplitPercent6Decimals: string; // Wallet's deposit reward split (6 decimals)
 }
 
 export interface WalletDetails {
@@ -586,6 +588,94 @@ export interface WalletDetails {
   ownedFarms: WalletFarmInfo[];
 }
 
+export interface WeeklyReward {
+  weekNumber: number;
+  paymentCurrency: PaymentCurrency;
+  protocolDepositRewardsReceived: string; // Protocol deposit rewards received by wallet
+  glowInflationTotal: string; // GLW inflation rewards (18 decimals)
+}
+
+export interface WeeklyRewardsSummary {
+  totalProtocolDepositRewardsReceived: string;
+  totalGlowInflation: string;
+  weeksActive: number;
+}
+
+export interface WalletWeeklyRewardsResponse {
+  wallet: string;
+  summary: WeeklyRewardsSummary;
+  rewards: WeeklyReward[];
+}
+
+export interface WeeklyRewardsQuery {
+  startWeek?: number; // Inclusive lower bound epoch/week
+  endWeek?: number; // Inclusive upper bound epoch/week
+  paymentCurrency?: PaymentCurrency; // Filter by payment currency
+  limit?: number; // Max rows to return (default 52, capped at 520)
+}
+
+// ----------------------------- Farm Weekly Rewards ---------------------------
+export interface FarmWeeklyReward {
+  weekNumber: number;
+  paymentCurrency: PaymentCurrency;
+  protocolDepositPaidTotal: string; // Total amount farm paid as protocol deposit
+  glowInflationTotal: string; // Total GLW inflation rewards allocated to farm (18 decimals)
+  expectedProductionTotal: string; // Farm's weekly carbon credit production in WAD (18 decimals)
+  protocolDepositRewardsDistributed: string; // Portion of protocol deposits distributed to wallets
+}
+
+export interface FarmWeeklyRewardsSummary {
+  totalProtocolDepositPaid: string;
+  totalGlowInflation: string;
+  totalExpectedProduction: string;
+  weeksActive: number;
+}
+
+export interface FarmWeeklyRewardsResponse {
+  farmId: string;
+  summary: FarmWeeklyRewardsSummary;
+  rewards: FarmWeeklyReward[];
+}
+
+export interface FarmWeeklyRewardsQuery {
+  startWeek?: number; // Inclusive lower bound epoch/week
+  endWeek?: number; // Inclusive upper bound epoch/week
+  paymentCurrency?: PaymentCurrency; // Filter by payment currency
+  limit?: number; // Max rows to return (default 52, capped at 520)
+}
+
+// ----------------------------- Region Weekly Rewards -------------------------
+export interface RegionWeeklyReward {
+  weekNumber: number;
+  paymentCurrency: PaymentCurrency;
+  protocolDepositPaidTotal: string; // Total amount paid by all farms in region as protocol deposit
+  glowInflationTotal: string; // Total GLW inflation rewards allocated to region (18 decimals)
+  expectedProductionTotal: string; // Region's total weekly carbon credit production in WAD (18 decimals)
+  protocolDepositRewardsDistributed: string; // Always "0" for regions (tracked at farm level)
+  createdAt?: string; // ISO 8601
+  updatedAt?: string; // ISO 8601
+}
+
+export interface RegionWeeklyRewardsSummary {
+  totalProtocolDepositPaid: string;
+  totalGlowInflation: string;
+  totalExpectedProduction: string;
+  weeksActive: number;
+}
+
+export interface RegionWeeklyRewardsResponse {
+  regionId: number;
+  summary: RegionWeeklyRewardsSummary;
+  rewards: RegionWeeklyReward[];
+}
+
+export interface RegionWeeklyRewardsQuery {
+  startWeek?: number; // Inclusive lower bound epoch/week
+  endWeek?: number; // Inclusive upper bound epoch/week
+  paymentCurrency?: PaymentCurrency; // Filter by payment currency
+  limit?: number; // Max rows to return (default 52, capped at 520)
+}
+
 // ----------------------------- Farms Reward Score ---------------------------
 export interface EstimateRewardScoreParams {
   userId: string;