@sodax/dapp-kit 0.0.1-rc.27 → 0.0.1-rc.29

package/README.md

@@ -41,6 +41,8 @@ dApp Kit is a collection of React components, hooks, and utilities designed to s
 
 - Shared
   - Derive user wallet address for hub abstraction (`useDeriveUserWalletAddress`)
+  - Check if Stellar trustline is established for an asset (`useStellarTrustlineCheck`)
+  - Request creation of Stellar trustline line for an asset (`useRequestTrustline`)
 
 ## Installation
 
@@ -66,6 +68,17 @@ pnpm install @sodax/dapp-kit @tanstack/react-query @sodax/wallet-sdk-react
 import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
 import { SodaxWalletProvider } from '@sodax/wallet-sdk-react';
 import { SodaxProvider } from '@sodax/dapp-kit';
+import {
+  ARBITRUM_MAINNET_CHAIN_ID,
+  AVALANCHE_MAINNET_CHAIN_ID,
+  BASE_MAINNET_CHAIN_ID,
+  BSC_MAINNET_CHAIN_ID,
+  OPTIMISM_MAINNET_CHAIN_ID,
+  POLYGON_MAINNET_CHAIN_ID,
+  SONIC_MAINNET_CHAIN_ID,
+  HYPEREVM_MAINNET_CHAIN_ID,
+  LIGHTLINK_MAINNET_CHAIN_ID,
+} from '@sodax/types';
 
 const queryClient = new QueryClient();
 
@@ -80,7 +93,18 @@ function App() {
         <SodaxWalletProvider
           config={{
             EVM: {
-              wagmiConfig: wagmiConfig,
+              // Add all the EVM chains you want to support
+              chains: [
+                ARBITRUM_MAINNET_CHAIN_ID,
+                AVALANCHE_MAINNET_CHAIN_ID,
+                BASE_MAINNET_CHAIN_ID,
+                BSC_MAINNET_CHAIN_ID,
+                OPTIMISM_MAINNET_CHAIN_ID,
+                POLYGON_MAINNET_CHAIN_ID,
+                SONIC_MAINNET_CHAIN_ID,
+                HYPEREVM_MAINNET_CHAIN_ID,
+                LIGHTLINK_MAINNET_CHAIN_ID,
+              ],
             },
             SUI: {
               isMainnet: true,

package/dist/hooks/shared/index.d.ts

@@ -1,4 +1,6 @@
 export * from './useSodaxContext';
 export * from './useEstimateGas';
 export * from './useDeriveUserWalletAddress';
+export * from './useStellarTrustlineCheck';
+export * from './useRequestTrustline';
 //# sourceMappingURL=index.d.ts.map

package/dist/hooks/shared/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/shared/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,8BAA8B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/shared/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,uBAAuB,CAAC"}

package/dist/hooks/shared/useRequestTrustline.d.ts

@@ -0,0 +1,44 @@
+import { type SpokeProvider, StellarSpokeProvider, type TxReturnType } from '@sodax/sdk';
+import { type UseMutationResult } from '@tanstack/react-query';
+/**
+ * React hook to request a Stellar trustline for a given token and amount.
+ *
+ * This hook provides a mutation for requesting a trustline on the Stellar network
+ * using the provided SpokeProvider. It is intended for use with StellarSpokeProvider
+ * and will throw if used with a non-Stellar provider. Upon success, it invalidates
+ * the trustline check query to ensure UI reflects the updated trustline state.
+ *
+ * @template T - The type of SpokeProvider, defaults to SpokeProvider.
+ * @param {string | undefined} token - The Stellar asset code or token address for which to request a trustline.
+ * @returns {UseMutationResult<TxReturnType<StellarSpokeProvider, false>, Error, { token: string; amount: bigint; spokeProvider: T }>}
+ *   A React Query mutation result object containing:
+ *   - `mutate`/`mutateAsync`: Function to trigger the trustline request.
+ *   - `data`: The transaction result if successful.
+ *   - `error`: Any error encountered during the request.
+ *   - `isLoading`: Whether the mutation is in progress.
+ *   - Other React Query mutation state.
+ *
+ * @example
+ * ```tsx
+ * import { useRequestTrustline } from '@sodax/dapp-kit';
+ *
+ * const { mutate: requestTrustline, isLoading, error, data } = useRequestTrustline('USDC-G...TOKEN');
+ *
+ * // To request a trustline:
+ * requestTrustline({
+ *   token: 'USDC-G...TOKEN',
+ *   amount: 10000000n,
+ *   spokeProvider: stellarProvider,
+ * });
+ *
+ * if (isLoading) return <span>Requesting trustline...</span>;
+ * if (error) return <span>Error: {error.message}</span>;
+ * if (data) return <span>Trustline requested! Tx: {data.txHash}</span>;
+ * ```
+ */
+export declare function useRequestTrustline<T extends SpokeProvider = SpokeProvider>(token: string | undefined): UseMutationResult<TxReturnType<StellarSpokeProvider, false>, Error, {
+    token: string;
+    amount: bigint;
+    spokeProvider: T;
+}>;
+//# sourceMappingURL=useRequestTrustline.d.ts.map

package/dist/hooks/shared/useRequestTrustline.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRequestTrustline.d.ts","sourceRoot":"","sources":["../../../src/hooks/shared/useRequestTrustline.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,oBAAoB,EAAuB,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAC9G,OAAO,EAAe,KAAK,iBAAiB,EAAkB,MAAM,uBAAuB,CAAC;AAE5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AAEH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,aAAa,GAAG,aAAa,EACzE,KAAK,EAAE,MAAM,GAAG,SAAS,GACxB,iBAAiB,CAClB,YAAY,CAAC,oBAAoB,EAAE,KAAK,CAAC,EACzC,KAAK,EACL;IACE,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,CAAC,CAAC;CAClB,CACF,CA+BA"}

package/dist/hooks/shared/useStellarTrustlineCheck.d.ts

@@ -0,0 +1,40 @@
+import type { SpokeChainId, SpokeProvider } from '@sodax/sdk';
+import { type UseQueryResult } from '@tanstack/react-query';
+/**
+ * React hook to check if a Stellar account has a sufficient trustline for a given token and amount.
+ *
+ * This hook queries the Stellar network (via the provided SpokeProvider) to determine
+ * whether the account has established a trustline for the specified token and if the trustline
+ * is sufficient for the intended amount. It is useful for gating UI actions that require
+ * a trustline to be present and funded.
+ *
+ * @template T - The type of SpokeProvider, defaults to SpokeProvider.
+ * @param {string | undefined} token - The Stellar asset code or token address to check the trustline for.
+ * @param {bigint | undefined} amount - The minimum amount required for the trustline.
+ * @param {T | undefined} spokeProvider - The provider instance for interacting with the Stellar network.
+ * @param {SpokeChainId | undefined} chainId - The chain ID to determine if the check should be performed (only on Stellar mainnet).
+ * @returns {UseQueryResult<boolean, Error>} A React Query result object containing:
+ *   - `data`: `true` if the trustline exists and is sufficient, `false` otherwise.
+ *   - `error`: Any error encountered during the check.
+ *   - `isLoading`: Whether the query is in progress.
+ *   - Other React Query state.
+ *
+ * @example
+ * ```tsx
+ * import { useStellarTrustlineCheck } from '@sodax/dapp-kit';
+ *
+ * const { data: hasTrustline, isLoading, error } = useStellarTrustlineCheck(
+ *   'USDC-G...TOKEN',
+ *   10000000n,
+ *   stellarProvider,
+ *   'stellar'
+ * );
+ *
+ * if (isLoading) return <span>Checking trustline...</span>;
+ * if (error) return <span>Error: {error.message}</span>;
+ * if (!hasTrustline) return <span>Trustline not established or insufficient.</span>;
+ * return <span>Trustline is sufficient!</span>;
+ * ```
+ */
+export declare function useStellarTrustlineCheck<T extends SpokeProvider = SpokeProvider>(token: string | undefined, amount: bigint | undefined, spokeProvider: T | undefined, chainId: SpokeChainId | undefined): UseQueryResult<boolean, Error>;
+//# sourceMappingURL=useStellarTrustlineCheck.d.ts.map

package/dist/hooks/shared/useStellarTrustlineCheck.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useStellarTrustlineCheck.d.ts","sourceRoot":"","sources":["../../../src/hooks/shared/useStellarTrustlineCheck.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC9D,OAAO,EAAY,KAAK,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AAEH,wBAAgB,wBAAwB,CAAC,CAAC,SAAS,aAAa,GAAG,aAAa,EAC9E,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,aAAa,EAAE,CAAC,GAAG,SAAS,EAC5B,OAAO,EAAE,YAAY,GAAG,SAAS,GAChC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAwBhC"}

package/dist/hooks/swap/useQuote.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useQuote.d.ts","sourceRoot":"","sources":["../../../src/hooks/swap/useQuote.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEnH,OAAO,EAAY,KAAK,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,eAAO,MAAM,QAAQ,YACV,wBAAwB,GAAG,SAAS,KAC5C,cAAc,CAAC,MAAM,CAAC,yBAAyB,EAAE,mBAAmB,CAAC,GAAG,SAAS,CAanF,CAAC"}
+{"version":3,"file":"useQuote.d.ts","sourceRoot":"","sources":["../../../src/hooks/swap/useQuote.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEnH,OAAO,EAAY,KAAK,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAGtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,eAAO,MAAM,QAAQ,YACV,wBAAwB,GAAG,SAAS,KAC5C,cAAc,CAAC,MAAM,CAAC,yBAAyB,EAAE,mBAAmB,CAAC,GAAG,SAAS,CA0BnF,CAAC"}

package/dist/hooks/swap/useSwap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useSwap.d.ts","sourceRoot":"","sources":["../../../src/hooks/swap/useSwap.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,kBAAkB,EAClB,uBAAuB,EACvB,MAAM,EACN,eAAe,EACf,MAAM,EACN,WAAW,EACX,aAAa,EACb,kBAAkB,EACnB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAe,KAAK,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE5E,KAAK,kBAAkB,GAAG,MAAM,CAAC,CAAC,uBAAuB,EAAE,MAAM,EAAE,kBAAkB,CAAC,EAAE,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC;AAEtH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,OAAO,CACrB,aAAa,EAAE,aAAa,GAAG,SAAS,GACvC,iBAAiB,CAAC,kBAAkB,EAAE,KAAK,EAAE,kBAAkB,CAAC,CAclE"}
+{"version":3,"file":"useSwap.d.ts","sourceRoot":"","sources":["../../../src/hooks/swap/useSwap.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,kBAAkB,EAClB,uBAAuB,EACvB,MAAM,EACN,eAAe,EACf,MAAM,EACN,WAAW,EACX,aAAa,EACb,kBAAkB,EACnB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAe,KAAK,iBAAiB,EAAkB,MAAM,uBAAuB,CAAC;AAE5F,KAAK,kBAAkB,GAAG,MAAM,CAAC,CAAC,uBAAuB,EAAE,MAAM,EAAE,kBAAkB,CAAC,EAAE,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC;AAEtH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,OAAO,CACrB,aAAa,EAAE,aAAa,GAAG,SAAS,GACvC,iBAAiB,CAAC,kBAAkB,EAAE,KAAK,EAAE,kBAAkB,CAAC,CAmBlE"}

package/dist/hooks/swap/useSwapAllowance.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useSwapAllowance.d.ts","sourceRoot":"","sources":["../../../src/hooks/swap/useSwapAllowance.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEtE,OAAO,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEpE;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,kBAAkB,GAAG,SAAS,EACtC,aAAa,EAAE,aAAa,GAAG,SAAS,GACvC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAoBhC"}
+{"version":3,"file":"useSwapAllowance.d.ts","sourceRoot":"","sources":["../../../src/hooks/swap/useSwapAllowance.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEtE,OAAO,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEpE;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,kBAAkB,GAAG,SAAS,EACtC,aAAa,EAAE,aAAa,GAAG,SAAS,GACvC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAqBhC"}

package/dist/index.js

@@ -44,6 +44,48 @@ function useDeriveUserWalletAddress(spokeProvider, walletAddress) {
     // This is a deterministic operation, no need to refetch
   });
 }
+function useStellarTrustlineCheck(token, amount, spokeProvider, chainId) {
+  return reactQuery.useQuery({
+    queryKey: ["stellar-trustline-check", token],
+    queryFn: async () => {
+      if (chainId !== sdk.STELLAR_MAINNET_CHAIN_ID) {
+        return true;
+      }
+      if (!spokeProvider || !token || !amount || !(spokeProvider instanceof sdk.StellarSpokeProvider)) {
+        console.error(
+          "Spoke provider, token or amount not found. Details: spokeProvider:",
+          spokeProvider,
+          "token:",
+          token,
+          "amount:",
+          amount
+        );
+        return false;
+      }
+      const response = await sdk.StellarSpokeService.hasSufficientTrustline(token, amount, spokeProvider);
+      return response;
+    },
+    enabled: !!spokeProvider && !!token && !!amount
+  });
+}
+function useRequestTrustline(token) {
+  const queryClient = reactQuery.useQueryClient();
+  return reactQuery.useMutation({
+    mutationFn: async ({
+      token: token2,
+      amount,
+      spokeProvider
+    }) => {
+      if (!spokeProvider || !token2 || !amount || !(spokeProvider instanceof sdk.StellarSpokeProvider)) {
+        throw new Error("Spoke provider, token or amount not found");
+      }
+      return sdk.StellarSpokeService.requestTrustline(token2, amount, spokeProvider);
+    },
+    onSuccess: () => {
+      queryClient.invalidateQueries({ queryKey: ["stellar-trustline-check", token] });
+    }
+  });
+}
 
 // src/hooks/provider/useHubProvider.ts
 function useHubProvider() {
@@ -289,8 +331,18 @@ function useMMApprove(token, spokeProvider) {
 }
 var useQuote = (payload) => {
   const { sodax } = useSodaxContext();
+  const queryKey = React.useMemo(() => {
+    if (!payload) return ["quote", void 0];
+    return [
+      "quote",
+      {
+        ...payload,
+        amount: payload.amount.toString()
+      }
+    ];
+  }, [payload]);
   return reactQuery.useQuery({
-    queryKey: [payload],
+    queryKey,
     queryFn: async () => {
       if (!payload) {
         return void 0;
@@ -303,6 +355,7 @@ var useQuote = (payload) => {
 };
 function useSwap(spokeProvider) {
   const { sodax } = useSodaxContext();
+  const queryClient = reactQuery.useQueryClient();
   return reactQuery.useMutation({
     mutationFn: async (params) => {
       if (!spokeProvider) {
@@ -312,6 +365,9 @@ function useSwap(spokeProvider) {
         intentParams: params,
         spokeProvider
       });
+    },
+    onSuccess: () => {
+      queryClient.invalidateQueries({ queryKey: ["xBalances"] });
     }
   });
 }
@@ -343,7 +399,8 @@ function useSwapAllowance(params, spokeProvider) {
       }
       return false;
     },
-    enabled: !!spokeProvider && !!params
+    enabled: !!spokeProvider && !!params,
+    refetchInterval: 2e3
   });
 }
 function useSwapApprove(params, spokeProvider) {
@@ -372,7 +429,7 @@ function useSwapApprove(params, spokeProvider) {
       return allowance.ok;
     },
     onSuccess: () => {
-      queryClient.invalidateQueries({ queryKey: ["allowance", params?.inputToken] });
+      queryClient.invalidateQueries({ queryKey: ["allowance", params] });
     }
   });
   return {
@@ -667,10 +724,12 @@ exports.useMMAllowance = useMMAllowance;
 exports.useMMApprove = useMMApprove;
 exports.useQuote = useQuote;
 exports.useRepay = useRepay;
+exports.useRequestTrustline = useRequestTrustline;
 exports.useReservesData = useReservesData;
 exports.useSodaxContext = useSodaxContext;
 exports.useSpokeProvider = useSpokeProvider;
 exports.useStatus = useStatus;
+exports.useStellarTrustlineCheck = useStellarTrustlineCheck;
 exports.useSupply = useSupply;
 exports.useSwap = useSwap;
 exports.useSwapAllowance = useSwapAllowance;