stylus-proc 0.10.5

Procedural macros for stylus-sdk
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

// Copyright 2024, Offchain Labs, Inc.
// For licensing, see https://github.com/OffchainLabs/stylus-sdk-rs/blob/main/licenses/COPYRIGHT.md

//! Constants for referencing imports within generated code.
//!
//! These constants use a fully qualified path with dependencies nested within [`stylus_sdk`] to
//! ensure compatibility.
//!
//! Usage:
//! ```compile_fail
//! use crate::imports::alloy_primitives::Address;
//!
//! let _ = quote! {
//!     let addr = #Address::random();
//! };
//! ```

#![allow(non_upper_case_globals)]

use proc_macro2::TokenStream;
use quote::ToTokens;

pub mod alloy_primitives {
    use crate::imports::ConstPath;

    pub const Address: ConstPath = ConstPath("stylus_sdk::alloy_primitives::Address");
}

pub mod alloy_sol_types {
    use crate::imports::ConstPath;

    pub const SolType: ConstPath = ConstPath("stylus_sdk::alloy_sol_types::SolType");
    pub const SolValue: ConstPath = ConstPath("stylus_sdk::alloy_sol_types::SolValue");

    pub mod private {
        use crate::imports::ConstPath;

        pub const SolTypeValue: ConstPath =
            ConstPath("stylus_sdk::alloy_sol_types::private::SolTypeValue");
    }

    pub mod sol_data {
        use syn::parse::Parse;

        use crate::imports::ConstPath;

        pub const Address: ConstPath = ConstPath("stylus_sdk::alloy_sol_types::sol_data::Address");

        /// Build path or type to member of the `alloy_sol_types::sol_data` module.
        ///
        /// This should not be used on user input, as parsing should be expected to succeed.
        pub fn join<T: Parse>(name: &str) -> T {
            syn::parse_str(&format!("stylus_sdk::alloy_sol_types::sol_data::{name}")).unwrap()
        }
    }
}

pub mod stylus_sdk {
    pub mod abi {
        use crate::imports::ConstPath;

        pub const AbiType: ConstPath = ConstPath("stylus_sdk::abi::AbiType");
        pub const Router: ConstPath = ConstPath("stylus_sdk::abi::Router");
        pub const ConstString: ConstPath = ConstPath("stylus_sdk::abi::ConstString");

        #[cfg(feature = "export-abi")]
        pub mod export {
            pub mod internal {
                use crate::imports::ConstPath;

                pub const InnerType: ConstPath =
                    ConstPath("stylus_sdk::abi::export::internal::InnerType");
                pub const InnerTypes: ConstPath =
                    ConstPath("stylus_sdk::abi::export::internal::InnerTypes");
            }
        }
    }
}

/// Definition of a fully-qualified path for generated code.
pub struct ConstPath(&'static str);

impl ConstPath {
    /// Interpret the path as a [`syn::Type`].
    pub fn as_type(&self) -> syn::Type {
        syn::parse_str(self.0).unwrap()
    }
}

impl ToTokens for ConstPath {
    fn to_tokens(&self, tokens: &mut TokenStream) {
        let path: syn::Path = syn::parse_str(self.0).unwrap();
        path.to_tokens(tokens);
    }
}

#[cfg(test)]
mod tests {
    use syn::parse_quote;

    #[test]
    fn test_const_path() {
        assert_eq!(
            super::alloy_primitives::Address.as_type(),
            parse_quote!(stylus_sdk::alloy_primitives::Address),
        );
    }
}