Merge pull request #376 from blockfrost/chore/cip25-incorrect-encoding

chore: allow non-utf8 asset names in onchain metadata cip25v1
blockfrost · Oct 9, 2024 · 4fd0df7 · 4fd0df7
2 parents 67dee59 + cf624b2
commit 4fd0df7
Show file tree

Hide file tree

Showing 4 changed files with 76 additions and 12 deletions.
diff --git a/.prettierrc b/.prettierrc
@@ -1,11 +1,11 @@
 {
-	"printWidth": 80,
-	"arrowParens": "avoid",
-	"bracketSpacing": true,
-	"singleQuote": false,
-	"semi": true,
-	"trailingComma": "all",
-	"tabWidth": 2,
-	"useTabs": false,
-	"endOfLine": "auto"
+  "printWidth": 80,
+  "arrowParens": "avoid",
+  "bracketSpacing": true,
+  "singleQuote": true,
+  "semi": true,
+  "trailingComma": "all",
+  "tabWidth": 2,
+  "useTabs": false,
+  "endOfLine": "auto"
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,7 @@ Unreleased changes are in the `master` branch.
 ### Changed
 
 - updated dependencies
+- allow CIP25v1 metadata encoding where asset name not utf8 encoded (hex asset name = lookup key in json map)
 
 ### Fixed
 

diff --git a/src/functions/metadata.ts b/src/functions/metadata.ts
@@ -129,9 +129,19 @@ export const getOnchainMetadata = (
 
   if (version === 1) {
     try {
-      onchainMetadataResult =
-        internalOnchainMetadata[policyId][assetNameVersion1] || null;
-      isFound = true;
+      if (
+        policyId in internalOnchainMetadata &&
+        assetNameVersion1 in internalOnchainMetadata[policyId]
+      ) {
+        onchainMetadataResult =
+          internalOnchainMetadata[policyId][assetNameVersion1];
+        isFound = true;
+      } else if (internalOnchainMetadata[policyId]?.[assetNameBase]) {
+        // alternative for incorrect metadata where asset name in JSON map is not utf8 encoded (test case "CIP25v1 but asset name is not valid utf8 (hex asset name = lookup key in json map)")
+        onchainMetadataResult =
+          internalOnchainMetadata[policyId][assetNameBase];
+        isFound = true;
+      }
     } catch (error) {
       onchainMetadataResult = null;
     }

diff --git a/test/fixtures/metadata.ts b/test/fixtures/metadata.ts
@@ -854,6 +854,59 @@ export const getOnchainMetadata = [
       validCIPversion: null,
     },
   },
+  {
+    name: 'CIP25v1 but asset name is not valid utf8 (hex asset name = lookup key in json map)',
+    data: {
+      asset: '62a866f7cd0b77220f4f32538a5123a9dc10c130f1681a191d324c409a56',
+      policy_id: '62a866f7cd0b77220f4f32538a5123a9dc10c130f1681a191d324c40',
+      asset_name: '9a56',
+      fingerprint: 'asset1zsct93xne2r67p3tlsqmavu3fmtkuk9x00s9al',
+      quantity: '1',
+      initial_mint_tx_hash:
+        'fe92c1667ff99ddcc0ff85a7d4bf9b48efd064886b50a859a8c68f80bdd03b39',
+      mint_or_burn_count: 1,
+      onchain_metadata: {
+        '62a866f7cd0b77220f4f32538a5123a9dc10c130f1681a191d324c40': {
+          '330d': {
+            name: 'MNTX airdrop claim',
+            image: 'ipfs://QmTCmbEj82q9WxH4zjniMnVuX2pzzkpvZFMV2imkeo8dTX',
+            amount: '2033.077257',
+            mediaType: 'image/jpeg',
+          },
+          '9a56': {
+            name: 'MNTX airdrop claim',
+            image: 'ipfs://QmTCmbEj82q9WxH4zjniMnVuX2pzzkpvZFMV2imkeo8dTX',
+            amount: '466.017709',
+            mediaType: 'image/jpeg',
+          },
+          c3af: {
+            name: 'MNTX airdrop claim',
+            image: 'ipfs://QmTCmbEj82q9WxH4zjniMnVuX2pzzkpvZFMV2imkeo8dTX',
+            amount: '199.007562',
+            mediaType: 'image/jpeg',
+          },
+          dc69: {
+            name: 'MNTX airdrop claim',
+            image: 'ipfs://QmTCmbEj82q9WxH4zjniMnVuX2pzzkpvZFMV2imkeo8dTX',
+            amount: '537.020407',
+            mediaType: 'image/jpeg',
+          },
+        },
+      },
+      onchain_metadata_cbor:
+        'a11902d1a178386161316230336336613439393531323832653961363862313731333361383134663463363033663835626534363965323238363965636234a166726561646d65a465696d6167657835697066733a2f2f516d54526179616535567a71344d5a384545523975586e675a6e4a316b7973576473563565374448534d73627a37697075626c69736865727268747470733a2f2f6d696e746572722e696f667469636b657266726561646d65646e616d6566726561646d65',
+      metadata: null,
+    },
+    response: {
+      onchainMetadata: {
+        name: 'MNTX airdrop claim',
+        image: 'ipfs://QmTCmbEj82q9WxH4zjniMnVuX2pzzkpvZFMV2imkeo8dTX',
+        amount: '466.017709',
+        mediaType: 'image/jpeg',
+      },
+      validCIPversion: 'CIP25v1',
+    },
+  },
 ];
 
 export const validateCIP68Metadata = [