gsdk_codegen/
lib.rs

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
// This file is part of Gear.
//
// Copyright (C) 2021-2024 Gear Technologies Inc.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

use proc_macro::TokenStream;
use syn::ItemFn;

mod storage;

/// Generate storage query for the latest state for functions that
/// query storage at specified block.
///
/// # Note
///
/// - the docs must be end with `at specified block.`
/// - the function name must be end with `_at`.
/// - the last argument must be `Option<H256>`.
///
/// # Example
///
/// ```ignore
/// /// Imdocs at specified block.
/// #[storage_fetch]
/// pub fn query_storage_at(addr: Address, block_hash: Option<H256>) -> R {
///     // ...
/// }
/// ```
///
/// will generate functions
///
/// ```ignore
/// /// Imdocs at specified block.
/// pub fn query_storage_at(addr: Address, block_hash: impl Into<Option<H256>>) -> R {
///     // ...
/// }
///
/// /// Imdocs.
/// pub fn query_storage(addr: Address) -> R {
///     query_storage_at(addr, None)
/// }
/// ```
#[proc_macro_attribute]
pub fn storage_fetch(_: TokenStream, item: TokenStream) -> TokenStream {
    let raw: ItemFn = syn::parse_macro_input!(item);
    storage::StorageQueryBuilder::from(raw).build()
}