feat: create soroban-rpc crate (#21)

* feat: create soroban-rpc crate * chore: add doc strings
stellar · Jan 27, 2024 · d1e5709 · d1e5709
1 parent 2af47af
commit d1e5709
Show file tree

Hide file tree

Showing 12 changed files with 642 additions and 265 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -69,6 +69,10 @@ rev = "e6c2c900ab82b5f6eec48f69cb2cb519e19819cb"
 version = "20.2.0"
 path = "cmd/soroban-cli"
 
+[workspace.dependencies.soroban-rpc]
+version = "20.2.0"
+path = "cmd/crates/soroban-rpc"
+
 [workspace.dependencies.stellar-xdr]
 version = "=20.0.2"
 default-features = true

diff --git a/cmd/crates/soroban-rpc/Cargo.toml b/cmd/crates/soroban-rpc/Cargo.toml
@@ -0,0 +1,59 @@
+[package]
+name = "soroban-rpc"
+description = "Soroban RPC client for rust"
+homepage = "https://github.com/stellar/soroban-tools"
+repository = "https://github.com/stellar/soroban-tools"
+authors = ["Stellar Development Foundation <info@stellar.org>"]
+license = "Apache-2.0"
+readme = "README.md"
+version.workspace = true
+edition = "2021"
+rust-version = "1.70"
+autobins = false
+
+
+[lib]
+crate-type = ["rlib"]
+
+
+[dependencies]
+soroban-sdk = { workspace = true }
+soroban-spec-tools = { workspace = true }
+
+soroban-env-host = { workspace = true }
+stellar-strkey = { workspace = true }
+stellar-xdr = { workspace = true, features = ["curr", "std", "serde"] }
+soroban-spec = { workspace = true }
+
+
+termcolor = { workspace = true }
+termcolor_output = { workspace = true }
+clap = { workspace = true }
+
+serde_json = { workspace = true }
+serde-aux = { workspace = true }
+itertools = { workspace = true }
+ethnum = { workspace = true }
+hex = { workspace = true }
+wasmparser = { workspace = true }
+base64 = { workspace = true }
+thiserror = { workspace = true }
+serde = { workspace = true }
+tokio = { workspace = true }
+sha2 = { workspace = true }
+ed25519-dalek = { workspace = true }
+tracing = { workspace = true }
+
+
+# networking
+jsonrpsee-http-client = { workspace = true }
+jsonrpsee-core = { workspace = true }
+http = { workspace = true }
+
+# soroban-ledger-snapshot = { workspace = true }
+# soroban-sdk = { workspace = true }
+# sep5 = { workspace = true }
+
+
+[dev-dependencies]
+which = { workspace = true }
diff --git a/cmd/crates/soroban-rpc/README.md b/cmd/crates/soroban-rpc/README.md
@@ -0,0 +1,3 @@
+# soroban-rpc
+
+Tools and utilities for soroban rpc.
diff --git a/...-cli/src/rpc/fixtures/event_response.json → ...oban-rpc/src/fixtures/event_response.json b/...-cli/src/rpc/fixtures/event_response.json → ...oban-rpc/src/fixtures/event_response.json
diff --git a/cmd/soroban-cli/src/rpc/mod.rs → cmd/crates/soroban-rpc/src/lib.rs b/cmd/soroban-cli/src/rpc/mod.rs → cmd/crates/soroban-rpc/src/lib.rs
@@ -31,9 +31,8 @@ mod txn;
 
 pub use txn::*;
 
-use soroban_spec_tools::contract::Spec as Contract;
+use soroban_spec_tools::contract;
 
-use crate::utils::contract_spec as contract;
 const VERSION: Option<&str> = option_env!("CARGO_PKG_VERSION");
 
 pub type LogEvents = fn(
@@ -179,6 +178,8 @@ impl TryInto<GetTransactionResponse> for GetTransactionResponseRaw {
 }
 
 impl GetTransactionResponse {
+    ///
+    /// # Errors
     pub fn return_value(&self) -> Result<xdr::ScVal, Error> {
         if let Some(xdr::TransactionMeta::V3(xdr::TransactionMetaV3 {
             soroban_meta: Some(xdr::SorobanTransactionMeta { return_value, .. }),
@@ -191,6 +192,8 @@ impl GetTransactionResponse {
         }
     }
 
+    ///
+    /// # Errors
     pub fn events(&self) -> Result<Vec<DiagnosticEvent>, Error> {
         if let Some(meta) = self.result_meta.as_ref() {
             Ok(extract_events(meta))
@@ -199,6 +202,8 @@ impl GetTransactionResponse {
         }
     }
 
+    ///
+    /// # Errors
     pub fn contract_events(&self) -> Result<Vec<DiagnosticEvent>, Error> {
         Ok(self
             .events()?
@@ -311,6 +316,8 @@ pub struct SimulateTransactionResponse {
 }
 
 impl SimulateTransactionResponse {
+    ///
+    /// # Errors
     pub fn results(&self) -> Result<Vec<SimulateHostFunctionResult>, Error> {
         self.results
             .iter()
@@ -332,13 +339,17 @@ impl SimulateTransactionResponse {
             .collect()
     }
 
+    ///
+    /// # Errors
     pub fn events(&self) -> Result<Vec<DiagnosticEvent>, Error> {
         self.events
             .iter()
             .map(|e| Ok(DiagnosticEvent::from_xdr_base64(e, Limits::none())?))
             .collect()
     }
 
+    ///
+    /// # Errors
     pub fn transaction_data(&self) -> Result<SorobanTransactionData, Error> {
         Ok(SorobanTransactionData::from_xdr_base64(
             &self.transaction_data,
@@ -435,10 +446,13 @@ impl Display for Event {
 }
 
 impl Event {
+    ///
+    /// # Errors
     pub fn parse_cursor(&self) -> Result<(u64, i32), Error> {
         parse_cursor(&self.id)
     }
-
+    ///
+    /// # Errors
     pub fn pretty_print(&self) -> Result<(), Box<dyn std::error::Error>> {
         let mut stdout = StandardStream::stdout(ColorChoice::Auto);
         if !stdout.supports_color() {
@@ -540,6 +554,8 @@ pub struct Client {
 }
 
 impl Client {
+    ///
+    /// # Errors
     pub fn new(base_url: &str) -> Result<Self, Error> {
         // Add the port to the base URL if there is no port explicitly included
         // in the URL and the scheme allows us to infer a default port.
@@ -570,6 +586,8 @@ impl Client {
         })
     }
 
+    ///
+    /// # Errors
     fn client(&self) -> Result<HttpClient, Error> {
         let url = self.base_url.clone();
         let mut headers = HeaderMap::new();
@@ -581,6 +599,8 @@ impl Client {
             .build(url)?)
     }
 
+    ///
+    /// # Errors
     pub async fn friendbot_url(&self) -> Result<String, Error> {
         let network = self.get_network().await?;
         tracing::trace!("{network:#?}");
@@ -591,7 +611,8 @@ impl Client {
             )
         })
     }
-
+    ///
+    /// # Errors
     pub async fn verify_network_passphrase(&self, expected: Option<&str>) -> Result<String, Error> {
         let server = self.get_network().await?.passphrase;
         if let Some(expected) = expected {
@@ -605,11 +626,15 @@ impl Client {
         Ok(server)
     }
 
+    ///
+    /// # Errors
     pub async fn get_network(&self) -> Result<GetNetworkResponse, Error> {
         tracing::trace!("Getting network");
         Ok(self.client()?.request("getNetwork", rpc_params![]).await?)
     }
 
+    ///
+    /// # Errors
     pub async fn get_latest_ledger(&self) -> Result<GetLatestLedgerResponse, Error> {
         tracing::trace!("Getting latest ledger");
         Ok(self
@@ -618,6 +643,8 @@ impl Client {
             .await?)
     }
 
+    ///
+    /// # Errors
     pub async fn get_account(&self, address: &str) -> Result<AccountEntry, Error> {
         tracing::trace!("Getting address {}", address);
         let key = LedgerKey::Account(LedgerKeyAccount {
@@ -649,6 +676,8 @@ soroban config identity fund {address} --helper-url <url>"#
         }
     }
 
+    ///
+    /// # Errors
     pub async fn send_transaction(
         &self,
         tx: &TransactionEnvelope,
@@ -719,6 +748,8 @@ soroban config identity fund {address} --helper-url <url>"#
         }
     }
 
+    ///
+    /// # Errors
     pub async fn simulate_transaction(
         &self,
         tx: &TransactionEnvelope,
@@ -741,6 +772,8 @@ soroban config identity fund {address} --helper-url <url>"#
         }
     }
 
+    ///
+    /// # Errors
     pub async fn send_assembled_transaction(
         &self,
         txn: txn::Assembled,
@@ -762,6 +795,8 @@ soroban config identity fund {address} --helper-url <url>"#
         self.send_transaction(&tx).await
     }
 
+    ///
+    /// # Errors
     pub async fn prepare_and_send_transaction(
         &self,
         tx_without_preflight: &Transaction,
@@ -783,20 +818,26 @@ soroban config identity fund {address} --helper-url <url>"#
         .await
     }
 
+    ///
+    /// # Errors
     pub async fn create_assembled_transaction(
         &self,
         txn: &Transaction,
     ) -> Result<txn::Assembled, Error> {
         txn::Assembled::new(txn, self).await
     }
 
+    ///
+    /// # Errors
     pub async fn get_transaction(&self, tx_id: &str) -> Result<GetTransactionResponseRaw, Error> {
         Ok(self
             .client()?
             .request("getTransaction", rpc_params![tx_id])
             .await?)
     }
 
+    ///
+    /// # Errors
     pub async fn get_ledger_entries(
         &self,
         keys: &[LedgerKey],
@@ -807,14 +848,16 @@ soroban config identity fund {address} --helper-url <url>"#
             if base64_result.is_err() {
                 return Err(Error::Xdr(XdrError::Invalid));
             }
-            base64_keys.push(k.to_xdr_base64(Limits::none()).unwrap());
+            base64_keys.push(k.to_xdr_base64(Limits::none())?);
         }
         Ok(self
             .client()?
             .request("getLedgerEntries", rpc_params![base64_keys])
             .await?)
     }
 
+    ///
+    /// # Errors
     pub async fn get_full_ledger_entries(
         &self,
         ledger_keys: &[LedgerKey],
@@ -855,7 +898,8 @@ soroban config identity fund {address} --helper-url <url>"#
             latest_ledger,
         })
     }
-
+    ///
+    /// # Errors
     pub async fn get_events(
         &self,
         start: EventStart,
@@ -895,6 +939,8 @@ soroban config identity fund {address} --helper-url <url>"#
         Ok(self.client()?.request("getEvents", oparams).await?)
     }
 
+    ///
+    /// # Errors
     pub async fn get_contract_data(
         &self,
         contract_id: &[u8; 32],
@@ -918,6 +964,8 @@ soroban config identity fund {address} --helper-url <url>"#
         }
     }
 
+    ///
+    /// # Errors
     pub async fn get_remote_wasm(&self, contract_id: &[u8; 32]) -> Result<Vec<u8>, Error> {
         match self.get_contract_data(contract_id).await? {
             xdr::ContractDataEntry {
@@ -932,6 +980,8 @@ soroban config identity fund {address} --helper-url <url>"#
         }
     }
 
+    ///
+    /// # Errors
     pub async fn get_remote_wasm_from_hash(&self, hash: xdr::Hash) -> Result<Vec<u8>, Error> {
         let code_key = LedgerKey::ContractCode(xdr::LedgerKeyContractCode { hash: hash.clone() });
         let contract_data = self.get_ledger_entries(&[code_key]).await?;
@@ -948,7 +998,8 @@ soroban config identity fund {address} --helper-url <url>"#
             scval => Err(Error::UnexpectedContractCodeDataType(scval)),
         }
     }
-
+    ///
+    /// # Errors
     pub async fn get_remote_contract_spec(
         &self,
         contract_id: &[u8; 32],
@@ -958,9 +1009,11 @@ soroban config identity fund {address} --helper-url <url>"#
             xdr::ScVal::ContractInstance(xdr::ScContractInstance {
                 executable: xdr::ContractExecutable::Wasm(hash),
                 ..
-            }) => Ok(Contract::new(&self.get_remote_wasm_from_hash(hash).await?)
-                .map_err(Error::CouldNotParseContractSpec)?
-                .spec),
+            }) => Ok(
+                contract::Spec::new(&self.get_remote_wasm_from_hash(hash).await?)
+                    .map_err(Error::CouldNotParseContractSpec)?
+                    .spec,
+            ),
             xdr::ScVal::ContractInstance(xdr::ScContractInstance {
                 executable: xdr::ContractExecutable::StellarAsset,
                 ..
@@ -997,7 +1050,7 @@ fn extract_events(tx_meta: &TransactionMeta) -> Vec<DiagnosticEvent> {
     }
 }
 
-pub fn parse_cursor(c: &str) -> Result<(u64, i32), Error> {
+pub(crate) fn parse_cursor(c: &str) -> Result<(u64, i32), Error> {
     let (toid_part, event_index) = c.split('-').collect_tuple().ok_or(Error::InvalidCursor)?;
     let toid_part: u64 = toid_part.parse().map_err(|_| Error::InvalidCursor)?;
     let start_index: i32 = event_index.parse().map_err(|_| Error::InvalidCursor)?;

diff --git a/cmd/soroban-cli/src/rpc/log.rs → cmd/crates/soroban-rpc/src/log.rs b/cmd/soroban-cli/src/rpc/log.rs → cmd/crates/soroban-rpc/src/log.rs
diff --git a/...oban-cli/src/rpc/log/diagnostic_events.rs → .../soroban-rpc/src/log/diagnostic_events.rs b/...oban-cli/src/rpc/log/diagnostic_events.rs → .../soroban-rpc/src/log/diagnostic_events.rs
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# soroban-rpc

		Tools and utilities for soroban rpc.