pchain_compile 0.4.3

ParallelChain Smart Contract Compile CLI - A command line tool for compiling ParallelChain Smart Contract.
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

/*
    Copyright © 2023, ParallelChain Lab
    Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0
*/

//! Defines enum of Error Codes for exiting the processes.

use thiserror::Error;

/// Describes the exit status codes during building process.
#[derive(Error, Debug)]
pub enum Error {
    #[error("Failure during building process.")]
    BuildFailure(String),

    #[error("Failure during building process.")]
    BuildFailureWithLogs(String),

    #[error("The building process took too long.")]
    BuildTimeout,

    #[error("Docker daemon service did not respond.")]
    DockerDaemonFailure,

    #[error("Some artifacts downloaded by pchain-compile were not successfully removed.")]
    ArtifactRemovalFailure,

    #[error("Manifest file not found.")]
    ManifestFailure,

    #[error("Source code path not valid.")]
    InvalidSourcePath,

    #[error("Destination path not valid.")]
    InvalidDestinationPath,

    #[error("Dependency path not valid.")]
    InvalidDependencyPath,

    #[error("Fails to create temporary directory.")]
    CreateTempDir,

    #[error("Unknown docker image tag")]
    UnkownDockerImageTag(String),
}

impl Error {
    pub fn detail(&self) -> String {
        match self {
            Error::ArtifactRemovalFailure => "The compilation was successful, but pchain-compile failed to stop its Docker containers. Please remove them manually.".to_string(), 
            Error::BuildFailure(e) => format!("\nDetails: {e}\nPlease rectify the errors and build your source code again."),
            Error::BuildFailureWithLogs(log) => format!("There maybe some problems in the source code.\nBuilding log is as follows:\n\n{log}\n"),
            Error::BuildTimeout => format!("The time used in the building process is abnormal. It is possible that the contract code is extraordinarily  large, or there is something wrong in your building environment (e.g. docker)."),
            Error::DockerDaemonFailure => "Failed to compile.\nDetails: Docker Daemon Failure. Check if Docker is running on your machine and confirm read/write access privileges.".to_string(),
            Error::ManifestFailure => "Failed to compile.\nDetails: Manifest File Not Found. Check if the manifest file exists on the source code path.".to_string(),
            Error::InvalidSourcePath => "Failed to compile.\nDetails: Source Code Path Not Valid. Check if you have provided the correct path to your source code directory and confirm write access privileges.".to_string(),
            Error::InvalidDestinationPath => "\nDetails: Destination Path Not Valid. Check if you have provided the correct path to save your optimized WASM binary and confirm write access privileges.".to_string(),
            Error::InvalidDependencyPath => "\nDetails: Dependency Paths Specified Within Smart Contract Crate Not Valid. Check if you have provided the correct path to the dependencies on your source".to_string(),
            Error::CreateTempDir => "\nDetails: The compilation process requires creating a temporary folder in your machine. Please check if the program has write permission to create folder.".to_string(),
            Error::UnkownDockerImageTag(tag) => format!("\nDetails: The docker image tag ({tag}) is not recognised. Please choose tag from dockerhub https://hub.docker.com/r/parallelchainlab/pchain_compile"),
        }
    }
}