ink 6.0.0-alpha

[ink!] Rust based eDSL for writing smart contracts for Polkadot SDK
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
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

// 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.

#![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)]

#[macro_use]
#[doc(hidden)]
pub mod option_info;

#[macro_use]
#[doc(hidden)]
pub mod result_info;

#[cfg_attr(not(feature = "show-codegen-docs"), doc(hidden))]
pub mod codegen;

pub use ink_env::reflect;

mod chain_extension;
mod contract_ref;
mod env_access;
mod message_builder;

pub use ink_env as env;
#[cfg(feature = "std")]
pub use ink_metadata as metadata;
pub use ink_prelude as prelude;
pub use ink_primitives as primitives;
pub use scale;
#[cfg(feature = "std")]
pub use scale_info;
pub use xcm;

pub extern crate polkavm_derive;
#[doc(hidden)]
pub use polkavm_derive::*;

pub mod storage {
    pub mod traits {
        pub use ink_macro::{
            Storable,
            StorableHint,
            StorageKey,
            StorageLayout,
        };
        pub use ink_storage::traits::*;
    }
    pub use ink_storage::{
        Lazy,
        Mapping,
        StorageVec,
    };
}

pub use self::{
    chain_extension::{
        ChainExtensionInstance,
        IsResultType,
        Output,
        ValueReturned,
    },
    contract_ref::ToAddr,
    env_access::EnvAccess,
    prelude::IIP2_WILDCARD_COMPLEMENT_SELECTOR,
};
#[allow(unused)]
pub use ink_macro::chain_extension;
pub use ink_macro::{
    blake2x256,
    contract,
    event,
    scale_derive,
    selector_bytes,
    selector_id,
    storage_item,
    test,
    trait_definition,
    Event,
    EventMetadata,
};
pub use ink_primitives::{
    Address,
    ConstructorResult,
    LangError,
    MessageResult,
    SolBytes,
    SolDecode,
    SolEncode,
    H160,
    H256,
    U256,
};

#[cfg(feature = "std")]
#[doc(hidden)]
pub use linkme;

#[cfg(feature = "std")]
use ink_metadata::EventSpec;

/// Any event which derives `#[derive(ink::EventMetadata)]` and is used in the contract
/// binary will have its implementation added to this distributed slice at linking time.
#[cfg(feature = "std")]
#[linkme::distributed_slice]
#[linkme(crate = linkme)]
pub static CONTRACT_EVENTS: [fn() -> EventSpec] = [..];

/// Collect the [`EventSpec`] metadata of all event definitions linked and used in the
/// binary.
#[cfg(feature = "std")]
pub fn collect_events() -> Vec<EventSpec> {
    CONTRACT_EVENTS.iter().map(|event| event()).collect()
}