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

use crate::xdr;

pub use ledger_impl::*;

#[derive(thiserror::Error, Debug)]
pub enum Error {
    #[error("Ledger Device keys are not allowed: additional-libs feature must be enabled")]
    FeatureNotEnabled,

    #[cfg(feature = "additional-libs")]
    #[error(transparent)]
    StellarLedger(#[from] stellar_ledger::Error),

    #[error(transparent)]
    TryFromSlice(#[from] std::array::TryFromSliceError),

    #[error(transparent)]
    Xdr(#[from] xdr::Error),
}

#[cfg(feature = "additional-libs")]
mod ledger_impl {
    use super::Error;
    use crate::xdr::{DecoratedSignature, Hash, Signature, SignatureHint, Transaction};
    use sha2::{Digest, Sha256};
    use stellar_ledger::{Blob as _, Exchange, LedgerSigner};

    #[cfg(not(feature = "emulator-tests"))]
    pub type LedgerType = Ledger<stellar_ledger::TransportNativeHID>;
    #[cfg(feature = "emulator-tests")]
    pub type LedgerType = Ledger<stellar_ledger::emulator_test_support::http_transport::Emulator>;

    pub struct Ledger<T: Exchange> {
        pub(crate) index: u32,
        pub(crate) signer: LedgerSigner<T>,
    }

    #[cfg(not(feature = "emulator-tests"))]
    #[allow(clippy::unused_async)]
    pub async fn new(hd_path: u32) -> Result<Ledger<stellar_ledger::TransportNativeHID>, Error> {
        let signer = stellar_ledger::native()?;
        Ok(Ledger {
            index: hd_path,
            signer,
        })
    }

    #[cfg(feature = "emulator-tests")]
    pub async fn new(
        hd_path: u32,
    ) -> Result<Ledger<stellar_ledger::emulator_test_support::http_transport::Emulator>, Error>
    {
        use stellar_ledger::emulator_test_support::ledger as emulator_ledger;
        // port from SPECULOS_PORT ENV var
        let host_port: u16 = std::env::var("SPECULOS_PORT")
            .expect("SPECULOS_PORT env var not set")
            .parse()
            .expect("port must be a number");
        let signer = emulator_ledger(host_port).await;

        Ok(Ledger {
            index: hd_path,
            signer,
        })
    }

    impl<T: Exchange> Ledger<T> {
        pub async fn sign_transaction_hash(
            &self,
            tx_hash: &[u8; 32],
        ) -> Result<DecoratedSignature, Error> {
            let key = self.public_key().await?;
            let hint = SignatureHint(key.0[28..].try_into()?);
            let signature = Signature(
                self.signer
                    .sign_transaction_hash(self.index, tx_hash)
                    .await?
                    .try_into()?,
            );
            Ok(DecoratedSignature { hint, signature })
        }

        pub async fn sign_transaction(
            &self,
            tx: Transaction,
            network_passphrase: &str,
        ) -> Result<DecoratedSignature, Error> {
            let network_id = Hash(Sha256::digest(network_passphrase).into());
            let signature = self
                .signer
                .sign_transaction(self.index, tx, network_id)
                .await?;
            let key = self.public_key().await?;
            let hint = SignatureHint(key.0[28..].try_into()?);
            let signature = Signature(signature.try_into()?);
            Ok(DecoratedSignature { hint, signature })
        }

        pub async fn public_key(&self) -> Result<stellar_strkey::ed25519::PublicKey, Error> {
            Ok(self.signer.get_public_key(&self.index.into()).await?)
        }
    }
}

#[cfg(not(feature = "additional-libs"))]
mod ledger_impl {
    use super::Error;
    use crate::xdr::{DecoratedSignature, Transaction};
    use std::marker::PhantomData;

    pub type LedgerType = Ledger<GenericExchange>;

    pub trait Exchange {}
    pub struct Ledger<T: Exchange> {
        _marker: PhantomData<T>,
    }

    #[allow(clippy::unused_async)]
    pub async fn new(_hd_path: u32) -> Result<Ledger<GenericExchange>, Error> {
        Err(Error::FeatureNotEnabled)
    }

    impl<T: Exchange> Ledger<T> {
        #[allow(clippy::unused_async)]
        pub async fn sign_transaction_hash(
            &self,
            _tx_hash: &[u8; 32],
        ) -> Result<DecoratedSignature, Error> {
            Err(Error::FeatureNotEnabled)
        }

        #[allow(clippy::unused_async)]
        pub async fn sign_transaction(
            &self,
            _tx: Transaction,
            _network_passphrase: &str,
        ) -> Result<DecoratedSignature, Error> {
            Err(Error::FeatureNotEnabled)
        }

        #[allow(clippy::unused_async)]
        pub async fn public_key(&self) -> Result<stellar_strkey::ed25519::PublicKey, Error> {
            Err(Error::FeatureNotEnabled)
        }
    }

    pub struct GenericExchange {}

    impl Exchange for GenericExchange {}

    impl GenericExchange {}
}