@glowlabs-org/utils 0.2.3 → 0.2.4

package/README.md

@@ -67,6 +67,76 @@ console.log("Tx hash:", forwarder.isProcessing ? "pending…" : "sent");
 
 See `src/lib/hooks/use-forwarder.ts` for all available helpers (`approveToken`, `checkTokenBalance`, `estimateGasForForward`, etc.).
 
+---
+
+### Control-API SDK (framework-agnostic)
+
+All on-chain accounting and staking data can be accessed through the plain-TypeScript helper exported from `src/lib/hooks/use-control-api.ts`.
+
+```typescript
+import { useControlApi } from "@glowlabs-org/utils";
+
+// Base URL of your deployed Control-API instance (can be relative or absolute)
+const controlApi = useControlApi("https://control-api.glowlabs.org");
+
+// Read-only queries
+const balance = await controlApi.fetchGctlBalance("0xYourWallet");
+const price = await controlApi.fetchGctlPrice();
+const regions = await controlApi.fetchRegions();
+
+// Mutations
+await controlApi.stakeGctl(
+  "0xYourWallet",
+  /* regionId */ 42,
+  /* amount */ "1000000"
+);
+
+if (controlApi.isStaking) {
+  console.log("staking in progress…");
+}
+```
+
+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.
+
+---
+
+### Regions-API SDK (framework-agnostic)
+
+This tiny helper wraps region CRUD endpoints and provides in-memory caching.
+
+```typescript
+import { useRegionsApi } from "@glowlabs-org/utils";
+
+const regionsApi = useRegionsApi("https://control-api.glowlabs.org");
+
+// Fetch & cache
+await regionsApi.fetchRegions();
+console.table(regionsApi.regions);
+
+// Create a new region
+await regionsApi.createRegion({
+  code: "FR",
+  name: "France",
+  isUs: false,
+});
+
+console.log("isCreatingRegion", regionsApi.isCreatingRegion);
+```
+
+`getRegionByCode()` also merges locally-bundled metadata (flag, description, etc.) from `src/lib/region-metadata.ts`.
+
+The metadata file re-exports handy arrays:
+
+```typescript
+import {
+  allRegions,
+  usStates,
+  countries,
+} from "@glowlabs-org/utils/dist/region-metadata";
+```
+
+---
+
 ## Contributions
 
 For contributions, feel free to open a PR or raise an issue.

package/dist/cjs/browser.d.ts

@@ -1,4 +1,8 @@
 export * from "./lib/hooks/use-forwarder";
+export * from "./lib/hooks/use-control-api";
+export * from "./lib/hooks/use-regions";
+export * from "./lib/types";
+export * from "./lib/region-metadata";
 export * from "./constants/addresses";
 export * from "./constants/weights";
 export * from "./constants/urls";