bat-cli 0.11.0

Blockchain Auditor Toolkit (BAT)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
use error_stack::{IntoReport, Result, ResultExt};
use inflector::Inflector;
use serde::{Deserialize, Serialize};

use crate::batbelt::git::git_action::GitAction;
use crate::batbelt::metadata::context_accounts_metadata::ContextAccountsMetadata;
use crate::batbelt::metadata::structs_source_code_metadata::StructMetadataType;
use crate::batbelt::metadata::{BatMetadata, BatMetadataParser, SourceCodeMetadata};
use crate::batbelt::parser::entrypoint_parser::EntrypointParser;
use crate::batbelt::parser::function_parser::FunctionParser;
use crate::batbelt::parser::solana_account_parser::{SolanaAccountParser, SolanaAccountType};
use crate::batbelt::path::BatFile;
use crate::batbelt::sonar::{BatSonar, SonarResultType};
use crate::batbelt::templates::code_overhaul_template::CoderOverhaulTemplatePlaceholders::{
    CompleteWithNotes, CompleteWithTheRestOfStateChanges,
};
use crate::batbelt::templates::{TemplateError, TemplateResult};
use crate::batbelt::{BatEnumerator, ShareableData};

pub struct CodeOverhaulTemplate {
    pub entrypoint_name: String,
    pub entrypoint_parser: Option<EntrypointParser>,
}

impl CodeOverhaulTemplate {
    pub fn new(entrypoint_name: &str, initialized: bool) -> Result<Self, TemplateError> {
        let entrypoint_parser = if initialized {
            let ep_parser =
                EntrypointParser::new_from_name(entrypoint_name).change_context(TemplateError)?;
            Some(ep_parser)
        } else {
            None
        };
        Ok(Self {
            entrypoint_name: entrypoint_name.to_string(),
            entrypoint_parser,
        })
    }

    pub fn get_markdown_content(&self) -> TemplateResult<String> {
        let state_changes_content = CodeOverhaulSection::StateChanges
            .get_section_content_for_start_co_file(self.entrypoint_parser.clone())?;
        let notes_content = CodeOverhaulSection::Notes
            .get_section_content_for_start_co_file(self.entrypoint_parser.clone())?;
        let signers_content = CodeOverhaulSection::Signers
            .get_section_content_for_start_co_file(self.entrypoint_parser.clone())?;
        let function_parameters_content = CodeOverhaulSection::DependencyFunctionParameters
            .get_section_content_for_start_co_file(self.entrypoint_parser.clone())?;
        let context_accounts_content = CodeOverhaulSection::ContextAccounts
            .get_section_content_for_start_co_file(self.entrypoint_parser.clone())?;
        let validations_content = CodeOverhaulSection::Validations
            .get_section_content_for_start_co_file(self.entrypoint_parser.clone())?;
        let miro_frame_url_content = CodeOverhaulSection::MiroFrameUrl
            .get_section_content_for_start_co_file(self.entrypoint_parser.clone())?;

        Ok(format!(
            "{state_changes_content}\
            \n\
            \n\
            {notes_content}\
            \n\
            \n\
            {signers_content}\
            \n\
            \n\
            {function_parameters_content}\
            \n\
            \n\
            {context_accounts_content}\
            \n\
            \n\
            {validations_content}\
            \n\
            \n\
            {miro_frame_url_content}
            ",
        ))
    }
}

#[derive(
    Default,
    Debug,
    Serialize,
    Deserialize,
    Clone,
    strum_macros::EnumIter,
    strum_macros::Display,
    PartialOrd,
    PartialEq,
)]
pub enum CodeOverhaulSection {
    #[default]
    StateChanges,
    Notes,
    Signers,
    DependencyFunctionParameters,
    ContextAccounts,
    Validations,
    MiroFrameUrl,
}

impl BatEnumerator for CodeOverhaulSection {}

impl CodeOverhaulSection {
    pub fn to_markdown_header(&self) -> String {
        format!("# {}:", self.to_string().to_sentence_case())
    }

    pub fn to_title(&self) -> String {
        format!("{}:", self.to_string().to_sentence_case())
    }

    pub fn get_section_content_for_start_co_file(
        &self,
        ep_parser: Option<EntrypointParser>,
    ) -> TemplateResult<String> {
        let section_content = if ep_parser.is_some() {
            let entrypoint_parser = ep_parser.unwrap();
            match self {
                CodeOverhaulSection::StateChanges => {
                    self.get_state_changes_content(entrypoint_parser)?
                }
                CodeOverhaulSection::Notes => self.get_notes_content(entrypoint_parser)?,
                CodeOverhaulSection::Signers => self.get_signers_section_content(entrypoint_parser),
                CodeOverhaulSection::DependencyFunctionParameters => {
                    self.get_dependency_function_parameters_section_content(entrypoint_parser)?
                }
                CodeOverhaulSection::ContextAccounts => {
                    self.get_context_account_section_content(entrypoint_parser)
                }
                CodeOverhaulSection::Validations => {
                    self.get_validations_section_content(entrypoint_parser)?
                }
                CodeOverhaulSection::MiroFrameUrl => {
                    CoderOverhaulTemplatePlaceholders::CompleteWithMiroFrameUrl.to_placeholder()
                }
            }
        } else {
            "".to_string()
        };

        Ok(format!(
            "{}\n\n{}",
            self.to_markdown_header(),
            section_content
        ))
    }

    fn get_notes_content(&self, entry_point_parser: EntrypointParser) -> TemplateResult<String> {
        let context_accounts_struct_source_code_metadata_id =
            entry_point_parser.context_accounts.metadata_id;
        let context_accounts_metadata =
            ContextAccountsMetadata::find_context_accounts_metadata_by_struct_metadata_id(
                context_accounts_struct_source_code_metadata_id,
            )
            .change_context(TemplateError)?;
        let context_accounts_sc_metadata = SourceCodeMetadata::find_struct(
            context_accounts_metadata.name.clone(),
            StructMetadataType::ContextAccounts,
        )
        .change_context(TemplateError)?;
        let ca_sc_metadata_file_content = BatFile::Generic {
            file_path: context_accounts_sc_metadata.path.clone(),
        }
        .read_content(false)
        .change_context(TemplateError)?;
        let ca_sc_file_content_lines = ca_sc_metadata_file_content.lines();
        let ca_info_with_validation = context_accounts_metadata
            .context_accounts_info
            .clone()
            .into_iter()
            .filter_map(|ca_info| {
                if !ca_info.validations.is_empty() {
                    Some(ca_info.validations.clone())
                } else {
                    None
                }
            });
        if ca_info_with_validation.clone().count() == 0 {
            return Ok(format!("- {}", CompleteWithNotes.to_placeholder()));
        }

        let mut result = vec![];
        result.push("- [ ] check constraints:".to_string());
        for ca_info_validations_vec in ca_info_with_validation.clone() {
            for ca_info_validation in ca_info_validations_vec.clone() {
                let validation_line = ca_sc_file_content_lines
                    .clone()
                    .position(|line| line.contains(&ca_info_validation))
                    .ok_or(TemplateError)
                    .into_report()?;
                let shared_permalink = ShareableData::new(String::new());
                GitAction::GetRepositoryPermalink {
                    file_path: context_accounts_sc_metadata.path.clone(),
                    start_line_index: validation_line + 1,
                    permalink: shared_permalink.original,
                }
                .execute_action()
                .change_context(TemplateError)?;
                // let permalink = format!("{}", &*shared_permalink.cloned.borrow());
                result.push(format!(
                    "  - [ ] [{}]({}), [ref]({})",
                    ca_info_validation,
                    validation_line + 1,
                    *shared_permalink.cloned.borrow()
                ));
            }
        }
        result.push(format!("- {}", CompleteWithNotes.to_placeholder()));
        Ok(result.join("\n"))
    }

    fn get_state_changes_content(
        &self,
        entry_point_parser: EntrypointParser,
    ) -> TemplateResult<String> {
        let bat_metadata = BatMetadata::read_metadata().change_context(TemplateError)?;
        let mut state_changes_content_vec = vec![];
        let context_accounts_metadata = bat_metadata
            .get_context_accounts_metadata_by_struct_source_code_metadata_id(
                entry_point_parser.context_accounts.metadata_id,
            )
            .change_context(TemplateError)?;

        let init_accounts = context_accounts_metadata
            .context_accounts_info
            .clone()
            .into_iter()
            .filter(|ca_info| ca_info.is_init)
            .collect::<Vec<_>>();
        for acc in init_accounts {
            state_changes_content_vec.push(format!(
                "- Initializes `{}`[{}], funded by `{}`",
                acc.account_name, acc.account_struct_name, acc.rent_exemption_account
            ))
        }

        let close_accounts = context_accounts_metadata
            .context_accounts_info
            .clone()
            .into_iter()
            .filter(|ca_info| ca_info.is_close)
            .collect::<Vec<_>>();
        for acc in close_accounts {
            state_changes_content_vec.push(format!(
                "- Closes `{}`[{}]. Rent exemption goes to `{}`",
                acc.account_name, acc.account_struct_name, acc.rent_exemption_account
            ))
        }

        let mut_program_state_accounts = context_accounts_metadata
            .clone()
            .context_accounts_info
            .into_iter()
            .filter(|ca_info| {
                ca_info.is_mut
                    && !ca_info.is_close
                    && !ca_info.is_init
                    && ca_info.solana_account_type == SolanaAccountType::ProgramStateAccount
            });

        for mut_program_state_acc in mut_program_state_accounts {
            let solana_acc_parser =
                SolanaAccountParser::new_from_struct_name_and_solana_account_type(
                    mut_program_state_acc.clone().account_struct_name,
                    mut_program_state_acc.clone().solana_account_type,
                )
                .change_context(TemplateError)?;
            state_changes_content_vec.push(format!(
                "- Updates `{}`[{}]:\n{}",
                mut_program_state_acc.clone().account_name,
                mut_program_state_acc.clone().account_struct_name,
                solana_acc_parser
                    .accounts
                    .clone()
                    .into_iter()
                    .map(|acc_parser| format!(
                        "  - `{}.{}`[{}]",
                        mut_program_state_acc.clone().account_name,
                        acc_parser.account_name,
                        acc_parser.account_type
                    ))
                    .collect::<Vec<_>>()
                    .join("\n")
            ));
        }

        let mut_unknown_accounts = context_accounts_metadata
            .clone()
            .context_accounts_info
            .into_iter()
            .filter(|ca_info| {
                ca_info.is_mut
                    && (ca_info.solana_account_type == SolanaAccountType::UncheckedAccount
                        || ca_info.solana_account_type == SolanaAccountType::Other)
            });
        for mut_unkown_account in mut_unknown_accounts {
            state_changes_content_vec.push(format!(
                "- Updates `{}`[{}]",
                mut_unkown_account.clone().account_name,
                mut_unkown_account.clone().account_struct_name,
            ));
        }

        let mut_token_accounts = context_accounts_metadata
            .clone()
            .context_accounts_info
            .into_iter()
            .filter(|ca_info| {
                ca_info.is_mut && ca_info.solana_account_type == SolanaAccountType::TokenAccount
            })
            .collect::<Vec<_>>();

        for (mut_token_account_index, mut_token_account) in
            mut_token_accounts.clone().into_iter().enumerate()
        {
            let mut destination_index = 0;
            while destination_index < mut_token_accounts.len() {
                if destination_index == mut_token_account_index {
                    destination_index += 1;
                    continue;
                }
                state_changes_content_vec.push(format!(
                    "- Transfers `{}` tokens from `{}`[authority={}] to `{}`[authority={}]",
                    CoderOverhaulTemplatePlaceholders::CompleteWithAmount.to_placeholder(),
                    mut_token_account.clone().account_name,
                    CoderOverhaulTemplatePlaceholders::CompleteWithTokenAuthority.to_placeholder(),
                    mut_token_accounts.clone()[destination_index].account_name,
                    CoderOverhaulTemplatePlaceholders::CompleteWithTokenAuthority.to_placeholder(),
                ));
                destination_index += 1;
            }
            state_changes_content_vec.push(format!(
                "- Transfers `{}` tokens from `{}`[authority={}] to `{}`[authority={}]",
                CoderOverhaulTemplatePlaceholders::CompleteWithAmount.to_placeholder(),
                mut_token_account.clone().account_name,
                CoderOverhaulTemplatePlaceholders::CompleteWithTokenAuthority.to_placeholder(),
                CoderOverhaulTemplatePlaceholders::CompleteWithDestinationTokenAccount
                    .to_placeholder(),
                CoderOverhaulTemplatePlaceholders::CompleteWithTokenAuthority.to_placeholder(),
            ));

            destination_index = 0;

            while destination_index < mut_token_accounts.len() {
                if destination_index == mut_token_account_index {
                    destination_index += 1;
                    continue;
                }
                state_changes_content_vec.push(format!(
                    "- Delegates `{}` tokens from `{}`[authority={}] to `{}`[authority={}]",
                    CoderOverhaulTemplatePlaceholders::CompleteWithAmount.to_placeholder(),
                    mut_token_account.clone().account_name,
                    CoderOverhaulTemplatePlaceholders::CompleteWithTokenAuthority.to_placeholder(),
                    mut_token_accounts.clone()[destination_index].account_name,
                    CoderOverhaulTemplatePlaceholders::CompleteWithTokenAuthority.to_placeholder(),
                ));
                destination_index += 1;
            }
            state_changes_content_vec.push(format!(
                "- Delegates `{}` tokens from `{}`[authority={}] to `{}`[authority={}]",
                CoderOverhaulTemplatePlaceholders::CompleteWithAmount.to_placeholder(),
                mut_token_account.clone().account_name,
                CoderOverhaulTemplatePlaceholders::CompleteWithTokenAuthority.to_placeholder(),
                CoderOverhaulTemplatePlaceholders::CompleteWithDestinationTokenAccount
                    .to_placeholder(),
                CoderOverhaulTemplatePlaceholders::CompleteWithTokenAuthority.to_placeholder(),
            ));
        }

        let mut_mint_accounts = context_accounts_metadata
            .clone()
            .context_accounts_info
            .into_iter()
            .filter(|ca_info| {
                ca_info.is_mut && ca_info.solana_account_type == SolanaAccountType::Mint
            })
            .collect::<Vec<_>>();

        for mut_mint_account in mut_mint_accounts {
            for mut_token_account in mut_token_accounts.clone() {
                state_changes_content_vec.push(format!(
                    "- Mints `{}` tokens from `{}` token_mint to `{}`[authority={}]",
                    CoderOverhaulTemplatePlaceholders::CompleteWithAmount.to_placeholder(),
                    mut_mint_account.clone().account_name,
                    mut_token_account.clone().account_name,
                    CoderOverhaulTemplatePlaceholders::CompleteWithTokenAuthority.to_placeholder(),
                ));
            }
            state_changes_content_vec.push(format!(
                "- Mints `{}` tokens from `{}` token_mint to `{}`[authority={}]",
                CoderOverhaulTemplatePlaceholders::CompleteWithAmount.to_placeholder(),
                mut_mint_account.clone().account_name,
                CoderOverhaulTemplatePlaceholders::CompleteWithDestinationTokenAccount
                    .to_placeholder(),
                CoderOverhaulTemplatePlaceholders::CompleteWithTokenAuthority.to_placeholder(),
            ));
            for mut_token_account in mut_token_accounts.clone() {
                state_changes_content_vec.push(format!(
                    "- Burns `{}` tokens from `{}` token_mint to `{}`[authority={}]",
                    CoderOverhaulTemplatePlaceholders::CompleteWithAmount.to_placeholder(),
                    mut_mint_account.clone().account_name,
                    mut_token_account.clone().account_name,
                    CoderOverhaulTemplatePlaceholders::CompleteWithTokenAuthority.to_placeholder(),
                ));
            }
            state_changes_content_vec.push(format!(
                "- Burns `{}` tokens from `{}` token_mint to `{}`[authority={}]",
                CoderOverhaulTemplatePlaceholders::CompleteWithAmount.to_placeholder(),
                mut_mint_account.clone().account_name,
                CoderOverhaulTemplatePlaceholders::CompleteWithDestinationTokenAccount
                    .to_placeholder(),
                CoderOverhaulTemplatePlaceholders::CompleteWithTokenAuthority.to_placeholder(),
            ));
        }

        state_changes_content_vec.push(format!(
            "- `{}`",
            CompleteWithTheRestOfStateChanges.to_placeholder()
        ));
        Ok(state_changes_content_vec.join("\n"))
    }

    fn get_validations_section_content(
        &self,
        entrypoint_parser: EntrypointParser,
    ) -> TemplateResult<String> {
        log::debug!(
            "get_validations_section_content entrypoint_parser \n{:#?}",
            entrypoint_parser
        );

        // Collect validations from all dependencies (recursively resolved)
        let mut dependency_validations: Vec<String> = vec![];
        for dep_function in &entrypoint_parser.dependencies {
            // Use exact line ranges from metadata for robust function content extraction
            let dep_if_validations = BatSonar::new_from_path_with_lines(
                &dep_function.path,
                dep_function.start_line_index,
                dep_function.end_line_index,
                SonarResultType::IfValidation,
            );

            // get the if validations inside any if statement to filter from the dependency validations
            let if_validations = dep_if_validations
                .results
                .iter()
                .map(|if_validation| {
                    let if_in_validations =
                        BatSonar::new_scanned(&if_validation.content, SonarResultType::Validation);
                    if !if_in_validations.results.is_empty() {
                        if_in_validations.results
                    } else {
                        vec![]
                    }
                })
                .fold(vec![], |mut result, current| {
                    for res in current {
                        result.push(res);
                    }
                    result
                });

            // any if that contains an if validation is considered a validation
            let mut filtered_if = dep_if_validations
                .results
                .iter()
                .filter(|if_est| {
                    if_validations
                        .clone()
                        .iter()
                        .any(|if_val| if_est.content.contains(&if_val.content))
                })
                .map(|result| result.content.clone())
                .collect::<Vec<_>>();

            let dep_validations_sonar = BatSonar::new_from_path_with_lines(
                &dep_function.path,
                dep_function.start_line_index,
                dep_function.end_line_index,
                SonarResultType::Validation,
            );

            // if there are validations in if_validations, then filter them from dependency validations to avoid repetition
            let mut filtered_dep = if if_validations.is_empty() {
                dep_validations_sonar
                    .results
                    .iter()
                    .map(|result| result.content.clone())
                    .collect::<Vec<_>>()
            } else {
                dep_validations_sonar
                    .results
                    .iter()
                    .filter(|validation| {
                        !dep_if_validations
                            .results
                            .iter()
                            .any(|if_val| if_val.content.contains(&validation.content.to_string()))
                    })
                    .map(|val| val.content.clone())
                    .collect::<Vec<_>>()
            };

            if !filtered_if.is_empty() || !filtered_dep.is_empty() {
                // Header with function name, relative source path and the
                // function's start line so the auditor can jump straight to
                // the source. Leading `../` from the bat-audit -> program
                // path is stripped for readability.
                let relative_path = dep_function.path.trim_start_matches("../").to_string();
                dependency_validations.push(format!(
                    "// {} — {}:{}:",
                    dep_function.name, relative_path, dep_function.start_line_index
                ));
                dependency_validations.append(&mut filtered_if);
                dependency_validations.append(&mut filtered_dep);
            }
        }

        let bat_metadata = BatMetadata::read_metadata().change_context(TemplateError)?;
        let context_accounts_metadata = bat_metadata
            .get_context_accounts_metadata_by_struct_source_code_metadata_id(
                entrypoint_parser.context_accounts.metadata_id,
            )
            .change_context(TemplateError)?;

        log::debug!(
            "context_accounts_metadata:\n{:#?}",
            context_accounts_metadata
        );

        let mut ca_accounts_results = context_accounts_metadata
            .context_accounts_info
            .into_iter()
            .filter_map(|ca_metadata| {
                if !ca_metadata.validations.is_empty() {
                    let trailing_str = "  ".to_string();
                    // Build the account type line from metadata fields
                    let account_line = if ca_metadata.lifetime_name.is_empty() {
                        format!(
                            "{}pub {}: {},",
                            trailing_str, ca_metadata.account_name, ca_metadata.account_struct_name
                        )
                    } else if ca_metadata.account_wrapper_name == ca_metadata.account_struct_name {
                        format!(
                            "{}pub {}: {}<{}>,",
                            trailing_str,
                            ca_metadata.account_name,
                            ca_metadata.account_struct_name,
                            ca_metadata.lifetime_name
                        )
                    } else {
                        format!(
                            "{}pub {}: {}<{}, {}>,",
                            trailing_str,
                            ca_metadata.account_name,
                            ca_metadata.account_wrapper_name,
                            ca_metadata.lifetime_name,
                            ca_metadata.account_struct_name
                        )
                    };
                    let result = format!(
                        "{}#[account(\n{}\n{})]\n{}",
                        trailing_str,
                        ca_metadata
                            .validations
                            .into_iter()
                            .map(|validation| {
                                format!(
                                    "{}\t{},",
                                    trailing_str.clone(),
                                    validation.trim_end_matches(',')
                                )
                            })
                            .collect::<Vec<_>>()
                            .join("\n"),
                        trailing_str,
                        account_line
                    );
                    Some(result)
                } else {
                    None
                }
            })
            .collect::<Vec<_>>();
        log::debug!("ca_accounts_results:\n{:#?}", ca_accounts_results.clone());

        let mut validations_vec: Vec<String> = vec![];
        validations_vec.append(&mut ca_accounts_results);
        validations_vec.append(&mut dependency_validations);

        let validations_content = if validations_vec.is_empty() {
            format!(
                "- {}",
                CoderOverhaulTemplatePlaceholders::NoValidationsDetected.to_placeholder()
            )
        } else {
            validations_vec
                .iter()
                .map(|validation| format!("```rust\n{}\n```", validation))
                .collect::<Vec<_>>()
                .join("\n")
        };
        Ok(validations_content)
    }

    fn get_signers_section_content(&self, entrypoint_parser: EntrypointParser) -> String {
        let context_source_code = entrypoint_parser
            .context_accounts
            .to_source_code_parser(None);
        let context_lines = context_source_code.get_source_code_content();
        // signer names is only the name of the signer
        let mut signers: Vec<String> = vec![];
        for (line_index, line) in context_lines.lines().enumerate() {
            if !line.contains("pub") {
                continue;
            }
            let next_pub_line = context_lines
                .lines()
                .enumerate()
                .position(|line| {
                    line.0 > line_index && line.1.contains("pub")
                        || line.0 == context_lines.lines().count() - 1
                })
                .unwrap();
            let mut content =
                context_lines.lines().collect::<Vec<_>>()[line_index + 1..=next_pub_line].to_vec();
            let has_signer = content.clone().last().unwrap().contains("Signer<");
            if !has_signer {
                continue;
            }
            let signer_name = content.clone().last().unwrap().trim().replace("pub ", "");
            let signer_name = signer_name.split(':').next().unwrap();
            // delete last line
            content.pop().unwrap();
            let signer_comments = content
                .iter()
                .filter(|line| line.trim().split(' ').next().unwrap().contains("//"))
                .collect::<Vec<_>>();
            if signer_comments.is_empty() {
                let signer_description = format!(
                    "- {}: {}",
                    signer_name,
                    CoderOverhaulTemplatePlaceholders::CompleteWithSignerDescription
                        .to_placeholder()
                );
                signers.push(signer_description)
            } else if signer_comments.len() == 1 {
                // prompt the user to state if the comment is correct
                let signer_description_comment = signer_comments[0].split("// ").last().unwrap();
                let signer_description =
                    format!("- {}: {}", signer_name, signer_description_comment);
                signers.push(signer_description);
                // multiple line description
            } else {
                let signer_formatted = signer_comments
                    .iter()
                    .map(|line| line.split("// ").last().unwrap().to_string())
                    .collect::<Vec<_>>()
                    .join(". ");
                let signer_description = format!("- {}: {}", signer_name, signer_formatted);
                signers.push(signer_description);
            }
        }
        if signers.is_empty() {
            return CoderOverhaulTemplatePlaceholders::PermissionlessFunction
                .to_placeholder()
                .to_string();
        }
        signers.join("\n")
    }

    fn get_context_account_section_content(&self, entrypoint_parser: EntrypointParser) -> String {
        let context_accounts_source_code = entrypoint_parser
            .context_accounts
            .to_source_code_parser(None);
        let context_accounts_content = context_accounts_source_code.get_source_code_content();
        let accounts = BatSonar::new_scanned(
            &context_accounts_content,
            SonarResultType::ContextAccountsNoValidation,
        );

        let accounts_string = accounts
            .results
            .iter()
            .fold("".to_string(), |result, next| {
                format!("{}\n\n{}", result, next.content)
            });
        let first_line = context_accounts_content.lines().next().unwrap();
        let last_line = context_accounts_content.lines().last().unwrap();
        let context_filtered = format!(
            "{}\n{}\n{}",
            first_line,
            accounts_string.trim_start_matches('\n'),
            last_line,
        );
        let formatted = context_filtered
            .lines()
            .map(|line| format!("  {}", line))
            .collect::<Vec<_>>()
            .join("\n");

        format!("{}\n{}\n{}", "```rust", formatted, "```")
    }

    fn get_dependency_function_parameters_section_content(
        &self,
        entrypoint_parser: EntrypointParser,
    ) -> TemplateResult<String> {
        if entrypoint_parser.dependencies.is_empty() {
            return Ok(
                CoderOverhaulTemplatePlaceholders::NoDependencyFunctionParametersDetected
                    .to_placeholder()
                    .to_string(),
            );
        }

        let mut all_parameters = vec![];
        for dep_function in &entrypoint_parser.dependencies {
            let dep_function_parser = FunctionParser::new_from_metadata(dep_function.clone())
                .change_context(TemplateError)?;
            let filtered_parameters = dep_function_parser
                .parameters
                .into_iter()
                .filter(|parameter| {
                    let normalized =
                        crate::batbelt::parser::function_parser::normalize_generic_type(
                            &parameter.parameter_type,
                        );
                    !normalized.contains("Context<")
                })
                .collect::<Vec<_>>();

            if !filtered_parameters.is_empty() {
                all_parameters.push(format!("// {}:", dep_function.name));
                for parameter in filtered_parameters {
                    all_parameters.push(format!(
                        "- {}: {}",
                        parameter.parameter_name,
                        parameter.parameter_type.trim_end_matches(',')
                    ));
                    if let Ok(struct_metadata) = SourceCodeMetadata::find_struct(
                        parameter.parameter_type.trim_start_matches("&").to_string(),
                        StructMetadataType::Other,
                    ) {
                        all_parameters.push(format!(
                            "```rust\n{}\n```",
                            struct_metadata
                                .to_source_code_parser(None)
                                .get_source_code_content()
                                .lines()
                                .map(|line| format!("  {line}"))
                                .collect::<Vec<_>>()
                                .join("\n")
                        ));
                    }
                }
            }
        }

        let function_parameters_content = if all_parameters.is_empty() {
            CoderOverhaulTemplatePlaceholders::NoDependencyFunctionParametersDetected
                .to_placeholder()
                .to_string()
        } else {
            all_parameters.join("\n")
        };
        Ok(function_parameters_content)
    }
}

#[derive(strum_macros::Display)]
pub enum CoderOverhaulTemplatePlaceholders {
    PermissionlessFunction,
    NoValidationsDetected,
    NoDependencyFunctionParametersDetected,
    CompleteWithTheRestOfStateChanges,
    CompleteWithNotes,
    CompleteWithSignerDescription,
    CompleteWithMiroFrameUrl,
    CompleteWithDestinationTokenAccount,
    CompleteWithAmount,
    CompleteWithTokenAuthority,
}

impl CoderOverhaulTemplatePlaceholders {
    pub fn to_placeholder(&self) -> String {
        self.to_string().to_screaming_snake_case()
    }
    pub fn get_state_changes_checked_placeholders_vec() -> Vec<String> {
        vec![
            Self::CompleteWithTheRestOfStateChanges.to_placeholder(),
            Self::CompleteWithAmount.to_placeholder(),
            Self::CompleteWithDestinationTokenAccount.to_placeholder(),
            Self::CompleteWithTokenAuthority.to_placeholder(),
        ]
    }
}

#[test]
fn test_to_title() {
    let expected = "Signers:";
    let title = CodeOverhaulSection::Signers.to_title();
    println!("title {:#?}", title);
    assert_eq!(expected, title, "Incorrect title");

    let expected = "Context accounts:";
    let title = CodeOverhaulSection::ContextAccounts.to_title();
    println!("title {:#?}", title);
    assert_eq!(expected, title, "Incorrect title");

    let expected = "Validations:";
    let title = CodeOverhaulSection::Validations.to_title();
    println!("title {:#?}", title);
    assert_eq!(expected, title, "Incorrect title");
}