updateMetadata for edition drop contracts

Author: joaquim-verges

.changeset/four-adults-confess.md

@@ -0,0 +1,5 @@
+---
+"@thirdweb-dev/sdk": patch
+---
+
+Expose contract.erc1155.updateMetadata()

packages/sdk/src/evm/core/classes/erc-1155.ts

@@ -14,7 +14,12 @@ import {
   type BytesLike,
 } from "ethers";
 import { QueryAllParams } from "../../../core/schema/QueryParams";
-import { NFT, NFTMetadata, NFTMetadataOrUri } from "../../../core/schema/nft";
+import {
+  NFT,
+  NFTMetadata,
+  NFTMetadataInput,
+  NFTMetadataOrUri,
+} from "../../../core/schema/nft";
 import { resolveAddress } from "../../common/ens/resolveAddress";
 import {
   ExtensionNotImplementedError,
@@ -959,6 +964,38 @@ export class Erc1155<
     },
   );
 
+  ////// ERC1155 Update Metadata Extension //////
+
+  /**
+   * Update the metadata of an NFT
+   *
+   * @remarks Update the metadata of an NFT in the connected wallet
+   *
+   * @example
+   * ```javascript
+   * // The token ID of the NFT you want to update
+   * const tokenId = 0;
+   * // The updated metadata of the NFT
+   * const metadata = {
+   *   name: "Updated NFT",
+   *   description: "This is an updated NFT",
+   *   image: fs.readFileSync("path/to/image.png"), // This can be an image url or file
+   * }
+   *
+   * const result = await contract.erc1155.updateMetadata(tokenId, metadata);
+   * ```
+   * @twfeature ERC1155UpdateMetadata
+   */
+  updateMetadata = /* @__PURE__ */ buildTransactionFunction(
+    async (tokenId: BigNumberish, metadata: NFTMetadataInput) => {
+      // TODO handle updating regular TokenERC1155 metadata
+      return assertEnabled(
+        this.lazyMintable,
+        FEATURE_EDITION_LAZY_MINTABLE_V2,
+      ).updateMetadata.prepare(tokenId, metadata);
+    },
+  );
+
   ////// ERC1155 Claimable Extension //////
 
   /**

packages/sdk/src/evm/core/classes/internal/erc1155/erc-1155-lazy-mintable.ts

@@ -1,8 +1,12 @@
-import type { DropERC1155_V2 } from "@thirdweb-dev/contracts-js";
+import type { DropERC1155, DropERC1155_V2 } from "@thirdweb-dev/contracts-js";
 import { TokensLazyMintedEvent } from "@thirdweb-dev/contracts-js/dist/declarations/src/LazyMint";
 import { ThirdwebStorage } from "@thirdweb-dev/storage";
-import { utils, type providers } from "ethers";
-import { NFTMetadata, NFTMetadataOrUri } from "../../../../../core/schema/nft";
+import { utils, type providers, BigNumber, BigNumberish } from "ethers";
+import {
+  NFTMetadata,
+  NFTMetadataInput,
+  NFTMetadataOrUri,
+} from "../../../../../core/schema/nft";
 import { detectContractFeature } from "../../../../common/feature-detection/detectContractFeature";
 import { getPrebuiltInfo } from "../../../../common/legacy";
 import { uploadOrExtractURIs } from "../../../../common/nft";
@@ -176,6 +180,74 @@ export class Erc1155LazyMintable implements DetectableFeature {
     },
   );
 
+  updateMetadata = /* @__PURE__ */ buildTransactionFunction(
+    async (
+      tokenId: BigNumberish,
+      metadata: NFTMetadataInput,
+      options?: {
+        onProgress: (event: UploadProgressEvent) => void;
+      },
+    ) => {
+      const batchCount = await this.contractWrapper.read("getBaseURICount", []);
+      if (batchCount.eq(0)) {
+        throw new Error(
+          "No base URI set. Please set a base URI before updating metadata",
+        );
+      }
+      const targetTokenId = BigNumber.from(tokenId);
+      let startTokenId = BigNumber.from(0);
+      let endTokenId = BigNumber.from(0);
+      let batchIndex = 0;
+      for (let i = 0; i < batchCount.toNumber(); i++) {
+        batchIndex = i;
+        endTokenId = await this.contractWrapper.read("getBatchIdAtIndex", [
+          batchIndex,
+        ]);
+        if (endTokenId.gt(targetTokenId)) {
+          break;
+        }
+        startTokenId = endTokenId;
+      }
+      // for the entire batch,
+      // 1. download all of the metadata as a list of nft metadata
+      const range = Array.from(
+        { length: endTokenId.sub(startTokenId).toNumber() },
+        (v, k) => k + startTokenId.toNumber(),
+      );
+      const metadatas = await Promise.all(
+        range.map((id) => this.erc1155.getTokenMetadata(id)),
+      );
+      // 2. replace the metadata of the tokenId desired
+      const newMetadatas = [];
+      for (let i = 0; i < metadatas.length; i++) {
+        const { id, uri, ...rest } = metadatas[i];
+        if (BigNumber.from(targetTokenId).eq(BigNumber.from(id))) {
+          newMetadatas.push(metadata);
+        } else {
+          void uri; // linter
+          newMetadatas.push(rest);
+        }
+      }
+      // 3. re-upload the entire batch with the correct starting number
+      const batch = await uploadOrExtractURIs(
+        newMetadatas,
+        this.storage,
+        startTokenId.toNumber(),
+        options,
+      );
+      const baseUri = batch[0].substring(0, batch[0].lastIndexOf("/"));
+      // 4. update the base uri for the entire batch
+      return Transaction.fromContractWrapper({
+        contractWrapper: this.contractWrapper as ContractWrapper<DropERC1155>, // TODO contract detection
+        method: "updateBatchBaseURI",
+        args: [
+          batchIndex,
+          `${baseUri.endsWith("/") ? baseUri : `${baseUri}/`}`,
+        ],
+      });
+    },
+  );
+
   /** ******************************
    * PRIVATE FUNCTIONS
    *******************************/

packages/sdk/test/evm/edition-drop-v4.test.ts

@@ -46,9 +46,11 @@ describe("Edition Drop Contract (V4)", async () => {
         platform_fee_basis_points: 10,
         platform_fee_recipient: adminWallet.address,
       },
-      await sdk.deployer.getLatestBuiltInContractVersion(
-        EditionDropInitializer.contractType,
-      ),
+      (
+        await sdk.deployer.getLatestBuiltInContractVersion(
+          EditionDropInitializer.contractType,
+        )
+      ).toString(),
     );
     bdContract = await sdk.getEditionDrop(address);
   });
@@ -252,6 +254,77 @@ describe("Edition Drop Contract (V4)", async () => {
     }
   });
 
+  it("should update metadata", async () => {
+    const tokens = [
+      {
+        name: "test 0",
+      },
+      {
+        name: "test 1",
+      },
+      {
+        name: "test 2",
+      },
+      {
+        name: "test 3",
+      },
+      {
+        name: "test 4",
+      },
+    ];
+    const result = await bdContract.createBatch(tokens);
+    assert.lengthOf(result, tokens.length);
+    for (const token of tokens) {
+      const found = result.find(
+        async (t) => (await t.data()).name === token.name,
+      );
+      assert.isDefined(found);
+    }
+
+    const token = await bdContract.get(1);
+    expect(token.metadata.name).to.eq("test 1");
+    await bdContract.erc1155.updateMetadata(1, {
+      name: "test 123",
+    });
+    const token2 = await bdContract.get(1);
+    expect(token2.metadata.name).to.eq("test 123");
+  });
+
+  it("should update metadata from diff batch", async () => {
+    const tokens = [
+      {
+        name: "test 0",
+      },
+      {
+        name: "test 1",
+      },
+      {
+        name: "test 2",
+      },
+    ];
+    const result = await bdContract.createBatch(tokens);
+    assert.lengthOf(result, tokens.length);
+
+    const tokens2 = [
+      {
+        name: "test 3",
+      },
+      {
+        name: "test 4",
+      },
+    ];
+    const result2 = await bdContract.createBatch(tokens2);
+    assert.lengthOf(result2, tokens2.length);
+
+    let token = await bdContract.get("3");
+    expect(token.metadata.name).to.eq("test 3");
+    await bdContract.erc1155.updateMetadata(3, {
+      name: "test 123",
+    });
+    token = await bdContract.get("3");
+    expect(token.metadata.name).to.eq("test 123");
+  });
+
   it("should allow setting max claims per wallet", async () => {
     await bdContract.createBatch([
       { name: "name", description: "description" },