Skip to content

Simplify hazmat feature docs #1643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leighmcculloch merged 1 commit into from
Dec 15, 2025
Merged

Simplify hazmat feature docs #1643

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions soroban-sdk/src/address.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,10 +394,7 @@ impl Address {
/// custom Ed25519 signature verification as a form of authentication
/// because the master key may not be configured the signer of the account.
#[cfg(any(test, feature = "hazmat-address"))]
#[cfg_attr(
feature = "docs",
doc(cfg(any(feature = "hazmat", feature = "hazmat-address")))
)]
#[cfg_attr(feature = "docs", doc(cfg(feature = "hazmat-address")))]
pub fn to_payload(&self) -> Option<AddressPayload> {
AddressPayload::from_address(self)
}
Expand All @@ -414,10 +411,7 @@ impl Address {
/// custom Ed25519 signature verification as a form of authentication
/// because the master key may not be configured the signer of the account.
#[cfg(any(test, feature = "hazmat-address"))]
#[cfg_attr(
feature = "docs",
doc(cfg(any(feature = "hazmat", feature = "hazmat-address")))
)]
#[cfg_attr(feature = "docs", doc(cfg(feature = "hazmat-address")))]
pub fn from_payload(env: &Env, payload: AddressPayload) -> Address {
payload.to_address(env)
}
Expand Down
5 changes: 1 addition & 4 deletions soroban-sdk/src/address_payload.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
#![cfg(any(test, feature = "hazmat-address"))]
#![cfg_attr(
feature = "docs",
doc(cfg(any(feature = "hazmat", feature = "hazmat-address")))
)]
#![cfg_attr(feature = "docs", doc(cfg(feature = "hazmat-address")))]

//! Address payload extraction and construction.
//!
Expand Down
5 changes: 1 addition & 4 deletions soroban-sdk/src/crypto.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,10 +191,7 @@ impl Crypto {
/// incorrectly can introduce security vulnerabilities. Please use [Crypto] if
/// possible.
#[cfg_attr(any(test, feature = "hazmat-crypto"), visibility::make(pub))]
#[cfg_attr(
feature = "docs",
doc(cfg(any(feature = "hazmat", feature = "hazmat-crypto")))
)]
#[cfg_attr(feature = "docs", doc(cfg(feature = "hazmat-crypto")))]
pub(crate) struct CryptoHazmat {
env: Env,
}
Expand Down
5 changes: 1 addition & 4 deletions soroban-sdk/src/env.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,10 +334,7 @@ impl Env {
/// incorrectly can introduce security vulnerabilities. Use [Crypto] if
/// possible.
#[cfg_attr(any(test, feature = "hazmat-crypto"), visibility::make(pub))]
#[cfg_attr(
feature = "docs",
doc(cfg(any(feature = "hazmat", feature = "hazmat-crypto")))
)]
#[cfg_attr(feature = "docs", doc(cfg(feature = "hazmat-crypto")))]
#[inline(always)]
pub(crate) fn crypto_hazmat(&self) -> crate::crypto::CryptoHazmat {
crate::crypto::CryptoHazmat::new(self)
Expand Down
Loading