exonum 1.0.0

An extensible framework for blockchain software projects.
Documentation 
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

// Copyright 2020 The Exonum Team
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! The set of errors for the Dispatcher module.

use exonum_derive::ExecutionFail;

use crate::runtime::{ExecutionError, ExecutionFail};

/// List of possible core errors.
///
/// Note that in most cases you don't need to spawn a core error, unless your service is
/// providing some wrapper for core logic and should behave just like core.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[derive(ExecutionFail)]
#[execution_fail(crate = "crate", kind = "core")]
#[non_exhaustive]
pub enum CoreError {
    /// Runtime identifier is incorrect in this context.
    IncorrectRuntime = 0,
    /// Artifact identifier is unknown.
    UnknownArtifactId = 1,
    /// Artifact with the given identifier is already deployed.
    ArtifactAlreadyDeployed = 2,
    /// Artifact with the given identifier is not deployed.
    ArtifactNotDeployed = 3,
    /// Specified service name is already used.
    ServiceNameExists = 4,
    /// Specified service identifier is already used.
    ServiceIdExists = 5,
    /// Specified service is not active.
    ServiceNotActive = 6,
    /// Suitable runtime for the given service instance ID is not found.
    IncorrectInstanceId = 7,
    /// Maximum depth of the call stack has been reached.
    StackOverflow = 8,
    /// Service instance is already transitioning to a new status.
    ServicePending = 9,
    /// Requested service transition is invalid given the current service status.
    InvalidServiceTransition = 10,
    /// The artifact to migrate the service to is not a newer version of the current
    /// service artifact.
    CannotUpgradeService = 11,
    /// Attempt to rollback or flush migration for a service which has no pending migration.
    NoMigration = 12,
    /// An attempt to resume the service instance with the wrong artifact. The specified
    /// artifact has a different name or an inappropriate version.
    CannotResumeService = 13,
    /// Incorrect call handler: an inner call has returned an error, but it was not propagated.
    IncorrectCall = 14,
    /// Cannot unload artifact.
    CannotUnloadArtifact = 15,
}

impl CoreError {
    pub(crate) fn stack_overflow(max_depth: u64) -> ExecutionError {
        let description = format!(
            "Maximum depth of call stack ({}) has been reached.",
            max_depth
        );
        Self::StackOverflow.with_description(description)
    }
}