Merge pull request #351 from blockfrost/chore/cip68v3

blockfrost · Oct 11, 2024 · db27161 · db27161
2 parents 4fd0df7 + f33c2e8
commit db27161
Show file tree

Hide file tree

Showing 12 changed files with 80 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@ Unreleased changes are in the `master` branch.
 ### Added
 
 - new UI for the API Reference
+- Parsing version 3 of `CIP68` metadata
 
 ### Changed
 

diff --git a/blockfrost-openapi.yaml b/blockfrost-openapi.yaml
@@ -9501,6 +9501,7 @@ components:
             - CIP25v2
             - CIP68v1
             - CIP68v2
+            - CIP68v3
           description: |
             If on-chain metadata passes validation, we display the standard
             under which it is valid

diff --git a/docs/blockfrost-openapi.yaml b/docs/blockfrost-openapi.yaml
@@ -9981,6 +9981,7 @@ components:
             - CIP25v2
             - CIP68v1
             - CIP68v2
+            - CIP68v3
           description: |
             If on-chain metadata passes validation, we display the standard
             under which it is valid

diff --git a/json-schema.json b/json-schema.json
diff --git a/openapi.json b/openapi.json
@@ -12933,7 +12933,8 @@
               "CIP25v1",
               "CIP25v2",
               "CIP68v1",
-              "CIP68v2"
+              "CIP68v2",
+              "CIP68v3"
             ],
             "description": "If on-chain metadata passes validation, we display the standard\nunder which it is valid\n"
           },

diff --git a/openapi.yaml b/openapi.yaml
@@ -9981,6 +9981,7 @@ components:
             - CIP25v2
             - CIP68v1
             - CIP68v2
+            - CIP68v3
           description: |
             If on-chain metadata passes validation, we display the standard
             under which it is valid

diff --git a/src/functions/metadata.ts b/src/functions/metadata.ts
@@ -201,11 +201,15 @@ export const validateCIP68Metadata: validateCIP68MetadataOverload = (
   schema,
 ) => {
   if (!input) return false;
-  // Validating only v1 and v2.
+  // Validating only v1, v2, v3.
   // Note: Version 2 added support for RFT, but due to botched CIP68 update process
   // it was initially included in v1.
   // As a result we are allowing both v1 and v2 for any token standard (NFT, FT, RFT).
-  if (!Number.isInteger(input.version) || input.version > 2) return false;
+  //
+  // Version 3 allows image and files.src to include array of bytes for >64B payloads.
+  // Conversion into a string is handled via blockfrost-utils,
+  // this validation function always receives these values as a string.
+  if (!Number.isInteger(input.version) || input.version > 3) return false;
 
   const versionString = `CIP68v${input.version}` as ValidCIP68Version;
 

diff --git a/src/generated-types.ts b/src/generated-types.ts
@@ -9444,7 +9444,7 @@ export interface components {
              *
              * @enum {string|null}
              */
-            onchain_metadata_standard?: "CIP25v1" | "CIP25v2" | "CIP68v1" | "CIP68v2" | null;
+            onchain_metadata_standard?: "CIP25v1" | "CIP25v2" | "CIP68v1" | "CIP68v2" | "CIP68v3" | null;
             /** @description Arbitrary plutus data (CIP68).
              *      */
             onchain_metadata_extra?: string | null;

diff --git a/src/schemas/assets/asset.yaml b/src/schemas/assets/asset.yaml
@@ -45,6 +45,7 @@ properties:
       - CIP25v2
       - CIP68v1
       - CIP68v2
+      - CIP68v3
     description: |
       If on-chain metadata passes validation, we display the standard
       under which it is valid

diff --git a/src/types/metadata.ts b/src/types/metadata.ts
@@ -9,7 +9,7 @@ export type GetOnchainMetadataResult = {
 };
 
 export type CIPTypes = 'CIP25v1' | 'CIP25v2' | null;
-export type ValidCIP68Version = 'CIP68v1' | 'CIP68v2';
+export type ValidCIP68Version = 'CIP68v1' | 'CIP68v2' | 'CIP68v3';
 export type CIP68Version = ValidCIP68Version | null;
 
 export type validateCIP68MetadataInput = {

diff --git a/test/fixtures/metadata.ts b/test/fixtures/metadata.ts
@@ -943,7 +943,7 @@ export const validateCIP68Metadata = [
         image: 'ipfs://QmYNyQbwLCYvjP743Jnud1bozcFPDSXFyYNYUmfQjYs5AQ',
         name: 'Matrix Berry #99',
       },
-      version: 3,
+      version: 4,
     },
     standard: 'nft',
     response: false,
@@ -1131,4 +1131,66 @@ export const validateCIP68Metadata = [
         'd8799f581c2d2b94c39535a96f74cedf908b704eda9605c7d4e788a0e9f0a133c7581de19ae47a5fee22019c8d426ad9638dbff902fbbd7422966b4361c56829ff',
     },
   },
+  {
+    name: 'RFT version 3',
+    payload: {
+      metadata: {
+        image: 'ipfs://QmSkgqaCapgw99Y2oAZ72tj9iGRb89DzM7kJPetvsj7NND',
+        name: 'handles_bg_boat_2',
+      },
+      version: 3,
+      extra:
+        'd8799fac44666f6e74582754696c7420507269736d2c68747470733a2f2f74696e7975726c2e636f6d2f32616e357062356145707269636518324671725f646f744f726f756e6465642c236666363133304b666f6e745f636f6c6f72739f4723666636313330ff4c71725f696e6e65725f6579654e7371756172652c236632663238354c71725f6f757465725f6579654f726f756e6465642c236632663238354d626f726465725f636f6c6f72739f492331323534363239344723373937393836ff517066705f626f726465725f636f6c6f72739f49233132353436323934ff52666f6e745f736861646f775f636f6c6f72739f472330613166643347233232643161664723333162633233ff52746578745f726962626f6e5f636f6c6f72739f472330303030303049233132353436323934ff5371725f6261636b67726f756e645f636f6c6f724923303030303030303054746578745f726962626f6e5f6772616469656e744672616469616cff',
+    },
+    standard: 'rft',
+    response: {
+      version: 'CIP68v3',
+      metadata: {
+        image: 'ipfs://QmSkgqaCapgw99Y2oAZ72tj9iGRb89DzM7kJPetvsj7NND',
+        name: 'handles_bg_boat_2',
+      },
+      extra:
+        'd8799fac44666f6e74582754696c7420507269736d2c68747470733a2f2f74696e7975726c2e636f6d2f32616e357062356145707269636518324671725f646f744f726f756e6465642c236666363133304b666f6e745f636f6c6f72739f4723666636313330ff4c71725f696e6e65725f6579654e7371756172652c236632663238354c71725f6f757465725f6579654f726f756e6465642c236632663238354d626f726465725f636f6c6f72739f492331323534363239344723373937393836ff517066705f626f726465725f636f6c6f72739f49233132353436323934ff52666f6e745f736861646f775f636f6c6f72739f472330613166643347233232643161664723333162633233ff52746578745f726962626f6e5f636f6c6f72739f472330303030303049233132353436323934ff5371725f6261636b67726f756e645f636f6c6f724923303030303030303054746578745f726962626f6e5f6772616469656e744672616469616cff',
+    },
+  },
+  {
+    name: 'NFT version 3',
+    payload: {
+      metadata: {
+        mediaType: 'image/png',
+        project: '4b47616c6163746963617473',
+        Background: '4542726f776e',
+        Fur: '454172746963',
+        Eyes: '46486f6f6b6564',
+        Clothes: '4f47616c616374696320436f6c6c6172',
+        Head: '4448616c6f',
+        Mouth: '45426c756e74',
+        name: 'Galacticats 145',
+        image:
+          '9f47697066733a2f2f583b62616679626569636875626c766b776c376d7a366e673767776a7437326a6f7a786f726d616a69706468697435666e6d7a78343770366d32337061ff',
+      },
+      version: 3,
+      extra:
+        'd8799f581c2d2b94c39535a96f74cedf908b704eda9605c7d4e788a0e9f0a133c7581de19ae47a5fee22019c8d426ad9638dbff902fbbd7422966b4361c56829ff',
+    },
+    standard: 'nft',
+    response: {
+      version: 'CIP68v3',
+      metadata: {
+        mediaType: 'image/png',
+        project: '4b47616c6163746963617473',
+        Background: '4542726f776e',
+        Fur: '454172746963',
+        Eyes: '46486f6f6b6564',
+        Clothes: '4f47616c616374696320436f6c6c6172',
+        Head: '4448616c6f',
+        Mouth: '45426c756e74',
+        name: 'Galacticats 145',
+        image:
+          '9f47697066733a2f2f583b62616679626569636875626c766b776c376d7a366e673767776a7437326a6f7a786f726d616a69706468697435666e6d7a78343770366d32337061ff',
+      },
+      extra:
+        'd8799f581c2d2b94c39535a96f74cedf908b704eda9605c7d4e788a0e9f0a133c7581de19ae47a5fee22019c8d426ad9638dbff902fbbd7422966b4361c56829ff',
+    },
+  },
 ];
diff --git a/test/tests/__snapshots__/get-schema-for-endpoint.test.ts.snap b/test/tests/__snapshots__/get-schema-for-endpoint.test.ts.snap
@@ -4436,6 +4436,7 @@ under which it is valid
               "CIP25v2",
               "CIP68v1",
               "CIP68v2",
+              "CIP68v3",
             ],
             "nullable": true,
             "type": "string",