@sodax/dapp-kit 1.2.3-beta → 1.2.5-beta

package/README.md

@@ -266,7 +266,8 @@ const { data: hasWithdrawAllowed, isLoading: isWithdrawAllowanceLoading } = useM
   };
 
   // Get user's supplied assets
-  const userReserves = useUserReservesData(chainId);
+  const { address } = useXAccount(chainId);
+  const { data: userReserves } = useUserReservesData({ spokeChainId: chainId, userAddress: address });
 }
 
 // Wallet Address Derivation

package/dist/index.d.mts

@@ -316,17 +316,29 @@ interface WithdrawResponse {
  */
 declare function useWithdraw(): UseMutationResult<WithdrawResponse, MoneyMarketError<'CREATE_WITHDRAW_INTENT_FAILED' | 'WITHDRAW_UNKNOWN_ERROR' | RelayErrorCode>, UseWithdrawParams>;
 
-type UseUserReservesDataParams = {
+type BaseQueryOptions$1 = {
+    queryOptions?: UseQueryOptions<readonly [readonly UserReserveData[], number], Error>;
+};
+type NewParams$1 = BaseQueryOptions$1 & {
+    /** Spoke chain id (e.g. '0xa86a.avax') */
+    spokeChainId: SpokeChainId$1 | undefined;
+    /** User wallet address on the spoke chain */
+    userAddress: string | undefined;
+};
+/** @deprecated Use `{ spokeChainId, userAddress }` instead */
+type LegacyParams$1 = BaseQueryOptions$1 & {
+    /** @deprecated Use `spokeChainId` instead */
     spokeProvider: SpokeProvider | undefined;
+    /** @deprecated Use `userAddress` instead */
     address: string | undefined;
-    queryOptions?: UseQueryOptions<readonly [readonly UserReserveData[], number], Error>;
 };
+type UseUserReservesDataParams = NewParams$1 | LegacyParams$1;
 /**
  * Hook for fetching user reserves data from the Sodax money market.
  *
  * @param params (optional) - Object including:
- *   - spokeProvider: The SpokeProvider instance required for data fetching. If not provided, data fetching is disabled.
- *   - address: The user's address (string) whose reserves data will be fetched. If not provided, data fetching is disabled.
+ *   - spokeChainId: The spoke chain id whose reserves data will be fetched. If not provided, data fetching is disabled.
+ *   - userAddress: The user's address (string) whose reserves data will be fetched. If not provided, data fetching is disabled.
  *   - queryOptions: (optional) Custom React Query options such as `queryKey`, `enabled`, or cache policy.
  *
  * @returns {UseQueryResult<readonly [readonly UserReserveData[], number], Error>} React Query result object containing:
@@ -337,8 +349,8 @@ type UseUserReservesDataParams = {
  *
  * @example
  * const { data: userReservesData, isLoading, error } = useUserReservesData({
- *   spokeProvider,
- *   address,
+ *   spokeChainId,
+ *   userAddress,
  * });
  */
 declare function useUserReservesData(params?: UseUserReservesDataParams): UseQueryResult<readonly [readonly UserReserveData[], number], Error>;
@@ -516,26 +528,30 @@ declare function useReservesUsdFormat(params?: UseReservesUsdFormatParams): UseQ
     priceInMarketReferenceCurrency: string;
 } & FormatReserveUSDResponse)[], Error>;
 
-type UseUserFormattedSummaryParams = {
-    spokeProvider?: SpokeProvider;
-    address?: string;
+type BaseQueryOptions = {
     queryOptions?: UseQueryOptions<FormatUserSummaryResponse<FormatReserveUSDResponse>, Error>;
 };
+type NewParams = BaseQueryOptions & {
+    /** Spoke chain id (e.g. '0xa86a.avax') */
+    spokeChainId: SpokeChainId$1 | undefined;
+    /** User wallet address on the spoke chain */
+    userAddress: string | undefined;
+};
+/** @deprecated Use `{ spokeChainId, userAddress }` instead */
+type LegacyParams = BaseQueryOptions & {
+    /** @deprecated Use `spokeChainId` instead */
+    spokeProvider: SpokeProvider | undefined;
+    /** @deprecated Use `userAddress` instead */
+    address: string | undefined;
+};
+type UseUserFormattedSummaryParams = NewParams | LegacyParams;
 /**
  * React hook to fetch a formatted summary of a user's Sodax money market portfolio.
  *
- * Accepts an optional params object:
- *   - `spokeProvider`: The SpokeProvider instance for the target chain
- *   - `address`: The user wallet address to get the summary for
- *   - `queryOptions`: Optional React Query options (key, caching, intervals, etc)
- *
- * The hook returns a React Query result object containing the formatted summary, loading and error state.
- * The query is enabled only if both the spokeProvider and address are provided.
- *
- * @param params Optional parameters:
- *   - spokeProvider: SpokeProvider to query chain data (required for enabled query)
- *   - address: User account address (required for enabled query)
- *   - queryOptions: React Query options for customization (optional)
+ * @param params (optional) - Object including:
+ *   - spokeChainId: The spoke chain id whose data will be fetched. If not provided, data fetching is disabled.
+ *   - userAddress: The user's address (string) whose summary will be fetched. If not provided, data fetching is disabled.
+ *   - queryOptions: (optional) Custom React Query options such as `queryKey`, `enabled`, or cache policy.
  *
  * @returns {UseQueryResult<FormatUserSummaryResponse<FormatReserveUSDResponse>, Error>}
  *   A result object from React Query including:
@@ -545,7 +561,7 @@ type UseUserFormattedSummaryParams = {
  *     - error: Error if thrown in fetching
  *
  * @example
- * const { data, isLoading, error } = useUserFormattedSummary({ spokeProvider, address });
+ * const { data, isLoading, error } = useUserFormattedSummary({ spokeChainId, userAddress });
  */
 declare function useUserFormattedSummary(params?: UseUserFormattedSummaryParams): UseQueryResult<FormatUserSummaryResponse<FormatReserveUSDResponse>, Error>;
 

package/dist/index.d.ts

@@ -316,17 +316,29 @@ interface WithdrawResponse {
  */
 declare function useWithdraw(): UseMutationResult<WithdrawResponse, MoneyMarketError<'CREATE_WITHDRAW_INTENT_FAILED' | 'WITHDRAW_UNKNOWN_ERROR' | RelayErrorCode>, UseWithdrawParams>;
 
-type UseUserReservesDataParams = {
+type BaseQueryOptions$1 = {
+    queryOptions?: UseQueryOptions<readonly [readonly UserReserveData[], number], Error>;
+};
+type NewParams$1 = BaseQueryOptions$1 & {
+    /** Spoke chain id (e.g. '0xa86a.avax') */
+    spokeChainId: SpokeChainId$1 | undefined;
+    /** User wallet address on the spoke chain */
+    userAddress: string | undefined;
+};
+/** @deprecated Use `{ spokeChainId, userAddress }` instead */
+type LegacyParams$1 = BaseQueryOptions$1 & {
+    /** @deprecated Use `spokeChainId` instead */
     spokeProvider: SpokeProvider | undefined;
+    /** @deprecated Use `userAddress` instead */
     address: string | undefined;
-    queryOptions?: UseQueryOptions<readonly [readonly UserReserveData[], number], Error>;
 };
+type UseUserReservesDataParams = NewParams$1 | LegacyParams$1;
 /**
  * Hook for fetching user reserves data from the Sodax money market.
  *
  * @param params (optional) - Object including:
- *   - spokeProvider: The SpokeProvider instance required for data fetching. If not provided, data fetching is disabled.
- *   - address: The user's address (string) whose reserves data will be fetched. If not provided, data fetching is disabled.
+ *   - spokeChainId: The spoke chain id whose reserves data will be fetched. If not provided, data fetching is disabled.
+ *   - userAddress: The user's address (string) whose reserves data will be fetched. If not provided, data fetching is disabled.
  *   - queryOptions: (optional) Custom React Query options such as `queryKey`, `enabled`, or cache policy.
  *
  * @returns {UseQueryResult<readonly [readonly UserReserveData[], number], Error>} React Query result object containing:
@@ -337,8 +349,8 @@ type UseUserReservesDataParams = {
  *
  * @example
  * const { data: userReservesData, isLoading, error } = useUserReservesData({
- *   spokeProvider,
- *   address,
+ *   spokeChainId,
+ *   userAddress,
  * });
  */
 declare function useUserReservesData(params?: UseUserReservesDataParams): UseQueryResult<readonly [readonly UserReserveData[], number], Error>;
@@ -516,26 +528,30 @@ declare function useReservesUsdFormat(params?: UseReservesUsdFormatParams): UseQ
     priceInMarketReferenceCurrency: string;
 } & FormatReserveUSDResponse)[], Error>;
 
-type UseUserFormattedSummaryParams = {
-    spokeProvider?: SpokeProvider;
-    address?: string;
+type BaseQueryOptions = {
     queryOptions?: UseQueryOptions<FormatUserSummaryResponse<FormatReserveUSDResponse>, Error>;
 };
+type NewParams = BaseQueryOptions & {
+    /** Spoke chain id (e.g. '0xa86a.avax') */
+    spokeChainId: SpokeChainId$1 | undefined;
+    /** User wallet address on the spoke chain */
+    userAddress: string | undefined;
+};
+/** @deprecated Use `{ spokeChainId, userAddress }` instead */
+type LegacyParams = BaseQueryOptions & {
+    /** @deprecated Use `spokeChainId` instead */
+    spokeProvider: SpokeProvider | undefined;
+    /** @deprecated Use `userAddress` instead */
+    address: string | undefined;
+};
+type UseUserFormattedSummaryParams = NewParams | LegacyParams;
 /**
  * React hook to fetch a formatted summary of a user's Sodax money market portfolio.
  *
- * Accepts an optional params object:
- *   - `spokeProvider`: The SpokeProvider instance for the target chain
- *   - `address`: The user wallet address to get the summary for
- *   - `queryOptions`: Optional React Query options (key, caching, intervals, etc)
- *
- * The hook returns a React Query result object containing the formatted summary, loading and error state.
- * The query is enabled only if both the spokeProvider and address are provided.
- *
- * @param params Optional parameters:
- *   - spokeProvider: SpokeProvider to query chain data (required for enabled query)
- *   - address: User account address (required for enabled query)
- *   - queryOptions: React Query options for customization (optional)
+ * @param params (optional) - Object including:
+ *   - spokeChainId: The spoke chain id whose data will be fetched. If not provided, data fetching is disabled.
+ *   - userAddress: The user's address (string) whose summary will be fetched. If not provided, data fetching is disabled.
+ *   - queryOptions: (optional) Custom React Query options such as `queryKey`, `enabled`, or cache policy.
  *
  * @returns {UseQueryResult<FormatUserSummaryResponse<FormatReserveUSDResponse>, Error>}
  *   A result object from React Query including:
@@ -545,7 +561,7 @@ type UseUserFormattedSummaryParams = {
  *     - error: Error if thrown in fetching
  *
  * @example
- * const { data, isLoading, error } = useUserFormattedSummary({ spokeProvider, address });
+ * const { data, isLoading, error } = useUserFormattedSummary({ spokeChainId, userAddress });
  */
 declare function useUserFormattedSummary(params?: UseUserFormattedSummaryParams): UseQueryResult<FormatUserSummaryResponse<FormatReserveUSDResponse>, Error>;
 

package/dist/index.js

@@ -257,11 +257,24 @@ function useWithdraw() {
     }
   });
 }
+function isLegacyParams(params) {
+  return "spokeProvider" in params || "address" in params;
+}
+function resolveParams(params) {
+  if (isLegacyParams(params)) {
+    return {
+      spokeChainId: params.spokeProvider?.chainConfig.chain.id,
+      userAddress: params.address
+    };
+  }
+  return { spokeChainId: params.spokeChainId, userAddress: params.userAddress };
+}
 function useUserReservesData(params) {
   const { sodax } = useSodaxContext();
+  const resolved = params ? resolveParams(params) : { spokeChainId: void 0, userAddress: void 0 };
   const defaultQueryOptions = {
-    queryKey: ["mm", "userReservesData", params?.spokeProvider?.chainConfig.chain.id, params?.address],
-    enabled: !!params?.spokeProvider && !!params?.address,
+    queryKey: ["mm", "userReservesData", resolved.spokeChainId, resolved.userAddress],
+    enabled: !!resolved.spokeChainId && !!resolved.userAddress,
     refetchInterval: 5e3
   };
   const queryOptions = {
@@ -272,10 +285,10 @@ function useUserReservesData(params) {
   return reactQuery.useQuery({
     ...queryOptions,
     queryFn: async () => {
-      if (!params?.spokeProvider || !params?.address) {
-        throw new Error("Spoke provider or address is not defined");
+      if (!resolved.spokeChainId || !resolved.userAddress) {
+        throw new Error("spokeChainId or userAddress is not defined");
       }
-      return await sodax.moneyMarket.data.getUserReservesData(params.spokeProvider);
+      return await sodax.moneyMarket.data.getUserReservesData(resolved.spokeChainId, resolved.userAddress);
     }
   });
 }
@@ -433,11 +446,24 @@ function useReservesUsdFormat(params) {
     }
   });
 }
+function isLegacyParams2(params) {
+  return "spokeProvider" in params || "address" in params;
+}
+function resolveParams2(params) {
+  if (isLegacyParams2(params)) {
+    return {
+      spokeChainId: params.spokeProvider?.chainConfig.chain.id,
+      userAddress: params.address
+    };
+  }
+  return { spokeChainId: params.spokeChainId, userAddress: params.userAddress };
+}
 function useUserFormattedSummary(params) {
   const { sodax } = useSodaxContext();
+  const resolved = params ? resolveParams2(params) : { spokeChainId: void 0, userAddress: void 0 };
   const defaultQueryOptions = {
-    queryKey: ["mm", "userFormattedSummary", params?.spokeProvider?.chainConfig.chain.id, params?.address],
-    enabled: !!params?.spokeProvider && !!params?.address,
+    queryKey: ["mm", "userFormattedSummary", resolved.spokeChainId, resolved.userAddress],
+    enabled: !!resolved.spokeChainId && !!resolved.userAddress,
     refetchInterval: 5e3
   };
   const queryOptions = {
@@ -448,14 +474,17 @@ function useUserFormattedSummary(params) {
   return reactQuery.useQuery({
     ...queryOptions,
     queryFn: async () => {
-      if (!params?.spokeProvider || !params?.address) {
-        throw new Error("Spoke provider or address is not defined");
+      if (!resolved.spokeChainId || !resolved.userAddress) {
+        throw new Error("spokeChainId or userAddress is not defined");
       }
       const reserves = await sodax.moneyMarket.data.getReservesHumanized();
       const formattedReserves = sodax.moneyMarket.data.formatReservesUSD(
         sodax.moneyMarket.data.buildReserveDataWithPrice(reserves)
       );
-      const userReserves = await sodax.moneyMarket.data.getUserReservesHumanized(params?.spokeProvider);
+      const userReserves = await sodax.moneyMarket.data.getUserReservesHumanized(
+        resolved.spokeChainId,
+        resolved.userAddress
+      );
       return sodax.moneyMarket.data.formatUserSummary(
         sodax.moneyMarket.data.buildUserSummaryRequest(reserves, formattedReserves, userReserves)
       );