leo_lang/cli/commands/
deploy.rs

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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
// Copyright (C) 2019-2025 Provable Inc.
// This file is part of the Leo library.

// The Leo library is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// The Leo library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with the Leo library. If not, see <https://www.gnu.org/licenses/>.

use super::*;
use aleo_std::StorageMode;
use dialoguer::{Confirm, theme::ColorfulTheme};
use leo_retriever::NetworkName;
use num_format::{Locale, ToFormattedString};
use snarkvm::{
    circuit::{Aleo, AleoTestnetV0},
    ledger::query::Query as SnarkVMQuery,
    package::Package as SnarkVMPackage,
    prelude::{
        ProgramOwner,
        TestnetV0,
        VM,
        deployment_cost,
        store::{ConsensusStore, helpers::memory::ConsensusMemory},
    },
};
#[cfg(not(feature = "only_testnet"))]
use snarkvm::{
    circuit::{AleoCanaryV0, AleoV0},
    prelude::{CanaryV0, MainnetV0},
};
use std::path::PathBuf;
use text_tables;

/// Deploys an Aleo program.
#[derive(Parser, Debug)]
pub struct Deploy {
    #[clap(flatten)]
    pub(crate) fee_options: FeeOptions,
    #[clap(long, help = "Disables building of the project before deployment.", default_value = "false")]
    pub(crate) no_build: bool,
    #[clap(long, help = "Enables recursive deployment of dependencies.", default_value = "false")]
    pub(crate) recursive: bool,
    #[clap(
        long,
        help = "Time in seconds to wait between consecutive deployments. This is to help prevent a program from trying to be included in an earlier block than its dependency program.",
        default_value = "12"
    )]
    pub(crate) wait: u64,
    #[clap(flatten)]
    pub(crate) options: BuildOptions,
}

impl Command for Deploy {
    type Input = ();
    type Output = ();

    fn log_span(&self) -> Span {
        tracing::span!(tracing::Level::INFO, "Leo")
    }

    fn prelude(&self, context: Context) -> Result<Self::Input> {
        if !self.no_build {
            (LeoBuild { options: self.options.clone() }).execute(context)?;
        }
        Ok(())
    }

    fn apply(self, context: Context, _: Self::Input) -> Result<Self::Output> {
        // Parse the network.
        let network = NetworkName::try_from(context.get_network(&self.options.network)?)?;
        let endpoint = context.get_endpoint(&self.options.endpoint)?;
        match network {
            NetworkName::TestnetV0 => handle_deploy::<AleoTestnetV0, TestnetV0>(&self, context, network, &endpoint),
            NetworkName::MainnetV0 => {
                #[cfg(feature = "only_testnet")]
                panic!("Mainnet chosen with only_testnet feature");
                #[cfg(not(feature = "only_testnet"))]
                return handle_deploy::<AleoV0, MainnetV0>(&self, context, network, &endpoint);
            }
            NetworkName::CanaryV0 => {
                #[cfg(feature = "only_testnet")]
                panic!("Canary chosen with only_testnet feature");
                #[cfg(not(feature = "only_testnet"))]
                return handle_deploy::<AleoCanaryV0, CanaryV0>(&self, context, network, &endpoint);
            }
        }
    }
}

// A helper function to handle deployment logic.
fn handle_deploy<A: Aleo<Network = N, BaseField = N::Field>, N: Network>(
    command: &Deploy,
    context: Context,
    network: NetworkName,
    endpoint: &str,
) -> Result<<Deploy as Command>::Output> {
    // Get the program name.
    let project_name = context.open_manifest::<N>()?.program_id().to_string();

    // Get the private key.
    let private_key = context.get_private_key(&command.fee_options.private_key)?;
    let address = Address::try_from(&private_key)?;

    // Specify the query
    let query = SnarkVMQuery::from(endpoint);

    let mut all_paths: Vec<(String, PathBuf)> = Vec::new();

    // Extract post-ordered list of local dependencies' paths from `leo.lock`.
    if command.recursive {
        // Cannot combine with private fee.
        if command.fee_options.record.is_some() {
            return Err(CliError::recursive_deploy_with_record().into());
        }
        all_paths = context.local_dependency_paths()?;
    }

    // Add the parent program to be deployed last.
    all_paths.push((project_name, context.dir()?.join("build")));

    for (index, (name, path)) in all_paths.iter().enumerate() {
        // Fetch the package from the directory.
        let package = SnarkVMPackage::<N>::open(path)?;

        println!("📦 Creating deployment transaction for '{}'...\n", &name.bold());

        // Generate the deployment
        let deployment = package.deploy::<A>(None)?;

        let variables = deployment.num_combined_variables()?;
        let constraints = deployment.num_combined_constraints()?;

        // Check if the number of variables and constraints are within the limits.
        if variables > N::MAX_DEPLOYMENT_VARIABLES {
            return Err(CliError::variable_limit_exceeded(name, N::MAX_DEPLOYMENT_VARIABLES, network).into());
        }
        if constraints > N::MAX_DEPLOYMENT_CONSTRAINTS {
            return Err(CliError::constraint_limit_exceeded(name, N::MAX_DEPLOYMENT_CONSTRAINTS, network).into());
        }

        // Print deployment summary
        println!(
            "📊 Deployment Summary:\n      Total Variables:   {:>10}\n      Total Constraints: {:>10}",
            variables.to_formatted_string(&Locale::en),
            constraints.to_formatted_string(&Locale::en)
        );

        let deployment_id = deployment.to_deployment_id()?;

        let store = ConsensusStore::<N, ConsensusMemory<N>>::open(StorageMode::Production)?;

        // Initialize the VM.
        let vm = VM::from(store)?;

        let base_fee = match command.fee_options.base_fee {
            Some(base_fee) => base_fee,
            None => {
                // Compute the minimum deployment cost.
                let (base_fee, (storage_cost, synthesis_cost, namespace_cost)) = deployment_cost(&deployment)?;

                // Display the deployment cost breakdown using `credit` denomination.
                deploy_cost_breakdown(
                    name,
                    base_fee as f64 / 1_000_000.0,
                    storage_cost as f64 / 1_000_000.0,
                    synthesis_cost as f64 / 1_000_000.0,
                    namespace_cost as f64 / 1_000_000.0,
                    command.fee_options.priority_fee as f64 / 1_000_000.0,
                )?;
                base_fee
            }
        };

        // Initialize an RNG.
        let rng = &mut rand::thread_rng();

        // Prepare the fees.
        let fee = match &command.fee_options.record {
            Some(record) => {
                let fee_record = parse_record(&private_key, record)?;
                let fee_authorization = vm.authorize_fee_private(
                    &private_key,
                    fee_record,
                    base_fee,
                    command.fee_options.priority_fee,
                    deployment_id,
                    rng,
                )?;
                vm.execute_fee_authorization(fee_authorization, Some(query.clone()), rng)?
            }
            None => {
                // Make sure the user has enough public balance to pay for the deployment.
                check_balance(
                    &private_key,
                    endpoint,
                    &network.to_string(),
                    &context,
                    base_fee + command.fee_options.priority_fee,
                )?;
                let fee_authorization = vm.authorize_fee_public(
                    &private_key,
                    base_fee,
                    command.fee_options.priority_fee,
                    deployment_id,
                    rng,
                )?;
                vm.execute_fee_authorization(fee_authorization, Some(query.clone()), rng)?
            }
        };
        // Construct the owner.
        let owner = ProgramOwner::new(&private_key, deployment_id, rng)?;

        // Generate the deployment transaction.
        let transaction = Transaction::from_deployment(owner, deployment, fee)?;

        // Determine if the transaction should be broadcast, stored, or displayed to the user.
        if !command.fee_options.dry_run {
            if !command.fee_options.yes {
                let prompt = format!(
                    "Do you want to submit deployment of program `{name}` to network {} via endpoint {} using address {}?",
                    network, endpoint, address
                );
                let confirmation =
                    Confirm::with_theme(&ColorfulTheme::default()).with_prompt(prompt).default(false).interact();

                // Check if the user confirmed the transaction.
                if let Ok(confirmation) = confirmation {
                    if !confirmation {
                        println!("✅ Successfully aborted the execution transaction for '{}'\n", name.bold());
                        return Ok(());
                    }
                } else {
                    return Err(CliError::confirmation_failed().into());
                }
            }
            println!("✅ Created deployment transaction for '{}'\n", name.bold());
            handle_broadcast(&format!("{}/{}/transaction/broadcast", endpoint, network), transaction, name)?;
            // Wait between successive deployments to prevent out of order deployments.
            if index < all_paths.len() - 1 {
                std::thread::sleep(std::time::Duration::from_secs(command.wait));
            }
        } else {
            println!("✅ Successful dry run deployment for '{}'\n", name.bold());
        }
    }

    Ok(())
}

// A helper function to display a cost breakdown of the deployment.
fn deploy_cost_breakdown(
    name: &String,
    base_fee: f64,
    storage_cost: f64,
    synthesis_cost: f64,
    namespace_cost: f64,
    priority_fee: f64,
) -> Result<()> {
    println!("\nBase deployment cost for '{}' is {} credits.\n", name.bold(), base_fee);
    // Display the cost breakdown in a table.
    let data = [
        [name, "Cost (credits)"],
        ["Transaction Storage", &format!("{:.6}", storage_cost)],
        ["Program Synthesis", &format!("{:.6}", synthesis_cost)],
        ["Namespace", &format!("{:.6}", namespace_cost)],
        ["Priority Fee", &format!("{:.6}", priority_fee)],
        ["Total", &format!("{:.6}", base_fee + priority_fee)],
    ];
    let mut out = Vec::new();
    text_tables::render(&mut out, data).map_err(CliError::table_render_failed)?;
    println!("{}", ::std::str::from_utf8(&out).map_err(CliError::table_render_failed)?);
    Ok(())
}