leo_package/
compilation_unit.rs

1// Copyright (C) 2019-2026 Provable Inc.
2// This file is part of the Leo library.
3
4// The Leo library is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8
9// The Leo library is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13
14// You should have received a copy of the GNU General Public License
15// along with the Leo library. If not, see <https://www.gnu.org/licenses/>.
16
17use crate::{MAX_PROGRAM_SIZE, *};
18
19use leo_errors::Result;
20use leo_span::Symbol;
21
22use snarkvm::prelude::{Program as SvmProgram, TestnetV0};
23
24use indexmap::{IndexMap, IndexSet};
25use std::path::Path;
26
27/// Find the latest cached edition for a program in the local registry.
28/// Returns None if no cached version exists.
29fn find_cached_edition(cache_directory: &Path, name: &str) -> Option<u16> {
30    let program_cache = cache_directory.join(name);
31    if !program_cache.exists() {
32        return None;
33    }
34
35    // List edition directories and find the highest one
36    std::fs::read_dir(&program_cache)
37        .ok()?
38        .filter_map(|entry| entry.ok())
39        .filter_map(|entry| {
40            let file_name = entry.file_name();
41            let name = file_name.to_str()?;
42            name.parse::<u16>().ok()
43        })
44        .max()
45}
46
47/// The kind of a Leo compilation unit: a deployable program, a library, or a test.
48#[derive(Clone, Debug, PartialEq, Eq)]
49pub enum PackageKind {
50    /// A deployable program with a `main.leo` entry point.
51    Program,
52    /// A library with a `lib.leo` entry point; not directly deployable.
53    Library,
54    /// A test file; compiled only during `leo test`.
55    Test,
56}
57
58impl PackageKind {
59    pub fn is_program(&self) -> bool {
60        matches!(self, Self::Program)
61    }
62
63    pub fn is_library(&self) -> bool {
64        matches!(self, Self::Library)
65    }
66
67    pub fn is_test(&self) -> bool {
68        matches!(self, Self::Test)
69    }
70}
71
72/// Information about a single Leo compilation unit.
73#[derive(Clone, Debug)]
74pub struct CompilationUnit {
75    // The name of the program. For local packages this is the bare name (no ".aleo" suffix,
76    // e.g. `my_program` or `my_lib`). For network-fetched programs this includes the ".aleo"
77    // suffix (e.g. `credits.aleo`). TODO: unify the invariant so the suffix is always absent.
78    pub name: Symbol,
79    pub data: ProgramData,
80    pub edition: Option<u16>,
81    pub dependencies: IndexSet<Dependency>,
82    pub is_local: bool,
83    pub kind: PackageKind,
84}
85
86impl CompilationUnit {
87    /// Given the location `path` of a `.aleo` file, read the filesystem
88    /// to obtain a `CompilationUnit`.
89    pub fn from_aleo_path<P: AsRef<Path>>(name: Symbol, path: P, map: &IndexMap<Symbol, Dependency>) -> Result<Self> {
90        Self::from_aleo_path_impl(name, path.as_ref(), map)
91    }
92
93    fn from_aleo_path_impl(name: Symbol, path: &Path, map: &IndexMap<Symbol, Dependency>) -> Result<Self> {
94        let bytecode = std::fs::read_to_string(path).map_err(|e| {
95            crate::errors::util_file_io_error(format_args!("Trying to read aleo file at {}", path.display()), e)
96        })?;
97
98        let dependencies = parse_dependencies_from_aleo(name, &bytecode, map)?;
99
100        Ok(CompilationUnit {
101            name,
102            data: ProgramData::Bytecode(bytecode),
103            edition: None,
104            dependencies,
105            is_local: true,
106            kind: PackageKind::Program,
107        })
108    }
109
110    /// Given the location `path` of a local Leo package, read the filesystem
111    /// to obtain a `CompilationUnit`.
112    pub fn from_package_path<P: AsRef<Path>>(name: Symbol, path: P) -> Result<Self> {
113        Self::from_package_path_impl(name, path.as_ref())
114    }
115
116    fn from_package_path_impl(name: Symbol, path: &Path) -> Result<Self> {
117        let manifest = Manifest::read_from_file(path.join(MANIFEST_FILENAME))?;
118        let manifest_symbol = crate::symbol(&manifest.program)?;
119        if name != manifest_symbol {
120            return Err(
121                crate::errors::conflicting_manifest(format_args!("{name}"), format_args!("{manifest_symbol}")).into()
122            );
123        }
124        let source_directory = path.join(SOURCE_DIRECTORY);
125        source_directory.read_dir().map_err(|e| {
126            crate::errors::util_file_io_error(
127                format_args!("Failed to read directory {}", source_directory.display()),
128                e,
129            )
130        })?;
131
132        let main_path = source_directory.join(MAIN_FILENAME);
133        let lib_path = source_directory.join(LIB_FILENAME);
134
135        let (source_path, kind) = match (main_path.exists(), lib_path.exists()) {
136            (true, true) => {
137                return Err(crate::errors::ambiguous_entry_file(
138                    source_directory.display(),
139                    MAIN_FILENAME,
140                    LIB_FILENAME,
141                )
142                .into());
143            }
144            (true, false) => (main_path, PackageKind::Program),
145            (false, true) => (lib_path, PackageKind::Library),
146            (false, false) => {
147                return Err(
148                    crate::errors::invalid_entry_file(source_directory.display(), MAIN_FILENAME, LIB_FILENAME).into()
149                );
150            }
151        };
152
153        Ok(CompilationUnit {
154            name,
155            data: ProgramData::SourcePath { directory: path.to_path_buf(), source: source_path },
156            edition: None,
157            dependencies: manifest
158                .dependencies
159                .unwrap_or_default()
160                .into_iter()
161                .map(|dependency| {
162                    let dep = canonicalize_dependency_path_relative_to(path, dependency)?;
163                    if dep.location == Location::Workspace { resolve_workspace_dependency(path, dep) } else { Ok(dep) }
164                })
165                .collect::<Result<IndexSet<_>, _>>()?,
166            is_local: true,
167            kind,
168        })
169    }
170
171    /// Given the path to the source file of a test, create a `CompilationUnit`.
172    ///
173    /// Unlike `CompilationUnit::from_package_path`, the path is to the source file,
174    /// and the name of the program is determined from the filename.
175    ///
176    /// `main_program` must be provided since every test is dependent on it.
177    pub fn from_test_path<P: AsRef<Path>>(source_path: P, main_program: Dependency) -> Result<Self> {
178        Self::from_path_test_impl(source_path.as_ref(), main_program)
179    }
180
181    fn from_path_test_impl(source_path: &Path, main_program: Dependency) -> Result<Self> {
182        let name = filename_no_leo_extension(source_path)
183            .ok_or_else(|| crate::errors::failed_path(source_path.display(), ""))?;
184        let test_directory = source_path.parent().ok_or_else(|| {
185            crate::errors::failed_to_open_file(format_args!(
186                "Failed to find directory for test {}",
187                source_path.display()
188            ))
189        })?;
190        let package_directory = test_directory.parent().ok_or_else(|| {
191            crate::errors::failed_to_open_file(format_args!(
192                "Failed to find package for test {}",
193                source_path.display()
194            ))
195        })?;
196        let manifest = Manifest::read_from_file(package_directory.join(MANIFEST_FILENAME))?;
197        let mut dependencies = manifest
198            .dev_dependencies
199            .unwrap_or_default()
200            .into_iter()
201            .map(|dependency| {
202                let dep = canonicalize_dependency_path_relative_to(package_directory, dependency)?;
203                if dep.location == Location::Workspace {
204                    resolve_workspace_dependency(package_directory, dep)
205                } else {
206                    Ok(dep)
207                }
208            })
209            .collect::<Result<IndexSet<_>, _>>()?;
210        dependencies.insert(main_program);
211
212        Ok(CompilationUnit {
213            name: Symbol::intern(&(name.to_owned() + ".aleo")),
214            edition: None,
215            data: ProgramData::SourcePath {
216                directory: test_directory.to_path_buf(),
217                source: source_path.to_path_buf(),
218            },
219            dependencies,
220            is_local: true,
221            kind: PackageKind::Test,
222        })
223    }
224
225    /// Given an Aleo program on a network, fetch it to build a `CompilationUnit`.
226    /// If no edition is found, the latest edition is pulled from the network.
227    pub fn fetch<P: AsRef<Path>>(
228        name: Symbol,
229        edition: Option<u16>,
230        home_path: P,
231        network: NetworkName,
232        endpoint: &str,
233        no_cache: bool,
234        network_retries: u32,
235    ) -> Result<Self> {
236        Self::fetch_impl(name, edition, home_path.as_ref(), network, endpoint, no_cache, network_retries)
237    }
238
239    fn fetch_impl(
240        name: Symbol,
241        edition: Option<u16>,
242        home_path: &Path,
243        network: NetworkName,
244        endpoint: &str,
245        no_cache: bool,
246        network_retries: u32,
247    ) -> Result<Self> {
248        // Callers may pass the name with or without the ".aleo" suffix; normalise to bare name
249        // here so cache paths and network URLs are constructed consistently.
250        let name = Symbol::intern(name.to_string().strip_suffix(".aleo").unwrap_or(&name.to_string()));
251
252        // It's not a local program; let's check the cache.
253        let cache_directory = home_path.join(format!("registry/{network}"));
254
255        // If the edition is not specified, try to find a cached version first,
256        // then fall back to querying the network for the latest edition.
257        let edition = match edition {
258            // Credits program always has edition 0.
259            _ if name == Symbol::intern("credits") => 0,
260            Some(edition) => edition,
261            None if !no_cache => {
262                // Check if we have a cached version - avoid network call if possible.
263                match find_cached_edition(&cache_directory, &name.to_string()) {
264                    Some(cached_edition) => cached_edition,
265                    None => crate::fetch_latest_edition(&name.to_string(), endpoint, network, network_retries)?,
266                }
267            }
268            // no_cache is set - user wants fresh data from network.
269            None => crate::fetch_latest_edition(&name.to_string(), endpoint, network, network_retries)?,
270        };
271
272        // Define the full cache path for the program.
273
274        // Build cache paths.
275        let cache_directory = cache_directory.join(format!("{name}/{edition}"));
276        let full_cache_path = cache_directory.join(format!("{name}.aleo"));
277        if !cache_directory.exists() {
278            // Create directory if it doesn't exist.
279            std::fs::create_dir_all(&cache_directory).map_err(|err| {
280                crate::errors::util_file_io_error(format!("Could not write path {}", cache_directory.display()), err)
281            })?;
282        }
283
284        // Get the existing bytecode if the file exists.
285        let existing_bytecode = match full_cache_path.exists() {
286            false => None,
287            true => {
288                let existing_contents = std::fs::read_to_string(&full_cache_path).map_err(|e| {
289                    crate::errors::util_file_io_error(
290                        format_args!("Trying to read cached file at {}", full_cache_path.display()),
291                        e,
292                    )
293                })?;
294                Some(existing_contents)
295            }
296        };
297
298        let bytecode = match (existing_bytecode, no_cache) {
299            // If we are using the cache, we can just return the bytecode.
300            (Some(bytecode), false) => bytecode,
301            // Otherwise, we need to fetch it from the network.
302            (existing, _) => {
303                // Define the primary URL to fetch the program from.
304                let primary_url = if name == Symbol::intern("credits") {
305                    format!("{endpoint}/{network}/program/credits.aleo")
306                } else {
307                    format!("{endpoint}/{network}/program/{name}.aleo/{edition}")
308                };
309                let secondary_url = format!("{endpoint}/{network}/program/{name}.aleo");
310                let contents = fetch_from_network(&primary_url, network_retries)
311                    .or_else(|_| fetch_from_network(&secondary_url, network_retries))
312                    .map_err(|err| {
313                        crate::errors::failed_to_retrieve_from_endpoint(
314                            primary_url,
315                            format_args!("Failed to fetch program `{name}` from network `{network}`: {err}"),
316                        )
317                    })?;
318
319                // If the file already exists, compare it to the new contents.
320                if let Some(existing_contents) = existing
321                    && existing_contents != contents
322                {
323                    println!(
324                        "Warning: The cached file at `{}` is different from the one fetched from the network. The cached file will be overwritten.",
325                        full_cache_path.display()
326                    );
327                }
328
329                // Write the bytecode to the cache.
330                std::fs::write(&full_cache_path, &contents).map_err(|err| {
331                    crate::errors::util_file_io_error(
332                        format_args!("Could not open file `{}`", full_cache_path.display()),
333                        err,
334                    )
335                })?;
336
337                contents
338            }
339        };
340
341        let dependencies = parse_dependencies_from_aleo(name, &bytecode, &IndexMap::new())?;
342
343        Ok(CompilationUnit {
344            // Network programs store the name with the ".aleo" suffix (unlike local packages).
345            // TODO: unify the invariant so the suffix is always absent.
346            name: Symbol::intern(&(name.to_string() + ".aleo")),
347            data: ProgramData::Bytecode(bytecode),
348            edition: Some(edition),
349            dependencies,
350            is_local: false,
351            kind: PackageKind::Program,
352        })
353    }
354}
355
356/// If `dependency` has a relative path, assume it's relative to `base` and canonicalize it.
357///
358/// This needs to be done when collecting local dependencies from manifests which
359/// may be located at different places on the file system.
360pub(crate) fn canonicalize_dependency_path_relative_to(base: &Path, mut dependency: Dependency) -> Result<Dependency> {
361    if let Some(path) = &mut dependency.path
362        && !path.is_absolute()
363    {
364        let joined = base.join(&path);
365        *path = joined.canonicalize().map_err(|e| crate::errors::failed_path(joined.display(), e))?;
366    }
367    Ok(dependency)
368}
369
370/// Parse the `.aleo` file's imports and construct `Dependency`s.
371fn parse_dependencies_from_aleo(
372    name: Symbol,
373    bytecode: &str,
374    existing: &IndexMap<Symbol, Dependency>,
375) -> Result<IndexSet<Dependency>> {
376    // Check if the program size exceeds the maximum allowed limit.
377    let program_size = bytecode.len();
378
379    if program_size > MAX_PROGRAM_SIZE {
380        return Err(leo_errors::LeoError::Backtraced(crate::errors::program_size_limit_exceeded(
381            name,
382            program_size,
383            MAX_PROGRAM_SIZE,
384        )));
385    }
386
387    // Parse the bytecode into an SVM program.
388    let svm_program: SvmProgram<TestnetV0> =
389        bytecode.parse().map_err(|_| crate::errors::snarkvm_parsing_error(name))?;
390    let dependencies = svm_program
391        .imports()
392        .keys()
393        .map(|program_id| {
394            // If the dependency already exists, use it.
395            // Otherwise, assume it's a network dependency.
396            if let Some(dependency) = existing.get(&Symbol::intern(&program_id.to_string())) {
397                dependency.clone()
398            } else {
399                let name = program_id.to_string();
400                Dependency { name, location: Location::Network, path: None, edition: None }
401            }
402        })
403        .collect();
404    Ok(dependencies)
405}
leo_package/compilation_unit.rs

leo_package/
compilation_unit.rs
