soroban-cli 26.0.0

Soroban 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

use crate::{
    assembled::{simulate_and_assemble_transaction, Assembled},
    print,
    xdr::{self, TransactionEnvelope, WriteXdr},
};
use std::ffi::OsString;

use crate::commands::{config, global};

#[derive(thiserror::Error, Debug)]
pub enum Error {
    #[error(transparent)]
    XdrArgs(#[from] super::xdr::Error),
    #[error(transparent)]
    Config(#[from] super::super::config::Error),
    #[error(transparent)]
    Rpc(#[from] crate::rpc::Error),
    #[error(transparent)]
    Xdr(#[from] xdr::Error),
    #[error(transparent)]
    Network(#[from] config::network::Error),
}

/// Command to simulate a transaction envelope via rpc
/// e.g. `stellar tx simulate file.txt` or `cat file.txt | stellar tx simulate`
#[derive(Debug, clap::Parser, Clone, Default)]
#[group(skip)]
pub struct Cmd {
    /// Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty
    #[arg()]
    pub tx_xdr: Option<OsString>,

    #[clap(flatten)]
    pub config: config::Args,

    /// Allow this many extra instructions when budgeting resources during transaction simulation
    #[arg(long)]
    pub instruction_leeway: Option<u64>,
}

impl Cmd {
    pub async fn run(&self, global_args: &global::Args) -> Result<(), Error> {
        let res = self.execute(global_args, &self.config).await?;
        let tx_env: TransactionEnvelope = res.transaction().clone().into();
        println!("{}", tx_env.to_xdr_base64(xdr::Limits::none())?);
        Ok(())
    }

    pub async fn execute(
        &self,
        global_args: &global::Args,
        config: &config::Args,
    ) -> Result<Assembled, Error> {
        let print = print::Print::new(global_args.quiet);
        let network = config.get_network()?;
        let client = network.rpc_client()?;
        let tx = super::xdr::unwrap_envelope_v1(super::xdr::tx_envelope_from_input(&self.tx_xdr)?)?;
        let resource_config = self
            .instruction_leeway
            .map(|instruction_leeway| soroban_rpc::ResourceConfig { instruction_leeway });
        let tx = simulate_and_assemble_transaction(&client, &tx, resource_config, None).await?;
        if let Some(fee_bump_fee) = tx.fee_bump_fee() {
            print.warnln(format!("The transaction fee of {} is too large and needs to be wrapped in a fee bump transaction.", print::format_number(fee_bump_fee, 7)));
        }
        Ok(tx)
    }
}