ink_ir/ir/
contract.rs

1// Copyright (C) Use Ink (UK) Ltd.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use crate::{
16    ast,
17    ir,
18};
19use proc_macro2::TokenStream as TokenStream2;
20
21/// An ink! contract definition consisting of the ink! configuration and module.
22///
23/// This is the root of any ink! smart contract definition. It contains every
24/// information accessible to the ink! smart contract macros. It is also used
25/// as the root source for the ink! code generation.
26///
27/// # Example
28///
29/// ```no_compile
30/// #[ink::contract(/* optional ink! configurations */)]
31/// mod my_contract {
32///     /* ink! and Rust definitions */
33/// }
34/// ```
35pub struct Contract {
36    /// The parsed Rust inline module.
37    ///
38    /// Contains all Rust module items after parsing. Note that while parsing
39    /// the ink! module all ink! specific items are moved out of this AST based
40    /// representation.
41    item: ir::ItemMod,
42    /// The specified ink! configuration.
43    config: ir::Config,
44}
45
46impl Contract {
47    /// Creates a new ink! contract from the given ink! configuration and module
48    /// token streams.
49    ///
50    /// The ink! macro should use this constructor in order to setup ink!.
51    ///
52    /// # Note
53    ///
54    /// - The `ink_config` token stream must properly decode into [`ir::Config`].
55    /// - The `ink_module` token stream must properly decode into [`ir::ItemMod`].
56    ///
57    /// # Errors
58    ///
59    /// Returns an error if the provided token stream cannot be decoded properly
60    /// into a valid ink! configuration or ink! module respectively.
61    pub fn new(
62        ink_config: TokenStream2,
63        ink_module: TokenStream2,
64    ) -> Result<Self, syn::Error> {
65        let config = syn::parse2::<ast::AttributeArgs>(ink_config)?;
66        let module = syn::parse2::<syn::ItemMod>(ink_module)?;
67        let ink_config = ir::Config::try_from(config)?;
68        let ink_module = ir::ItemMod::try_from(module)?;
69        Ok(Self {
70            item: ink_module,
71            config: ink_config,
72        })
73    }
74
75    /// Returns the ink! inline module definition.
76    ///
77    /// # Note
78    ///
79    /// The ink! inline module definition is the module that comprises the
80    /// whole ink! smart contract, e.g.:
81    ///
82    /// ```no_compile
83    /// #[ink::contract]
84    /// mod my_contract {
85    ///     // ...definitions
86    /// }
87    /// ```
88    pub fn module(&self) -> &ir::ItemMod {
89        &self.item
90    }
91
92    /// Returns the configuration of the ink! smart contract.
93    ///
94    /// # Note
95    ///
96    /// The configuration is given via the `#[ink::contract(config))]` attribute
97    /// macro annotation itself within the `(config)` part. The available fields
98    /// are the following:
99    ///
100    /// - `types`: To specify `Environment` different from the default environment types.
101    ///
102    /// Note that we might add more configuration fields in the future if
103    /// necessary.
104    pub fn config(&self) -> &ir::Config {
105        &self.config
106    }
107}
ink_ir/ir/contract.rs

ink_ir/ir/
contract.rs
