@glowlabs-org/utils 0.2.3 → 0.2.4

package/src/lib/types/index.ts

@@ -0,0 +1,153 @@
+// ---------------------------------------------------------------------------
+// Common / Shared Types
+// ---------------------------------------------------------------------------
+
+// ----------------------------- Control-API ----------------------------------
+export interface MintedEvent {
+  txId: string;
+  epoch: number;
+  wallet: string;
+  amountRaw: string;
+  currency: string;
+  gctlMinted: string;
+  ts: string; // ISO date string
+}
+
+export interface StakedEvent {
+  id: string;
+  epoch: number;
+  wallet: string;
+  regionId: number;
+  amount: string;
+  direction: "stake" | "unstake";
+  ts: string; // ISO date string
+}
+
+export interface PendingTransfer {
+  txId: string;
+  wallet: string;
+  amountRaw: string;
+  type: string;
+  currency: string;
+  status: string;
+  ts: string; // ISO date string
+  applicationId?: string;
+  farmId?: string;
+  regionId?: number;
+}
+
+export interface TransferDetails extends PendingTransfer {
+  blockNumber: string;
+  failureInfo?: {
+    failureType: string;
+    errorMessage: string;
+    errorDetails?: string;
+    isRetryable: boolean;
+    retryCount: number;
+    lastRetryAt?: string; // ISO date string
+  };
+}
+
+export interface FailedOperation {
+  id: string;
+  txId: string;
+  operation: string;
+  failureType: string;
+  errorMessage: string;
+  errorDetails?: string;
+  isRetryable: string;
+  retryCount: number;
+  lastRetryAt?: string; // ISO date string
+  resolvedAt?: string; // ISO date string
+  wallet?: string;
+  amountRaw?: string;
+  currency?: string;
+  createdAt: string; // ISO date string
+  updatedAt: string; // ISO date string
+}
+
+export interface GctlPrice {
+  currentPriceUsdc: number;
+}
+
+export interface StakeRequest {
+  wallet: string;
+  regionId: number;
+  amount: string; // Amount in atomic units (10^6 = 1 GCTL)
+}
+
+export interface RegionStake {
+  regionId: number;
+  currentGctlStake: string;
+}
+
+export interface WalletRegionStake {
+  wallet: string;
+  regionId: number;
+  currentGctlStake: string;
+}
+
+export interface WalletRegionUnlocked {
+  wallet: string;
+  regionId: number;
+  unlocked: string;
+}
+
+// ----------------------------- Regions --------------------------------------
+// A superset of fields coming from both control-api regions and regions-service.
+export interface Region {
+  id: number;
+  name: string;
+
+  // Optional metadata
+  flag?: string;
+  isUs?: boolean;
+
+  // Activation / status
+  isActive: boolean;
+
+  // Stake / GCTL info
+  currentGctlStake?: string; // value from control-api
+  stake?: string; // aggregated current stake
+  stakeProgress?: number;
+
+  // Solar farm info
+  solarFarmCount: number;
+  solarFarmProgress?: number;
+
+  // Installer info
+  installerCount?: number;
+  installerProgress?: number;
+}
+
+export interface RegionWithMetadata extends Region {
+  code: string;
+  description?: string;
+}
+
+export interface ActivationConfig {
+  duration: number; // number of days
+  minimumAmountOfGCTL: number;
+  minimumAmountOfFarms: number;
+  minimumAmountOfInstallers: number;
+}
+
+export interface CreateRegionPayload {
+  code: string;
+  name: string;
+  isUs: boolean;
+}
+
+// ----------------------------- Region Metadata -----------------------------
+export interface RegionMetadata {
+  code: string;
+  name: string;
+  description: string;
+  isUs: boolean;
+  flag?: string;
+}
+
+// ---------------------------------------------------------------------------
+// Barrel exports (convenience)
+// ---------------------------------------------------------------------------
+export type { MintedEvent as ControlMintedEvent };