@glowlabs-org/utils 0.2.149 → 0.2.151

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-C2Pkoecj.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-C2Pkoecj.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-Cpy_o4_u.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-Cpy_o4_u.js';
 
 const GENESIS_TIMESTAMP = 1700352000;
 

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

@@ -1,4 +1,4 @@
-import type { StakeRequest, RegionStake, WalletRegionStake, WalletRegionUnlocked, WalletRegionCommittedBalance, TransferDetails, GlwRegionRewardsResponse, MintedEventsResponse, StakeEventsResponse, FailedOperationsResponse, PendingTransfersResponse, PendingTransferType, RestakeRequest, MigrationAmountResponse } from "../types";
+import type { StakeRequest, RegionStake, WalletRegionStake, WalletRegionUnlocked, WalletRegionCommittedBalance, TransferDetails, GlwRegionRewardsResponse, MintedEventsResponse, StakeEventsResponse, FailedOperationsResponse, PendingTransfersResponse, PendingTransferType, RestakeRequest, MigrationAmountResponse, RetryFailedOperationResponse, FarmRewardSplit } from "../types";
 export interface PayProtocolDepositUsingStakedControlRequest {
     wallet: string;
     regionId: number;
@@ -28,6 +28,7 @@ export declare function ControlRouter(baseUrl: string): {
     readonly fetchGctlPrice: () => Promise<string>;
     readonly fetchGlwPrice: () => Promise<string>;
     readonly fetchCirculatingSupply: () => Promise<string>;
+    readonly fetchHoldersCount: () => Promise<number>;
     readonly fetchLastNonce: (wallet: string) => Promise<string>;
     readonly fetchMintedEvents: (page?: number, limit?: number) => Promise<MintedEventsResponse>;
     readonly fetchStakeEvents: (page?: number, limit?: number, regionId?: number) => Promise<StakeEventsResponse>;
@@ -39,11 +40,12 @@ export declare function ControlRouter(baseUrl: string): {
     readonly fetchWalletRegionCommittedBalance: (wallet: string, regionId: number) => Promise<WalletRegionCommittedBalance>;
     readonly fetchTransferDetails: (txId: string) => Promise<TransferDetails>;
     readonly fetchGlwRegionRewards: () => Promise<GlwRegionRewardsResponse>;
+    readonly fetchFarmRewardSplits: (farmId: string) => Promise<FarmRewardSplit[]>;
     readonly fetchMigrationAmount: (wallet: string) => Promise<MigrationAmountResponse>;
     readonly stakeGctl: (stakeRequest: StakeRequest) => Promise<boolean>;
     readonly unstakeGctl: (unstakeRequest: StakeRequest) => Promise<boolean>;
     readonly restakeGctl: (restakeRequest: RestakeRequest) => Promise<boolean>;
-    readonly retryFailedOperation: (operationId: string) => Promise<boolean>;
+    readonly retryFailedOperation: (operationId: string) => Promise<RetryFailedOperationResponse>;
     readonly payProtocolDepositUsingStakedControl: (paymentRequest: PayProtocolDepositUsingStakedControlRequest) => Promise<PayProtocolDepositUsingStakedControlResponse>;
     readonly migrateUser: (migrateRequest: MigrateUserRequest) => Promise<MigrateUserResponse>;
     readonly isStaking: boolean;

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

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

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

@@ -262,6 +262,9 @@ export interface ActivationEvent {
     id: string;
     regionId: number;
     epoch: number;
+    stakeThresholdMet: boolean;
+    solarFarmRequirementMet: boolean;
+    installerRequirementMet: boolean;
     activated: boolean;
     ts: string;
 }
@@ -308,6 +311,46 @@ export interface RegionDetails extends RegionWithMetadata {
     carbonCreditsIssued: number;
     carbonCreditsPerWeek: number;
 }
+export interface ActiveRegionSnapshot {
+    epoch: number;
+    totals: {
+        gctlStaked: string;
+        pendingUnstake: string;
+        pendingRestakeOut: string;
+        pendingRestakeIn: string;
+    };
+}
+export interface ActiveRegionSummary {
+    id: number;
+    name: string;
+    code: string;
+    slug: string;
+    isUs: boolean;
+    gctlStaked: string;
+    glwRewardPerWeek: string;
+    rewardShare: string;
+    pendingUnstake: string;
+    pendingRestakeOut: string;
+    pendingRestakeIn: string;
+    snapshots: ActiveRegionSnapshot[];
+}
+export interface ActiveRegionsSummaryResponse {
+    total: {
+        totalGctlStaked: string;
+        totalGlwRewards: string;
+    };
+    regions: ActiveRegionSummary[];
+}
+export interface InstallerApplicationPayload {
+    wallet: string;
+    signature: string;
+    nonce: string;
+    regionId: string;
+    deadline: string;
+}
+export interface InstallerApplicationResponse {
+    certified: boolean;
+}
 export interface RegionsResponse {
     regions: RegionWithMetadata[];
 }
@@ -530,4 +573,11 @@ export interface FarmRewardSplitsResponse {
 export interface FarmRewardSplitsErrorResponse {
     error: string;
 }
+export interface HoldersCountResponse {
+    holders: number;
+}
+export interface RetryFailedOperationResponse {
+    success?: boolean;
+    queued?: boolean;
+}
 export type { MintedEvent as ControlMintedEvent };

package/package.json

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

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

@@ -19,7 +19,20 @@ import type {
   PendingTransferType,
   RestakeRequest,
   MigrationAmountResponse,
+  HoldersCountResponse,
+  RetryFailedOperationResponse,
+  FarmRewardSplitsResponse,
+  FarmRewardSplitsErrorResponse,
+  FarmRewardSplit,
 } from "../types";
+
+interface FetchGctlBalanceResponse {
+  gctl_balance: string;
+}
+
+interface FetchCommittedBalanceResponse {
+  gctl_committed_balance: string;
+}
 import {
   sentryAddBreadcrumb,
   sentryCaptureException,
@@ -69,6 +82,9 @@ function parseApiError(error: unknown): string {
 // --------------------------------------------------------------------------
 
 export function ControlRouter(baseUrl: string) {
+  if (!baseUrl) {
+    throw new Error("CONTROL API base URL is not set");
+  }
   // ----------------------- Internal helpers --------------------------------
   const request = async <T>(path: string, init?: RequestInit): Promise<T> => {
     const res = await fetch(`${baseUrl}${path}`, init);
@@ -82,7 +98,7 @@ export function ControlRouter(baseUrl: string) {
   // ----------------------- GETters -----------------------------------------
   const fetchGctlBalance = async (wallet: string): Promise<string> => {
     try {
-      const data = await request<{ gctl_balance: string }>(
+      const data = await request<FetchGctlBalanceResponse>(
         `/balance/${wallet}`
       );
       return (data?.gctl_balance ?? "0").toString();
@@ -93,7 +109,7 @@ export function ControlRouter(baseUrl: string) {
 
   const fetchCommittedBalance = async (wallet: string): Promise<string> => {
     try {
-      const data = await request<{ gctl_committed_balance: string }>(
+      const data = await request<FetchCommittedBalanceResponse>(
         `/committed-balance/${wallet}`
       );
       return (data?.gctl_committed_balance ?? "0").toString();
@@ -138,6 +154,15 @@ export function ControlRouter(baseUrl: string) {
     }
   };
 
+  const fetchHoldersCount = async (): Promise<number> => {
+    try {
+      const data = await request<HoldersCountResponse>(`/holders/count`);
+      return data.holders;
+    } catch (error) {
+      throw new Error(parseApiError(error));
+    }
+  };
+
   // Build pagination query helper
   const buildPaginationQuery = (page?: number, limit?: number) => {
     const p = page ?? 1;
@@ -225,6 +250,21 @@ export function ControlRouter(baseUrl: string) {
     }
   };
 
+  const fetchFarmRewardSplits = async (
+    farmId: string
+  ): Promise<FarmRewardSplit[]> => {
+    try {
+      if (!farmId) throw new Error("Farm ID is required");
+      const data = await request<
+        FarmRewardSplitsResponse | FarmRewardSplitsErrorResponse
+      >(`/farms/${encodeURIComponent(farmId)}/reward-splits`);
+      if ("error" in data) throw new Error(data.error);
+      return data.rewardSplits ?? [];
+    } catch (error) {
+      throw new Error(parseApiError(error));
+    }
+  };
+
   // Exposed query with error parsing
   const getTransferDetails = async (txId: string): Promise<TransferDetails> => {
     try {
@@ -399,7 +439,7 @@ export function ControlRouter(baseUrl: string) {
 
   const retryFailedOperation = async (
     operationId: string
-  ): Promise<boolean> => {
+  ): Promise<RetryFailedOperationResponse> => {
     isRetryingFailedOperation = true;
     try {
       sentryAddBreadcrumb({
@@ -408,11 +448,14 @@ export function ControlRouter(baseUrl: string) {
         level: "info",
         data: { baseUrl, operationId },
       });
-      await request(`/operations/failed/${operationId}/retry`, {
-        method: "POST",
-        headers: { "Content-Type": "application/json" },
-      });
-      return true;
+      const response = await request<RetryFailedOperationResponse>(
+        `/operations/failed/${operationId}/retry`,
+        {
+          method: "POST",
+          headers: { "Content-Type": "application/json" },
+        }
+      );
+      return response;
     } catch (error) {
       sentryCaptureException(error, {
         action: "retryFailedOperation",
@@ -520,6 +563,7 @@ export function ControlRouter(baseUrl: string) {
     fetchGctlPrice,
     fetchGlwPrice,
     fetchCirculatingSupply,
+    fetchHoldersCount,
     fetchLastNonce,
     fetchMintedEvents,
     fetchStakeEvents,
@@ -531,6 +575,7 @@ export function ControlRouter(baseUrl: string) {
     fetchWalletRegionCommittedBalance,
     fetchTransferDetails: getTransferDetails,
     fetchGlwRegionRewards,
+    fetchFarmRewardSplits,
     fetchMigrationAmount,
 
     // Mutations

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

@@ -1,5 +1,58 @@
 "use strict";
 
+/**
+ * # Regions Router
+ *
+ * This router wraps the Control API endpoints that power Kickstarter-style
+ * activation across geographic regions. It surfaces read APIs for activation
+ * progress plus the installer certification mutation.
+ *
+ * ## Components
+ * - **router.ts**: exports the `RegionRouter` factory with helpers for each
+ *   endpoint:
+ *   - `GET /regions/all` – list regions with activation progress (stake, farms,
+ *     installers). Accepts optional `?isActive=true|false` filter.
+ *   - `GET /regions/:idOrSlug` – return region VCR view.
+ *   - `GET /regions/active/summary` – aggregate GLW/week distribution, pending
+ *     restakes, and recent epoch snapshots for active regions.
+ *   - `GET /regions/solar-farms/:regionId` – list sponsored farms for a region.
+ *   - `POST /regions/installers/apply` – certify an installer via signature.
+ *   - `GET /regions/activation-events` – activation-event timeline, optional
+ *     `regionId` filter.
+ *   - `GET /regions/activation-config` – static activation thresholds and
+ *     campaign duration for a region code.
+ * - **getters.ts**: shared data aggregation utilities used by the router
+ *   implementation.
+ * - **db/schema.ts**: Drizzle schema for `regions`, `region_kickstarters`,
+ *   `solar_farms`, `certified_installers`, and `region_activation_events`.
+ * - **constants**: activation thresholds imported from `@src/constants`:
+ *   ```ts
+ *   import {
+ *     MIN_FARMS,
+ *     US_STAKE_THRESHOLD,
+ *     NON_US_STAKE_THRESHOLD,
+ *     CAMPAIGN_DURATION_DAYS,
+ *     MIN_INSTALLERS,
+ *     US_STAKED_TRESHOLD_BIGINT,
+ *     NON_US_STAKED_TRESHOLD_BIGINT,
+ *   } from "@src/constants";
+ *   ```
+ * - Region metadata: `regionMetadata` from `@glowlabs-org/utils/browser` feeds
+ *   `/activation-config` responses.
+ * - Kickstarter endpoints live in `KickstarterRouter`.
+ *
+ * ## Activation Criteria
+ * A region activates when it satisfies all of:
+ * 1. Stake threshold met (≥ 20 000 GCTL for US, ≥ 200 000 GCTL otherwise).
+ * 2. At least 10 solar farms registered.
+ * 3. At least 1 certified installer.
+ *
+ * ## API Responses
+ * All numeric stake values are returned as strings (atomic units) to avoid
+ * precision loss. Dates are ISO 8601 strings. The router exposes typed helpers
+ * for the full dataset described above.
+ */
+
 import { generateSlug } from "src/utils/generate-slug";
 import { regionMetadata } from "../region-metadata";
 import type {
@@ -8,6 +61,9 @@ import type {
   ActivationEvent,
   RegionDetails,
   SponsoredFarm,
+  ActiveRegionsSummaryResponse,
+  InstallerApplicationPayload,
+  InstallerApplicationResponse,
 } from "../types";
 
 // ---------------------------------------------------------------------------
@@ -119,6 +175,34 @@ export function RegionRouter(baseUrl: string) {
     }
   };
 
+  const fetchActiveSummary =
+    async (): Promise<ActiveRegionsSummaryResponse> => {
+      try {
+        return await request<ActiveRegionsSummaryResponse>(
+          `/regions/active/summary`
+        );
+      } catch (error) {
+        throw new Error(parseApiError(error));
+      }
+    };
+
+  const applyInstallerCertification = async (
+    payload: InstallerApplicationPayload
+  ): Promise<InstallerApplicationResponse> => {
+    try {
+      return await request<InstallerApplicationResponse>(
+        `/regions/installers/apply`,
+        {
+          method: "POST",
+          headers: { "Content-Type": "application/json" },
+          body: JSON.stringify(payload),
+        }
+      );
+    } catch (error) {
+      throw new Error(parseApiError(error));
+    }
+  };
+
   // Kickstarter-related logic moved to kickstarter-router.ts
 
   // -------------------------------------------------------------------------
@@ -173,7 +257,9 @@ export function RegionRouter(baseUrl: string) {
     fetchActivationEvents,
     fetchRegionByIdOrSlug,
     fetchRegionSolarFarms,
+    fetchActiveSummary,
     getRegionByCode,
+    applyInstallerCertification,
 
     // Cached data & flags
     get regions() {

package/src/lib/types/index.ts

@@ -321,6 +321,9 @@ export interface ActivationEvent {
   id: string;
   regionId: number;
   epoch: number;
+  stakeThresholdMet: boolean;
+  solarFarmRequirementMet: boolean;
+  installerRequirementMet: boolean;
   activated: boolean;
   ts: string; // ISO 8601
 }
@@ -374,6 +377,51 @@ export interface RegionDetails extends RegionWithMetadata {
   carbonCreditsPerWeek: number;
 }
 
+export interface ActiveRegionSnapshot {
+  epoch: number;
+  totals: {
+    gctlStaked: string;
+    pendingUnstake: string;
+    pendingRestakeOut: string;
+    pendingRestakeIn: string;
+  };
+}
+
+export interface ActiveRegionSummary {
+  id: number;
+  name: string;
+  code: string;
+  slug: string;
+  isUs: boolean;
+  gctlStaked: string;
+  glwRewardPerWeek: string;
+  rewardShare: string;
+  pendingUnstake: string;
+  pendingRestakeOut: string;
+  pendingRestakeIn: string;
+  snapshots: ActiveRegionSnapshot[];
+}
+
+export interface ActiveRegionsSummaryResponse {
+  total: {
+    totalGctlStaked: string;
+    totalGlwRewards: string;
+  };
+  regions: ActiveRegionSummary[];
+}
+
+export interface InstallerApplicationPayload {
+  wallet: string;
+  signature: string;
+  nonce: string;
+  regionId: string;
+  deadline: string;
+}
+
+export interface InstallerApplicationResponse {
+  certified: boolean;
+}
+
 // ----------------------------- API Responses --------------------------------
 export interface RegionsResponse {
   regions: RegionWithMetadata[];
@@ -651,6 +699,15 @@ export interface FarmRewardSplitsErrorResponse {
   error: string;
 }
 
+export interface HoldersCountResponse {
+  holders: number;
+}
+
+export interface RetryFailedOperationResponse {
+  success?: boolean;
+  queued?: boolean;
+}
+
 // ---------------------------------------------------------------------------
 // Barrel exports (convenience)
 // ---------------------------------------------------------------------------