graz 0.1.0-alpha.1 → 0.1.0-alpha.2

package/dist/index.d.ts

@@ -479,8 +479,11 @@ interface UseAccountArgs {
     onDisconnect?: () => void;
 }
 /**
- * graz query hook to retrieve account data with optional arguments to invoke
- * given function on connect/disconnect.
+ * graz query hook to retrieve account data
+ *
+ * @param chainId - if provided, it will only return the data of the given chainId
+ * @param onConnect - callback function when the account is connected
+ * @param onDisconnect - callback function when the account is disconnected
  *
  * @example
  * ```tsx
@@ -502,6 +505,10 @@ type UseConnectChainArgs = MutationEventArgs<ConnectArgs, ConnectResult>;
  * graz mutation hook to execute wallet connection with optional arguments to
  * invoke given functions on error, loading, or success event.
  *
+ * @param onError - callback function when the connection is failed
+ * @param onLoading - callback function when the connection is loading
+ * @param onSuccess - callback function when the connection is successful
+ *
  * @example
  * ```ts
  * import { useConnect, mainnetChains } from "graz";
@@ -545,6 +552,10 @@ declare const useConnect: ({ onError, onLoading, onSuccess }?: UseConnectChainAr
  * graz mutation hook to execute wallet disconnection with optional arguments to
  * invoke given functions on error, loading, or success event.
  *
+ * @param onError - callback function when the disconnection is failed
+ * @param onLoading - callback function when the disconnection is loading
+ * @param onSuccess - callback function when the disconnection is successful
+ *
  * @example
  * ```ts
  * import { useDisconnect } from "graz";
@@ -559,8 +570,11 @@ declare const useConnect: ({ onError, onLoading, onSuccess }?: UseConnectChainAr
  *   onSuccess: () => { ... },
  * });
  *
- * // pass `true` on disconnect to clear recent connected chain
- * disconnect(true);
+ * //disconnect all chains
+ * disconnect();
+ *
+ * //disconnect specific chains
+ * disconnect({ chainid: ["cosmoshub-4", "juno-1"] });
  * ```
  *
  * @see {@link disconnect}
@@ -580,12 +594,21 @@ declare const useDisconnect: ({ onError, onLoading, onSuccess }?: MutationEventA
 /**
  * graz hook to retrieve offline signer objects (default, amino enabled, and auto).
  *
- * Note: signer objects is initialized after connecting an account.
+ * @param chainId - chain id arguments
+ *
+ * @returns if chainId is string it will return an object, otherwise it will return a record of objects
  *
  * @example
  * ```ts
  * import { useOfflineSigners } from "graz";
- * const { signer, signerAmino, signerAuto } = useOfflineSigners();
+ *
+ * // single chain
+ * const { offlineSigner, offlineSignerAmino, offlineSignerAuto } = useOfflineSigners({ chainId: "cosmoshub-4" });
+ *
+ * // multi chain
+ * const offlineSigners = useOfflineSigners();
+ * offlineSigners["cosmoshub-4"].offlineSignerAuto;
+ *
  * ```
  */
 declare const useOfflineSigners: <T extends ChainIdArgs>(args?: T | undefined) => UseQueryResult<HookResultDataWithChainId<OfflineSigners, T> | undefined>;
@@ -619,8 +642,6 @@ declare const useActiveChainValidators: <T extends QueryClient & StakingExtensio
  *   connect(recentChain);
  * }
  * ```
- *
- * @see {@link useActiveChain}
  */
 declare const useRecentChain: () => {
     data: string[] | null;
@@ -691,6 +712,16 @@ declare const useSuggestChainAndConnect: ({ onError, onLoading, onSuccess }?: Us
     suggestAndConnect: _tanstack_react_query.UseMutateFunction<ConnectResult, unknown, SuggestChainAndConnectArgs, unknown>;
     suggestAndConnectAsync: _tanstack_react_query.UseMutateAsyncFunction<ConnectResult, unknown, SuggestChainAndConnectArgs, unknown>;
 };
+/**
+ * graz hook to retrieve chain data and usefull functions with given chainId
+ * @param chainId - Chain ID string
+ *
+ * @example
+ * ```ts
+ * import { useChain } from "graz";
+ * const { data: chain } = useChain("cosmoshub-4");
+ * ```
+ */
 declare const useChain: ({ chainId }: {
     chainId: string;
 }) => {
@@ -703,17 +734,25 @@ declare const useChain: ({ chainId }: {
 } | undefined;
 
 /**
- * graz query hook to retrieve a CosmWasmClient, StargateClient and Tendermint34Client. If there's no given arguments it will be using the current connected client
+ * graz query hook to retrieve a CosmWasmClient or StargateClient or Tendermint34Client.
+ *
+ * @param client - if provided, it will use the given client instead of the default client
+ * @param chainId - if provided, it will only return the data of the given chainId
+ * @param onlyConnectedChains - if true, it will only return the client of the current connected chains
+ * @param enabled - if false, it will not fetch the data
+ *
+ * @returns if chainId is string it will return an object, otherwise it will return a record of objects
  *
  * @example
  * ```ts
  * import { useClient } from "graz";
  *
- * // use connected client's cosmwasm client
- * const { data, isFetching, refetch, ... } = useClient();
+ * // single chain
+ * const { data, isLoading, ... } = useClient({ client: "stargate" chainId: "cosmoshub-4" });
+ *
+ * // all chains from GrazProvider example
+ * const { data, isLoading, ... } = useClient({ client: "stargate" });
  *
- * // initialize new custom client from given arguments
- * useClient({ rpc: "https://rpc.cosmoshub.strange.love", });
  * ```
  */
 declare const useConnectClient: <T extends Clients, U extends ChainIdArgs>(args?: ({
@@ -726,21 +765,24 @@ declare const useConnectClient: <T extends Clients, U extends ChainIdArgs>(args?
     enabled?: boolean | undefined;
 } & U) | undefined) => UseQueryResult<HookResultDataWithChainId<ConnectClient<T>, U> | undefined>;
 /**
- * graz query hook to retrieve a SigningCosmWasmClient. If there's no given args it will be using the current connected signer
+ * graz query hook to retrieve a SigningCosmWasmClient or SigningStargateClient.
+ *
+ * @param client - if provided, it will use the given client instead of the default client
+ * @param chainId - if provided, it will only return the data of the given chainId
+ * @param options - signing client options of given client
+ *
+ * @returns if chainId is string it will return an object, otherwise it will return a record of objects
  *
  * @example
  * ```ts
  * import { useSigningClient } from "graz";
  *
- * // get connected client's cosmwasm client
- * const { data, isFetching, refetch, ... } = useSigningClient();
+ * // single chain
+ * const { data, isLoading, ... } = useSigningClient({ client: "stargate" chainId: "cosmoshub-4" });
+ *
+ * // all chains from GrazProvider example
+ * const { data, isLoading, ... } = useSigningClient({ client: "stargate" });
  *
- * // initialize new custom client with given args
- * useSigningClient({
- *   rpc: "https://rpc.cosmoshub.strange.love",
- *   offlineSigner: customOfflineSigner,
- *   ...
- * });
  * ```
  */
 declare const useConnectSigningClient: <T extends SigningClients, U extends ChainIdArgs>(args?: ({
@@ -781,6 +823,8 @@ declare const useBalance: <T extends "cosmWasm" | "stargate">(args: {
  * @param chainId - Optional chainId to retrieve the balances from given address and chainId, if not provided will return all balances currencies from all chains provided from GrazProvider
  * @param client - Optional client, if not provided will use the default client
  *
+ * @returns if chainId is string it will return an object, otherwise it will return a record of objects
+ *
  * @example
  * ```ts
  * import { useAllBalances } from "graz";
@@ -809,6 +853,8 @@ declare const useAllBalances: <U extends ChainIdArgs>(args: {
  * @param client - Optional client, if not provided will use the default client
  * @param chainId - Optional chainId to retrieve the balances from given address and chainId, if not provided will return all balances currencies from all chains provided from GrazProvider
  *
+ * @returns if chainId is string it will return an object, otherwise it will return a record of objects
+ *
  * @example
  * ```ts
  * import { useChainBalances } from "graz";
@@ -837,6 +883,8 @@ declare const useChainBalances: <T extends "cosmWasm" | "stargate", U extends Ch
  * @param bech32Address - Optional bech32 account address, if not provided will return undefined
  * @param chainId - Optional chainId to retrieve the balances from given address and chainId, if not provided will return all balances currencies from all chains provided from GrazProvider
  *
+ * @returns if chainId is string it will return an object, otherwise it will return a record of objects
+ *
  * @example
  * ```ts
  * import { useBalanceStaked } from "graz";

package/dist/index.js

@@ -2507,39 +2507,18 @@ var useDisconnect = ({ onError, onLoading, onSuccess } = {}) => {
 };
 var useOfflineSigners = (args) => {
   const accounts = useAccount();
-  const { data } = (0, import_react_query2.useQuery)(
-    ["OFFLINE_SIGNERS", { accounts }],
-    async () => {
-      if (!accounts)
-        return void 0;
-      const connectedChainIds = Object.values(accounts).map((i) => i == null ? void 0 : i.chainId).filter(Boolean);
-      const res = {};
-      await Promise.all(
-        connectedChainIds.map(async (_chainId) => {
-          const signers = await getOfflineSigners({
-            chainId: _chainId
-          });
-          res[_chainId] = signers;
-        })
-      );
-      return res;
-    },
-    {
-      enabled: Boolean(accounts)
-    }
-  );
   const query = (0, import_react_query2.useQuery)(
     [
       "USE_OFFLINE_SIGNERS",
       {
         args,
-        offlineSigners: data
+        accounts
       }
     ],
     async () => {
-      if (!data)
+      if (!accounts)
         return void 0;
-      const connectedChainIds = Object.keys(data).map(([chainId]) => chainId).filter((i) => i);
+      const connectedChainIds = Object.keys(accounts).map(([chainId]) => chainId).filter(Boolean);
       if (args == null ? void 0 : args.chainId) {
         const offlineSigners = await getOfflineSigners({
           chainId: args.chainId
@@ -2557,7 +2536,7 @@ var useOfflineSigners = (args) => {
       );
       return res;
     },
-    { enabled: Boolean(data), refetchOnMount: false, refetchOnWindowFocus: false }
+    { enabled: Boolean(accounts), refetchOnMount: false, refetchOnWindowFocus: false }
   );
   return query;
 };
@@ -2650,7 +2629,7 @@ var useConnectClient = (args) => {
   const chains = (args == null ? void 0 : args.onlyConnectedChains) ? sessionChains : _chains;
   const query = (0, import_react_query4.useQuery)(
     [
-      "USE_CLIENTS",
+      "USE_CONNECT_CLIENT",
       {
         client: _client,
         chainId: args == null ? void 0 : args.chainId,
@@ -2697,7 +2676,7 @@ var useConnectSigningClient = (args) => {
   const singleChain = _chains == null ? void 0 : _chains.find((i) => i.chainId === (args == null ? void 0 : args.chainId));
   const sessionChains = sessionChainIds == null ? void 0 : sessionChainIds.map((i) => _chains.find((x) => x.chainId === i));
   const queryKey = [
-    "USE_SIGNING_CLIENTS",
+    "USE_CONNECT_SIGNING_CLIENT",
     { client: _client, chainId: args == null ? void 0 : args.chainId, options: args == null ? void 0 : args.options }
   ];
   const query = (0, import_react_query4.useQuery)(
@@ -2769,7 +2748,7 @@ var useBalance = (args) => {
   });
   const query = (0, import_react_query5.useQuery)(
     [
-      "USE_BALANCES",
+      "USE_BALANCE",
       {
         client,
         ...args,
@@ -2809,7 +2788,7 @@ var useAllBalances = (args) => {
   });
   const query = (0, import_react_query5.useQuery)(
     [
-      "USE_BALANCES",
+      "USE_ALL_BALANCES",
       {
         singleClient,
         multiClient,
@@ -2868,7 +2847,7 @@ var useChainBalances = (args) => {
   });
   const query = (0, import_react_query5.useQuery)(
     [
-      "USE_BALANCES",
+      "USE_CHAIN_BALANCES",
       {
         singleClient,
         multiClient,
@@ -2942,7 +2921,7 @@ var useBalanceStaked = (args) => {
   });
   const query = (0, import_react_query5.useQuery)(
     [
-      "USE_BALANCE_STAKED",
+      "useBalanceStaked",
       {
         singleClient,
         multiClient,

package/dist/index.mjs

@@ -2399,39 +2399,18 @@ var useDisconnect = ({ onError, onLoading, onSuccess } = {}) => {
 };
 var useOfflineSigners = (args) => {
   const accounts = useAccount();
-  const { data } = useQuery2(
-    ["OFFLINE_SIGNERS", { accounts }],
-    async () => {
-      if (!accounts)
-        return void 0;
-      const connectedChainIds = Object.values(accounts).map((i) => i == null ? void 0 : i.chainId).filter(Boolean);
-      const res = {};
-      await Promise.all(
-        connectedChainIds.map(async (_chainId) => {
-          const signers = await getOfflineSigners({
-            chainId: _chainId
-          });
-          res[_chainId] = signers;
-        })
-      );
-      return res;
-    },
-    {
-      enabled: Boolean(accounts)
-    }
-  );
   const query = useQuery2(
     [
       "USE_OFFLINE_SIGNERS",
       {
         args,
-        offlineSigners: data
+        accounts
       }
     ],
     async () => {
-      if (!data)
+      if (!accounts)
         return void 0;
-      const connectedChainIds = Object.keys(data).map(([chainId]) => chainId).filter((i) => i);
+      const connectedChainIds = Object.keys(accounts).map(([chainId]) => chainId).filter(Boolean);
       if (args == null ? void 0 : args.chainId) {
         const offlineSigners = await getOfflineSigners({
           chainId: args.chainId
@@ -2449,7 +2428,7 @@ var useOfflineSigners = (args) => {
       );
       return res;
     },
-    { enabled: Boolean(data), refetchOnMount: false, refetchOnWindowFocus: false }
+    { enabled: Boolean(accounts), refetchOnMount: false, refetchOnWindowFocus: false }
   );
   return query;
 };
@@ -2542,7 +2521,7 @@ var useConnectClient = (args) => {
   const chains = (args == null ? void 0 : args.onlyConnectedChains) ? sessionChains : _chains;
   const query = useQuery4(
     [
-      "USE_CLIENTS",
+      "USE_CONNECT_CLIENT",
       {
         client: _client,
         chainId: args == null ? void 0 : args.chainId,
@@ -2589,7 +2568,7 @@ var useConnectSigningClient = (args) => {
   const singleChain = _chains == null ? void 0 : _chains.find((i) => i.chainId === (args == null ? void 0 : args.chainId));
   const sessionChains = sessionChainIds == null ? void 0 : sessionChainIds.map((i) => _chains.find((x) => x.chainId === i));
   const queryKey = [
-    "USE_SIGNING_CLIENTS",
+    "USE_CONNECT_SIGNING_CLIENT",
     { client: _client, chainId: args == null ? void 0 : args.chainId, options: args == null ? void 0 : args.options }
   ];
   const query = useQuery4(
@@ -2661,7 +2640,7 @@ var useBalance = (args) => {
   });
   const query = useQuery5(
     [
-      "USE_BALANCES",
+      "USE_BALANCE",
       {
         client,
         ...args,
@@ -2701,7 +2680,7 @@ var useAllBalances = (args) => {
   });
   const query = useQuery5(
     [
-      "USE_BALANCES",
+      "USE_ALL_BALANCES",
       {
         singleClient,
         multiClient,
@@ -2760,7 +2739,7 @@ var useChainBalances = (args) => {
   });
   const query = useQuery5(
     [
-      "USE_BALANCES",
+      "USE_CHAIN_BALANCES",
       {
         singleClient,
         multiClient,
@@ -2834,7 +2813,7 @@ var useBalanceStaked = (args) => {
   });
   const query = useQuery5(
     [
-      "USE_BALANCE_STAKED",
+      "useBalanceStaked",
       {
         singleClient,
         multiClient,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "graz",
   "description": "React hooks for Cosmos",
-  "version": "0.1.0-alpha.1",
+  "version": "0.1.0-alpha.2",
   "author": "Griko Nibras <griko@strange.love>",
   "repository": "https://github.com/strangelove-ventures/graz.git",
   "homepage": "https://github.com/strangelove-ventures/graz",