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

use super::args::Args;
use crate::{
    commands::contract::Durability,
    config::{self, locator},
    xdr::{
        self, ContractDataDurability, ContractId, Hash, LedgerKey, LedgerKeyContractData, Limits,
        ReadXdr, ScAddress, ScVal,
    },
};
use clap::Parser;

#[derive(Parser, Debug, Clone)]
#[group(skip)]
pub struct Cmd {
    /// Contract alias or address to fetch
    #[arg(long)]
    pub contract: config::UnresolvedContract,

    #[command(flatten)]
    pub args: Args,

    /// Storage entry durability
    #[arg(long, value_enum, default_value = "persistent")]
    pub durability: Durability,

    /// Storage key (symbols only)
    #[arg(long = "key", required_unless_present_any = vec!("key_xdr", "instance"))]
    pub key: Option<Vec<String>>,

    /// Storage key (base64-encoded XDR)
    #[arg(long = "key-xdr", required_unless_present_any = vec!("key", "instance"))]
    pub key_xdr: Option<Vec<String>>,

    /// If the contract instance ledger entry should be included in the output
    #[arg(long = "instance", required_unless_present_any = vec!("key", "key_xdr"))]
    pub instance: bool,
}

#[derive(thiserror::Error, Debug)]
pub enum Error {
    #[error(transparent)]
    Run(#[from] super::args::Error),
    #[error(transparent)]
    Locator(#[from] locator::Error),
    #[error(transparent)]
    Spec(#[from] soroban_spec_tools::Error),
    #[error(transparent)]
    StellarXdr(#[from] stellar_xdr::curr::Error),
}

impl Cmd {
    pub async fn run(&self) -> Result<(), Error> {
        let mut ledger_keys = vec![];
        self.insert_keys(&mut ledger_keys)?;
        Ok(self.args.run(ledger_keys).await?)
    }

    fn insert_keys(&self, ledger_keys: &mut Vec<LedgerKey>) -> Result<(), Error> {
        let network = self.args.network()?;
        let contract_id = self
            .contract
            .resolve_contract_id(&self.args.locator, &network.network_passphrase)?;
        let contract_address_arg = ScAddress::Contract(ContractId(Hash(contract_id.0)));
        if self.instance {
            let contract_instance_key = LedgerKey::ContractData(LedgerKeyContractData {
                contract: contract_address_arg.clone(),
                key: ScVal::LedgerKeyContractInstance,
                durability: ContractDataDurability::Persistent,
            });

            ledger_keys.push(contract_instance_key);
        }

        if let Some(keys) = &self.key {
            for key in keys {
                let key = LedgerKey::ContractData(LedgerKeyContractData {
                    contract: contract_address_arg.clone(),
                    key: soroban_spec_tools::from_string_primitive(
                        key,
                        &xdr::ScSpecTypeDef::Symbol,
                    )?,
                    durability: ContractDataDurability::Persistent,
                });

                ledger_keys.push(key);
            }
        }

        if let Some(keys) = &self.key_xdr {
            for key in keys {
                let key = LedgerKey::ContractData(LedgerKeyContractData {
                    contract: contract_address_arg.clone(),
                    key: ScVal::from_xdr_base64(key, Limits::none())?,
                    durability: ContractDataDurability::Persistent,
                });

                ledger_keys.push(key);
            }
        }

        Ok(())
    }
}