thirdweb 5.41.0 → 5.42.0

package/src/wallets/in-app/web/ecosystem.ts

@@ -7,10 +7,29 @@ import type {
 import { createEcosystemWallet } from "../core/wallet/ecosystem-core.js";
 
 /**
- * Creates an ecosystem wallet.
+ * Creates an [Ecosystem Wallet](https://portal.thirdweb.com/connect/ecosystems/overview) based on various authentication methods.
+ *
+ * Available authentication methods:
+ * - Email
+ * - Phone
+ * - Passkey
+ * - Google
+ * - Apple
+ * - Facebook
+ * - Discord
+ * - Farcaster
+ *
+ * Can also be configured to use Account Abstraction to directly connect to a ERC4337 smart account based on those authentication methods.
+ *
+ * Refer to [inAppWallet](https://portal.thirdweb.com/references/typescript/v5/inAppWallet) for detailed usage examples.
+ *
  * @param createOptions - configuration options
+ * Refer to [EcosystemWalletCreationOptions](https://portal.thirdweb.com/references/typescript/v5/EcosystemWalletCreationOptions) for more details.
  * @returns The created ecosystem wallet.
  * @example
+ *
+ * ### Connect to an ecosystem wallet
+ *
  * ```ts
  * import { ecosystemWallet } from "thirdweb/wallets";
  *
@@ -23,14 +42,21 @@ import { createEcosystemWallet } from "../core/wallet/ecosystem-core.js";
  * });
  * ```
  *
- * Connect to a restricted ecosystem wallet with your designated partner ID
- * @note The parnter ID will be provided to you by the ecosystem with which you're integrating.
+ * [View all connection options](https://portal.thirdweb.com/references/typescript/v5/EcosystemWalletConnectionOptions)
+ *
+ * ### Connect to a restricted ecosystem wallet with your designated partner ID
+ *
+ * The parnter ID will be provided to you by the ecosystem with which you're integrating.
+ *
  * ```ts
  * import { ecosystemWallet } from "thirdweb/wallets";
  * const wallet = ecosystemWallet("ecosystem.hooli", {
  *  partnerId: "..."
  * });
  * ```
+ *
+ * Refer to [inAppWallet](https://portal.thirdweb.com/references/typescript/v5/inAppWallet) for more usage examples.
+ *
  * @wallet
  */
 export function ecosystemWallet(

package/src/wallets/in-app/web/in-app.ts

@@ -4,10 +4,27 @@ import type { CreateWalletArgs } from "../../wallet-types.js";
 import { createInAppWallet } from "../core/wallet/in-app-core.js";
 
 /**
- * Creates an in-app wallet.
+ * Creates an app scoped wallet for users based on various authentication methods.
+ *
+ * Available authentication methods:
+ * - Email
+ * - Phone
+ * - Passkey
+ * - Google
+ * - Apple
+ * - Facebook
+ * - Discord
+ * - Farcaster
+ *
+ * Can also be configured to use Account Abstraction to directly connect to a ERC4337 smart account based on those authentication methods.
+ *
  * @param createOptions - configuration options
+ * Refer to [InAppWalletCreationOptions](https://portal.thirdweb.com/references/typescript/v5/InAppWalletCreationOptions) to see the available options.
  * @returns The created in-app wallet.
  * @example
+ *
+ * ### Login with socials
+ *
  * ```ts
  * import { inAppWallet } from "thirdweb/wallets";
  *
@@ -20,18 +37,90 @@ import { createInAppWallet } from "../core/wallet/in-app-core.js";
  * });
  * ```
  *
- * Enable smart accounts and sponsor gas for your users:
+ * [View all available social auth methods](https://portal.thirdweb.com/references/typescript/v5/InAppWalletSocialAuth)
+ *
+ * * ### Login with email
+ *
+ * ```ts
+ * import { inAppWallet, preAuthenticate } from "thirdweb/wallets/in-app";
+ *
+ * const wallet = inAppWallet();
+ *
+ * // sends a verification code to the provided email
+ * await preAuthenticate({
+ *   client,
+ *   strategy: "email",
+ *   email: "example@example.com",
+ * });
+ *
+ * // login with the verification code
+ * const account = await wallet.connect({
+ *   client,
+ *   chain,
+ *   strategy: "email",
+ *   verificationCode: "123456",
+ * });
+ * ```
+ *
+ * ### Login with phone number
+ * ```ts
+ * import { inAppWallet, preAuthenticate } from "thirdweb/wallets/in-app";
+ *
+ * const wallet = inAppWallet();
+ *
+ * // sends a verification code to the provided phone number
+ * await preAuthenticate({
+ *   client,
+ *   strategy: "phone",
+ *   phoneNumber: "+1234567890",
+ * });
+ *
+ * // login with the verification code
+ * const account = await wallet.connect({
+ *   client,
+ *   chain,
+ *   strategy: "phone",
+ *   verificationCode: "123456",
+ * });
+ *
+ * ### Login with passkey
+ *
+ * ```ts
+ * import { inAppWallet, hasStoredPasskey } from "thirdweb/wallets/in-app";
+ *
+ * const wallet = inAppWallet();
+ *
+ * const wallet = inAppWallet();
+ * const hasPasskey = await hasStoredPasskey(client);
+ * await wallet.connect({
+ *   client,
+ *   strategy: "passkey",
+ *  type: hasPasskey ? "sign-in" : "sign-up",
+ * });
+ * ```
+ *
+ * ### Enable smart accounts and sponsor gas for your users:
+ *
  * ```ts
  * import { inAppWallet } from "thirdweb/wallets";
+ * import { sepolia } from "thirdweb/chains";
+ *
  * const wallet = inAppWallet({
  *  smartAccount: {
  *   chain: sepolia,
  *   sponsorGas: true,
  * },
  * });
+ *
+ * // account will be a smart account with sponsored gas enabled
+ * const account = await wallet.connect({
+ *   client,
+ *   chain,
+ *   strategy: "google",
+ * });
  * ```
  *
- * Specify a logo for your login page
+ * ### Specify a logo for your login page (Connect UI)
  * ```ts
  * import { inAppWallet } from "thirdweb/wallets";
  * const wallet = inAppWallet({
@@ -46,7 +135,8 @@ import { createInAppWallet } from "../core/wallet/in-app-core.js";
  * });
  * ```
  *
- * Hide the ability to export the private key within the Connect Modal
+ * ### Hide the ability to export the private key within the Connect Modal UI
+ *
  * ```ts
  * import { inAppWallet } from "thirdweb/wallets";
  * const wallet = inAppWallet({
@@ -54,7 +144,10 @@ import { createInAppWallet } from "../core/wallet/in-app-core.js";
  * });
  * ```
  *
- * Open the Oauth window in the same tab
+ * ### Open the Oauth window in the same tab
+ *
+ * By default, the Oauth window will open in a popup window. You can change this behavior by setting the `auth.mode` option to `"redirect"`.
+ *
  * ```ts
  * import { inAppWallet } from "thirdweb/wallets";
  * const wallet = inAppWallet({
@@ -63,6 +156,8 @@ import { createInAppWallet } from "../core/wallet/in-app-core.js";
  *  }
  * });
  * ```
+ *
+ * @returns The created in-app wallet.
  * @wallet
  */
 export function inAppWallet(

package/src/wallets/smart/smart-wallet.ts

@@ -11,23 +11,89 @@ import type {
 import { DEFAULT_ACCOUNT_FACTORY } from "./lib/constants.js";
 
 /**
- * Creates a smart wallet.
+ * Creates a ERC4337 smart wallet based on a admin account.
+ *
+ * Smart wallets are smart contract wallets that enable multiple benefits for users:
+ *
+ * - Sponsor gas fees for transactions
+ * - Multiple owners
+ * - Session keys
+ * - Batch transactions
+ * - Predictable addresses
+ * - Programmable features
+ *
+ * [Learn more about account abstraction](https://portal.thirdweb.com/connect/account-abstraction/how-it-works)
+ *
  * @param createOptions - The options for creating the wallet.
+ * Refer to [SmartWalletCreationOptions](https://portal.thirdweb.com/references/typescript/v5/SmartWalletCreationOptions) for more details.
  * @returns The created smart wallet.
  * @example
+ *
+ * ## Connect to a smart wallet
+ *
+ * To connect to a smart wallet, you need to provide an admin account as the `personalAccount` option.
+ *
+ * Any wallet can be used as an admin account, including an in-app wallets.
+ *
+ * The `sponsorGas` option is used to enable sponsored gas for transactions automatically.
+ *
  * ```ts
- * import { smartWallet } from "thirdweb/wallets";
+ * import { smartWalletm inAppWallet } from "thirdweb/wallets";
+ * import { sepolia } from "thirdweb/chains";
+ * import { sendTransaction } from "thirdweb";
  *
  * const wallet = smartWallet({
  *  chain: sepolia,
- *  gasless: true,
+ *  sponsorGas: true, // enable sponsored transactions
  * });
  *
- * const account = await wallet.connect({
+ * // any wallet can be used as an admin account
+ * // in this example we use an in-app wallet
+ * const adminWallet = inAppWallet();
+ * const personalAccount = await adminWallet.connect({
  *   client,
- *   personalAccount: account,
+ *   chain: sepolia,
+ *   strategy: "google",
+ * });
+ *
+ * const smartAccount = await wallet.connect({
+ *   client,
+ *   personalAccount, // pass the admin account
+ * });
+ *
+ * // sending sponsored transactions with the smartAccount
+ * await sendTransaction({
+ *   account: smartAccount,
+ *   transaction,
  * });
  * ```
+ *
+ * ## Configuring the smart wallet
+ *
+ * You can pass options to the `smartWallet` function to configure the smart wallet.
+ *
+ * ```ts
+ * import { smartWallet } from "thirdweb/wallets";
+ * import { sepolia } from "thirdweb/chains";
+ *
+ * const wallet = smartWallet({
+ *  chain: sepolia,
+ *  sponsorGas: true, // enable sponsored transactions
+ *  factoryAddress: "0x...", // custom factory address
+ *  overrides: {
+ *    accountAddress: "0x...", // override account address
+ *    accountSalt: "0x...", // override account salt
+ *    entrypointAddress: "0x...", // override entrypoint address
+ *    erc20Paymaster: { ... }, // enable erc20 paymaster
+ *    bundlerUrl: "https://...", // override bundler url
+ *    paymaster: (userOp) => { ... }, // override paymaster
+ *    ...
+ *  }
+ * });
+ * ```
+ *
+ * Refer to [SmartWalletOptions](https://portal.thirdweb.com/references/typescript/v5/SmartWalletOptions) for more details.
+ *
  * @wallet
  */
 export function smartWallet(