shank_render 0.4.8

Renders implementaions derived from shank macros
Documentation 
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

use proc_macro2::{Span, TokenStream};
use quote::quote;
use shank_macro_impl::syn::Ident;
use shank_render::pda::render_pda_fn;

use crate::utils;

// -----------------
// Integration Tests and Real World Examples
// -----------------

fn render_pda(code: TokenStream, include_comments: bool) -> TokenStream {
    let processed_seeds =
        utils::process_seeds(code).expect("Should process seeds without error");
    render_pda_fn(
        &processed_seeds,
        &Ident::new("shank_seeds", Span::call_site()),
        &Ident::new("shank_seeds_with_bump", Span::call_site()),
        &Ident::new("shank_pda", Span::call_site()),
        &Ident::new("shank_pda_with_bump", Span::call_site()),
        include_comments,
    )
    .unwrap()
}

#[allow(unused)]
fn render_and_dump(code: &TokenStream) {
    let rendered = render_pda(code.clone(), false);
    eprintln!("{}", utils::pretty_print(rendered));
}

fn assert_rendered_pda_fn(code: TokenStream, expected: TokenStream) {
    let rendered = render_pda(code, false);
    assert_eq!(utils::pretty_print(rendered), utils::pretty_print(expected));
}

// NOTE: the below tests use the same seeds as the ./render_seeds_fn.rs tests
#[test]
fn literal_pubkeys_and_u8_byte_pda() {
    let code = quote! {
        #[derive(ShankAccount)]
        #[seeds(
            /* literal    */ "lit:prefix",
            /* program_id */ program_id,
            /* pubkey     */ some_pubkey("description of some pubkey"),
            /* byte       */ some_byte("description of byte", u8),
        )]
        struct AccountStructWithSeed {
            count: u8,
        }
    };
    render_and_dump(&code);
    assert_rendered_pda_fn(
        code,
        quote! {
            #[allow(unused)]
            pub fn shank_pda(
                program_id: &::solana_program::pubkey::Pubkey,
                some_pubkey: &::solana_program::pubkey::Pubkey,
                some_byte: u8,
            ) -> (::solana_program::pubkey::Pubkey, u8) {
                let some_byte_arg = &[some_byte];
                let seeds = Self::shank_seeds(program_id, some_pubkey, some_byte_arg);
                ::solana_program::pubkey::Pubkey::find_program_address(&seeds, program_id)
            }
            #[allow(unused)]
            pub fn shank_pda_with_bump(
                program_id: &::solana_program::pubkey::Pubkey,
                some_pubkey: &::solana_program::pubkey::Pubkey,
                some_byte: u8,
                bump: u8,
            ) -> (::solana_program::pubkey::Pubkey, u8) {
                let some_byte_arg = &[some_byte];
                let bump_arg = &[bump];
                let seeds = Self::shank_seeds_with_bump(
                    program_id,
                    some_pubkey,
                    some_byte_arg,
                    bump_arg,
                );
                ::solana_program::pubkey::Pubkey::find_program_address(&seeds, program_id)
            }
        },
    );
}

#[test]
fn candy_guard_edition_marker_pda() {
    let code = quote! {
        #[derive(ShankAccount)]
        #[seeds(
            prefix("Prefix", str),
            program_id,
            master_edition_mint_info("Master Edition Mint Info", AccountInfo),
            edition("Edition", str),
            edition_marker_number("Edition Marker Number", String),
        )]
        struct CandyGuardEditionMarker {
            count: u8,
        }
    };
    assert_rendered_pda_fn(
        code,
        quote! {
            #[allow(unused)]
            pub fn shank_pda(
                program_id: &::solana_program::pubkey::Pubkey,
                prefix: &str,
                master_edition_mint_info: &::solana_program::account_info::AccountInfo,
                edition: &str,
                edition_marker_number: &String,
            ) -> (::solana_program::pubkey::Pubkey, u8) {
                let seeds = Self::shank_seeds(
                    prefix,
                    program_id,
                    master_edition_mint_info,
                    edition,
                    edition_marker_number,
                );
                ::solana_program::pubkey::Pubkey::find_program_address(&seeds, program_id)
            }
            #[allow(unused)]
            pub fn shank_pda_with_bump(
                program_id: &::solana_program::pubkey::Pubkey,
                prefix: &str,
                master_edition_mint_info: &::solana_program::account_info::AccountInfo,
                edition: &str,
                edition_marker_number: &String,
                bump: u8,
            ) -> (::solana_program::pubkey::Pubkey, u8) {
                let bump_arg = &[bump];
                let seeds = Self::shank_seeds_with_bump(
                    prefix,
                    program_id,
                    master_edition_mint_info,
                    edition,
                    edition_marker_number,
                    bump_arg,
                );
                ::solana_program::pubkey::Pubkey::find_program_address(&seeds, program_id)
            }
        },
    );
}

#[test]
fn candy_guard_mint_limit_pda() {
    let code = quote! {
        #[derive(ShankAccount)]
        #[seeds(
            id("Guard Id", u8),
            user("The User Pubkey"),
            candy_guard_key("Candy Guard Key", Pubkey),
            candy_machine_key("Candy Machine Key"),
        )]
        struct CandyGuardMintLimitSeeds {
            count: u8,
        }
    };
    assert_rendered_pda_fn(
        code,
        quote! {
            #[allow(unused)]
            pub fn shank_pda(
                program_id: &::solana_program::pubkey::Pubkey,
                id: u8,
                user: &::solana_program::pubkey::Pubkey,
                candy_guard_key: &::solana_program::pubkey::Pubkey,
                candy_machine_key: &::solana_program::pubkey::Pubkey,
            ) -> (::solana_program::pubkey::Pubkey, u8) {
                let id_arg = &[id];
                let seeds = Self::shank_seeds(id_arg, user, candy_guard_key, candy_machine_key);
                ::solana_program::pubkey::Pubkey::find_program_address(&seeds, program_id)
            }
            #[allow(unused)]
            pub fn shank_pda_with_bump(
                program_id: &::solana_program::pubkey::Pubkey,
                id: u8,
                user: &::solana_program::pubkey::Pubkey,
                candy_guard_key: &::solana_program::pubkey::Pubkey,
                candy_machine_key: &::solana_program::pubkey::Pubkey,
                bump: u8,
            ) -> (::solana_program::pubkey::Pubkey, u8) {
                let id_arg = &[id];
                let bump_arg = &[bump];
                let seeds = Self::shank_seeds_with_bump(
                    id_arg,
                    user,
                    candy_guard_key,
                    candy_machine_key,
                    bump_arg,
                );
                ::solana_program::pubkey::Pubkey::find_program_address(&seeds, program_id)
            }
        },
    );
}

// -----------------
// Edge Cases
// -----------------
#[test]
fn struct_with_one_literal_pda_fn() {
    let code = quote! {
        #[derive(ShankAccount)]
        #[seeds("lit:prefix")]
        struct SomeAccount {
            count: u8,
        }
    };
    assert_rendered_pda_fn(
        code,
        quote! {
            #[allow(unused)]
            pub fn shank_pda(
                program_id: &::solana_program::pubkey::Pubkey,
            ) -> (::solana_program::pubkey::Pubkey, u8) {
                let seeds = Self::shank_seeds();
                ::solana_program::pubkey::Pubkey::find_program_address(&seeds, program_id)
            }
            #[allow(unused)]
            pub fn shank_pda_with_bump(
                program_id: &::solana_program::pubkey::Pubkey,
                bump: u8,
            ) -> (::solana_program::pubkey::Pubkey, u8) {
                let bump_arg = &[bump];
                let seeds = Self::shank_seeds_with_bump(bump_arg);
                ::solana_program::pubkey::Pubkey::find_program_address(&seeds, program_id)
            }
        },
    );
}