pr remarks

bosonprotocol · Jan 25, 2024 · cc55db7 · cc55db7
1 parent a25a160
commit cc55db7
Show file tree

Hide file tree

Showing 26 changed files with 139 additions and 80 deletions.
diff --git a/e2e/tests/bundle.test.ts b/e2e/tests/bundle.test.ts
@@ -416,6 +416,7 @@ describe("Bundle e2e tests", () => {
       product?.variants.some((variant) => variant.offer.id === bundleOffer.id)
     ).toBe(true);
   });
+  xtest("Create a BUNDLE that contains a multi-variant product already listed as single offer", async () => {});
 });
 
 // TODO: check methods getAllProductsWithNotVoidedVariants() / getAllProductsWithVariants() with BUNDLE offers
diff --git a/packages/ipfs-storage/src/ipfs/metadata.ts b/packages/ipfs-storage/src/ipfs/metadata.ts
@@ -17,7 +17,7 @@ export class IpfsMetadataStorage
 
   /**
    * Validates and stores supported offer metadata on IPFS.
-   * @param metadata - Offer metadata of type `BASE` or `PRODUCT_V1`.
+   * @param metadata - Offer metadata of any type.
    * @returns Metadata CID.
    */
   public async storeMetadata(metadata: AnyMetadata): Promise<string> {

diff --git a/packages/ipfs-storage/src/utils.ts b/packages/ipfs-storage/src/utils.ts
@@ -1,21 +1,39 @@
 import { AnyMetadata } from "@bosonprotocol/metadata";
-import { MetadataType } from "@bosonprotocol/metadata/dist/cjs/iMetadata";
 
 export type ERC721Metadata = AnyMetadata & {
-  external_url: string;
-  animation_url: string;
+  image_data?: string;
+  external_url?: string;
+  animation_url?: string;
+  youtube_url?: string;
+  external_link?: string;
+  attributes?: {
+    trait_type: string;
+    value: string;
+    display_type?: string;
+  }[];
 };
 
 /**
  * The ERC721 metadata standard defines the property `external_url` in snake_case.
  * We prefer to use camelCase though. To comply with the standard but still be consistent
  * in our code, we redundantly add the property `external_url` with the value of `externalUrl`.
+ * Same with animationUrl field, and attributes items
  */
 export function convertToERC721Metadata(metadata: AnyMetadata): ERC721Metadata {
   return {
     ...metadata,
-    external_url: metadata["externalUrl"],
-    animation_url: metadata["animationUrl"]
+    image_data: metadata["image_data"] || metadata["imageData"],
+    external_url: metadata["external_url"] || metadata["externalUrl"],
+    animation_url: metadata["animation_url"] || metadata["animationUrl"],
+    youtube_url: metadata["youtube_url"] || metadata["youtubeUrl"],
+    external_link: metadata["external_link"] || metadata["externalLink"],
+    attributes: metadata["attributes"]?.map((attr) => {
+      return {
+        ...attr,
+        trait_type: attr["trait_type"] || attr["traitType"],
+        display_type: attr["display_type"] || attr["displayType"]
+      };
+    })
   };
 }
 

diff --git a/packages/metadata/src/base/schema.json b/packages/metadata/src/base/schema.json
@@ -6,20 +6,22 @@
     "name": { "type": "string" },
     "description": { "type": "string" },
     "image": { "type": "string" },
+    "imageData": { "type": "string" },
     "externalUrl": { "type": "string" },
     "licenseUrl": { "type": "string" },
     "condition": { "type": "string" },
     "animationUrl": { "type": "string" },
+    "youtubeUrl": { "type": "string" },
     "attributes": {
       "type": "array",
       "items": {
         "type": "object",
         "properties": {
-          "trait_type": { "type": "string"},
+          "traitType": { "type": "string"},
           "value": { "type": "string"},
-          "display_type": { "type": "string"}
+          "displayType": { "type": "string"}
         },
-        "required": ["trait_type", "value"]
+        "required": ["traitType", "value"]
       }
     }
   },

diff --git a/packages/metadata/src/bundle/schema.json b/packages/metadata/src/bundle/schema.json
@@ -6,20 +6,22 @@
     "name": { "type": "string" },
     "description": { "type": "string" },
     "image": { "type": "string" },
+    "imageData": { "type": "string" },
     "externalUrl": { "type": "string" },
     "licenseUrl": { "type": "string" },
+    "youtubeUrl": { "type": "string" },
     "condition": { "type": "string" },
     "animationUrl": { "type": "string" },
     "attributes": {
       "type": "array",
       "items": {
         "type": "object",
         "properties": {
-          "trait_type": { "type": "string"},
+          "traitType": { "type": "string"},
           "value": { "type": "string"},
-          "display_type": { "type": "string"}
+          "displayType": { "type": "string"}
         },
-        "required": ["trait_type", "value"]
+        "required": ["traitType", "value"]
       }
     },
     "bundleUuid": { "type": "string"},

diff --git a/packages/metadata/src/collection/index.ts b/packages/metadata/src/collection/index.ts
@@ -13,6 +13,7 @@ export type CollectionMetadata = Omit<IMetadata, "type"> & {
   name: string;
   description?: string;
   image?: string;
-  external_link?: string;
+  externalLink?: string;
+  external_link?: string; // Stay compliant with https://docs.opensea.io/docs/contract-level-metadata
   collaborators?: string[];
 };
diff --git a/packages/metadata/src/collection/schema.json b/packages/metadata/src/collection/schema.json
@@ -6,6 +6,7 @@
     "name": { "type": "string" },
     "description": { "type": "string" },
     "image": { "type": "string" },
+    "externalLink": { "type": "string" },
     "external_link": { "type": "string" },
     "collaborators": {
       "type": "array",

diff --git a/packages/metadata/src/nftItem/index.ts b/packages/metadata/src/nftItem/index.ts
@@ -10,13 +10,26 @@ export type NftItem = Omit<IItemMetadata, "type"> & {
   name: string;
   description?: string;
   image?: string;
+  imageData?: string;
   externalUrl?: string;
   animationUrl?: string;
-  attributes?: {
-    trait_type: string;
-    value: string;
-    display_type?: string;
-  }[];
+  youtubeUrl?: string;
+  image_data?: string; // stay compliant with https://docs.opensea.io/docs/metadata-standards
+  external_url?: string; // stay compliant with https://docs.opensea.io/docs/metadata-standards
+  animation_url?: string; // stay compliant with https://docs.opensea.io/docs/metadata-standards
+  youtube_url?: string; // stay compliant with https://docs.opensea.io/docs/metadata-standards
+  attributes?:
+    | {
+        traitType: string;
+        value: string;
+        displayType?: string;
+      }[]
+    | {
+        // stay compliant with https://docs.opensea.io/docs/metadata-standards
+        trait_type: string;
+        value: string;
+        display_type?: string;
+      }[];
   chainId?: number;
   contract?: string;
   tokenId?: string;

diff --git a/packages/metadata/src/nftItem/schema.json b/packages/metadata/src/nftItem/schema.json
@@ -6,18 +6,26 @@
     "name": { "type": "string" },
     "description": { "type": "string" },
     "image": { "type": "string" },
+    "imageData": { "type": "string" },
     "externalUrl": { "type": "string" },
     "animationUrl": { "type": "string" },
+    "youtubeUrl": { "type": "string" },
+    "image_data": { "type": "string" },
+    "external_url": { "type": "string" },
+    "animation_url": { "type": "string" },
+    "youtube_url": { "type": "string" },
     "attributes": {
       "type": "array",
       "items": {
         "type": "object",
         "properties": {
+          "traitType": { "type": "string"},
           "trait_type": { "type": "string"},
           "value": { "type": "string"},
+          "displayType": { "type": "string"},
           "display_type": { "type": "string"}
         },
-        "required": ["trait_type", "value"]
+        "required": ["value"]
       }
     },
     "chainId": { "type": "number" },

diff --git a/packages/metadata/src/product-v1/index.ts b/packages/metadata/src/product-v1/index.ts
@@ -68,7 +68,7 @@ export function createVariantProductMetadata(
     // add some attributes depending on variation
     const variantAttributes = metadata.variations?.map((variation) => {
       return {
-        trait_type: variation.type,
+        traitType: variation.type,
         value: variation.option
       };
     });

diff --git a/packages/metadata/src/product-v1/schema.json b/packages/metadata/src/product-v1/schema.json
@@ -8,19 +8,21 @@
     "description": { "type": "string" },
     "externalUrl": { "type": "string" },
     "licenseUrl": { "type": "string" },
+    "youtubeUrl": { "type": "string" },
     "condition": { "type": "string" },
     "image": { "type": "string" },
+    "imageData": { "type": "string" },
     "animationUrl": { "type": "string" },
     "attributes": {
       "type": "array",
       "items": {
         "type": "object",
         "properties": {
-          "trait_type": { "type": "string"},
+          "traitType": { "type": "string"},
           "value": { "type": "string"},
-          "display_type": { "type": "string"}
+          "displayType": { "type": "string"}
         },
-        "required": ["trait_type", "value"]
+        "required": ["traitType", "value"]
       },
       "minItems": 2
     },

diff --git a/packages/metadata/src/rNFT/index.ts b/packages/metadata/src/rNFT/index.ts
@@ -13,13 +13,15 @@ export type RNftMetadata = Omit<IMetadata, "type"> & {
   name: string;
   description: string;
   image?: string;
+  imageData?: string;
   externalUrl: string;
   licenseUrl: string;
   condition?: string;
   animationUrl?: string;
+  youtubeUrl?: string;
   attributes?: {
-    trait_type: string;
+    traitType: string;
     value: string;
-    display_type?: string;
+    displayType?: string;
   }[];
 };
diff --git a/packages/metadata/src/rNFT/schema.json b/packages/metadata/src/rNFT/schema.json
@@ -15,11 +15,11 @@
       "items": {
         "type": "object",
         "properties": {
-          "trait_type": { "type": "string"},
+          "traitType": { "type": "string"},
           "value": { "type": "string"},
-          "display_type": { "type": "string"}
+          "displayType": { "type": "string"}
         },
-        "required": ["trait_type", "value"]
+        "required": ["traitType", "value"]
       }
     }
   },

diff --git a/packages/metadata/tests/bundle/valid/full.json b/packages/metadata/tests/bundle/valid/full.json
@@ -10,16 +10,16 @@
   "condition": "this offer requires to own at least one NFT of Makersplace collection: https://opensea.io/collection/makersplace",
   "attributes": [
     {
-      "trait_type": "Creator",
+      "traitType": "Creator",
       "value": "MetaFactory"
     },
     {
-      "trait_type": "Redeemable Until",
-      "display_type": "date",
+      "traitType": "Redeemable Until",
+      "displayType": "date",
       "value": "1658492054"
     },
     {
-      "trait_type": "Offer Category",
+      "traitType": "Offer Category",
       "value": "PHYGITAL"
     }
   ],

diff --git a/packages/metadata/tests/index.test.ts b/packages/metadata/tests/index.test.ts
@@ -143,10 +143,10 @@ describe("#validateMetadata()", () => {
 
     xtest("throw if missing 'Redeemable Until' attribute", () => {
       const attributes = productV1ValidFullOffer.attributes.map((attr) => {
-        if (attr.trait_type === "Redeemable Until") {
+        if (attr.traitType === "Redeemable Until") {
           return {
             ...attr,
-            trait_type: "XXXXXX"
+            traitType: "XXXXXX"
           };
         }
         return attr;
@@ -161,10 +161,10 @@ describe("#validateMetadata()", () => {
 
     xtest("throw if missing 'Offer Category' attribute", () => {
       const attributes = productV1ValidFullOffer.attributes.map((attr) => {
-        if (attr.trait_type === "Offer Category") {
+        if (attr.traitType === "Offer Category") {
           return {
             ...attr,
-            trait_type: "XXXXXX"
+            traitType: "XXXXXX"
           };
         }
         return attr;

diff --git a/packages/metadata/tests/nft-item/valid/full.json b/packages/metadata/tests/nft-item/valid/full.json
@@ -12,8 +12,8 @@
       "value": "MetaFactory"
     },
     {
-      "trait_type": "Redeemable Until",
-      "display_type": "date",
+      "traitType": "Redeemable Until",
+      "displayType": "date",
       "value": "1658492054"
     },
     {

diff --git a/packages/metadata/tests/product-v1/missingArguments.ts b/packages/metadata/tests/product-v1/missingArguments.ts
@@ -87,7 +87,7 @@ export const productMissingArguments = [
   //   data: {
   //     attributes: [
   //       {
-  //         trait_type: "Offer Category",
+  //         traitType: "Offer Category",
   //         value: "PHYSICAL"
   //       }
   //     ]

diff --git a/packages/metadata/tests/product-v1/valid/fullOffer.json b/packages/metadata/tests/product-v1/valid/fullOffer.json
@@ -11,16 +11,16 @@
   "image": "https://bsn-portal-production-image-upload-storage.s3.amazonaws.com/fc11acc4-e27b-4ede-b7d3-f16735fab406",
   "attributes": [
     {
-      "trait_type": "Creator",
+      "traitType": "Creator",
       "value": "MetaFactory"
     },
     {
-      "trait_type": "Redeemable Until",
+      "traitType": "Redeemable Until",
       "display_type": "date",
       "value": "1658492054"
     },
     {
-      "trait_type": "Offer Category",
+      "traitType": "Offer Category",
       "value": "PHYGITAL"
     }
   ],

diff --git a/packages/metadata/tests/product-v1/valid/minimalOffer.json b/packages/metadata/tests/product-v1/valid/minimalOffer.json
@@ -15,12 +15,12 @@
   "image": "https://bsn-portal-production-image-upload-storage.s3.amazonaws.com/fc11acc4-e27b-4ede-b7d3-f16735fab406",
   "attributes": [
     {
-      "trait_type": "Redeemable Until",
-      "display_type": "date",
+      "traitType": "Redeemable Until",
+      "displayType": "date",
       "value": "1658492054"
     },
     {
-      "trait_type": "Offer Category",
+      "traitType": "Offer Category",
       "value": "PHYSICAL"
     }
   ],

diff --git a/packages/metadata/tests/product-v1/valid/template.json b/packages/metadata/tests/product-v1/valid/template.json
@@ -5,16 +5,19 @@
   "name": "",
   "description": "",
   "externalUrl": "",
+  "animationUrl": "",
+  "youtubeUrl": "",
   "image": "",
+  "imageData": "",
   "attributes": [
     {
-      "trait_type": "",
+      "traitType": "",
       "value": "",
-      "display_type": ""
+      "displayType": ""
     },{
-      "trait_type": "",
+      "traitType": "",
       "value": "",
-      "display_type": ""
+      "displayType": ""
     }
   ],
   "product": {