thirdweb 5.45.0 → 5.45.2-nightly-141fd53759f1b5515e38688fe96364edc4c76644-20240812000351

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("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("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/version.ts

@@ -1 +1 @@
-export const version = "5.45.0";
+export const version = "5.45.2-nightly-141fd53759f1b5515e38688fe96364edc4c76644-20240812000351";