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
//! Inkpad executor result
use crate::{
trap::{Trap, TrapCode},
Value,
};
use inkpad_std::{fmt, format, String, Vec};
use parity_scale_codec::{Decode, Encode};
bitflags::bitflags! {
/// Flags used by a contract to customize exit behaviour.
#[derive(Encode, Decode, Default)]
pub struct ReturnFlags: u32 {
/// If this bit is set all changes made by the contract execution are rolled back.
const REVERT = 0x0000_0001;
}
}
/// Successful Return data
#[derive(PartialEq, Eq, Debug, Clone, Default, Encode, Decode)]
pub struct ReturnData {
/// Flags passed along by `seal_return`. Empty when `seal_return` was never called.
pub flags: ReturnFlags,
/// Buffer passed along by `seal_return`. Empty when `seal_return` was never called.
pub data: Vec<u8>,
}
#[repr(i32)]
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
pub enum ReturnCode {
/// API call successful.
Success = 0,
/// The called function trapped and has its state changes reverted.
/// In this case no output buffer is returned.
CalleeTrapped = 1,
/// The called function ran to completion but decided to revert its state.
/// An output buffer is returned when one was supplied.
CalleeReverted = 2,
/// The passed key does not exist in storage.
KeyNotFound = 3,
/// Transfer failed because it would have brought the sender's total balance below the
/// subsistence threshold.
BelowSubsistenceThreshold = 4,
/// Transfer failed for other reasons. Most probably reserved or locked balance of the
/// sender prevents the transfer.
TransferFailed = 5,
/// The newly created contract is below the subsistence threshold after executing
/// its constructor.
NewContractNotFunded = 6,
/// No code could be found at the supplied code hash.
CodeNotFound = 7,
/// The contract that was called is either no contract at all (a plain account)
/// or is a tombstone.
NotCallable = 8,
/// The call to `seal_debug_message` had no effect because debug message
/// recording was disabled.
LoggingDisabled = 9,
/// The call dispatched by `seal_call_runtime` was executed but returned an error.
CallRuntimeReturnedError = 10,
/// ECDSA pubkey recovery failed. Most probably wrong recovery id or signature.
EcdsaRecoverFailed = 11,
/// Unexpected return code
UnExpectedReturnCode = 12,
}
impl From<i32> for ReturnCode {
fn from(n: i32) -> ReturnCode {
match n {
0 => ReturnCode::Success,
1 => ReturnCode::CalleeTrapped,
2 => ReturnCode::CalleeReverted,
3 => ReturnCode::KeyNotFound,
4 => ReturnCode::BelowSubsistenceThreshold,
5 => ReturnCode::TransferFailed,
6 => ReturnCode::NewContractNotFunded,
7 => ReturnCode::CodeNotFound,
8 => ReturnCode::NotCallable,
9 => ReturnCode::LoggingDisabled,
_ => ReturnCode::UnExpectedReturnCode,
}
}
}
/// Inkpad executor errors
#[derive(Debug, Eq, PartialEq, Clone)]
pub enum Error {
InitMemoryFailed,
/// Memory outof bounds
OutOfBounds,
InitModuleFailed,
ExecuteFailed(ReturnCode),
UnkownError,
Trap(Trap),
GetFunctionNameFailed,
CreateWasmtimeConfigFailed,
GetExternalFailed(String),
DecodeRuntimeValueFailed,
OutputBufferTooSmall,
WrongArugmentLength,
SetStorageFailed,
Return(ReturnData),
/// Topics
TooManyTopics,
DuplicateTopics,
TopicValueTooLarge,
/// Gas
OutOfGas,
/// Custom Error
Custom(&'static str),
/// Unexpected return value
UnExpectedReturnValue,
ParseWasmModuleFailed,
ExecutorNotInited,
CodeNotFound,
ExitedAllFrames,
CalcuateMemoryLimitFailed,
InitExecutorFailed,
DecodeBucketFailed([u8; 32]),
MemoryNotFound,
SerializationError(String),
StateNotFound,
CodeHashNotFound,
DecodeContractFailed,
FlushDataFailed,
}
impl From<parity_wasm::SerializationError> for Error {
fn from(e: parity_wasm::SerializationError) -> Error {
Error::SerializationError(format!("{}", e))
}
}
impl From<&'static str> for Error {
fn from(e: &'static str) -> Error {
Error::Custom(e)
}
}
#[cfg(feature = "wasmtime")]
impl std::error::Error for Error {}
impl fmt::Display for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{:?}", self)
}
}
/// Inkpad executor result
pub type Result<T> = core::result::Result<T, Error>;
/// Wasm function execution result
#[derive(Clone, Default)]
pub struct ExecResult {
pub data: ReturnData,
pub value: Value,
}
impl ExecResult {
/// from execution result
pub fn from_res(v: Result<Value>) -> Result<ExecResult> {
Ok(match v {
Ok(value) => ExecResult {
value,
..Default::default()
},
Err(Error::Trap(Trap {
code: TrapCode::HostError(e),
trace: _,
})) => Self::from_res(Err(*e))?,
Err(Error::Return(data)) => {
if data.flags.contains(ReturnFlags::REVERT) {
return Err(Error::ExecuteFailed(ReturnCode::CalleeReverted));
}
ExecResult {
data,
..Default::default()
}
}
Err(e) => return Err(e),
})
}
}