@glowlabs-org/utils 0.1.5 → 0.2.0

package/README.md

@@ -8,10 +8,10 @@ This repository contains utils for interacting with Glow labs data sources
 
 ## Requirements
 
-- Ethers V5
+- Node >= 16 (tested up to 20)
+- Ethers v5 (peer-dependency)
 - MerkletreeJS
 - Viem
-- Node version >= 16
 
 ## Example Usage
 
@@ -31,11 +31,42 @@ const main = async () => {
   //Save to 37.json
   fs.writeFileSync("37.json", JSON.stringify(report, null, 4));
 };
-``;
+```
+
+---
+
+### Forwarder SDK (framework-agnostic)
+
+Below is a minimal example showing how to forward USDC using a standard `ethers` signer. The same call works in Node or in a browser (e.g. MetaMask’s `window.ethereum`).
+
+```typescript
+import { useForwarder } from "@glowlabs-org/utils";
+import { Wallet, providers, utils } from "ethers";
 
-main();
+// Use Infura, Alchemy or any JSON-RPC endpoint
+const provider = new providers.JsonRpcProvider(
+  "https://sepolia.infura.io/v3/<API_KEY>"
+);
+
+// A local private key, or rely on a browser wallet by passing `provider.getSigner()`
+const signer = new Wallet(process.env.PRIVATE_KEY!, provider);
+
+// Chain id 11155111 = Sepolia
+const forwarder = useForwarder(signer, 11155111);
+
+await forwarder.forwardTokens({
+  amount: utils.parseUnits("10", 6), // 10 USDC (6 dp)
+  userAddress: await signer.getAddress(),
+  type: "PayProtocolFee",
+  applicationId: "123",
+  currency: "USDC",
+});
+
+console.log("Tx hash:", forwarder.isProcessing ? "pending…" : "sent");
 ```
 
+See `src/lib/hooks/use-forwarder.ts` for all available helpers (`approveToken`, `checkTokenBalance`, `estimateGasForForward`, etc.).
+
 ## Contributions
 
 For contributions, feel free to open a PR or raise an issue.

package/dist/cjs/constants/addresses.d.ts

@@ -0,0 +1,3 @@
+type ContractKeys = "USDC" | "FORWARDER" | "FOUNDATION_WALLET" | "GLW" | "USDG";
+export declare const getAddresses: (CHAIN_ID: number) => Record<ContractKeys, `0x${string}`>;
+export {};

package/dist/cjs/index.d.ts

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