@zoralabs/protocol-sdk 0.7.0 → 0.7.1

package/src/ipfs/token-metadata.ts

@@ -0,0 +1,99 @@
+import { getFetchableUrl } from "./gateway";
+import {
+  DEFAULT_THUMBNAIL_CID_HASHES,
+  TEXT_PLAIN,
+  getMimeType,
+  isImage,
+  mimeTypeToMedia,
+} from "./mimeTypes";
+import {
+  MakeMediaMetadataParams,
+  MakeTextMetadataParams,
+  TokenMetadataJson,
+} from "./types";
+
+/**
+ * Takes properties for a text based nft and formats it as proper json metadata
+ * for the token, which should be uploaded to IPFS.
+ * @param parameters - The parameters to format into metadata {@link MakeTextMetadataParams}
+ */
+export const makeTextTokenMetadata = (
+  parameters: MakeTextMetadataParams,
+): TokenMetadataJson => {
+  const { name, textFileUrl, thumbnailUrl, attributes = [] } = parameters;
+
+  const content = textFileUrl
+    ? {
+        mime: TEXT_PLAIN,
+        uri: textFileUrl,
+      }
+    : null;
+
+  const image = thumbnailUrl;
+  const animation_url = textFileUrl;
+
+  return {
+    name,
+    image,
+    animation_url,
+    content,
+    attributes,
+  };
+};
+
+/**
+ * Takes properties for a media based nft (video, image, etc) and formats it as proper json metadata
+ * for the token, which should be uploaded to IPFS.
+ * @param parameters - The parameters to format into metadata {@link MakeMediaMetadataParams}
+ */
+export const makeMediaTokenMetadata = async ({
+  name,
+  description,
+  attributes = [],
+  mediaUrl,
+  thumbnailUrl,
+}: MakeMediaMetadataParams): Promise<TokenMetadataJson> => {
+  const contentUrl = mediaUrl;
+  const fetchableContentUrl = getFetchableUrl(contentUrl);
+
+  if (!fetchableContentUrl)
+    throw new Error(`Content url (${contentUrl}) is not fetchable`);
+
+  const mimeType = await getMimeType(fetchableContentUrl);
+  const mediaType = mimeTypeToMedia(mimeType);
+
+  let image: string | undefined = undefined;
+  let animation_url: string | null = null;
+
+  // If the media is an image, just set the image field
+  // Otherwise we require a thumbnail, set image and animation_url
+  if (isImage(mimeType)) {
+    image = contentUrl;
+  } else {
+    image = thumbnailUrl;
+    animation_url = mediaUrl;
+  }
+
+  // If no image determined, use a fallback placeholder
+  if (!image)
+    image = `ipfs://${
+      DEFAULT_THUMBNAIL_CID_HASHES[mediaType] ||
+      DEFAULT_THUMBNAIL_CID_HASHES.default
+    }`;
+
+  const content = contentUrl
+    ? {
+        mime: mimeType || "application/octet-stream",
+        uri: contentUrl,
+      }
+    : null;
+
+  return {
+    name,
+    description,
+    image,
+    animation_url,
+    content,
+    attributes,
+  };
+};

package/src/ipfs/types.ts

@@ -0,0 +1,54 @@
+export type CreateERC1155TokenAttributes = {
+  trait_type: string;
+  value: string;
+};
+
+export type ContractMetadataJson = {
+  name?: string;
+  description?: string;
+  image?: string;
+};
+
+export type TokenMetadataJson = {
+  name: string;
+  description?: string;
+  /** Primary image file */
+  image?: string;
+  animation_url?: string | null;
+  content?: {
+    mime: string;
+    uri: string;
+  } | null;
+  attributes: Array<CreateERC1155TokenAttributes>;
+};
+
+export type BaseMetadataParams = {
+  /** Token name */
+  name: string;
+  /** Optional description */
+  description?: string;
+  /** Optional attributes to tag the token with */
+  attributes?: CreateERC1155TokenAttributes[];
+};
+
+export type MakeTextMetadataParams = BaseMetadataParams & {
+  /** Ipfs url where media is hosted */
+  textFileUrl: string;
+  /** If thumbnail was generate for text file, thumbnail image url */
+  thumbnailUrl?: string;
+};
+
+export type TextMetadataFiles = {
+  name: string;
+  /** File that holds the text, and is the primary media */
+  mediaUrlFile: File;
+  /** Thumbnail image preview of the text */
+  thumbnailFile: File;
+};
+
+export type MakeMediaMetadataParams = BaseMetadataParams & {
+  /** Ipfs url where media is hosted */
+  mediaUrl: string;
+  /** Ipfs url where thumbnail of media is hosted */
+  thumbnailUrl?: string;
+};

package/src/premint/premint-client.ts

@@ -65,7 +65,7 @@ type PremintedV2LogType = DecodeEventLogReturnType<
   "PremintedV2"
 >["args"];
 
-type URLSReturnType = {
+export type URLSReturnType = {
   explorer: null | string;
   zoraCollect: null | string;
   zoraManage: null | string;
@@ -433,6 +433,7 @@ type PremintReturn<T extends PremintConfigVersion> = {
   signAndSubmit: (params: SignAndSubmitParams) => Promise<SignAndSubmitReturn>;
   /** For the case where the premint is signed externally, takes the signature for the Premint, and submits it and the Premint to the Zora Premint API */
   submit: (params: SubmitParams) => Promise<void>;
+  urls: URLSReturnType;
 } & PremintConfigWithVersion<T>;
 
 function makePremintReturn<T extends PremintConfigVersion>({
@@ -503,6 +504,12 @@ function makePremintReturn<T extends PremintConfigVersion>({
     });
   };
 
+  const urls = makeUrls({
+    chainId,
+    address: collectionAddress,
+    uid: premintConfig.uid,
+  });
+
   return {
     premintConfig,
     premintConfigVersion,
@@ -510,6 +517,7 @@ function makePremintReturn<T extends PremintConfigVersion>({
     collectionAddress,
     signAndSubmit,
     submit,
+    urls,
   };
 }