@sudobility/heavymath_indexer_client 0.0.3

package/LICENSE.md

@@ -0,0 +1,80 @@
+Business Source License 1.1
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved. "Business Source License" is a trademark of
+MariaDB Corporation Ab.
+
+---
+
+Parameters
+
+Licensor: Sudobility Inc.
+
+Licensed Work: HeavyMath. The Licensed Work is (C) 2025 Sudobility Inc.
+
+Additional Use Grant: None
+
+Change Date: 2029-11-13
+
+Change License: GNU General Public License v3.0 or later
+
+---
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative works, redistribute, and make non-production
+use of the Licensed Work. The Licensor may make an Additional Use Grant, above, permitting limited production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly available distribution of a specific
+version of the Licensed Work under this License, whichever comes first, the Licensor hereby grants you rights under the
+terms of the Change License, and the rights granted in the paragraph above terminate.
+
+If your use of the Licensed Work does not comply with the requirements currently in effect as described in this License,
+you must purchase a commercial license from the Licensor, its affiliated entities, or authorized resellers, or you must
+refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works of the Licensed Work, are subject to this
+License. This License applies separately for each version of the Licensed Work and the Change Date may vary for each
+version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy of the Licensed Work. If you receive the
+Licensed Work in original or modified form from a third party, the terms and conditions set forth in this License apply
+to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically terminate your rights under this License
+for the current and all other versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of Licensor or its affiliates (provided that you may
+use a trademark or logo of Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS
+ALL WARRANTIES AND CONDITIONS, EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE.
+
+MariaDB hereby grants you permission to use this License's text to license your works, and to refer to it using the
+trademark "Business Source License", as long as you comply with the Covenants of Licensor below.
+
+---
+
+Covenants of Licensor
+
+In consideration of the right to use this License's text and the "Business Source License" name and trademark, Licensor
+covenants to MariaDB, and to all other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 3.0 or any later version, or a license that is compatible with GPL
+   Version 3.0 or a later version, where "compatible" means that software provided under the Change License can be
+   included in a program with software provided under GPL Version 3.0 or a later version. Licensor may specify
+   additional Change Licenses without limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not impose any additional restriction on the
+   right granted in this License, as the Additional Use Grant; or (b) insert the text "None".
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.
+
+---
+
+Notice
+
+The Business Source License (this document, or the "License") is not an Open Source license. However, the Licensed Work
+will eventually be made available under an Open Source License, as stated in this License.

package/README.md

@@ -0,0 +1,380 @@
+# @heavymath/indexer_client
+
+TypeScript client library for the Heavymath Prediction Market Indexer API. Provides React hooks, business services, and low-level API clients for querying prediction market data.
+
+## Features
+
+- **Full API Coverage** - All REST endpoints supported
+- **React Hooks** - Built-in hooks using @tanstack/react-query
+- **Business Services** - High-level services with caching
+- **Network Layer** - Low-level API client for custom integrations
+- **TypeScript First** - Full type definitions included
+- **React Native Compatible** - Works in React Native environments
+- **Dependency Injection** - Uses NetworkClient from @sudobility/di
+
+## Installation
+
+```bash
+npm install @heavymath/indexer_client
+```
+
+## Peer Dependencies
+
+```bash
+npm install react @tanstack/react-query @sudobility/types @sudobility/heavymath_types @sudobility/di
+```
+
+## Quick Start
+
+### 1. Setup React Query Provider
+
+```tsx
+import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
+
+const queryClient = new QueryClient();
+
+function App() {
+  return (
+    <QueryClientProvider client={queryClient}>
+      <YourApp />
+    </QueryClientProvider>
+  );
+}
+```
+
+### 2. Create IndexerClient with NetworkClient
+
+```tsx
+import { useMemo } from 'react';
+import { useNetworkService } from '@sudobility/di'; // Or your DI container
+import { IndexerClient } from '@heavymath/indexer_client';
+
+// Create a hook to provide IndexerClient
+function useIndexerClient() {
+  const networkClient = useNetworkService();
+  return useMemo(
+    () => new IndexerClient('http://localhost:42069', networkClient),
+    [networkClient]
+  );
+}
+```
+
+### 3. Use Hooks in Your Components
+
+```tsx
+import { useActiveMarkets, useUserPredictions } from '@heavymath/indexer_client';
+
+function BettorDashboard({ wallet }: { wallet: string }) {
+  const client = useIndexerClient();
+
+  const { data: markets, isLoading: marketsLoading } = useActiveMarkets(client, 20);
+  const { data: myBets, isLoading: betsLoading } = useUserPredictions(client, wallet);
+
+  if (marketsLoading || betsLoading) return <div>Loading...</div>;
+
+  return (
+    <div>
+      <h2>Active Markets</h2>
+      {markets?.data?.map(market => (
+        <MarketCard key={market.id} market={market} />
+      ))}
+
+      <h2>My Bets</h2>
+      {myBets?.data?.map(bet => (
+        <BetCard key={bet.id} bet={bet} />
+      ))}
+    </div>
+  );
+}
+```
+
+## Architecture
+
+The library is organized into three layers:
+
+### 1. Network Layer
+
+Low-level API client that accepts a `NetworkClient` instance.
+
+```tsx
+import type { NetworkClient } from '@sudobility/types';
+import { IndexerClient } from '@heavymath/indexer_client';
+
+// Get NetworkClient from your DI container
+const networkClient: NetworkClient = getNetworkService();
+
+const client = new IndexerClient('http://localhost:42069', networkClient);
+
+// Direct API calls
+const markets = await client.getMarkets({ status: 'Active', limit: 10 });
+const market = await client.getMarket('1-market-123');
+```
+
+### 2. Business Layer
+
+High-level services with caching and business logic.
+
+```tsx
+import type { NetworkClient } from '@sudobility/types';
+import { IndexerService } from '@heavymath/indexer_client';
+
+const networkClient: NetworkClient = getNetworkService();
+
+const service = new IndexerService({
+  indexerUrl: 'http://localhost:42069',
+  networkClient,
+  cacheTTL: 5 * 60 * 1000, // 5 minutes (optional)
+});
+
+// Business methods with caching
+const activeMarkets = await service.getActiveMarkets(20);
+const userPredictions = await service.getUserPredictions('0x123...');
+const dealerDashboard = await service.getDealerDashboard('0x123...');
+```
+
+### 3. Hooks Layer
+
+React hooks using @tanstack/react-query for data fetching.
+
+```tsx
+import { useActiveMarkets, useUserPredictions, useDealerDashboard } from '@heavymath/indexer_client';
+
+// All hooks take IndexerClient as first parameter
+const { data, isLoading, error, refetch } = useActiveMarkets(client, 20);
+```
+
+## Common Use Cases
+
+### Dealer Dashboard
+
+```tsx
+import { useDealerDashboard, useIsDealer } from '@heavymath/indexer_client';
+
+function DealerDashboard({ wallet }: { wallet: string }) {
+  const client = useIndexerClient();
+
+  const { data: isDealer, isLoading: checkingDealer } = useIsDealer(client, wallet);
+  const { nfts, markets, isLoading } = useDealerDashboard(client, wallet);
+
+  if (checkingDealer) return <div>Checking dealer status...</div>;
+  if (!isDealer) return <div>You are not a dealer</div>;
+  if (isLoading) return <div>Loading dashboard...</div>;
+
+  return (
+    <div>
+      <h2>My Dealer NFTs</h2>
+      {nfts.data?.map(nft => (
+        <div key={nft.id}>Token #{nft.tokenId}</div>
+      ))}
+
+      <h2>My Markets</h2>
+      {markets.data?.map(market => (
+        <MarketCard key={market.id} market={market} />
+      ))}
+    </div>
+  );
+}
+```
+
+### Market Details Page
+
+```tsx
+import { useMarketDetails } from '@heavymath/indexer_client';
+
+function MarketPage({ marketId }: { marketId: string }) {
+  const client = useIndexerClient();
+
+  const { market, predictions, history, isLoading, isError } = useMarketDetails(client, marketId);
+
+  if (isLoading) return <div>Loading...</div>;
+  if (isError) return <div>Error loading market</div>;
+
+  return (
+    <div>
+      <h1>{market.data?.data?.title}</h1>
+      <p>{market.data?.data?.description}</p>
+      <p>Status: {market.data?.data?.status}</p>
+
+      <h2>Predictions ({predictions.data?.data?.length || 0})</h2>
+      {predictions.data?.data?.map(pred => (
+        <div key={pred.id}>
+          {pred.userAddress}: {pred.percentage}%
+        </div>
+      ))}
+
+      <h2>State History</h2>
+      {history.data?.data?.map(state => (
+        <div key={state.id}>
+          {state.fromState} → {state.toState}
+        </div>
+      ))}
+    </div>
+  );
+}
+```
+
+### Wallet Favorites
+
+```tsx
+import { useFavorites } from '@heavymath/indexer_client';
+
+function FavoritesPage({ wallet }: { wallet: string }) {
+  const client = useIndexerClient();
+
+  const { favorites, isLoading, addFavorite, removeFavorite, refresh } = useFavorites(
+    client,
+    wallet
+  );
+
+  const handleAddFavorite = async () => {
+    await addFavorite.mutateAsync({
+      category: 'sports',
+      subcategory: 'soccer',
+      type: 'team',
+      id: 'team-123',
+    });
+  };
+
+  const handleRemoveFavorite = async (id: number) => {
+    await removeFavorite.mutateAsync(id);
+  };
+
+  if (isLoading) return <div>Loading...</div>;
+
+  return (
+    <div>
+      <h2>My Favorites</h2>
+      {favorites.map(fav => (
+        <div key={fav.id}>
+          {fav.category}/{fav.subcategory}: {fav.itemId}
+          <button onClick={() => handleRemoveFavorite(fav.id)}>Remove</button>
+        </div>
+      ))}
+      <button onClick={handleAddFavorite}>Add Favorite</button>
+    </div>
+  );
+}
+```
+
+## Available Hooks
+
+### Market Hooks
+- `useMarkets(client, filters?)` - Get all markets with filtering
+- `useActiveMarkets(client, limit?)` - Get active markets only
+- `useMarket(client, marketId)` - Get specific market
+- `useMarketPredictions(client, marketId)` - Get market's predictions
+- `useMarketHistory(client, marketId)` - Get market's state history
+- `useMarketDetails(client, marketId)` - Get complete market details
+
+### Prediction Hooks
+- `usePredictions(client, filters?)` - Get predictions with filtering
+- `useUserPredictions(client, wallet, filters?)` - Get user's predictions
+- `useActiveBets(client, wallet)` - Get user's active bets
+- `usePastBets(client, wallet)` - Get user's claimed bets
+- `usePrediction(client, predictionId)` - Get specific prediction
+- `useUserBettingHistory(client, wallet)` - Get complete betting history
+
+### Dealer Hooks
+- `useDealers(client, filters?)` - Get dealer NFTs with filtering
+- `useIsDealer(client, wallet)` - Check if wallet is a dealer
+- `useDealerNFTs(client, wallet)` - Get wallet's dealer NFTs
+- `useDealer(client, dealerId)` - Get specific dealer NFT
+- `useDealerPermissions(client, dealerId)` - Get dealer's permissions
+- `useDealerMarkets(client, dealerId)` - Get dealer's markets
+- `useDealerDashboard(client, wallet)` - Get complete dealer dashboard
+
+### Withdrawal Hooks
+- `useWithdrawals(client, filters?)` - Get withdrawals with filtering
+- `useDealerWithdrawals(client, dealer)` - Get dealer's withdrawals
+- `useSystemWithdrawals(client)` - Get system withdrawals
+- `useMarketWithdrawals(client, marketId)` - Get market's withdrawals
+
+### Oracle Hooks
+- `useOracleRequests(client, filters?)` - Get oracle requests with filtering
+- `useOracleRequest(client, requestId)` - Get specific oracle request
+- `useMarketOracle(client, marketId)` - Get market's oracle request
+- `useTimedOutOracleRequests(client)` - Get timed out requests
+- `usePendingOracleRequests(client)` - Get pending requests
+
+### Favorites Hooks
+- `useFavorites(client, wallet, filters?)` - Get favorites with add/remove/refresh
+- `useCategoryFavorites(client, wallet, category)` - Get favorites by category
+- `useIsFavorite(client, wallet, item)` - Check if item is favorited with toggle
+
+### Stats Hooks
+- `useMarketStats(client)` - Get market statistics
+- `useHealth(client)` - Get indexer health status
+
+## API Endpoints
+
+The client supports all REST endpoints:
+
+- **Markets**: `/api/markets`, `/api/markets/:id`, `/api/markets/:id/predictions`, `/api/markets/:id/history`
+- **Predictions**: `/api/predictions`, `/api/predictions/:id`
+- **Dealers**: `/api/dealers`, `/api/dealers/:id`, `/api/dealers/:id/permissions`, `/api/dealers/:id/markets`
+- **Withdrawals**: `/api/withdrawals`
+- **Oracle**: `/api/oracle/requests`, `/api/oracle/requests/:id`
+- **Favorites**: `/api/wallet/:address/favorites` (GET, POST, DELETE)
+- **Analytics**: `/api/stats/markets`, `/api/health`
+
+## TypeScript Support
+
+Full TypeScript definitions included:
+
+```tsx
+import type {
+  // Core types (from @sudobility/heavymath_types)
+  MarketData,
+  PredictionData,
+  DealerNftData,
+  DealerPermissionData,
+  MarketStateHistoryData,
+  FeeWithdrawalData,
+  OracleRequestData,
+  WalletFavoriteData,
+  CreateFavoriteRequest,
+  // Enums
+  MarketStatus,
+  ClaimType,
+  WithdrawalType,
+  // Response wrappers (from @sudobility/types)
+  ApiResponse,
+  PaginatedResponse,
+  NetworkClient,
+  // Filter types
+  MarketFilters,
+  PredictionFilters,
+  DealerFilters,
+  WithdrawalFilters,
+  OracleFilters,
+  WalletFavoritesFilters,
+} from '@heavymath/indexer_client';
+```
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Build
+npm run build
+
+# Type check
+npm run typecheck
+
+# Lint
+npm run lint
+
+# Format
+npm run format
+
+# Run all checks
+npm run check-all
+```
+
+## License
+
+BUSL 1.1 - Business Use Source License
+
+Copyright (c) 2025 Sudobility Inc.

package/dist/business/index.d.ts

@@ -0,0 +1,2 @@
+export * from './indexer-service';
+//# sourceMappingURL=index.d.ts.map

package/dist/business/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/business/index.ts"],"names":[],"mappings":"AAIA,cAAc,mBAAmB,CAAC"}

package/dist/business/index.js

@@ -0,0 +1,2 @@
+export * from './indexer-service';
+//# sourceMappingURL=index.js.map

package/dist/business/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/business/index.ts"],"names":[],"mappings":"AAIA,cAAc,mBAAmB,CAAC"}

package/dist/business/indexer-service.d.ts

@@ -0,0 +1,40 @@
+import type { NetworkClient } from '@sudobility/types';
+import { IndexerClient } from '../network/IndexerClient';
+import type { Market, Prediction, DealerNFT, PaginatedResponse, ApiResponse, PredictionFilters, StateHistory, MarketStats } from '../types';
+export interface IndexerServiceConfig {
+    indexerUrl: string;
+    networkClient: NetworkClient;
+    cacheTTL?: number;
+}
+export declare class IndexerService {
+    private static instance;
+    private indexerClient;
+    private cache;
+    private readonly CACHE_TTL;
+    constructor(config: IndexerServiceConfig);
+    static getInstance(config: IndexerServiceConfig): IndexerService;
+    private getCacheKey;
+    private getCache;
+    private setCache;
+    getActiveMarkets(limit?: number): Promise<PaginatedResponse<Market>>;
+    getUserPredictions(walletAddress: string, filters?: Omit<PredictionFilters, 'user'>): Promise<PaginatedResponse<Prediction>>;
+    getDealerNFTs(walletAddress: string): Promise<DealerNFT[]>;
+    getDealerDashboard(walletAddress: string): Promise<{
+        nfts: DealerNFT[];
+        markets: Market[];
+    }>;
+    getMarketDetails(marketId: string): Promise<{
+        market: Market;
+        predictions: Prediction[];
+        history: StateHistory[];
+    }>;
+    getUserBettingHistory(walletAddress: string): Promise<{
+        active: Prediction[];
+        claimed: Prediction[];
+    }>;
+    getMarketFromPrediction(predictionId: string): Promise<Market | null>;
+    getMarketStats(): Promise<ApiResponse<MarketStats>>;
+    clearCache(): void;
+    getClient(): IndexerClient;
+}
+//# sourceMappingURL=indexer-service.d.ts.map

package/dist/business/indexer-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexer-service.d.ts","sourceRoot":"","sources":["../../src/business/indexer-service.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,KAAK,EACV,MAAM,EACN,UAAU,EACV,SAAS,EACT,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,WAAW,EACZ,MAAM,UAAU,CAAC;AAKlB,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,aAAa,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAMD,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAiB;IACxC,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,KAAK,CAAyD;IACtE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;gBAMvB,MAAM,EAAE,oBAAoB;WAW1B,WAAW,CAAC,MAAM,EAAE,oBAAoB,GAAG,cAAc;IAWvE,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,QAAQ;IAShB,OAAO,CAAC,QAAQ;IAeH,gBAAgB,CAAC,KAAK,GAAE,MAAW,GAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAyBxE,kBAAkB,CAC7B,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAC,GACxC,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAwB5B,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAwB1D,kBAAkB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC;QAC9D,IAAI,EAAE,SAAS,EAAE,CAAC;QAClB,OAAO,EAAE,MAAM,EAAE,CAAC;KACnB,CAAC;IAoCW,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;QACvD,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,EAAE,UAAU,EAAE,CAAC;QAC1B,OAAO,EAAE,YAAY,EAAE,CAAC;KACzB,CAAC;IAuCW,qBAAqB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC;QACjE,MAAM,EAAE,UAAU,EAAE,CAAC;QACrB,OAAO,EAAE,UAAU,EAAE,CAAC;KACvB,CAAC;IAqCW,uBAAuB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAmBrE,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IAmBzD,UAAU,IAAI,IAAI;IAOlB,SAAS,IAAI,aAAa;CAGlC"}