refacto: move StarknetRuntimeApi trait definition in its own crate (#1272)

Yogalholic · tdelabro · web-flow · commit 859f3124dc6d · 2023-11-22T09:26:43.000+01:00
Co-authored-by: Timothée Delabrouille &lt;timothee.delabrouille@gmail.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## Next release
 
+- refacto: move starknet runtime api in it's own crate
 - chore: update README.md and getting-started.md
 - chore: remove crates that have been copy-pasted from plkdtSDK
 - feat(rpc): return deployed contract address and actual fee in transaction
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -3,6 +3,7 @@ resolver = "2"
 members = [
   "crates/node",
   "crates/runtime",
+  "crates/pallets/starknet/runtime_api/",
   "crates/pallets/starknet",
   "crates/primitives/digest-log",
   "crates/primitives/transactions",
@@ -28,6 +29,7 @@ members = [
 default-members = [
   "crates/node",
   "crates/runtime",
+  "crates/pallets/starknet/runtime_api/",
   "crates/pallets/starknet",
   "crates/primitives/digest-log",
   "crates/primitives/transactions",
@@ -147,7 +149,7 @@ pallet-timestamp = { default-features = false, git = "https://github.com/parityt
 
 # Madara pallets
 pallet-starknet = { path = "crates/pallets/starknet", default-features = false }
-
+pallet-starknet-runtime-api = { path = "crates/pallets/starknet/runtime_api", default-features = false }
 # Madara primtitives
 mp-digest-log = { path = "crates/primitives/digest-log", default-features = false }
 mp-block = { path = "crates/primitives/block", default-features = false }
diff --git a/crates/client/commitment-state-diff/Cargo.toml b/crates/client/commitment-state-diff/Cargo.toml
@@ -17,6 +17,7 @@ mp-digest-log = { workspace = true, default-features = true }
 mp-hashers = { workspace = true, default-features = true }
 mp-storage = { workspace = true, default-features = true }
 pallet-starknet = { workspace = true }
+pallet-starknet-runtime-api = { workspace = true, default-features = true }
 
 # Starknet
 blockifier = { workspace = true, default-features = true }
diff --git a/crates/client/commitment-state-diff/src/lib.rs b/crates/client/commitment-state-diff/src/lib.rs
@@ -9,7 +9,7 @@ use futures::{Stream, StreamExt};
 use indexmap::IndexMap;
 use mp_hashers::HasherT;
 use mp_storage::{SN_COMPILED_CLASS_HASH_PREFIX, SN_CONTRACT_CLASS_HASH_PREFIX, SN_NONCE_PREFIX, SN_STORAGE_PREFIX};
-use pallet_starknet::runtime_api::StarknetRuntimeApi;
+use pallet_starknet_runtime_api::StarknetRuntimeApi;
 use sc_client_api::client::BlockchainEvents;
 use sc_client_api::{StorageEventStream, StorageNotification};
 use sp_api::ProvideRuntimeApi;
diff --git a/crates/client/mapping-sync/Cargo.toml b/crates/client/mapping-sync/Cargo.toml
@@ -23,6 +23,7 @@ mp-digest-log = { workspace = true }
 mp-hashers = { workspace = true }
 mp-transactions = { workspace = true }
 pallet-starknet = { workspace = true }
+pallet-starknet-runtime-api = { workspace = true }
 sc-client-api = { workspace = true }
 sp-api = { workspace = true }
 sp-blockchain = { workspace = true }
diff --git a/crates/client/mapping-sync/src/lib.rs b/crates/client/mapping-sync/src/lib.rs
@@ -20,7 +20,7 @@ use futures::task::{Context, Poll};
 use futures_timer::Delay;
 use log::debug;
 use mp_hashers::HasherT;
-use pallet_starknet::runtime_api::StarknetRuntimeApi;
+use pallet_starknet_runtime_api::StarknetRuntimeApi;
 use sc_client_api::backend::{Backend, StorageProvider};
 use sc_client_api::client::ImportNotifications;
 use sp_api::ProvideRuntimeApi;
diff --git a/crates/client/mapping-sync/src/sync_blocks.rs b/crates/client/mapping-sync/src/sync_blocks.rs
@@ -2,7 +2,7 @@ use mc_rpc_core::utils::get_block_by_block_hash;
 use mp_digest_log::{find_starknet_block, FindLogError};
 use mp_hashers::HasherT;
 use mp_transactions::compute_hash::ComputeTransactionHash;
-use pallet_starknet::runtime_api::StarknetRuntimeApi;
+use pallet_starknet_runtime_api::StarknetRuntimeApi;
 use sc_client_api::backend::{Backend, StorageProvider};
 use sp_api::ProvideRuntimeApi;
 use sp_blockchain::{Backend as _, HeaderBackend};
diff --git a/crates/client/rpc/Cargo.toml b/crates/client/rpc/Cargo.toml
@@ -18,6 +18,7 @@ targets = ["x86_64-unknown-linux-gnu"]
 [dependencies]
 # Madara runtime
 pallet-starknet = { workspace = true, default-features = true }
+pallet-starknet-runtime-api = { workspace = true, default-features = true }
 # Madara client
 mc-db = { workspace = true }
 mc-rpc-core = { workspace = true }
diff --git a/crates/client/rpc/src/errors.rs b/crates/client/rpc/src/errors.rs
@@ -1,5 +1,5 @@
 use jsonrpsee::types::error::{CallError, ErrorObject};
-use pallet_starknet::runtime_api::StarknetTransactionExecutionError;
+use pallet_starknet_runtime_api::StarknetTransactionExecutionError;
 
 // Comes from the RPC Spec:
 // https://github.com/starkware-libs/starknet-specs/blob/0e859ff905795f789f1dfd6f7340cdaf5015acc8/api/starknet_write_api.json#L227
diff --git a/crates/client/rpc/src/events/mod.rs b/crates/client/rpc/src/events/mod.rs
@@ -9,7 +9,7 @@ use log::error;
 use mc_rpc_core::utils::get_block_by_block_hash;
 use mp_felt::Felt252Wrapper;
 use mp_hashers::HasherT;
-use pallet_starknet::runtime_api::{ConvertTransactionRuntimeApi, StarknetRuntimeApi};
+use pallet_starknet_runtime_api::{ConvertTransactionRuntimeApi, StarknetRuntimeApi};
 use sc_client_api::backend::{Backend, StorageProvider};
 use sc_client_api::BlockBackend;
 use sc_transaction_pool::ChainApi;
diff --git a/crates/client/rpc/src/lib.rs b/crates/client/rpc/src/lib.rs
@@ -24,7 +24,7 @@ use mp_hashers::HasherT;
 use mp_transactions::compute_hash::ComputeTransactionHash;
 use mp_transactions::to_starknet_core_transaction::to_starknet_core_tx;
 use mp_transactions::UserTransaction;
-use pallet_starknet::runtime_api::{ConvertTransactionRuntimeApi, StarknetRuntimeApi};
+use pallet_starknet_runtime_api::{ConvertTransactionRuntimeApi, StarknetRuntimeApi};
 use sc_client_api::backend::{Backend, StorageProvider};
 use sc_client_api::BlockBackend;
 use sc_network_sync::SyncingService;
diff --git a/crates/client/storage/Cargo.toml b/crates/client/storage/Cargo.toml
@@ -20,6 +20,7 @@ frame-system = { workspace = true, features = ["std"] }
 madara-runtime = { workspace = true, features = ["std"] }
 mp-storage = { workspace = true, features = ["std"] }
 pallet-starknet = { workspace = true, features = ["std"] }
+pallet-starknet-runtime-api = { workspace = true, features = ["std"] }
 sc-client-api = { workspace = true }
 scale-codec = { workspace = true, features = ["std"] }
 sp-api = { workspace = true, features = ["std"] }
diff --git a/crates/client/storage/src/lib.rs b/crates/client/storage/src/lib.rs
@@ -13,7 +13,7 @@ use std::sync::Arc;
 
 use mp_storage::{StarknetStorageSchemaVersion, PALLET_STARKNET_SCHEMA};
 pub use overrides::*;
-use pallet_starknet::runtime_api::StarknetRuntimeApi;
+use pallet_starknet_runtime_api::StarknetRuntimeApi;
 use sc_client_api::backend::{Backend, StorageProvider};
 use scale_codec::Decode;
 use sp_api::ProvideRuntimeApi;
diff --git a/crates/client/storage/src/overrides/mod.rs b/crates/client/storage/src/overrides/mod.rs
@@ -5,7 +5,7 @@ use std::sync::Arc;
 use blockifier::execution::contract_class::ContractClass;
 use frame_support::{Identity, StorageHasher};
 use mp_storage::StarknetStorageSchemaVersion;
-use pallet_starknet::runtime_api::StarknetRuntimeApi;
+use pallet_starknet_runtime_api::StarknetRuntimeApi;
 use sc_client_api::{Backend, HeaderBackend, StorageProvider};
 use sp_api::ProvideRuntimeApi;
 use sp_io::hashing::twox_128;
diff --git a/crates/node/Cargo.toml b/crates/node/Cargo.toml
@@ -86,6 +86,7 @@ mc-mapping-sync = { workspace = true }
 mc-rpc = { workspace = true }
 mc-storage = { workspace = true }
 pallet-starknet = { workspace = true }
+pallet-starknet-runtime-api = { workspace = true }
 starknet-core = { workspace = true }
 
 # Primitives
diff --git a/crates/node/src/rpc/mod.rs b/crates/node/src/rpc/mod.rs
@@ -53,8 +53,8 @@ where
     C: Send + Sync + 'static,
     C::Api: substrate_frame_rpc_system::AccountNonceApi<Block, AccountId, Index>,
     C::Api: BlockBuilder<Block>,
-    C::Api: pallet_starknet::runtime_api::StarknetRuntimeApi<Block>
-        + pallet_starknet::runtime_api::ConvertTransactionRuntimeApi<Block>,
+    C::Api: pallet_starknet_runtime_api::StarknetRuntimeApi<Block>
+        + pallet_starknet_runtime_api::ConvertTransactionRuntimeApi<Block>,
     P: TransactionPool<Block = Block> + 'static,
     BE: Backend<Block> + 'static,
 {
diff --git a/crates/pallets/starknet/runtime_api/Cargo.toml b/crates/pallets/starknet/runtime_api/Cargo.toml
@@ -0,0 +1,47 @@
+[package]
+name = "pallet-starknet-runtime-api"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+# Madara primitives
+mp-felt = { workspace = true, features = ["parity-scale-codec", "serde"] }
+mp-transactions = { workspace = true, features = [
+  "parity-scale-codec",
+  "scale-info",
+] }
+
+# Starknet
+blockifier = { workspace = true, features = [
+  "parity-scale-codec",
+  "scale-info",
+] }
+hashbrown = { workspace = true }
+starknet_api = { workspace = true, features = [
+  "scale-info",
+  "parity-scale-codec",
+] }
+
+# Substrate 
+parity-scale-codec = { workspace = true, features = ["derive"] }
+scale-info = { workspace = true, features = ["derive"] }
+sp-api = { workspace = true }
+sp-arithmetic = { workspace = true }
+sp-runtime = { workspace = true }
+
+
+[features]
+default = ["std"]
+std = [
+  "mp-felt/std",
+  "mp-transactions/std",
+  "blockifier/std",
+  "starknet_api/std",
+  "sp-api/std",
+  "sp-runtime/std",
+  "sp-arithmetic/std",
+  "parity-scale-codec/std",
+  "scale-info/std",
+]
diff --git a/crates/pallets/starknet/runtime_api/src/lib.rs b/crates/pallets/starknet/runtime_api/src/lib.rs
@@ -1,5 +1,6 @@
 //! Definition of the runtime API for the StarkNet pallet.
 
+#![cfg_attr(not(feature = "std"), no_std)]
 // Adding allow unused type parameters to avoid clippy errors
 // generated by the `decl_runtime_apis` macro.
 // Specifically, the macro generates a trait (`StarknetRuntimeApi`) with unused type parameters.
diff --git a/crates/pallets/starknet/src/lib.rs b/crates/pallets/starknet/src/lib.rs
@@ -45,8 +45,6 @@ pub mod blockifier_state_adapter;
 pub mod genesis_loader;
 /// The implementation of the message type.
 pub mod message;
-/// The Starknet pallet's runtime API
-pub mod runtime_api;
 /// Transaction validation logic.
 pub mod transaction_validation;
 /// The Starknet pallet's runtime custom types.
diff --git a/crates/runtime/Cargo.toml b/crates/runtime/Cargo.toml
@@ -50,6 +50,7 @@ frame-system-benchmarking = { workspace = true, optional = true }
 # Madara Local Dependencies
 # Madara Pallets
 pallet-starknet = { workspace = true }
+pallet-starknet-runtime-api = { workspace = true }
 
 # Madara Primitives
 mp-chain-id = { workspace = true }
diff --git a/crates/runtime/src/lib.rs b/crates/runtime/src/lib.rs
@@ -34,9 +34,9 @@ use pallet_grandpa::{fg_primitives, AuthorityId as GrandpaId, AuthorityList as G
 /// Import the StarkNet pallet.
 pub use pallet_starknet;
 use pallet_starknet::pallet::Error as PalletError;
-use pallet_starknet::runtime_api::StarknetTransactionExecutionError;
 use pallet_starknet::Call::{consume_l1_message, declare, deploy_account, invoke};
 use pallet_starknet::{Config, Event};
+use pallet_starknet_runtime_api::StarknetTransactionExecutionError;
 pub use pallet_timestamp::Call as TimestampCall;
 use sp_api::impl_runtime_apis;
 use sp_consensus_aura::sr25519::AuthorityId as AuraId;
@@ -232,7 +232,7 @@ impl_runtime_apis! {
         }
     }
 
-    impl pallet_starknet::runtime_api::StarknetRuntimeApi<Block> for Runtime {
+    impl pallet_starknet_runtime_api::StarknetRuntimeApi<Block> for Runtime {
 
         fn get_storage_at(address: ContractAddress, key: StorageKey) -> Result<StarkFelt, DispatchError> {
             Starknet::get_storage_at(address, key)
@@ -362,12 +362,12 @@ impl_runtime_apis! {
            Starknet::tx_revert_error(tx_hash).map(|s| s.into_bytes())
         }
 
-        fn get_block_context() -> pallet_starknet::runtime_api::BlockContext {
+        fn get_block_context() -> pallet_starknet_runtime_api::BlockContext {
            Starknet::get_block_context().into()
         }
     }
 
-    impl pallet_starknet::runtime_api::ConvertTransactionRuntimeApi<Block> for Runtime {
+    impl pallet_starknet_runtime_api::ConvertTransactionRuntimeApi<Block> for Runtime {
         fn convert_transaction(transaction: UserTransaction) -> Result<UncheckedExtrinsic, DispatchError> {
             let call = match transaction {
                 UserTransaction::Declare(tx, contract_class) => {
