miden-client 0.16.0-alpha.1

Client library that facilitates interaction with the Miden network
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

use core::ops::{Deref, DerefMut};

pub(crate) use api_client_wrapper::{ApiClient, InnerClient};

// WEB CLIENT
// ================================================================================================

#[cfg(target_arch = "wasm32")]
pub(crate) mod api_client_wrapper {
    use alloc::string::String;
    use core::time::Duration;

    use crate::remote_prover::RemoteProverClientError;
    use crate::remote_prover::generated::api_client::ApiClient as ProtoClient;

    pub type InnerClient = ProtoClient<tonic_web_wasm_client::Client>;

    /// Wrapper around the generated prover API client that hides the transport type.
    #[derive(Clone)]
    pub struct ApiClient(pub(crate) InnerClient);

    impl ApiClient {
        /// Connects to the remote prover at the provided endpoint.
        // Kept async for API parity with the native client; in WASM this is synchronous.
        #[allow(clippy::unused_async)]
        pub async fn new_client(
            endpoint: String,
            timeout: Duration,
        ) -> Result<ApiClient, RemoteProverClientError> {
            let fetch_options =
                tonic_web_wasm_client::options::FetchOptions::new().timeout(timeout);
            let web_client =
                tonic_web_wasm_client::Client::new_with_options(endpoint, fetch_options);
            Ok(ApiClient(ProtoClient::new(web_client)))
        }
    }
}

// NATIVE CLIENT
// ================================================================================================

#[cfg(not(target_arch = "wasm32"))]
pub(crate) mod api_client_wrapper {
    use alloc::string::String;
    use core::time::Duration;

    use crate::remote_prover::RemoteProverClientError;
    use crate::remote_prover::generated::api_client::ApiClient as ProtoClient;

    pub type InnerClient = ProtoClient<tonic::transport::Channel>;

    /// Wrapper around the generated prover API client that hides the transport type.
    #[derive(Clone)]
    pub struct ApiClient(pub(crate) InnerClient);

    impl ApiClient {
        /// Connects to the remote prover at the provided endpoint.
        pub async fn new_client(
            endpoint: String,
            timeout: Duration,
        ) -> Result<ApiClient, RemoteProverClientError> {
            let endpoint = tonic::transport::Endpoint::try_from(endpoint)
                .map_err(|err| RemoteProverClientError::ConnectionFailed(err.into()))?
                .timeout(timeout);
            let channel = endpoint
                .tls_config(tonic::transport::ClientTlsConfig::new().with_native_roots())
                .map_err(|err| RemoteProverClientError::ConnectionFailed(err.into()))?
                .connect()
                .await
                .map_err(|err| RemoteProverClientError::ConnectionFailed(err.into()))?;
            Ok(ApiClient(ProtoClient::new(channel)))
        }
    }
}

impl Deref for ApiClient {
    type Target = InnerClient;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl DerefMut for ApiClient {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}