Enable ink_metadata to be used for metadata generation outside of ink!

crates/metadata/src/layout/mod.rs

@@ -106,6 +106,14 @@ impl<'a> From<&'a Key> for LayoutKey {
 }
 
 impl LayoutKey {
+    /// Construct a custom layout key.
+    pub fn new<T>(key: T) -> Self
+    where
+        T: Into<u32>,
+    {
+        Self { key: key.into() }
+    }
+
     /// Returns the key of the layout key.
     pub fn key(&self) -> &Key {
         &self.key
@@ -125,19 +133,6 @@ pub struct RootLayout<F: Form = MetaForm> {
     layout: Box<Layout<F>>,
 }
 
-impl RootLayout {
-    /// Creates a new root layout.
-    pub fn new<L>(root_key: LayoutKey, layout: L) -> Self
-    where
-        L: Into<Layout>,
-    {
-        Self {
-            root_key,
-            layout: Box::new(layout.into()),
-        }
-    }
-}
-
 impl IntoPortable for RootLayout {
     type Output = RootLayout<PortableForm>;
 
@@ -153,6 +148,17 @@ impl<F> RootLayout<F>
 where
     F: Form,
 {
+    /// Creates a new root layout.
+    pub fn new<L>(root_key: LayoutKey, layout: L) -> Self
+    where
+        L: Into<Layout<F>>,
+    {
+        Self {
+            root_key,
+            layout: Box::new(layout.into()),
+        }
+    }
+
     /// Returns the root key of the sub-tree.
     pub fn root_key(&self) -> &LayoutKey {
         &self.root_key
@@ -179,7 +185,7 @@ pub struct LeafLayout<F: Form = MetaForm> {
 
 impl LeafLayout {
     /// Creates a new cell layout.
-    pub fn new<T>(key: LayoutKey) -> Self
+    pub fn from_key<T>(key: LayoutKey) -> Self
     where
         T: TypeInfo + 'static,
     {
@@ -241,6 +247,10 @@ where
     pub fn ty(&self) -> &F::Type {
         &self.ty
     }
+
+    pub fn new(key: LayoutKey, ty: <F as Form>::Type) -> Self {
+        Self { key, ty }
+    }
 }
 
 /// A hashing layout potentially hitting all cells of the storage.
@@ -448,24 +458,22 @@ pub struct StructLayout<F: Form = MetaForm> {
     fields: Vec<FieldLayout<F>>,
 }
 
-impl StructLayout {
+impl<F> StructLayout<F>
+where
+    F: Form,
+{
     /// Creates a new struct layout.
-    pub fn new<N, F>(name: N, fields: F) -> Self
+    pub fn new<N, T>(name: N, fields: T) -> Self
     where
-        N: Into<&'static str>,
-        F: IntoIterator<Item = FieldLayout>,
+        N: Into<F::String>,
+        T: IntoIterator<Item = FieldLayout<F>>,
     {
         Self {
             name: name.into(),
             fields: fields.into_iter().collect(),
         }
     }
-}
 
-impl<F> StructLayout<F>
-where
-    F: Form,
-{
     /// Returns the name of the struct.
     pub fn name(&self) -> &F::String {
         &self.name
@@ -481,7 +489,7 @@ impl IntoPortable for StructLayout {
 
     fn into_portable(self, registry: &mut Registry) -> Self::Output {
         StructLayout {
-            name: self.name.into(),
+            name: self.name.to_string(),
             fields: self
                 .fields
                 .into_iter()
@@ -507,24 +515,22 @@ pub struct FieldLayout<F: Form = MetaForm> {
     layout: Layout<F>,
 }
 
-impl FieldLayout {
-    /// Creates a new field layout.
+impl<F> FieldLayout<F>
+where
+    F: Form,
+{
+    /// Creates a new custom field layout.
     pub fn new<N, L>(name: N, layout: L) -> Self
     where
-        N: Into<&'static str>,
-        L: Into<Layout>,
+        N: Into<F::String>,
+        L: Into<Layout<F>>,
     {
         Self {
             name: name.into(),
             layout: layout.into(),
         }
     }
-}
 
-impl<F> FieldLayout<F>
-where
-    F: Form,
-{
     /// Returns the name of the field.
     pub fn name(&self) -> &F::String {
         &self.name
@@ -544,7 +550,7 @@ impl IntoPortable for FieldLayout {
 
     fn into_portable(self, registry: &mut Registry) -> Self::Output {
         FieldLayout {
-            name: self.name.into_portable(registry),
+            name: self.name.to_string(),
             layout: self.layout.into_portable(registry),
         }
     }
@@ -587,7 +593,7 @@ impl EnumLayout {
     /// Creates a new enum layout.
     pub fn new<N, K, V>(name: N, dispatch_key: K, variants: V) -> Self
     where
-        N: Into<&'static str>,
+        N: Into<<MetaForm as Form>::String>,
         K: Into<LayoutKey>,
         V: IntoIterator<Item = (Discriminant, StructLayout)>,
     {
@@ -624,7 +630,7 @@ impl IntoPortable for EnumLayout {
 
     fn into_portable(self, registry: &mut Registry) -> Self::Output {
         EnumLayout {
-            name: self.name.into(),
+            name: self.name.to_string(),
             dispatch_key: self.dispatch_key,
             variants: self
                 .variants

crates/metadata/src/layout/tests.rs

@@ -26,8 +26,8 @@ fn named_fields_struct_layout(key: &Key) -> Layout {
     StructLayout::new(
         "Struct",
         vec![
-            FieldLayout::new("a", LeafLayout::new::<i32>(LayoutKey::from(key))),
-            FieldLayout::new("b", LeafLayout::new::<i64>(LayoutKey::from(key))),
+            FieldLayout::new("a", LeafLayout::from_key::<i32>(LayoutKey::from(key))),
+            FieldLayout::new("b", LeafLayout::from_key::<i64>(LayoutKey::from(key))),
         ],
     )
     .into()
@@ -73,8 +73,8 @@ fn tuple_struct_layout(key: &Key) -> Layout {
     StructLayout::new(
         "(A, B)",
         vec![
-            FieldLayout::new("0", LeafLayout::new::<i32>(LayoutKey::from(key))),
-            FieldLayout::new("1", LeafLayout::new::<i64>(LayoutKey::from(key))),
+            FieldLayout::new("0", LeafLayout::from_key::<i32>(LayoutKey::from(key))),
+            FieldLayout::new("1", LeafLayout::from_key::<i64>(LayoutKey::from(key))),
         ],
     )
     .into()
@@ -175,11 +175,11 @@ fn mixed_enum_layout(key: &Key) -> Layout {
                         vec![
                             FieldLayout::new(
                                 "0",
-                                LeafLayout::new::<i32>(LayoutKey::from(variant_key)),
+                                LeafLayout::from_key::<i32>(LayoutKey::from(variant_key)),
                             ),
                             FieldLayout::new(
                                 "1",
-                                LeafLayout::new::<i64>(LayoutKey::from(variant_key)),
+                                LeafLayout::from_key::<i64>(LayoutKey::from(variant_key)),
                             ),
                         ],
                     ),
@@ -194,11 +194,11 @@ fn mixed_enum_layout(key: &Key) -> Layout {
                         vec![
                             FieldLayout::new(
                                 "a",
-                                LeafLayout::new::<i32>(LayoutKey::from(variant_key)),
+                                LeafLayout::from_key::<i32>(LayoutKey::from(variant_key)),
                             ),
                             FieldLayout::new(
                                 "b",
-                                LeafLayout::new::<i64>(LayoutKey::from(variant_key)),
+                                LeafLayout::from_key::<i64>(LayoutKey::from(variant_key)),
                             ),
                         ],
                     ),
@@ -287,7 +287,7 @@ fn unbounded_hashing_layout(key: &Key) -> Layout {
             b"ink storage hashmap".to_vec(),
             Vec::new(),
         ),
-        LeafLayout::new::<(i32, bool)>(LayoutKey::from(root_key)),
+        LeafLayout::from_key::<(i32, bool)>(LayoutKey::from(root_key)),
     )
     .into()
 }

crates/metadata/src/layout/validate.rs

@@ -112,7 +112,7 @@ mod tests {
             0.into(),
             RootLayout::new(
                 1.into(),
-                RootLayout::new(2.into(), LeafLayout::new::<u32>(2.into())),
+                RootLayout::new(2.into(), LeafLayout::from_key::<u32>(2.into())),
             ),
         );
 
@@ -159,7 +159,7 @@ mod tests {
                         StructLayout::new(
                             "Struct0",
                             vec![
-                                FieldLayout::new("d", LeafLayout::new::<u128>(root_0)),
+                                FieldLayout::new("d", LeafLayout::from_key::<u128>(root_0)),
                                 FieldLayout::new(
                                     "f",
                                     RootLayout::new(
@@ -180,7 +180,7 @@ mod tests {
                                                                     "g",
                                                                     RootLayout::new(
                                                                         root_4,
-                                                                        LeafLayout::new::<
+                                                                        LeafLayout::from_key::<
                                                                             BTreeSet<u64>,
                                                                         >(
                                                                             root_4
@@ -197,7 +197,7 @@ mod tests {
                                                         "Second",
                                                         vec![FieldLayout::new(
                                                             "0",
-                                                            LeafLayout::new::<u8>(root_2),
+                                                            LeafLayout::from_key::<u8>(root_2),
                                                         )],
                                                     ),
                                                 ),
@@ -209,7 +209,7 @@ mod tests {
                                                             "0",
                                                             RootLayout::new(
                                                                 root_3,
-                                                                LeafLayout::new::<String>(
+                                                                LeafLayout::from_key::<String>(
                                                                     root_3,
                                                                 ),
                                                             ),
@@ -223,10 +223,10 @@ mod tests {
                             ],
                         ),
                     ),
-                    FieldLayout::new("b", LeafLayout::new::<u32>(root_0)),
+                    FieldLayout::new("b", LeafLayout::from_key::<u32>(root_0)),
                     FieldLayout::new(
                         "c",
-                        RootLayout::new(root_1, LeafLayout::new::<Vec<u8>>(root_1)),
+                        RootLayout::new(root_1, LeafLayout::from_key::<Vec<u8>>(root_1)),
                     ),
                 ],
             ),

crates/metadata/src/lib.rs

@@ -96,6 +96,7 @@ pub struct InkProject {
 }
 
 impl InkProject {
+    /// Create a new ink! project from a layout and a spec.
     pub fn new<L, S>(layout: L, spec: S) -> Self
     where
         L: Into<layout::Layout>,
@@ -110,9 +111,23 @@ impl InkProject {
             registry: registry.into(),
         }
     }
-}
 
-impl InkProject {
+    /// Create a new portable ink! project.
+    ///
+    /// The caller is responsible to register all types into the supplied registry.
+    pub fn new_portable(
+        layout: layout::Layout<PortableForm>,
+        spec: ContractSpec<PortableForm>,
+        registry: PortableRegistry,
+    ) -> Self {
+        Self {
+            version: Default::default(),
+            layout,
+            spec,
+            registry,
+        }
+    }
+
     /// Returns the metadata version used by the contract.
     pub fn version(&self) -> &MetadataVersion {
         &self.version