snarkvm 4.6.2

A decentralized virtual machine
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

// Copyright (c) 2019-2026 Provable Inc.
// This file is part of the snarkVM library.

// 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.

use super::*;

impl<N: Network> Package<N> {
    /// Removes the build directory for the package.
    pub fn clean(directory: &Path) -> Result<()> {
        // Ensure the directory path exists.
        ensure!(directory.exists(), "The program directory does not exist: {}", directory.display());
        // Ensure the manifest file exists.
        ensure!(
            Manifest::<N>::exists_at(directory),
            "Missing '{}' at '{}'",
            Manifest::<N>::file_name(),
            directory.display()
        );
        // Ensure the main program file exists.
        ensure!(
            AleoFile::<N>::main_exists_at(directory),
            "Missing '{}' at '{}'",
            AleoFile::<N>::main_file_name(),
            directory.display()
        );

        // Prepare the build directory.
        let build_directory = directory.join("build");
        // Remove the build directory if it exists.
        if build_directory.exists() {
            std::fs::remove_dir_all(&build_directory)?;
        }

        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    type CurrentNetwork = snarkvm_console::network::MainnetV0;
    type CurrentAleo = snarkvm_circuit::network::AleoV0;

    #[test]
    fn test_clean() {
        // Samples a new package at a temporary directory.
        let (directory, package) = crate::package::test_helpers::sample_token_package();

        // Ensure the build directory does *not* exist.
        assert!(!package.build_directory().exists());
        // Clean the package.
        Package::<CurrentNetwork>::clean(&directory).unwrap();
        // Ensure the build directory still does *not* exist.
        assert!(!package.build_directory().exists());

        // Build the package.
        package.build::<CurrentAleo>().unwrap();

        // Ensure the build directory exists.
        assert!(package.build_directory().exists());
        // Clean the package.
        Package::<CurrentNetwork>::clean(&directory).unwrap();
        // Ensure the build directory does *not* exist.
        assert!(!package.build_directory().exists());

        // Proactively remove the temporary directory (to conserve space).
        std::fs::remove_dir_all(directory).unwrap();
    }

    #[test]
    fn test_clean_with_import() {
        // Samples a new package at a temporary directory.
        let (directory, package) = crate::package::test_helpers::sample_wallet_package();

        // Ensure the build directory does *not* exist.
        assert!(!package.build_directory().exists());
        // Clean the package.
        Package::<CurrentNetwork>::clean(&directory).unwrap();
        // Ensure the build directory still does *not* exist.
        assert!(!package.build_directory().exists());

        // Build the package.
        package.build::<CurrentAleo>().unwrap();

        // Ensure the build directory exists.
        assert!(package.build_directory().exists());
        // Clean the package.
        Package::<CurrentNetwork>::clean(&directory).unwrap();
        // Ensure the build directory does *not* exist.
        assert!(!package.build_directory().exists());

        // Proactively remove the temporary directory (to conserve space).
        std::fs::remove_dir_all(directory).unwrap();
    }
}