Skip to content
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

Remove unsafe code from macro expansions #818

Merged
merged 3 commits into from
Dec 6, 2024
Merged

Remove unsafe code from macro expansions #818

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
18a4387
Remove unsafe code from macro expansions
nbaksalyar Dec 4, 2024
4a8db85
chore: clean up
DaniPopes Dec 6, 2024
959b012
fix
DaniPopes Dec 6, 2024
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
8 changes: 4 additions & 4 deletions crates/sol-macro-expander/src/expand/contract.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,7 +488,7 @@ pub(super) fn expand(cx: &mut ExpCtxt<'_>, contract: &ItemContract) -> Result<To
#mod_descr_doc
#(#mod_attrs)*
#mod_iface_doc
#[allow(non_camel_case_types, non_snake_case, clippy::pub_underscore_fields, clippy::style)]
#[allow(non_camel_case_types, non_snake_case, clippy::pub_underscore_fields, clippy::style, clippy::empty_structs_with_brackets)]
pub mod #name {
use super::*;
use #alloy_sol_types as alloy_sol_types;
Expand Down Expand Up @@ -715,7 +715,7 @@ impl CallLikeExpander<'_> {
}

#[inline]
#[allow(unsafe_code, non_snake_case)]
#[allow(non_snake_case)]
fn abi_decode_raw(
selector: [u8; 4],
data: &[u8],
Expand All @@ -737,8 +737,8 @@ impl CallLikeExpander<'_> {
selector,
));
};
// SAFETY: `idx` is a valid index into `DECODE_SHIMS`.
(unsafe { DECODE_SHIMS.get_unchecked(idx) })(data, validate)
// `SELECTORS` and `DECODE_SHIMS` have the same length and are sorted in the same order.
DECODE_SHIMS[idx](data, validate)
}

#[inline]
Expand Down
35 changes: 15 additions & 20 deletions crates/sol-macro-expander/src/expand/enum.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ pub(super) fn expand(cx: &ExpCtxt<'_>, enumm: &ItemEnum) -> Result<TokenStream>
let uint8 = quote!(alloy_sol_types::sol_data::Uint<8>);
let uint8_st = quote!(<#uint8 as alloy_sol_types::SolType>);

let index_to_variant = variants.iter().enumerate().map(|(idx, variant)| {
let ident = &variant.ident;
let idx = idx as u8;
quote! { #idx => ::core::result::Result::Ok(Self::#ident), }
});

let doc = docs.then(|| mk_doc(format!("```solidity\n{enumm}\n```")));
let tokens = quote! {
#(#attrs)*
Expand Down Expand Up @@ -98,15 +104,13 @@ pub(super) fn expand(cx: &ExpCtxt<'_>, enumm: &ItemEnum) -> Result<TokenStream>
impl ::core::convert::TryFrom<u8> for #name {
type Error = alloy_sol_types::Error;

#[allow(unsafe_code)]
#[inline]
fn try_from(v: u8) -> alloy_sol_types::Result<Self> {
if v <= #max {
::core::result::Result::Ok(unsafe { ::core::mem::transmute(v) })
} else {
::core::result::Result::Err(alloy_sol_types::Error::InvalidEnumValue {
fn try_from(value: u8) -> alloy_sol_types::Result<Self> {
match value {
#(#index_to_variant)*
value => ::core::result::Result::Err(alloy_sol_types::Error::InvalidEnumValue {
name: #name_s,
value: v,
value,
max: #max,
})
}
Expand All @@ -127,7 +131,7 @@ pub(super) fn expand(cx: &ExpCtxt<'_>, enumm: &ItemEnum) -> Result<TokenStream>

#[inline]
fn stv_eip712_data_word(&self) -> alloy_sol_types::Word {
#uint8_st::eip712_data_word(self.as_u8())
#uint8_st::eip712_data_word(&(*self as u8))
}

#[inline]
Expand Down Expand Up @@ -170,33 +174,24 @@ pub(super) fn expand(cx: &ExpCtxt<'_>, enumm: &ItemEnum) -> Result<TokenStream>
impl alloy_sol_types::EventTopic for #name {
#[inline]
fn topic_preimage_length(rust: &Self::RustType) -> usize {
<#uint8 as alloy_sol_types::EventTopic>::topic_preimage_length(rust.as_u8())
<#uint8 as alloy_sol_types::EventTopic>::topic_preimage_length(&(*rust as u8))
}

#[inline]
fn encode_topic_preimage(rust: &Self::RustType, out: &mut alloy_sol_types::private::Vec<u8>) {
<#uint8 as alloy_sol_types::EventTopic>::encode_topic_preimage(rust.as_u8(), out);
<#uint8 as alloy_sol_types::EventTopic>::encode_topic_preimage(&(*rust as u8), out);
}

#[inline]
fn encode_topic(rust: &Self::RustType) -> alloy_sol_types::abi::token::WordToken {
<#uint8 as alloy_sol_types::EventTopic>::encode_topic(rust.as_u8())
<#uint8 as alloy_sol_types::EventTopic>::encode_topic(&(*rust as u8))
}
}

#[automatically_derived]
impl alloy_sol_types::SolEnum for #name {
const COUNT: usize = #count;
}

#[automatically_derived]
impl #name {
#[allow(unsafe_code, clippy::inline_always)]
#[inline(always)]
fn as_u8(&self) -> &u8 {
unsafe { &*(self as *const Self as *const u8) }
}
}
};
};
Ok(tokens)
Expand Down
Loading