Break appcrypto dep cycle (paritytech#4347)

* move application-crypto tests into seperate crate * Fix crate name, update script and add docs * pressing 'save' helps * remove useless lines * adding header * split into actual modules
belikji · Dec 10, 2019 · d7c3fa2 · d7c3fa2
1 parent 52373bf
commit d7c3fa2
Show file tree

Hide file tree

Showing 27 changed files with 174 additions and 100 deletions.
diff --git a/.maintain/rename-crates-for-2.0.sh b/.maintain/rename-crates-for-2.0.sh
@@ -35,7 +35,8 @@ TO_RENAME=(
     # OLD-CRATE-NAME NEW-CRATE-NAME
 
     # PRIMITIVES
-    "substrate-application-crypto sc-application-crypto"
+    "substrate-application-crypto sp-application-crypto"
+    "sc-application-crypto sp-application-crypto"
     "substrate-authority-discovery-primitives sp-authority-discovery"
     "substrate-block-builder-runtime-api sp-block-builder"
     "substrate-consensus-aura-primitives sp-consensus-aura"

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -90,6 +90,7 @@ members = [
 	"frame/treasury",
 	"frame/utility",
 	"primitives/application-crypto",
+	"primitives/application-crypto/test",
 	"primitives/authority-discovery",
 	"primitives/authorship",
 	"primitives/block-builder/runtime-api",

diff --git a/client/consensus/aura/Cargo.toml b/client/consensus/aura/Cargo.toml
@@ -6,7 +6,7 @@ description = "Aura consensus algorithm for substrate"
 edition = "2018"
 
 [dependencies]
-app-crypto = { package = "sc-application-crypto", path = "../../../primitives/application-crypto" }
+app-crypto = { package = "sp-application-crypto", path = "../../../primitives/application-crypto" }
 aura_primitives = { package = "sp-consensus-aura", path = "../../../primitives/consensus/aura" }
 block-builder-api = { package = "sp-block-builder", path = "../../../primitives/block-builder/runtime-api" }
 client = { package = "sc-client", path = "../../" }

diff --git a/client/consensus/babe/Cargo.toml b/client/consensus/babe/Cargo.toml
@@ -9,7 +9,7 @@ edition = "2018"
 codec = { package = "parity-scale-codec", version = "1.0.0", features = ["derive"] }
 babe_primitives = { package = "sp-consensus-babe", path = "../../../primitives/consensus/babe" }
 primitives = { package = "sp-core", path = "../../../primitives/core" }
-app-crypto = { package = "sc-application-crypto", path = "../../../primitives/application-crypto" }
+app-crypto = { package = "sp-application-crypto", path = "../../../primitives/application-crypto" }
 num-bigint = "0.2.3"
 num-rational = "0.2.2"
 num-traits = "0.2.8"

diff --git a/client/keystore/Cargo.toml b/client/keystore/Cargo.toml
@@ -7,7 +7,7 @@ edition = "2018"
 [dependencies]
 derive_more = "0.99.2"
 primitives = { package = "sp-core",  path = "../../primitives/core" }
-app-crypto = { package = "sc-application-crypto",  path = "../../primitives/application-crypto" }
+app-crypto = { package = "sp-application-crypto",  path = "../../primitives/application-crypto" }
 hex = "0.4.0"
 rand = "0.7.2"
 serde_json = "1.0.41"

diff --git a/client/service/Cargo.toml b/client/service/Cargo.toml
@@ -34,7 +34,7 @@ sp-runtime = { path = "../../primitives/runtime" }
 sp-blockchain = { path = "../../primitives/blockchain" }
 primitives = { package = "sp-core", path = "../../primitives/core" }
 session = { package = "sp-session", path = "../../primitives/session" }
-app-crypto = { package = "sc-application-crypto", path = "../../primitives/application-crypto" }
+app-crypto = { package = "sp-application-crypto", path = "../../primitives/application-crypto" }
 consensus_common = { package = "sp-consensus", path = "../../primitives/consensus/common" }
 network = { package = "sc-network", path = "../network" }
 chain-spec = { package = "sc-chain-spec", path = "../chain-spec" }

diff --git a/docs/Upgrade.md b/docs/Upgrade.md
@@ -0,0 +1,5 @@
+# Upgrade path for you building on substrate
+
+## master
+ - crate rename has been fixed `sp-application-crypto` (was `sc-application-crypto`);  `.maintain/rename-crates-for-2.0.sh` has been updated accordingly, you can use it to upgrade to latest naming convention
+ - crates have been renamed, run `bash .maintain/rename-crates-for-2.0.sh`
diff --git a/frame/aura/Cargo.toml b/frame/aura/Cargo.toml
@@ -5,7 +5,7 @@ authors = ["Parity Technologies <[email protected]>"]
 edition = "2018"
 
 [dependencies]
-app-crypto = { package = "sc-application-crypto",  path = "../../primitives/application-crypto", default-features = false }
+app-crypto = { package = "sp-application-crypto",  path = "../../primitives/application-crypto", default-features = false }
 codec = { package = "parity-scale-codec", version = "1.0.0", default-features = false, features = ["derive"] }
 inherents = { package = "sp-inherents", path = "../../primitives/inherents", default-features = false }
 primitives = { package = "sp-core",  path = "../../primitives/core", default-features = false }

diff --git a/frame/authority-discovery/Cargo.toml b/frame/authority-discovery/Cargo.toml
@@ -6,7 +6,7 @@ edition = "2018"
 
 [dependencies]
 authority-discovery-primitives = { package = "sp-authority-discovery", path = "../../primitives/authority-discovery", default-features = false }
-app-crypto = { package = "sc-application-crypto", path = "../../primitives/application-crypto", default-features = false }
+app-crypto = { package = "sp-application-crypto", path = "../../primitives/application-crypto", default-features = false }
 codec = { package = "parity-scale-codec", version = "1.0.0", default-features = false, features = ["derive"] }
 primitives = { package = "sp-core",  path = "../../primitives/core", default-features = false }
 sp-std = { path = "../../primitives/std", default-features = false }

diff --git a/frame/im-online/Cargo.toml b/frame/im-online/Cargo.toml
@@ -5,7 +5,7 @@ authors = ["Parity Technologies <[email protected]>"]
 edition = "2018"
 
 [dependencies]
-app-crypto = { package = "sc-application-crypto", path = "../../primitives/application-crypto", default-features = false }
+app-crypto = { package = "sp-application-crypto", path = "../../primitives/application-crypto", default-features = false }
 authorship = { package = "pallet-authorship", path = "../authorship", default-features = false }
 codec = { package = "parity-scale-codec", version = "1.0.0", default-features = false, features = ["derive"] }
 primitives = { package="sp-core", path = "../../primitives/core", default-features = false }

diff --git a/frame/session/Cargo.toml b/frame/session/Cargo.toml
@@ -20,7 +20,7 @@ impl-trait-for-tuples = "0.1.3"
 
 [dev-dependencies]
 primitives = { package = "sp-core",  path = "../../primitives/core" }
-app-crypto = { package = "sc-application-crypto",  path = "../../primitives/application-crypto" }
+app-crypto = { package = "sp-application-crypto",  path = "../../primitives/application-crypto" }
 lazy_static = "1.4.0"
 
 [features]

diff --git a/primitives/application-crypto/Cargo.toml b/primitives/application-crypto/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "sc-application-crypto"
+name = "sp-application-crypto"
 version = "2.0.0"
 authors = ["Parity Technologies <[email protected]>"]
 edition = "2018"
@@ -12,10 +12,6 @@ serde = { version = "1.0.101", optional = true, features = ["derive"] }
 sp-std = { path = "../std", default-features = false }
 sp-io = { path = "../../primitives/io", default-features = false }
 
-[dev-dependencies]
-test-client = { package = "substrate-test-runtime-client", path = "../../test/utils/runtime/client" }
-sp-runtime = { path = "../../primitives/runtime" }
-
 [features]
 default = [ "std" ]
 std = [ "full_crypto", "primitives/std", "codec/std", "serde", "sp-std/std", "sp-io/std" ]

diff --git a/primitives/application-crypto/src/ed25519.rs b/primitives/application-crypto/src/ed25519.rs
@@ -55,26 +55,3 @@ impl RuntimePublic for Public {
 	}
 }
 
-#[cfg(test)]
-mod tests {
-	use sp_runtime::{generic::BlockId, traits::ProvideRuntimeApi};
-	use primitives::{testing::{KeyStore, ED25519}, crypto::Pair};
-	use test_client::{
-		TestClientBuilder, DefaultTestClientBuilderExt, TestClientBuilderExt,
-		runtime::{TestAPI, app_crypto::ed25519::{AppPair, AppPublic}},
-	};
-
-	#[test]
-	fn ed25519_works_in_runtime() {
-		let keystore = KeyStore::new();
-		let test_client = TestClientBuilder::new().set_keystore(keystore.clone()).build();
-		let (signature, public) = test_client.runtime_api()
-			.test_ed25519_crypto(&BlockId::Number(0))
-			.expect("Tests `ed25519` crypto.");
-
-		let key_pair = keystore.read().ed25519_key_pair(ED25519, &public.as_ref())
-			.expect("There should be at a `ed25519` key in the keystore for the given public key.");
-
-		assert!(AppPair::verify(&signature, "ed25519", &AppPublic::from(key_pair.public())));
-	}
-}
diff --git a/primitives/application-crypto/src/lib.rs b/primitives/application-crypto/src/lib.rs
@@ -45,7 +45,7 @@ pub use traits::*;
 /// Application-specific types whose identifier is `$key_type`.
 ///
 /// ```rust
-///# use sc_application_crypto::{app_crypto, wrap, ed25519, KeyTypeId};
+///# use sp_application_crypto::{app_crypto, wrap, ed25519, KeyTypeId};
 /// // Declare a new set of crypto types using Ed25519 logic that identifies as `KeyTypeId`
 /// // of value `b"fuba"`.
 /// app_crypto!(ed25519, KeyTypeId(*b"_uba"));
@@ -66,7 +66,7 @@ macro_rules! app_crypto {
 /// Application-specific types whose identifier is `$key_type`.
 ///
 /// ```rust
-///# use sc_application_crypto::{app_crypto, wrap, ed25519, KeyTypeId};
+///# use sp_application_crypto::{app_crypto, wrap, ed25519, KeyTypeId};
 /// // Declare a new set of crypto types using Ed25519 logic that identifies as `KeyTypeId`
 /// // of value `b"fuba"`.
 /// app_crypto!(ed25519, KeyTypeId(*b"_uba"));
@@ -390,7 +390,7 @@ macro_rules! app_crypto_signature_common {
 /// Implement bidirectional `From` and on-way `AsRef`/`AsMut` for two types, `$inner` and `$outer`.
 ///
 /// ```rust
-/// sc_application_crypto::wrap! {
+/// sp_application_crypto::wrap! {
 ///     pub struct Wrapper(u32);
 /// }
 /// ```