@glowlabs-org/utils 0.2.142 → 0.2.144

package/README.md

@@ -4,14 +4,17 @@ This repository contains utils for interacting with Glow labs data sources
 
 ## Install
 
-`npm install ethers@5.7.2 viem merkletreejs @glowlabs-org/utils`
+```bash
+# peer deps (versions compatible with this library)
+pnpm add @glowlabs-org/utils ethers@^6 viem@^2 merkletreejs decimal.js
+```
 
 ## Requirements
 
 - Node >= 16 (tested up to 20)
-- Ethers v5 (peer-dependency)
+- Ethers v6 (peer-dependency)
+- Viem v2 (peer-dependency)
 - MerkletreeJS
-- Viem
 
 ## Example Usage
 
@@ -41,12 +44,10 @@ Below is a minimal example showing how to forward USDC using a standard `ethers`
 
 ```typescript
 import { useForwarder } from "@glowlabs-org/utils";
-import { Wallet, providers, utils } from "ethers";
+import { Wallet, JsonRpcProvider, parseUnits } from "ethers";
 
 // Use Infura, Alchemy or any JSON-RPC endpoint
-const provider = new providers.JsonRpcProvider(
-  "https://sepolia.infura.io/v3/<API_KEY>"
-);
+const provider = new 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);
@@ -55,7 +56,7 @@ const signer = new Wallet(process.env.PRIVATE_KEY!, provider);
 const forwarder = useForwarder(signer, 11155111);
 
 await forwarder.forwardTokens({
-  amount: utils.parseUnits("10", 6), // 10 USDC (6 dp)
+  amount: parseUnits("10", 6), // 10 USDC (6 dp)
   userAddress: await signer.getAddress(),
   type: "PayProtocolFee",
   applicationId: "123",
@@ -71,8 +72,6 @@ See `src/lib/hooks/use-forwarder.ts` for all available helpers (`approveToken`,
 
 ### Control-API SDK (framework-agnostic)
 
-All on-chain accounting and staking data can be accessed through the plain-TypeScript helper exported from `src/lib/control-api/control-router.ts`.
-
 ```typescript
 import { ControlRouter } from "@glowlabs-org/utils";
 
@@ -82,33 +81,27 @@ const controlApi = ControlRouter("https://control-api.glowlabs.org");
 // Read-only queries
 const balance = await controlApi.fetchGctlBalance("0xYourWallet");
 const price = await controlApi.fetchGctlPrice();
-// New – GLW token price in USDC
 const glwPrice = await controlApi.fetchGlwPrice();
 
-const regions = await controlApi.fetchRegions();
-
-// Paginated listings (page, limit are optional – default 1/50)
+// Paginated listings
 const mintedPage2 = await controlApi.fetchMintedEvents(2, 25);
 
 // Mutations
-await controlApi.stakeGctl(
-  "0xYourWallet",
-  /* regionId */ 42,
-  /* amount */ "1000000"
-);
-
-if (controlApi.isStaking) {
-  console.log("staking in progress…");
-}
+await controlApi.stakeGctl({
+  wallet: "0xYourWallet",
+  regionId: 42,
+  amount: "1000000",
+  signature: "0x…",
+  deadline: "1728000000",
+  nonce: "1",
+});
 ```
 
-Refer to the source file for the full surface (`fetchMintedEvents`, `unstakeGctl`, `retryFailedOperation`, etc.). All methods are promise-based and contain zero React dependencies – usable in Node, Deno or the browser.
+All methods are promise-based and contain zero React dependencies – usable in Node, Deno or the browser.
 
 ---
 
-### Regions-API SDK (framework-agnostic)
-
-This tiny helper wraps region CRUD endpoints and provides in-memory caching.
+### Region-API SDK (framework-agnostic)
 
 ```typescript
 import { RegionRouter } from "@glowlabs-org/utils";
@@ -119,17 +112,92 @@ const regionsApi = RegionRouter("https://control-api.glowlabs.org");
 await regionsApi.fetchRegions();
 console.table(regionsApi.regions);
 
-// Create a new region
-await regionsApi.createRegion({
-  code: "FR",
-  name: "France",
-  isUs: false,
+// Convenience helper merges bundled metadata with fetched regions
+const maybeFlorida = regionsApi.getRegionByCode("US-FL");
+```
+
+`getRegionByCode()` merges locally-bundled metadata (flag, description, etc.) from `src/lib/region-metadata.ts`.
+
+---
+
+## Optional Sentry integration (Next.js)
+
+This library ships with built-in, optional Sentry hooks. If Sentry isn’t configured, everything no-ops safely.
+
+#### 1) Install Sentry for Next.js
+
+```bash
+pnpm add @sentry/nextjs
+# or: npx @sentry/wizard -i nextjs
+```
+
+Set env vars (build-time for source maps, and runtime DSN):
+
+```env
+# build-time (CI) – for source maps upload
+SENTRY_AUTH_TOKEN=...        # keep secret
+SENTRY_ORG=your-org
+SENTRY_PROJECT=your-project
+
+# runtime (browser/server)
+NEXT_PUBLIC_SENTRY_DSN=https://<key>@o<org>.ingest.sentry.io/<project>
+NEXT_PUBLIC_SENTRY_ENABLED=true
+```
+
+Wrap your Next config to enable source maps upload (optional but recommended):
+
+```js
+// next.config.js
+const { withSentryConfig } = require("@sentry/nextjs");
+
+const nextConfig = {
+  /* your config */
+};
+module.exports = withSentryConfig(nextConfig, { silent: true });
+```
+
+#### 2) Initialize Sentry and wire the utils once
+
+App Router (recommended):
+
+```ts
+// sentry.client.config.ts
+import * as Sentry from "@sentry/nextjs";
+import { configureSentry } from "@glowlabs-org/utils/browser";
+
+Sentry.init({ dsn: process.env.NEXT_PUBLIC_SENTRY_DSN });
+
+configureSentry({
+  enabled: process.env.NEXT_PUBLIC_SENTRY_ENABLED !== "false",
+  client: Sentry,
+  defaultContext: { app: "web", env: process.env.NEXT_PUBLIC_VERCEL_ENV },
 });
+```
+
+```ts
+// sentry.server.config.ts
+import * as Sentry from "@sentry/nextjs";
+import { configureSentry } from "@glowlabs-org/utils";
+
+Sentry.init({ dsn: process.env.NEXT_PUBLIC_SENTRY_DSN });
+
+configureSentry({
+  enabled: process.env.NEXT_PUBLIC_SENTRY_ENABLED !== "false",
+  client: Sentry,
+  defaultContext: { runtime: "server" },
+});
+```
+
+That’s it. All mutations in `ControlRouter`, `FarmsRouter`, `KickstarterRouter`, and the hooks (`useForwarder`, `useOffchainFractions`) will automatically add breadcrumbs and capture exceptions with useful context (wallets, ids, region, baseUrl, etc.).
+
+#### Disable Sentry (locally or per environment)
 
-console.log("isCreatingRegion", regionsApi.isCreatingRegion);
+```ts
+import { configureSentry } from "@glowlabs-org/utils";
+configureSentry({ enabled: false });
 ```
 
-`getRegionByCode()` also merges locally-bundled metadata (flag, description, etc.) from `src/lib/region-metadata.ts`.
+You can also skip calling `configureSentry` entirely – the library will quietly no-op unless a Sentry client is provided or found globally.
 
 The metadata file re-exports handy arrays:
 

package/dist/cjs/browser.d.ts

@@ -14,3 +14,4 @@ export * from "./constants/weights";
 export * from "./constants/urls";
 export * from "./utils/stake-control";
 export * from "./utils/transaction-utils";
+export { configureSentry, type SentryClientLike } from "./utils/sentry";

package/dist/cjs/browser.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var farmsRouter = require('./farms-router-CCva--xp.js');
+var farmsRouter = require('./farms-router-Bvy7r2pJ.js');
 var viem = require('viem');
 require('ethers');
 
@@ -12447,6 +12447,7 @@ exports.TRANSFER_TYPES = farmsRouter.TRANSFER_TYPES;
 exports.USDG_WEIGHT_DECIMAL_PRECISION = farmsRouter.USDG_WEIGHT_DECIMAL_PRECISION;
 exports.WalletsRouter = farmsRouter.WalletsRouter;
 exports.allRegions = farmsRouter.allRegions;
+exports.configureSentry = farmsRouter.configureSentry;
 exports.countries = farmsRouter.countries;
 exports.getAddresses = farmsRouter.getAddresses;
 exports.parseEthersError = farmsRouter.parseEthersError;