Serialize storage keys in metadata as SCALE encoded (#2048)

ascjones · web-flow · commit 4531ba61d731 · 2024-01-10T10:56:14.000Z
* Use scale encoding in metadata for keys

* Fix tests
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/metadata/Cargo.toml b/crates/metadata/Cargo.toml
@@ -22,6 +22,7 @@ serde = { workspace = true, features = ["derive", "alloc"] }
 impl-serde = { workspace = true, default-features = true }
 derive_more = { workspace = true, features = ["from"] }
 linkme = { workspace = true }
+scale = { workspace = true }
 scale-info = { workspace = true, features = ["derive", "serde", "decode", "schema"] }
 schemars = { workspace = true }
 
diff --git a/crates/metadata/src/layout/mod.rs b/crates/metadata/src/layout/mod.rs
@@ -29,6 +29,10 @@ use crate::{
 use derive_more::From;
 use ink_prelude::collections::btree_map::BTreeMap;
 use ink_primitives::Key;
+use scale::{
+    Decode,
+    Encode,
+};
 use scale_info::{
     form::{
         Form,
@@ -42,7 +46,10 @@ use scale_info::{
 };
 use schemars::JsonSchema;
 use serde::{
-    de::DeserializeOwned,
+    de::{
+        DeserializeOwned,
+        Error,
+    },
     Deserialize,
     Serialize,
 };
@@ -87,7 +94,7 @@ impl serde::Serialize for LayoutKey {
     where
         S: serde::Serializer,
     {
-        serde_hex::serialize(&self.key.to_be_bytes(), serializer)
+        serde_hex::serialize(&self.key.encode(), serializer)
     }
 }
 
@@ -98,7 +105,10 @@ impl<'de> serde::Deserialize<'de> for LayoutKey {
     {
         let mut arr = [0; 4];
         serde_hex::deserialize_check_len(d, serde_hex::ExpectedLen::Exact(&mut arr[..]))?;
-        Ok(Key::from_be_bytes(arr).into())
+        let key = Key::decode(&mut &arr[..]).map_err(|err| {
+            Error::custom(format!("Error decoding layout key: {}", err))
+        })?;
+        Ok(key.into())
     }
 }
 
diff --git a/crates/metadata/src/layout/tests.rs b/crates/metadata/src/layout/tests.rs
@@ -20,7 +20,7 @@ use scale_info::Path;
 fn layout_key_works() {
     let layout_key = LayoutKey::from(&1);
     let json = serde_json::to_string(&layout_key).unwrap();
-    assert_eq!(json, "\"0x00000001\"",);
+    assert_eq!(json, "\"0x01000000\"",);
 }
 
 fn named_fields_struct_layout(key: &Key) -> Layout {
@@ -47,7 +47,7 @@ fn named_fields_work() {
                     {
                         "layout": {
                             "leaf": {
-                                "key": "0x00000159",
+                                "key": "0x59010000",
                                 "ty": 0,
                             }
                         },
@@ -56,7 +56,7 @@ fn named_fields_work() {
                     {
                         "layout": {
                             "leaf": {
-                                "key": "0x00000159",
+                                "key": "0x59010000",
                                 "ty": 1,
                             }
                         },
@@ -94,7 +94,7 @@ fn tuple_struct_work() {
                     {
                         "layout": {
                             "leaf": {
-                                "key": "0x000000ea",
+                                "key": "0xea000000",
                                 "ty": 0,
                             }
                         },
@@ -103,7 +103,7 @@ fn tuple_struct_work() {
                     {
                         "layout": {
                             "leaf": {
-                                "key": "0x000000ea",
+                                "key": "0xea000000",
                                 "ty": 1,
                             }
                         },
@@ -139,7 +139,7 @@ fn clike_enum_work() {
     let expected = serde_json::json! {
         {
             "enum": {
-                "dispatchKey": "0x0000007b",
+                "dispatchKey": "0x7b000000",
                 "name": "Enum",
                 "variants": {
                     "0": {
@@ -219,7 +219,7 @@ fn mixed_enum_work() {
     let expected = serde_json::json! {
         {
             "enum": {
-                "dispatchKey": "0x000001c8",
+                "dispatchKey": "0xc8010000",
                 "name": "Enum",
                 "variants": {
                     "0": {
@@ -231,7 +231,7 @@ fn mixed_enum_work() {
                             {
                                 "layout": {
                                     "leaf": {
-                                        "key": "0x000001c8",
+                                        "key": "0xc8010000",
                                         "ty": 0,
                                     }
                                 },
@@ -240,7 +240,7 @@ fn mixed_enum_work() {
                             {
                                 "layout": {
                                     "leaf": {
-                                        "key": "0x000001c8",
+                                        "key": "0xc8010000",
                                         "ty": 1,
                                     }
                                 },
@@ -254,7 +254,7 @@ fn mixed_enum_work() {
                             {
                                 "layout": {
                                     "leaf": {
-                                        "key": "0x000001c8",
+                                        "key": "0xc8010000",
                                         "ty": 0,
                                     }
                                 },
@@ -263,7 +263,7 @@ fn mixed_enum_work() {
                             {
                                 "layout": {
                                     "leaf": {
-                                        "key": "0x000001c8",
+                                        "key": "0xc8010000",
                                         "ty": 1,
                                     }
                                 },
@@ -304,11 +304,11 @@ fn unbounded_layout_works() {
             "hash": {
                 "layout": {
                     "leaf": {
-                        "key": "0x00000237",
+                        "key": "0x37020000",
                         "ty": 0
                     }
                 },
-                "offset": "0x00000237",
+                "offset": "0x37020000",
                 "strategy": {
                         "hasher": "Blake2x256",
                         "prefix": "0x696e6b2073746f7261676520686173686d6170",

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ use scale_info::Path;`
`20`	`20`	`fn layout_key_works() {`
`21`	`21`	`let layout_key = LayoutKey::from(&1);`
`22`	`22`	`let json = serde_json::to_string(&layout_key).unwrap();`
`23`		`- assert_eq!(json, "\"0x00000001\"",);`
	`23`	`+ assert_eq!(json, "\"0x01000000\"",);`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`fn named_fields_struct_layout(key: &Key) -> Layout {`
`@@ -47,7 +47,7 @@ fn named_fields_work() {`
`47`	`47`	`{`
`48`	`48`	`"layout": {`
`49`	`49`	`"leaf": {`
`50`		`- "key": "0x00000159",`
	`50`	`+ "key": "0x59010000",`
`51`	`51`	`"ty": 0,`
`52`	`52`	`}`
`53`	`53`	`},`
`@@ -56,7 +56,7 @@ fn named_fields_work() {`
`56`	`56`	`{`
`57`	`57`	`"layout": {`
`58`	`58`	`"leaf": {`
`59`		`- "key": "0x00000159",`
	`59`	`+ "key": "0x59010000",`
`60`	`60`	`"ty": 1,`
`61`	`61`	`}`
`62`	`62`	`},`
`@@ -94,7 +94,7 @@ fn tuple_struct_work() {`
`94`	`94`	`{`
`95`	`95`	`"layout": {`
`96`	`96`	`"leaf": {`
`97`		`- "key": "0x000000ea",`
	`97`	`+ "key": "0xea000000",`
`98`	`98`	`"ty": 0,`
`99`	`99`	`}`
`100`	`100`	`},`
`@@ -103,7 +103,7 @@ fn tuple_struct_work() {`
`103`	`103`	`{`
`104`	`104`	`"layout": {`
`105`	`105`	`"leaf": {`
`106`		`- "key": "0x000000ea",`
	`106`	`+ "key": "0xea000000",`
`107`	`107`	`"ty": 1,`
`108`	`108`	`}`
`109`	`109`	`},`
`@@ -139,7 +139,7 @@ fn clike_enum_work() {`
`139`	`139`	`let expected = serde_json::json! {`
`140`	`140`	`{`
`141`	`141`	`"enum": {`
`142`		`- "dispatchKey": "0x0000007b",`
	`142`	`+ "dispatchKey": "0x7b000000",`
`143`	`143`	`"name": "Enum",`
`144`	`144`	`"variants": {`
`145`	`145`	`"0": {`
`@@ -219,7 +219,7 @@ fn mixed_enum_work() {`
`219`	`219`	`let expected = serde_json::json! {`
`220`	`220`	`{`
`221`	`221`	`"enum": {`
`222`		`- "dispatchKey": "0x000001c8",`
	`222`	`+ "dispatchKey": "0xc8010000",`
`223`	`223`	`"name": "Enum",`
`224`	`224`	`"variants": {`
`225`	`225`	`"0": {`
`@@ -231,7 +231,7 @@ fn mixed_enum_work() {`
`231`	`231`	`{`
`232`	`232`	`"layout": {`
`233`	`233`	`"leaf": {`
`234`		`- "key": "0x000001c8",`
	`234`	`+ "key": "0xc8010000",`
`235`	`235`	`"ty": 0,`
`236`	`236`	`}`
`237`	`237`	`},`
`@@ -240,7 +240,7 @@ fn mixed_enum_work() {`
`240`	`240`	`{`
`241`	`241`	`"layout": {`
`242`	`242`	`"leaf": {`
`243`		`- "key": "0x000001c8",`
	`243`	`+ "key": "0xc8010000",`
`244`	`244`	`"ty": 1,`
`245`	`245`	`}`
`246`	`246`	`},`
`@@ -254,7 +254,7 @@ fn mixed_enum_work() {`
`254`	`254`	`{`
`255`	`255`	`"layout": {`
`256`	`256`	`"leaf": {`
`257`		`- "key": "0x000001c8",`
	`257`	`+ "key": "0xc8010000",`
`258`	`258`	`"ty": 0,`
`259`	`259`	`}`
`260`	`260`	`},`
`@@ -263,7 +263,7 @@ fn mixed_enum_work() {`
`263`	`263`	`{`
`264`	`264`	`"layout": {`
`265`	`265`	`"leaf": {`
`266`		`- "key": "0x000001c8",`
	`266`	`+ "key": "0xc8010000",`
`267`	`267`	`"ty": 1,`
`268`	`268`	`}`
`269`	`269`	`},`
`@@ -304,11 +304,11 @@ fn unbounded_layout_works() {`
`304`	`304`	`"hash": {`
`305`	`305`	`"layout": {`
`306`	`306`	`"leaf": {`
`307`		`- "key": "0x00000237",`
	`307`	`+ "key": "0x37020000",`
`308`	`308`	`"ty": 0`
`309`	`309`	`}`
`310`	`310`	`},`
`311`		`- "offset": "0x00000237",`
	`311`	`+ "offset": "0x37020000",`
`312`	`312`	`"strategy": {`
`313`	`313`	`"hasher": "Blake2x256",`
`314`	`314`	`"prefix": "0x696e6b2073746f7261676520686173686d6170",`