implement additional extensions (#2735)

Author: jnsdls

.changeset/new-dots-move.md

@@ -0,0 +1,5 @@
+---
+"thirdweb": minor
+---
+
+added extension support for: Marketplace, ERC1155, ERC721

.vscode/settings.json

@@ -2,7 +2,8 @@
   "editor.formatOnSave": true,
   "editor.defaultFormatter": "biomejs.biome",
   "editor.codeActionsOnSave": {
-    "source.fixAll": "explicit"
+    "quickfix.biome": "explicit",
+    "source.organizeImports.biome": "explicit"
   },
   "typescript.preferences.importModuleSpecifier": "relative"
 }

packages/thirdweb/scripts/generate/abis/erc721/ISharedMetadata.json

@@ -1,4 +1,5 @@
 [
   "event SharedMetadataUpdated(string name, string description, string imageURI, string animationURI)",
-  "function setSharedMetadata((string name, string description, string imageURI, string animationURI) _metadata)"
+  "function setSharedMetadata((string name, string description, string imageURI, string animationURI) _metadata)",
+  "function sharedMetadata() view returns (string name, string description, string imageURI, string animationURI)"
 ]

packages/thirdweb/scripts/generate/abis/marketplace/IDirectListings.json

@@ -14,5 +14,8 @@
   "function getAllValidListings(uint256 _startId, uint256 _endId) view returns ((uint256 listingId, uint256 tokenId, uint256 quantity, uint256 pricePerToken, uint128 startTimestamp, uint128 endTimestamp, address listingCreator, address assetContract, address currency, uint8 tokenType, uint8 status, bool reserved)[] listings)",
   "function getListing(uint256 _listingId) view returns ((uint256 listingId, uint256 tokenId, uint256 quantity, uint256 pricePerToken, uint128 startTimestamp, uint128 endTimestamp, address listingCreator, address assetContract, address currency, uint8 tokenType, uint8 status, bool reserved) listing)",
   "function totalListings() view returns (uint256)",
-  "function updateListing(uint256 _listingId, (address assetContract, uint256 tokenId, uint256 quantity, address currency, uint256 pricePerToken, uint128 startTimestamp, uint128 endTimestamp, bool reserved) _params)"
+  "function updateListing(uint256 _listingId, (address assetContract, uint256 tokenId, uint256 quantity, address currency, uint256 pricePerToken, uint128 startTimestamp, uint128 endTimestamp, bool reserved) _params)",
+  "function isBuyerApprovedForListing(uint256 _listingId, address _buyer) view returns (bool)",
+  "function isCurrencyApprovedForListing(uint256 _listingId, address _currency) view returns (bool)",
+  "function currencyPriceForListing(uint256 _listingId, address _currency) view returns (uint256)"
 ]

packages/thirdweb/src/exports/extensions/erc1155.ts

@@ -33,6 +33,10 @@ export {
   balanceOf,
   type BalanceOfParams,
 } from "../../extensions/erc1155/__generated__/IERC1155/read/balanceOf.js";
+export {
+  isApprovedForAll,
+  type IsApprovedForAllParams,
+} from "../../extensions/erc1155/__generated__/IERC1155/read/isApprovedForAll.js";
 
 //WRITE
 
@@ -44,6 +48,41 @@ export {
   burnBatch,
   type BurnBatchParams,
 } from "../../extensions/erc1155/__generated__/IBurnableERC1155/write/burnBatch.js";
+export {
+  setApprovalForAll,
+  type SetApprovalForAllParams,
+} from "../../extensions/erc1155/__generated__/IERC1155/write/setApprovalForAll.js";
+export {
+  safeTransferFrom,
+  type SafeTransferFromParams,
+} from "../../extensions/erc1155/__generated__/IERC1155/write/safeTransferFrom.js";
+export {
+  safeBatchTransferFrom,
+  type SafeBatchTransferFromParams,
+} from "../../extensions/erc1155/__generated__/IERC1155/write/safeBatchTransferFrom.js";
+export {
+  mintTo,
+  type MintToParams,
+} from "../../extensions/erc1155/write/mintTo.js";
+export {
+  mintAdditionalSupplyTo,
+  type MintAdditionalSupplyToParams,
+} from "../../extensions/erc1155/write/mintAdditionalSupplyTo.js";
+
+// EVENTS
+
+export {
+  transferSingleEvent,
+  type TransferSingleEventFilters,
+} from "../../extensions/erc1155/__generated__/IERC1155/events/TransferSingle.js";
+export {
+  transferBatchEvent,
+  type TransferBatchEventFilters,
+} from "../../extensions/erc1155/__generated__/IERC1155/events/TransferBatch.js";
+export {
+  approvalForAllEvent,
+  type ApprovalForAllEventFilters,
+} from "../../extensions/erc1155/__generated__/IERC1155/events/ApprovalForAll.js";
 
 /**
  * DROPS extension for ERC1155

packages/thirdweb/src/exports/extensions/erc721.ts

@@ -97,6 +97,7 @@ export {
 /**
  * DROPS extension for ERC721
  */
+export { getClaimConditionById } from "../../extensions/erc721/__generated__/IDrop/read/getClaimConditionById.js";
 export { getActiveClaimCondition } from "../../extensions/erc721/drops/read/getActiveClaimCondition.js";
 export {
   claimTo,
@@ -111,3 +112,12 @@ export {
   type GenerateMintSignatureOptions,
   generateMintSignature,
 } from "../../extensions/erc721/write/sigMint.js";
+
+/**
+ * SHARED METADATA extension for ERC721
+ */
+export { sharedMetadata } from "../../extensions/erc721/__generated__/ISharedMetadata/read/sharedMetadata.js";
+export {
+  setSharedMetadata,
+  type SetSharedMetadataParams,
+} from "../../extensions/erc721/write/setSharedMetadata.js";

packages/thirdweb/src/exports/extensions/marketplace.ts

@@ -25,12 +25,44 @@ export {
   getAllValidListings,
   type GetAllValidListingParams,
 } from "../../extensions/marketplace/read/direct/getAllValidListings.js";
+export {
+  isBuyerApprovedForListing,
+  type IsBuyerApprovedForListingParams,
+} from "../../extensions/marketplace/read/direct/isBuyerApprovedForListing.js";
+export {
+  isCurrencyApprovedForListing,
+  type IsCurrencyApprovedForListingParams,
+} from "../../extensions/marketplace/__generated__/IDirectListings/read/isCurrencyApprovedForListing.js";
+export {
+  currencyPriceForListing,
+  type CurrencyPriceForListingParams,
+} from "../../extensions/marketplace/read/direct/currencyPriceForListing.js";
 
 // WRITE
 export {
   createListing,
   type CreateListingParams,
 } from "../../extensions/marketplace/write/direct/createListing.js";
+export {
+  updateListing,
+  type UpdateListingParams,
+} from "../../extensions/marketplace/write/direct/updateListing.js";
+export {
+  cancelListing,
+  type CancelListingParams,
+} from "../../extensions/marketplace/__generated__/IDirectListings/write/cancelListing.js";
+export {
+  buyFromListing,
+  type BuyFromListingParams,
+} from "../../extensions/marketplace/write/direct/buyFromListing.js";
+export {
+  approveBuyerForListing,
+  type ApproveBuyerForListingParams,
+} from "../../extensions/marketplace/__generated__/IDirectListings/write/approveBuyerForListing.js";
+export {
+  approveCurrencyForListing,
+  type ApproveCurrencyForListingParams,
+} from "../../extensions/marketplace/__generated__/IDirectListings/write/approveCurrencyForListing.js";
 
 // EVENTS
 export {

packages/thirdweb/src/extensions/erc1155/1155.test.ts

@@ -0,0 +1,170 @@
+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,
+} from "../../../test/src/test-wallets.js";
+import { type ThirdwebContract, getContract } from "../../contract/contract.js";
+import { sendAndConfirmTransaction } from "../../exports/transaction.js";
+import { getContractMetadata } from "../common/read/getContractMetadata.js";
+import { deployERC1155Contract } from "../prebuilts/deploy-erc1155.js";
+import { balanceOf } from "./__generated__/IERC1155/read/balanceOf.js";
+import { totalSupply } from "./__generated__/IERC1155/read/totalSupply.js";
+import { nextTokenIdToMint } from "./__generated__/IERC1155Enumerable/read/nextTokenIdToMint.js";
+import { getNFT } from "./read/getNFT.js";
+import { getNFTs } from "./read/getNFTs.js";
+import { mintAdditionalSupplyTo } from "./write/mintAdditionalSupplyTo.js";
+import { mintTo } from "./write/mintTo.js";
+
+describe.runIf(process.env.TW_SECRET_KEY)("TokenERC1155", () => {
+  let contract: ThirdwebContract;
+
+  beforeAll(async () => {
+    const contractAddress = await deployERC1155Contract({
+      account: TEST_ACCOUNT_A,
+      chain: ANVIL_CHAIN,
+      client: TEST_CLIENT,
+      params: {
+        name: "Test TokenERC1155",
+      },
+      type: "TokenERC1155",
+    });
+
+    contract = getContract({
+      address: contractAddress,
+      chain: ANVIL_CHAIN,
+      client: TEST_CLIENT,
+    });
+    // this deploys a contract, it may take some time
+  }, 60_000);
+
+  describe("Deployment", () => {
+    it("should deploy", async () => {
+      expect(contract).toBeDefined();
+    });
+    it("should have the correct name", async () => {
+      const metadata = await getContractMetadata({ contract });
+      expect(metadata.name).toBe("Test TokenERC1155");
+    });
+  });
+
+  it("should allow for minting tokens", async () => {
+    // initially no tokens minted
+    await expect(nextTokenIdToMint({ contract })).resolves.toBe(0n);
+
+    // mint 1 token
+    const mintTx = mintTo({
+      contract,
+      to: TEST_ACCOUNT_A.address,
+      supply: 10n,
+      nft: { name: "Test NFT" },
+    });
+    await sendAndConfirmTransaction({
+      transaction: mintTx,
+      account: TEST_ACCOUNT_A,
+    });
+
+    // now 1 token minted
+    await expect(nextTokenIdToMint({ contract })).resolves.toBe(1n);
+    // tokenId 0 is minted
+    await expect(
+      getNFT({ contract, tokenId: 0n }),
+    ).resolves.toMatchInlineSnapshot(`
+        {
+          "id": 0n,
+          "metadata": {
+            "name": "Test NFT",
+          },
+          "owner": null,
+          "supply": 10n,
+          "tokenURI": "ipfs://QmUut8sypH8NaPUeksnirut7MgggMeQa9RvJ37sV513sw3/0",
+          "type": "ERC1155",
+        }
+      `);
+    // account should have a balance of 10
+    await expect(
+      balanceOf({ contract, owner: TEST_ACCOUNT_A.address, tokenId: 0n }),
+    ).resolves.toBe(10n);
+    // totalSupply should be 10
+    await expect(totalSupply({ contract, id: 0n })).resolves.toBe(10n);
+
+    // mint additional supply
+    const mintTx2 = mintAdditionalSupplyTo({
+      contract,
+      to: TEST_ACCOUNT_A.address,
+      supply: 5n,
+      tokenId: 0n,
+    });
+
+    await sendAndConfirmTransaction({
+      transaction: mintTx2,
+      account: TEST_ACCOUNT_A,
+    });
+
+    // still 1 token minted
+    await expect(nextTokenIdToMint({ contract })).resolves.toBe(1n);
+    // tokenId 0 is minted
+    // supply should be 15
+    await expect(
+      getNFT({ contract, tokenId: 0n }),
+    ).resolves.toMatchInlineSnapshot(`
+        {
+          "id": 0n,
+          "metadata": {
+            "name": "Test NFT",
+          },
+          "owner": null,
+          "supply": 15n,
+          "tokenURI": "ipfs://QmUut8sypH8NaPUeksnirut7MgggMeQa9RvJ37sV513sw3/0",
+          "type": "ERC1155",
+        }
+      `);
+    // account should have a balance of 15
+    await expect(
+      balanceOf({ contract, owner: TEST_ACCOUNT_A.address, tokenId: 0n }),
+    ).resolves.toBe(15n);
+    // totalSupply should be 15
+    await expect(totalSupply({ contract, id: 0n })).resolves.toBe(15n);
+
+    // mint a second token
+    const mintTx3 = mintTo({
+      contract,
+      to: TEST_ACCOUNT_B.address,
+      supply: 5n,
+      nft: { name: "Test NFT 2" },
+    });
+
+    await sendAndConfirmTransaction({
+      transaction: mintTx3,
+      account: TEST_ACCOUNT_A,
+    });
+
+    // now 2 tokens minted
+    await expect(nextTokenIdToMint({ contract })).resolves.toBe(2n);
+    await expect(getNFTs({ contract })).resolves.toMatchInlineSnapshot(`
+      [
+        {
+          "id": 0n,
+          "metadata": {
+            "name": "Test NFT",
+          },
+          "owner": null,
+          "supply": 15n,
+          "tokenURI": "ipfs://QmUut8sypH8NaPUeksnirut7MgggMeQa9RvJ37sV513sw3/0",
+          "type": "ERC1155",
+        },
+        {
+          "id": 1n,
+          "metadata": {
+            "name": "Test NFT 2",
+          },
+          "owner": null,
+          "supply": 5n,
+          "tokenURI": "ipfs://QmV6gsfzdiMRtpnh8ay3CgutStVbes7qoF4DKpYE64h8hT/0",
+          "type": "ERC1155",
+        },
+      ]
+    `);
+  });
+});

packages/thirdweb/src/extensions/erc1155/write/mintAdditionalSupplyTo.ts

@@ -0,0 +1,50 @@
+import type { BaseTransactionOptions } from "../../../transaction/types.js";
+import { uri } from "../__generated__/IERC1155/read/uri.js";
+import { mintTo as generatedMintTo } from "../__generated__/IMintableERC1155/write/mintTo.js";
+
+export type MintAdditionalSupplyToParams = {
+  to: string;
+  tokenId: bigint;
+  supply: bigint;
+};
+
+/**
+ * Mints a "supply" number of additional ERC1155 tokens to the specified "to" address.
+ * @param options - The transaction options.
+ * @returns A promise that resolves to the transaction result.
+ * @extension ERC1155
+ * @example
+ * ```ts
+ * import { mintAdditionalSupplyTo } from "thirdweb/extensions/erc1155";
+ * const transaction = mintTo({
+ *  contract,
+ *  to: "0x...",
+ *  tokenId: 1n,
+ *  supply: 10n,
+ * });
+ *
+ * const { transactionHash } = await sendTransaction({ transaction, account });
+ *
+ * ```
+ */
+export function mintAdditionalSupplyTo(
+  options: BaseTransactionOptions<MintAdditionalSupplyToParams>,
+) {
+  return generatedMintTo({
+    contract: options.contract,
+    asyncParams: async () => {
+      // we'll be re-using the exising token URI
+      const tokenUri = await uri({
+        contract: options.contract,
+        tokenId: options.tokenId,
+      });
+
+      return {
+        to: options.to,
+        tokenId: options.tokenId,
+        uri: tokenUri,
+        amount: options.supply,
+      };
+    },
+  });
+}