@glowlabs-org/utils 0.1.5 → 0.2.0

package/dist/esm/lib/abis/erc20.abi.d.ts

@@ -0,0 +1,13 @@
+export declare const ERC20_ABI: {
+    inputs: {
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    outputs: {
+        name: string;
+        type: string;
+    }[];
+    stateMutability: string;
+    type: string;
+}[];

package/dist/esm/lib/abis/forwarderABI.d.ts

@@ -0,0 +1,99 @@
+export declare const FORWARDER_ABI: readonly [{
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "_forwarder";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "constructor";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "target";
+        readonly type: "address";
+    }];
+    readonly name: "AddressEmptyCode";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "account";
+        readonly type: "address";
+    }];
+    readonly name: "AddressInsufficientBalance";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "FailedInnerCall";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "token";
+        readonly type: "address";
+    }];
+    readonly name: "SafeERC20FailedOperation";
+    readonly type: "error";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "from";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "token";
+        readonly type: "address";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "uint256";
+        readonly name: "amount";
+        readonly type: "uint256";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "string";
+        readonly name: "message";
+        readonly type: "string";
+    }];
+    readonly name: "Forward";
+    readonly type: "event";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "FORWARD_ADDRESS";
+    readonly outputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "token";
+        readonly type: "address";
+    }, {
+        readonly internalType: "address";
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "amount";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "string";
+        readonly name: "message";
+        readonly type: "string";
+    }];
+    readonly name: "forward";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}];

package/dist/esm/lib/hooks/use-forwarder.d.ts

@@ -0,0 +1,36 @@
+import { BigNumber, ethers } from "ethers";
+export declare enum ForwarderError {
+    CONTRACT_NOT_AVAILABLE = "Contract not available",
+    SIGNER_NOT_AVAILABLE = "Signer not available",
+    UNKNOWN_ERROR = "Unknown error",
+    INVALID_FORWARD_TYPE = "Invalid forward type",
+    MISSING_REQUIRED_PARAMS = "Missing required parameters"
+}
+export type ForwardType = "PayProtocolFeeAndMintGCTLAndStake" | "PayProtocolFee" | "MintGCTLAndStake" | "MintGCTL" | "BuySolarFarm";
+export type Currency = "USDC" | "GLW" | "USDG";
+export interface ForwardParams {
+    amount: BigNumber;
+    userAddress: string;
+    type: ForwardType;
+    currency?: Currency;
+    applicationId?: string;
+    farmId?: string;
+    regionId?: number;
+}
+export declare function useForwarder(signer: ethers.providers.JsonRpcSigner | undefined, CHAIN_ID: number): {
+    forwardTokens: (params: ForwardParams) => Promise<string>;
+    payProtocolFeeAndMintGCTLAndStake: (amount: BigNumber, userAddress: string, applicationId: string, regionId?: number, currency?: Currency) => Promise<string>;
+    payProtocolFee: (amount: BigNumber, userAddress: string, applicationId: string, currency?: Currency) => Promise<string>;
+    mintGCTLAndStake: (amount: BigNumber, userAddress: string, regionId?: number) => Promise<string>;
+    mintGCTL: (amount: BigNumber, userAddress: string) => Promise<string>;
+    buySolarFarm: (amount: BigNumber, userAddress: string, farmId: string, currency?: Currency) => Promise<string>;
+    approveToken: (amount: BigNumber, currency?: Currency) => Promise<boolean>;
+    checkTokenAllowance: (owner: string, currency?: Currency) => Promise<BigNumber>;
+    checkTokenBalance: (owner: string, currency?: Currency) => Promise<BigNumber>;
+    estimateGasForForward: (params: ForwardParams, ethPriceInUSD: number | null) => Promise<string>;
+    mintTestUSDC: (amount: BigNumber, recipient: string) => Promise<string>;
+    constructForwardMessage: (params: ForwardParams) => string;
+    readonly isProcessing: boolean;
+    addresses: Record<"USDC" | "GLW" | "USDG" | "FORWARDER" | "FOUNDATION_WALLET", `0x${string}`>;
+    isSignerAvailable: boolean;
+};

package/package.json

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

package/src/constants/addresses.ts

@@ -0,0 +1,34 @@
+type ContractKeys = "USDC" | "FORWARDER" | "FOUNDATION_WALLET" | "GLW" | "USDG";
+
+// Contract-specific addresses
+const mainnetAddresses: Record<ContractKeys, `0x${string}`> = {
+  USDG: "0xe010ec500720bE9EF3F82129E7eD2Ee1FB7955F2",
+  GLW: "0xf4fbC617A5733EAAF9af08E1Ab816B103388d8B6",
+  USDC: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+  FORWARDER: "0x0000000000000000000000000000000000000000", // TODO: Update with actual mainnet address
+  FOUNDATION_WALLET: "0x0000000000000000000000000000000000000000", // TODO: Update with actual mainnet foundation wallet
+};
+
+const sepoliaAddresses: Record<ContractKeys, `0x${string}`> = {
+  USDG: "0xda78313A3fF949890112c1B746AB1c75d1b1c17B",
+  GLW: "0x2039161fcE4C8e5CF5FE64e17Fd290E8dFF3c9BD",
+  USDC: "0x93c898be98cd2618ba84a6dccf5003d3bbe40356",
+  FORWARDER: "0x9c1d61303D46BFAb1eC5F25c12A1Bf4cB3d06416",
+  FOUNDATION_WALLET: "0x5e230FED487c86B90f6508104149F087d9B1B0A7",
+};
+
+export const getAddresses = (
+  CHAIN_ID: number
+): Record<ContractKeys, `0x${string}`> => {
+  switch (CHAIN_ID) {
+    case 1:
+      return mainnetAddresses;
+    case 11155111:
+      return sepoliaAddresses;
+    default:
+      console.warn(
+        `Unsupported chain ID: ${CHAIN_ID}, falling back to mainnet addresses`
+      );
+      return mainnetAddresses;
+  }
+};

package/src/index.ts

@@ -4,3 +4,5 @@ export {
   createWeeklyReport,
   createWeeklyReportLegacy,
 } from "./lib/create-weekly-report/index";
+
+export { useForwarder } from "./lib/hooks/use-forwarder";

package/src/lib/abis/erc20.abi.ts

@@ -0,0 +1,49 @@
+export const ERC20_ABI = [
+  {
+    inputs: [
+      { name: "spender", type: "address" },
+      { name: "amount", type: "uint256" },
+    ],
+    name: "approve",
+    outputs: [{ name: "", type: "bool" }],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      { name: "owner", type: "address" },
+      { name: "spender", type: "address" },
+    ],
+    name: "allowance",
+    outputs: [{ name: "", type: "uint256" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [
+      { name: "to", type: "address" },
+      { name: "amount", type: "uint256" },
+    ],
+    name: "transfer",
+    outputs: [{ name: "", type: "bool" }],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [{ name: "account", type: "address" }],
+    name: "balanceOf",
+    outputs: [{ name: "", type: "uint256" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [
+      { name: "account", type: "address" },
+      { name: "amount", type: "uint256" },
+    ],
+    name: "mint",
+    outputs: [{ name: "", type: "bool" }],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+];

package/src/lib/abis/forwarderABI.ts

@@ -0,0 +1,69 @@
+export const FORWARDER_ABI = [
+  {
+    inputs: [{ internalType: "address", name: "_forwarder", type: "address" }],
+    stateMutability: "nonpayable",
+    type: "constructor",
+  },
+  {
+    inputs: [{ internalType: "address", name: "target", type: "address" }],
+    name: "AddressEmptyCode",
+    type: "error",
+  },
+  {
+    inputs: [{ internalType: "address", name: "account", type: "address" }],
+    name: "AddressInsufficientBalance",
+    type: "error",
+  },
+  { inputs: [], name: "FailedInnerCall", type: "error" },
+  {
+    inputs: [{ internalType: "address", name: "token", type: "address" }],
+    name: "SafeERC20FailedOperation",
+    type: "error",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: true, internalType: "address", name: "from", type: "address" },
+      { indexed: true, internalType: "address", name: "to", type: "address" },
+      {
+        indexed: true,
+        internalType: "address",
+        name: "token",
+        type: "address",
+      },
+      {
+        indexed: false,
+        internalType: "uint256",
+        name: "amount",
+        type: "uint256",
+      },
+      {
+        indexed: false,
+        internalType: "string",
+        name: "message",
+        type: "string",
+      },
+    ],
+    name: "Forward",
+    type: "event",
+  },
+  {
+    inputs: [],
+    name: "FORWARD_ADDRESS",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "address", name: "token", type: "address" },
+      { internalType: "address", name: "to", type: "address" },
+      { internalType: "uint256", name: "amount", type: "uint256" },
+      { internalType: "string", name: "message", type: "string" },
+    ],
+    name: "forward",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+] as const;