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

lang: Log ix names by default, is feature that can be turned off #1057

Merged
merged 5 commits into from
Nov 24, 2021
Merged

lang: Log ix names by default, is feature that can be turned off #1057

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ac3bc29
lang: Log ix names by default, is feature that can be turned off
paul-schaaf Nov 24, 2021
0721c03
lang: rename to no-log-ix-name and make it a reverse feature (turn of…
paul-schaaf Nov 24, 2021
20c2c35
cli: add no-log-ix-name feature to Cargo.toml template
paul-schaaf Nov 24, 2021
3c8c406
lang: remove superfluous format! call during runtime
paul-schaaf Nov 24, 2021
86053ee
docs: add changelog entry
paul-schaaf Nov 24, 2021
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ incremented for features.
### Features

* lang: Add `ErrorCode::AccountNotInitialized` error to separate the situation when the account has the wrong owner from when it does not exist (#[1024](https://github.com/project-serum/anchor/pull/1024))
* lang: Called instructions now log their name by default. This can be turned off with the `no-log-ix-name` flag ([#1057](https://github.com/project-serum/anchor/pull/1057))

## [0.18.2] - 2021-11-14

Expand Down
1 change: 1 addition & 0 deletions cli/src/template.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ name = "{1}"
[features]
no-entrypoint = []
no-idl = []
no-log-ix-name = []
cpi = ["no-entrypoint"]
default = []

Expand Down
42 changes: 41 additions & 1 deletion lang/syn/src/codegen/program/handlers.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,9 @@ pub fn generate(program: &Program) -> proc_macro2::TokenStream {
accounts: &mut anchor_lang::idl::IdlCreateAccounts,
data_len: u64,
) -> ProgramResult {
#[cfg(not(feature = "no-log-ix-name"))]
anchor_lang::prelude::msg!("Instruction: IdlCreateAccount");

if program_id != accounts.program.key {
return Err(anchor_lang::__private::ErrorCode::IdlInstructionInvalidProgram.into());
}
Expand Down Expand Up @@ -132,6 +135,9 @@ pub fn generate(program: &Program) -> proc_macro2::TokenStream {
program_id: &Pubkey,
accounts: &mut anchor_lang::idl::IdlCreateBuffer,
) -> ProgramResult {
#[cfg(not(feature = "no-log-ix-name"))]
anchor_lang::prelude::msg!("Instruction: IdlCreateBuffer");

let mut buffer = &mut accounts.buffer;
buffer.authority = *accounts.authority.key;
Ok(())
Expand All @@ -143,6 +149,9 @@ pub fn generate(program: &Program) -> proc_macro2::TokenStream {
accounts: &mut anchor_lang::idl::IdlAccounts,
idl_data: Vec<u8>,
) -> ProgramResult {
#[cfg(not(feature = "no-log-ix-name"))]
anchor_lang::prelude::msg!("Instruction: IdlWrite");

let mut idl = &mut accounts.idl;
idl.data.extend(idl_data);
Ok(())
Expand All @@ -154,6 +163,9 @@ pub fn generate(program: &Program) -> proc_macro2::TokenStream {
accounts: &mut anchor_lang::idl::IdlAccounts,
new_authority: Pubkey,
) -> ProgramResult {
#[cfg(not(feature = "no-log-ix-name"))]
anchor_lang::prelude::msg!("Instruction: IdlSetAuthority");

accounts.idl.authority = new_authority;
Ok(())
}
Expand All @@ -163,6 +175,9 @@ pub fn generate(program: &Program) -> proc_macro2::TokenStream {
program_id: &Pubkey,
accounts: &mut anchor_lang::idl::IdlSetBuffer,
) -> ProgramResult {
#[cfg(not(feature = "no-log-ix-name"))]
anchor_lang::prelude::msg!("Instruction: IdlSetBuffer");

accounts.idl.data = accounts.buffer.data.clone();
Ok(())
}
Expand All @@ -180,12 +195,16 @@ pub fn generate(program: &Program) -> proc_macro2::TokenStream {
let variant_arm = generate_ctor_variant(state);
let ix_name: proc_macro2::TokenStream =
generate_ctor_variant_name().parse().unwrap();
let ix_name_log = format!("Instruction: {}", ix_name);
if state.is_zero_copy {
quote! {
// One time state account initializer. Will faill on subsequent
// invocations.
#[inline(never)]
pub fn __ctor(program_id: &Pubkey, accounts: &[AccountInfo], ix_data: &[u8]) -> ProgramResult {
#[cfg(not(feature = "no-log-ix-name"))]
anchor_lang::prelude::msg!(#ix_name_log);

// Deserialize instruction data.
let ix = instruction::state::#ix_name::deserialize(&mut &ix_data[..])
.map_err(|_| anchor_lang::__private::ErrorCode::InstructionDidNotDeserialize)?;
Expand Down Expand Up @@ -257,6 +276,9 @@ pub fn generate(program: &Program) -> proc_macro2::TokenStream {
// invocations.
#[inline(never)]
pub fn __ctor(program_id: &Pubkey, accounts: &[AccountInfo], ix_data: &[u8]) -> ProgramResult {
#[cfg(not(feature = "no-log-ix-name"))]
anchor_lang::prelude::msg!(#ix_name_log);

// Deserialize instruction data.
let ix = instruction::state::#ix_name::deserialize(&mut &ix_data[..])
.map_err(|_| anchor_lang::__private::ErrorCode::InstructionDidNotDeserialize)?;
Expand Down Expand Up @@ -347,6 +369,7 @@ pub fn generate(program: &Program) -> proc_macro2::TokenStream {
let variant_arm =
generate_ix_variant(ix.raw_method.sig.ident.to_string(), &ix.args);
let ix_name = generate_ix_variant_name(ix.raw_method.sig.ident.to_string());
let ix_name_log = format!("Instruction: {}", ix_name);

if state.is_zero_copy {
quote! {
Expand All @@ -356,6 +379,9 @@ pub fn generate(program: &Program) -> proc_macro2::TokenStream {
accounts: &[AccountInfo],
ix_data: &[u8],
) -> ProgramResult {
#[cfg(not(feature = "no-log-ix-name"))]
anchor_lang::prelude::msg!(#ix_name_log);

// Deserialize instruction.
let ix = instruction::state::#ix_name::deserialize(&mut &ix_data[..])
.map_err(|_| anchor_lang::__private::ErrorCode::InstructionDidNotDeserialize)?;
Expand Down Expand Up @@ -399,6 +425,9 @@ pub fn generate(program: &Program) -> proc_macro2::TokenStream {
accounts: &[AccountInfo],
ix_data: &[u8],
) -> ProgramResult {
#[cfg(not(feature = "no-log-ix-name"))]
anchor_lang::prelude::msg!(#ix_name_log);

// Deserialize instruction.
let ix = instruction::state::#ix_name::deserialize(&mut &ix_data[..])
.map_err(|_| anchor_lang::__private::ErrorCode::InstructionDidNotDeserialize)?;
Expand Down Expand Up @@ -472,6 +501,8 @@ pub fn generate(program: &Program) -> proc_macro2::TokenStream {
let ix_method_name = &ix.raw_method.sig.ident;
let state_ty: proc_macro2::TokenStream = state.name.parse().unwrap();
let anchor_ident = &ix.anchor_ident;
let ix_name = generate_ix_variant_name(ix.raw_method.sig.ident.to_string());
let ix_name_log = format!("Instruction: {}", ix_name);

let raw_args: Vec<&syn::PatType> = ix
.args
Expand Down Expand Up @@ -511,6 +542,9 @@ pub fn generate(program: &Program) -> proc_macro2::TokenStream {
accounts: &[AccountInfo],
ix_data: &[u8],
) -> ProgramResult {
#[cfg(not(feature = "no-log-ix-name"))]
anchor_lang::prelude::msg!(#ix_name_log);

// Deserialize instruction.
#deserialize_instruction

Expand Down Expand Up @@ -555,6 +589,9 @@ pub fn generate(program: &Program) -> proc_macro2::TokenStream {
accounts: &[AccountInfo],
ix_data: &[u8],
) -> ProgramResult {
#[cfg(not(feature = "no-log-ix-name"))]
anchor_lang::prelude::msg!(#ix_name_log);

// Deserialize instruction.
#deserialize_instruction

Expand Down Expand Up @@ -593,14 +630,17 @@ pub fn generate(program: &Program) -> proc_macro2::TokenStream {
let ix_method_name = &ix.raw_method.sig.ident;
let anchor = &ix.anchor_ident;
let variant_arm = generate_ix_variant(ix.raw_method.sig.ident.to_string(), &ix.args);

let ix_name_log = format!("Instruction: {}", ix_name);
quote! {
#[inline(never)]
pub fn #ix_method_name(
program_id: &Pubkey,
accounts: &[AccountInfo],
ix_data: &[u8],
) -> ProgramResult {
#[cfg(not(feature = "no-log-ix-name"))]
anchor_lang::prelude::msg!(#ix_name_log);

// Deserialize data.
let ix = instruction::#ix_name::deserialize(&mut &ix_data[..])
.map_err(|_| anchor_lang::__private::ErrorCode::InstructionDidNotDeserialize)?;
Expand Down