[SDK] Use insight for erc721/getNFTs and erc721/getOwnedNFTs

Author: joaquim-verges

.changeset/purple-bats-march.md

@@ -0,0 +1,34 @@
+---
+"thirdweb": patch
+---
+
+Use insight for erc821/getNFT, erc721/getNFTs and erc721/getOwnedNFTs
+
+Standard ERC721 getNFT, getNFTs and getOwnedNFTs now use insight, our in house indexer by default. If indexer is not availbale, will fallback to RPC.
+
+You can also use the indexer directly using the Insight API:
+
+for an entire collection
+
+```ts
+import { Insight } from "thirdweb";
+
+const events = await Insight.getContractNFTs({
+  client,
+  chains: [sepolia],
+  contractAddress: "0x1234567890123456789012345678901234567890",
+});
+```
+
+or for a single NFT
+
+```ts
+import { Insight } from "thirdweb";
+
+const events = await Insight.getNFT({
+  client,
+  chains: [sepolia],
+  contractAddress: "0x1234567890123456789012345678901234567890",
+  tokenId: 1n,
+});
+```

.github/workflows/CI.yml

@@ -16,6 +16,7 @@ env:
   TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
   TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
   TW_SECRET_KEY: ${{ secrets.TW_SECRET_KEY }}
+  TW_CLIENT_ID: ${{ secrets.TW_CLIENT_ID }}
   CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
 jobs:

apps/dashboard/src/@/actions/getWalletNFTs.ts

@@ -194,6 +194,8 @@ async function getWalletNFTsFromInsight(params: {
       tokenURI: nft.metadata_url,
       type: nft.token_type === "erc721" ? "ERC721" : "ERC1155",
       supply: nft.balance,
+      tokenAddress: nft.contract.address,
+      chainId: nft.contract.chain_id,
     };
 
     return walletNFT;

apps/dashboard/src/app/(dashboard)/(chain)/[chain_id]/[contractAddress]/(marketplace)/components/list-form.tsx

@@ -205,6 +205,8 @@ export const CreateListingsForm: React.FC<CreateListingsFormProps> = ({
           owner: nft.owner,
           type: "ERC721",
           tokenURI: nft.tokenURI,
+          chainId: nft.chainId,
+          tokenAddress: nft.tokenAddress,
         };
       }
       return {
@@ -216,6 +218,8 @@ export const CreateListingsForm: React.FC<CreateListingsFormProps> = ({
         owner: nft.owner,
         type: "ERC1155",
         tokenURI: nft.tokenURI,
+        chainId: nft.chainId,
+        tokenAddress: nft.tokenAddress,
       };
     }) as WalletNFT[];
   }, [ownedNFTs, form]);

apps/dashboard/src/app/(dashboard)/(chain)/[chain_id]/[contractAddress]/_components/NFTCards.tsx

@@ -21,6 +21,7 @@ const dummyMetadata: (idx: number) => NFTWithContract = (idx) => ({
   owner: `0x_fake_${idx}`,
   type: "ERC721",
   supply: 1n,
+  tokenAddress: ZERO_ADDRESS,
 });
 
 interface NFTCardsProps {

apps/dashboard/src/app/(dashboard)/(chain)/[chain_id]/[contractAddress]/account/components/nfts-owned.tsx

@@ -33,6 +33,7 @@ export const NftsOwned: React.FC<NftsOwnedProps> = ({
         type: nft.type,
         contractAddress: nft.contractAddress,
         chainId: contract.chain.id,
+        tokenAddress: nft.tokenAddress,
       }))}
       allNfts
       isPending={isWalletNFTsLoading}

apps/dashboard/src/app/(dashboard)/(chain)/[chain_id]/[contractAddress]/overview/components/MarketplaceDetails.tsx

@@ -7,7 +7,7 @@ import { SkeletonContainer } from "@/components/ui/skeleton";
 import { TrackedLinkTW } from "@/components/ui/tracked-link";
 import { ArrowRightIcon } from "lucide-react";
 import { useMemo } from "react";
-import type { ThirdwebContract } from "thirdweb";
+import { ZERO_ADDRESS, type ThirdwebContract } from "thirdweb";
 import {
   type DirectListing,
   type EnglishAuction,
@@ -237,13 +237,17 @@ const dummyMetadata: (idx: number) => ListingData = (idx) => ({
     supply: BigInt(1),
     tokenURI: "",
     type: "ERC721",
+    tokenAddress: ZERO_ADDRESS,
+    chainId: 1,
   },
   currencyValuePerToken: {
     decimals: 18,
     displayValue: "0.0",
     name: "Ether",
     symbol: "ETH",
     value: 0n,
+    tokenAddress: ZERO_ADDRESS,
+    chainId: 1,
   },
   creatorAddress: "0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
   type: "direct-listing",
@@ -253,6 +257,8 @@ const dummyMetadata: (idx: number) => ListingData = (idx) => ({
     value: 0n,
     displayValue: "0.0",
     decimals: 18,
+    tokenAddress: ZERO_ADDRESS,
+    chainId: 1,
   },
 });
 

packages/thirdweb/src/event/actions/get-events.ts

@@ -5,7 +5,6 @@ import type {
   ExtractAbiEventNames,
 } from "abitype";
 import { type Log, formatLog } from "viem";
-import { getChainServices } from "../../chains/utils.js";
 import { resolveContractAbi } from "../../contract/actions/resolve-abi.js";
 import type { ThirdwebContract } from "../../contract/contract.js";
 import { getContractEvents as getContractEventsInsight } from "../../insight/get-events.js";
@@ -197,7 +196,7 @@ export async function getContractEvents<
         ),
       );
     } catch (e) {
-      console.warn("Error fetching from insight", e);
+      console.warn("Error fetching from insight, falling back to rpc", e);
       // fetch from rpc
       logs = await Promise.all(
         logsParams.map((ethLogParams) => eth_getLogs(rpcRequest, ethLogParams)),
@@ -225,17 +224,6 @@ async function getLogsFromInsight(options: {
 }): Promise<Log[]> {
   const { params, contract } = options;
 
-  const chainServices = await getChainServices(contract.chain);
-  const insightEnabled = chainServices.some(
-    (c) => c.service === "insight" && c.enabled,
-  );
-
-  if (!insightEnabled) {
-    throw new Error(
-      `Insight is not available for chainId ${contract.chain.id}`,
-    );
-  }
-
   const fromBlock =
     typeof params.fromBlock === "bigint" ? Number(params.fromBlock) : undefined;
 

packages/thirdweb/src/extensions/erc1155/read/getNFT.test.ts

@@ -11,6 +11,7 @@ describe.runIf(process.env.TW_SECRET_KEY)("erc1155.getNFT", () => {
     });
     expect(nft).toMatchInlineSnapshot(`
       {
+        "chainId": 1,
         "id": 2n,
         "metadata": {
           "animation_url": "ipfs://QmYoM63qaumQznBRx38tQjkY4ewbymeFb2KWBhkfMqNHax/3.mp4",
@@ -36,6 +37,7 @@ describe.runIf(process.env.TW_SECRET_KEY)("erc1155.getNFT", () => {
         },
         "owner": null,
         "supply": 2519n,
+        "tokenAddress": "0x42d3641255C946CC451474295d29D3505173F22A",
         "tokenURI": "ipfs://QmbMXdbnNUAuGRoY6c6G792c6T9utfaBGqRUaMaRUf52Cb/2",
         "type": "ERC1155",
       }

packages/thirdweb/src/extensions/erc1155/read/getNFT.ts

@@ -58,6 +58,8 @@ export async function getNFT(
       type: "ERC1155",
       owner: null,
       supply,
+      tokenAddress: options.contract.address,
+      chainId: options.contract.chain.id,
     },
   );
 }