@glowlabs-org/utils 0.0.9 → 0.1.2

package/dist/esm/lib/create-weekly-report/index.d.ts

@@ -0,0 +1,73 @@
+import { FinalizedLeaf } from "./types/merkle";
+export type MerkleLeafIntermediary = {
+    wallet: string;
+    glowWeight: bigint;
+    usdgWeight: bigint;
+};
+export type FinalLeaf = {
+    wallet: string;
+    glowWeight: string;
+    usdgWeight: string;
+};
+export type CreateWeeklyReportArgs = {
+    week: number;
+    gcaUrls: string[];
+    apiUrl: string;
+};
+export declare function createWeeklyReport({ week, gcaUrls, apiUrl, }: CreateWeeklyReportArgs): Promise<{
+    headlineStats: {
+        weekNumber: number;
+        totalCreditsProduced: string;
+        totalCreditsProducedBN: string;
+        totalGlowWeightInFinalized: string;
+        totalGlowWeightHuman: string;
+        totalUSDGWeightInFinalized: string;
+        totalUSDGWeightHuman: string;
+        root: string;
+        glowWeightDecimals: number;
+        usdgWeightDecimals: number;
+    };
+    finalLeaves: FinalLeaf[];
+    farmsWithMerkleProofs: {
+        proof: string[];
+        wallet: string;
+        glowWeight: string;
+        usdgWeight: string;
+    }[];
+    farms: import("./types").Farm[];
+    rawData: import("./types").GCAServerResponse;
+} | {
+    headlineStats: {
+        weekNumber: number;
+        totalCreditsProduced: string;
+        totalCreditsProducedBN: string;
+        totalGlowWeightInFinalized: string;
+        totalGlowWeightHuman: string;
+        totalUSDGWeightInFinalized: string;
+        totalUSDGWeightHuman: string;
+        root: string;
+        glowWeightDecimals: number;
+        usdgWeightDecimals: number;
+    };
+    finalizedLeaves: FinalizedLeaf[];
+    leavesWithProofs: {
+        proof: string[];
+        wallet: string;
+        glowWeight: string;
+        usdgWeight: string;
+    }[];
+    farms: import("./types").Farm[];
+    rawData: import("./types").GCAServerResponse;
+    shortIdAdjustedList: {
+        shortId: string;
+        adjustedCredit: string;
+    }[];
+    creditsDeviationList: {
+        shortId: string;
+        carbonCreditsProduced: number;
+        adjustedWeeklyCarbonCredit: number;
+        deviation: number;
+        absDeviation: number;
+        deviationPercent: number;
+    }[];
+}>;

package/dist/esm/lib/create-weekly-report/types/Audit.d.ts

@@ -0,0 +1,40 @@
+export interface AuditSummary {
+    address: {
+        location: string;
+        coordinates: string;
+    };
+    solarPanels: {
+        quantity: number;
+        brandAndModel: string;
+        warranty: string;
+    };
+    installationAndOperations: {
+        installationDate: string;
+        ptoDate: string;
+        electricityPrice: string;
+    };
+    carbonFootprintAndProduction: {
+        averageSunlightPerDay: string;
+        adjustedWeeklyCarbonCredit: string;
+        weeklyTotalCarbonDebt: string;
+        netCarbonCreditEarningWeekly: string;
+        protocolFees: string;
+        systemWattageOutput: string;
+    };
+}
+export interface Audit {
+    orderIndex: number;
+    id: string;
+    farmName: string;
+    image: string;
+    auditDate: string;
+    auditorName: string;
+    auditorDesc: string;
+    auditorImage: string;
+    previousShortIds: number[];
+    activeShortIds: number[];
+    auditDocuments: unknown[];
+    preInstallPictures: unknown[];
+    afterInstallPictures: unknown[];
+    summary: AuditSummary;
+}

package/dist/esm/lib/create-weekly-report/types/RewardSplit copy.d.ts

@@ -0,0 +1,5 @@
+export interface RewardSplit {
+    walletAddress: string;
+    glowSplitPercent: number;
+    usdgSplitPercent: number;
+}

package/dist/esm/lib/create-weekly-report/types/RewardSplit.d.ts

@@ -0,0 +1,5 @@
+export interface RewardSplit {
+    walletAddress: string;
+    glowSplitPercent: number;
+    usdgSplitPercent: number;
+}

package/dist/esm/lib/create-weekly-report/types/RewardSplits copy.d.ts

@@ -0,0 +1,2 @@
+import type { RewardSplit } from "./RewardSplit";
+export type RewardSplits = Array<RewardSplit>;

package/dist/esm/lib/create-weekly-report/types/RewardSplits.d.ts

@@ -0,0 +1,2 @@
+import type { RewardSplit } from "./RewardSplit";
+export type RewardSplits = Array<RewardSplit>;

package/dist/esm/lib/create-weekly-report/types/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./Audit";
+export * from "./Farm";
+export * from "./GCAServerResponse";
+export * from "./merkle";
+export * from "./RewardSplits";
+export * from "./SlotRange";
+export * from "./FarmStatus";

package/dist/esm/lib/create-weekly-report/types/merkle.d.ts

@@ -0,0 +1,10 @@
+export interface MerkleLeaf {
+    wallet: string;
+    glowWeight: bigint;
+    usdgWeight: bigint;
+}
+export interface FinalizedLeaf {
+    wallet: string;
+    glowWeight: string;
+    usdgWeight: string;
+}

package/dist/esm/lib/create-weekly-report/utils/accumulate-leaf-weights.d.ts

@@ -0,0 +1,2 @@
+import { MerkleLeaf } from "../types/merkle";
+export declare function accumulateLeafWeights(key: string, value: MerkleLeaf, map: Map<string, MerkleLeaf>): void;

package/dist/esm/lib/create-weekly-report/utils/custom-to-fixed.d.ts

@@ -0,0 +1 @@
+export declare function customToFixed(num: number, precision: number): string;

package/dist/esm/lib/create-weekly-report/utils/fetch-farms-for-week.d.ts

@@ -0,0 +1,12 @@
+import { GCAServerResponse } from "../types/GCAServerResponse";
+import { Farm } from "../types/Farm";
+export interface ApiResponse {
+    filteredFarms: Farm[];
+    rawData: GCAServerResponse;
+    multiplier: number;
+}
+/**
+ * Fetches farm data for a given protocol week from the GCA API.
+ * @param weekNumber - The protocol week number
+ */
+export declare function fetchFarmsForWeek(weekNumber: number, gcaUrls: string[], apiUrl: string): Promise<ApiResponse>;

package/dist/esm/lib/create-weekly-report/utils/from-bigint.d.ts

@@ -0,0 +1,7 @@
+import Decimal from "decimal.js";
+/**
+ * Converts a bigint with the specified decimal precision back to a Decimal.
+ * @param value - The bigint value
+ * @param decimals - Number of decimal places (default: 8)
+ */
+export declare function fromBigInt(value: bigint, decimals?: number): Decimal;

package/dist/esm/lib/create-weekly-report/utils/greater-than-max-deviation.d.ts

@@ -0,0 +1 @@
+export declare function greaterThanMaxDeviation(valA: number, valB: number, maxDeviationPercent: number): boolean;

package/dist/esm/lib/create-weekly-report/utils/hashLeaf.d.ts

@@ -0,0 +1,7 @@
+type HashLeafArgs = {
+    address: string;
+    glowWeight: string;
+    usdcWeight: string;
+};
+export declare function hashLeaf({ address, glowWeight, usdcWeight, }: HashLeafArgs): string;
+export {};

package/dist/esm/lib/create-weekly-report/utils/multiply-bigInt-by-decimal-percentage.d.ts

@@ -0,0 +1 @@
+export declare function multiplyBigIntByDecimalPercentage(bigInt: bigint, numberOfDecimals: number, percentage: number): bigint;

package/dist/esm/lib/create-weekly-report/utils/to-bigint.d.ts

@@ -0,0 +1,7 @@
+import Decimal from "decimal.js";
+/**
+ * Converts a Decimal-like value to bigint with the specified decimal precision, rounding down.
+ * @param value - The value to convert (string, number, or Decimal)
+ * @param decimals - Number of decimal places (default: 8)
+ */
+export declare function toBigInt(value: string | number | Decimal, decimals?: number): bigint;

package/dist/esm/utils/custom-to-fixed.d.ts

@@ -0,0 +1 @@
+export declare function customToFixed(num: number, precision: number): string;

package/dist/esm/utils/greater-than-max-deviation.d.ts

@@ -0,0 +1 @@
+export declare function greaterThanMaxDeviation(valA: number, valB: number, maxDeviationPercent: number): boolean;

package/dist/esm/utils/hash-leaf.d.ts

@@ -0,0 +1,7 @@
+type HashLeafArgs = {
+    address: string;
+    glowWeight: string;
+    usdcWeight: string;
+};
+export declare function hashLeaf({ address, glowWeight, usdcWeight, }: HashLeafArgs): string;
+export {};

package/package.json

@@ -1,11 +1,7 @@
 {
   "name": "@glowlabs-org/utils",
-  "version": "0.0.9",
+  "version": "0.1.2",
   "description": "A library containing all typechain types and addresses relating to the glow guarded launch",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "rollup -c"
-  },
   "keywords": [],
   "author": "",
   "license": "ISC",
@@ -26,18 +22,26 @@
   "peerDependencies": {
     "ethers": "5.x.x",
     "merkletreejs": "^0.3.11",
-    "viem": "^2.19.7"
+    "viem": "^2.19.7",
+    "decimal.js": "^10.4.3"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^26.0.1",
+    "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@types/node": "^20.10.5",
+    "axios": "^1.9.0",
+    "decimal.js": "^10.4.3",
     "esbuild": "^0.23.1",
-    "ethers": "^5.7.2",
+    "ethers": "5.7.2",
     "rollup": "^4.21.0",
     "rollup-plugin-peer-deps-external": "^2.2.4",
     "rollup-plugin-typescript2": "^0.36.0",
     "typescript": "^5.5.4",
-    "viem": "^2.19.7"
+    "viem": "^2.7.16"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "rollup -c"
   }
-}
+}

package/rollup.config.js

@@ -2,6 +2,7 @@ import commonjs from "@rollup/plugin-commonjs";
 import resolve from "@rollup/plugin-node-resolve";
 import typescript from "rollup-plugin-typescript2";
 import peerDepsExternal from "rollup-plugin-peer-deps-external";
+import json from "@rollup/plugin-json";
 
 export default {
   input: "src/index.ts", // Adjust to your entry point
@@ -21,6 +22,7 @@ export default {
     peerDepsExternal(), // Automatically externalize peer dependencies
     resolve(), // Resolves node modules
     commonjs(), // Converts CommonJS modules to ES6
+    json(),
     typescript({ tsconfig: "./tsconfig.json" }), // Handles TypeScript
   ],
 };

package/src/constants/regex.ts

@@ -0,0 +1,2 @@
+// Numeric string regex: matches valid numbers (digits, optional single dot, digits after dot)
+export const NUMERIC_REGEX = /^(?:\d+\.?\d*|\.\d+)$/;

package/src/constants/urls.ts

@@ -0,0 +1,3 @@
+export const HUB_URL = "https://glow.org";
+
+export const GCA_URLS = ["http://95.217.194.59:35015"];

package/src/constants/weights.ts

@@ -0,0 +1,15 @@
+/**
+ * @dev This is actually not as intuitive as it seems.
+ * Glow actually has 18 decimals, but glow weight is based on the amount of protocol fees (USDC) that the farm paid
+ * Therefore, the weight is based on the amount of USDC that was paid, which has 8 decimals
+ */
+export const GLOW_WEIGHT_DECIMAL_PRECISION = 8;
+
+/**
+ * @dev This is actually not as intuitive as it seems.
+ * USDG weight is based on the amount of carbon credits produced, but the max value of a weight is ((2*64)-1) / 5 so we need to choose sensible precision to make sure that number never overflows
+ */
+export const USDG_WEIGHT_DECIMAL_PRECISION = 8;
+
+export const MAX_WEIGHT: bigint =
+  (BigInt(2) ** BigInt(64) - BigInt(1)) / BigInt(5);

package/src/index.ts

@@ -1,3 +1,3 @@
-export * from "./types/index";
+export * from "./lib/create-weekly-report/types/index";
 export * from "./constants/index";
 export { createWeeklyReport } from "./lib/create-weekly-report/index";