sol_rpc_types 3.1.1

Candid types used by the SOL RPC canister
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

use crate::VecWithMaxLen;
use candid::{CandidType, Decode, Encode};
use proptest::{
    arbitrary::Arbitrary,
    prelude::{any, prop, Strategy, TestCaseError},
    prop_assert, prop_assert_eq, proptest,
};
use serde::de::DeserializeOwned;

mod vec_with_max_len_tests {
    use super::*;

    proptest! {
        #[test]
        fn should_encode_decode (
            string_vec in arb_vec_with_max_size(50),
            int_vec in arb_vec_with_max_size(75),
            bytes_vec in arb_vec_with_max_size(100))
        {
            encode_decode_roundtrip::<String, 50>(string_vec)?;
            encode_decode_roundtrip::<i32, 75>(int_vec)?;
            encode_decode_roundtrip::<Vec<u8>, 100>(bytes_vec)?;
        }

        #[test]
        fn should_fail_to_decode_when_too_long(
            string_vec in arb_vec_with_size_greater_than(50),
            int_vec in arb_vec_with_size_greater_than(75),
            bytes_vec in arb_vec_with_size_greater_than(100))
        {
            expect_decoding_error::<String, 50>(string_vec)?;
            expect_decoding_error::<i32, 75>(int_vec)?;
            expect_decoding_error::<Vec<u8>, 100>(bytes_vec)?;
        }
    }

    fn encode_decode_roundtrip<T, const CAPACITY: usize>(value: Vec<T>) -> Result<(), TestCaseError>
    where
        T: Clone + CandidType + std::fmt::Debug + PartialEq + DeserializeOwned,
    {
        let wrapped_value: VecWithMaxLen<T, CAPACITY> = TryFrom::try_from(value.clone())?;
        let encoded_value = Encode!(&value)?;
        let encoded_wrapped_value = Encode!(&wrapped_value)?;
        prop_assert_eq!(
            &encoded_value,
            &encoded_wrapped_value,
            "Encoded value differ for {:?}",
            value
        );

        let decoded_value = Decode!(&encoded_value, VecWithMaxLen<T, CAPACITY>)?;
        prop_assert_eq!(
            &decoded_value,
            &wrapped_value,
            "Decoded value differ for {:?}",
            value
        );
        Ok(())
    }

    fn expect_decoding_error<T, const CAPACITY: usize>(
        too_long: Vec<T>,
    ) -> Result<(), TestCaseError>
    where
        T: Clone + CandidType + std::fmt::Debug + PartialEq + DeserializeOwned,
    {
        let result = Decode!(&Encode!(&too_long)?, VecWithMaxLen<T, CAPACITY>);
        prop_assert!(
            result.is_err(),
            "Expected error decoding {:?}, got: {:?}",
            too_long,
            result
        );
        Ok(())
    }

    fn arb_vec_with_max_size<T: Arbitrary>(max_size: usize) -> impl Strategy<Value = Vec<T>> {
        prop::collection::vec(any::<T>(), 0..=max_size)
    }

    fn arb_vec_with_size_greater_than<T: Arbitrary>(
        min_size: usize,
    ) -> impl Strategy<Value = Vec<T>> {
        prop::collection::vec(any::<T>(), min_size + 1..=min_size + 100)
    }
}