Renames frame crate to polkadot-sdk-frame

docs/sdk/Cargo.toml

@@ -17,7 +17,7 @@ workspace = true
 # Needed for all FRAME-based code
 parity-scale-codec = { version = "3.0.0", default-features = false }
 scale-info = { version = "2.6.0", default-features = false }
-frame = { path = "../../substrate/frame", features = [
+frame = { package = "polkadot-sdk-frame", path = "../../substrate/frame", features = [
 	"experimental",
 	"runtime",
 ] }

prdoc/pr_3813.prdoc

@@ -0,0 +1,14 @@
+# Schema: Polkadot SDK PRDoc Schema (prdoc) v1.0.0
+# See doc at https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/prdoc/schema_user.json
+
+title: Renames `frame` crate to `polkadot-sdk-frame`
+
+doc:
+  - audience: Runtime Dev
+    description: |
+      This PR renames `frame` crate to `polkadot-sdk-frame` as `frame` is not available on crates.io. 
+      Please note that this crate can only be imported as `polkadot-sdk-frame` or `frame`.
+
+crates:
+  - name: polkadot-sdk-frame
+    bump: major

substrate/client/chain-spec/src/lib.rs

@@ -140,7 +140,7 @@
 //!       <td>A JSON object that provides an explicit and comprehensive representation of the
 //! <code>RuntimeGenesisConfig</code> struct, which is generated by <a
 //! href="../frame_support_procedural/macro.construct_runtime.html"
-//! ><code>frame::runtime::prelude::construct_runtime</code></a> macro (<a
+//! ><code>polkadot_sdk_frame::runtime::prelude::construct_runtime</code></a> macro (<a
 //! href="../substrate_test_runtime/struct.RuntimeGenesisConfig.html#"
 //! >example of generated struct</a>). Must contain all the keys of
 //! the genesis config, no defaults will be used.

substrate/frame/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
-name = "frame"
-version = "0.0.1-dev"
+name = "polkadot-sdk-frame"
+version = "0.1.0"
 authors = ["Parity Technologies <admin@parity.io>"]
 edition = "2021"
 license = "Apache-2.0"

substrate/frame/examples/frame-crate/Cargo.toml

@@ -19,7 +19,7 @@ targets = ["x86_64-unknown-linux-gnu"]
 codec = { package = "parity-scale-codec", version = "3.6.1", default-features = false }
 scale-info = { version = "2.5.0", default-features = false, features = ["derive"] }
 
-frame = { path = "../..", default-features = false, features = ["experimental", "runtime"] }
+frame = { package = "polkadot-sdk-frame", path = "../..", default-features = false, features = ["experimental", "runtime"] }
 
 
 [features]

substrate/frame/src/lib.rs

@@ -50,11 +50,11 @@
 #![cfg(feature = "experimental")]
 
 /// Exports the main pallet macro. This can wrap a `mod pallet` and will transform it into
-/// being a pallet, eg `#[frame::pallet] mod pallet { .. }`.
+/// being a pallet, eg `#[polkadot_sdk_frame::pallet] mod pallet { .. }`.
 ///
 /// Note that this is not part of the prelude, in order to make it such that the common way to
-/// define a macro is `#[frame::pallet] mod pallet { .. }`, followed by `#[pallet::foo]`,
-/// `#[pallet::bar]` inside the mod.
+/// define a macro is `#[polkadot_sdk_frame::pallet] mod pallet { .. }`, followed by
+/// `#[pallet::foo]`, `#[pallet::bar]` inside the mod.
 pub use frame_support::pallet;
 
 pub use frame_support::pallet_macros::{import_section, pallet_section};
@@ -75,7 +75,7 @@ pub mod pallet_macros {
 /// This prelude should almost always be the first line of code in any pallet or runtime.
 ///
 /// ```
-/// use frame::prelude::*;
+/// use polkadot_sdk_frame::prelude::*;
 ///
 /// // rest of your pallet..
 /// mod pallet {}
@@ -84,7 +84,7 @@ pub mod prelude {
 	/// `frame_system`'s parent crate, which is mandatory in all pallets build with this crate.
 	///
 	/// Conveniently, the keyword `frame_system` is in scope as one uses `use
-	/// frame::prelude::*`
+	/// polkadot_sdk_frame::prelude::*`
 	#[doc(inline)]
 	pub use frame_system;
 
@@ -112,7 +112,7 @@ pub mod prelude {
 /// A test setup typically starts with:
 ///
 /// ```
-/// use frame::testing_prelude::*;
+/// use polkadot_sdk_frame::testing_prelude::*;
 /// // rest of your test setup.
 /// ```
 #[cfg(feature = "std")]
@@ -141,7 +141,7 @@ pub mod runtime {
 	/// A runtime typically starts with:
 	///
 	/// ```
-	/// use frame::{prelude::*, runtime::prelude::*};
+	/// use polkadot_sdk_frame::{prelude::*, runtime::prelude::*};
 	/// ```
 	pub mod prelude {
 		/// All of the types related to the FRAME runtime executive.
@@ -186,7 +186,7 @@ pub mod runtime {
 	/// A non-testing runtime should have this enabled, as such:
 	///
 	/// ```
-	/// use frame::runtime::{prelude::*, apis::{*,}};
+	/// use polkadot_sdk_frame::runtime::{prelude::*, apis::{*,}};
 	/// ```
 	// TODO: This is because of wildcard imports, and it should be not needed once we can avoid
 	// that. Imports like that are needed because we seem to need some unknown types in the macro
@@ -330,8 +330,8 @@ pub mod derive {
 /// In most cases, hopefully the answer is yes.
 pub mod deps {
 	// TODO: It would be great to somehow instruct RA to prefer *not* suggesting auto-imports from
-	// these. For example, we prefer `frame::derive::CloneNoBound` rather than
-	// `frame::deps::frame_support::CloneNoBound`.
+	// these. For example, we prefer `polkadot_sdk_frame::derive::CloneNoBound` rather than
+	// `polkadot_sdk_frame::deps::frame_support::CloneNoBound`.
 	pub use frame_support;
 	pub use frame_system;
 

substrate/frame/support/procedural/src/lib.rs

@@ -665,9 +665,9 @@ pub fn storage_alias(attributes: TokenStream, input: TokenStream) -> TokenStream
         "{}::macro_magic",
         match generate_access_from_frame_or_crate("frame-support") {
             Ok(path) => Ok(path),
-            Err(_) => generate_access_from_frame_or_crate("frame"),
+            Err(_) => generate_access_from_frame_or_crate("polkadot-sdk-frame"),
         }
-        .expect("Failed to find either `frame-support` or `frame` in `Cargo.toml` dependencies.")
+        .expect("Failed to find either `frame-support` or `polkadot-sdk-frame` in `Cargo.toml` dependencies.")
         .to_token_stream()
         .to_string()
     )
@@ -1181,9 +1181,9 @@ pub fn pallet_section(attr: TokenStream, tokens: TokenStream) -> TokenStream {
         "{}::macro_magic",
         match generate_access_from_frame_or_crate("frame-support") {
             Ok(path) => Ok(path),
-            Err(_) => generate_access_from_frame_or_crate("frame"),
+            Err(_) => generate_access_from_frame_or_crate("polkadot-sdk-frame"),
         }
-        .expect("Failed to find either `frame-support` or `frame` in `Cargo.toml` dependencies.")
+        .expect("Failed to find either `frame-support` or `polkadot-sdk-frame` in `Cargo.toml` dependencies.")
         .to_token_stream()
         .to_string()
     )

substrate/frame/support/procedural/src/pallet/parse/config.rs

@@ -275,7 +275,8 @@ fn check_event_type(
 }
 
 /// Check that the path to `frame_system::Config` is valid, this is that the path is just
-/// `frame_system::Config` or when using the `frame` crate it is `frame::xyz::frame_system::Config`.
+/// `frame_system::Config` or when using the `frame` crate it is
+/// `polkadot_sdk_frame::xyz::frame_system::Config`.
 fn has_expected_system_config(path: syn::Path, frame_system: &syn::Path) -> bool {
 	// Check if `frame_system` is actually 'frame_system'.
 	if path.segments.iter().all(|s| s.ident != "frame_system") {
@@ -293,7 +294,7 @@ fn has_expected_system_config(path: syn::Path, frame_system: &syn::Path) -> bool
 			// `frame` re-exports it as such.
 				syn::parse2::<syn::Path>(quote::quote!(frame_system)).expect("is a valid path; qed"),
 			(_, _) =>
-			// They are either both `frame_system` or both `frame::xyz::frame_system`.
+			// They are either both `frame_system` or both `polkadot_sdk_frame::xyz::frame_system`.
 				frame_system.clone(),
 		};
 
@@ -517,52 +518,60 @@ mod tests {
 	#[test]
 	fn has_expected_system_config_works_with_frame() {
 		let frame_system =
-			syn::parse2::<syn::Path>(quote::quote!(frame::deps::frame_system)).unwrap();
+			syn::parse2::<syn::Path>(quote::quote!(polkadot_sdk_frame::deps::frame_system))
+				.unwrap();
 		let path = syn::parse2::<syn::Path>(quote::quote!(frame_system::Config)).unwrap();
 		assert!(has_expected_system_config(path, &frame_system));
 	}
 
 	#[test]
 	fn has_expected_system_config_works_with_frame_full_path() {
 		let frame_system =
-			syn::parse2::<syn::Path>(quote::quote!(frame::deps::frame_system)).unwrap();
+			syn::parse2::<syn::Path>(quote::quote!(polkadot_sdk_frame::deps::frame_system))
+				.unwrap();
 		let path =
-			syn::parse2::<syn::Path>(quote::quote!(frame::deps::frame_system::Config)).unwrap();
+			syn::parse2::<syn::Path>(quote::quote!(polkadot_sdk_frame::deps::frame_system::Config))
+				.unwrap();
 		assert!(has_expected_system_config(path, &frame_system));
 	}
 
 	#[test]
 	fn has_expected_system_config_works_with_other_frame_full_path() {
 		let frame_system =
-			syn::parse2::<syn::Path>(quote::quote!(frame::xyz::frame_system)).unwrap();
+			syn::parse2::<syn::Path>(quote::quote!(polkadot_sdk_frame::xyz::frame_system)).unwrap();
 		let path =
-			syn::parse2::<syn::Path>(quote::quote!(frame::xyz::frame_system::Config)).unwrap();
+			syn::parse2::<syn::Path>(quote::quote!(polkadot_sdk_frame::xyz::frame_system::Config))
+				.unwrap();
 		assert!(has_expected_system_config(path, &frame_system));
 	}
 
 	#[test]
 	fn has_expected_system_config_does_not_works_with_mixed_frame_full_path() {
 		let frame_system =
-			syn::parse2::<syn::Path>(quote::quote!(frame::xyz::frame_system)).unwrap();
+			syn::parse2::<syn::Path>(quote::quote!(polkadot_sdk_frame::xyz::frame_system)).unwrap();
 		let path =
-			syn::parse2::<syn::Path>(quote::quote!(frame::deps::frame_system::Config)).unwrap();
+			syn::parse2::<syn::Path>(quote::quote!(polkadot_sdk_frame::deps::frame_system::Config))
+				.unwrap();
 		assert!(!has_expected_system_config(path, &frame_system));
 	}
 
 	#[test]
 	fn has_expected_system_config_does_not_works_with_other_mixed_frame_full_path() {
 		let frame_system =
-			syn::parse2::<syn::Path>(quote::quote!(frame::deps::frame_system)).unwrap();
+			syn::parse2::<syn::Path>(quote::quote!(polkadot_sdk_frame::deps::frame_system))
+				.unwrap();
 		let path =
-			syn::parse2::<syn::Path>(quote::quote!(frame::xyz::frame_system::Config)).unwrap();
+			syn::parse2::<syn::Path>(quote::quote!(polkadot_sdk_frame::xyz::frame_system::Config))
+				.unwrap();
 		assert!(!has_expected_system_config(path, &frame_system));
 	}
 
 	#[test]
 	fn has_expected_system_config_does_not_work_with_frame_full_path_if_not_frame_crate() {
 		let frame_system = syn::parse2::<syn::Path>(quote::quote!(frame_system)).unwrap();
 		let path =
-			syn::parse2::<syn::Path>(quote::quote!(frame::deps::frame_system::Config)).unwrap();
+			syn::parse2::<syn::Path>(quote::quote!(polkadot_sdk_frame::deps::frame_system::Config))
+				.unwrap();
 		assert!(!has_expected_system_config(path, &frame_system));
 	}