extract quic-definitions crate

anza-xyz · Oct 11, 2024 · bd2b0e0 · bd2b0e0
1 parent ddf0adb
commit bd2b0e0
Show file tree

Hide file tree

Showing 7 changed files with 48 additions and 3 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -125,6 +125,7 @@ members = [
     "sdk/program-option",
     "sdk/program-pack",
     "sdk/pubkey",
+    "sdk/quic-definitions",
     "sdk/rent",
     "sdk/seed-derivable",
     "sdk/seed-phrase",
@@ -453,6 +454,7 @@ solana-program-test = { path = "program-test", version = "=2.1.0" }
 solana-pubkey = { path = "sdk/pubkey", version = "=2.1.0", default-features = false }
 solana-pubsub-client = { path = "pubsub-client", version = "=2.1.0" }
 solana-quic-client = { path = "quic-client", version = "=2.1.0" }
+solana-quic-definitions = { path = "sdk/quic-definitions", version = "=2.1.0" }
 solana-rayon-threadlimit = { path = "rayon-threadlimit", version = "=2.1.0" }
 solana-remote-wallet = { path = "remote-wallet", version = "=2.1.0", default-features = false }
 solana-rent = { path = "sdk/rent", version = "=2.1.0", default-features = false }

diff --git a/programs/sbf/Cargo.lock b/programs/sbf/Cargo.lock
diff --git a/sdk/Cargo.toml b/sdk/Cargo.toml
@@ -100,6 +100,7 @@ solana-frozen-abi-macro = { workspace = true, optional = true, features = [
 solana-presigner = { workspace = true, optional = true }
 solana-program = { workspace = true }
 solana-program-memory = { workspace = true }
+solana-quic-definitions = { workspace = true }
 solana-sanitize = { workspace = true }
 solana-sdk-macro = { workspace = true }
 solana-secp256k1-recover = { workspace = true }

diff --git a/sdk/quic-definitions/Cargo.toml b/sdk/quic-definitions/Cargo.toml
@@ -0,0 +1,19 @@
+[package]
+name = "solana-quic-definitions"
+description = "Definitions related to Solana over QUIC."
+documentation = "https://docs.rs/solana-quic-definitions"
+version = { workspace = true }
+authors = { workspace = true }
+repository = { workspace = true }
+homepage = { workspace = true }
+license = { workspace = true }
+edition = { workspace = true }
+
+[dependencies]
+solana-signer = { workspace = true, features = ["keypair"] }
+
+[package.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]
+
+[lints]
+workspace = true
diff --git a/sdk/src/quic.rs → sdk/quic-definitions/src/lib.rs b/sdk/src/quic.rs → sdk/quic-definitions/src/lib.rs
@@ -1,6 +1,5 @@
-#![cfg(feature = "full")]
 //! Definitions related to Solana over QUIC.
-use {crate::signer::keypair::Keypair, std::time::Duration};
+use {solana_signer::keypair::Keypair, std::time::Duration};
 
 pub const QUIC_PORT_OFFSET: u16 = 6;
 // Empirically found max number of concurrent streams
@@ -27,14 +26,20 @@ pub const QUIC_CONNECTION_HANDSHAKE_TIMEOUT: Duration = Duration::from_secs(60);
 
 /// The receive window for QUIC connection from unstaked nodes is
 /// set to this ratio times [`solana_sdk::packet::PACKET_DATA_SIZE`]
+///
+/// [`solana_sdk::packet::PACKET_DATA_SIZE`]: https://docs.rs/solana-sdk/latest/solana_sdk/packet/constant.PACKET_DATA_SIZE.html
 pub const QUIC_UNSTAKED_RECEIVE_WINDOW_RATIO: u64 = 128;
 
 /// The receive window for QUIC connection from minimum staked nodes is
 /// set to this ratio times [`solana_sdk::packet::PACKET_DATA_SIZE`]
+///
+/// [`solana_sdk::packet::PACKET_DATA_SIZE`]: https://docs.rs/solana-sdk/latest/solana_sdk/packet/constant.PACKET_DATA_SIZE.html
 pub const QUIC_MIN_STAKED_RECEIVE_WINDOW_RATIO: u64 = 128;
 
 /// The receive window for QUIC connection from maximum staked nodes is
 /// set to this ratio times [`solana_sdk::packet::PACKET_DATA_SIZE`]
+///
+/// [`solana_sdk::packet::PACKET_DATA_SIZE`]: https://docs.rs/solana-sdk/latest/solana_sdk/packet/constant.PACKET_DATA_SIZE.html
 pub const QUIC_MAX_STAKED_RECEIVE_WINDOW_RATIO: u64 = 512;
 
 pub trait NotifyKeyUpdate {

diff --git a/sdk/src/lib.rs b/sdk/src/lib.rs
@@ -87,7 +87,6 @@ pub mod poh_config;
 pub mod precompiles;
 pub mod program_utils;
 pub mod pubkey;
-pub mod quic;
 pub mod rent_collector;
 pub mod rent_debits;
 pub mod reserved_account_keys;
@@ -118,6 +117,9 @@ pub use solana_derivation_path as derivation_path;
 pub use solana_feature_set as feature_set;
 #[deprecated(since = "2.1.0", note = "Use `solana-program-memory` crate instead")]
 pub use solana_program_memory as program_memory;
+#[cfg(feature = "full")]
+#[deprecated(since = "2.1.0", note = "Use `solana-quic-definitions` crate instead")]
+pub use solana_quic_definitions as quic;
 #[deprecated(since = "2.1.0", note = "Use `solana-sanitize` crate instead")]
 pub use solana_sanitize as sanitize;
 /// Same as `declare_id` except report that this id has been deprecated.