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

use multiversx_sc_codec::{
    DecodeError, DecodeErrorHandler, TopDecode, TopDecodeInput, TopEncode, TopEncodeOutput, Vec,
};

use crate::{
    abi::{
        ExplicitEnumVariantDescription, TypeAbi, TypeAbiFrom, TypeContents, TypeDescription,
        TypeDescriptionContainer, TypeName,
    },
    api::ManagedTypeApi,
    codec::EncodeErrorHandler,
    types::ManagedBuffer,
};

const COMPLETED_STR: &str = "completed";
const INTERRUPTED_STR: &str = "interrupted";

/// Standard way of signalling that an operation was interrupted early, before running out of gas.
/// An endpoint that performs a longer operation can check from time to time if it is running low
/// on gas and can decide to save its state and exit, so that it can continue the same operation later.
#[derive(PartialEq, Eq, Debug, Clone, Copy)]
pub enum OperationCompletionStatus {
    Completed,
    InterruptedBeforeOutOfGas,
}

impl OperationCompletionStatus {
    pub fn output_bytes(&self) -> &'static [u8] {
        match self {
            OperationCompletionStatus::Completed => COMPLETED_STR.as_bytes(),
            OperationCompletionStatus::InterruptedBeforeOutOfGas => INTERRUPTED_STR.as_bytes(),
        }
    }

    pub fn is_completed(&self) -> bool {
        matches!(self, OperationCompletionStatus::Completed)
    }

    pub fn is_interrupted(&self) -> bool {
        matches!(self, OperationCompletionStatus::InterruptedBeforeOutOfGas)
    }
}

impl TopEncode for OperationCompletionStatus {
    fn top_encode_or_handle_err<O, H>(&self, output: O, _h: H) -> Result<(), H::HandledErr>
    where
        O: TopEncodeOutput,
        H: EncodeErrorHandler,
    {
        output.set_slice_u8(self.output_bytes());
        Ok(())
    }
}

impl TopDecode for OperationCompletionStatus {
    fn top_decode_or_handle_err<I, H>(input: I, h: H) -> Result<Self, H::HandledErr>
    where
        I: TopDecodeInput,
        H: DecodeErrorHandler,
    {
        const BUFFER_LEN: usize = 16;
        let mut buffer = [0u8; BUFFER_LEN];
        let len = input.into_max_size_buffer_align_right(&mut buffer, h)?;
        let bytes = &buffer[BUFFER_LEN - len..];

        if bytes.starts_with(COMPLETED_STR.as_bytes()) {
            Ok(OperationCompletionStatus::Completed)
        } else if bytes.starts_with(INTERRUPTED_STR.as_bytes()) {
            Ok(OperationCompletionStatus::InterruptedBeforeOutOfGas)
        } else {
            Err(h.handle_error(DecodeError::INVALID_VALUE))
        }
    }
}

impl<M: ManagedTypeApi> TypeAbiFrom<OperationCompletionStatus> for ManagedBuffer<M> {}
impl TypeAbiFrom<OperationCompletionStatus> for crate::types::heap::BoxedBytes {}
impl TypeAbiFrom<OperationCompletionStatus> for crate::types::heap::Vec<u8> {}

impl TypeAbiFrom<Self> for OperationCompletionStatus {}

impl TypeAbi for OperationCompletionStatus {
    type Unmanaged = Self;

    fn type_name() -> TypeName {
        TypeName::from("OperationCompletionStatus")
    }

    fn type_name_rust() -> TypeName {
        TypeName::from("OperationCompletionStatus")
    }

    fn provide_type_descriptions<TDC: TypeDescriptionContainer>(accumulator: &mut TDC) {
        let type_names = Self::type_names();

        accumulator.insert(
            type_names,
            TypeDescription {
                docs: Vec::new(),
                names: Self::type_names(),
                contents: TypeContents::ExplicitEnum([
                    ExplicitEnumVariantDescription::new(
                        &["indicates that operation was completed"],
                        COMPLETED_STR,
                    ),
                    ExplicitEnumVariantDescription::new(
                        &["indicates that operation was interrupted prematurely, due to low gas"],
                        INTERRUPTED_STR,
                    )
                ].to_vec()),
                macro_attributes: Vec::new()
            },
        );
    }
}

////////////////////////////////////////////////////////////////////////////////

#[cfg(test)]
mod tests {
    use multiversx_sc_codec::test_util::check_top_encode_decode;

    use super::*;

    #[test]
    fn test_operation_completion_status_is() {
        assert!(OperationCompletionStatus::Completed.is_completed());
        assert!(!OperationCompletionStatus::Completed.is_interrupted());
        assert!(!OperationCompletionStatus::InterruptedBeforeOutOfGas.is_completed());
        assert!(OperationCompletionStatus::InterruptedBeforeOutOfGas.is_interrupted());
    }

    #[test]
    fn test_codec_decode_operation_completion() {
        check_top_encode_decode(
            OperationCompletionStatus::Completed,
            COMPLETED_STR.as_bytes(),
        );
        check_top_encode_decode(
            OperationCompletionStatus::InterruptedBeforeOutOfGas,
            INTERRUPTED_STR.as_bytes(),
        );
    }
}