ink_primitives 5.1.1

[ink!] Fundamental primitive types for ink! smart contracts.
Documentation 
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

// Copyright (C) Use Ink (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.

//! Utilities in use by ink!.
//!
//! These are kept separate from ink! core utilities to allow for more dynamic inter-crate
//! dependencies. The main problem is that today Cargo manages crate features on a
//! per-crate basis instead of a per-crate-target basis thus making dependencies from
//! `ink` (or others) to `ink_env` or `ink_storage` impossible.
//!
//! By introducing `ink_primitives` we have a way to share utility components between
//! `ink_env` or `ink_storage` and other parts of the framework, like `ink`.

#![doc(
    html_logo_url = "https://use.ink/img/crate-docs/logo.png",
    html_favicon_url = "https://use.ink/crate-docs/favicon.png"
)]
#![cfg_attr(not(feature = "std"), no_std)]

mod key;
mod types;

pub use self::{
    key::{
        Key,
        KeyComposer,
    },
    types::{
        AccountId,
        Clear,
        Hash,
    },
};

/// An error emitted by the smart contracting language.
///
/// This is different than errors from:
/// - Errors from the contract, which are programmer defined
/// - Errors from the underlying execution environment (e.g `pallet-contracts`)
#[non_exhaustive]
#[repr(u32)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, ::scale::Encode, ::scale::Decode)]
#[cfg_attr(feature = "std", derive(::scale_info::TypeInfo))]
pub enum LangError {
    /// Failed to read execution input for the dispatchable.
    CouldNotReadInput = 1u32,
}

/// The `Result` type for ink! messages.
pub type MessageResult<T> = ::core::result::Result<T, LangError>;

/// The `Result` type for ink! constructors.
pub type ConstructorResult<T> = ::core::result::Result<T, LangError>;