thirdweb 5.31.1-nightly-cbb0bc2835bcfef62e69c18596063842f305f624-20240701000440 → 5.31.1

package/src/extensions/farcaster/write/rentStorage.ts

@@ -24,11 +24,15 @@ export type RentStorageParams = {
  * @example
  * ```ts
  * import { rentStorage } from "thirdweb/extensions/farcaster";
- * const tx = await rentStorage({
+ * import { sendTransaction } from "thirdweb";
+ *
+ * const transaction = rentStorage({
  *  client,
  * 	fid,
  *  units,
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function rentStorage(options: RentStorageParams) {

package/src/extensions/marketplace/direct-listings/write/buyFromListing.ts

@@ -20,13 +20,16 @@ export type BuyFromListingParams = {
  * @example
  * ```ts
  * import { buyFromListing } from "thirdweb/extensions/marketplace";
+ * import { sendTransaction } from "thirdweb";
  *
- * const result = await buyFromListing({
+ * const transaction = buyFromListing({
  *  contract,
  *  listingId: 1n,
  *  quantity: 1n,
  *  recipient: "0x...",
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function buyFromListing(

package/src/extensions/marketplace/direct-listings/write/createListing.ts

@@ -71,10 +71,11 @@ export type CreateListingParams = {
  * @example
  * ```typescript
  * import { createListing } from "thirdweb/extensions/marketplace";
+ * import { sendTransaction } from "thirdweb";
  *
  * const transaction = createListing({...});
  *
- * const { transactionHash } = await sendTransaction({ transaction, account });
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function createListing(

package/src/extensions/marketplace/direct-listings/write/updateListing.ts

@@ -76,10 +76,11 @@ export type UpdateListingParams = {
  * @example
  * ```typescript
  * import { updateListing } from "thirdweb/extensions/marketplace";
+ * import { sendTransaction } from "thirdweb";
  *
  * const transaction = updateListing({...});
  *
- * const { transactionHash } = await sendTransaction({ transaction, account });
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function updateListing(

package/src/extensions/marketplace/english-auctions/write/bidInAuction.ts

@@ -22,12 +22,15 @@ export type BidInAuctionParams = {
  * @example
  * ```ts
  * import { bidInAuction } from "thirdweb/extensions/marketplace";
+ * import { sendTransaction } from "thirdweb";
  *
  * const transaction = bidInAuction({
  *  contract,
  *  auctionId: 0n,
  *  bidAmount: "100",
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function bidInAuction(

package/src/extensions/marketplace/english-auctions/write/buyoutAuction.ts

@@ -15,11 +15,14 @@ export type BuyoutAuctionParams = {
  * @example
  * ```ts
  * import { buyoutAuction } from "thirdweb/extensions/marketplace";
+ * import { sendTransaction } from "thirdweb";
  *
  * const transaction = buyoutAuction({
  *  contract,
  *  auctionId: 0n
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function buyoutAuction(

package/src/extensions/marketplace/english-auctions/write/cancelAuction.ts

@@ -16,11 +16,14 @@ export type CancelAuctionParams = {
  * @example
  * ```ts
  * import { cancelAuction } from "thirdweb/extensions/marketplace";
+ * import { sendTransaction } from "thirdweb";
  *
  * const transaction = cancelAuction({
  *  contract,
  *  auctionId: 0n,
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function cancelAuction(

package/src/extensions/marketplace/english-auctions/write/createAuction.ts

@@ -100,11 +100,11 @@ export type CreateAuctionParams = {
  * @example
  * ```typescript
  * import { createAuction } from "thirdweb/extensions/marketplace";
+ * import { sendTransaction } from "thirdweb";
  *
  * const transaction = createAuction({...});
  *
- * const { transactionHash } = await sendTransaction({ transaction, account });
- *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function createAuction(

package/src/extensions/marketplace/english-auctions/write/executeSale.ts

@@ -18,11 +18,14 @@ export type ExecuteSaleParams = {
  * @example
  * ```ts
  * import { executeSale } from "thirdweb/extensions/marketplace";
+ * import { sendTransaction } from "thirdweb";
  *
  * const transaction = executeSale({
  *  contract,
  *  auctionId: 0n,
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function executeSale(

package/src/extensions/marketplace/offers/write/acceptOffer.ts

@@ -23,11 +23,14 @@ export type AcceptOfferParams = GeneratedAcceptOfferParams;
  * @example
  * ```ts
  * import { acceptOffer } from "thirdweb/extensions/marketplace";
+ * import { sendTransaction } from "thirdweb";
  *
  * const acceptOfferTx = acceptOffer({
  *  contract,
  *  offerId: 1n,
  * });
+ *
+ * await sendTransaction({ transaction, account });
  * ```
  */
 export function acceptOffer(

package/src/extensions/marketplace/offers/write/makeOffer.ts

@@ -49,6 +49,7 @@ export type MakeOfferParams = {
  * @example
  * ```ts
  * import { makeOffer } from "thirdweb/extensions/marketplace";
+ * import { sendTransaction } from "thirdweb";
  *
  * const offerTx = makeOffer({
  *  contract,
@@ -58,8 +59,9 @@ export type MakeOfferParams = {
  *  offerExpiresAt: new Date(Date.now() + 1000 * 60 * 60 * 24),
  *  totalOffer: "1.0",
  * });
- * ```
  *
+ * await sendTransaction({ transaction, account });
+ * ```
  */
 export function makeOffer(options: BaseTransactionOptions<MakeOfferParams>) {
   return makeOfferGenerated({

package/src/extensions/permissions/write/grant.ts

@@ -17,12 +17,16 @@ export type GrantRoleParams = {
  * @example
  * ```ts
  * import { grantRole } from "thirdweb/extensions/permissions";
+ * import { sendTransaction } from "thirdweb";
  *
- * const result = await grantRole({
+ * const transaction = grantRole({
  *  contract,
  *  role: "admin",
  *  targetAccountAddress: "0x1234567890123456789012345678901234567890",
  * });
+ *
+ * await sendTransaction({ transaction, account });
+ * ```
  */
 export function grantRole(options: BaseTransactionOptions<GrantRoleParams>) {
   return generatedGrantRole({

package/src/extensions/permissions/write/renounceRole.ts

@@ -17,12 +17,15 @@ export type RenounceRoleParams = {
  * @example
  * ```ts
  * import { renounceRole } from "thirdweb/extensions/permissions";
+ * import { sendTransaction } from "thirdweb";
  *
- * const result = await renounceRole({
+ * const transaction = renounceRole({
  *  contract,
  *  role: "admin",
  *  targetAccountAddress: "0x1234567890123456789012345678901234567890",
  * });
+ * await sendTransaction({ transaction, account });
+ * ```
  */
 export function renounceRole(
   options: BaseTransactionOptions<RenounceRoleParams>,

package/src/extensions/permissions/write/revokeRole.ts

@@ -17,12 +17,16 @@ export type RevokeRoleParams = {
  * @example
  * ```ts
  * import { revokeRole } from "thirdweb/extensions/permissions";
+ * import { sendTransaction } from "thirdweb";
  *
- * const result = await revokeRole({
+ * const transaction = revokeRole({
  *  contract,
  *  role: "admin",
  *  targetAccountAddress: "0x1234567890123456789012345678901234567890",
  * });
+ *
+ * await sendTransaction({ transaction, account });
+ * ```
  */
 export function revokeRole(options: BaseTransactionOptions<RevokeRoleParams>) {
   return generatedRevokeRole({

package/src/gas/get-gas-price.ts

@@ -20,6 +20,7 @@ export type GetGasPriceOptions = {
  *
  * const gasPrice = await getGasPrice({ client, chain });
  * ```
+ * @utils
  */
 export async function getGasPrice(
   options: GetGasPriceOptions,

package/src/pay/getBuyHistory.ts

@@ -72,6 +72,7 @@ export type BuyHistoryData = {
  *  walletAddress: "0x...",
  * })
  * ```
+ * @buycrypto
  */
 export async function getBuyHistory(
   params: BuyHistoryParams,

package/src/react/core/hooks/rpc/useBlockNumber.ts

@@ -22,6 +22,7 @@ export type UseBlockNumberOptions = {
  * import { useBlockNumber } from "thirdweb/react";
  * const blockNumber = useBlockNumber({client, chain});
  * ```
+ * @utils
  */
 export function useBlockNumber(options: UseBlockNumberOptions) {
   const { client, chain, enabled = true, watch = true } = options;

package/src/react/core/hooks/transaction/useSimulateTransaction.ts

@@ -5,6 +5,19 @@ import {
   simulateTransaction,
 } from "../../../../transaction/actions/simulate.js";
 
+/**
+ * A hook to simulate a transaction.
+ * @returns A mutation object to simulate a transaction.
+ * @example
+ * ```jsx
+ * import { useSimulateTransaction } from "thirdweb/react";
+ * const { mutate: simulateTx } = useSimulateTransaction();
+ *
+ * // later
+ * const result = await simulateTx(tx);
+ * ```
+ * @transaction
+ */
 export function useSimulateTransaction<
   const abi extends Abi,
   const abiFn extends AbiFunction,

package/src/react/native/hooks/transaction/useEstimateGas.ts

@@ -15,6 +15,7 @@ import { useActiveAccount } from "../wallets/useActiveAccount.js";
  * // later
  * const estimatedGas = await estimateGas(tx);
  * ```
+ * @transaction
  */
 export function useEstimateGas(): UseMutationResult<
   EstimateGasResult,

package/src/react/web/hooks/transaction/useEstimateGas.ts

@@ -15,6 +15,7 @@ import { useActiveAccount } from "../wallets/useActiveAccount.js";
  * // later
  * const estimatedGas = await estimateGas(tx);
  * ```
+ * @transaction
  */
 export function useEstimateGas(): UseMutationResult<
   EstimateGasResult,

package/src/react/web/ui/ConnectWallet/Details.tsx

@@ -1135,6 +1135,7 @@ export type UseWalletDetailsModalOptions = {
  *   return <button onClick={handleClick}> Show Wallet Details </button>
  * }
  * ```
+ * @wallet
  */
 export function useWalletDetailsModal() {
   const account = useActiveAccount();

package/src/react/web/utils/sortWallets.ts

@@ -27,8 +27,8 @@ export function sortWallets<T extends { id: string }>(
       })
       // show the recommended wallets even before that
       .sort((a, b) => {
-        const aIsRecommended = recommendedWallets?.find((w) => w === a);
-        const bIsRecommended = recommendedWallets?.find((w) => w === b);
+        const aIsRecommended = recommendedWallets?.find((w) => w.id === a.id);
+        const bIsRecommended = recommendedWallets?.find((w) => w.id === b.id);
 
         if (aIsRecommended && !bIsRecommended) {
           return -1;
@@ -38,7 +38,7 @@ export function sortWallets<T extends { id: string }>(
         }
         return 0;
       })
-      // show wallets with select ui first ( currently only in-app )
+      // show in-app wallets first
       .sort((a, b) => {
         const aIsInApp = a.id === "inApp" || a.id === "embedded";
         const bIsInApp = b.id === "inApp" || b.id === "embedded";

package/src/transaction/actions/estimate-gas-cost.ts

@@ -23,6 +23,7 @@ export type EstimateGasCostResult = {
  *
  * const gasCost = await estimateGasCost({ transaction });
  * ```
+ * @transaction
  */
 export async function estimateGasCost(
   options: EstimateGasOptions,

package/src/version.ts

@@ -1 +1 @@
-export const version = "5.31.1-nightly-cbb0bc2835bcfef62e69c18596063842f305f624-20240701000440";
+export const version = "5.31.1";

package/src/wallets/coinbase/coinbaseWebSDK.ts

@@ -132,7 +132,20 @@ export async function getCoinbaseWebProvider(
   options?: CreateWalletArgs<typeof COINBASE>[1],
 ): Promise<ProviderInterface> {
   if (!_provider) {
-    const { CoinbaseWalletSDK } = await import("@coinbase/wallet-sdk");
+    let CoinbaseWalletSDK: unknown = (await import("@coinbase/wallet-sdk"))
+      .default;
+    // Workaround for Vite dev import errors
+    // https://github.com/vitejs/vite/issues/7112
+    if (
+      typeof CoinbaseWalletSDK !== "function" &&
+      typeof (CoinbaseWalletSDK as { default: unknown }).default === "function"
+    ) {
+      CoinbaseWalletSDK = (
+        CoinbaseWalletSDK as unknown as { default: typeof CoinbaseWalletSDK }
+      ).default;
+    }
+
+    // @ts-expect-error This import error is not visible to TypeScript
     const client = new CoinbaseWalletSDK({
       appName: options?.appMetadata?.name || getDefaultAppMetadata().name,
       appChainIds: options?.chains

package/src/wallets/in-app/web/lib/auth/passkeys.ts

@@ -161,7 +161,7 @@ export async function loginWithPasskey(options: {
  * Returns whether this device has a stored passkey ready to be used for sign-in
  * @param client - the thirdweb client
  * @returns whether the device has a stored passkey
- * @wallet
+ * @walletUtils
  */
 export async function hasStoredPasskey(
   client: ThirdwebClient,

package/src/wallets/wallet-connect/receiver/index.ts

@@ -153,7 +153,7 @@ export const DefaultWalletConnectRequestHandlers = {
  *   },
  * });
  * ```
- * @wallets
+ * @wallet
  */
 export async function createWalletConnectClient(
   options: CreateWalletConnectClientOptions,
@@ -289,7 +289,7 @@ export async function createWalletConnectClient(
  *   uri: "wc:...",
  * });
  * ```
- * @wallets
+ * @wallet
  */
 export function createWalletConnectSession(
   options: CreateWalletConnectSessionOptions,
@@ -308,7 +308,7 @@ export function createWalletConnectSession(
  *
  * const sessions = await getActiveWalletConnectSessions();
  * ```
- * @wallets
+ * @wallet
  */
 export async function getActiveWalletConnectSessions(): Promise<
   WalletConnectSession[]
@@ -328,7 +328,7 @@ export async function getActiveWalletConnectSessions(): Promise<
  *   walletConnectClient: wcClient,
  * });
  * ```
- * @wallets
+ * @wallet
  */
 export async function disconnectWalletConnectSession(options: {
   session: WalletConnectSession;