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 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
// Copyright 2018-2021 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::{ call::{ utils::ReturnType, CallParams, CreateParams, }, hash::{ CryptoHash, HashOutput, }, topics::Topics, Environment, Result, }; use ink_primitives::Key; /// The flags to indicate further information about the end of a contract execution. pub struct ReturnFlags { value: u32, } impl Default for ReturnFlags { fn default() -> Self { Self { value: 0 } } } impl ReturnFlags { /// Sets the bit to indicate that the execution is going to be reverted. pub fn set_reverted(mut self, has_reverted: bool) -> Self { match has_reverted { true => self.value |= has_reverted as u32, false => self.value &= !has_reverted as u32, } self } /// Returns the underlying `u32` representation. pub(crate) fn into_u32(self) -> u32 { self.value } } /// Environmental contract functionality that does not require `Environment`. pub trait EnvBackend { /// Writes the value to the contract storage under the given key. fn set_contract_storage<V>(&mut self, key: &Key, value: &V) where V: scale::Encode; /// Returns the value stored under the given key in the contract's storage if any. /// /// # Errors /// /// - If the decoding of the typed value failed fn get_contract_storage<R>(&mut self, key: &Key) -> Result<Option<R>> where R: scale::Decode; /// Clears the contract's storage key entry. fn clear_contract_storage(&mut self, key: &Key); /// Returns the execution input to the executed contract and decodes it as `T`. /// /// # Note /// /// - The input is the 4-bytes selector followed by the arguments /// of the called function in their SCALE encoded representation. /// - No prior interaction with the environment must take place before /// calling this procedure. /// /// # Usage /// /// Normally contracts define their own `enum` dispatch types respective /// to their exported contructors and messages that implement `scale::Decode` /// according to the contructors or messages selectors and their arguments. /// These `enum` dispatch types are then given to this procedure as the `T`. /// /// When using ink! users do not have to construct those enum dispatch types /// themselves as they are normally generated by the ink! code generation /// automatically. /// /// # Errors /// /// If the given `T` cannot be properly decoded from the expected input. fn decode_input<T>(&mut self) -> Result<T> where T: scale::Decode; /// Returns the value back to the caller of the executed contract. /// /// # Note /// /// Calling this method will end contract execution immediately. /// It will return the given return value back to its caller. /// /// The `flags` parameter can be used to revert the state changes of the /// entire execution if necessary. fn return_value<R>(&mut self, flags: ReturnFlags, return_value: &R) -> ! where R: scale::Encode; /// Prints the given contents to the console log. fn println(&mut self, content: &str); /// Conducts the crypto hash of the given input and stores the result in `output`. fn hash_bytes<H>(&mut self, input: &[u8], output: &mut <H as HashOutput>::Type) where H: CryptoHash; /// Conducts the crypto hash of the given encoded input and stores the result in `output`. fn hash_encoded<H, T>(&mut self, input: &T, output: &mut <H as HashOutput>::Type) where H: CryptoHash, T: scale::Encode; /// Low-level interface to call a chain extension method. /// /// Returns the output of the chain extension of the specified type. /// /// # Errors /// /// - If the chain extension with the given ID does not exist. /// - If the inputs had an unexpected encoding. /// - If the output could not be properly decoded. /// - If some extension specific condition has not been met. /// /// # Dev. Note /// /// A valid implementation applies the `status_to_result` closure on /// the status code returned by the actual call to the chain extension /// method. /// Only if the closure finds that the given status code indicates a /// successful call to the chain extension method is the resulting /// output buffer passed to the `decode_to_result` closure, in order to /// drive the decoding and error management process from the outside. fn call_chain_extension<I, T, E, ErrorCode, F, D>( &mut self, func_id: u32, input: &I, status_to_result: F, decode_to_result: D, ) -> ::core::result::Result<T, E> where I: scale::Encode, T: scale::Decode, E: From<ErrorCode>, F: FnOnce(u32) -> ::core::result::Result<(), ErrorCode>, D: FnOnce(&[u8]) -> ::core::result::Result<T, E>; } /// Environmental contract functionality. pub trait TypedEnvBackend: EnvBackend { /// Returns the address of the caller of the executed contract. /// /// # Note /// /// For more details visit: [`caller`][`crate::caller`] fn caller<T: Environment>(&mut self) -> Result<T::AccountId>; /// Returns the transferred balance for the contract execution. /// /// # Note /// /// For more details visit: [`transferred_balance`][`crate::transferred_balance`] fn transferred_balance<T: Environment>(&mut self) -> Result<T::Balance>; /// Returns the price for the specified amount of gas. /// /// # Note /// /// For more details visit: [`weight_to_fee`][`crate::weight_to_fee`] fn weight_to_fee<T: Environment>(&mut self, gas: u64) -> Result<T::Balance>; /// Returns the amount of gas left for the contract execution. /// /// # Note /// /// For more details visit: [`gas_left`][`crate::gas_left`] fn gas_left<T: Environment>(&mut self) -> Result<T::Balance>; /// Returns the timestamp of the current block. /// /// # Note /// /// For more details visit: [`block_timestamp`][`crate::block_timestamp`] fn block_timestamp<T: Environment>(&mut self) -> Result<T::Timestamp>; /// Returns the address of the executed contract. /// /// # Note /// /// For more details visit: [`account_id`][`crate::account_id`] fn account_id<T: Environment>(&mut self) -> Result<T::AccountId>; /// Returns the balance of the executed contract. /// /// # Note /// /// For more details visit: [`balance`][`crate::balance`] fn balance<T: Environment>(&mut self) -> Result<T::Balance>; /// Returns the current rent allowance for the executed contract. /// /// # Note /// /// For more details visit: [`rent_allowance`][`crate::rent_allowance`] fn rent_allowance<T: Environment>(&mut self) -> Result<T::Balance>; /// Returns the current block number. /// /// # Note /// /// For more details visit: [`block_number`][`crate::block_number`] fn block_number<T: Environment>(&mut self) -> Result<T::BlockNumber>; /// Returns the minimum balance that is required for creating an account. /// /// # Note /// /// For more details visit: [`minimum_balance`][`crate::minimum_balance`] fn minimum_balance<T: Environment>(&mut self) -> Result<T::Balance>; /// Returns the tombstone deposit of the contract chain. /// /// # Note /// /// For more details visit: [`tombstone_deposit`][`crate::tombstone_deposit`] fn tombstone_deposit<T: Environment>(&mut self) -> Result<T::Balance>; /// Emits an event with the given event data. /// /// # Note /// /// For more details visit: [`emit_event`][`crate::emit_event`] fn emit_event<T, Event>(&mut self, event: Event) where T: Environment, Event: Topics + scale::Encode; /// Sets the rent allowance of the executed contract to the new value. /// /// # Note /// /// For more details visit: [`set_rent_allowance`][`crate::set_rent_allowance`] fn set_rent_allowance<T>(&mut self, new_value: T::Balance) where T: Environment; /// Invokes a contract message. /// /// # Note /// /// For more details visit: [`invoke_contract`][`crate::invoke_contract`] fn invoke_contract<T, Args>( &mut self, call_data: &CallParams<T, Args, ()>, ) -> Result<()> where T: Environment, Args: scale::Encode; /// Evaluates a contract message and returns its result. /// /// # Note /// /// For more details visit: [`eval_contract`][`crate::eval_contract`] fn eval_contract<T, Args, R>( &mut self, call_data: &CallParams<T, Args, ReturnType<R>>, ) -> Result<R> where T: Environment, Args: scale::Encode, R: scale::Decode; /// Instantiates another contract. /// /// # Note /// /// For more details visit: [`instantiate_contract`][`crate::instantiate_contract`] fn instantiate_contract<T, Args, Salt, C>( &mut self, params: &CreateParams<T, Args, Salt, C>, ) -> Result<T::AccountId> where T: Environment, Args: scale::Encode, Salt: AsRef<[u8]>; /// Restores a smart contract tombstone. /// /// # Note /// /// For more details visit: [`restore_contract`][`crate::restore_contract`] fn restore_contract<T>( &mut self, account_id: T::AccountId, code_hash: T::Hash, rent_allowance: T::Balance, filtered_keys: &[Key], ) where T: Environment; /// Terminates a smart contract. /// /// # Note /// /// For more details visit: [`terminate_contract`][`crate::terminate_contract`] fn terminate_contract<T>(&mut self, beneficiary: T::AccountId) -> ! where T: Environment; /// Transfers value from the contract to the destination account ID. /// /// # Note /// /// For more details visit: [`transfer`][`crate::transfer`] fn transfer<T>(&mut self, destination: T::AccountId, value: T::Balance) -> Result<()> where T: Environment; /// Returns a random hash seed. /// /// # Note /// /// For more details visit: [`random`][`crate::random`] fn random<T>(&mut self, subject: &[u8]) -> Result<T::Hash> where T: Environment; }