fix: display cached image in metadata responses (#104)

hirosystems · Feb 9, 2023 · 156e9e2 · 156e9e2
1 parent 0ab2fbb
commit 156e9e2
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 10 deletions.
diff --git a/src/api/types.ts b/src/api/types.ts
@@ -39,6 +39,7 @@ export const Metadata = Type.Object({
   name: Type.Optional(Type.String()),
   description: Type.Optional(Type.String()),
   image: Type.Optional(Type.String({ format: 'uri' })),
+  cached_image: Type.Optional(Type.String({ format: 'uri' })),
   attributes: Type.Optional(Type.Array(MetadataAttribute)),
   properties: Type.Optional(MetadataProperties),
   localization: Type.Optional(MetadataLocalization),

diff --git a/src/api/util/helpers.ts b/src/api/util/helpers.ts
@@ -8,15 +8,16 @@ export function parseMetadataLocaleBundle(
   if (locale && locale.metadata) {
     response = {
       sip: locale.metadata.sip,
-      name: locale.metadata.name ?? undefined,
-      description: locale.metadata.description ?? undefined,
-      image: locale.metadata.image ?? undefined,
+      name: locale.metadata.name,
+      description: locale.metadata.description,
+      image: locale.metadata.image,
+      cached_image: locale.metadata.cached_image,
     };
     if (locale.attributes.length > 0) {
       response.attributes = locale.attributes.map(item => ({
         trait_type: item.trait_type,
         value: item.value as MetadataValueType,
-        display_type: item.display_type ?? undefined,
+        display_type: item.display_type,
       }));
     }
     if (locale.properties.length > 0) {

diff --git a/tests/ft.test.ts b/tests/ft.test.ts
@@ -142,8 +142,8 @@ describe('FT routes', () => {
               l10n_uri: null,
               l10n_default: true,
               description: 'test',
-              image: null,
-              cached_image: null,
+              image: 'http://test.com/image.png',
+              cached_image: 'http://test.com/image.png?processed=true',
             },
             attributes: [
               {
@@ -186,6 +186,8 @@ describe('FT routes', () => {
         sip: 16,
         description: 'test',
         name: 'hello-world',
+        image: 'http://test.com/image.png',
+        cached_image: 'http://test.com/image.png?processed=true',
         attributes: [
           {
             display_type: 'number',

diff --git a/tests/nft.test.ts b/tests/nft.test.ts
@@ -136,8 +136,8 @@ describe('NFT routes', () => {
               l10n_uri: null,
               l10n_default: true,
               description: 'test',
-              image: null,
-              cached_image: null,
+              image: 'http://test.com/image.png',
+              cached_image: 'http://test.com/image.png?processed=true',
             },
             attributes: [
               {
@@ -176,6 +176,8 @@ describe('NFT routes', () => {
         sip: 16,
         description: 'test',
         name: 'hello-world',
+        image: 'http://test.com/image.png',
+        cached_image: 'http://test.com/image.png?processed=true',
         attributes: [
           {
             display_type: 'number',

diff --git a/tests/sft.test.ts b/tests/sft.test.ts
@@ -144,8 +144,8 @@ describe('SFT routes', () => {
               l10n_uri: null,
               l10n_default: true,
               description: 'test',
-              image: null,
-              cached_image: null,
+              image: 'http://test.com/image.png',
+              cached_image: 'http://test.com/image.png?processed=true',
             },
             attributes: [
               {
@@ -186,6 +186,8 @@ describe('SFT routes', () => {
         sip: 16,
         description: 'test',
         name: 'key-alex-autoalex-v1',
+        image: 'http://test.com/image.png',
+        cached_image: 'http://test.com/image.png?processed=true',
         attributes: [
           {
             display_type: 'number',