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

use crate::{commands::global, config::network, xdr::Hash};
use clap::Subcommand;
pub use soroban_rpc::GetTransactionEvents;
use std::fmt::Debug;

mod args;
mod envelope;
mod events;
pub mod fee;
mod meta;
mod result;

#[derive(Debug, clap::Args)]
#[command(args_conflicts_with_subcommands = true)]
pub struct Cmd {
    #[command(subcommand)]
    subcommand: Option<FetchCommands>,

    #[command(flatten)]
    default: DefaultArgs,
}

#[derive(Debug, Subcommand)]
pub enum FetchCommands {
    /// Fetch the transaction result
    Result(result::Cmd),
    /// Fetch the transaction meta
    Meta(meta::Cmd),
    /// Fetch the transaction fee information
    Fee(fee::Cmd),
    /// Fetch the transaction events
    Events(events::Cmd),
    /// Fetch the transaction envelope
    #[command(hide = true)]
    Envelope(envelope::Cmd),
}

#[derive(Debug, clap::Args)]
struct DefaultArgs {
    /// Hash of transaction to fetch
    #[arg(long)]
    pub hash: Option<Hash>,

    #[command(flatten)]
    pub network: Option<network::Args>,

    /// Format of the output
    #[arg(long, default_value = "json")]
    pub output: Option<args::OutputFormat>,
}

#[derive(thiserror::Error, Debug)]
pub enum Error {
    #[error(transparent)]
    Args(#[from] args::Error),

    #[error(transparent)]
    Result(#[from] result::Error),

    #[error(transparent)]
    Meta(#[from] meta::Error),

    #[error(transparent)]
    Envelope(#[from] envelope::Error),

    #[error(transparent)]
    Events(#[from] events::Error),
    #[error(transparent)]
    NotSupported(#[from] fee::Error),

    #[error("the following required argument was not provided: {0}")]
    MissingArg(String),

    #[error(transparent)]
    Io(#[from] std::io::Error),
}

impl Cmd {
    pub async fn run(&self, global_args: &global::Args) -> Result<(), Error> {
        match &self.subcommand {
            Some(FetchCommands::Result(cmd)) => cmd.run(global_args).await?,
            Some(FetchCommands::Meta(cmd)) => cmd.run(global_args).await?,
            Some(FetchCommands::Envelope(cmd)) => cmd.run(global_args).await?,
            Some(FetchCommands::Fee(cmd)) => cmd.run(global_args).await?,
            Some(FetchCommands::Events(cmd)) => cmd.run(global_args).await?,
            None => {
                envelope::Cmd {
                    args: args::Args {
                        hash: self
                            .default
                            .hash
                            .clone()
                            .ok_or(Error::MissingArg("--hash <HASH>".to_string()))?,
                        network: self.default.network.clone().unwrap_or_default(),
                    },
                    output: self.default.output.unwrap_or_default(),
                }
                .run(global_args)
                .await?;
            }
        }
        Ok(())
    }
}