mod.rs 8.55 KB
Newer Older
1
// Copyright 2018-2021 Parity Technologies (UK) Ltd.
2
3
4
5
6
7
8
9
10
11
12
13
14
//
// 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.

15
mod call_data;
16
mod chain_extension;
17
mod db;
18
mod hashing;
19
20
21
22
23
24
25
26
mod impls;
pub mod test_api;
mod typed_encoded;
mod types;

#[cfg(test)]
mod tests;

27
28
29
30
pub use self::{
    call_data::CallData,
    db::{
        AccountError,
31
        DebugMessages,
32
        EmittedEvent,
33
34
35
    },
    typed_encoded::TypedEncodedError,
};
36
use self::{
37
    chain_extension::ChainExtensionHandler,
38
39
40
41
42
    db::{
        Account,
        AccountsDb,
        Block,
        ChainSpec,
43
        DebugBuffer,
44
45
46
47
48
49
50
51
52
53
54
55
56
        EmittedEventsRecorder,
        ExecContext,
    },
    typed_encoded::TypedEncoded,
    types::{
        OffAccountId,
        OffBalance,
        OffBlockNumber,
        OffHash,
        OffTimestamp,
    },
};
use super::OnInstance;
57
use crate::Environment;
58
59
60
61
62
63
64
65
66
67
68
69
use core::cell::RefCell;
use derive_more::From;

#[derive(Debug, From, PartialEq, Eq)]
pub enum OffChainError {
    Account(AccountError),
    TypedEncoded(TypedEncodedError),
    #[from(ignore)]
    UninitializedBlocks,
    #[from(ignore)]
    UninitializedExecutionContext,
    #[from(ignore)]
Hero Bird's avatar
Hero Bird committed
70
    UnregisteredChainExtension,
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
}

pub type Result<T> = core::result::Result<T, OffChainError>;

/// The off-chain environment.
///
/// Mainly used for off-chain testing.
pub struct EnvInstance {
    /// The accounts database of the environment.
    accounts: AccountsDb,
    /// Current execution context and context.
    exec_context: Vec<ExecContext>,
    /// The general chain spec.
    chain_spec: ChainSpec,
    /// The blocks of the chain.
    blocks: Vec<Block>,
87
88
    /// The debug buffer to collect debug messages and print them to stdout.
    debug_buf: DebugBuffer,
Hero Bird's avatar
Hero Bird committed
89
90
    /// Handler for registered chain extensions.
    chain_extension_handler: ChainExtensionHandler,
91
92
    /// Emitted events recorder.
    emitted_events: EmittedEventsRecorder,
93
94
    /// Set to true to disable clearing storage
    clear_storage_disabled: bool,
95
96
97
98
99
100
101
102
103
104
}

impl EnvInstance {
    /// Creates a new uninitialized off-chain environment.
    pub fn uninitialized() -> Self {
        Self {
            accounts: AccountsDb::new(),
            exec_context: Vec::new(),
            chain_spec: ChainSpec::uninitialized(),
            blocks: Vec::new(),
105
            debug_buf: DebugBuffer::new(),
Hero Bird's avatar
Hero Bird committed
106
            chain_extension_handler: ChainExtensionHandler::new(),
107
            emitted_events: EmittedEventsRecorder::new(),
108
            clear_storage_disabled: false,
109
110
111
        }
    }

112
113
114
115
116
117
    /// Returns `true` if the off-chain environment is uninitialized.
    pub fn is_initialized(&self) -> bool {
        !self.exec_context.is_empty()
    }

    /// Either resets or initializes the off-chain environment to default values.
118
    pub fn initialize_or_reset_as_default<T>(&mut self) -> crate::Result<()>
119
    where
120
121
        T: Environment,
        <T as Environment>::AccountId: From<[u8; 32]>,
122
123
124
125
126
127
128
129
    {
        if self.is_initialized() {
            self.reset()
        }
        self.initialize_as_default::<T>()?;
        Ok(())
    }

130
    /// Resets the off-chain environment to uninitialized state.
131
132
133
134
135
    pub fn reset(&mut self) {
        self.accounts.reset();
        self.exec_context.clear();
        self.chain_spec.reset();
        self.blocks.clear();
136
        self.debug_buf.reset();
Hero Bird's avatar
Hero Bird committed
137
        self.chain_extension_handler.reset();
138
        self.emitted_events.reset();
139
        self.clear_storage_disabled = false;
140
141
    }

142
143
144
145
146
147
148
149
150
151
152
153
154
    /// Initializes the whole off-chain environment.
    ///
    /// # Note
    ///
    /// This is needed since we operate on a static instance that cannot be
    /// made generic over all environmental types and thus we are required to
    /// initialize it upon program start uninitialized which is why we have
    /// `TypedEncoded` wrappers.
    ///
    /// The off-chain environment requires to be initialized before every usage.
    ///
    /// This routine implements a default initialization that should be fine
    /// for most use cases.
155
    pub fn initialize_as_default<T>(&mut self) -> crate::Result<()>
156
    where
157
158
        T: Environment,
        <T as Environment>::AccountId: From<[u8; 32]>,
159
160
161
162
163
164
165
166
167
168
    {
        use core::ops::Div as _;
        use num_traits::{
            Bounded as _,
            Zero as _,
        };
        let default_accounts = test_api::default_accounts::<T>()?;
        // Alice has half of the maximum possible amount.
        self.accounts.add_user_account::<T>(
            default_accounts.alice.clone(),
169
            T::Balance::max_value().div(T::Balance::from(2u32)),
170
171
172
173
        );
        // Bob has half the balance that alice got.
        self.accounts.add_user_account::<T>(
            default_accounts.bob,
174
            T::Balance::max_value().div(T::Balance::from(4u32)),
175
176
177
178
179
180
181
182
183
184
185
186
        );
        // All other default accounts have zero balance.
        self.accounts
            .add_user_account::<T>(default_accounts.charlie, T::Balance::zero());
        self.accounts
            .add_user_account::<T>(default_accounts.django, T::Balance::zero());
        self.accounts
            .add_user_account::<T>(default_accounts.eve, T::Balance::zero());
        self.accounts
            .add_user_account::<T>(default_accounts.frank, T::Balance::zero());
        // Initialize our first block.
        self.blocks.push(Block::new::<T>(
187
188
            T::BlockNumber::from(0u32),
            T::Timestamp::from(0u32),
189
190
191
192
193
194
195
        ));
        // Initialize chain specification.
        self.chain_spec.initialize_as_default::<T>()?;
        // Initialize the called contract account.
        let contract_account_id = T::AccountId::from([0x07; 32]);
        self.accounts.add_contract_account::<T>(
            contract_account_id.clone(),
196
197
            T::Balance::from(0u32),
            T::Balance::from(20u32),
198
199
        );
        // Initialize the execution context for the first contract execution.
200
        use crate::call::Selector;
201
202
203
        // The below selector bytes are incorrect but since calling doesn't work
        // yet we do not have to fix this now.
        let selector_bytes_for_call = [0x00; 4];
204
205
206
207
        self.exec_context.push(
            ExecContext::build::<T>()
                .caller(default_accounts.alice)
                .callee(contract_account_id)
208
209
                .gas(T::Balance::from(500_000u32))
                .transferred_value(T::Balance::from(500u32))
210
                .call_data(CallData::new(Selector::new(selector_bytes_for_call)))
211
212
213
214
215
216
                .finish(),
        );
        Ok(())
    }

    /// Advances the chain by a single block.
217
    pub fn advance_block<T>(&mut self) -> crate::Result<()>
218
    where
219
        T: Environment,
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
    {
        let new_block_number = T::BlockNumber::from(self.blocks.len() as u32);
        let new_timestamp = self.current_block()?.timestamp::<T>()?
            + self.chain_spec.block_time::<T>()?;
        self.blocks
            .push(Block::new::<T>(new_block_number, new_timestamp));
        Ok(())
    }

    /// Returns the current execution context.
    fn exec_context(&self) -> Result<&ExecContext> {
        self.exec_context
            .last()
            .ok_or(OffChainError::UninitializedExecutionContext)
    }

    /// Returns the current execution context.
    fn exec_context_mut(&mut self) -> Result<&mut ExecContext> {
        self.exec_context
            .last_mut()
            .ok_or(OffChainError::UninitializedExecutionContext)
    }

    /// Returns the current block of the chain.
    fn current_block(&self) -> Result<&Block> {
        self.blocks.last().ok_or(OffChainError::UninitializedBlocks)
    }

    /// Returns a mutable reference to the current block of the chain.
    fn current_block_mut(&mut self) -> Result<&mut Block> {
        self.blocks
            .last_mut()
252
            .ok_or(OffChainError::UninitializedBlocks)
253
    }
254
255
256
257

    fn chain_spec_mut(&mut self) -> &mut ChainSpec {
        &mut self.chain_spec
    }
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
}

impl OnInstance for EnvInstance {
    fn on_instance<F, R>(f: F) -> R
    where
        F: FnOnce(&mut Self) -> R,
    {
        thread_local!(
            static INSTANCE: RefCell<EnvInstance> = RefCell::new(
                EnvInstance::uninitialized()
            )
        );
        INSTANCE.with(|instance| f(&mut instance.borrow_mut()))
    }
}