feature-gate unchecked constructors in core

astriaorg · Sep 30, 2024 · d16b193 · d16b193
1 parent 132bddc
commit d16b193
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 1 deletion.
diff --git a/crates/astria-core/Cargo.toml b/crates/astria-core/Cargo.toml
@@ -55,6 +55,10 @@ server = ["dep:tonic"]
 test-utils = []
 base64-serde = ["dep:base64-serde"]
 brotli = ["dep:brotli"]
+# When enabled, this adds constructors for some types that skip the normal constructor validity
+# checks. It supports the case where the inputs are already deemed valid, e.g. having read them from
+# local storage.
+unchecked-constructors = []
 
 [dev-dependencies]
 astria-core = { path = ".", features = ["serde"] }

diff --git a/crates/astria-core/src/primitive/v1/asset/denom.rs b/crates/astria-core/src/primitive/v1/asset/denom.rs
@@ -303,6 +303,7 @@ impl TracePrefixed {
 
     /// This should only be used where the inputs have been provided by a trusted entity, e.g. read
     /// from our own state store.
+    #[cfg(feature = "unchecked-constructors")]
     #[doc(hidden)]
     #[must_use]
     pub fn unchecked_from_parts<I: IntoIterator<Item = (String, String)>>(

diff --git a/crates/astria-core/src/primitive/v1/mod.rs b/crates/astria-core/src/primitive/v1/mod.rs
@@ -573,6 +573,7 @@ impl Address<Bech32m> {
 
     /// This should only be used where the inputs have been provided by a trusted entity, e.g. read
     /// from our own state store.
+    #[cfg(feature = "unchecked-constructors")]
     #[doc(hidden)]
     #[must_use]
     pub fn unchecked_from_parts(bytes: [u8; ADDRESS_LEN], prefix: &str) -> Self {
@@ -889,6 +890,7 @@ mod tests {
         let _ = address.into_raw();
     }
 
+    #[cfg(feature = "unchecked-constructors")]
     #[test]
     fn address_to_unchecked_roundtrip() {
         let bytes = [42u8; ADDRESS_LEN];

diff --git a/crates/astria-core/src/sequencerblock/v1alpha1/block.rs b/crates/astria-core/src/sequencerblock/v1alpha1/block.rs
@@ -176,6 +176,7 @@ impl RollupTransactions {
 
     /// This should only be used where `parts` has been provided by a trusted entity, e.g. read from
     /// our own state store.
+    #[cfg(feature = "unchecked-constructors")]
     #[doc(hidden)]
     #[must_use]
     pub fn unchecked_from_parts(parts: RollupTransactionsParts) -> Self {
@@ -502,6 +503,7 @@ impl SequencerBlockHeader {
 
     /// This should only be used where `parts` has been provided by a trusted entity, e.g. read from
     /// our own state store.
+    #[cfg(feature = "unchecked-constructors")]
     #[doc(hidden)]
     #[must_use]
     pub fn unchecked_from_parts(parts: SequencerBlockHeaderParts) -> Self {
@@ -969,6 +971,7 @@ impl SequencerBlock {
 
     /// This should only be used where `parts` has been provided by a trusted entity, e.g. read from
     /// our own state store.
+    #[cfg(feature = "unchecked-constructors")]
     #[doc(hidden)]
     #[must_use]
     pub fn unchecked_from_parts(parts: SequencerBlockParts) -> Self {

diff --git a/crates/astria-sequencer/Cargo.toml b/crates/astria-sequencer/Cargo.toml
@@ -15,7 +15,11 @@ name = "astria-sequencer"
 benchmark = ["divan"]
 
 [dependencies]
-astria-core = { path = "../astria-core", features = ["server", "serde"] }
+astria-core = { path = "../astria-core", features = [
+  "server",
+  "serde",
+  "unchecked-constructors",
+] }
 astria-build-info = { path = "../astria-build-info", features = ["runtime"] }
 
 # The "anyhow" feature is only included because it is necessary for the implementation of