gcli 1.10.0

Gear program CLI
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

// This file is part of Gear.
//
// Copyright (C) 2021-2025 Gear Technologies Inc.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
//
// This program 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.
//
// This program 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 this program. If not, see <https://www.gnu.org/licenses/>.

//! Command `send`
use crate::{App, result::Result, utils::Hex};
use clap::Parser;

/// Sends a message to a program or to another account.
///
/// The origin must be Signed and the sender must have sufficient funds to pay
/// for `gas` and `value` (in case the latter is being transferred).
///
/// To avoid an undefined behavior a check is made that the destination address
/// is not a program in uninitialized state. If the opposite holds true,
/// the message is not enqueued for processing.
///
/// Parameters:
/// - `destination`: the message destination.
/// - `payload`: in case of a program destination, parameters of the `handle` function.
/// - `gas_limit`: maximum amount of gas the program can spend before it is halted.
/// - `value`: balance to be transferred to the program once it's been created.
///
/// Emits the following events:
/// - `DispatchMessageEnqueued(MessageInfo)` when dispatch message is placed in the queue.
#[derive(Clone, Debug, Parser)]
pub struct Send {
    /// Send to
    pub destination: String,
    /// Send payload
    #[arg(short, long, default_value = "0x")]
    pub payload: String,
    /// Send gas limit
    ///
    /// Use estimated gas limit automatically if not set.
    #[arg(short, long)]
    pub gas_limit: Option<u64>,
    /// Send value
    #[arg(short, long, default_value = "0")]
    pub value: u128,
}

impl Send {
    pub async fn exec(&self, app: &impl App) -> Result<()> {
        let signer = app.signer().await?;
        let gas_limit = if let Some(gas_limit) = self.gas_limit {
            gas_limit
        } else {
            signer
                .calculate_handle_gas(
                    None,
                    self.destination.to_hash()?.into(),
                    self.payload.to_vec()?,
                    self.value,
                    false,
                )
                .await?
                .min_limit
        };

        let (message_id, _) = signer
            .send_message_bytes(
                self.destination.to_hash()?.into(),
                self.payload.clone(),
                gas_limit,
                self.value,
            )
            .await?;

        log::info!("Message ID: 0x{}", hex::encode(message_id.into_bytes()));
        Ok(())
    }
}