format external url in case it is a direct ipfs link (#1181)

hypercerts-org · Nov 13, 2023 · e622aba · e622aba
1 parent b3b237c
commit e622aba
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 6 deletions.
diff --git a/frontend/lib/formatting.ts b/frontend/lib/formatting.ts
@@ -1,4 +1,5 @@
 import _ from "lodash";
+import { HypercertClient } from "@hypercerts-org/sdk";
 
 export const formatScope = (scopeLabel: string) =>
   scopeLabel.toLowerCase().replaceAll(/\s+/g, "-").trim();
@@ -72,3 +73,19 @@ export const formatAddress = (address: string) =>
  */
 export const cidToIpfsUri = (cid: string) =>
   cid.startsWith("ipfs://") ? cid : `ipfs://${cid}`;
+
+export const formatExternalUrl = (
+  client: HypercertClient,
+  externalUrl?: string,
+) => {
+  if (!externalUrl) {
+    return "";
+  }
+  if (!externalUrl.startsWith("ipfs://")) {
+    return externalUrl;
+  }
+
+  return client.storage.getNftStorageGatewayUri(
+    externalUrl.replace("ipfs://", ""),
+  );
+};
diff --git a/frontend/lib/hypercert.ts b/frontend/lib/hypercert.ts
@@ -5,10 +5,11 @@ import {
   HypercertClient,
 } from "@hypercerts-org/sdk";
 import BN from "bn.js";
+import { formatExternalUrl } from "./formatting";
 
 export interface Hypercert {
   getTokensFor(owner: string): HypercertTokens;
-  metadata?: HypercertMetadata;
+  metadata?: HypercertMetadata & { external_uri_formatted?: string };
   claim?: ClaimByIdQuery["claim"];
   claimTokens?: ClaimTokensByClaimQuery["claimTokens"];
   name: string;
@@ -39,13 +40,25 @@ export async function loadHypercert(
         : claimQueryResp.claim?.uri;
     if (metadataUri) {
       const metadata = await client.storage.getMetadata(metadataUri);
-      hypercert.metadata = metadata;
+      hypercert.metadata = {
+        ...metadata,
+        external_url_formatted: formatExternalUrl(
+          client,
+          metadata.external_url,
+        ),
+      };
     }
     return hypercert;
   } else {
     if (options.metadataUri) {
       const metadata = await client.storage.getMetadata(options.metadataUri);
-      return new MetadataOnlyHypercert(options.metadataUri, metadata);
+      return new MetadataOnlyHypercert(options.metadataUri, {
+        ...metadata,
+        external_url_formatted: formatExternalUrl(
+          client,
+          metadata.external_url,
+        ),
+      });
     }
     throw new Error(
       "A metadataUri or claimId are required to load a hypercert",
@@ -102,10 +115,13 @@ export class HypercertTokens {
 export class MetadataOnlyHypercert implements Hypercert {
   claim?: ClaimByIdQuery["claim"];
   claimTokens?: ClaimTokensByClaimQuery["claimTokens"];
-  metadata: HypercertMetadata;
+  metadata: HypercertMetadata & { external_url_formatted?: string };
   metadataUri: string;
 
-  constructor(metadataUri: string, metadata: HypercertMetadata) {
+  constructor(
+    metadataUri: string,
+    metadata: HypercertMetadata & { external_url_formatted?: string },
+  ) {
     this.metadata = metadata;
     this.metadataUri = metadataUri;
   }
@@ -139,7 +155,7 @@ export class FullHypercert implements Hypercert {
   // previous HypercertData type
   claim: ClaimByIdQuery["claim"];
   claimTokens: ClaimTokensByClaimQuery["claimTokens"];
-  metadata?: HypercertMetadata;
+  metadata?: HypercertMetadata & { external_url_formatted?: string };
 
   constructor(
     claimQueryResp: ClaimByIdQuery,