@evefrontier/dapp-kit 0.1.0 → 0.1.2

package/hooks/useSponsoredTransaction.ts

@@ -17,7 +17,7 @@ import {
   type SponsoredTransactionOutput,
   SponsoredTransactionArgs,
 } from "../wallet";
-import { SponsoredTransactionActions } from "../types";
+import { QueryParams, SponsoredTransactionActions } from "../types";
 
 /** Wallet-like shape from dApp Kit (UiWallet or connection store). */
 type ResolvableWallet = {
@@ -74,6 +74,58 @@ export class WalletNoAccountSelectedError extends Error {
   }
 }
 
+/**
+ * Error thrown when assembly ID cannot be resolved or is invalid.
+ * Assembly ID must come from the assembly object (item_id) or the URL query param (itemId), and must be a valid non-negative integer.
+ *
+ * @category Errors
+ */
+export class AssemblyIdRequiredError extends Error {
+  constructor(reason?: string) {
+    super(
+      reason ??
+        "Assembly ID is required: pass an assembly object with item_id or set the itemId query param to a valid non-negative integer",
+    );
+    this.name = "AssemblyIdRequiredError";
+  }
+}
+
+// ============================================================================
+// Assembly ID resolution
+// ============================================================================
+
+/**
+ * Resolves assembly ID to a non-negative integer from the assembly object or query param.
+ * Fails fast with {@link AssemblyIdRequiredError} if neither source provides a valid id.
+ */
+function resolveAssemblyId(
+  assemblyItemId: number | undefined,
+  queryItemId: string | null,
+): number {
+  const fromAssembly =
+    typeof assemblyItemId === "number" &&
+    Number.isInteger(assemblyItemId) &&
+    assemblyItemId >= 0
+      ? assemblyItemId
+      : undefined;
+
+  if (fromAssembly !== undefined) {
+    return fromAssembly;
+  }
+
+  if (queryItemId != null && queryItemId.trim() !== "") {
+    const parsed = parseInt(queryItemId.trim(), 10);
+    if (Number.isNaN(parsed) || parsed < 0) {
+      throw new AssemblyIdRequiredError(
+        `Query param itemId must be a non-negative integer; got "${queryItemId}"`,
+      );
+    }
+    return parsed;
+  }
+
+  throw new AssemblyIdRequiredError();
+}
+
 // ============================================================================
 // Hook Types
 // ============================================================================
@@ -87,6 +139,7 @@ export type UseSponsoredTransactionError =
   | WalletSponsoredTransactionNotSupportedError
   | WalletNotConnectedError
   | WalletNoAccountSelectedError
+  | AssemblyIdRequiredError
   | Error;
 
 /**
@@ -129,10 +182,9 @@ export type UseSponsoredTransactionMutationOptions = Omit<
  * **Input** (passed to `mutate` / `mutateAsync`):
  * - `txAction` (required) – The sponsored action to run (e.g. BRING_ONLINE, BRING_OFFLINE).
  * - `chain` (required) – Sui chain id, e.g. `"sui:testnet"` or `"sui:mainnet"`.
- * - `ownerId` (required) – Assembly owner ID.
- * - `assembly` (optional) – Assembly ID; omit to use context-specific default.
- * - `destination` (optional) – Destination for gate linking (LINK_SMART_GATE / UNLINK_SMART_GATE).
- * - `account` (optional) – Signer account override; defaults to current connected account.
+ * - `assembly` (required) – Full assembly object (`AssemblyType<Assemblies>`). Must include `type` and `item_id` (number). If `item_id` is missing or invalid, the hook falls back to the URL query param `itemId` (parsed as a non-negative integer). Fails with {@link AssemblyIdRequiredError} if neither source provides a valid id.
+ * - `tenant` (optional) – Tenant ID. When omitted, the hook resolves it from the URL query param (e.g. `tenant`) with fallback to `"testevenet"`. Pass explicitly to override.
+ * - `account` (optional) – Signer address. If omitted, the currently connected wallet account is used.
  *
  * **Output** (on success, in `data` or resolved from `mutateAsync`):
  * - `digest` (required) – Transaction digest.
@@ -152,21 +204,23 @@ export type UseSponsoredTransactionMutationOptions = Omit<
  * @throws {WalletNotConnectedError} If no wallet is connected
  * @throws {WalletNoAccountSelectedError} If no account is selected
  * @throws {WalletSponsoredTransactionNotSupportedError} If wallet doesn't support sponsored transactions
+ * @throws {AssemblyIdRequiredError} If assembly ID is missing or invalid (neither assembly.item_id nor itemId query param is a valid non-negative integer)
  *
  * @example Basic bring online transaction
  * ```tsx
- * import { useSponsoredTransaction, SponsoredTransactionActions } from "@evefrontier/dapp-kit";
+ * import { useSponsoredTransaction, SponsoredTransactionActions, useSmartObject } from "@evefrontier/dapp-kit";
  *
  * const BringOnlineButton = () => {
+ *   const { assembly } = useSmartObject();
  *   const { mutateAsync: sendTx, isPending } = useSponsoredTransaction();
  *
  *   const handleBringOnline = async () => {
+ *     if (!assembly) return;
  *     try {
  *       const result = await sendTx({
  *         txAction: SponsoredTransactionActions.BRING_ONLINE,
- *         assembly: "0x123...",
+ *         assembly,
  *         chain: "sui:testnet",
- *         ownerId: "0x...",
  *       });
  *       console.log("Transaction digest:", result.digest);
  *     } catch (error) {
@@ -175,7 +229,7 @@ export type UseSponsoredTransactionMutationOptions = Omit<
  *   };
  *
  *   return (
- *     <button onClick={handleBringOnline} disabled={isPending}>
+ *     <button onClick={handleBringOnline} disabled={isPending || !assembly}>
  *       {isPending ? "Processing..." : "Bring Online"}
  *     </button>
  *   );
@@ -184,13 +238,13 @@ export type UseSponsoredTransactionMutationOptions = Omit<
  *
  * @example With callbacks
  * ```tsx
+ * const { assembly } = useSmartObject();
  * const { mutate: sendTx } = useSponsoredTransaction();
  *
  * sendTx(
  *   {
  *     txAction: SponsoredTransactionActions.BRING_ONLINE,
- *     assembly: "0x123...",
- *     ownerId: "0x...",
+ *     assembly,
  *     chain: "sui:testnet",
  *   },
  *   {
@@ -204,13 +258,13 @@ export type UseSponsoredTransactionMutationOptions = Omit<
  * );
  * ```
  *
- * @example With assembly
+ * @example With assembly and optional account
  * ```tsx
  * const result = await sendTx({
  *   txAction: SponsoredTransactionActions.BRING_ONLINE,
+ *   assembly, // full AssemblyType from useSmartObject() or similar
  *   chain: "sui:testnet",
- *   ownerId: "0x...",
- *   assembly: "0x123...",
+ *   account: "0x...", // optional; defaults to connected wallet account
  * });
  * ```
  *
@@ -230,6 +284,10 @@ export function useSponsoredTransaction({
   const wallets = useWallets();
   const currentAccount = useCurrentAccount();
 
+  const queryParams = new URLSearchParams(window.location.search);
+  const queryItemId = queryParams.get(QueryParams.ITEM_ID);
+  const queryTenant = queryParams.get(QueryParams.TENANT);
+
   return useMutation({
     mutationKey: [
       "evefrontier",
@@ -308,14 +366,25 @@ export function useSponsoredTransaction({
         );
       }
 
+      const tenant = (args.tenant ?? queryTenant ?? "testevenet").trim();
+      if (!tenant) {
+        throw new Error(
+          "Tenant could not be resolved; pass tenant or set the tenant query param",
+        );
+      }
+
+      const assemblyId = resolveAssemblyId(args.assembly.item_id, queryItemId);
+
       const payload: SponsoredTransactionInput = {
         txAction: args.txAction,
-        assembly: args.assembly.item_id,
+        assembly: assemblyId,
         assemblyType: getAssemblyTypeApiString(args.assembly.type),
         chain: args.chain,
-        ...(args.destination != null ? { destination: args.destination } : {}),
+        tenant,
       };
 
+      console.log("payload", payload);
+
       return await signSponsoredTransaction(payload);
     },
     ...mutationOptions,

package/index.ts

@@ -31,14 +31,6 @@ export {
   NotificationContext,
 } from "./providers";
 
-// Types from providers
-export type {
-  VaultContextType,
-  SmartObjectContextType,
-  NotificationContextType,
-  NotificationState,
-} from "./providers";
-
 // =========================================
 // Types (re-exported from ./types)
 // =========================================
@@ -145,7 +137,6 @@ export {
 // Wallet Standard Extensions
 // =========================================
 export {
-  EVEFRONTIER_SPONSORED_TRANSACTION,
   getAssemblyTypeApiString,
   hasSponsoredTransactionFeature,
   walletSupportsSponsoredTransaction,
@@ -155,7 +146,6 @@ export {
 export type {
   EveFrontierSponsoredTransactionFeature,
   SponsoredTransactionArgs,
-  SponsoredTransactionAssemblyType,
   SponsoredTransactionInput,
   SponsoredTransactionOutput,
   SponsoredTransactionMethod,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evefrontier/dapp-kit",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "React SDK for EVE Frontier dApps on Sui",
   "main": "index.ts",
   "author": "",

package/providers/NotificationProvider.tsx

@@ -1,26 +1,7 @@
 import { ReactNode, createContext, useCallback, useState } from "react";
 
 import { Severity } from "../types";
-
-/** @category Types */
-export interface NotificationState {
-  message: string;
-  txHash: string;
-  severity: Severity;
-  handleClose: () => void;
-  isOpen: boolean;
-}
-
-/** @category Types */
-export interface NotificationContextType {
-  notify: (notification: {
-    type: Severity;
-    txHash?: string;
-    message?: string;
-  }) => void;
-  notification: NotificationState;
-  handleClose: () => void;
-}
+import { NotificationContextType, NotificationState } from "../types";
 
 /** @category Providers */
 export const NotificationContext = createContext<NotificationContextType>({

package/providers/SmartObjectProvider.tsx

@@ -23,26 +23,24 @@ import {
 } from "../utils";
 import { getDatahubGameInfo } from "../utils/datahub";
 import { useConnection } from "../hooks/useConnection";
+import { SmartObjectContextType } from "../types";
 
-/** @category Types */
-export interface SmartObjectContextType {
-  assembly: AssemblyType<Assemblies> | null;
-  character: DetailedSmartCharacterResponse | null;
-  selectedObjectId: string;
-  loading: boolean;
-  error: string | null;
-  setSelectedObjectId: (id: string) => void;
-  refetch: () => Promise<void>;
-}
+/** Tenant when not provided via URL ?tenant= (e.g. dev/default chain). */
+const DEFAULT_TENANT = "testevenet";
+
+/** Input for fetching object data: either itemId + tenant (derive object ID) or a Sui object ID directly.
+ * @category Types
+ */
+export type FetchObjectDataInput =
+  | { itemId: string; selectedTenant: string }
+  | { objectId: string };
 
 /** @category Providers */
 export const SmartObjectContext = createContext<SmartObjectContextType>({
   assembly: null,
   character: null,
-  selectedObjectId: "",
   loading: true,
   error: null,
-  setSelectedObjectId: () => {},
   refetch: async () => {},
 });
 
@@ -66,6 +64,7 @@ const SmartObjectProvider = ({ children }: { children: ReactNode }) => {
     useState<DetailedSmartCharacterResponse | null>(null);
   const [selectedObjectId, setSelectedObjectId] = useState<string>("");
   const [selectedTenant, setSelectedTenant] = useState<string>("");
+  const [isObjectIdDirect, setIsObjectIdDirect] = useState<boolean>(false); // Whether selectedObjectId is a Sui object ID or derived from itemId + tenant.
   const [loading, setLoading] = useState<boolean>(true);
   const [error, setError] = useState<string | null>(null);
 
@@ -74,10 +73,16 @@ const SmartObjectProvider = ({ children }: { children: ReactNode }) => {
 
   const { isConnected } = useConnection();
 
-  // Fetch object data with owner/character info
+  // Fetch object data with owner/character info.
+  // Accepts either { itemId, selectedTenant } (derive Sui object ID) or { objectId } (use directly).
   const fetchObjectData = useCallback(
-    async (itemId: string, selectedTenant: string, isInitialFetch = false) => {
-      if (!itemId || !selectedTenant) return;
+    async (input: FetchObjectDataInput, isInitialFetch = false) => {
+      const hasItemId = "itemId" in input && "selectedTenant" in input;
+      if (hasItemId) {
+        if (!input.itemId || !input.selectedTenant) return;
+      } else {
+        if (!input.objectId) return;
+      }
 
       if (isInitialFetch) {
         setLoading(true);
@@ -85,17 +90,22 @@ const SmartObjectProvider = ({ children }: { children: ReactNode }) => {
       setError(null);
 
       try {
+        const objectId = hasItemId
+          ? await getObjectId(input.itemId, input.selectedTenant)
+          : input.objectId;
         console.log(
-          "[DappKit] SmartObjectProvider: Fetching object with item ID and tenant:",
-          itemId,
-          selectedTenant,
+          "[DappKit] SmartObjectProvider: Fetching object:",
+          hasItemId
+            ? { itemId: input.itemId, selectedTenant: input.selectedTenant }
+            : { objectId },
         );
 
-        const objectId = await getObjectId(itemId, selectedTenant);
-
         // Fetch both assembly and character data
-        const { moveObject, character: characterInfo } =
-          await getAssemblyWithOwner(objectId);
+        const {
+          moveObject,
+          character: characterInfo,
+          energySource,
+        } = await getAssemblyWithOwner(objectId);
 
         if (!moveObject) {
           console.warn(
@@ -111,6 +121,7 @@ const SmartObjectProvider = ({ children }: { children: ReactNode }) => {
         const dataHash = JSON.stringify({
           moveObject,
           character: characterInfo,
+          energySource,
         });
 
         // Only update state if the data changed (optimization for polling)
@@ -142,6 +153,7 @@ const SmartObjectProvider = ({ children }: { children: ReactNode }) => {
             {
               character: characterInfo,
               datahubInfo,
+              energySource: energySource,
             },
           );
 
@@ -168,54 +180,40 @@ const SmartObjectProvider = ({ children }: { children: ReactNode }) => {
     [],
   );
 
-  // Initialize the object ID from env or query params
+  // Initialize the object ID (env or query params) and tenant (query params).
+  // Tenant comes from URL ?tenant= with fallback DEFAULT_TENANT.
   useEffect(() => {
     console.log("[DappKit] SmartObjectProvider: Checking for item ID");
 
+    const queryParams = new URLSearchParams(window.location.search);
+    const queryTenant =
+      queryParams.get(QueryParams.TENANT)?.trim() || DEFAULT_TENANT;
+
     // Check if an object ID exists in the .env file
-    const envItemId = import.meta.env.VITE_ITEM_ID;
-    const envTenant = import.meta.env.VITE_EVE_WORLD_TENANT;
+    const envObjectId = import.meta.env.VITE_OBJECT_ID;
 
-    if (envItemId) {
+    if (envObjectId) {
       console.log(
-        "[DappKit] SmartObjectProvider: Using item ID from env:",
-        envItemId,
+        "[DappKit] SmartObjectProvider: Using Sui object ID from env:",
+        envObjectId,
       );
-      setSelectedObjectId(envItemId);
-
-      if (envTenant) {
-        console.log(
-          "[DappKit] SmartObjectProvider: Using tenant from env:",
-          envTenant,
-        );
-        setSelectedTenant(envTenant);
-      } else {
-        console.error(
-          "[DappKit] SmartObjectProvider: VITE_ITEM_ID is set but VITE_EVE_WORLD_TENANT is missing. " +
-            "Both are required when using env-based configuration.",
-        );
-        setLoading(false);
-      }
+      setSelectedObjectId(envObjectId);
+      setSelectedTenant(queryTenant);
+      setIsObjectIdDirect(true);
       return;
     }
 
-    // Check if an object ID has been passed via query param
-    const queryParams = new URLSearchParams(window.location.search);
+    // Else, derive object ID from item ID and tenant and passed via query param
     const queryItemId = queryParams.get(QueryParams.ITEM_ID);
-    const queryTenant = queryParams.get(QueryParams.TENANT);
 
     if (queryItemId) {
       setSelectedObjectId(queryItemId);
+      setSelectedTenant(queryTenant);
+      setIsObjectIdDirect(false);
     } else {
       console.error("[DappKit] SmartObjectProvider: No object ID provided");
       setLoading(false);
     }
-
-    if (queryTenant) {
-      setSelectedTenant(queryTenant);
-    } else {
-      console.error("[DappKit] SmartObjectProvider: No tenant provided");
-    }
   }, []);
 
   // Fetch and poll for object data
@@ -227,12 +225,16 @@ const SmartObjectProvider = ({ children }: { children: ReactNode }) => {
       return;
     }
 
+    const input: FetchObjectDataInput = isObjectIdDirect
+      ? { objectId: selectedObjectId }
+      : { itemId: selectedObjectId, selectedTenant };
+
     // Initial fetch
-    fetchObjectData(selectedObjectId, selectedTenant, true);
+    fetchObjectData(input, true);
 
     // Set up polling
     pollingRef.current = setInterval(() => {
-      fetchObjectData(selectedObjectId, selectedTenant, false);
+      fetchObjectData(input, false);
     }, POLLING_INTERVAL);
 
     console.log(
@@ -248,29 +250,29 @@ const SmartObjectProvider = ({ children }: { children: ReactNode }) => {
       }
       lastDataHashRef.current = null;
     };
-  }, [selectedObjectId, isConnected, fetchObjectData]);
-
-  const handleSetSelectedObjectId = useCallback((id: string) => {
-    console.log("[DappKit] SmartObjectProvider: Setting new object ID:", id);
-    lastDataHashRef.current = null;
-    setSelectedObjectId(id);
-  }, []);
+  }, [
+    selectedObjectId,
+    selectedTenant,
+    isObjectIdDirect,
+    isConnected,
+    fetchObjectData,
+  ]);
 
   const handleRefetch = useCallback(async () => {
-    if (selectedObjectId) {
-      await fetchObjectData(selectedObjectId, selectedTenant, true);
-    }
-  }, [selectedObjectId, selectedTenant, fetchObjectData]);
+    if (!selectedObjectId) return;
+    const input: FetchObjectDataInput = isObjectIdDirect
+      ? { objectId: selectedObjectId }
+      : { itemId: selectedObjectId, selectedTenant };
+    await fetchObjectData(input, true);
+  }, [selectedObjectId, selectedTenant, isObjectIdDirect, fetchObjectData]);
 
   return (
     <SmartObjectContext.Provider
       value={{
         assembly,
         character,
-        selectedObjectId,
         loading,
         error,
-        setSelectedObjectId: handleSetSelectedObjectId,
         refetch: handleRefetch,
       }}
     >

package/providers/VaultProvider.tsx

@@ -4,18 +4,8 @@ import {
   useWallets,
   useDAppKit,
 } from "@mysten/dapp-kit-react";
-import type { WalletAccount } from "@mysten/wallet-standard";
-import { STORAGE_KEYS } from "../utils/constants";
-
-/** @category Types */
-export interface VaultContextType {
-  currentAccount: WalletAccount | null;
-  walletAddress: string | undefined;
-  hasEveVault: boolean;
-  isConnected: boolean;
-  handleConnect: () => void;
-  handleDisconnect: () => void;
-}
+import { STORAGE_KEYS } from "../utils";
+import { SupportedWallets, VaultContextType } from "../types";
 
 /** @category Providers */
 export const VaultContext = createContext<VaultContextType>({
@@ -44,8 +34,10 @@ const VaultProvider = ({ children }: { children: ReactNode }) => {
   const wallets = useWallets();
 
   // Find Eve Vault wallet if available
-  const eveVaultWallet = wallets.find((wallet) =>
-    wallet.name.includes("Eve Vault"),
+  const eveVaultWallet = wallets.find(
+    (wallet) =>
+      wallet.name.includes(SupportedWallets.EVE_FRONTIER_CLIENT_WALLET) ||
+      wallet.name.includes(SupportedWallets.EVE_VAULT),
   );
 
   // Track if auto-connect has been attempted to prevent infinite loops

package/providers/index.ts

@@ -1,17 +1,10 @@
 export { default as EveFrontierProvider } from "./EveFrontierProvider";
-export {
-  default as VaultProvider,
-  VaultContext,
-  type VaultContextType,
-} from "./VaultProvider";
+export { default as VaultProvider, VaultContext } from "./VaultProvider";
 export {
   default as SmartObjectProvider,
   SmartObjectContext,
-  type SmartObjectContextType,
 } from "./SmartObjectProvider";
 export {
   default as NotificationProvider,
   NotificationContext,
-  type NotificationContextType,
-  type NotificationState,
 } from "./NotificationProvider";

package/types/contexts.ts

@@ -0,0 +1,55 @@
+import { WalletAccount } from "@mysten/wallet-standard";
+import {
+  Assemblies,
+  AssemblyType,
+  DetailedSmartCharacterResponse,
+  Severity,
+} from "./types";
+
+/**
+ * Vault Context Type
+ * @category Types */
+export interface VaultContextType {
+  currentAccount: WalletAccount | null;
+  walletAddress: string | undefined;
+  hasEveVault: boolean;
+  isConnected: boolean;
+  handleConnect: () => void;
+  handleDisconnect: () => void;
+}
+
+export enum SupportedWallets {
+  EVE_VAULT = "Eve Vault",
+  EVE_FRONTIER_CLIENT_WALLET = "EVE Frontier Client Wallet",
+}
+
+/**
+ * Smart Object Context Type
+ * @category Types */
+export interface SmartObjectContextType {
+  assembly: AssemblyType<Assemblies> | null;
+  character: DetailedSmartCharacterResponse | null;
+  loading: boolean;
+  error: string | null;
+  refetch: () => Promise<void>;
+}
+
+/** @category Types */
+export interface NotificationContextType {
+  notify: (notification: {
+    type: Severity;
+    txHash?: string;
+    message?: string;
+  }) => void;
+  notification: NotificationState;
+  handleClose: () => void;
+}
+
+/** @category Types */
+export interface NotificationState {
+  message: string;
+  txHash: string;
+  severity: Severity;
+  handleClose: () => void;
+  isOpen: boolean;
+}

package/types/index.ts

@@ -1,4 +1,4 @@
 export * from "./types";
 export * from "./worldApiReturnTypes";
 export * from "./sponsoredTransaction";
-
+export * from "./contexts";

package/types/sponsoredTransaction.ts

@@ -2,6 +2,7 @@ import {
   SponsoredTransactionArgs,
   SponsoredTransactionOutput,
 } from "../wallet";
+import { Assemblies } from "./types";
 
 /**
  * Available sponsored transaction actions
@@ -24,3 +25,37 @@ export type SendSponsoredTransactionFn = (
     onError?: (error: Error) => void;
   },
 ) => Promise<SponsoredTransactionOutput>;
+
+// ============================================================================
+// Feature Identifiers
+// ============================================================================
+
+/**
+ * Feature identifier for sponsored transactions.
+ * Wallets implementing this feature can request gas sponsorship from
+ * the EVE Frontier sponsored-transaction backend service.
+ *
+ * @category Wallet
+ */
+export const EVEFRONTIER_SPONSORED_TRANSACTION =
+  "evefrontier:sponsoredTransaction" as const;
+
+// ============================================================================
+// Sponsored Transaction Types
+// ============================================================================
+
+/**
+ * Map assembly types to API strings
+ */
+export const ASSEMBLY_TYPE_API_STRING: Record<Assemblies, string> = {
+  [Assemblies.SmartStorageUnit]: "storage-units",
+  [Assemblies.SmartTurret]: "turrets",
+  [Assemblies.SmartGate]: "gates",
+  [Assemblies.NetworkNode]: "network-nodes",
+  [Assemblies.Manufacturing]: "manufacturing",
+  [Assemblies.Refinery]: "refineries",
+} as const;
+
+/** API slug for assembly type in sponsored transaction payloads (e.g. "storage-units"). */
+export type SponsoredTransactionAssemblyType =
+  (typeof ASSEMBLY_TYPE_API_STRING)[Assemblies];