radix-sbor-derive 1.2.0-dev

A library of macros for deriving Scrypto SBOR and Manifest SBOR implementation.
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

use proc_macro2::TokenStream;
use syn::Result;

pub fn handle_scrypto_describe(input: TokenStream) -> Result<TokenStream> {
    sbor_derive_common::describe::handle_describe(
        input,
        Some("radix_common::data::scrypto::ScryptoCustomTypeKind"),
    )
}

#[cfg(test)]
mod tests {
    use super::*;
    use proc_macro2::TokenStream;
    use quote::quote;
    use sbor_derive_common::utils::get_code_hash_const_array_token_stream;
    use std::str::FromStr;

    fn assert_code_eq(a: TokenStream, b: TokenStream) {
        assert_eq!(a.to_string(), b.to_string());
    }

    #[test]
    fn test_describe_struct() {
        let input = TokenStream::from_str("pub struct MyStruct { }").unwrap();
        let code_hash = get_code_hash_const_array_token_stream(&input);
        let output = handle_scrypto_describe(input).unwrap();

        assert_code_eq(
            output,
            quote! {
                impl ::sbor::Describe<radix_common::data::scrypto::ScryptoCustomTypeKind > for MyStruct {
                    const TYPE_ID: ::sbor::RustTypeId = ::sbor::RustTypeId::novel_with_code(
                        "MyStruct",
                        &[],
                        &#code_hash
                    );
                    fn type_data() -> ::sbor::TypeData<radix_common::data::scrypto::ScryptoCustomTypeKind, ::sbor::RustTypeId> {
                        ::sbor::TypeData::struct_with_named_fields(
                            "MyStruct",
                            ::sbor::rust::vec![],
                        )
                    }
                    fn add_all_dependencies(aggregator: &mut ::sbor::TypeAggregator<radix_common::data::scrypto::ScryptoCustomTypeKind >) {}
                }
            },
        );
    }

    #[test]
    fn test_describe_generic_struct() {
        let input = TokenStream::from_str("pub struct Thing<T> { field: T }").unwrap();
        let code_hash = get_code_hash_const_array_token_stream(&input);
        let output = handle_scrypto_describe(input).unwrap();

        assert_code_eq(
            output,
            quote! {
                impl<T> ::sbor::Describe<radix_common::data::scrypto::ScryptoCustomTypeKind > for Thing<T>
                where
                    T: ::sbor::Describe<
                        radix_common::data::scrypto::ScryptoCustomTypeKind
                    >
                {
                    const TYPE_ID: ::sbor::RustTypeId = ::sbor::RustTypeId::novel_with_code(
                        "Thing",
                        &[<T>::TYPE_ID,],
                        &#code_hash
                    );
                    fn type_data() -> ::sbor::TypeData<radix_common::data::scrypto::ScryptoCustomTypeKind, ::sbor::RustTypeId> {
                        ::sbor::TypeData::struct_with_named_fields(
                            "Thing",
                            ::sbor::rust::vec![
                                ("field", <T as ::sbor::Describe<radix_common::data::scrypto::ScryptoCustomTypeKind >>::TYPE_ID),
                            ],
                        )
                    }
                    fn add_all_dependencies(aggregator: &mut ::sbor::TypeAggregator<radix_common::data::scrypto::ScryptoCustomTypeKind >) {
                        aggregator.add_child_type_and_descendents::<T>();
                    }
                }
            },
        );
    }

    #[test]
    fn test_describe_enum() {
        let input = TokenStream::from_str("enum MyEnum<T: Bound> { A { named: T }, B(String), C }")
            .unwrap();
        let code_hash = get_code_hash_const_array_token_stream(&input);
        let output = handle_scrypto_describe(input).unwrap();

        assert_code_eq(
            output,
            quote! {
                impl<T: Bound>
                    ::sbor::Describe<radix_common::data::scrypto::ScryptoCustomTypeKind > for MyEnum<T>
                where
                    T: ::sbor::Describe<radix_common::data::scrypto::ScryptoCustomTypeKind >
                {
                    const TYPE_ID: ::sbor::RustTypeId = ::sbor::RustTypeId::novel_with_code(
                        "MyEnum",
                        &[<T>::TYPE_ID,],
                        &#code_hash
                    );
                    fn type_data() -> ::sbor::TypeData<radix_common::data::scrypto::ScryptoCustomTypeKind, ::sbor::RustTypeId> {
                        use ::sbor::rust::borrow::ToOwned;
                        ::sbor::TypeData::enum_variants(
                            "MyEnum",
                            :: sbor :: rust :: prelude :: indexmap ! [
                                0u8 => :: sbor :: TypeData :: struct_with_named_fields ("A", :: sbor :: rust :: vec ! [("named", < T as :: sbor :: Describe < radix_common::data::scrypto::ScryptoCustomTypeKind >> :: TYPE_ID) ,] ,) ,
                                1u8 => :: sbor :: TypeData :: struct_with_unnamed_fields ("B", :: sbor :: rust :: vec ! [< String as :: sbor :: Describe < radix_common::data::scrypto::ScryptoCustomTypeKind >> :: TYPE_ID ,] ,) ,
                                2u8 => :: sbor :: TypeData :: struct_with_unit_fields ("C") ,
                            ],
                        )
                    }
                    fn add_all_dependencies(aggregator: &mut ::sbor::TypeAggregator<radix_common::data::scrypto::ScryptoCustomTypeKind >) {
                        aggregator.add_child_type_and_descendents::<T>();
                        aggregator.add_child_type_and_descendents::<String>();
                    }
                }
            },
        );
    }
}