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
// Copyright (C) Use Ink (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 crateEnvironment;
/// Stores the used host environment type of the ink! smart contract.
///
/// # Note
///
/// The used host environment can be altered using the `env` configuration
/// parameter in the `#[ink::contract]` parameters. For example if the user
/// wanted to use an environment type definition called `MyEnvironment` they
/// issue the ink! smart contract as follows:
///
/// ```no_compile
/// #[ink::contract(env = MyEnvironment)]
/// ```
///
/// # Usage: Default Environment
///
/// ```
/// #[ink::contract]
/// pub mod contract {
/// #[ink(storage)]
/// pub struct Contract {}
///
/// impl Contract {
/// #[ink(constructor)]
/// pub fn constructor() -> Self {
/// Self {}
/// }
///
/// #[ink(message)]
/// pub fn message(&self) {}
/// }
/// }
///
/// use contract::Contract;
///
/// # use ink::env::ContractEnv;
/// # use ink::codegen::utils::IsSameType;
///
/// // The following line only compiles successfully if both
/// // `ink_env::DefaultEnvironment` and `<Contract as ContractEnv>::Env`
/// // are of the same type.
/// const _: IsSameType<<Contract as ContractEnv>::Env> =
/// <IsSameType<ink_env::DefaultEnvironment>>::new();
/// ```
///
/// # Usage: Custom Environment
///
/// ```
/// # use ink_env::{Environment, DefaultEnvironment};
/// #[derive(Clone)]
/// pub struct CustomEnvironment {}
///
/// impl Environment for CustomEnvironment {
/// const MAX_EVENT_TOPICS: usize = 4;
///
/// type AccountId = <DefaultEnvironment as Environment>::AccountId;
/// type Balance = u64;
/// type Hash = <DefaultEnvironment as Environment>::Hash;
/// type BlockNumber = u32;
/// type Timestamp = u64;
/// type ChainExtension = <DefaultEnvironment as Environment>::ChainExtension;
/// type EventRecord = <DefaultEnvironment as Environment>::EventRecord;
/// }
///
/// #[ink::contract(env = super::CustomEnvironment)]
/// pub mod contract {
/// #[ink(storage)]
/// pub struct Contract {}
///
/// impl Contract {
/// #[ink(constructor)]
/// pub fn constructor() -> Self {
/// Self {}
/// }
///
/// #[ink(message)]
/// pub fn message(&self) {}
/// }
/// }
///
/// use contract::Contract;
/// # use ink::env::ContractEnv;
/// # use ink::codegen::utils::IsSameType;
///
/// // The following line only compiles successfully if both
/// // `CustomEnvironment` and `<Contract as ContractEnv>::Env`
/// // are of the same type.
/// const _: IsSameType<<Contract as ContractEnv>::Env> =
/// <IsSameType<CustomEnvironment>>::new();
///
/// fn main() {}
/// ```
/// Refers to the generated ink! smart contract reference type.
///
/// # Note
///
/// Given an ink! storage struct with identifier `Contract` the ink! codegen produces
/// the ink! root type `Contract` and the ink! reference type `ContractRef`.
///
/// This trait exists so that users can avoid using a generated identifier to refer to
/// the generated reference type of the ink! smart contract.
///
/// # Usage
///
/// ```
/// #[ink::contract]
/// pub mod contract {
/// #[ink(storage)]
/// pub struct Contract {}
///
/// impl Contract {
/// #[ink(constructor)]
/// pub fn constructor() -> Self {
/// Self {}
/// }
///
/// #[ink(message)]
/// pub fn message(&self) {}
/// }
/// }
///
/// use contract::{
/// Contract,
/// ContractRef,
/// };
/// # use ink::codegen::utils::IsSameType;
/// # use ink::env::ContractReference;
///
/// // The following line only compiles successfully if both
/// // `ContractReference` and `<Contract as ContractReference>::Type`
/// // are of the same type.
/// const _: IsSameType<<Contract as ContractReference>::Type> =
/// <IsSameType<ContractRef>>::new();
/// ```
/// Refers back to the original contract from the generated ink! smart contract
/// reference type.