@basedone/core 0.1.8 → 0.2.0

package/lib/meta/data/testnet/spotMeta.json

@@ -10547,6 +10547,123 @@
       "name": "@1366",
       "index": 1366,
       "isCanonical": false
+    },
+    {
+      "tokens": [
+        1487,
+        0
+      ],
+      "name": "@1368",
+      "index": 1368,
+      "isCanonical": false
+    },
+    {
+      "tokens": [
+        1485,
+        0
+      ],
+      "name": "@1369",
+      "index": 1369,
+      "isCanonical": false
+    },
+    {
+      "tokens": [
+        1490,
+        0
+      ],
+      "name": "@1370",
+      "index": 1370,
+      "isCanonical": false
+    },
+    {
+      "tokens": [
+        1481,
+        0
+      ],
+      "name": "@1371",
+      "index": 1371,
+      "isCanonical": false
+    },
+    {
+      "tokens": [
+        1484,
+        0
+      ],
+      "name": "@1372",
+      "index": 1372,
+      "isCanonical": false
+    },
+    {
+      "tokens": [
+        1477,
+        1452
+      ],
+      "name": "@1373",
+      "index": 1373,
+      "isCanonical": false
+    },
+    {
+      "tokens": [
+        1492,
+        0
+      ],
+      "name": "@1374",
+      "index": 1374,
+      "isCanonical": false
+    },
+    {
+      "tokens": [
+        1469,
+        0
+      ],
+      "name": "@1375",
+      "index": 1375,
+      "isCanonical": false
+    },
+    {
+      "tokens": [
+        1,
+        1295
+      ],
+      "name": "@1376",
+      "index": 1376,
+      "isCanonical": true
+    },
+    {
+      "tokens": [
+        1493,
+        0
+      ],
+      "name": "@1377",
+      "index": 1377,
+      "isCanonical": false
+    },
+    {
+      "tokens": [
+        1105,
+        1493
+      ],
+      "name": "@1378",
+      "index": 1378,
+      "isCanonical": false
+    },
+    {
+      "tokens": [
+        1498,
+        0
+      ],
+      "name": "@1379",
+      "index": 1379,
+      "isCanonical": false
+    },
+    {
+      "tokens": [
+        1498,
+        1452
+      ],
+      "name": "@1380",
+      "index": 1380,
+      "isCanonical": false
     }
   ],
   "tokens": [
@@ -27088,7 +27205,10 @@
       "index": 1469,
       "tokenId": "0x8e670650571a3ce604ece184eaaf01c0",
       "isCanonical": false,
-      "evmContract": null,
+      "evmContract": {
+        "address": "0x03d7cd2d64de683e07f24fd857367d7492c85b22",
+        "evm_extra_wei_decimals": 10
+      },
       "fullName": null,
       "deployerTradingFeeShare": "1.0"
     },
@@ -27244,7 +27364,10 @@
       "index": 1481,
       "tokenId": "0x21a4632b44112fe0593fccbe5400a701",
       "isCanonical": false,
-      "evmContract": null,
+      "evmContract": {
+        "address": "0xed40d1ab429ff92ad66935766fb0f7025125b520",
+        "evm_extra_wei_decimals": 4
+      },
       "fullName": null,
       "deployerTradingFeeShare": "1.0"
     },
@@ -27280,7 +27403,10 @@
       "index": 1484,
       "tokenId": "0x57df584e21097424d758b228e842d2ef",
       "isCanonical": false,
-      "evmContract": null,
+      "evmContract": {
+        "address": "0xe04532bd84a7ee59599a90512a8fcc8484b546b5",
+        "evm_extra_wei_decimals": 10
+      },
       "fullName": null,
       "deployerTradingFeeShare": "1.0"
     },
@@ -27291,7 +27417,10 @@
       "index": 1485,
       "tokenId": "0x797f444bb03c7be19234b94ca29f3410",
       "isCanonical": false,
-      "evmContract": null,
+      "evmContract": {
+        "address": "0x2af50e43e313cfab0e7f46ac95106991cd9baea8",
+        "evm_extra_wei_decimals": 10
+      },
       "fullName": "STABLE",
       "deployerTradingFeeShare": "1.0"
     },
@@ -27313,7 +27442,10 @@
       "index": 1487,
       "tokenId": "0xd55b27dcaed90223bfc3c378b98526bb",
       "isCanonical": false,
-      "evmContract": null,
+      "evmContract": {
+        "address": "0xed3eb348853a670e3bb692dd5e654ad51c2f5128",
+        "evm_extra_wei_decimals": 10
+      },
       "fullName": "MONARCH TEST 1",
       "deployerTradingFeeShare": "1.0"
     },
@@ -27335,9 +27467,117 @@
       "index": 1489,
       "tokenId": "0x398e2bab402c7f3c9e214d3862d02ada",
       "isCanonical": false,
-      "evmContract": null,
+      "evmContract": {
+        "address": "0x000000000000780555bd0bca3791f89f9542c2d6",
+        "evm_extra_wei_decimals": 10
+      },
       "fullName": "They HYPE beta",
       "deployerTradingFeeShare": "1.0"
+    },
+    {
+      "name": "PP",
+      "szDecimals": 2,
+      "weiDecimals": 8,
+      "index": 1490,
+      "tokenId": "0xc7a956f1c1174545c713707d2ca67b76",
+      "isCanonical": false,
+      "evmContract": {
+        "address": "0x1fc9929be618ede69b1f71a69440165c885acadc",
+        "evm_extra_wei_decimals": 10
+      },
+      "fullName": "smol pp",
+      "deployerTradingFeeShare": "1.0"
+    },
+    {
+      "name": "SLIM",
+      "szDecimals": 2,
+      "weiDecimals": 8,
+      "index": 1491,
+      "tokenId": "0x45754dd4d3bb5517fa92dbbe8ccb6392",
+      "isCanonical": false,
+      "evmContract": {
+        "address": "0x719d4dee0fbefebbfbc837b2347840684b891916",
+        "evm_extra_wei_decimals": 10
+      },
+      "fullName": "The Real Slim Shady",
+      "deployerTradingFeeShare": "1.0"
+    },
+    {
+      "name": "USDZ",
+      "szDecimals": 2,
+      "weiDecimals": 8,
+      "index": 1492,
+      "tokenId": "0x7f8d334fed99e32ccc7d1ef50af5f246",
+      "isCanonical": false,
+      "evmContract": null,
+      "fullName": "Z Test Token",
+      "deployerTradingFeeShare": "1.0"
+    },
+    {
+      "name": "TUSDC",
+      "szDecimals": 2,
+      "weiDecimals": 8,
+      "index": 1493,
+      "tokenId": "0xa8469cf6df9c92f729a4bfa0f3643479",
+      "isCanonical": false,
+      "evmContract": null,
+      "fullName": "USDC Coin",
+      "deployerTradingFeeShare": "0.0"
+    },
+    {
+      "name": "MQVMJW",
+      "szDecimals": 1,
+      "weiDecimals": 9,
+      "index": 1494,
+      "tokenId": "0x202ec473e3100aac31d517c0a673ceaf",
+      "isCanonical": false,
+      "evmContract": null,
+      "fullName": "$WASH launchpad 2025-12-01T19:17:15.851Z",
+      "deployerTradingFeeShare": "1.0"
+    },
+    {
+      "name": "TSQEBL",
+      "szDecimals": 1,
+      "weiDecimals": 10,
+      "index": 1495,
+      "tokenId": "0x5d05f06a9590464cf3555a30d2d8ffd4",
+      "isCanonical": false,
+      "evmContract": null,
+      "fullName": "$WASH launchpad 2025-12-02T20:17:18.214Z",
+      "deployerTradingFeeShare": "1.0"
+    },
+    {
+      "name": "RNSZPK",
+      "szDecimals": 0,
+      "weiDecimals": 10,
+      "index": 1496,
+      "tokenId": "0x699de51e4fc0e6d7a6e450d2c3d92a1a",
+      "isCanonical": false,
+      "evmContract": null,
+      "fullName": "$WASH launchpad 2025-12-04T03:17:21.132Z",
+      "deployerTradingFeeShare": "1.0"
+    },
+    {
+      "name": "VENAHX",
+      "szDecimals": 1,
+      "weiDecimals": 9,
+      "index": 1497,
+      "tokenId": "0x43513901b952fcb6d8d5697ce17fa58f",
+      "isCanonical": false,
+      "evmContract": null,
+      "fullName": "$WASH launchpad 2025-12-05T10:17:24.096Z",
+      "deployerTradingFeeShare": "1.0"
+    },
+    {
+      "name": "LMB",
+      "szDecimals": 2,
+      "weiDecimals": 8,
+      "index": 1498,
+      "tokenId": "0x9f416264220c915ec41b6c4c0b11fab1",
+      "isCanonical": false,
+      "evmContract": null,
+      "fullName": "LMB",
+      "deployerTradingFeeShare": "1.0"
     }
   ]
 }

package/lib/meta/metadata.ts

@@ -2,12 +2,12 @@ import {
   HttpTransport,
   InfoClient,
   PerpsAssetCtx,
-  PerpsMeta,
   SpotMeta,
   SpotToken,
 } from "@nktkas/hyperliquid";
 import { isHip3Symbol } from "../hip3/utils";
 import type { Hex } from "@nktkas/hyperliquid/types";
+import type { PerpsMeta } from "./types";
 
 export interface PerpDex {
   /** Short name of the perpetual dex. */
@@ -48,6 +48,8 @@ export interface MarketInfo {
   dexDisplayName?: string; // Display name override for the DEX
   dexImageUrl?: string; // Image URL override for the DEX
   dexCollateralTokenSymbol?: string; // Collateral token symbol for HIP-3 markets
+
+  growthMode: boolean; // Whether the market is in growth mode
 }
 
 export interface DexInfo {
@@ -130,6 +132,7 @@ interface MetadataClientConfig {
  */
 export const ROOT_DEX = "hyperliquid";
 
+/**@deprecated use react sdk instead */
 export class MetadataClient {
   private infoClient: InfoClient;
   private config: MetadataClientConfig;
@@ -359,6 +362,7 @@ export class MetadataClient {
           szDecimals: market.szDecimals,
           type: "perps",
           maxLeverage: market.maxLeverage,
+          growthMode: market.growthMode === "enabled",
         };
 
         // Apply static metadata overrides for perps
@@ -410,6 +414,7 @@ export class MetadataClient {
           type: "spot",
           baseToken: baseToken,
           quoteToken: quoteToken,
+          growthMode: false,
         };
 
         // Apply static metadata overrides for spot
@@ -545,6 +550,7 @@ export class MetadataClient {
         dexDisplayName: dexInfo.displayName,
         dexImageUrl: dexInfo.imageUrl,
         dexCollateralTokenSymbol: dexInfo.collateralTokenSymbol,
+        growthMode: market.growthMode === "enabled",
       };
 
       // Apply static metadata overrides for HIP-3
@@ -648,6 +654,7 @@ export class MetadataClient {
       szDecimals: market.szDecimals,
       type: "perps",
       maxLeverage: market.maxLeverage,
+      growthMode: market.growthMode === "enabled",
     };
   }
 

package/lib/meta/types.ts

@@ -0,0 +1,36 @@
+import { MarginTables, PerpsAssetCtx } from "@nktkas/hyperliquid";
+
+export interface PerpsMeta {
+  /** Trading universes available for perpetual trading. */
+  universe: PerpsUniverse[];
+  /** Margin requirement tables for different leverage tiers. */
+  marginTables: MarginTables;
+  /** Collateral token index. */
+  collateralToken?: number;
+}
+/** Metadata and context for perpetual assets. */
+export type PerpsMetaAndAssetCtxs = [
+  /** Metadata for assets. */
+  PerpsMeta,
+  /** Context for each perpetual asset. */
+  PerpsAssetCtx[],
+];
+/** Trading universe parameters for perpetual assets. */
+export interface PerpsUniverse {
+  /** Minimum decimal places for order sizes. */
+  szDecimals: number;
+  /** Name of the universe. */
+  name: string;
+  /** Maximum allowed leverage. */
+  maxLeverage: number;
+  /** Unique identifier for the margin requirements table. */
+  marginTableId: number;
+  /** Indicates if only isolated margin trading is allowed. */
+  onlyIsolated?: true;
+  /** Indicates if the universe is delisted. */
+  isDelisted?: true;
+  /** Indicates if the universe is in growth mode, eligible for discounted fees */
+  growthMode?: "enabled";
+  /** Margin mode for the universe. */
+  marginMode?: "strictIsolated" | "noCross";
+}

package/lib/react/InstrumentProvider.tsx

@@ -0,0 +1,69 @@
+"use client";
+
+import { createContext, useContext, useMemo, type ReactNode } from "react";
+import { SpotMeta } from "@nktkas/hyperliquid";
+import { AllPerpsMeta } from "../hip3/market-info";
+import { InstrumentClient } from "../instrument/client";
+
+const InstrumentContext = createContext<InstrumentClient | null>(null);
+
+export interface InstrumentsProviderProps {
+  spotMeta: SpotMeta;
+  allPerpsMeta: AllPerpsMeta;
+  children: ReactNode;
+}
+
+/**
+ * Provides InstrumentClient to the React tree.
+ *
+ * @example
+ * ```tsx
+ * <InstrumentsProvider spotMeta={spotMeta} allPerpsMeta={allPerpsMeta}>
+ *   <App />
+ * </InstrumentsProvider>
+ * ```
+ */
+export function InstrumentsProvider({
+  spotMeta,
+  allPerpsMeta,
+  children,
+}: InstrumentsProviderProps) {
+  const client = useMemo(
+    () => new InstrumentClient(spotMeta, allPerpsMeta).init(),
+    [spotMeta, allPerpsMeta],
+  );
+
+  return (
+    <InstrumentContext.Provider value={client}>
+      {children}
+    </InstrumentContext.Provider>
+  );
+}
+
+/**
+ * Access the InstrumentClient from context.
+ * Must be used within an InstrumentsProvider.
+ *
+ * @example
+ * ```tsx
+ * const client = useInstruments();
+ * const btc = client.getInstrument("BTC");
+ * ```
+ */
+export function useInstruments(): InstrumentClient {
+  const client = useContext(InstrumentContext);
+  if (!client) {
+    throw new Error(
+      "useInstruments must be used within an InstrumentsProvider",
+    );
+  }
+  return client;
+}
+
+/**
+ * Access the InstrumentClient from context, returns null if not in provider.
+ * Useful for optional instrument access.
+ */
+export function useInstrumentsOptional(): InstrumentClient | null {
+  return useContext(InstrumentContext);
+}

package/lib/utils/flooredDateTime.ts

@@ -0,0 +1,55 @@
+// ====== UTC-only rounding utilities ======
+
+type RoundMode = 'floor' | 'round' | 'ceil';
+
+const MIN  = 60_000;
+const HOUR = 60 * MIN;
+const DAY  = 24 * HOUR;
+const WEEK = 7 * DAY;
+
+const opOf = (m: RoundMode) => m === 'ceil' ? Math.ceil : m === 'round' ? Math.round : Math.floor;
+
+interface UtcRoundOptions {
+  mode?: RoundMode;                 // default 'floor'
+  weekStartsOn?: 0|1|2|3|4|5|6;     // only used if stepMs % WEEK === 0; 0=Sun..6=Sat
+  anchorUtc?: number;               // custom UTC anchor (ms). Default 0 or computed for weekStartsOn
+}
+
+/**
+ * Higher-order UTC rounder.
+ * Snaps an instant t to the UTC grid defined by (anchorUtc + k*stepMs).
+ * Formula: anchor + step * op((t - anchor)/step)
+ */
+export function makeUtcRounder(stepMs: number, opts: UtcRoundOptions = {}) {
+  const mode = opts.mode ?? 'floor';
+  const op = opOf(mode);
+
+  // Determine anchor in UTC millis
+  let anchorUtc = opts.anchorUtc ?? 0;
+
+  // If weekly and weekStartsOn provided, anchor to the desired weekday at 00:00 UTC
+  if (stepMs % WEEK === 0 && opts.weekStartsOn !== undefined) {
+    // 1970-01-04T00:00:00Z was a Sunday in UTC
+    const sundayUTC = Date.UTC(1970, 0, 4);
+    anchorUtc = sundayUTC + opts.weekStartsOn * DAY; // e.g., 1 => Monday, 2 => Tuesday, etc.
+  }
+
+  return (t: Date): Date => {
+    const ts = t.getTime(); // UTC ms
+    const snapped = op((ts - anchorUtc) / stepMs) * stepMs + anchorUtc;
+    return new Date(snapped);
+  };
+}
+
+// ---------- Convenience helpers (UTC) ----------
+
+// Floor to arbitrary minute step (UTC)
+export const floorUtcMinutes = (stepMinutes: number) =>
+  makeUtcRounder(stepMinutes * MIN, { mode: 'floor' });
+
+// Floor to hour/day/week (UTC)
+export const floorUtcHour = () => makeUtcRounder(HOUR, { mode: 'floor' });
+export const floorUtcDay  = () => makeUtcRounder(DAY,  { mode: 'floor' });
+export const floorUtcWeek = (weekStartsOn: 0|1|2|3|4|5|6 = 1) =>
+  makeUtcRounder(WEEK, { mode: 'floor', weekStartsOn }); // default Monday-start
+

package/lib/utils/time.ts

@@ -0,0 +1,51 @@
+import { floorUtcWeek } from './flooredDateTime';
+
+export enum DayOfWeek {
+  Sunday = 0,
+  Monday = 1,
+  Tuesday = 2,
+  Wednesday = 3,
+  Thursday = 4,
+  Friday = 5,
+  Saturday = 6,
+}
+
+export interface WeekInfo {
+  weekNumber: number;
+  startDate: Date;
+  endDate: Date;
+}
+
+const WEEK_IN_MS = 7 * 24 * 60 * 60 * 1000;
+
+/**
+ * Gets the latest completed week information.
+ * 
+ * @param currentTimestamp - Optional timestamp in milliseconds. If not provided, uses current time.
+ * @param offset - Optional number of weeks to offset (0 = latest completed week, 1 = previous week, etc.)
+ * @param weekStartsOn - Day of week the week should start on. Defaults to Thursday.
+ * @returns WeekInfo with weekNumber, startDate, and endDate
+ */
+export function getLatestCompletedWeek(
+  currentTimestamp?: number,
+  offset: number = 0,
+  weekStartsOn: DayOfWeek = DayOfWeek.Thursday
+): WeekInfo {
+  const now = new Date(currentTimestamp ?? Date.now());
+
+  // floorUtcWeek floors to the beginning of the week on the specified day.
+  // This gives us the start of the *current* week, which is the end of the *last completed* week.
+  const floorToWeekStart = floorUtcWeek(weekStartsOn as 0|1|2|3|4|5|6);
+  const endDate = new Date(floorToWeekStart(now).getTime() - offset * WEEK_IN_MS);
+  
+  // The start date of the completed week is 7 days before the end date.
+  const startDate = new Date(endDate.getTime() - WEEK_IN_MS);
+
+  // Using a fixed point in time for week 1 calculation for consistency
+  const week1StartDate = new Date(process.env.WEEK1_START_DATE || "2025-12-04T00:00:00Z");
+  const msSinceWeek1 = startDate.getTime() - week1StartDate.getTime();
+  const weekNumber = Math.round(msSinceWeek1 / WEEK_IN_MS) + 1;
+
+  return { weekNumber, startDate, endDate };
+}
+

package/package.json

@@ -1,37 +1,63 @@
 {
   "name": "@basedone/core",
-  "version": "0.1.8",
+  "version": "0.2.0",
   "description": "Core utilities for Based One",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
   "source": "./index.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./react": {
+      "types": "./dist/react.d.ts",
+      "import": "./dist/react.mjs",
+      "require": "./dist/react.js"
+    },
+    "./ecommerce": {
+      "types": "./dist/ecommerce.d.ts",
+      "import": "./dist/ecommerce.mjs",
+      "require": "./dist/ecommerce.js"
+    }
+  },
   "files": [
     "dist",
     "index.ts",
+    "react.ts",
+    "ecommerce.ts",
     "lib"
   ],
-  "scripts": {
-    "build": "rm -rf dist && tsup index.ts --format cjs,esm --dts",
-    "dev": "tsup index.ts --format cjs,esm --dts --watch",
-    "test": "vitest",
-    "update-meta": "tsx scripts/update-static-meta.ts",
-    "prepublishOnly": "pnpm build"
-  },
   "keywords": [],
   "author": "",
   "license": "ISC",
-  "packageManager": "pnpm@10.10.0",
   "devDependencies": {
+    "@types/node": "^20.0.0",
+    "@types/react": "^18.0.0",
     "tsup": "^8.5.0",
     "tsx": "^4.19.2",
     "typescript": "^5.0.0",
     "vitest": "^3.2.4"
   },
   "dependencies": {
+    "axios": "^1.6.0",
     "decimal.js": "^10.6.0"
   },
   "peerDependencies": {
-    "@nktkas/hyperliquid": "^0.24.3"
+    "@nktkas/hyperliquid": "^0.24.3",
+    "react": "^18.0.0 || ^19.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsup index.ts react.ts ecommerce.ts --format cjs,esm --dts",
+    "dev": "tsup index.ts react.ts ecommerce.ts --format cjs,esm --dts --watch",
+    "test": "vitest",
+    "update-meta": "tsx scripts/update-static-meta.ts"
   }
-}
+}

package/react.ts

@@ -0,0 +1 @@
+export * from "./lib/react/InstrumentProvider";