distribute token

Author: kumaryash90

packages/thirdweb/src/assets/distribute-token.test.ts

@@ -0,0 +1,106 @@
+import { type ThirdwebContract, getContract } from "src/contract/contract.js";
+import { getBalance } from "src/extensions/erc20/read/getBalance.js";
+import { approve } from "src/extensions/erc20/write/approve.js";
+import { sendAndConfirmTransaction } from "src/transaction/actions/send-and-confirm-transaction.js";
+import { beforeAll, describe, expect, it } from "vitest";
+import { ANVIL_CHAIN } from "../../test/src/chains.js";
+import { TEST_CLIENT } from "../../test/src/test-clients.js";
+import {
+  TEST_ACCOUNT_A,
+  TEST_ACCOUNT_B,
+  TEST_ACCOUNT_C,
+  TEST_ACCOUNT_D,
+} from "../../test/src/test-wallets.js";
+import { createTokenByImplConfig } from "./create-token-by-impl-config.js";
+import { distributeToken } from "./distribute-token.js";
+import { getDeployedEntrypointERC20 } from "./get-entrypoint-erc20.js";
+
+describe.runIf(process.env.TW_SECRET_KEY)("create token by impl config", () => {
+  let token: ThirdwebContract;
+  beforeAll(async () => {
+    // create token
+    const tokenAddress = await createTokenByImplConfig({
+      chain: ANVIL_CHAIN,
+      client: TEST_CLIENT,
+      account: TEST_ACCOUNT_A,
+      params: {
+        name: "Test",
+        maxSupply: 10_000_000_000n,
+      },
+      salt: "salt123",
+    });
+
+    token = getContract({
+      address: tokenAddress,
+      client: TEST_CLIENT,
+      chain: ANVIL_CHAIN,
+    });
+
+    // approve tokens to entrypoint for distribution
+    const entrypoint = await getDeployedEntrypointERC20({
+      chain: ANVIL_CHAIN,
+      client: TEST_CLIENT,
+    });
+
+    const approvalTx = approve({
+      contract: token,
+      spender: entrypoint?.address as string,
+      amountWei: 1000n,
+    });
+    await sendAndConfirmTransaction({
+      transaction: approvalTx,
+      account: TEST_ACCOUNT_A,
+    });
+  });
+
+  it("should distrbute tokens to specified recipients", async () => {
+    const contents = [
+      { recipient: TEST_ACCOUNT_B.address, amount: 10n },
+      { recipient: TEST_ACCOUNT_C.address, amount: 15n },
+      { recipient: TEST_ACCOUNT_D.address, amount: 20n },
+    ];
+
+    await distributeToken({
+      account: TEST_ACCOUNT_A,
+      client: TEST_CLIENT,
+      chain: ANVIL_CHAIN,
+      tokenAddress: token.address,
+      contents,
+    });
+
+    const balanceB = (
+      await getBalance({
+        contract: token,
+        address: TEST_ACCOUNT_B.address,
+      })
+    ).value;
+
+    const balanceC = (
+      await getBalance({
+        contract: token,
+        address: TEST_ACCOUNT_C.address,
+      })
+    ).value;
+
+    const balanceD = (
+      await getBalance({
+        contract: token,
+        address: TEST_ACCOUNT_D.address,
+      })
+    ).value;
+
+    // admin balance
+    const balanceA = (
+      await getBalance({
+        contract: token,
+        address: TEST_ACCOUNT_A.address,
+      })
+    ).value;
+
+    expect(balanceB).to.equal(10n);
+    expect(balanceC).to.equal(15n);
+    expect(balanceD).to.equal(20n);
+
+    expect(balanceA).to.equal(10_000_000_000n - balanceB - balanceC - balanceD);
+  });
+});

packages/thirdweb/src/assets/distribute-token.ts

@@ -0,0 +1,29 @@
+import { distributeAsset } from "../extensions/assets/__generated__/AssetEntrypointERC20/write/distributeAsset.js";
+import { sendTransaction } from "../transaction/actions/send-transaction.js";
+import type { ClientAndChainAndAccount } from "../utils/types.js";
+import { getDeployedEntrypointERC20 } from "./get-entrypoint-erc20.js";
+import type { DistributeContent } from "./types.js";
+
+type DistrbuteTokenParams = ClientAndChainAndAccount & {
+  tokenAddress: string;
+  contents: DistributeContent[];
+};
+
+export async function distributeToken(options: DistrbuteTokenParams) {
+  const entrypoint = await getDeployedEntrypointERC20(options);
+
+  if (!entrypoint) {
+    throw new Error(`Entrypoint not found on chain: ${options.chain.id}`);
+  }
+
+  const transaction = distributeAsset({
+    contract: entrypoint,
+    asset: options.tokenAddress,
+    contents: options.contents,
+  });
+
+  return await sendTransaction({
+    transaction,
+    account: options.account,
+  });
+}

packages/thirdweb/src/assets/types.ts

@@ -30,7 +30,7 @@ export type MarketConfig = {
   hookInitData?: string;
 };
 
-type DistributeContent = {
+export type DistributeContent = {
   amount: bigint;
   recipient: string;
 };