thirdweb 5.45.1 → 5.45.2-nightly-141fd53759f1b5515e38688fe96364edc4c76644-20240812000351

package/dist/types/extensions/split/__generated__/Split/read/totalShares.d.ts

@@ -0,0 +1,46 @@
+import type { BaseTransactionOptions } from "../../../../../transaction/types.js";
+import type { Hex } from "../../../../../utils/encoding/hex.js";
+import type { ThirdwebContract } from "../../../../../contract/contract.js";
+export declare const FN_SELECTOR: "0x3a98ef39";
+/**
+ * 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 declare function isTotalSharesSupported(contract: ThirdwebContract<any>): Promise<boolean>;
+/**
+ * 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 declare function decodeTotalSharesResult(result: Hex): bigint;
+/**
+ * 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 declare function totalShares(options: BaseTransactionOptions): Promise<bigint>;
+//# sourceMappingURL=totalShares.d.ts.map

package/dist/types/extensions/split/__generated__/Split/read/totalShares.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"totalShares.d.ts","sourceRoot":"","sources":["../../../../../../../src/extensions/split/__generated__/Split/read/totalShares.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAGlF,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,sCAAsC,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAG5E,eAAO,MAAM,WAAW,cAAwB,CAAC;AAQjD;;;;;;;;;;;GAWG;AACH,wBAAsB,sBAAsB,CAAC,QAAQ,EAAE,gBAAgB,CAAC,GAAG,CAAC,oBAK3E;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,GAAG,UAElD;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,WAAW,CAAC,OAAO,EAAE,sBAAsB,mBAMhE"}

package/dist/types/extensions/split/read/getAllRecipientsAddresses.d.ts

@@ -0,0 +1,14 @@
+import type { BaseTransactionOptions } from "../../../transaction/types.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 declare function getAllRecipientsAddresses(options: BaseTransactionOptions): Promise<string[]>;
+//# sourceMappingURL=getAllRecipientsAddresses.d.ts.map

package/dist/types/extensions/split/read/getAllRecipientsAddresses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getAllRecipientsAddresses.d.ts","sourceRoot":"","sources":["../../../../../src/extensions/split/read/getAllRecipientsAddresses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAI5E;;;;;;;;;;GAUG;AACH,wBAAsB,yBAAyB,CAC7C,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,MAAM,EAAE,CAAC,CAQnB"}

package/dist/types/extensions/split/read/getAllRecipientsPercentages.d.ts

@@ -0,0 +1,27 @@
+import type { BaseTransactionOptions } from "../../../transaction/types.js";
+import { type SplitRecipient } 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 declare function getAllRecipientsPercentages(options: BaseTransactionOptions): Promise<SplitRecipient[]>;
+//# sourceMappingURL=getAllRecipientsPercentages.d.ts.map

package/dist/types/extensions/split/read/getAllRecipientsPercentages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getAllRecipientsPercentages.d.ts","sourceRoot":"","sources":["../../../../../src/extensions/split/read/getAllRecipientsPercentages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAE5E,OAAO,EACL,KAAK,cAAc,EAEpB,MAAM,kCAAkC,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,2BAA2B,CAC/C,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,cAAc,EAAE,CAAC,CAQ3B"}

package/dist/types/extensions/split/read/getRecipientSplitPercentage.d.ts

@@ -0,0 +1,21 @@
+import type { BaseTransactionOptions } from "../../../transaction/types.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 declare function getRecipientSplitPercentage(options: BaseTransactionOptions<{
+    recipientAddress: string;
+}>): Promise<SplitRecipient>;
+//# sourceMappingURL=getRecipientSplitPercentage.d.ts.map

package/dist/types/extensions/split/read/getRecipientSplitPercentage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getRecipientSplitPercentage.d.ts","sourceRoot":"","sources":["../../../../../src/extensions/split/read/getRecipientSplitPercentage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAI5E;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,wBAAsB,2BAA2B,CAC/C,OAAO,EAAE,sBAAsB,CAAC;IAAE,gBAAgB,EAAE,MAAM,CAAA;CAAE,CAAC,GAC5D,OAAO,CAAC,cAAc,CAAC,CAezB"}

package/dist/types/version.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "5.45.1";
+export declare const version = "5.45.2-nightly-141fd53759f1b5515e38688fe96364edc4c76644-20240812000351";
 //# sourceMappingURL=version.d.ts.map

package/dist/types/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,2EAA2E,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "thirdweb",
-  "version": "5.45.1",
+  "version": "5.45.2-nightly-141fd53759f1b5515e38688fe96364edc4c76644-20240812000351",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/thirdweb-dev/js.git#main"

package/src/exports/deploys.ts

@@ -33,3 +33,8 @@ export {
   type PrepareDirectDeployTransactionOptions,
 } from "../contract/deployment/deploy-with-abi.js";
 export { computePublishedContractAddress } from "../utils/any-evm/compute-published-contract-address.js";
+export {
+  deploySplitContract,
+  type SplitContractParams,
+  type DeploySplitContractOptions,
+} from "../extensions/prebuilts/deploy-split.js";

package/src/exports/extensions/split.ts

@@ -34,6 +34,14 @@ export { totalReleased } from "../../extensions/split/__generated__/Split/read/t
 
 export { totalReleasedByToken } from "../../extensions/split/read/totalReleasedByToken.js";
 
+export { getAllRecipientsAddresses } from "../../extensions/split/read/getAllRecipientsAddresses.js";
+
+export { getAllRecipientsPercentages } from "../../extensions/split/read/getAllRecipientsPercentages.js";
+
+export {
+  getRecipientSplitPercentage,
+  type SplitRecipient,
+} from "../../extensions/split/read/getRecipientSplitPercentage.js";
 /**
  * WRITE
  */

package/src/extensions/prebuilts/__generated__/Split/write/initialize.ts

@@ -0,0 +1,191 @@
+import type { AbiParameterToPrimitiveType } from "abitype";
+import type {
+  BaseTransactionOptions,
+  WithOverrides,
+} from "../../../../../transaction/types.js";
+import { prepareContractCall } from "../../../../../transaction/prepare-contract-call.js";
+import { encodeAbiParameters } from "../../../../../utils/abi/encodeAbiParameters.js";
+import { once } from "../../../../../utils/promise/once.js";
+import type { ThirdwebContract } from "../../../../../contract/contract.js";
+import { detectMethod } from "../../../../../utils/bytecode/detectExtension.js";
+
+/**
+ * Represents the parameters for the "initialize" function.
+ */
+export type InitializeParams = WithOverrides<{
+  defaultAdmin: AbiParameterToPrimitiveType<{
+    type: "address";
+    name: "_defaultAdmin";
+  }>;
+  contractURI: AbiParameterToPrimitiveType<{
+    type: "string";
+    name: "_contractURI";
+  }>;
+  trustedForwarders: AbiParameterToPrimitiveType<{
+    type: "address[]";
+    name: "_trustedForwarders";
+  }>;
+  payees: AbiParameterToPrimitiveType<{ type: "address[]"; name: "_payees" }>;
+  shares: AbiParameterToPrimitiveType<{ type: "uint256[]"; name: "_shares" }>;
+}>;
+
+export const FN_SELECTOR = "0xb1a14437" as const;
+const FN_INPUTS = [
+  {
+    type: "address",
+    name: "_defaultAdmin",
+  },
+  {
+    type: "string",
+    name: "_contractURI",
+  },
+  {
+    type: "address[]",
+    name: "_trustedForwarders",
+  },
+  {
+    type: "address[]",
+    name: "_payees",
+  },
+  {
+    type: "uint256[]",
+    name: "_shares",
+  },
+] as const;
+const FN_OUTPUTS = [] as const;
+
+/**
+ * Checks if the `initialize` method is supported by the given contract.
+ * @param contract The ThirdwebContract.
+ * @returns A promise that resolves to a boolean indicating if the `initialize` method is supported.
+ * @extension PREBUILTS
+ * @example
+ * ```ts
+ * import { isInitializeSupported } from "thirdweb/extensions/prebuilts";
+ *
+ * const supported = await isInitializeSupported(contract);
+ * ```
+ */
+export async function isInitializeSupported(contract: ThirdwebContract<any>) {
+  return detectMethod({
+    contract,
+    method: [FN_SELECTOR, FN_INPUTS, FN_OUTPUTS] as const,
+  });
+}
+
+/**
+ * Encodes the parameters for the "initialize" function.
+ * @param options - The options for the initialize function.
+ * @returns The encoded ABI parameters.
+ * @extension PREBUILTS
+ * @example
+ * ```ts
+ * import { encodeInitializeParams } "thirdweb/extensions/prebuilts";
+ * const result = encodeInitializeParams({
+ *  defaultAdmin: ...,
+ *  contractURI: ...,
+ *  trustedForwarders: ...,
+ *  payees: ...,
+ *  shares: ...,
+ * });
+ * ```
+ */
+export function encodeInitializeParams(options: InitializeParams) {
+  return encodeAbiParameters(FN_INPUTS, [
+    options.defaultAdmin,
+    options.contractURI,
+    options.trustedForwarders,
+    options.payees,
+    options.shares,
+  ]);
+}
+
+/**
+ * Encodes the "initialize" function into a Hex string with its parameters.
+ * @param options - The options for the initialize function.
+ * @returns The encoded hexadecimal string.
+ * @extension PREBUILTS
+ * @example
+ * ```ts
+ * import { encodeInitialize } "thirdweb/extensions/prebuilts";
+ * const result = encodeInitialize({
+ *  defaultAdmin: ...,
+ *  contractURI: ...,
+ *  trustedForwarders: ...,
+ *  payees: ...,
+ *  shares: ...,
+ * });
+ * ```
+ */
+export function encodeInitialize(options: InitializeParams) {
+  // we do a "manual" concat here to avoid the overhead of the "concatHex" function
+  // we can do this because we know the specific formats of the values
+  return (FN_SELECTOR +
+    encodeInitializeParams(options).slice(
+      2,
+    )) as `${typeof FN_SELECTOR}${string}`;
+}
+
+/**
+ * Prepares a transaction to call the "initialize" function on the contract.
+ * @param options - The options for the "initialize" function.
+ * @returns A prepared transaction object.
+ * @extension PREBUILTS
+ * @example
+ * ```ts
+ * import { initialize } from "thirdweb/extensions/prebuilts";
+ *
+ * const transaction = initialize({
+ *  contract,
+ *  defaultAdmin: ...,
+ *  contractURI: ...,
+ *  trustedForwarders: ...,
+ *  payees: ...,
+ *  shares: ...,
+ *  overrides: {
+ *    ...
+ *  }
+ * });
+ *
+ * // Send the transaction
+ * ...
+ *
+ * ```
+ */
+export function initialize(
+  options: BaseTransactionOptions<
+    | InitializeParams
+    | {
+        asyncParams: () => Promise<InitializeParams>;
+      }
+  >,
+) {
+  const asyncOptions = once(async () => {
+    return "asyncParams" in options ? await options.asyncParams() : options;
+  });
+
+  return prepareContractCall({
+    contract: options.contract,
+    method: [FN_SELECTOR, FN_INPUTS, FN_OUTPUTS] as const,
+    params: async () => {
+      const resolvedOptions = await asyncOptions();
+      return [
+        resolvedOptions.defaultAdmin,
+        resolvedOptions.contractURI,
+        resolvedOptions.trustedForwarders,
+        resolvedOptions.payees,
+        resolvedOptions.shares,
+      ] as const;
+    },
+    value: async () => (await asyncOptions()).overrides?.value,
+    accessList: async () => (await asyncOptions()).overrides?.accessList,
+    gas: async () => (await asyncOptions()).overrides?.gas,
+    gasPrice: async () => (await asyncOptions()).overrides?.gasPrice,
+    maxFeePerGas: async () => (await asyncOptions()).overrides?.maxFeePerGas,
+    maxPriorityFeePerGas: async () =>
+      (await asyncOptions()).overrides?.maxPriorityFeePerGas,
+    nonce: async () => (await asyncOptions()).overrides?.nonce,
+    extraGas: async () => (await asyncOptions()).overrides?.extraGas,
+    erc20Value: async () => (await asyncOptions()).overrides?.erc20Value,
+  });
+}

package/src/extensions/prebuilts/deploy-split.test.ts

@@ -0,0 +1,31 @@
+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 { isAddress } from "../../utils/address.js";
+import { deploySplitContract } from "./deploy-split.js";
+
+describe("deploy-split contract", () => {
+  it("should deploy Split contract", async () => {
+    const address = await deploySplitContract({
+      account: TEST_ACCOUNT_A,
+      client: TEST_CLIENT,
+      chain: ANVIL_CHAIN,
+      params: {
+        name: "split-contract",
+        payees: [
+          "0x12345674b599ce99958242b3D3741e7b01841DF3",
+          "0xA6f11e47dE28B3dB934e945daeb6F538E9019694",
+        ],
+        shares: [
+          5100n, // 51%
+          4900n, // 49%
+        ],
+      },
+    });
+    expect(address).toBeDefined();
+    expect(isAddress(address)).toBe(true);
+    // Further tests to verify the functionality of this contract
+    // are done in other Split tests
+  });
+});

package/src/extensions/prebuilts/deploy-split.ts

@@ -0,0 +1,144 @@
+import type { ThirdwebClient } from "../../client/client.js";
+import type { ThirdwebContract } from "../../contract/contract.js";
+import { deployViaAutoFactory } from "../../contract/deployment/deploy-via-autofactory.js";
+import { getOrDeployInfraForPublishedContract } from "../../contract/deployment/utils/bootstrap.js";
+import { upload } from "../../storage/upload.js";
+import type { FileOrBufferOrString } from "../../storage/upload/types.js";
+import type { Prettify } from "../../utils/type-utils.js";
+import type { ClientAndChainAndAccount } from "../../utils/types.js";
+import { initialize } from "./__generated__/Split/write/initialize.js";
+
+/**
+ * @extension PREBUILT
+ */
+export type SplitContractParams = {
+  name: string;
+
+  /**
+   * An array of strings containing wallet addresses of the recipients
+   * For example:
+   * ```ts
+   * ["0x...123", "0x...456"]
+   * ```
+   */
+  payees: string[];
+  /**
+   * An array of bigints containing the shared percentages of each respective payees.
+   * Must have the same length as `payees`
+   * @example
+   * ```ts
+   * [
+   *   5100n, // 51%
+   *   4900n, // 49%
+   * ]
+   * ```
+   */
+  shares: bigint[];
+  description?: string;
+  image?: FileOrBufferOrString;
+  external_link?: string;
+  social_urls?: Record<string, string>;
+  symbol?: string;
+  contractURI?: string;
+  defaultAdmin?: string;
+  trustedForwarders?: string[];
+};
+
+/**
+ * @extension DEPLOY
+ */
+export type DeploySplitContractOptions = Prettify<
+  ClientAndChainAndAccount & {
+    params: SplitContractParams;
+  }
+>;
+
+/**
+ * Deploys a thirdweb [`Split contract`](https://thirdweb.com/thirdweb.eth/Split)
+ * On chains where the thirdweb infrastructure contracts are not deployed, this function will deploy them as well.
+ * @param options - The deployment options.
+ * @returns The deployed contract address.
+ * @extension DEPLOY
+ *
+ * @example
+ * ```ts
+ * import { deploySplitContract } from "thirdweb/deploys";
+ * const contractAddress = await deploySplitContract({
+ *  chain,
+ *  client,
+ *  account,
+ *  params: {
+ *    name: "Split contract",
+ *    payees: ["0x...123", "0x...456"],
+ *    shares: [5100, 4900], // See type `SplitContractParams` for more context
+ * });
+ * ```
+ */
+export async function deploySplitContract(options: DeploySplitContractOptions) {
+  const { chain, client, account, params } = options;
+  const { cloneFactoryContract, implementationContract } =
+    await getOrDeployInfraForPublishedContract({
+      chain,
+      client,
+      account,
+      contractId: "Split",
+      constructorParams: [],
+    });
+  const initializeTransaction = await getInitializeTransaction({
+    client,
+    implementationContract,
+    params,
+    accountAddress: account.address,
+  });
+
+  return deployViaAutoFactory({
+    client,
+    chain,
+    account,
+    cloneFactoryContract,
+    initializeTransaction,
+  });
+}
+
+async function getInitializeTransaction(options: {
+  client: ThirdwebClient;
+  implementationContract: ThirdwebContract;
+  params: SplitContractParams;
+  accountAddress: string;
+}) {
+  const { client, implementationContract, params, accountAddress } = options;
+  const {
+    name,
+    description,
+    symbol,
+    image,
+    external_link,
+    social_urls,
+    payees,
+    shares,
+  } = params;
+  const contractURI =
+    params.contractURI ||
+    (await upload({
+      client,
+      files: [
+        {
+          name,
+          description,
+          symbol,
+          image,
+          external_link,
+          social_urls,
+        },
+      ],
+    })) ||
+    "";
+  return initialize({
+    contract: implementationContract,
+    defaultAdmin: params.defaultAdmin || accountAddress,
+    contractURI,
+    trustedForwarders: params.trustedForwarders || [],
+    payees,
+    shares,
+  });
+}

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("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;
+}