provekit_noirc_artifacts 1.0.0-beta.20-alpha.1

Definitions of Nargo's build artifacts
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
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

use acvm::{FieldElement, acir::circuit::Program};
use noirc_abi::{Abi, AbiType, AbiValue};
use serde::{Deserialize, Serialize};

use std::collections::{BTreeMap, HashMap};

use fm::FileId;

use crate::{
    debug::{DebugFile, DebugInfo, ProgramDebugInfo},
    program::CompiledProgram,
    ssa::SsaReport,
};

use super::{deserialize_hash, serialize_hash};

#[derive(Clone, Serialize, Deserialize, Debug)]
pub struct ContractOutputsArtifact {
    pub structs: HashMap<String, Vec<AbiType>>,
    pub globals: HashMap<String, Vec<AbiValue>>,
}

impl From<CompiledContractOutputs> for ContractOutputsArtifact {
    fn from(outputs: CompiledContractOutputs) -> Self {
        ContractOutputsArtifact { structs: outputs.structs, globals: outputs.globals }
    }
}

#[derive(Clone, Serialize, Deserialize, Debug)]
pub struct ContractArtifact {
    /// Version of noir used to compile this contract
    pub noir_version: String,
    /// The name of the contract.
    pub name: String,
    /// Each of the contract's functions are compiled into a separate program stored in this `Vec`.
    pub functions: Vec<ContractFunctionArtifact>,

    pub outputs: ContractOutputsArtifact,
    /// Map of file Id to the source code so locations in debug info can be mapped to source code they point to.
    pub file_map: BTreeMap<FileId, DebugFile>,
}

impl From<CompiledContract> for ContractArtifact {
    fn from(contract: CompiledContract) -> Self {
        ContractArtifact {
            noir_version: contract.noir_version,
            name: contract.name,
            functions: contract.functions.into_iter().map(ContractFunctionArtifact::from).collect(),
            outputs: contract.outputs.into(),
            file_map: contract.file_map,
        }
    }
}

impl ContractArtifact {
    pub fn function_as_compiled_program(&self, function_name: &str) -> Option<CompiledProgram> {
        self.functions.iter().find(|f| f.name == function_name).map(|f| {
            f.clone().into_compiled_program(self.noir_version.clone(), self.file_map.clone())
        })
    }
}

/// Each function in the contract will be compiled as a separate noir program.
///
/// A contract function unlike a regular Noir program however can have additional properties.
/// One of these being a function type.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ContractFunctionArtifact {
    pub name: String,

    /// Hash of the monomorphized program from which the [`ContractFunction`] was compiled.
    #[serde(default)] // For backwards compatibility (it was missing).
    #[serde(serialize_with = "serialize_hash", deserialize_with = "deserialize_hash")]
    pub hash: u64,

    pub is_unconstrained: bool,

    pub custom_attributes: Vec<String>,

    pub abi: Abi,

    #[serde(
        serialize_with = "Program::serialize_program_base64",
        deserialize_with = "Program::deserialize_program_base64"
    )]
    pub bytecode: Program<FieldElement>,

    #[serde(
        serialize_with = "ProgramDebugInfo::serialize_compressed_base64_json",
        deserialize_with = "ProgramDebugInfo::deserialize_compressed_base64_json"
    )]
    pub debug_symbols: ProgramDebugInfo,
}

impl ContractFunctionArtifact {
    pub fn into_compiled_program(
        self,
        noir_version: String,
        file_map: BTreeMap<FileId, DebugFile>,
    ) -> CompiledProgram {
        CompiledProgram {
            noir_version,
            hash: self.hash,
            program: self.bytecode,
            abi: self.abi,
            debug: self.debug_symbols.debug_infos,
            file_map,
            warnings: Vec::new(),
        }
    }
}

impl From<ContractFunction> for ContractFunctionArtifact {
    fn from(func: ContractFunction) -> Self {
        ContractFunctionArtifact {
            name: func.name,
            hash: func.hash,
            is_unconstrained: func.is_unconstrained,
            custom_attributes: func.custom_attributes,
            abi: func.abi,
            bytecode: func.bytecode,
            debug_symbols: ProgramDebugInfo { debug_infos: func.debug },
        }
    }
}

#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct CompiledContractOutputs {
    pub structs: HashMap<String, Vec<AbiType>>,
    pub globals: HashMap<String, Vec<AbiValue>>,
}

#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct CompiledContract {
    pub noir_version: String,

    /// The name of the contract.
    pub name: String,
    /// Each of the contract's functions are compiled into a separate `CompiledProgram`
    /// stored in this `Vector`.
    pub functions: Vec<ContractFunction>,

    pub outputs: CompiledContractOutputs,

    pub file_map: BTreeMap<FileId, DebugFile>,
    pub warnings: Vec<SsaReport>,
}

/// Each function in the contract will be compiled
/// as a separate noir program.
///
/// A contract function unlike a regular Noir program
/// however can have additional properties.
/// One of these being a function type.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ContractFunction {
    pub name: String,

    pub hash: u64,

    pub is_unconstrained: bool,

    pub custom_attributes: Vec<String>,

    pub abi: Abi,

    #[serde(
        serialize_with = "Program::serialize_program_base64",
        deserialize_with = "Program::deserialize_program_base64"
    )]
    pub bytecode: Program<FieldElement>,

    pub debug: Vec<DebugInfo>,
}