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
//! This library provides the core API that can be used to write smart contracts //! for the Concordium blockchain. It aims to provide safe wrappers around the //! core primitives exposed by the chain and accessible to smart contracts. //! //! By default the library will be linked with the //! [std](https://doc.rust-lang.org/std/) crate, the rust standard library, //! however to minimize code size this library supports toggling compilation //! with the `#![no_std]` attribute via the feature `std` which is enabled by //! default. Compilation without the `std` feature requires a nightly version of //! rust. //! //! To use this library without the `std` feature you have to disable it, which //! can be done, for example, as follows. //! ``` //! [dependencies.concordium-std] //! default-features = false //! ``` //! In your project's `Cargo.toml` file. //! //! The library is meant to be used as a standard library for developing smart //! contracts. For this reason it re-exports a number of definitions from other //! libraries. //! //! # Global allocator. //! Importing this library has a side-effect of setting the allocator to [wee_alloc](https://docs.rs/wee_alloc/) //! which is a memory allocator aimed at small code footprint. //! This allocator is designed to be used in contexts where there are a few //! large allocations up-front, and the memory is afterwards used by the program //! without many further allocations. Frequent small allocations will have bad //! performance, and should be avoided. //! //! In the future it will be possible to opt-out of the global allocator via a //! feature. //! //! # Panic handler //! When compiled without the `std` feature this crate sets the panic handler //! so that it terminates the process immediately, without any unwinding or //! prints. //! Concretely, when compiled to the `wasm32` target panic boils down to the //! `unreachable` instruction, which triggers a runtime failure, aborting //! execution of the program. //! //! # Build for generating a module schema //! **WARNING** Building with this feature enabled is meant for tooling, and the //! result is not intended to be deployed on chain. //! //! This library provides a way to automate the building of smart contract //! module schema, by allowing the contract to be built exporting getter //! functions for the `concordium_contracts_common::schema::Type` of Types for //! contract state and parameters. //! This special build is only intended to be used for generating the schema //! and is not meant to be deployed, since the build exports functions that do //! not conform to the expected API of smart contracts. //! The build is enabled by setting the feature `build-schema`. //! //! **Note** This feature is used by `cargo-concordium`, when building with //! schema and for most cases this feature should not be set manually. //! //! # Build for testing in Wasm //! **WARNING** Building with this feature enabled is meant for tooling, and the //! result is not intended to be deployed on chain. //! //! The macros [`#[concordium_test]`](attr.concordium_test.html) and //! [`#[concordium_cfg_test]`](attr.concordium_cfg_test.html) are reduced to //! `#[test]` and `#[cfg(test)]` unless the `wasm-test` feature is enabled. //! //! With the `wasm-test` feature enabled, the //! [`#[concordium_test]`](attr.concordium_test.html) macro exports the test as //! an `extern` function, allowing tools such as `cargo-concordium` to call the //! test functions directly, when compiled to Wasm. //! Without the feature it falls back to `#[test]`. //! //! With the 'wasm-test' feature enabled, the //! [`#[concordium_cfg_test]`](attr.concordium_cfg_test.html) macro allows the //! annotated code to be included in the build. Without the feature, it falls //! back to `#[cfg(test)]`. //! //! **Note** This feature is used by `cargo-concordium`, when building for //! testing and for most cases this feature should not be set manually. //! //! # Traits //! Most of the functionality for interacting with the host is abstracted away //! by the traits //! - [HasParameter](./trait.HasParameter.html) for accessing the contract //! parameter //! - [HasCommonData](./trait.HasCommonData.html) for accessing the data that is //! common to both init and receive methodss //! - [HasInitContext](./trait.HasInitContext.html) for all the context data //! available to the init functions (note that this includes all the common //! data) //! - [HasReceiveContext](./trait.HasReceiveContext.html) for accessing all the //! context data available to the receive functions (note that this includes //! all the common data) //! - [HasLogger](./trait.HasLogger.html) for logging data during smart contract //! execution //! - [HasPolicy](./trait.HasPolicy.html) for accessing the policy of the //! sender, either of the init or receive method //! - [HasContractState](./trait.HasContractState.html) for operations possible //! on the contract state. //! //! These are provided by traits to make testing easier. There are two main //! implementations provided for these traits. One provided by so-called //! __host__ functions, which is the implementation that is used by Concordium //! nodes when contracts are executed on the chain, or when tested via //! `cargo-concordium`. //! //! The second implementation is on types in the //! [test_infrastructure](./test_infrastructure/index.html) module, and is //! intended to be used for unit-testing together with the `concordium_test` //! infrastructure. #![cfg_attr(not(feature = "std"), no_std, feature(alloc_error_handler, core_intrinsics))] #[cfg(not(feature = "std"))] pub extern crate alloc; #[cfg(not(feature = "std"))] #[alloc_error_handler] fn on_oom(_layout: alloc::alloc::Layout) -> ! { #[cfg(target_arch = "wasm32")] unsafe { core::arch::wasm32::unreachable() } #[cfg(not(target_arch = "wasm32"))] loop {} } /// Terminate execution immediately without panicking. /// When the `std` feature is enabled this is just [std::process::abort](https://doc.rust-lang.org/std/process/fn.abort.html). /// When `std` is not present and the target architecture is `wasm32` this will /// simply emit the [unreachable](https://doc.rust-lang.org/core/arch/wasm32/fn.unreachable.html) instruction. #[cfg(feature = "std")] pub use std::process::abort as trap; #[cfg(all(not(feature = "std"), target_arch = "wasm32"))] #[inline(always)] pub fn trap() -> ! { unsafe { core::arch::wasm32::unreachable() } } #[cfg(all(not(feature = "std"), not(target_arch = "wasm32")))] #[inline(always)] pub fn trap() -> ! { core::intrinsics::abort() } #[cfg(not(feature = "std"))] #[panic_handler] fn abort_panic(_info: &core::panic::PanicInfo) -> ! { #[cfg(target_arch = "wasm32")] unsafe { core::arch::wasm32::unreachable() } #[cfg(not(target_arch = "wasm32"))] loop {} } // Provide some re-exports to make it easier to use the library. // This should be expanded in the future. #[cfg(not(feature = "std"))] pub use core::result::*; /// Re-export. #[cfg(not(feature = "std"))] pub use alloc::collections; /// Re-export. #[cfg(not(feature = "std"))] pub use alloc::{string, string::String, string::ToString, vec, vec::Vec}; /// Re-export. #[cfg(not(feature = "std"))] pub use core::convert; /// Re-export. #[cfg(not(feature = "std"))] pub use core::marker; /// Re-export. #[cfg(not(feature = "std"))] pub use core::mem; #[cfg(feature = "std")] pub(crate) use std::vec; /// Re-export. #[cfg(feature = "std")] pub use std::collections; /// Re-export. #[cfg(feature = "std")] pub use std::convert; #[cfg(feature = "std")] pub use std::marker; /// Re-export. #[cfg(feature = "std")] pub use std::mem; mod impls; mod prims; mod traits; mod types; pub use concordium_contracts_common::*; pub use concordium_std_derive::*; pub use impls::*; pub use traits::*; pub use types::*; extern crate wee_alloc; // Use `wee_alloc` as the global allocator to reduce code size. #[global_allocator] static ALLOC: wee_alloc::WeeAlloc = wee_alloc::WeeAlloc::INIT; pub mod test_infrastructure;