thirdweb 5.60.1 → 5.61.0

package/src/extensions/unstoppable-domains/consts.ts

@@ -0,0 +1 @@
+export const UD_POLYGON_MAINNET = "0xa9a6A3626993D487d2Dbda3173cf58cA1a9D9e9f";

package/src/extensions/unstoppable-domains/read/resolveAddress.test.ts

@@ -0,0 +1,18 @@
+import { describe, expect, it } from "vitest";
+import { TEST_CLIENT } from "~test/test-clients.js";
+import { resolveAddress } from "./resolveAddress.js";
+
+// Double check: https://unstoppabledomains.com/d/thirdwebsdk.unstoppable
+
+describe("Unstoppable Domain: resolve address", () => {
+  it("should resolve address", async () => {
+    expect(
+      (
+        await resolveAddress({
+          name: "thirdwebsdk.unstoppable",
+          client: TEST_CLIENT,
+        })
+      ).toLowerCase(),
+    ).toBe("0x12345674b599ce99958242b3D3741e7b01841DF3".toLowerCase());
+  });
+});

package/src/extensions/unstoppable-domains/read/resolveAddress.ts

@@ -0,0 +1,96 @@
+import { polygon } from "../../../chains/chain-definitions/polygon.js";
+import type { Chain } from "../../../chains/types.js";
+import type { ThirdwebClient } from "../../../client/client.js";
+import { getContract } from "../../../contract/contract.js";
+import { getAddress, isAddress } from "../../../utils/address.js";
+import { withCache } from "../../../utils/promise/withCache.js";
+import { getMany } from "../__generated__/UnstoppableDomains/read/getMany.js";
+import { namehash } from "../__generated__/UnstoppableDomains/read/namehash.js";
+import { UD_POLYGON_MAINNET } from "../consts.js";
+
+/**
+ * @extension UNSTOPPABLE-DOMAINS
+ */
+export type ResolveAddressOptions = {
+  client: ThirdwebClient;
+  name: string;
+  resolverAddress?: string;
+  resolverChain?: Chain;
+};
+
+/**
+ * Resolve an Unstoppable-Domain domain to an Ethereum address
+ * @param options - The options for resolving an UD domain
+ * @returns The Ethereum address associated with the domain name. [Learn more](https://docs.unstoppabledomains.com/reverse-resolution/)
+ * @example
+ *
+ * ### Basic usage
+ * ```ts
+ * import { resolveAddress } from "thirdweb/extension/unstoppable-domains";
+ *
+ * const address = await resolveAddress({
+ *   client,
+ *   name: "thirdweb.crypto",
+ * });
+ * ```
+ *
+ * ### Custom resolver
+ * By default this extension will try to resolve the name on Polygon mainnet,
+ * you can decide to customize the resolver contract by specifying `resolverAddress` and `resolverChain`
+ * ```ts
+ * import { ethereum } from "thirdweb/chains";
+ *
+ * const address = await resolveAddress({
+ *   client,
+ *   name: "thirdweb.crypto",
+ *   resolverAddress: "0x...",
+ *   resolverChain: ethereum,
+ * });
+ * ```
+ *
+ * @extension UNSTOPPABLE-DOMAINS
+ */
+export async function resolveAddress(
+  options: ResolveAddressOptions,
+): Promise<string> {
+  const { client, name, resolverAddress, resolverChain } = options;
+  if (isAddress(name)) {
+    return getAddress(name);
+  }
+  return withCache(
+    async () => {
+      const contract = getContract({
+        client,
+        chain: resolverChain || polygon,
+        address: resolverAddress || UD_POLYGON_MAINNET,
+      });
+
+      // Get namehash
+      const possibleTokenId = await namehash({
+        contract,
+        labels: name.split("."),
+      });
+
+      // Resolve ETH address from the tokenId
+      const resolved = await getMany({
+        contract,
+        tokenId: possibleTokenId,
+        // note that you can also retrieve the (BTC, SOL, etc.) address by using "crypto.<symbol>.address" (should that become useful one day)
+        keys: ["crypto.ETH.address"],
+      });
+
+      const possibleETHAddress = resolved[0];
+      if (!possibleETHAddress) {
+        throw new Error(
+          `Could not retrieve any ETH address associated with domain name: ${name}. Make sure you have set the base EVM address for your domain here: https://unstoppabledomains.com/manage?page=crypto&domain=<your-domain>`,
+        );
+      }
+      return possibleETHAddress;
+    },
+    {
+      cacheKey: `unstoppable-domain:addr:${resolverChain?.id || 1}:${name}`,
+      // 1min cache
+      cacheTime: 60 * 1000,
+    },
+  );
+}

package/src/extensions/unstoppable-domains/read/resolveName.test.ts

@@ -0,0 +1,16 @@
+import { describe, expect, it } from "vitest";
+import { TEST_CLIENT } from "~test/test-clients.js";
+import { resolveName } from "./resolveName.js";
+
+// Double check: https://unstoppabledomains.com/d/thirdwebsdk.unstoppable
+
+describe("Unstoppable Domain: resolve name", () => {
+  it("should resolve name", async () => {
+    expect(
+      await resolveName({
+        address: "0x12345674b599ce99958242b3D3741e7b01841DF3",
+        client: TEST_CLIENT,
+      }),
+    ).toBe("thirdwebsdk.unstoppable");
+  });
+});

package/src/extensions/unstoppable-domains/read/resolveName.ts

@@ -0,0 +1,77 @@
+import { polygon } from "../../../chains/chain-definitions/polygon.js";
+import type { Chain } from "../../../chains/types.js";
+import type { ThirdwebClient } from "../../../client/client.js";
+import { getContract } from "../../../contract/contract.js";
+import { withCache } from "../../../utils/promise/withCache.js";
+import { reverseNameOf } from "../__generated__/UnstoppableDomains/read/reverseNameOf.js";
+import { UD_POLYGON_MAINNET } from "../consts.js";
+
+/**
+ * @extension UNSTOPPABLE-DOMAINS
+ */
+export type ResolveUDNameOptions = {
+  client: ThirdwebClient;
+  address: string;
+  resolverAddress?: string;
+  resolverChain?: Chain;
+};
+
+/**
+ * Resolves the primary Untoppable-Domains name for a specified address.
+ * @param options - The options for resolving an UD domain
+ * @example
+ *
+ * ### Basic usage
+ * ```ts
+ * import { resolveName } from "thirdweb/extension/unstoppable-domains";
+ *
+ * const name = await resolveName({
+ *   client,
+ *   address: "0x...",
+ * });
+ * ```
+ *
+ * ### Custom resolver
+ * By default this extension will try to resolve the address on Polygon mainnet,
+ * you can decide to customize the resolver contract by specifying `resolverAddress` and `resolverChain`
+ * ```ts
+ * import { ethereum } from "thirdweb/chains";
+ *
+ * const address = await resolveName({
+ *   client,
+ *   address: "0x...",
+ *   resolverAddress: "0x...",
+ *   resolverChain: ethereum,
+ * });
+ * ```
+ * @extension UNSTOPPABLE-DOMAINS
+ */
+export async function resolveName(
+  options: ResolveUDNameOptions,
+): Promise<string> {
+  const { client, address, resolverAddress, resolverChain } = options;
+  return withCache(
+    async () => {
+      const contract = getContract({
+        client,
+        chain: resolverChain || polygon,
+        address: resolverAddress || UD_POLYGON_MAINNET,
+      });
+
+      // Note: if the given wallet address does not have any UD name, `reverseNameOf` will return an empty string
+      // This can still happen if you have transfered a domain to a new address, and forgot to set up the Reverse Resolution on the new address
+      const domain = await reverseNameOf({ contract, addr: address });
+      if (!domain) {
+        throw new Error(
+          `Failed to retrieve domain for address: ${address}. Make sure you have set the Reverse Resolution address for your domain at https://unstoppabledomains.com/manage?page=reverseResolution&domain=your-domain`,
+        );
+      }
+      return domain;
+    },
+    {
+      cacheKey: `unstoppable-domain:name:${resolverChain?.id || 1}:${address}`,
+      // 1min cache
+      cacheTime: 60 * 1000,
+    },
+  );
+}

package/src/react/native/hooks/wallets/useLinkProfile.ts

@@ -0,0 +1,92 @@
+import { useMutation } from "@tanstack/react-query";
+import { isEcosystemWallet } from "../../../../wallets/ecosystem/is-ecosystem-wallet.js";
+import type { AuthArgsType } from "../../../../wallets/in-app/core/authentication/types.js";
+import type { Ecosystem } from "../../../../wallets/in-app/core/wallet/types.js";
+import { linkProfile } from "../../../../wallets/in-app/web/lib/auth/index.js";
+import { useAdminWallet } from "../../../core/hooks/wallets/useAdminWallet.js";
+
+/**
+ * Links a web2 or web3 profile to the connected in-app or ecosystem account.
+ *
+ * **When a profile is linked to the account, that profile can then be used to sign into the same account.**
+ *
+ * @example
+ *
+ * ### Linking a social profile
+ *
+ * ```jsx
+ * import { useLinkProfile } from "thirdweb/react";
+ *
+ * const { mutate: linkProfile } = useLinkProfile();
+ *
+ * const onClick = () => {
+ *   linkProfile({
+ *     client,
+ *     strategy: "discord", // or "google", "x", "telegram", etc
+ *   });
+ * };
+ * ```
+ *
+ * ### Linking an email
+ *
+ * ```jsx
+ * import { useLinkProfile } from "thirdweb/react";
+ * import { preAuthenticate } from "thirdweb/wallets";
+ *
+ * const { mutate: linkProfile } = useLinkProfile();
+ *
+ * // send a verification email first
+ * const sendEmail = async () => {
+ *   const email = await preAuthenticate({
+ *     client,
+ *     strategy: "email",
+ *     email: "john.doe@example.com",
+ *   });
+ * };
+ *
+ * // then link the profile with the verification code
+ * const onClick = (code: string) => {
+ *   linkProfile({
+ *     client,
+ *     strategy: "email",
+ *     email: "john.doe@example.com",
+ *     verificationCode: code,
+ *   });
+ * };
+ * ```
+ *
+ * The same process can be used for phone and email, simply swap out the `strategy` parameter.
+ *
+ * ### Linking a wallet
+ *
+ * ```jsx
+ * import { useLinkProfile } from "thirdweb/react";
+ *
+ * const { mutate: linkProfile } = useLinkProfile();
+ *
+ * const onClick = () => {
+ *   linkProfile({
+ *     client,
+ *     strategy: "wallet",
+ *     wallet: createWallet("io.metamask"), // autocompletion for 400+ wallet ids
+ *     chain: sepolia, // any chain works, needed for SIWE signature
+ *   });
+ * };
+ * ```
+ *
+ * @wallet
+ */
+export function useLinkProfile() {
+  const wallet = useAdminWallet();
+  return useMutation({
+    mutationKey: ["profiles"],
+    mutationFn: async (options: Omit<AuthArgsType, "ecosystem">) => {
+      const ecosystem: Ecosystem | undefined =
+        wallet && isEcosystemWallet(wallet)
+          ? { id: wallet.id, partnerId: wallet.getConfig()?.partnerId }
+          : undefined;
+      const optionsWithEcosystem = { ...options, ecosystem } as AuthArgsType;
+      return linkProfile(optionsWithEcosystem);
+    },
+  });
+}

package/src/react/native/hooks/wallets/useProfiles.ts

@@ -7,11 +7,10 @@ import { getProfiles } from "../../../../wallets/in-app/web/lib/auth/index.js";
 import { useAdminWallet } from "../../../core/hooks/wallets/useAdminWallet.js";
 
 /**
- * Retrieves all linked profiles of the connected in-app or ecosystem wallet.
+ * Retrieves all linked profiles of the connected in-app or ecosystem account.
  *
- * @returns A React Query result containing the linked profiles for the connected in-app wallet.
- *
- * @note This hook will only run if the connected wallet supports multi-auth (in-app wallets).
+ * @returns A React Query result containing the linked profiles for the connected in-app account.
+ * @note This hook will only run if the connected wallet supports account linking.
  *
  * @example
  * ```jsx

package/src/react/web/hooks/wallets/useLinkProfile.ts

@@ -0,0 +1,91 @@
+import { useMutation } from "@tanstack/react-query";
+import { isEcosystemWallet } from "../../../../wallets/ecosystem/is-ecosystem-wallet.js";
+import type { AuthArgsType } from "../../../../wallets/in-app/core/authentication/types.js";
+import type { Ecosystem } from "../../../../wallets/in-app/core/wallet/types.js";
+import { linkProfile } from "../../../../wallets/in-app/web/lib/auth/index.js";
+import { useAdminWallet } from "../../../core/hooks/wallets/useAdminWallet.js";
+
+/**
+ * Links a web2 or web3 profile to the connected in-app or ecosystem account.
+ * **When a profile is linked to the account, that profile can then be used to sign into the same account.**
+ *
+ * @example
+ *
+ * ### Linking a social profile
+ *
+ * ```jsx
+ * import { useLinkProfile } from "thirdweb/react";
+ *
+ * const { mutate: linkProfile } = useLinkProfile();
+ *
+ * const onClick = () => {
+ *   linkProfile({
+ *     client,
+ *     strategy: "discord", // or "google", "x", "telegram", etc
+ *   });
+ * };
+ * ```
+ *
+ * ### Linking an email
+ *
+ * ```jsx
+ * import { useLinkProfile } from "thirdweb/react";
+ * import { preAuthenticate } from "thirdweb/wallets";
+ *
+ * const { mutate: linkProfile } = useLinkProfile();
+ *
+ * // send a verification email first
+ * const sendEmail = async () => {
+ *   const email = await preAuthenticate({
+ *     client,
+ *     strategy: "email",
+ *     email: "john.doe@example.com",
+ *   });
+ * };
+ *
+ * // then link the profile with the verification code
+ * const onClick = (code: string) => {
+ *   linkProfile({
+ *     client,
+ *     strategy: "email",
+ *     email: "john.doe@example.com",
+ *     verificationCode: code,
+ *   });
+ * };
+ * ```
+ *
+ * The same process can be used for phone and email, simply swap out the `strategy` parameter.
+ *
+ * ### Linking a wallet
+ *
+ * ```jsx
+ * import { useLinkProfile } from "thirdweb/react";
+ *
+ * const { mutate: linkProfile } = useLinkProfile();
+ *
+ * const onClick = () => {
+ *   linkProfile({
+ *     client,
+ *     strategy: "wallet",
+ *     wallet: createWallet("io.metamask"), // autocompletion for 400+ wallet ids
+ *     chain: sepolia, // any chain works, needed for SIWE signature
+ *   });
+ * };
+ * ```
+ *
+ * @wallet
+ */
+export function useLinkProfile() {
+  const wallet = useAdminWallet();
+  return useMutation({
+    mutationKey: ["profiles"],
+    mutationFn: async (options: AuthArgsType) => {
+      const ecosystem: Ecosystem | undefined =
+        wallet && isEcosystemWallet(wallet)
+          ? { id: wallet.id, partnerId: wallet.getConfig()?.partnerId }
+          : undefined;
+      const optionsWithEcosystem = { ...options, ecosystem } as AuthArgsType;
+      return linkProfile(optionsWithEcosystem);
+    },
+  });
+}

package/src/react/web/hooks/wallets/useProfiles.ts

@@ -7,11 +7,10 @@ import { getProfiles } from "../../../../wallets/in-app/web/lib/auth/index.js";
 import { useAdminWallet } from "../../../core/hooks/wallets/useAdminWallet.js";
 
 /**
- * Retrieves all linked profiles of the connected in-app or ecosystem wallet.
+ * Retrieves all linked profiles of the connected in-app or ecosystem account.
  *
- * @returns A React Query result containing the linked profiles for the connected in-app wallet.
- *
- * @note This hook will only run if the connected wallet supports multi-auth (in-app wallets).
+ * @returns A React Query result containing the linked profiles for the connected in-app account.
+ * @note This hook will only run if the connected wallet supports account linking.
  *
  * @example
  * ```jsx

package/src/utils/any-evm/zksync/isZkSyncChain.ts

@@ -15,7 +15,8 @@ export async function isZkSyncChain(chain: Chain) {
     chain.id === 282 ||
     chain.id === 388 ||
     chain.id === 4654 ||
-    chain.id === 333271
+    chain.id === 333271 ||
+    chain.id === 37111
   ) {
     return true;
   }

package/src/version.ts

@@ -1 +1 @@
-export const version = "5.60.1";
+export const version = "5.61.0";

package/src/wallets/in-app/core/authentication/types.ts

@@ -91,6 +91,7 @@ export type OAuthRedirectObject = {
   redirectUrl: string;
 };
 
+// TODO: type this better for each auth provider
 export type Profile = {
   type: AuthOption | "wallet";
   details: {

package/src/wallets/in-app/core/users/getUser.ts

@@ -3,6 +3,7 @@ import { getThirdwebBaseUrl } from "../../../../utils/domains.js";
 import { getClientFetch } from "../../../../utils/fetch.js";
 import type { OneOf, Prettify } from "../../../../utils/type-utils.js";
 import type { Profile } from "../authentication/types.js";
+import type { Ecosystem } from "../wallet/types.js";
 
 export type GetUserResult = {
   userId: string;
@@ -17,24 +18,23 @@ export type GetUserResult = {
  * Gets user based on the provided query parameters.
  * @note This function is only available on the server (a secret key is required in the client).
  *
- * @param options - The options for the find users function.
+ * @param options - The options for the get user function.
  * @param options.client - The Thirdweb client with a secret key included.
- * @param [options.walletAddress] - The wallet address to query by.
+ * @param [options.walletAddress] - The wallet address generated by thirdweb to query by.
  * @param [options.email] - The email to query by.
  * @param [options.phone] - The phone number to query by.
  * @param [options.id] - The user ID to query by.
+ * @param [options.externalWalletAddress] - The linked external wallet address to query by.
  *
- * @returns An array of user objects.
+ * @returns A user object or null if not found.
  *
  * @example
- * ```ts
  * import { getUser } from "thirdweb/wallets";
  *
  * const user = await getUser({
  *   client,
  *   walletAddress: "0x123...",
  * });
- * ```
  *
  * @wallet
  */
@@ -44,14 +44,18 @@ export async function getUser({
   email,
   phone,
   id,
+  externalWalletAddress,
+  ecosystem,
 }: Prettify<
   {
     client: ThirdwebClient;
+    ecosystem?: Ecosystem;
   } & OneOf<{
     walletAddress?: string;
     email?: string;
     phone?: string;
     id?: string;
+    externalWalletAddress?: string;
   }>
 >): Promise<GetUserResult | null> {
   if (!client.secretKey) {
@@ -76,13 +80,16 @@ export async function getUser({
   } else if (id) {
     url.searchParams.set("queryBy", "id");
     url.searchParams.set("id", id);
+  } else if (externalWalletAddress) {
+    url.searchParams.set("queryBy", "externalWalletAddress");
+    url.searchParams.set("externalWalletAddress", externalWalletAddress);
   } else {
     throw new Error(
-      "Please provide a walletAddress, email, phone, or id to query for users.",
+      "Please provide a walletAddress, email, phone, id, or externalWalletAddress to query for users.",
     );
   }
 
-  const clientFetch = getClientFetch(client);
+  const clientFetch = getClientFetch(client, ecosystem);
 
   const res = await clientFetch(url.toString());
 

package/src/wallets/in-app/native/native-connector.ts

@@ -288,6 +288,7 @@ export class InAppNativeConnector implements InAppConnector {
       client: args.client,
       tokenToLink: storedToken.cookieString,
       storage: this.localStorage,
+      ecosystem: args.ecosystem || this.ecosystem,
     });
   }
 

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

@@ -152,9 +152,9 @@ export async function authenticate(args: AuthArgsType) {
  * @returns A promise that resolves to the authentication result.
  * @example
  * ```ts
- * import { authenticate } from "thirdweb/wallets/in-app";
+ * import { authenticateWithRedirect } from "thirdweb/wallets/in-app";
  *
- * const result = await authenticate({
+ * const result = await authenticateWithRedirect({
  *  client,
  *  strategy: "google",
  *  mode: "redirect",
@@ -180,25 +180,21 @@ export async function authenticateWithRedirect(
 }
 
 /**
- * Connects a new profile (authentication method) to the current user.
- * The connected profile can be any valid in-app wallet including email, phone, passkey, etc.
- * The inputs mirror those used when authenticating normally.
+ * Connects a new profile (and new authentication method) to the current user.
  *
- * **When a profile is linked to the account, that profile can then be used to sign into the account.**
+ * Requires a connected in-app or ecosystem account.
  *
- * This method is only available for in-app wallets.
+ * **When a profile is linked to the account, that profile can then be used to sign into the same account.**
  *
- * @param wallet - The wallet to link an additional profile to.
  * @param auth - The authentications options to add the new profile.
  * @returns A promise that resolves to the currently linked profiles when the connection is successful.
  * @throws If the connection fails, if the profile is already linked to the account, or if the profile is already associated with another account.
  *
  * @example
  * ```ts
- * const wallet = inAppWallet();
+ * import { linkProfile } from "thirdweb/wallets";
  *
- * await wallet.connect({ client, strategy: "google" });
- * const profiles = await linkProfile({ client, strategy: "discord" });
+ * await linkProfile({ client, strategy: "discord" });
  * ```
  * @wallet
  */
@@ -214,17 +210,28 @@ export async function linkProfile(args: AuthArgsType) {
  *
  * @example
  * ```ts
- * import { inAppWallet } from "thirdweb/wallets";
- *
- * const wallet = inAppWallet();
- * wallet.connect({ strategy: "google" });
+ * import { getProfiles } from "thirdweb/wallets";
  *
  * const profiles = await getProfiles({
  *  client,
  * });
  *
- * console.log(profiles[0].type);
+ * console.log(profiles[0].type); // will be "email", "phone", "google", "discord", etc
  * console.log(profiles[0].details.email);
+ * console.log(profiles[0].details.phone);
+ * ```
+ *
+ * ### Getting profiles for a ecosystem user
+ *
+ * ```ts
+ * import { getProfiles } from "thirdweb/wallets/in-app";
+ *
+ * const profiles = await getProfiles({
+ *  client,
+ *  ecosystem: {
+ *    id: "ecosystem.your-ecosystem-id",
+ *  },
+ * });
  * ```
  * @wallet
  */

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

@@ -444,6 +444,7 @@ export class InAppWebConnector implements InAppConnector {
       client: args.client,
       tokenToLink: storedToken.cookieString,
       storage: this.localStorage,
+      ecosystem: args.ecosystem || this.ecosystem,
     });
   }