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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
//! Mock dispatch context for use in tests.
use std::collections::BTreeMap;

use oasis_core_runtime::{
    common::{namespace::Namespace, version::Version},
    consensus::{beacon, roothash, state::ConsensusState, Event},
    protocol::HostInfo,
    storage::mkvs,
    types::EventKind,
};

use crate::{
    context::{Context, RuntimeBatchContext},
    dispatcher,
    error::RuntimeError,
    history,
    keymanager::KeyManager,
    module::MigrationHandler,
    modules,
    runtime::Runtime,
    state::{self, CurrentState, TransactionResult},
    storage::MKVSStore,
    testing::{configmap, keymanager::MockKeyManagerClient},
    types::{address::SignatureAddressSpec, transaction},
};

pub struct Config;

impl modules::core::Config for Config {}

/// A mock runtime that only has the core module.
pub struct EmptyRuntime;

impl Runtime for EmptyRuntime {
    const VERSION: Version = Version::new(0, 0, 0);

    type Core = modules::core::Module<Config>;

    type Modules = modules::core::Module<Config>;

    fn genesis_state() -> <Self::Modules as MigrationHandler>::Genesis {
        Default::default()
    }
}

struct EmptyHistory;

impl history::HistoryHost for EmptyHistory {
    fn consensus_state_at(&self, _height: u64) -> Result<ConsensusState, history::Error> {
        Err(history::Error::FailedToFetchBlock)
    }

    fn consensus_events_at(
        &self,
        _height: u64,
        _kind: EventKind,
    ) -> Result<Vec<Event>, history::Error> {
        Err(history::Error::FailedToFetchEvents)
    }
}

/// Mock dispatch context factory.
pub struct Mock {
    pub host_info: HostInfo,
    pub runtime_header: roothash::Header,
    pub runtime_round_results: roothash::RoundResults,
    pub consensus_state: ConsensusState,
    pub history: Box<dyn history::HistoryHost>,
    pub epoch: beacon::EpochTime,

    pub max_messages: u32,
}

impl Mock {
    /// Create a new mock dispatch context.
    pub fn create_ctx(&mut self) -> RuntimeBatchContext<'_, EmptyRuntime> {
        self.create_ctx_for_runtime(false)
    }

    /// Create a new mock dispatch context.
    pub fn create_ctx_for_runtime<R: Runtime>(
        &mut self,
        confidential: bool,
    ) -> RuntimeBatchContext<'_, R> {
        RuntimeBatchContext::new(
            &self.host_info,
            if confidential {
                Some(Box::new(MockKeyManagerClient::new()) as Box<dyn KeyManager>)
            } else {
                None
            },
            &self.runtime_header,
            &self.runtime_round_results,
            &self.consensus_state,
            &self.history,
            self.epoch,
            self.max_messages,
        )
    }

    /// Create an instance with the given local configuration.
    pub fn with_local_config(local_config: BTreeMap<String, cbor::Value>) -> Self {
        // Ensure a current state is always available during tests. Note that one can always use a
        // different store by calling `CurrentState::enter` explicitly.
        CurrentState::init_local_fallback();

        let consensus_tree = mkvs::Tree::builder()
            .with_root_type(mkvs::RootType::State)
            .build(Box::new(mkvs::sync::NoopReadSyncer));

        Self {
            host_info: HostInfo {
                runtime_id: Namespace::default(),
                consensus_backend: "mock".to_string(),
                consensus_protocol_version: Version::default(),
                consensus_chain_context: "test".to_string(),
                local_config,
            },
            runtime_header: roothash::Header::default(),
            runtime_round_results: roothash::RoundResults::default(),
            consensus_state: ConsensusState::new(1, consensus_tree),
            history: Box::new(EmptyHistory),
            epoch: 1,
            max_messages: 32,
        }
    }
}

impl Default for Mock {
    fn default() -> Self {
        let local_config_for_tests = configmap! {
            // Allow expensive gas estimation and expensive queries so they can be tested.
            "estimate_gas_by_simulating_contracts" => true,
            "allowed_queries" => vec![
                configmap! {"all_expensive" => true}
            ],
        };
        Self::with_local_config(local_config_for_tests)
    }
}

/// Create an empty MKVS store.
pub fn empty_store() -> MKVSStore<mkvs::OverlayTree<mkvs::Tree>> {
    let root = mkvs::OverlayTree::new(
        mkvs::Tree::builder()
            .with_root_type(mkvs::RootType::State)
            .build(Box::new(mkvs::sync::NoopReadSyncer)),
    );
    MKVSStore::new(root)
}

/// Create a new mock transaction.
pub fn transaction() -> transaction::Transaction {
    transaction::Transaction {
        version: 1,
        call: transaction::Call {
            format: transaction::CallFormat::Plain,
            method: "mock".to_owned(),
            body: cbor::Value::Simple(cbor::SimpleValue::NullValue),
            ..Default::default()
        },
        auth_info: transaction::AuthInfo {
            signer_info: vec![],
            fee: transaction::Fee {
                amount: Default::default(),
                gas: 1_000_000,
                consensus_messages: 32,
            },
            ..Default::default()
        },
    }
}

/// Options that can be used during mock signer calls.
#[derive(Clone, Debug)]
pub struct CallOptions {
    /// Transaction fee.
    pub fee: transaction::Fee,
}

impl Default for CallOptions {
    fn default() -> Self {
        Self {
            fee: transaction::Fee {
                amount: Default::default(),
                gas: 1_000_000,
                consensus_messages: 0,
            },
        }
    }
}

/// A mock signer for use during tests.
pub struct Signer {
    nonce: u64,
    sigspec: SignatureAddressSpec,
}

impl Signer {
    /// Create a new mock signer using the given nonce and signature spec.
    pub fn new(nonce: u64, sigspec: SignatureAddressSpec) -> Self {
        Self { nonce, sigspec }
    }

    /// Address specification for this signer.
    pub fn sigspec(&self) -> &SignatureAddressSpec {
        &self.sigspec
    }

    /// Dispatch a call to the given method.
    pub fn call<C, B>(&mut self, ctx: &C, method: &str, body: B) -> dispatcher::DispatchResult
    where
        C: Context,
        B: cbor::Encode,
    {
        self.call_opts(ctx, method, body, Default::default())
    }

    /// Dispatch a call to the given method with the given options.
    pub fn call_opts<C, B>(
        &mut self,
        ctx: &C,
        method: &str,
        body: B,
        opts: CallOptions,
    ) -> dispatcher::DispatchResult
    where
        C: Context,
        B: cbor::Encode,
    {
        let tx = transaction::Transaction {
            version: 1,
            call: transaction::Call {
                format: transaction::CallFormat::Plain,
                method: method.to_owned(),
                body: cbor::to_value(body),
                ..Default::default()
            },
            auth_info: transaction::AuthInfo {
                signer_info: vec![transaction::SignerInfo::new_sigspec(
                    self.sigspec.clone(),
                    self.nonce,
                )],
                fee: opts.fee,
                ..Default::default()
            },
        };

        let result = dispatcher::Dispatcher::<C::Runtime>::dispatch_tx(ctx, 1024, tx, 0)
            .expect("dispatch should work");

        // Increment the nonce.
        self.nonce += 1;

        result
    }

    /// Dispatch a query to the given method.
    pub fn query<C, A, R>(&self, ctx: &C, method: &str, args: A) -> Result<R, RuntimeError>
    where
        C: Context,
        A: cbor::Encode,
        R: cbor::Decode,
    {
        let result = CurrentState::with_transaction_opts(
            state::Options::new().with_mode(state::Mode::Check),
            || {
                let result = dispatcher::Dispatcher::<C::Runtime>::dispatch_query(
                    ctx,
                    method,
                    cbor::to_vec(args),
                );

                TransactionResult::Rollback(result)
            },
        )?;
        Ok(cbor::from_slice(&result).expect("result should decode correctly"))
    }
}