revive-solc-json-interface 1.1.0

Rust bindings for the solc standard JSON and combined JSON interface
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
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

//! The `solc --standard-json` input settings.

pub mod libraries;
pub mod metadata;
pub mod metadata_hash;
pub mod optimizer;
pub mod polkavm;
pub mod selection;
#[cfg(feature = "resolc")]
pub mod warning;

use std::collections::BTreeSet;

use serde::Deserialize;
use serde::Serialize;

use self::libraries::Libraries;
use self::metadata::Metadata;
use self::optimizer::Optimizer;
use self::polkavm::PolkaVM;
use self::selection::Selection;
#[cfg(feature = "resolc")]
use self::warning::Warning;

/// The `solc --standard-json` input settings.
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Settings {
    /// The target EVM version.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub evm_version: Option<revive_common::EVMVersion>,
    /// The linker library addresses.
    #[serde(default, skip_serializing_if = "Libraries::is_empty")]
    pub libraries: Libraries,
    /// The sorted list of remappings.
    #[serde(default, skip_serializing_if = "BTreeSet::is_empty")]
    pub remappings: BTreeSet<String>,
    /// The output selection filters.
    #[serde(default)]
    pub output_selection: Selection,
    /// Whether to compile via IR. Only for testing with solc >=0.8.13.
    #[serde(
        rename = "viaIR",
        skip_serializing_if = "Option::is_none",
        skip_deserializing
    )]
    pub via_ir: Option<bool>,
    /// The optimizer settings.
    pub optimizer: Optimizer,
    /// The metadata settings.
    #[serde(default)]
    pub metadata: Metadata,
    /// The resolc custom PolkaVM settings.
    #[serde(default, skip_serializing)]
    pub polkavm: PolkaVM,

    /// The suppressed warnings.
    #[cfg(feature = "resolc")]
    #[serde(default, skip_serializing)]
    pub suppressed_warnings: Vec<self::warning::Warning>,

    /// The extra LLVM arguments.
    #[cfg(feature = "resolc")]
    #[serde(default, alias = "LLVMOptions", skip_serializing)]
    pub llvm_arguments: Vec<String>,

    /// Whether to enable the missing libraries detection mode.
    /// Deprecated in favor of post-compile-time linking.
    #[serde(default, rename = "detectMissingLibraries", skip_serializing)]
    pub detect_missing_libraries: bool,
}

#[cfg(feature = "resolc")]
impl Settings {
    /// A shortcut constructor.
    pub fn new(
        evm_version: Option<revive_common::EVMVersion>,
        libraries: Libraries,
        remappings: BTreeSet<String>,
        output_selection: Selection,
        optimizer: Optimizer,
        metadata: Metadata,
        polkavm: PolkaVM,
        suppressed_warnings: Vec<Warning>,
        llvm_arguments: Vec<String>,
        detect_missing_libraries: bool,
    ) -> Self {
        Self {
            evm_version,
            libraries,
            remappings,
            output_selection,
            optimizer,
            metadata,
            via_ir: Some(true),
            polkavm,
            suppressed_warnings,
            llvm_arguments,
            detect_missing_libraries,
        }
    }

    /// Extends the output selection with another one.
    pub fn extend_selection(&mut self, selection: Selection) {
        self.output_selection.extend(selection);
    }

    /// Returns flags that are going to be automatically added by the compiler,
    /// but were not explicitly requested by the user.
    ///
    /// Afterwards, the flags are used to prune JSON output before returning it.
    pub fn selection_to_prune(&self) -> Selection {
        self.output_selection.selection_to_prune()
    }

    /// Removes unneeded selections.
    pub fn retain_output_selection(&mut self) {
        self.output_selection.retain();
    }
}