spl-program-error 0.7.0

Library for Solana Program error attributes and derive macro for creating them
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

pub mod bench;
pub mod decode;
pub mod into;
pub mod print;
pub mod spl;

#[cfg(test)]
mod tests {
    use {
        super::*,
        serial_test::serial,
        solana_decode_error::DecodeError,
        solana_program_error::{PrintProgramError, ProgramError},
        std::sync::{Arc, RwLock},
    };

    // Used to capture output for `PrintProgramError` for testing
    lazy_static::lazy_static! {
        static ref EXPECTED_DATA: Arc<RwLock<Vec<u8>>> = Arc::new(RwLock::new(Vec::new()));
    }
    fn set_expected_data(expected_data: Vec<u8>) {
        *EXPECTED_DATA.write().unwrap() = expected_data;
    }
    pub struct SyscallStubs {}
    impl solana_sysvar::program_stubs::SyscallStubs for SyscallStubs {
        fn sol_log(&self, message: &str) {
            assert_eq!(
                message,
                String::from_utf8_lossy(&EXPECTED_DATA.read().unwrap())
            );
        }
    }

    // `#[derive(IntoProgramError)]`
    #[test]
    fn test_derive_into_program_error() {
        // `Into<ProgramError>`
        assert_eq!(
            Into::<ProgramError>::into(bench::ExampleError::MintHasNoMintAuthority),
            Into::<ProgramError>::into(into::ExampleError::MintHasNoMintAuthority),
        );
        assert_eq!(
            Into::<ProgramError>::into(bench::ExampleError::IncorrectMintAuthority),
            Into::<ProgramError>::into(into::ExampleError::IncorrectMintAuthority),
        );
    }

    // `#[derive(DecodeError)]`
    #[test]
    fn test_derive_decode_error() {
        // `Into<ProgramError>`
        assert_eq!(
            Into::<ProgramError>::into(bench::ExampleError::MintHasNoMintAuthority),
            Into::<ProgramError>::into(decode::ExampleError::MintHasNoMintAuthority),
        );
        assert_eq!(
            Into::<ProgramError>::into(bench::ExampleError::IncorrectMintAuthority),
            Into::<ProgramError>::into(decode::ExampleError::IncorrectMintAuthority),
        );
        // `DecodeError<T>`
        assert_eq!(
            <bench::ExampleError as DecodeError<bench::ExampleError>>::type_of(),
            <bench::ExampleError as DecodeError<decode::ExampleError>>::type_of(),
        );
    }
    // `#[derive(PrintProgramError)]`
    #[test]
    #[serial]
    fn test_derive_print_program_error() {
        use std::sync::Once;
        static ONCE: Once = Once::new();

        ONCE.call_once(|| {
            solana_sysvar::program_stubs::set_syscall_stubs(Box::new(SyscallStubs {}));
        });
        // `Into<ProgramError>`
        assert_eq!(
            Into::<ProgramError>::into(bench::ExampleError::MintHasNoMintAuthority),
            Into::<ProgramError>::into(print::ExampleError::MintHasNoMintAuthority),
        );
        assert_eq!(
            Into::<ProgramError>::into(bench::ExampleError::IncorrectMintAuthority),
            Into::<ProgramError>::into(print::ExampleError::IncorrectMintAuthority),
        );
        // `DecodeError<T>`
        assert_eq!(
            <bench::ExampleError as DecodeError<bench::ExampleError>>::type_of(),
            <bench::ExampleError as DecodeError<print::ExampleError>>::type_of(),
        );
        // `PrintProgramError`
        set_expected_data("Mint has no mint authority".as_bytes().to_vec());
        PrintProgramError::print::<print::ExampleError>(
            &print::ExampleError::MintHasNoMintAuthority,
        );
        set_expected_data(
            "Incorrect mint authority has signed the instruction"
                .as_bytes()
                .to_vec(),
        );
        PrintProgramError::print::<print::ExampleError>(
            &print::ExampleError::IncorrectMintAuthority,
        );
    }

    // `#[spl_program_error]`
    #[test]
    #[serial]
    fn test_spl_program_error() {
        use std::sync::Once;
        static ONCE: Once = Once::new();

        ONCE.call_once(|| {
            solana_sysvar::program_stubs::set_syscall_stubs(Box::new(SyscallStubs {}));
        });
        // `Into<ProgramError>`
        assert_eq!(
            Into::<ProgramError>::into(bench::ExampleError::MintHasNoMintAuthority),
            Into::<ProgramError>::into(spl::ExampleError::MintHasNoMintAuthority),
        );
        assert_eq!(
            Into::<ProgramError>::into(bench::ExampleError::IncorrectMintAuthority),
            Into::<ProgramError>::into(spl::ExampleError::IncorrectMintAuthority),
        );
        // `DecodeError<T>`
        assert_eq!(
            <bench::ExampleError as DecodeError<bench::ExampleError>>::type_of(),
            <bench::ExampleError as DecodeError<spl::ExampleError>>::type_of(),
        );
        // `PrintProgramError`
        set_expected_data("Mint has no mint authority".as_bytes().to_vec());
        PrintProgramError::print::<spl::ExampleError>(&spl::ExampleError::MintHasNoMintAuthority);
        set_expected_data(
            "Incorrect mint authority has signed the instruction"
                .as_bytes()
                .to_vec(),
        );
        PrintProgramError::print::<spl::ExampleError>(&spl::ExampleError::IncorrectMintAuthority);
    }
}