config.rs 8.84 KB
Newer Older
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
// Copyright 2018-2020 Parity Technologies (UK) Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use crate::{
    ast,
    error::ExtError as _,
};
use core::convert::TryFrom;
use syn::spanned::Spanned;

/// The ink! configuration.
#[derive(Debug, Default, PartialEq, Eq)]
pub struct Config {
    /// If `true` enables the dynamic storage allocator
    /// facilities and code generation of the ink! smart
    /// contract. Does incur some overhead. The default is
    /// `true`.
    storage_alloc: Option<bool>,
    /// If `true` compiles this ink! smart contract always as
    /// if it was a dependency of another smart contract.
    /// This configuration is mainly needed for testing and
    /// the default is `false`.
    as_dependency: Option<bool>,
    /// The environmental types definition.
    ///
    /// This must be a type that implements `ink_core::env::EnvTypes` and can
    /// be used to change the underlying environmental types of an ink! smart
    /// contract.
    env_types: Option<EnvTypes>,
}

/// Return an error to notify about duplicate ink! config arguments.
fn duplicate_config_err<F, S>(fst: F, snd: S, name: &str) -> syn::Error
where
    F: Spanned,
    S: Spanned,
{
    format_err!(
        snd.span(),
        "encountered duplicate ink! `{}` config argument",
        name,
    )
    .into_combine(format_err!(
        fst.span(),
        "first `{}` config argument here",
        name
    ))
}

impl TryFrom<ast::AttributeArgs> for Config {
    type Error = syn::Error;

    fn try_from(args: ast::AttributeArgs) -> Result<Self, Self::Error> {
        let mut storage_alloc: Option<(bool, ast::MetaNameValue)> = None;
        let mut as_dependency: Option<(bool, ast::MetaNameValue)> = None;
        let mut env_types: Option<(EnvTypes, ast::MetaNameValue)> = None;
        for arg in args.into_iter() {
            if arg.name.is_ident("storage_alloc") {
                if let Some((_, ast)) = storage_alloc {
                    return Err(duplicate_config_err(ast, arg, "storage_allocator"))
                }
                if let ast::PathOrLit::Lit(syn::Lit::Bool(lit_bool)) = &arg.value {
                    storage_alloc = Some((lit_bool.value, arg))
                } else {
                    return Err(format_err_spanned!(
                        arg,
                        "expected a bool literal for `storage_allocator` ink! config argument",
                    ))
                }
            } else if arg.name.is_ident("compile_as_dependency") {
                if let Some((_, ast)) = as_dependency {
                    return Err(duplicate_config_err(ast, arg, "compile_as_dependency"))
                }
                if let ast::PathOrLit::Lit(syn::Lit::Bool(lit_bool)) = &arg.value {
                    as_dependency = Some((lit_bool.value, arg))
                } else {
                    return Err(format_err_spanned!(
                        arg,
                        "expected a bool literal for `compile_as_dependency` ink! config argument",
                    ))
                }
            } else if arg.name.is_ident("env_types") {
                if let Some((_, ast)) = env_types {
                    return Err(duplicate_config_err(ast, arg, "env_types"))
                }
                if let ast::PathOrLit::Path(path) = &arg.value {
                    env_types = Some((EnvTypes { path: path.clone() }, arg))
                } else {
                    return Err(format_err_spanned!(
                        arg,
                        "expected a path for `env_types` ink! config argument",
                    ))
                }
            } else {
                return Err(format_err_spanned!(
                    arg,
                    "encountered unknown or unsupported ink! config argument",
                ))
            }
        }
        Ok(Config {
            storage_alloc: storage_alloc.map(|(storage_alloc, _)| storage_alloc),
            as_dependency: as_dependency.map(|(as_dependency, _)| as_dependency),
            env_types: env_types.map(|(env_types, _)| env_types),
        })
    }
}

impl Config {
    /// Returns the environmental types definition if specified.
    /// Otherwise returns the default environmental types definition provided
    /// by ink!.
    pub fn env_types(&self) -> syn::Path {
        self.env_types
            .as_ref()
            .map(|env_types| &env_types.path)
            .cloned()
            .unwrap_or_else(|| EnvTypes::default().path)
    }

    /// Returns `true` if the dynamic storage allocator facilities are enabled
    /// for the ink! smart contract, `false` otherwise.
    ///
    /// If nothing has been specified returns the default which is `true`.
    pub fn is_storage_allocator_enabled(&self) -> bool {
        self.storage_alloc.unwrap_or(true)
    }

    /// Return `true` if this ink! smart contract shall always be compiled as
    /// if it was a dependency of another smart contract, returns `false`
    /// otherwise.
    ///
    /// If nothing has been specified returns the default which is `false`.
    pub fn is_compile_as_dependency_enabled(&self) -> bool {
        self.as_dependency.unwrap_or(false)
    }
}

/// The environmental types definition.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct EnvTypes {
    /// The underlying Rust type.
    pub path: syn::Path,
}

impl Default for EnvTypes {
    fn default() -> Self {
        Self {
            path: syn::parse_quote! { ::ink_core::env::DefaultEnvTypes },
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    /// Asserts that the given input config attribute argument are converted
    /// into the expected ink! configuration or yields the expected error message.
    fn assert_try_from(
        input: ast::AttributeArgs,
        expected: Result<Config, &'static str>,
    ) {
        assert_eq!(
            <Config as TryFrom<ast::AttributeArgs>>::try_from(input)
                .map_err(|err| err.to_string()),
            expected.map_err(ToString::to_string),
        );
    }

    #[test]
    fn empty_config_works() {
        assert_try_from(syn::parse_quote! {}, Ok(Config::default()))
    }

    #[test]
    fn storage_alloc_works() {
        assert_try_from(
            syn::parse_quote! {
                storage_alloc = true
            },
            Ok(Config {
                storage_alloc: Some(true),
                as_dependency: None,
                env_types: None,
            }),
        )
    }

    #[test]
    fn storage_alloc_invalid_value_fails() {
        assert_try_from(
            syn::parse_quote! { storage_alloc = "invalid" },
            Err("expected a bool literal for `storage_allocator` ink! config argument"),
        )
    }

    #[test]
    fn as_dependency_works() {
        assert_try_from(
            syn::parse_quote! {
                compile_as_dependency = false
            },
            Ok(Config {
                storage_alloc: None,
                as_dependency: Some(false),
                env_types: None,
            }),
        )
    }

    #[test]
    fn as_dependency_invalid_value_fails() {
        assert_try_from(
            syn::parse_quote! { compile_as_dependency = "invalid" },
            Err(
                "expected a bool literal for `compile_as_dependency` ink! config argument"
            )
        )
    }

    #[test]
    fn env_types_works() {
        assert_try_from(
            syn::parse_quote! {
                env_types = ::my::env::Types
            },
            Ok(Config {
                storage_alloc: None,
                as_dependency: None,
                env_types: Some(EnvTypes {
                    path: syn::parse_quote! { ::my::env::Types },
                }),
            }),
        )
    }

    #[test]
    fn env_types_invalid_value_fails() {
        assert_try_from(
            syn::parse_quote! { env_types = "invalid" },
            Err("expected a path for `env_types` ink! config argument"),
        );
    }

    #[test]
    fn unknown_arg_fails() {
        assert_try_from(
            syn::parse_quote! { unknown = argument },
            Err("encountered unknown or unsupported ink! config argument"),
        );
    }

    #[test]
    fn duplicate_args_fails() {
        assert_try_from(
            syn::parse_quote! {
                env_types = ::my::env::Types,
                env_types = ::my::other::env::Types,
            },
            Err("encountered duplicate ink! `env_types` config argument"),
        );
    }
}