favor imports from api-client-types crate & fix api-client features; remove unused jsonrpsee dependency (#1271)

clangenb · web-flow · commit 67a3cf618c56 · 2023-04-06T08:42:22.000+02:00
* update api-client feature flags to remove unused jsonrpsee dependency.

* update enclave Cargo.lock

* [itp-api-client-types] re-export extrinsic params trait.

* [itp-node-api-metadata] use Metadata from itp-api-client-types instead of from api-client

* [enclave-runtime] remove unnecessary dependency on the substrate-api-client

* [itc-rpc-client] uses now the types from itp-api-client-types

* [enclave-runtime] fix api-client dependencies in tests.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/cli/Cargo.toml b/cli/Cargo.toml
@@ -28,7 +28,8 @@ ws = { version = "0.9.1", features = ["ssl"] }
 my-node-runtime = { package = "integritee-node-runtime", git = "https://github.com/integritee-network/integritee-node.git", branch = "polkadot-v0.9.39" }
 pallet-evm = { optional = true, git = "https://github.com/integritee-network/frontier.git", branch = "polkadot-v0.9.39" }
 pallet-teerex = { git = "https://github.com/integritee-network/pallets.git", branch = "polkadot-v0.9.39" }
-substrate-api-client = { features = ["ws-client"], git = "https://github.com/scs/substrate-api-client.git", branch = "polkadot-v0.9.39" }
+# `default-features = false` to remove the jsonrpsee dependency.
+substrate-api-client = { default-features = false, features = ["std", "ws-client"], git = "https://github.com/scs/substrate-api-client.git", branch = "polkadot-v0.9.39" }
 substrate-client-keystore = { git = "https://github.com/scs/substrate-api-client.git", branch = "polkadot-v0.9.39" }
 teerex-primitives = { git = "https://github.com/integritee-network/pallets.git", branch = "polkadot-v0.9.39" }
 
diff --git a/core-primitives/node-api/api-client-extensions/Cargo.toml b/core-primitives/node-api/api-client-extensions/Cargo.toml
@@ -15,7 +15,8 @@ sp-finality-grandpa = { git = "https://github.com/paritytech/substrate.git", bra
 sp-runtime = { git = "https://github.com/paritytech/substrate.git", branch = "polkadot-v0.9.39" }
 
 # scs
-substrate-api-client = { git = "https://github.com/scs/substrate-api-client.git", branch = "polkadot-v0.9.39" }
+# `default-features = false` to remove the jsonrpsee dependency.
+substrate-api-client = { default-features = false, features = ["std"], git = "https://github.com/scs/substrate-api-client.git", branch = "polkadot-v0.9.39" }
 
 # local deps
 itp-api-client-types = { path = "../api-client-types" }
diff --git a/core-primitives/node-api/api-client-types/src/lib.rs b/core-primitives/node-api/api-client-types/src/lib.rs
@@ -26,7 +26,8 @@ pub use itp_types::parentchain::{
 	AccountId, Address, Balance, Hash, Index, Signature as PairSignature,
 };
 pub use substrate_api_client::{
-	AssetTip, CallIndex, GenericAdditionalParams, GenericExtrinsicParams, GenericSignedExtra,
+	storage_key, AssetTip, CallIndex, ExtrinsicParams, GenericAdditionalParams,
+	GenericExtrinsicParams, GenericSignedExtra, InvalidMetadataError, Metadata, MetadataError,
 	PlainTip, StaticExtrinsicSigner, UncheckedExtrinsicV4,
 };
 
diff --git a/core-primitives/node-api/metadata/Cargo.toml b/core-primitives/node-api/metadata/Cargo.toml
@@ -9,18 +9,18 @@ edition = "2021"
 codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = ["derive"] }
 derive_more = { version = "0.99.5" }
 
+# local
+itp-api-client-types = { default-features = false, path = "../api-client-types" }
+
 # substrate
 sp-core = { git = "https://github.com/paritytech/substrate.git", default-features = false, branch = "polkadot-v0.9.39" }
 
-# scs
-substrate-api-client = { default-features = false, git = "https://github.com/scs/substrate-api-client.git", branch = "polkadot-v0.9.39" }
-
 [features]
 default = ["std"]
 std = [
     "codec/std",
+    "itp-api-client-types/std",
     "sp-core/std",
-    "substrate-api-client/std",
 ]
 
 # used for unit testing only!
diff --git a/core-primitives/node-api/metadata/src/error.rs b/core-primitives/node-api/metadata/src/error.rs
@@ -21,7 +21,7 @@ pub enum Error {
 	/// Metadata has not been set
 	MetadataNotSet,
 	/// Api-client metadata error
-	NodeMetadata(substrate_api_client::MetadataError),
+	NodeMetadata(itp_api_client_types::MetadataError),
 }
 
 pub type Result<T> = core::result::Result<T, Error>;
diff --git a/core-primitives/node-api/metadata/src/lib.rs b/core-primitives/node-api/metadata/src/lib.rs
@@ -23,8 +23,8 @@ use crate::{
 	error::Result, pallet_sidechain::SidechainCallIndexes, pallet_teerex::TeerexCallIndexes,
 };
 use codec::{Decode, Encode};
+use itp_api_client_types::{Metadata, MetadataError};
 use sp_core::storage::StorageKey;
-use substrate_api_client::{Metadata, MetadataError};
 
 pub use crate::error::Error;
 
diff --git a/core-primitives/stf-executor/Cargo.toml b/core-primitives/stf-executor/Cargo.toml
@@ -25,9 +25,6 @@ itp-time-utils = { path = "../time-utils", default-features = false }
 itp-top-pool-author = { path = "../top-pool-author", default-features = false }
 itp-types = { path = "../types", default-features = false }
 
-# scs
-substrate-api-client = { default-features = false, git = "https://github.com/scs/substrate-api-client.git", branch = "polkadot-v0.9.39" }
-
 # sgx enabled external libraries
 thiserror_sgx = { optional = true, package = "thiserror", git = "https://github.com/mesalock-linux/thiserror-sgx", tag = "sgx_1.1.3" }
 
@@ -69,8 +66,6 @@ std = [
     # crates.io
     "log/std",
     "codec/std",
-    # scs
-    "substrate-api-client/std",
     # substrate
     "sp-core/std",
     "sp-runtime/std",
diff --git a/core/parentchain/indirect-calls-executor/Cargo.toml b/core/parentchain/indirect-calls-executor/Cargo.toml
@@ -37,9 +37,6 @@ binary-merkle-tree = { default-features = false, git = "https://github.com/parit
 sp-core = { default-features = false, features = ["full_crypto"], git = "https://github.com/paritytech/substrate.git", branch = "polkadot-v0.9.39" }
 sp-runtime = { default-features = false, git = "https://github.com/paritytech/substrate.git", branch = "polkadot-v0.9.39" }
 
-# scs/integritee
-substrate-api-client = { git = "https://github.com/scs/substrate-api-client.git", branch = "polkadot-v0.9.39", default-features = false }
-
 [dev-dependencies]
 env_logger = "0.9.0"
 itp-node-api = { path = "../../../core-primitives/node-api", features = ["mocks"] }
@@ -67,7 +64,6 @@ std = [
     "binary-merkle-tree/std",
     "sp-core/std",
     "sp-runtime/std",
-    "substrate-api-client/std",
     "thiserror",
 ]
 sgx = [
diff --git a/core/parentchain/indirect-calls-executor/src/executor.rs b/core/parentchain/indirect-calls-executor/src/executor.rs
@@ -235,7 +235,8 @@ mod test {
 	use itc_parentchain_test::parentchain_block_builder::ParentchainBlockBuilder;
 	use itp_node_api::{
 		api_client::{
-			ParentchainAdditionalParams, ParentchainExtrinsicParams, ParentchainUncheckedExtrinsic,
+			ExtrinsicParams, ParentchainAdditionalParams, ParentchainExtrinsicParams,
+			ParentchainUncheckedExtrinsic,
 		},
 		metadata::{metadata_mocks::NodeMetadataMock, provider::NodeMetadataRepository},
 	};
@@ -250,7 +251,6 @@ mod test {
 	use sp_core::{ed25519, Pair};
 	use sp_runtime::{MultiSignature, OpaqueExtrinsic};
 	use std::assert_matches::assert_matches;
-	use substrate_api_client::ExtrinsicParams;
 
 	type TestShieldingKeyRepo = KeyRepositoryMock<ShieldingCryptoMock>;
 	type TestStfEnclaveSigner = StfEnclaveSignerMock;
diff --git a/core/rpc-client/Cargo.toml b/core/rpc-client/Cargo.toml
@@ -13,16 +13,15 @@ parking_lot = "0.12.1"
 serde_derive = "1.0"
 serde_json = "1.0"
 sgx_crypto_helper = { branch = "master", git = "https://github.com/apache/teaclave-sgx-sdk.git" }
-substrate-api-client = { git = "https://github.com/scs/substrate-api-client.git", branch = "polkadot-v0.9.39" }
 thiserror = { version = "1.0" }
 url = { version = "2.0.0" }
 ws = { version = "0.9.1", features = ["ssl"] }
 
 # parity
 frame-metadata = { git = "https://github.com/paritytech/frame-metadata", features = ["v14"] }
 
-
 # local
+itp-api-client-types = { path = "../../core-primitives/node-api/api-client-types" }
 itp-rpc = { path = "../../core-primitives/rpc" }
 itp-types = { path = "../../core-primitives/types" }
 itp-utils = { path = "../../core-primitives/utils" }
diff --git a/core/rpc-client/src/direct_client.rs b/core/rpc-client/src/direct_client.rs
@@ -20,6 +20,7 @@
 use crate::ws_client::{WsClient, WsClientControl};
 use codec::Decode;
 use frame_metadata::RuntimeMetadataPrefixed;
+use itp_api_client_types::Metadata;
 use itp_rpc::{RpcRequest, RpcResponse, RpcReturnValue};
 use itp_types::DirectRequestStatus;
 use itp_utils::FromHexPrefixed;
@@ -33,7 +34,6 @@ use std::{
 	thread,
 	thread::JoinHandle,
 };
-use substrate_api_client::metadata::Metadata;
 
 pub use crate::error::{Error, Result};
 
diff --git a/core/rpc-client/src/error.rs b/core/rpc-client/src/error.rs
@@ -15,9 +15,9 @@
 
 */
 use codec::Error as CodecError;
+use itp_api_client_types::InvalidMetadataError;
 use serde_json::Error as JsonError;
 use std::{boxed::Box, sync::mpsc::RecvError};
-use substrate_api_client::metadata::InvalidMetadataError;
 use thiserror;
 use ws::Error as WsClientError;
 
diff --git a/core/rpc-client/src/mock.rs b/core/rpc-client/src/mock.rs
@@ -20,9 +20,9 @@
 use crate::{direct_client::DirectApi, error::Result};
 use codec::Decode;
 use frame_metadata::RuntimeMetadataPrefixed;
+use itp_api_client_types::Metadata;
 use sgx_crypto_helper::rsa3072::Rsa3072PubKey;
 use std::{sync::mpsc::Sender as MpscSender, thread::JoinHandle};
-use substrate_api_client::Metadata;
 
 #[derive(Clone, Default)]
 pub struct DirectClientMock {
diff --git a/core/rpc-client/src/ws_client.rs b/core/rpc-client/src/ws_client.rs
@@ -15,11 +15,11 @@
 
 */
 
-use crate::error::{Error, Result as RpcClientResult};
 ///! Websocket client implementation to access the direct-rpc-server running inside an enclave.
 ///
 /// This should be replaced with the `jsonrpsee::WsClient`as soon as available in no-std:
 /// https://github.com/paritytech/jsonrpsee/issues/1
+use crate::error::{Error, Result as RpcClientResult};
 use log::*;
 use openssl::ssl::{SslConnector, SslMethod, SslStream, SslVerifyMode};
 use parking_lot::Mutex;
diff --git a/enclave-runtime/Cargo.lock b/enclave-runtime/Cargo.lock
@@ -742,7 +742,6 @@ dependencies = [
  "sp-core",
  "sp-runtime",
  "sp-std",
- "substrate-api-client",
  "webpki",
 ]
 
@@ -1693,7 +1692,6 @@ dependencies = [
  "sgx_types",
  "sp-core",
  "sp-runtime",
- "substrate-api-client",
  "thiserror 1.0.9",
 ]
 
@@ -1910,9 +1908,9 @@ name = "itp-node-api-metadata"
 version = "0.9.0"
 dependencies = [
  "derive_more",
+ "itp-api-client-types",
  "parity-scale-codec",
  "sp-core",
- "substrate-api-client",
 ]
 
 [[package]]
@@ -2049,7 +2047,6 @@ dependencies = [
  "sgx_types",
  "sp-core",
  "sp-runtime",
- "substrate-api-client",
  "thiserror 1.0.9",
 ]
 
@@ -4605,7 +4602,7 @@ version = "1.6.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "97fee6b57c6a41524a810daee9286c02d7752c4253064d0b05472833a438f675"
 dependencies = [
- "cfg-if 1.0.0",
+ "cfg-if 0.1.10",
  "digest 0.10.6",
  "static_assertions",
 ]
diff --git a/enclave-runtime/Cargo.toml b/enclave-runtime/Cargo.toml
@@ -70,7 +70,6 @@ primitive-types = { version = "0.12.1", default-features = false, features = ["c
 
 # scs / integritee
 jsonrpc-core = { default-features = false, git = "https://github.com/scs/jsonrpc", branch = "no_std_v18" }
-substrate-api-client = { default-features = false, git = "https://github.com/scs/substrate-api-client.git", branch = "polkadot-v0.9.39" }
 
 # mesalock
 env_logger = { git = "https://github.com/integritee-network/env_logger-sgx" }
diff --git a/enclave-runtime/src/test/on_chain_ocall_tests.rs b/enclave-runtime/src/test/on_chain_ocall_tests.rs
@@ -17,11 +17,11 @@
 */
 
 use crate::ocall::OcallApi;
+use itp_node_api::api_client::storage_key;
 use itp_ocall_api::EnclaveOnChainOCallApi;
 use itp_types::{WorkerRequest, WorkerResponse};
 use log::*;
 use std::vec::Vec;
-use substrate_api_client::storage_key;
 
 #[allow(unused)]
 fn test_ocall_worker_request() {
diff --git a/enclave-runtime/src/test/top_pool_tests.rs b/enclave-runtime/src/test/top_pool_tests.rs
@@ -44,7 +44,8 @@ use itc_parentchain_test::{
 };
 use itp_node_api::{
 	api_client::{
-		ParentchainAdditionalParams, ParentchainExtrinsicParams, ParentchainUncheckedExtrinsic,
+		ExtrinsicParams, ParentchainAdditionalParams, ParentchainExtrinsicParams,
+		ParentchainUncheckedExtrinsic,
 	},
 	metadata::{
 		metadata_mocks::NodeMetadataMock, pallet_teerex::TeerexCallIndexes,
@@ -64,7 +65,6 @@ use sgx_crypto_helper::RsaKeyPair;
 use sp_core::{ed25519, Pair};
 use sp_runtime::{MultiSignature, OpaqueExtrinsic};
 use std::{sync::Arc, vec::Vec};
-use substrate_api_client::ExtrinsicParams;
 
 pub fn process_indirect_call_in_top_pool() {
 	let _ = env_logger::builder().is_test(true).try_init();
diff --git a/service/Cargo.toml b/service/Cargo.toml
@@ -60,7 +60,8 @@ its-storage = { path = "../sidechain/storage" }
 
 my-node-runtime = { package = "integritee-node-runtime", git = "https://github.com/integritee-network/integritee-node.git", branch = "polkadot-v0.9.39" }
 sgx-verify = { git = "https://github.com/integritee-network/pallets.git", branch = "polkadot-v0.9.39" }
-substrate-api-client = { git = "https://github.com/scs/substrate-api-client.git", branch = "polkadot-v0.9.39" }
+# `default-features = false` to remove the jsonrpsee dependency.
+substrate-api-client = { default-features = false, features = ["std", "ws-client"], git = "https://github.com/scs/substrate-api-client.git", branch = "polkadot-v0.9.39" }
 teerex-primitives = { git = "https://github.com/integritee-network/pallets.git", branch = "polkadot-v0.9.39" }
 
 # Substrate dependencies

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ pub enum Error {`
`21`	`21`	`/// Metadata has not been set`
`22`	`22`	`MetadataNotSet,`
`23`	`23`	`/// Api-client metadata error`
`24`		`- NodeMetadata(substrate_api_client::MetadataError),`
	`24`	`+ NodeMetadata(itp_api_client_types::MetadataError),`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`pub type Result<T> = core::result::Result<T, Error>;`