[RPC API][Refactoring] - Move rpc apis to it's own package (MystenLab…

…s#2542) * move rpc apis to it's own package and decouple it from gateway, in preparation of creating a Sui rust SDK * minor fixes * fix fmt * rename sui-rpc and sui-rpc-api to sui-json-rpc and sui-json-rpc-api
yellow0x · Jun 14, 2022 · b027b24 · b027b24
1 parent d96ea49
commit b027b24
Show file tree

Hide file tree

Showing 39 changed files with 394 additions and 214 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -13,6 +13,8 @@ members = [
     "crates/sui-framework-build",
     "crates/sui-gateway",
     "crates/sui-json",
+    "crates/sui-json-rpc",
+    "crates/sui-json-rpc-api",
     "crates/sui-network",
     "crates/sui-node",
     "crates/sui-open-rpc",

diff --git a/crates/generate-json-rpc-spec/Cargo.toml b/crates/generate-json-rpc-spec/Cargo.toml
@@ -16,6 +16,8 @@ tempfile = "3.3.0"
 tokio = { version = "1.18.2", features = ["full"] }
 
 sui = { path = "../sui" }
+sui-json-rpc = { path = "../sui-json-rpc" }
+sui-json-rpc-api = { path = "../sui-json-rpc-api" }
 sui-core = { path = "../sui-core" }
 sui-gateway = { path = "../sui-gateway" }
 sui-json = { path = "../sui-json" }

diff --git a/crates/generate-json-rpc-spec/src/main.rs b/crates/generate-json-rpc-spec/src/main.rs
@@ -2,6 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use std::collections::BTreeMap;
+use std::fs::File;
+use std::io::Write;
 
 use clap::ArgEnum;
 use clap::Parser;
@@ -11,24 +13,23 @@ use pretty_assertions::assert_str_eq;
 use serde::Serialize;
 use serde_json::{json, Map, Value};
 
-use std::fs::File;
-use std::io::Write;
 use sui::wallet_commands::{WalletCommandResult, WalletCommands, WalletContext};
 use sui::wallet_commands::{EXAMPLE_NFT_DESCRIPTION, EXAMPLE_NFT_NAME, EXAMPLE_NFT_URL};
 use sui_config::genesis_config::GenesisConfig;
 use sui_config::SUI_WALLET_CONFIG;
-use sui_core::gateway_types::{
+use sui_json::SuiJsonValue;
+use sui_json_rpc::bcs_api::BcsApiImpl;
+use sui_json_rpc::gateway_api::{GatewayReadApiImpl, RpcGatewayImpl, TransactionBuilderImpl};
+use sui_json_rpc::read_api::{FullNodeApi, ReadApi};
+use sui_json_rpc::sui_rpc_doc;
+use sui_json_rpc::SuiRpcModule;
+use sui_json_rpc_api::rpc_types::{
     GetObjectDataResponse, SuiObjectInfo, TransactionEffectsResponse, TransactionResponse,
 };
-use sui_gateway::api::RpcGatewayApiClient;
-use sui_gateway::api::RpcReadApiClient;
-use sui_gateway::api::RpcTransactionBuilderClient;
-use sui_gateway::api::{SuiRpcModule, TransactionBytes};
-use sui_gateway::bcs_api::BcsApiImpl;
-use sui_gateway::json_rpc::sui_rpc_doc;
-use sui_gateway::read_api::{FullNodeApi, ReadApi};
-use sui_gateway::rpc_gateway::{GatewayReadApiImpl, RpcGatewayImpl, TransactionBuilderImpl};
-use sui_json::SuiJsonValue;
+use sui_json_rpc_api::QuorumDriverApiClient;
+use sui_json_rpc_api::RpcReadApiClient;
+use sui_json_rpc_api::RpcTransactionBuilderClient;
+use sui_json_rpc_api::TransactionBytes;
 use sui_types::base_types::{ObjectID, SuiAddress};
 use sui_types::sui_serde::{Base64, Encoding};
 use sui_types::SUI_FRAMEWORK_ADDRESS;

diff --git a/crates/sui-cluster-test/Cargo.toml b/crates/sui-cluster-test/Cargo.toml
@@ -20,6 +20,7 @@ telemetry-subscribers = { git = "https://github.com/MystenLabs/mysten-infra", re
 
 sui-faucet = { path = "../sui-faucet" }
 sui = { path = "../sui" }
+sui-json-rpc-api = { path = "../sui-json-rpc-api" }
 sui-core = { path = "../sui-core" }
 sui-types = { path = "../sui-types" }
 sui-json = { path = "../sui-json" }

diff --git a/crates/sui-cluster-test/src/main.rs b/crates/sui-cluster-test/src/main.rs
@@ -11,9 +11,9 @@ use sui::{
         call_move, WalletContext, EXAMPLE_NFT_DESCRIPTION, EXAMPLE_NFT_NAME, EXAMPLE_NFT_URL,
     },
 };
-use sui_core::gateway_types::{GetObjectDataResponse, SuiExecutionStatus, TransactionResponse};
 use sui_faucet::FaucetResponse;
 use sui_json::SuiJsonValue;
+use sui_json_rpc_api::rpc_types::{GetObjectDataResponse, SuiExecutionStatus, TransactionResponse};
 use sui_types::{
     base_types::{encode_bytes_hex, ObjectID, SuiAddress},
     crypto::get_key_pair,

diff --git a/crates/sui-core/Cargo.toml b/crates/sui-core/Cargo.toml
@@ -49,6 +49,7 @@ sui-types = { path = "../sui-types" }
 sui-storage = { path = "../sui-storage" }
 sui-config = { path = "../sui-config" }
 sui-json = { path = "../sui-json" }
+sui-json-rpc-api = { path = "../sui-json-rpc-api" }
 
 move-binary-format = { git = "https://github.com/move-language/move", rev = "4e15a34ecf155b7e2d9729d3b07f83c146149f02" }
 move-bytecode-utils = { git = "https://github.com/move-language/move", rev = "4e15a34ecf155b7e2d9729d3b07f83c146149f02" }

diff --git a/crates/sui-core/src/authority.rs b/crates/sui-core/src/authority.rs
@@ -9,7 +9,6 @@ use crate::{
     epoch::EpochInfoLocals,
     event_handler::EventHandler,
     execution_engine,
-    gateway_types::TransactionEffectsResponse,
     query_helpers::QueryHelpers,
     transaction_input_checker,
 };
@@ -1101,7 +1100,7 @@ impl AuthorityState {
     pub async fn get_transaction(
         &self,
         digest: TransactionDigest,
-    ) -> Result<TransactionEffectsResponse, anyhow::Error> {
+    ) -> Result<(CertifiedTransaction, TransactionEffects), anyhow::Error> {
         QueryHelpers::get_transaction(&self.database, digest)
     }
 

diff --git a/crates/sui-core/src/gateway_state.rs b/crates/sui-core/src/gateway_state.rs
@@ -42,8 +42,12 @@ use crate::{
     query_helpers::QueryHelpers,
 };
 use sui_json::{resolve_move_function_args, SuiJsonCallArg, SuiJsonValue};
+use sui_json_rpc_api::rpc_types::{
+    GetObjectDataResponse, GetRawObjectDataResponse, MergeCoinResponse, PublishResponse,
+    SplitCoinResponse, SuiMoveObject, SuiObject, SuiObjectInfo, TransactionEffectsResponse,
+    TransactionResponse,
+};
 
-use crate::gateway_types::*;
 use crate::transaction_input_checker::InputObjects;
 
 #[cfg(test)]
@@ -1214,6 +1218,12 @@ where
         &self,
         digest: TransactionDigest,
     ) -> Result<TransactionEffectsResponse, anyhow::Error> {
-        QueryHelpers::get_transaction(&self.store, digest)
+        let (cert, effect) = QueryHelpers::get_transaction(&self.store, digest)?;
+
+        Ok(TransactionEffectsResponse {
+            certificate: cert.try_into()?,
+            effects: effect.into(),
+            timestamp_ms: None,
+        })
     }
 }
diff --git a/crates/sui-core/src/lib.rs b/crates/sui-core/src/lib.rs
@@ -13,7 +13,6 @@ pub mod epoch;
 pub mod event_handler;
 pub mod execution_engine;
 pub mod gateway_state;
-pub mod gateway_types;
 pub mod safe_client;
 pub mod streamer;
 pub mod transaction_input_checker;

diff --git a/crates/sui-core/src/query_helpers.rs b/crates/sui-core/src/query_helpers.rs
@@ -1,9 +1,10 @@
 // Copyright (c) 2022, Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::{authority::SuiDataStore, gateway_types::TransactionEffectsResponse};
+use crate::authority::SuiDataStore;
 use anyhow::anyhow;
 use serde::{Deserialize, Serialize};
+use sui_types::messages::{CertifiedTransaction, TransactionEffects};
 use sui_types::{base_types::*, batch::TxSequenceNumber, error::SuiError, fp_ensure};
 use tracing::debug;
 
@@ -79,14 +80,10 @@ impl<const ALL_OBJ_VER: bool, S: Eq + Serialize + for<'de> Deserialize<'de>>
     pub fn get_transaction(
         database: &SuiDataStore<ALL_OBJ_VER, S>,
         digest: TransactionDigest,
-    ) -> Result<TransactionEffectsResponse, anyhow::Error> {
+    ) -> Result<(CertifiedTransaction, TransactionEffects), anyhow::Error> {
         let opt = database.get_certified_transaction(&digest)?;
         match opt {
-            Some(certificate) => Ok(TransactionEffectsResponse {
-                certificate: certificate.try_into()?,
-                effects: database.get_effects(&digest)?.into(),
-                timestamp_ms: None,
-            }),
+            Some(certificate) => Ok((certificate, database.get_effects(&digest)?)),
             None => Err(anyhow!(SuiError::TransactionNotFound { digest })),
         }
     }

diff --git a/crates/sui-faucet/Cargo.toml b/crates/sui-faucet/Cargo.toml
@@ -21,6 +21,7 @@ serde_json = "1.0.80"
 tower = { version = "0.4.12", features = ["util", "timeout", "load-shed", "limit"] }
 
 sui = { path = "../sui" }
+sui-json-rpc-api = { path = "../sui-json-rpc-api" }
 sui-types = { path = "../sui-types" }
 sui-core = { path = "../sui-core" }
 sui-config = { path = "../sui-config" }

diff --git a/crates/sui-faucet/src/faucet/mod.rs b/crates/sui-faucet/src/faucet/mod.rs
@@ -3,7 +3,7 @@
 use crate::FaucetError;
 use async_trait::async_trait;
 use serde::{Deserialize, Serialize};
-use sui_core::gateway_types::SuiParsedObject;
+use sui_json_rpc_api::rpc_types::SuiParsedObject;
 use sui_types::{
     base_types::{ObjectID, SuiAddress},
     gas_coin::GasCoin,

diff --git a/crates/sui-faucet/src/faucet/simple_faucet.rs b/crates/sui-faucet/src/faucet/simple_faucet.rs
@@ -4,7 +4,7 @@
 use anyhow::anyhow;
 use async_trait::async_trait;
 use sui::wallet_commands::WalletContext;
-use sui_core::gateway_types::{SuiExecutionStatus, SuiParsedObject};
+use sui_json_rpc_api::rpc_types::{SuiExecutionStatus, SuiParsedObject};
 use sui_types::{
     base_types::{ObjectID, SuiAddress},
     gas_coin::GasCoin,

diff --git a/crates/sui-gateway/Cargo.toml b/crates/sui-gateway/Cargo.toml
@@ -27,8 +27,8 @@ sui-core = { path = "../sui-core" }
 sui-config = { path = "../sui-config" }
 sui-types = { path = "../sui-types" }
 sui-json = { path = "../sui-json" }
+sui-json-rpc-api = { path = "../sui-json-rpc-api" }
 sui-open-rpc = { path = "../sui-open-rpc" }
-sui-open-rpc-macros = { path = "../sui-open-rpc-macros" }
 
 move-core-types = { git = "https://github.com/move-language/move", rev = "4e15a34ecf155b7e2d9729d3b07f83c146149f02", features = ["address20"] }
 mysten-network = { git = "https://github.com/MystenLabs/mysten-infra", rev = "ff5c1d69057fe93be658377462ca2875a57a0223" }

diff --git a/crates/sui-gateway/src/lib.rs b/crates/sui-gateway/src/lib.rs
@@ -1,10 +1,29 @@
 // Copyright (c) 2022, Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-pub mod api;
-pub mod bcs_api;
+use crate::config::GatewayConfig;
+use anyhow::anyhow;
+use std::path::Path;
+use std::sync::Arc;
+use sui_config::PersistedConfig;
+use sui_core::gateway_state::{GatewayClient, GatewayState};
+
 pub mod config;
-pub mod json_rpc;
-pub mod read_api;
-pub mod rpc_gateway;
 pub mod rpc_gateway_client;
+
+pub fn create_client(config_path: &Path) -> Result<GatewayClient, anyhow::Error> {
+    let config: GatewayConfig = PersistedConfig::read(config_path).map_err(|e| {
+        anyhow!(
+            "Failed to read config file at {:?}: {}. Have you run `sui genesis` first?",
+            config_path,
+            e
+        )
+    })?;
+    let committee = config.make_committee();
+    let authority_clients = config.make_authority_clients();
+    Ok(Arc::new(GatewayState::new(
+        config.db_folder_path,
+        committee,
+        authority_clients,
+    )?))
+}