@shelby-protocol/react 0.0.4 → 1.0.0

package/src/queries/useBlobMetadata.tsx

@@ -1,20 +1,15 @@
-import type { Network } from "@aptos-labs/ts-sdk";
-import type {
-  BlobMetadata,
-  ShelbyBlobClient,
-} from "@shelby-protocol/sdk/browser";
+import type { BlobMetadata } from "@shelby-protocol/sdk/browser";
 import { useQuery } from "@tanstack/react-query";
-import type { UseQueryOptionsWithClient } from "../types/queries";
+import { useShelbyClient } from "../components/ShelbyClientProvider";
+import {
+  getUseBlobMetadataQueryKey,
+  type UseBlobMetadataOptions,
+} from "../core/queries/blobMetadata";
 
-export const getUseBlobMetadataQueryKey = (
-  params: Parameters<ShelbyBlobClient["getBlobMetadata"]>[0] & {
-    network: Network;
-  },
-) => ["blob-metadata", params.network, params.account.toString(), params.name];
-
-export type UseBlobMetadataOptions =
-  UseQueryOptionsWithClient<BlobMetadata | null> &
-    Parameters<ShelbyBlobClient["getBlobMetadata"]>[0];
+export {
+  getUseBlobMetadataQueryKey,
+  type UseBlobMetadataOptions,
+} from "../core/queries/blobMetadata";
 
 /**
  * Queries the metadata for a specific blob.
@@ -39,9 +34,10 @@ export type UseBlobMetadataOptions =
 export function useBlobMetadata({
   account,
   name,
-  client: shelbyClient,
+  client,
   ...options
 }: UseBlobMetadataOptions) {
+  const shelbyClient = useShelbyClient(client);
   return useQuery<BlobMetadata | null>({
     queryKey: getUseBlobMetadataQueryKey({
       network: shelbyClient.config.network,

package/src/types/index.ts

@@ -0,0 +1 @@
+export * from "./signers";

package/src/types/mutations.ts

@@ -2,15 +2,24 @@ import type { ShelbyClient } from "@shelby-protocol/sdk/browser";
 import type {
   DefaultError,
   MutationKey,
-  UseMutationOptions,
+  UseMutationOptions as UseMutationOptionsTanstack,
 } from "@tanstack/react-query";
 
-export type UseMutationOptionsWithClient<
+export type UseMutationOptions<
   TMutationFnData = unknown,
   TError = DefaultError,
   TData = TMutationFnData,
   TMutationKey extends MutationKey = MutationKey,
 > = Omit<
-  UseMutationOptions<TMutationFnData, TError, TData, TMutationKey>,
+  UseMutationOptionsTanstack<TMutationFnData, TError, TData, TMutationKey>,
   "mutationFn"
-> & { client: ShelbyClient };
+>;
+
+export type UseMutationOptionsWithClient<
+  TMutationFnData = unknown,
+  TError = DefaultError,
+  TData = TMutationFnData,
+  TMutationKey extends MutationKey = MutationKey,
+> = UseMutationOptions<TMutationFnData, TError, TData, TMutationKey> & {
+  client?: ShelbyClient | null;
+};

package/src/types/queries.ts

@@ -1,16 +1 @@
-import type { ShelbyClient } from "@shelby-protocol/sdk/browser";
-import type {
-  DefaultError,
-  QueryKey,
-  UseQueryOptions,
-} from "@tanstack/react-query";
-
-export type UseQueryOptionsWithClient<
-  TQueryFnData = unknown,
-  TError = DefaultError,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
-> = Omit<
-  UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
-  "queryFn" | "queryKey"
-> & { client: ShelbyClient };
+export type { UseQueryOptionsWithClient } from "../core/types";

package/src/types/signers.ts

@@ -4,8 +4,26 @@ import type { SignAndSubmitTransactionFn } from "./walletAdapter";
 export type AccountSigner = Account;
 
 export type WalletAdapterSigner = {
-  account: AccountAddressInput;
+  account?: AccountAddressInput | { address: AccountAddressInput } | null;
   signAndSubmitTransaction: SignAndSubmitTransactionFn;
 };
 
+/**
+ * A signer is a user who can sign transactions on the Shelby network.
+ * It can be an account signer or a wallet adapter signer.
+ *
+ * @example AccountSigner
+ * ```tsx
+ * const signer = new Account.generate();
+ * ```
+ *
+ * @example WalletAdapterSigner
+ * ```tsx
+ * const walletAdapterSigner = useWallet();
+ *
+ * if (!walletAdapterSigner.account) throw new Error("A wallet must be connected to sign transactions");
+ *
+ * const signer = walletAdapterSigner;
+ * ```
+ */
 export type Signer = AccountSigner | WalletAdapterSigner;