@glowlabs-org/utils 0.2.128 → 0.2.130

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-CXLLMwfG.js';
-export { C as ControlRouter, F as FarmsRouter, c 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, u as useForwarder, a as useOffchainFractions } from './farms-router-CXLLMwfG.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-DqPqj03h.js';
+export { C as ControlRouter, F as FarmsRouter, c 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, u as useForwarder, a as useOffchainFractions } from './farms-router-DqPqj03h.js';
 
 const GENESIS_TIMESTAMP = 1700352000;
 

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

@@ -23,12 +23,17 @@
  * ### 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.
+ *
+ * ### POST `/farms/mining-scores-batch`
+ * 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 } from "../types";
+import type { SponsoredFarm, EstimateRewardScoreParams, RewardScoreResponse, EstimateRewardScoresBatchParams, EstimateRewardScoresBatchResponse, FarmWithRewards, FarmRewardSplit, MiningScoresBatchParams, MiningScoresBatchResponse } 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 estimateRewardScore: (params: EstimateRewardScoreParams) => Promise<RewardScoreResponse>;
     readonly estimateRewardScoresBatch: (params: EstimateRewardScoresBatchParams) => Promise<EstimateRewardScoresBatchResponse>;
+    readonly calculateMiningScoresBatch: (params: MiningScoresBatchParams) => Promise<MiningScoresBatchResponse>;
 };

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

@@ -470,6 +470,49 @@ export type BatchRewardScoreResult = BatchRewardScoreSuccessResult | BatchReward
 export interface EstimateRewardScoresBatchResponse {
     results: BatchRewardScoreResult[];
 }
+export interface MiningScoreParams {
+    farmId: string;
+    userId: string;
+    dollarCostOfMiner: string;
+}
+export interface MiningScoresBatchParams {
+    farms: MiningScoreParams[];
+}
+export interface MiningScoreResponse {
+    miningScore: number;
+    userWeeklyGlwRewards: string;
+    glwPriceUsd6: string;
+    dollarCostOfMiner: string;
+    weeksOfMinerLifeRemaining: number;
+    regionInfo: {
+        regionId: number;
+        existingFarmCount: number;
+        existingTotalDepositsUsd: string;
+        currencyBreakdown: {
+            currency: string;
+            protocolDepositSum: string;
+            carbonCreditProductionSum: string;
+        }[];
+        regionGctlStaked: string;
+        totalGctlStakedAllRegions: string;
+    };
+}
+export interface BatchMiningScoreSuccessResult {
+    success: true;
+    data: MiningScoreResponse;
+}
+export interface BatchMiningScoreFailureResult {
+    success: false;
+    error: string;
+    farmData: {
+        farmId: string;
+        userId: string;
+    };
+}
+export type BatchMiningScoreResult = BatchMiningScoreSuccessResult | BatchMiningScoreFailureResult;
+export interface MiningScoresBatchResponse {
+    results: BatchMiningScoreResult[];
+}
 export interface UserWeeklyRewards {
     protocolDepositAsset: PaymentCurrency;
     protocolDepositRewards: string;

package/package.json

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

@@ -25,6 +25,10 @@
  * ### 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.
+ *
+ * ### POST `/farms/mining-scores-batch`
+ * 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 {
@@ -40,6 +44,8 @@ import type {
   FarmRewardSplitsResponse,
   FarmRewardSplitsErrorResponse,
   FarmRewardSplit,
+  MiningScoresBatchParams,
+  MiningScoresBatchResponse,
 } from "../types";
 
 function parseApiError(error: unknown): string {
@@ -166,11 +172,33 @@ export function FarmsRouter(baseUrl: string) {
     }
   };
 
+  const calculateMiningScoresBatch = async (
+    params: MiningScoresBatchParams
+  ): Promise<MiningScoresBatchResponse> => {
+    try {
+      const data = await request<MiningScoresBatchResponse>(
+        "/farms/mining-scores-batch",
+        {
+          method: "POST",
+          headers: {
+            "Content-Type": "application/json",
+          },
+          body: JSON.stringify(params),
+        }
+      );
+
+      return data;
+    } catch (error) {
+      throw new Error(parseApiError(error));
+    }
+  };
+
   return {
     fetchFarmRewardSplits,
     fetchSponsoredFarms,
     fetchWalletFarmsWithRewards,
     estimateRewardScore,
     estimateRewardScoresBatch,
+    calculateMiningScoresBatch,
   } as const;
 }

package/src/lib/types/index.ts

@@ -573,6 +573,59 @@ export interface EstimateRewardScoresBatchResponse {
   results: BatchRewardScoreResult[];
 }
 
+// ----------------------------- Farms Mining Score ----------------------------
+export interface MiningScoreParams {
+  farmId: string; // The farm ID of the existing farm
+  userId: string; // User's wallet address to calculate mining score for
+  dollarCostOfMiner: string; // Dollar cost of the miner (USD with 6 decimals)
+}
+
+export interface MiningScoresBatchParams {
+  farms: MiningScoreParams[];
+}
+
+export interface MiningScoreResponse {
+  miningScore: number; // Mining score (calculated using farm's total GLW rewards)
+  userWeeklyGlwRewards: string; // User's portion of weekly GLW rewards after split (18 decimals)
+  glwPriceUsd6: string; // GLW price used in calculation (6 decimals)
+  dollarCostOfMiner: string; // Dollar cost of miner (6 decimals)
+  weeksOfMinerLifeRemaining: number; // Weeks of miner life remaining (calculated from farm's end reward period)
+  regionInfo: {
+    regionId: number;
+    existingFarmCount: number;
+    existingTotalDepositsUsd: string;
+    currencyBreakdown: {
+      currency: string;
+      protocolDepositSum: string;
+      carbonCreditProductionSum: string;
+    }[];
+    regionGctlStaked: string;
+    totalGctlStakedAllRegions: string;
+  };
+}
+
+export interface BatchMiningScoreSuccessResult {
+  success: true;
+  data: MiningScoreResponse;
+}
+
+export interface BatchMiningScoreFailureResult {
+  success: false;
+  error: string;
+  farmData: {
+    farmId: string;
+    userId: string;
+  };
+}
+
+export type BatchMiningScoreResult =
+  | BatchMiningScoreSuccessResult
+  | BatchMiningScoreFailureResult;
+
+export interface MiningScoresBatchResponse {
+  results: BatchMiningScoreResult[];
+}
+
 // ----------------------------- Wallet Farm Rewards ---------------------------
 export interface UserWeeklyRewards {
   protocolDepositAsset: PaymentCurrency;