ink_primitives/reflect/
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
15/// Stores the name of the ink! smart contract.
16///
17/// # Note
18///
19/// The name is the identifier of the `#[ink(storage)]` annotated `struct`.
20///
21/// # Usage
22///
23/// ```
24/// #[ink::contract]
25/// pub mod contract {
26///     #[ink(storage)]
27///     pub struct Contract {}
28///
29///     impl Contract {
30///         #[ink(constructor)]
31///         pub fn constructor() -> Self {
32///             Self {}
33///         }
34///
35///         #[ink(message)]
36///         pub fn message(&self) {}
37///     }
38/// }
39///
40/// use contract::Contract;
41///
42/// # use ink::reflect::ContractName;
43/// assert_eq!(<Contract as ContractName>::NAME, "Contract",);
44/// ```
45pub trait ContractName {
46    /// The name of the ink! smart contract.
47    const NAME: &'static str;
48}
ink_primitives/reflect/contract.rs

ink_primitives/reflect/
contract.rs
