api.rs 16.1 KB
Newer Older
1
// Copyright 2019-2020 Parity Technologies (UK) Ltd.
2
//
3
4
5
// 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
6
//
7
//     http://www.apache.org/licenses/LICENSE-2.0
8
//
9
10
11
12
13
// 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.
14

15
//! The public raw interface towards the host Wasm engine.
Hero Bird's avatar
Hero Bird committed
16

17
18
19
use crate::env::{
    backend::{
        Env,
Hero Bird's avatar
Hero Bird committed
20
        ReturnFlags,
21
22
23
        TypedEnv,
    },
    call::{
24
        utils::ReturnType,
25
        CallParams,
26
        CreateParams,
27
28
29
30
    },
    engine::{
        EnvInstance,
        OnInstance,
31
    },
32
33
34
    EnvTypes,
    Result,
    Topics,
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
use ink_primitives::Key;

/// Returns the address of the caller of the executed contract.
///
/// # Errors
///
/// If the returned caller cannot be properly decoded.
pub fn caller<T>() -> Result<T::AccountId>
where
    T: EnvTypes,
{
    <EnvInstance as OnInstance>::on_instance(|instance| TypedEnv::caller::<T>(instance))
}

/// Returns the transferred balance for the contract execution.
///
/// # Errors
///
/// If the returned value cannot be properly decoded.
pub fn transferred_balance<T>() -> Result<T::Balance>
where
    T: EnvTypes,
{
    <EnvInstance as OnInstance>::on_instance(|instance| {
        TypedEnv::transferred_balance::<T>(instance)
    })
}

64
/// Returns the price for the specified amount of gas.
65
66
67
68
///
/// # Errors
///
/// If the returned value cannot be properly decoded.
Hero Bird's avatar
Hero Bird committed
69
pub fn weight_to_fee<T>(gas: u64) -> Result<T::Balance>
70
71
72
73
where
    T: EnvTypes,
{
    <EnvInstance as OnInstance>::on_instance(|instance| {
Hero Bird's avatar
Hero Bird committed
74
        TypedEnv::weight_to_fee::<T>(instance, gas)
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
    })
}

/// Returns the amount of gas left for the contract execution.
///
/// # Errors
///
/// If the returned value cannot be properly decoded.
pub fn gas_left<T>() -> Result<T::Balance>
where
    T: EnvTypes,
{
    <EnvInstance as OnInstance>::on_instance(|instance| TypedEnv::gas_left::<T>(instance))
}

/// Returns the current block timestamp.
///
/// # Errors
///
/// If the returned value cannot be properly decoded.
pub fn block_timestamp<T>() -> Result<T::Timestamp>
where
    T: EnvTypes,
{
    <EnvInstance as OnInstance>::on_instance(|instance| {
        TypedEnv::block_timestamp::<T>(instance)
    })
}
103

104
/// Returns the account ID of the executed contract.
105
///
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/// # Note
///
/// This method was formerly known as `address`.
///
/// # Errors
///
/// If the returned value cannot be properly decoded.
pub fn account_id<T>() -> Result<T::AccountId>
where
    T: EnvTypes,
{
    <EnvInstance as OnInstance>::on_instance(|instance| {
        TypedEnv::account_id::<T>(instance)
    })
}

/// Returns the balance of the executed contract.
///
/// # Errors
125
///
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/// If the returned value cannot be properly decoded.
pub fn balance<T>() -> Result<T::Balance>
where
    T: EnvTypes,
{
    <EnvInstance as OnInstance>::on_instance(|instance| TypedEnv::balance::<T>(instance))
}

/// Returns the current rent allowance for the executed contract.
///
/// # Errors
///
/// If the returned value cannot be properly decoded.
pub fn rent_allowance<T>() -> Result<T::Balance>
where
    T: EnvTypes,
{
    <EnvInstance as OnInstance>::on_instance(|instance| {
        TypedEnv::rent_allowance::<T>(instance)
    })
146
147
}

148
/// Returns the current block number.
149
///
150
/// # Errors
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
/// If the returned value cannot be properly decoded.
pub fn block_number<T>() -> Result<T::BlockNumber>
where
    T: EnvTypes,
{
    <EnvInstance as OnInstance>::on_instance(|instance| {
        TypedEnv::block_number::<T>(instance)
    })
}

/// Returns the minimum balance for the contracts chain.
///
/// # Errors
///
/// If the returned value cannot be properly decoded.
pub fn minimum_balance<T>() -> Result<T::Balance>
where
    T: EnvTypes,
{
    <EnvInstance as OnInstance>::on_instance(|instance| {
        TypedEnv::minimum_balance::<T>(instance)
    })
}

/// Returns the tombstone deposit for the contracts chain.
///
/// # Errors
///
/// If the returned value cannot be properly decoded.
pub fn tombstone_deposit<T>() -> Result<T::Balance>
where
    T: EnvTypes,
{
    <EnvInstance as OnInstance>::on_instance(|instance| {
        TypedEnv::tombstone_deposit::<T>(instance)
    })
}

/// Emits an event with the given event data.
pub fn emit_event<T, Event>(event: Event)
where
    T: EnvTypes,
    Event: Topics<T> + scale::Encode,
{
    <EnvInstance as OnInstance>::on_instance(|instance| {
        TypedEnv::emit_event::<T, Event>(instance, event)
    })
199
200
}

201
202
203
204
205
206
207
208
209
210
211
/// Sets the rent allowance of the executed contract to the new value.
pub fn set_rent_allowance<T>(new_value: T::Balance)
where
    T: EnvTypes,
{
    <EnvInstance as OnInstance>::on_instance(|instance| {
        TypedEnv::set_rent_allowance::<T>(instance, new_value)
    })
}

/// Writes the value to the contract storage under the given key.
Hero Bird's avatar
Hero Bird committed
212
213
214
215
///
/// # Panics
///
/// - If the encode length of value exceeds the configured maximum value length of a storage entry.
216
pub fn set_contract_storage<V>(key: &Key, value: &V)
217
218
219
220
221
222
223
224
225
where
    V: scale::Encode,
{
    <EnvInstance as OnInstance>::on_instance(|instance| {
        Env::set_contract_storage::<V>(instance, key, value)
    })
}

/// Returns the value stored under the given key in the contract's storage if any.
226
///
227
/// # Errors
228
///
Hero Bird's avatar
Hero Bird committed
229
230
/// - If the decoding of the typed value failed (`KeyNotFound`)
pub fn get_contract_storage<R>(key: &Key) -> Result<Option<R>>
231
232
233
234
235
236
237
238
239
where
    R: scale::Decode,
{
    <EnvInstance as OnInstance>::on_instance(|instance| {
        Env::get_contract_storage::<R>(instance, key)
    })
}

/// Clears the contract's storage key entry.
240
pub fn clear_contract_storage(key: &Key) {
241
242
243
    <EnvInstance as OnInstance>::on_instance(|instance| {
        Env::clear_contract_storage(instance, key)
    })
Andrew Jones's avatar
Andrew Jones committed
244
245
}

246
/// Invokes a contract message.
247
///
248
249
250
251
252
253
254
255
256
/// # Note
///
/// - Prefer using this over [`eval_contract`] if possible. [`invoke_contract`]
///   will generally have a better performance since it won't try to fetch any results.
/// - This is a low level way to invoke another smart contract.
///   Prefer to use the ink! guided and type safe approach to using this.
///
/// # Errors
///
Hero Bird's avatar
Hero Bird committed
257
258
/// - If the called account does not exist.
/// - If the called account is not a contract.
259
260
261
262
/// - If the called contract is a tombstone.
/// - If arguments passed to the called contract message are invalid.
/// - If the called contract execution has trapped.
/// - If the called contract ran out of gas upon execution.
263
pub fn invoke_contract<T, Args>(params: &CallParams<T, Args, ()>) -> Result<()>
264
where
265
    T: EnvTypes,
266
    Args: scale::Encode,
267
{
268
    <EnvInstance as OnInstance>::on_instance(|instance| {
269
        TypedEnv::invoke_contract::<T, Args>(instance, params)
270
    })
271
}
272

273
274
275
276
277
278
/// Evaluates a contract message and returns its result.
///
/// # Note
///
/// This is a low level way to evaluate another smart contract.
/// Prefer to use the ink! guided and type safe approach to using this.
279
///
280
281
/// # Errors
///
Hero Bird's avatar
Hero Bird committed
282
283
/// - If the called account does not exist.
/// - If the called account is not a contract.
284
285
286
287
288
/// - If the called contract is a tombstone.
/// - If arguments passed to the called contract message are invalid.
/// - If the called contract execution has trapped.
/// - If the called contract ran out of gas upon execution.
/// - If the returned value failed to decode properly.
289
pub fn eval_contract<T, Args, R>(params: &CallParams<T, Args, ReturnType<R>>) -> Result<R>
290
where
291
    T: EnvTypes,
292
    Args: scale::Encode,
293
    R: scale::Decode,
294
{
295
    <EnvInstance as OnInstance>::on_instance(|instance| {
296
        TypedEnv::eval_contract::<T, Args, R>(instance, params)
297
    })
298
299
}

300
301
302
303
304
305
/// Instantiates another contract.
///
/// # Note
///
/// This is a low level way to instantiate another smart contract.
/// Prefer to use the ink! guided and type safe approach to using this.
306
///
307
308
309
310
311
312
313
314
/// # Errors
///
/// - If the code hash is invalid.
/// - If the arguments passed to the instantiation process are invalid.
/// - If the instantiation process traps.
/// - If the instantiation process runs out of gas.
/// - If given insufficient endowment.
/// - If the returned account ID failed to decode properly.
315
pub fn instantiate_contract<T, Args, C>(
316
    params: &CreateParams<T, Args, C>,
317
) -> Result<T::AccountId>
318
where
319
    T: EnvTypes,
320
    Args: scale::Encode,
321
{
322
    <EnvInstance as OnInstance>::on_instance(|instance| {
323
        TypedEnv::instantiate_contract::<T, Args, C>(instance, params)
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
/// Restores a smart contract in tombstone state.
///
/// # Params
///
/// - `account_id`: Account ID of the to-be-restored contract.
/// - `code_hash`: Code hash of the to-be-restored contract.
/// - `rent_allowance`: Rent allowance of the restored contract
///                     upon successful restoration.
/// - `filtered_keys`: Storage keys to be excluded when calculating the tombstone hash,
///                    which is used to decide whether the original contract and the
///                    to-be-restored contract have matching storage.
///
/// # Usage
///
/// A smart contract that has too few funds to pay for its storage fees
/// can eventually be evicted. An evicted smart contract `C` leaves behind
/// a tombstone associated with a hash that has been computed partially
/// by its storage contents.
///
/// To restore contract `C` back to a fully working contract the normal
/// process is to write another contract `C2` with the only purpose to
/// eventually have the absolutely same contract storage as `C` did when
/// it was evicted.
/// For that purpose `C2` can use other storage keys that have not been in
/// use by contract `C`.
/// Once `C2` contract storage matches the storage of `C` when it was evicted
/// `C2` can invoke this method in order to initiate restoration of `C`.
/// A tombstone hash is calculated for `C2` and if it matches the tombstone
/// hash of `C` the restoration is going to be successful.
/// The `filtered_keys` argument can be used to ignore the extraneous keys
/// used by `C2` but not used by `C`.
358
///
359
360
361
362
363
364
365
366
367
368
369
370
/// The process of such a smart contract restoration can generally be very expensive.
///
/// # Note
///
/// - The `filtered_keys` can be used to ignore certain storage regions
///   in the restorer contract to not influence the hash calculations.
/// - Does *not* perform restoration right away but defers it to the end of
///   the contract execution.
/// - Restoration is cancelled if there is no tombstone in the destination
///   address or if the hashes don't match. No changes are made in this case.
pub fn restore_contract<T>(
    account_id: T::AccountId,
371
    code_hash: T::Hash,
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
    rent_allowance: T::Balance,
    filtered_keys: &[Key],
) where
    T: EnvTypes,
{
    <EnvInstance as OnInstance>::on_instance(|instance| {
        TypedEnv::restore_contract::<T>(
            instance,
            account_id,
            code_hash,
            rent_allowance,
            filtered_keys,
        )
    })
}

388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
/// Terminates the existence of the currently executed smart contract.
///
/// This removes the calling account and transfers all remaining balance
/// to the given beneficiary.
///
/// # Note
///
/// This function never returns. Either the termination was successful and the
/// execution of the destroyed contract is halted. Or it failed during the termination
/// which is considered fatal and results in a trap + rollback.
pub fn terminate_contract<T>(beneficiary: T::AccountId) -> !
where
    T: EnvTypes,
{
    <EnvInstance as OnInstance>::on_instance(|instance| {
        TypedEnv::terminate_contract::<T>(instance, beneficiary)
    })
}

407
408
409
410
411
412
413
414
/// Transfers value from the contract to the destination account ID.
///
/// # Note
///
/// This is more efficient and simpler than the alternative to make a no-op
/// contract call or invoke a runtime function that performs the
/// transaction.
///
Hero Bird's avatar
Hero Bird committed
415
/// # Panics
416
417
418
419
420
421
422
423
424
425
426
///
/// If the contract doesn't have sufficient funds.
pub fn transfer<T>(destination: T::AccountId, value: T::Balance) -> Result<()>
where
    T: EnvTypes,
{
    <EnvInstance as OnInstance>::on_instance(|instance| {
        TypedEnv::transfer::<T>(instance, destination, value)
    })
}

Hero Bird's avatar
Hero Bird committed
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
/// Calls the chain extension with the given ID and inputs.
///
/// Returns the given output type.
///
/// # Errors
///
/// - If the given function ID does not exist in the runtime.
/// - If the given inputs cannot be properly decoded by the runtime.
/// - If the given output type cannot be properly decoded by the contract.
/// - If some chain extension specific conditions are not met.
#[cfg(feature = "ink-unstable-chain-extensions")]
pub fn call_chain_extension<I, O>(func_id: u32, input: &I) -> Result<O>
where
    I: scale::Codec + 'static,
    O: scale::Codec + 'static,
{
    <EnvInstance as OnInstance>::on_instance(|instance| {
        Env::call_chain_extension(instance, func_id, input)
    })
}

448
/// Returns the execution input to the executed contract and decodes it as `T`.
449
450
451
452
453
///
/// # Note
///
/// - The input is the 4-bytes selector followed by the arguments
///   of the called function in their SCALE encoded representation.
454
455
456
457
458
459
460
461
462
463
464
465
466
/// - 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.
467
468
469
///
/// # Errors
///
470
471
472
473
474
475
/// If the given `T` cannot be properly decoded from the expected input.
pub fn decode_input<T>() -> Result<T>
where
    T: scale::Decode,
{
    <EnvInstance as OnInstance>::on_instance(|instance| Env::decode_input::<T>(instance))
476
477
478
479
480
481
}

/// Returns the value back to the caller of the executed contract.
///
/// # Note
///
Hero Bird's avatar
Hero Bird committed
482
483
/// This function  stops the execution of the contract immediately.
pub fn return_value<R>(return_flags: ReturnFlags, return_value: &R) -> !
484
485
486
487
where
    R: scale::Encode,
{
    <EnvInstance as OnInstance>::on_instance(|instance| {
Hero Bird's avatar
Hero Bird committed
488
        Env::return_value::<R>(instance, return_flags, return_value)
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
    })
}

/// Returns a random hash seed.
///
/// # Note
///
/// - The subject buffer can be used to further randomize the hash.
/// - Within the same execution returns the same random hash for the same subject.
///
/// # Errors
///
/// If the returned value cannot be properly decoded.
pub fn random<T>(subject: &[u8]) -> Result<T::Hash>
where
    T: EnvTypes,
{
    <EnvInstance as OnInstance>::on_instance(|instance| {
        TypedEnv::random::<T>(instance, subject)
    })
}

/// Prints the given contents to the environmental log.
pub fn println(content: &str) {
    <EnvInstance as OnInstance>::on_instance(|instance| Env::println(instance, content))
}

516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
/// Built-in efficient cryptographic hash functions.
pub mod hash {
    use super::*;

    macro_rules! impl_hash_fn {
        ( $(#[$doc:meta])* fn $name:ident($output_len:literal) ) => {
            paste::item! {
                $( #[$doc] )*
                pub fn $name(input: &[u8], output: &mut [u8; $output_len]) {
                    // No need to actually access the environmental instance
                    // if we only call one of its inherent methods.
                    <EnvInstance as Env>::[<hash_ $name>](input, output)
                }
            }
        };
    }
    impl_hash_fn!(
533
        /// Conducts the SHA2 256-bit hash of the given bytes and
534
535
536
537
        /// puts the result into the output buffer.
        fn sha2_256(32)
    );
    impl_hash_fn!(
538
        /// Conducts the KECCAK 256-bit hash of the given bytes and
539
540
541
542
        /// puts the result into the output buffer.
        fn keccak_256(32)
    );
    impl_hash_fn!(
543
        /// Conducts the BLAKE2 256-bit hash of the given bytes and
544
545
546
547
        /// puts the result into the output buffer.
        fn blake2_256(32)
    );
    impl_hash_fn!(
548
        /// Conducts the BLAKE2 128-bit hash of the given bytes and
549
550
551
552
        /// puts the result into the output buffer.
        fn blake2_128(16)
    );
}