Merge pull request #181 from metaplex-foundation/feat/msgpack-decoding

Automatic msgpack decoding in SDK
metaplex-foundation · Aug 1, 2024 · 1b28658 · 1b28658
2 parents 2a72c64 + d63fca1
commit 1b28658
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 35 deletions.
diff --git a/clients/js/package.json b/clients/js/package.json
@@ -29,13 +29,15 @@
     "@metaplex-foundation/umi": ">=0.8.2 < 1",
     "@noble/hashes": "^1.3.1"
   },
+  "dependencies": {
+    "@msgpack/msgpack": "^3.0.0-beta2"
+  },
   "devDependencies": {
     "@ava/typescript": "^5.0.0",
     "@metaplex-foundation/mpl-core-oracle-example": "^0.0.2",
     "@metaplex-foundation/mpl-toolbox": "^0.8.0",
     "@metaplex-foundation/umi": "^0.8.10",
     "@metaplex-foundation/umi-bundle-tests": "^0.8.10",
-    "@msgpack/msgpack": "3.0.0-beta2",
     "@solana/web3.js": "^1.73.0",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.46.1",
@@ -65,4 +67,4 @@
     }
   },
   "packageManager": "[email protected]"
-}
+}
diff --git a/clients/js/pnpm-lock.yaml b/clients/js/pnpm-lock.yaml
diff --git a/clients/js/src/plugins/lib.ts b/clients/js/src/plugins/lib.ts
@@ -1,5 +1,6 @@
 import { isSome, none, Option, some } from '@metaplex-foundation/umi';
 
+import { decode } from '@msgpack/msgpack';
 import {
   Key,
   PluginHeaderV1,
@@ -234,11 +235,11 @@ export function parseExternalPluginAdapterData(
         }
       }
     } else if (plugin.schema === ExternalPluginAdapterSchema.MsgPack) {
-      // eslint-disable-next-line no-console
-      console.warn(
-        'MsgPack schema currently not supported, falling back to binary'
-      );
-      data = dataSlice;
+      if (dataSlice.length === 0) {
+        data = null;
+      } else {
+        data = decode(dataSlice);
+      }
     }
     return data;
   }

diff --git a/clients/js/test/externalPlugins/appData.test.ts b/clients/js/test/externalPlugins/appData.test.ts
@@ -91,6 +91,7 @@ async function generateTestContext(
     otherData = Uint8Array.from(Buffer.from(JSON.stringify(otherDataJson)));
   } else if (schema === ExternalPluginAdapterSchema.MsgPack) {
     data = msgpack.encode({ message: 'Hello', target: 'msgpack' });
+    otherData = msgpack.encode({ message: 'Hello hello', target: 'msgpack' });
   }
 
   if (!dataAuthoritySigner) {
@@ -188,11 +189,10 @@ DATA_AUTHORITIES.forEach((dataAuthorityType) => {
       }).sendAndConfirm(umi);
 
       let assertData = null;
-      if (
-        schema === ExternalPluginAdapterSchema.Binary ||
-        schema === ExternalPluginAdapterSchema.MsgPack
-      ) {
+      if (schema === ExternalPluginAdapterSchema.Binary) {
         assertData = data;
+      } else if (schema === ExternalPluginAdapterSchema.MsgPack) {
+        assertData = msgpack.decode(data);
       } else if (schema === ExternalPluginAdapterSchema.Json) {
         assertData = JSON.parse(Buffer.from(data).toString());
       }
@@ -260,11 +260,10 @@ DATA_AUTHORITIES.forEach((dataAuthorityType) => {
       }).sendAndConfirm(umi);
 
       let assertData = null;
-      if (
-        schema === ExternalPluginAdapterSchema.Binary ||
-        schema === ExternalPluginAdapterSchema.MsgPack
-      ) {
+      if (schema === ExternalPluginAdapterSchema.Binary) {
         assertData = data;
+      } else if (schema === ExternalPluginAdapterSchema.MsgPack) {
+        assertData = msgpack.decode(data);
       } else if (schema === ExternalPluginAdapterSchema.Json) {
         assertData = JSON.parse(Buffer.from(data).toString());
       }
@@ -294,11 +293,10 @@ DATA_AUTHORITIES.forEach((dataAuthorityType) => {
         asset: asset.publicKey,
       }).sendAndConfirm(umi);
 
-      if (
-        schema === ExternalPluginAdapterSchema.Binary ||
-        schema === ExternalPluginAdapterSchema.MsgPack
-      ) {
+      if (schema === ExternalPluginAdapterSchema.Binary) {
         assertData = otherData;
+      } else if (schema === ExternalPluginAdapterSchema.MsgPack) {
+        assertData = msgpack.decode(otherData);
       } else if (schema === ExternalPluginAdapterSchema.Json) {
         assertData = JSON.parse(Buffer.from(otherData).toString());
       }

diff --git a/clients/js/test/externalPlugins/linkedAppData.test.ts b/clients/js/test/externalPlugins/linkedAppData.test.ts
@@ -97,6 +97,7 @@ async function generateTestContext(
     otherData = Uint8Array.from(Buffer.from(JSON.stringify(otherDataJson)));
   } else if (schema === ExternalPluginAdapterSchema.MsgPack) {
     data = msgpack.encode({ message: 'Hello', target: 'msgpack' });
+    otherData = msgpack.encode({ message: 'Hello hello', target: 'msgpack' });
   }
 
   if (!dataAuthoritySigner) {
@@ -203,11 +204,10 @@ DATA_AUTHORITIES.forEach((dataAuthorityType) => {
       }).sendAndConfirm(umi);
 
       let assertData = null;
-      if (
-        schema === ExternalPluginAdapterSchema.Binary ||
-        schema === ExternalPluginAdapterSchema.MsgPack
-      ) {
+      if (schema === ExternalPluginAdapterSchema.Binary) {
         assertData = data;
+      } else if (schema === ExternalPluginAdapterSchema.MsgPack) {
+        assertData = msgpack.decode(data);
       } else if (schema === ExternalPluginAdapterSchema.Json) {
         assertData = JSON.parse(Buffer.from(data).toString());
       }
@@ -300,11 +300,10 @@ DATA_AUTHORITIES.forEach((dataAuthorityType) => {
       }).sendAndConfirm(umi);
 
       let assertData = null;
-      if (
-        schema === ExternalPluginAdapterSchema.Binary ||
-        schema === ExternalPluginAdapterSchema.MsgPack
-      ) {
+      if (schema === ExternalPluginAdapterSchema.Binary) {
         assertData = data;
+      } else if (schema === ExternalPluginAdapterSchema.MsgPack) {
+        assertData = msgpack.decode(data);
       } else if (schema === ExternalPluginAdapterSchema.Json) {
         assertData = JSON.parse(Buffer.from(data).toString());
       }
@@ -355,11 +354,10 @@ DATA_AUTHORITIES.forEach((dataAuthorityType) => {
         asset: asset.publicKey,
       }).sendAndConfirm(umi);
 
-      if (
-        schema === ExternalPluginAdapterSchema.Binary ||
-        schema === ExternalPluginAdapterSchema.MsgPack
-      ) {
+      if (schema === ExternalPluginAdapterSchema.Binary) {
         assertData = otherData;
+      } else if (schema === ExternalPluginAdapterSchema.MsgPack) {
+        assertData = msgpack.decode(otherData);
       } else if (schema === ExternalPluginAdapterSchema.Json) {
         assertData = JSON.parse(Buffer.from(otherData).toString());
       }