Skip to content

fix: correct line number reporting for missing CHECK errors on duplic… #3918

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

Closed
ayushmishra2005 wants to merge 3 commits into from
Closed

fix: correct line number reporting for missing CHECK errors on duplic… #3918

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fc83a77
fix: correct line number reporting for missing CHECK errors on duplic…
ayushmishra2005 Sep 7, 2025
9a30a81
fix formatting
ayushmishra2005 Sep 7, 2025
3423c26
addressred comments
ayushmishra2005 Oct 26, 2025
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
105 changes: 55 additions & 50 deletions lang/syn/src/parser/context.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,34 +52,68 @@ impl CrateContext {
pub fn safety_checks(&self) -> Result<()> {
// Check all structs for unsafe field types, i.e. AccountInfo and UncheckedAccount.
for ctx in self.modules.values() {
for unsafe_field in ctx.unsafe_struct_fields() {
// Check if unsafe field type has been documented with a /// SAFETY: doc string.
let is_documented = unsafe_field.attrs.iter().any(|attr| {
attr.tokens.clone().into_iter().any(|token| match token {
// Check for doc comments containing CHECK
proc_macro2::TokenTree::Literal(s) => s.to_string().contains("CHECK"),
_ => false,
})
for struct_item in ctx.structs() {
// Only check structs with #[derive(Accounts)]
let has_accounts_derive = struct_item.attrs.iter().any(|attr| {
match attr.parse_meta() {
Ok(syn::Meta::List(syn::MetaList{path, nested, ..})) => {
path.is_ident("derive") && nested.iter().any(|nested| {
matches!(nested, syn::NestedMeta::Meta(syn::Meta::Path(path)) if path.is_ident("Accounts"))
})
}
_ => false
}
});
if !is_documented {
let ident = unsafe_field.ident.as_ref().unwrap();
let span = ident.span();
// Error if undocumented.
return Err(anyhow!(
r#"

if has_accounts_derive {
for field in &struct_item.fields {
// Check if this field is an unsafe type
let is_unsafe_type = match &field.ty {
syn::Type::Path(syn::TypePath {
path: syn::Path { segments, .. },
..
}) => {
segments.len() == 1 && segments[0].ident == "UncheckedAccount"
|| segments[0].ident == "AccountInfo"
}
_ => false,
};

if is_unsafe_type {
// Check if unsafe field type has been documented with a /// CHECK: doc string.
let is_documented = field.attrs.iter().any(|attr| {
attr.tokens.clone().into_iter().any(|token| match token {
// Check for doc comments containing CHECK
proc_macro2::TokenTree::Literal(s) => {
s.to_string().contains("CHECK")
}
_ => false,
})
});

if !is_documented {
let ident = field.ident.as_ref().unwrap();
let span = ident.span();
// Error if undocumented.
return Err(anyhow!(
r#"
{}:{}:{}
Struct field "{}" is unsafe, but is not documented.
Struct field "{}" in struct "{}" is unsafe, but is not documented.
Please add a `/// CHECK:` doc comment explaining why no checks through types are necessary.
Alternatively, for reasons like quick prototyping, you may disable the safety checks
by using the `skip-lint` option.
See https://www.anchor-lang.com/docs/the-accounts-struct#safety-checks for more information.
"#,
ctx.file.canonicalize().unwrap().display(),
span.start().line,
span.start().column,
ident.to_string()
));
};
ctx.file.canonicalize().unwrap().display(),
span.start().line,
span.start().column,
ident.to_string(),
struct_item.ident.to_string()
));
}
}
}
}
}
}
Ok(())
Expand Down Expand Up @@ -221,35 +255,6 @@ impl ParsedModule {
})
}

fn unsafe_struct_fields(&self) -> impl Iterator<Item = &syn::Field> {
let accounts_filter = |item_struct: &&syn::ItemStruct| {
item_struct.attrs.iter().any(|attr| {
match attr.parse_meta() {
Ok(syn::Meta::List(syn::MetaList{path, nested, ..})) => {
path.is_ident("derive") && nested.iter().any(|nested| {
matches!(nested, syn::NestedMeta::Meta(syn::Meta::Path(path)) if path.is_ident("Accounts"))
})
}
_ => false
}
})
};

self.structs()
.filter(accounts_filter)
.flat_map(|s| &s.fields)
.filter(|f| match &f.ty {
syn::Type::Path(syn::TypePath {
path: syn::Path { segments, .. },
..
}) => {
segments.len() == 1 && segments[0].ident == "UncheckedAccount"
|| segments[0].ident == "AccountInfo"
}
_ => false,
})
}

fn enums(&self) -> impl Iterator<Item = &syn::ItemEnum> {
self.items.iter().filter_map(|i| match i {
syn::Item::Enum(item) => Some(item),
Expand Down
4 changes: 2 additions & 2 deletions tests/safety-checks/test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ echo "Building programs"
#
pushd programs/unchecked-account/
output=$(anchor build 2>&1 > /dev/null)
if ! [[ $output =~ "Struct field \"unchecked\" is unsafe" ]]; then
if ! [[ $output =~ "Struct field \"unchecked\" in struct \"Initialize\" is unsafe" ]]; then
echo "Error: expected /// CHECK error"
exit 1
fi
Expand All @@ -18,7 +18,7 @@ popd
#
pushd programs/account-info/
output=$(anchor build 2>&1 > /dev/null)
if ! [[ $output =~ "Struct field \"unchecked\" is unsafe" ]]; then
if ! [[ $output =~ "Struct field \"unchecked\" in struct \"Initialize\" is unsafe" ]]; then
echo "Error: expected /// CHECK error"
exit 1
fi
Expand Down