nym-client-core 1.21.1

Crate containing core client functionality and configs, used by all other Nym client implentations
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176

// Copyright 2024 - Nym Technologies SA <contact@nymtech.net>
// SPDX-License-Identifier: Apache-2.0

use crate::client::key_manager::ClientKeys;
use crate::client::key_manager::persistence::KeyStore;
use crate::error::ClientCoreError;
use nym_client_core_gateways_storage::{
    ActiveGateway, GatewayPublishedData, GatewayRegistration, GatewaysDetailsStore,
};
use nym_crypto::asymmetric::ed25519;

// helpers for error wrapping
pub async fn set_active_gateway<D>(
    details_store: &D,
    gateway_id: &str,
) -> Result<(), ClientCoreError>
where
    D: GatewaysDetailsStore,
    D::StorageError: Send + Sync + 'static,
{
    details_store
        .set_active_gateway(gateway_id)
        .await
        .map_err(|source| ClientCoreError::GatewaysDetailsStoreError {
            source: Box::new(source),
        })
}

pub async fn get_active_gateway_identity<D>(
    details_store: &D,
) -> Result<Option<ed25519::PublicKey>, ClientCoreError>
where
    D: GatewaysDetailsStore,
    D::StorageError: Send + Sync + 'static,
{
    details_store
        .active_gateway()
        .await
        .map_err(|source| ClientCoreError::GatewaysDetailsStoreError {
            source: Box::new(source),
        })
        .map(|a| a.registration.map(|r| r.details.gateway_id()))
}

pub async fn get_all_registered_identities<D>(
    details_store: &D,
) -> Result<Vec<ed25519::PublicKey>, ClientCoreError>
where
    D: GatewaysDetailsStore + Sync,
    D::StorageError: Send + Sync + 'static,
{
    details_store
        .all_gateways_identities()
        .await
        .map_err(|source| ClientCoreError::GatewaysDetailsStoreError {
            source: Box::new(source),
        })
}

pub async fn get_gateway_registrations<D>(
    details_store: &D,
) -> Result<Vec<GatewayRegistration>, ClientCoreError>
where
    D: GatewaysDetailsStore + Sync,
    D::StorageError: Send + Sync + 'static,
{
    details_store.all_gateways().await.map_err(|source| {
        ClientCoreError::GatewaysDetailsStoreError {
            source: Box::new(source),
        }
    })
}

pub async fn store_gateway_details<D>(
    details_store: &D,
    details: &GatewayRegistration,
) -> Result<(), ClientCoreError>
where
    D: GatewaysDetailsStore,
    D::StorageError: Send + Sync + 'static,
{
    details_store
        .store_gateway_details(details)
        .await
        .map_err(|source| ClientCoreError::GatewaysDetailsStoreError {
            source: Box::new(source),
        })
}

pub async fn update_stored_published_data_gateway<D>(
    details_store: &D,
    gateway_id: &ed25519::PublicKey,
    published_data: &GatewayPublishedData,
) -> Result<(), ClientCoreError>
where
    D: GatewaysDetailsStore,
    D::StorageError: Send + Sync + 'static,
{
    details_store
        .update_gateway_published_data(gateway_id, published_data)
        .await
        .map_err(|source| ClientCoreError::GatewaysDetailsStoreError {
            source: Box::new(source),
        })
}

pub async fn load_active_gateway_details<D>(
    details_store: &D,
) -> Result<ActiveGateway, ClientCoreError>
where
    D: GatewaysDetailsStore,
    D::StorageError: Send + Sync + 'static,
{
    details_store.active_gateway().await.map_err(|source| {
        ClientCoreError::GatewaysDetailsStoreError {
            source: Box::new(source),
        }
    })
}

pub async fn load_gateway_details<D>(
    details_store: &D,
    gateway_id: &str,
) -> Result<GatewayRegistration, ClientCoreError>
where
    D: GatewaysDetailsStore,
    D::StorageError: Send + Sync + 'static,
{
    details_store
        .load_gateway_details(gateway_id)
        .await
        .map_err(|source| ClientCoreError::UnavailableGatewayDetails {
            gateway_id: gateway_id.to_string(),
            source: Box::new(source),
        })
}

pub async fn has_gateway_details<D>(
    details_store: &D,
    gateway_id: &str,
) -> Result<bool, ClientCoreError>
where
    D: GatewaysDetailsStore,
    D::StorageError: Send + Sync + 'static,
{
    details_store
        .has_gateway_details(gateway_id)
        .await
        .map_err(|source| ClientCoreError::GatewaysDetailsStoreError {
            source: Box::new(source),
        })
}

pub async fn load_client_keys<K>(key_store: &K) -> Result<ClientKeys, ClientCoreError>
where
    K: KeyStore,
    K::StorageError: Send + Sync + 'static,
{
    ClientKeys::load_keys(key_store)
        .await
        .map_err(|source| ClientCoreError::KeyStoreError {
            source: Box::new(source),
        })
}

pub async fn store_client_keys<K>(keys: ClientKeys, key_store: &K) -> Result<(), ClientCoreError>
where
    K: KeyStore,
    K::StorageError: Send + Sync + 'static,
{
    keys.persist_keys(key_store)
        .await
        .map_err(|source| ClientCoreError::KeyStoreError {
            source: Box::new(source),
        })
}