thirdweb 5.31.0 → 5.31.1-nightly-a1d6a3c93e9a7b0433076a3e321183b09cfc0054-20240702000343

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/extensions/prebuilts/deploy-modular-core.test.ts

@@ -2,9 +2,9 @@ import { describe, expect, it } from "vitest";
 import { ANVIL_CHAIN } from "../../../test/src/chains.js";
 import { TEST_CLIENT } from "../../../test/src/test-clients.js";
 import { TEST_ACCOUNT_A } from "../../../test/src/test-wallets.js";
-import { ADDRESS_ZERO } from "../../constants/addresses.js";
+import { ZERO_ADDRESS } from "../../constants/addresses.js";
 import { getContract } from "../../contract/contract.js";
-import { sendTransaction } from "../../transaction/actions/send-transaction.js";
+import { sendAndConfirmTransaction } from "../../transaction/actions/send-and-confirm-transaction.js";
 import { installPublishedExtension } from "../modular/ModularCore/write/installPublishedExtension.js";
 import { uninstallExtensionByProxy } from "../modular/ModularCore/write/uninstallExtensionByProxy.js";
 import { uninstallPublishedExtension } from "../modular/ModularCore/write/uninstallPublishedExtension.js";
@@ -65,7 +65,7 @@ describe.runIf(process.env.TW_SECRET_KEY)(
         extensionName: "DemoExtensionWithFunctions",
         publisherAddress: "0xFD78F7E2dF2B8c3D5bff0413c96f3237500898B3",
       });
-      await sendTransaction({
+      await sendAndConfirmTransaction({
         transaction: installTransaction,
         account: TEST_ACCOUNT_A,
       });
@@ -75,7 +75,7 @@ describe.runIf(process.env.TW_SECRET_KEY)(
         contract: core,
       });
       const extensionAddress = installedExtensions[0]?.implementation;
-      expect(extensionAddress).to.not.equal(ADDRESS_ZERO);
+      expect(extensionAddress).to.not.equal(ZERO_ADDRESS);
 
       // uninstall extension
       const uninstallTransaction = uninstallExtensionByProxy({
@@ -85,7 +85,7 @@ describe.runIf(process.env.TW_SECRET_KEY)(
         extensionProxyAddress: extensionAddress as string,
         extensionData: "0x",
       });
-      await sendTransaction({
+      await sendAndConfirmTransaction({
         transaction: uninstallTransaction,
         account: TEST_ACCOUNT_A,
       });
@@ -123,7 +123,7 @@ describe.runIf(process.env.TW_SECRET_KEY)(
         extensionName: "DemoExtensionWithFunctions",
         publisherAddress: "0xFD78F7E2dF2B8c3D5bff0413c96f3237500898B3",
       });
-      await sendTransaction({
+      await sendAndConfirmTransaction({
         transaction: installTransaction,
         account: TEST_ACCOUNT_A,
       });
@@ -143,7 +143,7 @@ describe.runIf(process.env.TW_SECRET_KEY)(
         publisherAddress: "0xFD78F7E2dF2B8c3D5bff0413c96f3237500898B3",
         extensionData: "0x",
       });
-      await sendTransaction({
+      await sendAndConfirmTransaction({
         transaction: uninstallTransaction,
         account: TEST_ACCOUNT_A,
       });

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.0";
+export const version = "5.31.1-nightly-a1d6a3c93e9a7b0433076a3e321183b09cfc0054-20240702000343";

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;