ext.rs 18.3 KB
Newer Older
1
// Copyright 2018-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
16
17
18

//! External C API to communicate with substrate contracts runtime module.
//!
//! Refer to substrate SRML contract module for more documentation.

Hero Bird's avatar
Hero Bird committed
19
20
use crate::env::ReturnFlags;
use core::marker::PhantomData;
21
22
use ink_primitives::Key;

Hero Bird's avatar
Hero Bird committed
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
macro_rules! define_error_codes {
    (
        $(
            $( #[$attr:meta] )*
            $name:ident = $discr:literal,
        )*
    ) => {
        /// Every error that can be returned to a contract when it calls any of the host functions.
        #[repr(u32)]
        pub enum Error {
            $(
                $( #[$attr] )*
                $name = $discr,
            )*
            /// Returns if an unknown error was received from the host module.
            UnknownError,
        }

        impl From<ReturnCode> for Result {
            #[inline]
            fn from(return_code: ReturnCode) -> Self {
                match return_code.0 {
                    0 => Ok(()),
                    $(
                        $discr => Err(Error::$name),
                    )*
                    _ => Err(Error::UnknownError),
                }
            }
        }
    };
}
define_error_codes! {
    /// The called function trapped and has its state changes reverted.
    /// In this case no output buffer is returned.
    /// Can only be returned from `seal_call` and `seal_instantiate`.
    CalleeTrapped = 1,
    /// The called function ran to completion but decided to revert its state.
    /// An output buffer is returned when one was supplied.
    /// Can only be returned from `seal_call` and `seal_instantiate`.
    CalleeReverted = 2,
    /// The passed key does not exist in storage.
    KeyNotFound = 3,
    /// Transfer failed because it would have brought the sender's total balance
    /// bwlow the subsistence threshold.
    BelowSubsistenceThreshold = 4,
    /// Transfer failed for other not further specified reason. Most probably
    /// reserved or locked balance of the sender that was preventing the transfer.
    TransferFailed = 5,
    /// The newly created contract is below the subsistence threshold after executing
    /// its constructor so no usable contract instance will be created.
    NewContractNotFunded = 6,
    /// No code could be found at the supplied code hash.
    CodeNotFound = 7,
    /// The account that was called is either no contract (e.g. user account) or is a tombstone.
    NotCallable = 8,
}

/// Thin-wrapper around a `u32` representing a pointer for Wasm32.
///
/// Only for shared references.
///
/// # Note
///
/// Can only be constructed from shared reference types and encapsulates the
/// conversion from reference to raw `u32`.
/// Does not allow accessing the internal `u32` value.
#[derive(Debug)]
#[repr(transparent)]
pub struct Ptr32<'a, T>
where
    T: ?Sized,
{
    /// The internal Wasm32 raw pointer value.
    ///
    /// Must not be readable or directly usable by any safe Rust code.
    value: u32,
    /// We handle types like these as if the associated lifetime was exclusive.
    marker: PhantomData<fn() -> &'a T>,
}

impl<'a, T> Ptr32<'a, T>
where
    T: ?Sized,
{
    /// Creates a new Wasm32 pointer for the given raw pointer value.
    fn new(value: u32) -> Self {
        Self {
            value,
            marker: Default::default(),
        }
    }
}

impl<'a, T> Ptr32<'a, [T]> {
    /// Creates a new Wasm32 pointer from the given shared slice.
    pub fn from_slice(slice: &'a [T]) -> Self {
        Self::new(slice.as_ptr() as u32)
    }
}

/// Thin-wrapper around a `u32` representing a pointer for Wasm32.
///
/// Only for exclusive references.
///
/// # Note
///
/// Can only be constructed from exclusive reference types and encapsulates the
/// conversion from reference to raw `u32`.
/// Does not allow accessing the internal `u32` value.
#[derive(Debug)]
#[repr(transparent)]
pub struct Ptr32Mut<'a, T>
where
    T: ?Sized,
{
    /// The internal Wasm32 raw pointer value.
    ///
    /// Must not be readable or directly usable by any safe Rust code.
    value: u32,
    /// We handle types like these as if the associated lifetime was exclusive.
    marker: PhantomData<fn() -> &'a mut T>,
}

impl<'a, T> Ptr32Mut<'a, T>
where
    T: ?Sized,
{
    /// Creates a new Wasm32 pointer for the given raw pointer value.
    fn new(value: u32) -> Self {
        Self {
            value,
            marker: Default::default(),
        }
    }
}

impl<'a, T> Ptr32Mut<'a, [T]> {
    /// Creates a new Wasm32 pointer from the given exclusive slice.
    pub fn from_slice(slice: &'a mut [T]) -> Self {
        Self::new(slice.as_ptr() as u32)
    }
}

impl<'a, T> Ptr32Mut<'a, T>
where
    T: Sized,
{
    /// Creates a new Wasm32 pointer from the given exclusive reference.
    pub fn from_ref(a_ref: &'a mut T) -> Self {
        let a_ptr: *mut T = a_ref;
        Self::new(a_ptr as u32)
    }
}

/// The raw return code returned by the host side.
#[repr(transparent)]
pub struct ReturnCode(u32);

type Result = core::result::Result<(), Error>;
183
184

mod sys {
Hero Bird's avatar
Hero Bird committed
185
186
187
188
189
190
191
192
    use super::{
        Key,
        Ptr32,
        Ptr32Mut,
        ReturnCode,
    };

    #[link(wasm_import_module = "seal0")]
193
    extern "C" {
Hero Bird's avatar
Hero Bird committed
194
195
        pub fn seal_instantiate(
            init_code_ptr: Ptr32<[u8]>,
196
197
            init_code_len: u32,
            gas: u64,
Hero Bird's avatar
Hero Bird committed
198
199
200
201
202
203
204
205
206
207
208
209
            endowment_ptr: Ptr32<[u8]>,
            endowment_len: u32,
            input_ptr: Ptr32<[u8]>,
            input_len: u32,
            address_ptr: Ptr32Mut<[u8]>,
            address_len_ptr: Ptr32Mut<u32>,
            output_ptr: Ptr32Mut<[u8]>,
            output_len_ptr: Ptr32Mut<u32>,
        ) -> ReturnCode;

        pub fn seal_call(
            callee_ptr: Ptr32<[u8]>,
210
211
            callee_len: u32,
            gas: u64,
Hero Bird's avatar
Hero Bird committed
212
213
214
215
216
217
218
219
220
221
            transferred_value_ptr: Ptr32<[u8]>,
            transferred_value_len: u32,
            input_ptr: Ptr32<[u8]>,
            input_len: u32,
            output_ptr: Ptr32Mut<[u8]>,
            output_len_ptr: Ptr32Mut<u32>,
        ) -> ReturnCode;

        pub fn seal_transfer(
            account_id_ptr: Ptr32<[u8]>,
222
            account_id_len: u32,
Hero Bird's avatar
Hero Bird committed
223
224
225
            transferred_value_ptr: Ptr32<[u8]>,
            transferred_value_len: u32,
        ) -> ReturnCode;
226

Hero Bird's avatar
Hero Bird committed
227
228
        pub fn seal_deposit_event(
            topics_ptr: Ptr32<[u8]>,
229
            topics_len: u32,
Hero Bird's avatar
Hero Bird committed
230
            data_ptr: Ptr32<[u8]>,
231
232
233
            data_len: u32,
        );

Hero Bird's avatar
Hero Bird committed
234
235
236
237
238
239
240
        pub fn seal_set_storage(key_ptr: Ptr32<[u8]>, value_ptr: Ptr32<[u8]>, value_len: u32);
        pub fn seal_get_storage(
            key_ptr: Ptr32<[u8]>,
            output_ptr: Ptr32Mut<[u8]>,
            output_len_ptr: Ptr32Mut<u32>,
        ) -> ReturnCode;
        pub fn seal_clear_storage(key_ptr: Ptr32<[u8]>);
241

Hero Bird's avatar
Hero Bird committed
242
243
        pub fn seal_restore_to(
            dest_ptr: Ptr32<[u8]>,
244
            dest_len: u32,
Hero Bird's avatar
Hero Bird committed
245
            code_hash_ptr: Ptr32<[u8]>,
246
            code_hash_len: u32,
Hero Bird's avatar
Hero Bird committed
247
            rent_allowance_ptr: Ptr32<[u8]>,
248
            rent_allowance_len: u32,
Hero Bird's avatar
Hero Bird committed
249
            delta_ptr: Ptr32<[Key]>,
250
251
            delta_count: u32,
        );
Hero Bird's avatar
Hero Bird committed
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
        pub fn seal_terminate(beneficiary_ptr: Ptr32<[u8]>, beneficiary_len: u32) -> !;

        #[cfg(feature = "ink-unstable-chain-extensions")]
        pub fn seal_call_chain_extension(
            func_id: u32,
            input_ptr: Ptr32<[u8]>,
            input_len: u32,
            output_ptr: Ptr32Mut<[u8]>,
            output_len_ptr: Ptr32Mut<u32>,
        ) -> ReturnCode;

        pub fn seal_input(buf_ptr: Ptr32Mut<[u8]>, buf_len_ptr: Ptr32Mut<u32>);
        pub fn seal_return(flags: u32, data_ptr: Ptr32<[u8]>, data_len: u32) -> !;

        pub fn seal_caller(output_ptr: Ptr32Mut<[u8]>, output_len_ptr: Ptr32Mut<u32>);
        pub fn seal_block_number(
            output_ptr: Ptr32Mut<[u8]>,
            output_len_ptr: Ptr32Mut<u32>,
        );
        pub fn seal_address(output_ptr: Ptr32Mut<[u8]>, output_len_ptr: Ptr32Mut<u32>);
        pub fn seal_balance(output_ptr: Ptr32Mut<[u8]>, output_len_ptr: Ptr32Mut<u32>);
        pub fn seal_weight_to_fee(
            gas: u64,
            output_ptr: Ptr32Mut<[u8]>,
            output_len_ptr: Ptr32Mut<u32>,
        );
        pub fn seal_gas_left(output_ptr: Ptr32Mut<[u8]>, output_len_ptr: Ptr32Mut<u32>);
        pub fn seal_value_transferred(
            output_ptr: Ptr32Mut<[u8]>,
            output_len_ptr: Ptr32Mut<u32>,
        );
        pub fn seal_now(output_ptr: Ptr32Mut<[u8]>, output_len_ptr: Ptr32Mut<u32>);
        pub fn seal_rent_allowance(
            output_ptr: Ptr32Mut<[u8]>,
            output_len_ptr: Ptr32Mut<u32>,
        );
        pub fn seal_minimum_balance(
            output_ptr: Ptr32Mut<[u8]>,
            output_len_ptr: Ptr32Mut<u32>,
        );
        pub fn seal_tombstone_deposit(
            output_ptr: Ptr32Mut<[u8]>,
            output_len_ptr: Ptr32Mut<u32>,
        );

        pub fn seal_set_rent_allowance(value_ptr: Ptr32<[u8]>, value_len: u32);

        pub fn seal_random(
            subject_ptr: Ptr32<[u8]>,
            subject_len: u32,
            output_ptr: Ptr32Mut<[u8]>,
            output_len_ptr: Ptr32Mut<u32>,
        );
        pub fn seal_println(str_ptr: Ptr32<[u8]>, str_len: u32);

        pub fn seal_hash_keccak_256(
            input_ptr: Ptr32<[u8]>,
            input_len: u32,
            output_ptr: Ptr32Mut<[u8]>,
        );
        pub fn seal_hash_blake2_256(
            input_ptr: Ptr32<[u8]>,
            input_len: u32,
            output_ptr: Ptr32Mut<[u8]>,
        );
        pub fn seal_hash_blake2_128(
            input_ptr: Ptr32<[u8]>,
            input_len: u32,
            output_ptr: Ptr32Mut<[u8]>,
        );
        pub fn seal_hash_sha2_256(
            input_ptr: Ptr32<[u8]>,
            input_len: u32,
            output_ptr: Ptr32Mut<[u8]>,
        );
327
328
    }
}
329

Hero Bird's avatar
Hero Bird committed
330
331
332
333
334
335
336
fn extract_from_slice(output: &mut &mut [u8], new_len: usize) {
    debug_assert!(new_len <= output.len());
    let tmp = core::mem::take(output);
    *output = &mut tmp[..new_len];
}

pub fn instantiate(
337
338
    code_hash: &[u8],
    gas_limit: u64,
Hero Bird's avatar
Hero Bird committed
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
    endowment: &[u8],
    input: &[u8],
    out_address: &mut &mut [u8],
    out_return_value: &mut &mut [u8],
) -> Result {
    let mut address_len = out_address.len() as u32;
    let mut return_value_len = out_return_value.len() as u32;
    let ret_code = {
        unsafe {
            sys::seal_instantiate(
                Ptr32::from_slice(code_hash),
                code_hash.len() as u32,
                gas_limit,
                Ptr32::from_slice(endowment),
                endowment.len() as u32,
                Ptr32::from_slice(input),
                input.len() as u32,
                Ptr32Mut::from_slice(out_address),
                Ptr32Mut::from_ref(&mut address_len),
                Ptr32Mut::from_slice(out_return_value),
                Ptr32Mut::from_ref(&mut return_value_len),
            )
        }
362
    };
Hero Bird's avatar
Hero Bird committed
363
364
365
    extract_from_slice(out_address, address_len as usize);
    extract_from_slice(out_return_value, return_value_len as usize);
    ret_code.into()
366
367
}

Hero Bird's avatar
Hero Bird committed
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
pub fn call(
    callee: &[u8],
    gas_limit: u64,
    value: &[u8],
    input: &[u8],
    output: &mut &mut [u8],
) -> Result {
    let mut output_len = output.len() as u32;
    let ret_code = {
        unsafe {
            sys::seal_call(
                Ptr32::from_slice(callee),
                callee.len() as u32,
                gas_limit,
                Ptr32::from_slice(value),
                value.len() as u32,
                Ptr32::from_slice(input),
                input.len() as u32,
                Ptr32Mut::from_slice(output),
                Ptr32Mut::from_ref(&mut output_len),
            )
        }
390
    };
Hero Bird's avatar
Hero Bird committed
391
392
    extract_from_slice(output, output_len as usize);
    ret_code.into()
393
394
}

Hero Bird's avatar
Hero Bird committed
395
pub fn transfer(account_id: &[u8], value: &[u8]) -> Result {
396
    let ret_code = unsafe {
Hero Bird's avatar
Hero Bird committed
397
398
        sys::seal_transfer(
            Ptr32::from_slice(account_id),
399
            account_id.len() as u32,
Hero Bird's avatar
Hero Bird committed
400
            Ptr32::from_slice(value),
401
402
403
            value.len() as u32,
        )
    };
Hero Bird's avatar
Hero Bird committed
404
    ret_code.into()
405
406
}

407
408
pub fn deposit_event(topics: &[u8], data: &[u8]) {
    unsafe {
Hero Bird's avatar
Hero Bird committed
409
410
        sys::seal_deposit_event(
            Ptr32::from_slice(topics),
411
            topics.len() as u32,
Hero Bird's avatar
Hero Bird committed
412
            Ptr32::from_slice(data),
413
414
415
416
417
            data.len() as u32,
        )
    }
}

418
419
pub fn set_storage(key: &[u8], encoded_value: &[u8]) {
    unsafe {
Hero Bird's avatar
Hero Bird committed
420
421
422
        sys::seal_set_storage(
            Ptr32::from_slice(key),
            Ptr32::from_slice(encoded_value),
423
424
            encoded_value.len() as u32,
        )
425
426
427
    }
}

428
pub fn clear_storage(key: &[u8]) {
Hero Bird's avatar
Hero Bird committed
429
    unsafe { sys::seal_clear_storage(Ptr32::from_slice(key)) }
430
431
}

Hero Bird's avatar
Hero Bird committed
432
433
434
435
436
437
438
439
440
441
pub fn get_storage(key: &[u8], output: &mut &mut [u8]) -> Result {
    let mut output_len = output.len() as u32;
    let ret_code = {
        unsafe {
            sys::seal_get_storage(
                Ptr32::from_slice(key),
                Ptr32Mut::from_slice(output),
                Ptr32Mut::from_ref(&mut output_len),
            )
        }
442
    };
Hero Bird's avatar
Hero Bird committed
443
444
    extract_from_slice(output, output_len as usize);
    ret_code.into()
445
446
}

447
448
449
450
451
452
453
454
455
456
457
/// Restores a tombstone to the original smart contract.
///
/// # Params
///
/// - `account_id`: Encoded bytes of the `AccountId` of the to-be-restored contract.
/// - `code_hash`: Encoded code hash of the to-be-restored contract.
/// - `rent_allowance`: The encoded rent allowance of the restored contract
///                     upon successful restoration.
/// - `filtered_keys`: Storage keys that will be ignored for the tombstone hash
///                    match calculation that decide whether the original contract
///                    storage and the storage of the restorer contract is equal.
458
pub fn restore_to(
459
    account_id: &[u8],
460
461
462
463
464
    code_hash: &[u8],
    rent_allowance: &[u8],
    filtered_keys: &[Key],
) {
    unsafe {
Hero Bird's avatar
Hero Bird committed
465
466
        sys::seal_restore_to(
            Ptr32::from_slice(account_id),
467
            account_id.len() as u32,
Hero Bird's avatar
Hero Bird committed
468
            Ptr32::from_slice(code_hash),
469
            code_hash.len() as u32,
Hero Bird's avatar
Hero Bird committed
470
            Ptr32::from_slice(rent_allowance),
471
            rent_allowance.len() as u32,
Hero Bird's avatar
Hero Bird committed
472
            Ptr32::from_slice(filtered_keys),
473
474
475
476
477
            filtered_keys.len() as u32,
        )
    }
}

478
pub fn terminate(beneficiary: &[u8]) -> ! {
Hero Bird's avatar
Hero Bird committed
479
480
481
    unsafe {
        sys::seal_terminate(Ptr32::from_slice(beneficiary), beneficiary.len() as u32)
    }
482
483
}

Hero Bird's avatar
Hero Bird committed
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
#[cfg(feature = "ink-unstable-chain-extensions")]
pub fn call_chain_extension(
    func_id: u32,
    input: &[u8],
    output: &mut &mut [u8],
) -> Result {
    let mut output_len = output.len() as u32;
    let ret_code = {
        unsafe {
            sys::seal_call_chain_extension(
                func_id,
                Ptr32::from_slice(input),
                input.len() as u32,
                Ptr32Mut::from_slice(output),
                Ptr32Mut::from_ref(&mut output_len),
            )
        }
    };
    extract_from_slice(output, output_len as usize);
    ret_code.into()
504
505
}

Hero Bird's avatar
Hero Bird committed
506
507
508
509
510
511
512
513
514
515
516
pub fn input(output: &mut &mut [u8]) {
    let mut output_len = output.len() as u32;
    {
        unsafe {
            sys::seal_input(
                Ptr32Mut::from_slice(output),
                Ptr32Mut::from_ref(&mut output_len),
            )
        };
    }
    extract_from_slice(output, output_len as usize);
517
518
}

Hero Bird's avatar
Hero Bird committed
519
520
521
522
523
524
525
526
pub fn return_value(flags: ReturnFlags, return_value: &[u8]) -> ! {
    unsafe {
        sys::seal_return(
            flags.into_u32(),
            Ptr32::from_slice(return_value),
            return_value.len() as u32,
        )
    }
527
528
}

Hero Bird's avatar
Hero Bird committed
529
530
macro_rules! impl_seal_wrapper_for {
    ( $( ($name:ident => $seal_name:ident), )* ) => {
531
        $(
Hero Bird's avatar
Hero Bird committed
532
533
534
535
536
537
538
539
540
            pub fn $name(output: &mut &mut [u8]) {
                let mut output_len = output.len() as u32;
                {
                    unsafe {
                        sys::$seal_name(
                            Ptr32Mut::from_slice(output),
                            Ptr32Mut::from_ref(&mut output_len),
                        )
                    };
541
                }
Hero Bird's avatar
Hero Bird committed
542
                extract_from_slice(output, output_len as usize);
543
544
545
546
            }
        )*
    }
}
Hero Bird's avatar
Hero Bird committed
547
548
549
550
551
552
553
554
555
556
557
impl_seal_wrapper_for! {
    (caller => seal_caller),
    (block_number => seal_block_number),
    (address => seal_address),
    (balance => seal_balance),
    (gas_left => seal_gas_left),
    (value_transferred => seal_value_transferred),
    (now => seal_now),
    (rent_allowance => seal_rent_allowance),
    (minimum_balance => seal_minimum_balance),
    (tombstone_deposit => seal_tombstone_deposit),
558
559
}

Hero Bird's avatar
Hero Bird committed
560
561
562
563
564
565
566
567
568
569
570
571
pub fn weight_to_fee(gas: u64, output: &mut &mut [u8]) {
    let mut output_len = output.len() as u32;
    {
        unsafe {
            sys::seal_weight_to_fee(
                gas,
                Ptr32Mut::from_slice(output),
                Ptr32Mut::from_ref(&mut output_len),
            )
        };
    }
    extract_from_slice(output, output_len as usize);
572
573
}

574
pub fn set_rent_allowance(value: &[u8]) {
Hero Bird's avatar
Hero Bird committed
575
    unsafe { sys::seal_set_rent_allowance(Ptr32::from_slice(value), value.len() as u32) }
576
577
}

Hero Bird's avatar
Hero Bird committed
578
579
580
581
582
583
584
585
586
587
588
589
590
pub fn random(subject: &[u8], output: &mut &mut [u8]) {
    let mut output_len = output.len() as u32;
    {
        unsafe {
            sys::seal_random(
                Ptr32::from_slice(subject),
                subject.len() as u32,
                Ptr32Mut::from_slice(output),
                Ptr32Mut::from_ref(&mut output_len),
            )
        };
    }
    extract_from_slice(output, output_len as usize);
591
592
593
594
}

pub fn println(content: &str) {
    let bytes = content.as_bytes();
Hero Bird's avatar
Hero Bird committed
595
    unsafe { sys::seal_println(Ptr32::from_slice(bytes), bytes.len() as u32) }
596
}
597
598
599
600
601
602

macro_rules! impl_hash_fn {
    ( $name:ident, $bytes_result:literal ) => {
        paste::item! {
            pub fn [<hash_ $name>](input: &[u8], output: &mut [u8; $bytes_result]) {
                unsafe {
Hero Bird's avatar
Hero Bird committed
603
604
                    sys::[<seal_hash_ $name>](
                        Ptr32::from_slice(input),
605
                        input.len() as u32,
Hero Bird's avatar
Hero Bird committed
606
                        Ptr32Mut::from_slice(output),
607
608
609
610
611
612
613
614
615
616
                    )
                }
            }
        }
    };
}
impl_hash_fn!(sha2_256, 32);
impl_hash_fn!(keccak_256, 32);
impl_hash_fn!(blake2_256, 32);
impl_hash_fn!(blake2_128, 16);