refactor!: move macro generated types to pseudo-private module

.gitignore

@@ -14,3 +14,4 @@ neardev
 
 .idea
 .vscode
+**/.DS_Store

CHANGELOG.md

@@ -19,6 +19,7 @@
 - Fixed gas assertion in `*_transfer_call` implementations of FT and NFT standards to only require what's needed. [PR 760](https://github.com/near/near-sdk-rs/pull/760)
 - Fixed events being emitted in FT standard to include refund transfers and burn events. [PR 752](https://github.com/near/near-sdk-rs/pull/752)
 - Moved `VMContext` to a local type defined in SDK to avoid duplicate types. [PR 785](https://github.com/near/near-sdk-rs/pull/785)
+- Moved `Metadata` and `MethodMetadata` to a pseudo-private module as these are just types used within macros and not stable. [PR 771](https://github.com/near/near-sdk-rs/pull/771)
 
 ### Removed
 - Remove `Clone` implementation for `Promise` (error prone) https://github.com/near/near-sdk-rs/pull/783

near-sdk-macros/src/core_impl/metadata/metadata_generator.rs

@@ -14,7 +14,7 @@ impl ImplItemMethodInfo {
     /// ```
     /// will produce this struct:
     /// ```ignore
-    /// near_sdk::MethodMetadata {
+    /// near_sdk::__private::MethodMetadata {
     ///     name: "f3".to_string(),
     ///     is_view: false,
     ///     is_init: false,
@@ -108,7 +108,7 @@ impl ImplItemMethodInfo {
         };
 
         quote! {
-             near_sdk::MethodMetadata {
+             near_sdk::__private::MethodMetadata {
                  name: #method_name_str.to_string(),
                  is_view: #is_view,
                  is_init: #is_init,

near-sdk-macros/src/core_impl/metadata/metadata_visitor.rs

@@ -57,7 +57,7 @@ impl MetadataVisitor {
             pub extern "C" fn metadata() {
                 #panic_hook
                 use borsh::*;
-                let metadata = near_sdk::Metadata::new(vec![
+                let metadata = near_sdk::__private::Metadata::new(vec![
                     #(#methods),*
                 ]);
                 let data = near_sdk::borsh::BorshSerialize::try_to_vec(&metadata).expect("Failed to serialize the metadata using Borsh");
@@ -100,8 +100,8 @@ mod tests {
             pub extern "C" fn metadata() {
                 near_sdk::env::setup_panic_hook();
                 use borsh::*;
-                let metadata = near_sdk::Metadata::new(vec![
-                    near_sdk::MethodMetadata {
+                let metadata = near_sdk::__private::Metadata::new(vec![
+                    near_sdk::__private::MethodMetadata {
                         name: "f1".to_string(),
                         is_view: true,
                         is_init: false,
@@ -110,7 +110,7 @@ mod tests {
                         callbacks_vec: None,
                         result: None
                     },
-                    near_sdk::MethodMetadata {
+                    near_sdk::__private::MethodMetadata {
                         name: "f2".to_string(),
                         is_view: false,
                         is_init: false,
@@ -129,7 +129,7 @@ mod tests {
                         callbacks_vec: None,
                         result: None
                     },
-                    near_sdk::MethodMetadata {
+                    near_sdk::__private::MethodMetadata {
                         name: "f3".to_string(),
                         is_view: false,
                         is_init: false,

near-sdk-macros/src/lib.rs

@@ -232,7 +232,7 @@ pub fn borsh_storage_key(item: TokenStream) -> TokenStream {
         );
     };
     TokenStream::from(quote! {
-        impl near_sdk::BorshIntoStorageKey for #name {}
+        impl near_sdk::__private::BorshIntoStorageKey for #name {}
     })
 }
 

near-sdk/src/lib.rs

@@ -22,8 +22,10 @@ pub use near_sys as sys;
 mod promise;
 pub use promise::{Promise, PromiseOrValue};
 
-mod metadata;
-pub use metadata::{Metadata, MethodMetadata};
+// Private types just used within macro generation, not stable to be used.
+#[doc(hidden)]
+#[path = "private/mod.rs"]
+pub mod __private;
 
 pub mod json_types;
 
@@ -41,7 +43,7 @@ pub use near_vm_logic::VMConfig;
 pub use test_utils::context::VMContext;
 
 pub mod utils;
-pub use crate::utils::storage_key_impl::*;
+pub use crate::utils::storage_key_impl::IntoStorageKey;
 pub use crate::utils::*;
 
 #[cfg(not(target_arch = "wasm32"))]

near-sdk/src/private/mod.rs

@@ -0,0 +1,36 @@
+mod metadata;
+
+pub use metadata::{Metadata, MethodMetadata};
+
+use crate::IntoStorageKey;
+use borsh::BorshSerialize;
+
+/// Converts a Borsh serializable object into a `Vec<u8>` that is used for a storage key.
+///
+/// [`BorshStorageKey`](crate::BorshStorageKey) should be used instead of implementing
+/// this manually.
+///
+/// ```
+/// use near_sdk::borsh::BorshSerialize;
+/// use near_sdk::BorshStorageKey;
+/// use near_sdk::collections::LookupMap;
+///
+/// #[derive(BorshSerialize, BorshStorageKey)]
+///  enum StorageKey {
+///     FungibleToken,
+///     Metadata { sub_key: String },
+/// }
+///
+/// let lookup_map_1: LookupMap<u64, String> = LookupMap::new(StorageKey::Metadata { sub_key: String::from("yo") });
+/// let lookup_map_2: LookupMap<String, String> = LookupMap::new(StorageKey::FungibleToken);
+/// ```
+pub trait BorshIntoStorageKey: BorshSerialize {}
+
+impl<T> IntoStorageKey for T
+where
+    T: BorshIntoStorageKey,
+{
+    fn into_storage_key(self) -> Vec<u8> {
+        self.try_to_vec().unwrap()
+    }
+}

near-sdk/src/utils/storage_key_impl.rs

@@ -1,5 +1,3 @@
-use borsh::BorshSerialize;
-
 /// Converts Self into a [`Vec<u8>`] that is used for a storage key through [`into_storage_key`].
 ///
 /// [`into_storage_key`]: IntoStorageKey::into_storage_key
@@ -35,32 +33,3 @@ impl IntoStorageKey for u8 {
         vec![self]
     }
 }
-
-/// Converts a Borsh serializable object into a `Vec<u8>` that is used for a storage key.
-///
-/// ```
-/// use near_sdk::borsh::BorshSerialize;
-/// use near_sdk::BorshIntoStorageKey;
-/// use near_sdk::collections::LookupMap;
-///
-/// #[derive(BorshSerialize)]
-///  enum StorageKey {
-///     FungibleToken,
-///     Metadata { sub_key: String },
-/// }
-///
-/// impl BorshIntoStorageKey for StorageKey {}
-///
-/// let lookup_map_1: LookupMap<u64, String> = LookupMap::new(StorageKey::Metadata { sub_key: String::from("yo") });
-/// let lookup_map_2: LookupMap<String, String> = LookupMap::new(StorageKey::FungibleToken);
-/// ```
-pub trait BorshIntoStorageKey: BorshSerialize {}
-
-impl<T> IntoStorageKey for T
-where
-    T: BorshIntoStorageKey,
-{
-    fn into_storage_key(self) -> Vec<u8> {
-        self.try_to_vec().unwrap()
-    }
-}