@glowlabs-org/utils 0.2.156 → 0.2.158

package/dist/cjs/{farms-router-DekpTBQj.js → calculate-farm-efficiency-CLa5037R.js}

@@ -2,6 +2,7 @@
 
 var ethers = require('ethers');
 var viem = require('viem');
+var Decimal = require('decimal.js');
 
 const HUB_URL = "https://glow.org";
 const GCA_URLS = ["http://95.217.194.59:35015"];
@@ -4998,6 +4999,19 @@ function FarmsRouter(baseUrl) {
             throw new Error(parseApiError(error));
         }
     };
+    const fetchEfficiencyScores = async (farmId) => {
+        try {
+            const query = farmId ? `?farmId=${encodeURIComponent(farmId)}` : "";
+            const data = await request(`/farms/efficiency-scores${query}`);
+            if ("error" in data) {
+                throw new Error(data.error);
+            }
+            return data;
+        }
+        catch (error) {
+            throw new Error(parseApiError(error));
+        }
+    };
     return {
         fetchFarmRewardSplits,
         fetchSponsoredFarms,
@@ -5006,9 +5020,51 @@ function FarmsRouter(baseUrl) {
         estimateRewardScore,
         estimateRewardScoresBatch,
         calculateMiningScoresBatch,
+        fetchEfficiencyScores,
     };
 }
 
+/**
+ * Calculates the efficiency score for a farm
+ *
+ * Formula: efficiencyScore = (CC / PD) / 100,000
+ *
+ * Where:
+ * - CC = weekly carbon credits in WAD format (18 decimals)
+ * - PD = protocol deposit in USD (6 decimals)
+ *
+ * Due to the decimal difference (CC has 18 decimals, PD has 6 decimals),
+ * the actual calculation maintains a 10^12 factor, resulting in:
+ * efficiencyScore = (CC_actual / PD_actual) × 10^8
+ *
+ * The efficiency score represents carbon credits produced per $100,000 of
+ * protocol deposit per week. Higher scores indicate more efficient farms.
+ *
+ * @param protocolDepositUsd6 - Protocol deposit in USD (6 decimals)
+ * @param weeklyImpactAssetsWad - Weekly carbon credits in WAD format (18 decimals)
+ * @returns The efficiency score as a number
+ *
+ * @example
+ * ```typescript
+ * const score = calculateFarmEfficiency(5000000000n, 1500000000000000000n);
+ * // Returns the efficiency score
+ * ```
+ */
+function calculateFarmEfficiency(protocolDepositUsd6, weeklyImpactAssetsWad) {
+    // Handle zero carbon credits case
+    if (weeklyImpactAssetsWad === 0n) {
+        return 0;
+    }
+    // Convert to Decimal for precise calculation
+    const pdDecimal = new Decimal(protocolDepositUsd6.toString());
+    const ccDecimal = new Decimal(weeklyImpactAssetsWad.toString());
+    // Formula: efficiencyScore = (CC / PD) / 100,000
+    // CC is in 18 decimals, PD is in 6 decimals
+    // Direct division: (CC / PD) / 100,000
+    const efficiencyDecimal = ccDecimal.div(pdDecimal).div(100000);
+    return efficiencyDecimal.toNumber();
+}
+
 exports.ControlRouter = ControlRouter;
 exports.DECIMALS_BY_TOKEN = DECIMALS_BY_TOKEN;
 exports.FORWARDER_ABI = FORWARDER_ABI;
@@ -5027,6 +5083,7 @@ exports.TRANSFER_TYPES = TRANSFER_TYPES;
 exports.USDG_WEIGHT_DECIMAL_PRECISION = USDG_WEIGHT_DECIMAL_PRECISION;
 exports.WalletsRouter = WalletsRouter;
 exports.allRegions = allRegions;
+exports.calculateFarmEfficiency = calculateFarmEfficiency;
 exports.configureSentry = configureSentry;
 exports.countries = countries;
 exports.getAddresses = getAddresses;
@@ -5039,4 +5096,4 @@ exports.useOffchainFractions = useOffchainFractions;
 exports.useRewardsKernel = useRewardsKernel;
 exports.waitForEthersTransactionWithRetry = waitForEthersTransactionWithRetry;
 exports.waitForViemTransactionWithRetry = waitForViemTransactionWithRetry;
-//# sourceMappingURL=farms-router-DekpTBQj.js.map
+//# sourceMappingURL=calculate-farm-efficiency-CLa5037R.js.map