lib.rs 2.65 KB
Newer Older
1
// Copyright 2018-2021 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 `ink_env` utilities used to interoperate with the contract executor.
Hero Bird's avatar
Hero Bird committed
16
17
18
19
//!
//! Mainly provides entities to work on a contract's storage
//! as well as high-level collections on top of those.
//! Also provides environmental utilities, such as storage allocators,
20
//! FFI to interface with FRAME contracts and a primitive blockchain
Hero Bird's avatar
Hero Bird committed
21
22
//! emulator for simple off-chain testing.

23
#![cfg_attr(not(feature = "std"), no_std)]
24
#![deny(
25
    missing_docs,
26
    bad_style,
27
    bare_trait_objects,
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
    const_err,
    improper_ctypes,
    non_shorthand_field_patterns,
    no_mangle_generic_items,
    overflowing_literals,
    path_statements,
    patterns_in_fns_without_body,
    private_in_public,
    unconditional_recursion,
    unused_allocation,
    unused_comparisons,
    unused_parens,
    while_true,
    trivial_casts,
    trivial_numeric_casts,
    unused_extern_crates
44
)]
45

Hero Bird's avatar
Hero Bird committed
46
47
48
49
50
51
52
53
54
55
56
#[cfg(all(not(feature = "std"), target_arch = "wasm32"))]
#[panic_handler]
fn panic(_info: &core::panic::PanicInfo) -> ! {
    // SAFETY: We only use this operation if we are guaranteed to be in Wasm32 compilation.
    //         This is used in order to make any panic a direct abort avoiding Rust's general
    //         panic infrastructure.
    unsafe {
        core::arch::wasm32::unreachable();
    }
}

57
58
59
// This extern crate definition is required since otherwise rustc
// is not recognizing its allocator and panic handler definitions.
#[cfg(not(feature = "std"))]
60
extern crate ink_allocator;
61

62
63
64
65
mod api;
mod arithmetic;
mod backend;
pub mod call;
66
pub mod chain_extension;
67
68
69
mod engine;
mod error;
pub mod hash;
70
71
#[doc(hidden)]
pub mod topics;
72
mod types;
73

74
75
76
77
78
79
80
81
#[cfg(test)]
mod tests;

#[cfg(any(feature = "std", test, doc))]
#[doc(inline)]
pub use self::engine::off_chain::test_api as test;

use self::backend::{
82
83
    EnvBackend,
    TypedEnvBackend,
84
85
86
87
88
};
pub use self::{
    api::*,
    backend::ReturnFlags,
    error::{
89
        Error,
90
91
        Result,
    },
92
    topics::Topics,
93
94
95
    types::{
        AccountId,
        Clear,
96
97
        DefaultEnvironment,
        Environment,
98
        Hash,
99
        NoChainExtension,
100
101
    },
};