ink_env/error.rs
1// Copyright (C) Use Ink (UK) Ltd.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use derive_more::From;
16
17#[cfg(any(feature = "std", test, doc))]
18use crate::engine::off_chain::OffChainError;
19use pallet_revive_uapi::ReturnErrorCode;
20
21/// Errors that can be encountered upon environmental interaction.
22#[derive(Debug, From, PartialEq)]
23pub enum Error {
24 /// Error upon decoding an encoded value.
25 Decode(scale::Error),
26 /// Error upon decoding with the Solidity ABI encoding.
27 DecodeSol(alloy_sol_types::Error),
28 /// The static buffer used during ABI encoding or ABI decoding is too small.
29 BufferTooSmall,
30 /// An error that can only occur in the off-chain environment.
31 #[cfg(any(feature = "std", test, doc))]
32 OffChain(OffChainError),
33 /// The error returned by the contract.
34 ReturnError(ReturnErrorCode),
35}
36
37/// A result of environmental operations.
38pub type Result<T> = core::result::Result<T, Error>;