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 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
// Copyright (C) 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::{
Call,
CallParams,
CallV1,
ConstructorReturnType,
CreateParams,
DelegateCall,
FromAccountId,
LimitParamsV1,
LimitParamsV2,
},
event::Event,
hash::{
CryptoHash,
HashOutput,
},
Environment,
Result,
};
use ink_storage_traits::Storable;
pub use pallet_contracts_uapi::ReturnFlags;
/// Environmental contract functionality that does not require `Environment`.
pub trait EnvBackend {
/// Writes the value to the contract storage under the given storage key.
///
/// Returns the size of the pre-existing value at the specified key if any.
fn set_contract_storage<K, V>(&mut self, key: &K, value: &V) -> Option<u32>
where
K: scale::Encode,
V: Storable;
/// Returns the value stored under the given storage key in the contract's storage if
/// any.
///
/// # Errors
///
/// - If the decoding of the typed value failed
fn get_contract_storage<K, R>(&mut self, key: &K) -> Result<Option<R>>
where
K: scale::Encode,
R: Storable;
/// Removes the `value` at `key`, returning the previous `value` at `key` from storage
/// if any.
///
/// # Errors
///
/// - If the decoding of the typed value failed
fn take_contract_storage<K, R>(&mut self, key: &K) -> Result<Option<R>>
where
K: scale::Encode,
R: Storable;
/// Returns the size of a value stored under the given storage key is returned if any.
fn contains_contract_storage<K>(&mut self, key: &K) -> Option<u32>
where
K: scale::Encode;
/// Clears the contract's storage key entry under the given storage key.
///
/// Returns the size of the previously stored value at the specified key if any.
fn clear_contract_storage<K>(&mut self, key: &K) -> Option<u32>
where
K: scale::Encode;
/// 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 constructors and messages that implement `scale::Decode`
/// according to the constructors 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;
/// Emit a custom debug message.
///
/// The message is appended to the debug buffer which is then supplied to the calling
/// RPC client. This buffer is also printed as a debug message to the node console
/// if the `debug` log level is enabled for the `runtime::contracts` target.
///
/// If debug message recording is disabled in the contracts pallet, which is always
/// the case when the code is executing on-chain, then this will have no effect.
fn debug_message(&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;
/// Recovers the compressed ECDSA public key for given `signature` and `message_hash`,
/// and stores the result in `output`.
fn ecdsa_recover(
&mut self,
signature: &[u8; 65],
message_hash: &[u8; 32],
output: &mut [u8; 33],
) -> Result<()>;
/// Retrieves an Ethereum address from the ECDSA compressed `pubkey`
/// and stores the result in `output`.
fn ecdsa_to_eth_address(
&mut self,
pubkey: &[u8; 33],
output: &mut [u8; 20],
) -> Result<()>;
/// Verifies a sr25519 signature.
///
/// # Errors
///
/// - If the signature verification failed.
///
/// **WARNING**: this function is from the [unstable interface](https://github.com/paritytech/substrate/tree/master/frame/contracts#unstable-interfaces),
/// which is unsafe and normally is not available on production chains.
fn sr25519_verify(
&mut self,
signature: &[u8; 64],
message: &[u8],
pub_key: &[u8; 32],
) -> Result<()>;
/// 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.
///
/// # Developer 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,
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>;
/// Sets a new code hash for the current contract.
///
/// This effectively replaces the code which is executed for this contract address.
///
/// # Errors
///
/// - If the supplied `code_hash` cannot be found on-chain.
fn set_code_hash(&mut self, code_hash: &[u8]) -> Result<()>;
}
/// 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<E: Environment>(&mut self) -> E::AccountId;
/// Returns the transferred value for the contract execution.
///
/// # Note
///
/// For more details visit: [`transferred_value`][`crate::transferred_value`]
fn transferred_value<E: Environment>(&mut self) -> E::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<E: Environment>(&mut self, gas: u64) -> E::Balance;
/// Returns the amount of gas left for the contract execution.
///
/// # Note
///
/// For more details visit: [`gas_left`][`crate::gas_left`]
fn gas_left<E: Environment>(&mut self) -> u64;
/// Returns the timestamp of the current block.
///
/// # Note
///
/// For more details visit: [`block_timestamp`][`crate::block_timestamp`]
fn block_timestamp<E: Environment>(&mut self) -> E::Timestamp;
/// Returns the address of the executed contract.
///
/// # Note
///
/// For more details visit: [`account_id`][`crate::account_id`]
fn account_id<E: Environment>(&mut self) -> E::AccountId;
/// Returns the balance of the executed contract.
///
/// # Note
///
/// For more details visit: [`balance`][`crate::balance`]
fn balance<E: Environment>(&mut self) -> E::Balance;
/// Returns the current block number.
///
/// # Note
///
/// For more details visit: [`block_number`][`crate::block_number`]
fn block_number<E: Environment>(&mut self) -> E::BlockNumber;
/// Returns the minimum balance that is required for creating an account
/// (i.e. the chain's existential deposit).
///
/// # Note
///
/// For more details visit: [`minimum_balance`][`crate::minimum_balance`]
fn minimum_balance<E: Environment>(&mut self) -> E::Balance;
/// Emits an event with the given event data.
///
/// # Note
///
/// For more details visit: [`emit_event`][`crate::emit_event`]
fn emit_event<E, Evt>(&mut self, event: Evt)
where
E: Environment,
Evt: Event;
/// Invokes a contract message and returns its result.
///
/// # Note
///
/// **This will call into the original `call` host function.**
///
/// For more details visit: [`invoke_contract`][`crate::invoke_contract_v1`]
fn invoke_contract_v1<E, Args, R>(
&mut self,
call_data: &CallParams<E, CallV1<E>, Args, R>,
) -> Result<ink_primitives::MessageResult<R>>
where
E: Environment,
Args: scale::Encode,
R: scale::Decode;
/// Invokes a contract message and returns its result.
///
/// # Note
///
/// **This will call into the latest `call_v2` host function.**
///
/// For more details visit: [`invoke_contract`][`crate::invoke_contract`]
fn invoke_contract<E, Args, R>(
&mut self,
call_data: &CallParams<E, Call<E>, Args, R>,
) -> Result<ink_primitives::MessageResult<R>>
where
E: Environment,
Args: scale::Encode,
R: scale::Decode;
/// Invokes a contract message via delegate call and returns its result.
///
/// # Note
///
/// For more details visit:
/// [`invoke_contract_delegate`][`crate::invoke_contract_delegate`]
fn invoke_contract_delegate<E, Args, R>(
&mut self,
call_data: &CallParams<E, DelegateCall<E>, Args, R>,
) -> Result<ink_primitives::MessageResult<R>>
where
E: Environment,
Args: scale::Encode,
R: scale::Decode;
/// Instantiates another contract.
///
/// # Note
///
/// For more details visit: [`instantiate_contract`][`crate::instantiate_contract`]
fn instantiate_contract<E, ContractRef, Args, Salt, R>(
&mut self,
params: &CreateParams<E, ContractRef, LimitParamsV2<E>, Args, Salt, R>,
) -> Result<
ink_primitives::ConstructorResult<
<R as ConstructorReturnType<ContractRef>>::Output,
>,
>
where
E: Environment,
ContractRef: FromAccountId<E>,
Args: scale::Encode,
Salt: AsRef<[u8]>,
R: ConstructorReturnType<ContractRef>;
fn instantiate_contract_v1<E, ContractRef, Args, Salt, R>(
&mut self,
params: &CreateParams<E, ContractRef, LimitParamsV1, Args, Salt, R>,
) -> Result<
ink_primitives::ConstructorResult<
<R as ConstructorReturnType<ContractRef>>::Output,
>,
>
where
E: Environment,
ContractRef: FromAccountId<E>,
Args: scale::Encode,
Salt: AsRef<[u8]>,
R: ConstructorReturnType<ContractRef>;
/// Terminates a smart contract.
///
/// # Note
///
/// For more details visit: [`terminate_contract`][`crate::terminate_contract`]
fn terminate_contract<E>(&mut self, beneficiary: E::AccountId) -> !
where
E: Environment;
/// Transfers value from the contract to the destination account ID.
///
/// # Note
///
/// For more details visit: [`transfer`][`crate::transfer`]
fn transfer<E>(&mut self, destination: E::AccountId, value: E::Balance) -> Result<()>
where
E: Environment;
/// Checks whether a specified account belongs to a contract.
///
/// # Note
///
/// For more details visit: [`is_contract`][`crate::is_contract`]
#[allow(clippy::wrong_self_convention)]
fn is_contract<E>(&mut self, account: &E::AccountId) -> bool
where
E: Environment;
/// Checks whether the caller of the current contract is the origin of the whole call
/// stack.
///
/// # Note
///
/// For more details visit: [`caller_is_origin`][`crate::caller_is_origin`]
fn caller_is_origin<E>(&mut self) -> bool
where
E: Environment;
/// Retrieves the code hash of the contract at the given `account` id.
///
/// # Note
///
/// For more details visit: [`code_hash`][`crate::code_hash`]
fn code_hash<E>(&mut self, account: &E::AccountId) -> Result<E::Hash>
where
E: Environment;
/// Retrieves the code hash of the currently executing contract.
///
/// # Note
///
/// For more details visit: [`own_code_hash`][`crate::own_code_hash`]
fn own_code_hash<E>(&mut self) -> Result<E::Hash>
where
E: Environment;
fn call_runtime<E, Call>(&mut self, call: &Call) -> Result<()>
where
E: Environment,
Call: scale::Encode;
/// Adds a new delegate dependency lock to the contract.
///
/// # Note
///
/// For more details visit:
/// [`lock_delegate_dependency`][`crate::lock_delegate_dependency`]
fn lock_delegate_dependency<E>(&mut self, code_hash: &E::Hash)
where
E: Environment;
/// Unlocks the delegate dependency from the contract.
///
/// # Note
///
/// For more details visit:
/// [`unlock_delegate_dependency`][`crate::unlock_delegate_dependency`].
fn unlock_delegate_dependency<E>(&mut self, code_hash: &E::Hash)
where
E: Environment;
}