thirdweb 5.45.1 → 5.45.2-nightly-b15aa4cdff3f3b233025da285780668a18fe29ab-20240813000336

package/src/extensions/split/__generated__/Split/read/totalShares.ts

@@ -0,0 +1,72 @@
+import { readContract } from "../../../../../transaction/read-contract.js";
+import type { BaseTransactionOptions } from "../../../../../transaction/types.js";
+
+import { decodeAbiParameters } from "viem";
+import type { Hex } from "../../../../../utils/encoding/hex.js";
+import type { ThirdwebContract } from "../../../../../contract/contract.js";
+import { detectMethod } from "../../../../../utils/bytecode/detectExtension.js";
+
+export const FN_SELECTOR = "0x3a98ef39" as const;
+const FN_INPUTS = [] as const;
+const FN_OUTPUTS = [
+  {
+    type: "uint256",
+  },
+] as const;
+
+/**
+ * Checks if the `totalShares` method is supported by the given contract.
+ * @param contract The ThirdwebContract.
+ * @returns A promise that resolves to a boolean indicating if the `totalShares` method is supported.
+ * @extension SPLIT
+ * @example
+ * ```ts
+ * import { isTotalSharesSupported } from "thirdweb/extensions/split";
+ *
+ * const supported = await isTotalSharesSupported(contract);
+ * ```
+ */
+export async function isTotalSharesSupported(contract: ThirdwebContract<any>) {
+  return detectMethod({
+    contract,
+    method: [FN_SELECTOR, FN_INPUTS, FN_OUTPUTS] as const,
+  });
+}
+
+/**
+ * Decodes the result of the totalShares function call.
+ * @param result - The hexadecimal result to decode.
+ * @returns The decoded result as per the FN_OUTPUTS definition.
+ * @extension SPLIT
+ * @example
+ * ```ts
+ * import { decodeTotalSharesResult } from "thirdweb/extensions/split";
+ * const result = decodeTotalSharesResult("...");
+ * ```
+ */
+export function decodeTotalSharesResult(result: Hex) {
+  return decodeAbiParameters(FN_OUTPUTS, result)[0];
+}
+
+/**
+ * Calls the "totalShares" function on the contract.
+ * @param options - The options for the totalShares function.
+ * @returns The parsed result of the function call.
+ * @extension SPLIT
+ * @example
+ * ```ts
+ * import { totalShares } from "thirdweb/extensions/split";
+ *
+ * const result = await totalShares({
+ *  contract,
+ * });
+ *
+ * ```
+ */
+export async function totalShares(options: BaseTransactionOptions) {
+  return readContract({
+    contract: options.contract,
+    method: [FN_SELECTOR, FN_INPUTS, FN_OUTPUTS] as const,
+    params: [],
+  });
+}

package/src/extensions/split/read/getAllRecipientsAddresses.test.ts

@@ -0,0 +1,39 @@
+import { describe, expect, it } from "vitest";
+import { ANVIL_CHAIN } from "~test/chains.js";
+import { TEST_CLIENT } from "~test/test-clients.js";
+import { TEST_ACCOUNT_A } from "~test/test-wallets.js";
+import { getContract } from "../../../contract/contract.js";
+import { deploySplitContract } from "../../../extensions/prebuilts/deploy-split.js";
+import { getAllRecipientsAddresses } from "./getAllRecipientsAddresses.js";
+
+const chain = ANVIL_CHAIN;
+const client = TEST_CLIENT;
+
+describe.runIf(process.env.TW_SECRET_KEY)("getAllRecipientsAddresses", () => {
+  it("should work", async () => {
+    const payees = [
+      "0x12345674b599ce99958242b3D3741e7b01841DF3",
+      "0xA6f11e47dE28B3dB934e945daeb6F538E9019694",
+    ];
+    const address = await deploySplitContract({
+      account: TEST_ACCOUNT_A,
+      client: TEST_CLIENT,
+      chain: ANVIL_CHAIN,
+      params: {
+        name: "split-contract",
+        payees,
+        shares: [
+          5100n, // 51%
+          4900n, // 49%
+        ],
+      },
+    });
+    const contract = getContract({
+      address,
+      chain,
+      client,
+    });
+    const result = await getAllRecipientsAddresses({ contract });
+    expect(result).toStrictEqual(payees);
+  });
+});

package/src/extensions/split/read/getAllRecipientsAddresses.ts

@@ -0,0 +1,26 @@
+import type { BaseTransactionOptions } from "../../../transaction/types.js";
+import { payee } from "../__generated__/Split/read/payee.js";
+import { payeeCount } from "../__generated__/Split/read/payeeCount.js";
+
+/**
+ * Get the addresses of all recipients of a [`thirdweb Split contract`](https://thirdweb.com/thirdweb.eth/Split)
+ * @extension SPLIT
+ * @returns an array of wallet addresses
+ *
+ * @example
+ * ```ts
+ * import { getAllRecipientsAddresses } from "thirdweb/extensions/split";
+ *
+ * const addresses = await getAllRecipientsAddresses({ contract });
+ */
+export async function getAllRecipientsAddresses(
+  options: BaseTransactionOptions,
+): Promise<string[]> {
+  const { contract } = options;
+  const _totalRecipients = await payeeCount(options);
+  const indexes = Array.from({ length: Number(_totalRecipients) }, (_, i) => i);
+  const recipientAddresses = await Promise.all(
+    indexes.map((index) => payee({ contract, index: BigInt(index) })),
+  );
+  return recipientAddresses;
+}

package/src/extensions/split/read/getAllRecipientsPercentages.test.ts

@@ -0,0 +1,48 @@
+import { describe, expect, it } from "vitest";
+import { ANVIL_CHAIN } from "~test/chains.js";
+import { TEST_CLIENT } from "~test/test-clients.js";
+import { TEST_ACCOUNT_A } from "~test/test-wallets.js";
+import { getContract } from "../../../contract/contract.js";
+import { deploySplitContract } from "../../../extensions/prebuilts/deploy-split.js";
+import { getAllRecipientsPercentages } from "./getAllRecipientsPercentages.js";
+
+const chain = ANVIL_CHAIN;
+const client = TEST_CLIENT;
+
+describe.runIf(process.env.TW_SECRET_KEY)("getAllRecipientsPercentages", () => {
+  it("should work", async () => {
+    const payees = [
+      "0x12345674b599ce99958242b3D3741e7b01841DF3",
+      "0xA6f11e47dE28B3dB934e945daeb6F538E9019694",
+    ];
+    const address = await deploySplitContract({
+      account: TEST_ACCOUNT_A,
+      client: TEST_CLIENT,
+      chain: ANVIL_CHAIN,
+      params: {
+        name: "split-contract",
+        payees,
+        shares: [
+          5100n, // 51%
+          4900n, // 49%
+        ],
+      },
+    });
+    const contract = getContract({
+      address,
+      chain,
+      client,
+    });
+    const result = await getAllRecipientsPercentages({ contract });
+    expect(result).toStrictEqual([
+      {
+        address: "0x12345674b599ce99958242b3D3741e7b01841DF3",
+        splitPercentage: 51,
+      },
+      {
+        address: "0xA6f11e47dE28B3dB934e945daeb6F538E9019694",
+        splitPercentage: 49,
+      },
+    ]);
+  });
+});

package/src/extensions/split/read/getAllRecipientsPercentages.ts

@@ -0,0 +1,41 @@
+import type { BaseTransactionOptions } from "../../../transaction/types.js";
+import { getAllRecipientsAddresses } from "./getAllRecipientsAddresses.js";
+import {
+  type SplitRecipient,
+  getRecipientSplitPercentage,
+} from "./getRecipientSplitPercentage.js";
+
+/**
+ * Get all the recipients of a Split contracts
+ * @extension SPLIT
+ * @returns an array of recipients' addresses and split percentage of each
+ *
+ * @example
+ * ```ts
+ * import { getAllRecipientsPercentages } from "thirdweb/extensions/split";
+ *
+ * const allRecipients = await getAllRecipientsPercentages({ contract });
+ * // Example result:
+ * [
+ *   {
+ *     address: "0x1...",
+ *     splitPercentage: 25, // 25%
+ *   },
+ *   {
+ *     address: "0x2...",
+ *     splitPercentage: 75, // 75%
+ *   },
+ * ];
+ * ```
+ */
+export async function getAllRecipientsPercentages(
+  options: BaseTransactionOptions,
+): Promise<SplitRecipient[]> {
+  const { contract } = options;
+  const recipientAddresses = await getAllRecipientsAddresses({ contract });
+  return await Promise.all(
+    recipientAddresses.map((recipientAddress) =>
+      getRecipientSplitPercentage({ contract, recipientAddress }),
+    ),
+  );
+}

package/src/extensions/split/read/getRecipientSplitPercentage.test.ts

@@ -0,0 +1,45 @@
+import { describe, expect, it } from "vitest";
+import { ANVIL_CHAIN } from "~test/chains.js";
+import { TEST_CLIENT } from "~test/test-clients.js";
+import { TEST_ACCOUNT_A } from "~test/test-wallets.js";
+import { getContract } from "../../../contract/contract.js";
+import { deploySplitContract } from "../../../extensions/prebuilts/deploy-split.js";
+import { getRecipientSplitPercentage } from "./getRecipientSplitPercentage.js";
+const chain = ANVIL_CHAIN;
+const client = TEST_CLIENT;
+
+describe.runIf(process.env.TW_SECRET_KEY)("getRecipientSplitPercentage", () => {
+  it("should work", async () => {
+    const payees = [
+      "0x12345674b599ce99958242b3D3741e7b01841DF3",
+      "0xA6f11e47dE28B3dB934e945daeb6F538E9019694",
+    ];
+    const address = await deploySplitContract({
+      account: TEST_ACCOUNT_A,
+      client: TEST_CLIENT,
+      chain: ANVIL_CHAIN,
+      params: {
+        name: "split-contract",
+        payees,
+        shares: [
+          5100n, // 51%
+          4900n, // 49%
+        ],
+      },
+    });
+    const contract = getContract({
+      address,
+      chain,
+      client,
+    });
+    const result = await getRecipientSplitPercentage({
+      contract,
+      recipientAddress: "0x12345674b599ce99958242b3D3741e7b01841DF3",
+    });
+
+    expect(result).toStrictEqual({
+      address: "0x12345674b599ce99958242b3D3741e7b01841DF3",
+      splitPercentage: 51,
+    });
+  });
+});

package/src/extensions/split/read/getRecipientSplitPercentage.ts

@@ -0,0 +1,40 @@
+import type { BaseTransactionOptions } from "../../../transaction/types.js";
+import { shares } from "../__generated__/Split/read/shares.js";
+import { totalShares } from "../__generated__/Split/read/totalShares.js";
+
+/**
+ * @extension SPLIT
+ */
+export interface SplitRecipient {
+  /**
+   * The address of the recipient
+   */
+  address: string;
+
+  /**
+   * The split of the recipient as a percentage of the total amount
+   *
+   * I.e. If a recipient has a split of 50%, and the asset sells for 100 ETH,
+   * the recipient will receive 50 ETH.
+   */
+  splitPercentage: number;
+}
+
+export async function getRecipientSplitPercentage(
+  options: BaseTransactionOptions<{ recipientAddress: string }>,
+): Promise<SplitRecipient> {
+  const { contract, recipientAddress } = options;
+  const [_totalShares, walletsShares] = await Promise.all([
+    totalShares({ contract }),
+    shares({ contract, account: recipientAddress }),
+  ]);
+  // We convert to basis points to avoid floating point loss of precision
+  // 7544n -> 75.44 (75.44 %)
+  // also we don't have to worry about number overflow in this particular context
+  const splitPercentage =
+    (Number(walletsShares) * 1e7) / Number(_totalShares) / 1e5;
+  return {
+    address: recipientAddress,
+    splitPercentage,
+  };
+}

package/src/react/core/hooks/auth/useSiweAuth.ts

@@ -1,6 +1,7 @@
 import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
 import type { LoginPayload } from "../../../../auth/core/types.js";
 import type { VerifyLoginPayloadParams } from "../../../../auth/core/verify-login-payload.js";
+import { getCachedChain } from "../../../../chains/utils.js";
 import type { Account, Wallet } from "../../../../wallets/interfaces/wallet.js";
 
 /**
@@ -95,6 +96,12 @@ export function useSiweAuth(
         import("../../../../auth/core/sign-login-payload.js"),
       ]);
 
+      if (payload.chain_id) {
+        await activeWallet.switchChain(
+          getCachedChain(Number(payload.chain_id)),
+        );
+      }
+
       const signedPayload = await signLoginPayload({
         payload,
         account: activeAccount,

package/src/react/core/hooks/others/useProfiles.ts

@@ -5,7 +5,7 @@ import type { Wallet } from "../../../../wallets/interfaces/wallet.js";
 import { useActiveWallet } from "../wallets/useActiveWallet.js";
 
 /**
- * @description Retrieves all linked profiles for the current wallet.
+ * Retrieves all linked profiles for the current wallet.
  *
  * @returns A React Query result containing the linked profiles for the connected in-app wallet.
  *

package/src/version.ts

@@ -1 +1 @@
-export const version = "5.45.1";
+export const version = "5.45.2-nightly-b15aa4cdff3f3b233025da285780668a18fe29ab-20240813000336";

package/src/wallets/in-app/core/wallet/profiles.ts

@@ -6,7 +6,6 @@ import type {
 } from "../authentication/types.js";
 
 /**
- * @description
  * Gets the linked profiles for the provided wallet.
  * This method is only available for in-app wallets.
  *
@@ -24,6 +23,7 @@ import type {
  * console.log(profiles[0].type);
  * console.log(profiles[0].details.email);
  * ```
+ * @wallet
  */
 export async function getProfiles(wallet: Wallet<"inApp">) {
   if (wallet.id !== "inApp") {
@@ -36,10 +36,9 @@ export async function getProfiles(wallet: Wallet<"inApp">) {
 }
 
 /**
- * @description
  * 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, @see {@link Wallet.connect}
+ * The inputs mirror those used when authenticating normally.
  *
  * **When a profile is linked to the account, that profile can then be used to sign into the account.**
  *
@@ -57,6 +56,7 @@ export async function getProfiles(wallet: Wallet<"inApp">) {
  * await wallet.connect({ strategy: "google" });
  * const profiles = await linkProfile(wallet, { strategy: "discord" });
  * ```
+ * @wallet
  */
 export async function linkProfile(
   wallet: Wallet<"inApp">,