aptos-sdk-macros 0.3.0

Procedural macros for type-safe Aptos contract bindings
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

//! ABI type definitions for parsing Move module ABIs.

use serde::{Deserialize, Serialize};

/// Move module ABI.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub(crate) struct MoveModuleABI {
    /// The module address.
    pub address: String,
    /// The module name.
    pub name: String,
    /// Exposed functions.
    #[serde(default)]
    pub exposed_functions: Vec<MoveFunction>,
    /// Structs defined in the module.
    #[serde(default)]
    pub structs: Vec<MoveStructDef>,
}

/// A function defined in a Move module.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub(crate) struct MoveFunction {
    /// Function name.
    pub name: String,
    /// Visibility.
    #[serde(default)]
    pub visibility: String,
    /// Whether this is an entry function.
    #[serde(default)]
    pub is_entry: bool,
    /// Whether this is a view function.
    #[serde(default)]
    pub is_view: bool,
    /// Generic type parameters.
    #[serde(default)]
    pub generic_type_params: Vec<MoveFunctionGenericTypeParam>,
    /// Function parameters.
    #[serde(default)]
    pub params: Vec<String>,
    /// Return types.
    #[serde(default, rename = "return")]
    pub returns: Vec<String>,
}

/// Generic type parameter in a function.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub(crate) struct MoveFunctionGenericTypeParam {
    /// Constraints on the type parameter.
    #[serde(default)]
    pub constraints: Vec<String>,
}

/// A struct defined in a Move module.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub(crate) struct MoveStructDef {
    /// Struct name.
    pub name: String,
    /// Whether this is a native struct.
    #[serde(default)]
    pub is_native: bool,
    /// Abilities of the struct.
    #[serde(default)]
    pub abilities: Vec<String>,
    /// Generic type parameters.
    #[serde(default)]
    pub generic_type_params: Vec<MoveStructGenericTypeParam>,
    /// Fields of the struct.
    #[serde(default)]
    pub fields: Vec<MoveStructField>,
}

/// Generic type parameter in a struct.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub(crate) struct MoveStructGenericTypeParam {
    /// Constraints on the type parameter.
    #[serde(default)]
    pub constraints: Vec<String>,
}

/// A field in a Move struct.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub(crate) struct MoveStructField {
    /// Field name.
    pub name: String,
    /// Field type.
    #[serde(rename = "type")]
    pub typ: String,
}