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
/*
 * AquaVM Workflow Engine
 *
 * Copyright (C) 2024 Fluence DAO
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation version 3 of the
 * License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

#![forbid(unsafe_code)]
#![warn(rust_2018_idioms)]
#![deny(
    dead_code,
    nonstandard_style,
    unused_imports,
    unused_mut,
    unused_variables,
    unused_unsafe,
    unreachable_patterns
)]

pub mod call_services;
pub mod executed_state;
pub mod key_utils;
pub mod test_runner;

pub mod native_test_runner;
pub mod wasm_test_runner;

pub use air::interpreter_data::*;

use air::ExecutionCidState;
pub use avm_interface::raw_outcome::*;
pub use avm_server::*;

use futures::future::LocalBoxFuture;

pub mod prelude {
    pub use super::*;
    pub use call_services::*;
    pub use executed_state::*;
    pub use test_runner::*;

    pub use air_interpreter_value::JValue;
    pub use serde_json::json;
}

pub type CallServiceClosure<'x> =
    Box<dyn Fn(CallRequestParams) -> LocalBoxFuture<'x, CallServiceResult> + 'static>;

use air_interpreter_value::JValue;

#[macro_export]
macro_rules! checked_call_vm {
    ($vm:expr, $test_run_parameters:expr, $script:expr, $prev_data:expr, $data:expr) => {{
        match $vm
            .call($script, $prev_data, $data, $test_run_parameters)
            .await
        {
            Ok(v) if v.ret_code != 0 => {
                panic!("VM returns a error: {} {}", v.ret_code, v.error_message)
            }
            Ok(v) => v,
            Err(err) => panic!("VM call failed: {}", err),
        }
    }};
}

#[macro_export]
macro_rules! call_vm {
    ($vm:expr, $test_run_parameters:expr, $script:expr, $prev_data:expr, $data:expr) => {
        match $vm
            .call($script, $prev_data, $data, $test_run_parameters)
            .await
        {
            Ok(v) => v,
            Err(err) => panic!("VM call failed: {}", err),
        }
    };
}

pub fn trace_from_result(result: &RawAVMOutcome) -> ExecutionTrace {
    let data = data_from_result(result);
    data.trace
}

pub fn data_from_result(result: &RawAVMOutcome) -> InterpreterData {
    let env = InterpreterDataEnvelope::try_from_slice(&result.data)
        .expect("default serializer shouldn't fail");
    InterpreterData::try_from_slice(&env.inner_data).expect("default serializer shouldn't fail")
}

pub fn env_from_result(result: &RawAVMOutcome) -> InterpreterDataEnvelope<'_> {
    InterpreterDataEnvelope::try_from_slice(&result.data)
        .expect("default serializer shouldn't fail")
}

pub fn raw_data_from_trace(
    trace: impl Into<ExecutionTrace>,
    cid_state: ExecutionCidState,
) -> Vec<u8> {
    let data = InterpreterDataEnvelope::from_execution_result(
        trace.into(),
        cid_state.into(),
        <_>::default(),
        0,
        semver::Version::new(1, 1, 1),
    );
    data.serialize().expect("default serializer shouldn't fail")
}

pub fn raw_data_from_trace_with_canon(
    trace: impl Into<ExecutionTrace>,
    cid_state: ExecutionCidState,
) -> Vec<u8> {
    let data = InterpreterDataEnvelope::from_execution_result(
        trace.into(),
        CidInfo {
            value_store: cid_state.value_tracker.into(),
            tetraplet_store: cid_state.tetraplet_tracker.into(),
            canon_element_store: cid_state.canon_element_tracker.into(),
            canon_result_store: cid_state.canon_result_tracker.into(),
            service_result_store: cid_state.service_result_agg_tracker.into(),
        },
        <_>::default(),
        0,
        semver::Version::new(1, 1, 1),
    );
    data.serialize().expect("default serializer shouldn't fail")
}

#[macro_export]
macro_rules! assert_next_pks {
    ($expected:expr, $actual:expr) => {
        let expected: std::collections::HashSet<_> =
            $expected.into_iter().map(|s| s.as_str()).collect();
        let actual: std::collections::HashSet<_> = $actual.iter().map(|s| *s).collect();

        assert_eq!(expected, actual)
    };
}

pub fn print_trace(result: &RawAVMOutcome, trace_name: &str) {
    let data = data_from_result(result);
    let trace = &data.trace;

    println!("trace {} (states_count: {}): [", trace_name, trace.len());
    for (id, state) in trace.iter().enumerate() {
        print!("  {id}: {state}");
        match state {
            ExecutedState::Call(call_result) => print_call_value(&data, call_result),
            ExecutedState::Canon(canon_result) => print_canon_values(&data, canon_result),
            ExecutedState::Par(_) | ExecutedState::Fold(_) | ExecutedState::Ap(_) => {}
        }
        println!();
    }
    println!("]");
}

fn print_call_value(data: &InterpreterData, call_result: &CallResult) {
    let service_result_cid = match call_result {
        CallResult::Executed(ValueRef::Unused(_)) | CallResult::RequestSentBy(_) => return,
        CallResult::Executed(ValueRef::Scalar(cid)) => cid,
        CallResult::Executed(ValueRef::Stream { cid, .. }) => cid,
        CallResult::Failed(cid) => cid,
    };

    let service_result = data
        .cid_info
        .service_result_store
        .get(service_result_cid)
        .unwrap_or_else(|| panic!("service result CID not found: {:?}", service_result_cid));
    let value = data
        .cid_info
        .value_store
        .get(&service_result.value_cid)
        .unwrap_or_else(|| panic!("value CID not found: {:?}", service_result.value_cid));
    print!(" => {:#?}", value);
}

fn print_canon_values(data: &InterpreterData, canon_result: &CanonResult) {
    let canon_result_cid = match canon_result {
        CanonResult::RequestSentBy(_) => return,
        CanonResult::Executed(cid) => cid,
    };
    let canon_agg = data
        .cid_info
        .canon_result_store
        .get(canon_result_cid)
        .unwrap_or_else(|| panic!("canon result CID not found: {:?}", canon_result_cid));
    let canon_vals: Vec<_> = canon_agg
        .values
        .iter()
        .map(|elt_cid| {
            let elt = data
                .cid_info
                .canon_element_store
                .get(elt_cid)
                .unwrap_or_else(|| panic!("canon element CID not found: {:?}", elt_cid));
            data.cid_info
                .value_store
                .get(&elt.value)
                .unwrap_or_else(|| panic!("value CID not found: {:?}", elt.value));
        })
        .collect();
    print!(" => {:?}", canon_vals)
}

#[macro_export]
macro_rules! rc {
    ($expr:expr) => {
        ::std::rc::Rc::new($expr)
    };
}

use air::ToErrorCode;
use air_interpreter_interface::INTERPRETER_SUCCESS;

pub fn is_interpreter_succeded(result: &RawAVMOutcome) -> bool {
    result.ret_code == INTERPRETER_SUCCESS
}

pub fn check_error(result: &RawAVMOutcome, error: impl ToErrorCode + ToString) -> bool {
    result.ret_code == error.to_error_code() && result.error_message == error.to_string()
}

#[macro_export]
macro_rules! assert_error_eq {
    ($result:expr, $error:expr $(,)?) => {{
        let result: &::air_test_utils::RawAVMOutcome = $result;
        let error = $error;
        ::std::assert_eq!(
            (result.ret_code, &result.error_message),
            (::air::ToErrorCode::to_error_code(&error), &::std::string::ToString::to_string(&error))
        );
    }};
    ($result:expr, $error:expr, $($arg:tt)+) => {{
        let result: &::air_test_utils::RawAVMOutcome = $result;
        let error = $error;
        ::std::assert_eq!(
            (result.ret_code, &result.error_message),
            (::air::ToErrorCode::to_error_code(&error), &::std::string::ToString::to_string(&error)),
            $($arg)+
        );
    }};
}