[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]);

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,
     },
   );
 }

packages/thirdweb/src/extensions/erc20/read/getBalance.ts

@@ -23,6 +23,8 @@ export type GetBalanceResult = {
   displayValue: string;
   symbol: string;
   name: string;
+  tokenAddress: string;
+  chainId: number;
 };
 
 /**
@@ -48,5 +50,7 @@ export async function getBalance(
     ...currencyMetadata,
     value: balanceWei,
     displayValue: toTokens(balanceWei, currencyMetadata.decimals),
+    tokenAddress: options.contract.address,
+    chainId: options.contract.chain.id,
   };
 }

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

@@ -1,16 +1,117 @@
 import { describe, expect, it } from "vitest";
 import { DOODLES_CONTRACT } from "~test/test-contracts.js";
+import { TEST_CLIENT } from "../../../../test/src/test-clients.js";
 import { getNFT } from "./getNFT.js";
 
 describe.runIf(process.env.TW_SECRET_KEY)("erc721.getNFT", () => {
+  it("without owner using indexer", async () => {
+    const clientId = TEST_CLIENT.clientId;
+    const nft = await getNFT({
+      contract: { ...DOODLES_CONTRACT },
+      tokenId: 1n,
+      includeOwner: false,
+    });
+    expect(nft).toMatchInlineSnapshot(`
+      {
+        "chainId": 1,
+        "id": 1n,
+        "metadata": {
+          "attributes": [
+            {
+              "trait_type": "face",
+              "value": "holographic beard",
+            },
+            {
+              "trait_type": "hair",
+              "value": "white bucket cap",
+            },
+            {
+              "trait_type": "body",
+              "value": "purple sweater with satchel",
+            },
+            {
+              "trait_type": "background",
+              "value": "grey",
+            },
+            {
+              "trait_type": "head",
+              "value": "gradient 2",
+            },
+          ],
+          "description": "A community-driven collectibles project featuring art by Burnt Toast. Doodles come in a joyful range of colors, traits and sizes with a collection size of 10,000. Each Doodle allows its owner to vote for experiences and activations paid for by the Doodles Community Treasury. Burnt Toast is the working alias for Scott Martin, a Canadian–based illustrator, designer, animator and muralist.",
+          "image": "https://${clientId}.ipfscdn.io/ipfs/QmTDxnzcvj2p3xBrKcGv1wxoyhAn2yzCQnZZ9LmFjReuH9",
+          "image_url": "https://${clientId}.ipfscdn.io/ipfs/QmTDxnzcvj2p3xBrKcGv1wxoyhAn2yzCQnZZ9LmFjReuH9",
+          "name": "Doodle #1",
+          "uri": "https://${clientId}.ipfscdn.io/ipfs/QmPMc4tcBsMqLRuCQtPmPe84bpSjrC3Ky7t3JWuHXYB4aS/1",
+        },
+        "owner": null,
+        "tokenAddress": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e",
+        "tokenURI": "https://${clientId}.ipfscdn.io/ipfs/QmPMc4tcBsMqLRuCQtPmPe84bpSjrC3Ky7t3JWuHXYB4aS/1",
+        "type": "ERC721",
+      }
+    `);
+  });
+
+  it("with owner using indexer", async () => {
+    const nft = await getNFT({
+      contract: { ...DOODLES_CONTRACT },
+      tokenId: 1n,
+      includeOwner: true,
+    });
+    expect(nft).toMatchInlineSnapshot(`
+      {
+        "chainId": 1,
+        "id": 1n,
+        "metadata": {
+          "attributes": [
+            {
+              "trait_type": "face",
+              "value": "holographic beard",
+            },
+            {
+              "trait_type": "hair",
+              "value": "white bucket cap",
+            },
+            {
+              "trait_type": "body",
+              "value": "purple sweater with satchel",
+            },
+            {
+              "trait_type": "background",
+              "value": "grey",
+            },
+            {
+              "trait_type": "head",
+              "value": "gradient 2",
+            },
+          ],
+          "description": "A community-driven collectibles project featuring art by Burnt Toast. Doodles come in a joyful range of colors, traits and sizes with a collection size of 10,000. Each Doodle allows its owner to vote for experiences and activations paid for by the Doodles Community Treasury. Burnt Toast is the working alias for Scott Martin, a Canadian–based illustrator, designer, animator and muralist.",
+          "image": "https://${clientId}.ipfscdn.io/ipfs/QmTDxnzcvj2p3xBrKcGv1wxoyhAn2yzCQnZZ9LmFjReuH9",
+          "image_url": "https://${clientId}.ipfscdn.io/ipfs/QmTDxnzcvj2p3xBrKcGv1wxoyhAn2yzCQnZZ9LmFjReuH9",
+          "name": "Doodle #1",
+          "owner_addresses": [
+            "0xbe9936fcfc50666f5425fde4a9decc59cef73b24",
+          ],
+          "uri": "https://${clientId}.ipfscdn.io/ipfs/QmPMc4tcBsMqLRuCQtPmPe84bpSjrC3Ky7t3JWuHXYB4aS/1",
+        },
+        "owner": "0xbe9936fcfc50666f5425fde4a9decc59cef73b24",
+        "tokenAddress": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e",
+        "tokenURI": "https://${clientId}.ipfscdn.io/ipfs/QmPMc4tcBsMqLRuCQtPmPe84bpSjrC3Ky7t3JWuHXYB4aS/1",
+        "type": "ERC721",
+      }
+    `);
+  });
+
   it("without owner", async () => {
     const nft = await getNFT({
       contract: { ...DOODLES_CONTRACT },
       tokenId: 1n,
       includeOwner: false,
+      useIndexer: false,
     });
     expect(nft).toMatchInlineSnapshot(`
       {
+        "chainId": 1,
         "id": 1n,
         "metadata": {
           "attributes": [
@@ -40,6 +141,7 @@ describe.runIf(process.env.TW_SECRET_KEY)("erc721.getNFT", () => {
           "name": "Doodle #1",
         },
         "owner": null,
+        "tokenAddress": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e",
         "tokenURI": "ipfs://QmPMc4tcBsMqLRuCQtPmPe84bpSjrC3Ky7t3JWuHXYB4aS/1",
         "type": "ERC721",
       }
@@ -51,9 +153,11 @@ describe.runIf(process.env.TW_SECRET_KEY)("erc721.getNFT", () => {
       contract: { ...DOODLES_CONTRACT },
       tokenId: 1n,
       includeOwner: true,
+      useIndexer: false,
     });
     expect(nft).toMatchInlineSnapshot(`
       {
+        "chainId": 1,
         "id": 1n,
         "metadata": {
           "attributes": [
@@ -83,6 +187,7 @@ describe.runIf(process.env.TW_SECRET_KEY)("erc721.getNFT", () => {
           "name": "Doodle #1",
         },
         "owner": "0xbE9936FCFC50666f5425FDE4A9decC59cEF73b24",
+        "tokenAddress": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e",
         "tokenURI": "ipfs://QmPMc4tcBsMqLRuCQtPmPe84bpSjrC3Ky7t3JWuHXYB4aS/1",
         "type": "ERC721",
       }

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

@@ -7,8 +7,8 @@ import {
   tokenURI,
 } from "../__generated__/IERC721A/read/tokenURI.js";
 import { tokenByIndex } from "../__generated__/IERC721Enumerable/read/tokenByIndex.js";
-
 export { isTokenURISupported as isGetNFTSupported } from "../__generated__/IERC721A/read/tokenURI.js";
+import { getNFT as getNFTInsight } from "../../../insight/index.js";
 
 /**
  * Parameters for getting an NFT.
@@ -27,6 +27,11 @@ export type GetNFTParams = Prettify<
      * In this case, the provided tokenId will be considered as token-index and actual tokenId will be fetched from the contract.
      */
     tokenByIndex?: boolean;
+    /**
+     * Whether to use the insight API to fetch the NFT.
+     * @default true
+     */
+    useIndexer?: boolean;
   }
 >;
 
@@ -58,6 +63,51 @@ export type GetNFTParams = Prettify<
  */
 export async function getNFT(
   options: BaseTransactionOptions<GetNFTParams>,
+): Promise<NFT> {
+  const { useIndexer = true } = options;
+  if (useIndexer) {
+    try {
+      return getNFTFromInsight(options);
+    } catch {
+      return getNFTFromRPC(options);
+    }
+  }
+  return getNFTFromRPC(options);
+}
+
+async function getNFTFromInsight(
+  options: BaseTransactionOptions<GetNFTParams>,
+): Promise<NFT> {
+  const tokenId = options.tokenId;
+  const nft = await getNFTInsight({
+    client: options.contract.client,
+    chain: options.contract.chain,
+    contractAddress: options.contract.address,
+    tokenId: options.tokenId,
+    includeOwners: options.includeOwner,
+  });
+  if (!nft) {
+    return parseNFT(
+      {
+        id: tokenId,
+        type: "ERC721",
+        uri: "",
+      },
+      {
+        tokenId,
+        tokenUri: "",
+        type: "ERC721",
+        owner: null,
+        tokenAddress: options.contract.address,
+        chainId: options.contract.chain.id,
+      },
+    );
+  }
+  return nft;
+}
+
+async function getNFTFromRPC(
+  options: BaseTransactionOptions<GetNFTParams>,
 ): Promise<NFT> {
   let tokenId = options.tokenId;
   if (options.tokenByIndex) {
@@ -90,6 +140,8 @@ export async function getNFT(
         tokenUri: "",
         type: "ERC721",
         owner,
+        tokenAddress: options.contract.address,
+        chainId: options.contract.chain.id,
       },
     );
   }
@@ -109,6 +161,8 @@ export async function getNFT(
       tokenUri: uri,
       type: "ERC721",
       owner,
+      tokenAddress: options.contract.address,
+      chainId: options.contract.chain.id,
     },
   );
 }