nym-validator-client 1.21.1

Client for interacting with Nyx Cosmos SDK blockchain
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
// Copyright 2026 - Nym Technologies SA <contact@nymtech.net>
// SPDX-License-Identifier: Apache-2.0

use crate::collect_paged;
use crate::nyxd::contract_traits::NymContractsProvider;
use crate::nyxd::error::NyxdError;
use crate::nyxd::CosmWasmClient;
use async_trait::async_trait;
use cosmrs::AccountId;
use serde::Deserialize;

use nym_mixnet_contract_common::NodeId;
pub use nym_node_families_contract_common::{
    msg::QueryMsg as NodeFamiliesQueryMsg, AllFamilyMembersPagedResponse,
    AllPastFamilyInvitationsPagedResponse, FamiliesPagedResponse, FamilyMemberRecord,
    FamilyMembersPagedResponse, GlobalPastFamilyInvitationCursor, NodeFamily,
    NodeFamilyByNameResponse, NodeFamilyByOwnerResponse, NodeFamilyId,
    NodeFamilyMembershipResponse, NodeFamilyResponse, PastFamilyInvitation,
    PastFamilyInvitationCursor, PastFamilyInvitationForNodeCursor,
    PastFamilyInvitationsForNodePagedResponse, PastFamilyInvitationsPagedResponse,
    PastFamilyMember, PastFamilyMemberCursor, PastFamilyMemberForNodeCursor,
    PastFamilyMembersForNodePagedResponse, PastFamilyMembersPagedResponse,
    PendingFamilyInvitationDetails, PendingFamilyInvitationResponse,
    PendingFamilyInvitationsPagedResponse, PendingInvitationsForNodePagedResponse,
    PendingInvitationsPagedResponse,
};

#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
pub trait NodeFamiliesQueryClient {
    async fn query_node_families_contract<T>(
        &self,
        query: NodeFamiliesQueryMsg,
    ) -> Result<T, NyxdError>
    where
        for<'a> T: Deserialize<'a>;

    async fn get_family_by_id(
        &self,
        family_id: NodeFamilyId,
    ) -> Result<NodeFamilyResponse, NyxdError> {
        self.query_node_families_contract(NodeFamiliesQueryMsg::GetFamilyById { family_id })
            .await
    }

    async fn get_family_by_owner(
        &self,
        owner: &AccountId,
    ) -> Result<NodeFamilyByOwnerResponse, NyxdError> {
        self.query_node_families_contract(NodeFamiliesQueryMsg::GetFamilyByOwner {
            owner: owner.to_string(),
        })
        .await
    }

    async fn get_family_by_name(
        &self,
        name: String,
    ) -> Result<NodeFamilyByNameResponse, NyxdError> {
        self.query_node_families_contract(NodeFamiliesQueryMsg::GetFamilyByName { name })
            .await
    }

    async fn get_families_paged(
        &self,
        start_after: Option<NodeFamilyId>,
        limit: Option<u32>,
    ) -> Result<FamiliesPagedResponse, NyxdError> {
        self.query_node_families_contract(NodeFamiliesQueryMsg::GetFamiliesPaged {
            start_after,
            limit,
        })
        .await
    }

    async fn get_family_membership(
        &self,
        node_id: NodeId,
    ) -> Result<NodeFamilyMembershipResponse, NyxdError> {
        self.query_node_families_contract(NodeFamiliesQueryMsg::GetFamilyMembership { node_id })
            .await
    }

    async fn get_family_members_paged(
        &self,
        family_id: NodeFamilyId,
        start_after: Option<NodeId>,
        limit: Option<u32>,
    ) -> Result<FamilyMembersPagedResponse, NyxdError> {
        self.query_node_families_contract(NodeFamiliesQueryMsg::GetFamilyMembersPaged {
            family_id,
            start_after,
            limit,
        })
        .await
    }

    async fn get_all_family_members_paged(
        &self,
        start_after: Option<NodeId>,
        limit: Option<u32>,
    ) -> Result<AllFamilyMembersPagedResponse, NyxdError> {
        self.query_node_families_contract(NodeFamiliesQueryMsg::GetAllFamilyMembersPaged {
            start_after,
            limit,
        })
        .await
    }

    async fn get_pending_invitation(
        &self,
        family_id: NodeFamilyId,
        node_id: NodeId,
    ) -> Result<PendingFamilyInvitationResponse, NyxdError> {
        self.query_node_families_contract(NodeFamiliesQueryMsg::GetPendingInvitation {
            family_id,
            node_id,
        })
        .await
    }

    async fn get_pending_invitations_for_family_paged(
        &self,
        family_id: NodeFamilyId,
        start_after: Option<NodeId>,
        limit: Option<u32>,
    ) -> Result<PendingFamilyInvitationsPagedResponse, NyxdError> {
        self.query_node_families_contract(
            NodeFamiliesQueryMsg::GetPendingInvitationsForFamilyPaged {
                family_id,
                start_after,
                limit,
            },
        )
        .await
    }

    async fn get_pending_invitations_for_node_paged(
        &self,
        node_id: NodeId,
        start_after: Option<NodeFamilyId>,
        limit: Option<u32>,
    ) -> Result<PendingInvitationsForNodePagedResponse, NyxdError> {
        self.query_node_families_contract(NodeFamiliesQueryMsg::GetPendingInvitationsForNodePaged {
            node_id,
            start_after,
            limit,
        })
        .await
    }

    async fn get_all_pending_invitations_paged(
        &self,
        start_after: Option<(NodeFamilyId, NodeId)>,
        limit: Option<u32>,
    ) -> Result<PendingInvitationsPagedResponse, NyxdError> {
        self.query_node_families_contract(NodeFamiliesQueryMsg::GetAllPendingInvitationsPaged {
            start_after,
            limit,
        })
        .await
    }

    async fn get_past_invitations_for_family_paged(
        &self,
        family_id: NodeFamilyId,
        start_after: Option<PastFamilyInvitationCursor>,
        limit: Option<u32>,
    ) -> Result<PastFamilyInvitationsPagedResponse, NyxdError> {
        self.query_node_families_contract(NodeFamiliesQueryMsg::GetPastInvitationsForFamilyPaged {
            family_id,
            start_after,
            limit,
        })
        .await
    }

    async fn get_past_invitations_for_node_paged(
        &self,
        node_id: NodeId,
        start_after: Option<PastFamilyInvitationForNodeCursor>,
        limit: Option<u32>,
    ) -> Result<PastFamilyInvitationsForNodePagedResponse, NyxdError> {
        self.query_node_families_contract(NodeFamiliesQueryMsg::GetPastInvitationsForNodePaged {
            node_id,
            start_after,
            limit,
        })
        .await
    }

    async fn get_all_past_invitations_paged(
        &self,
        start_after: Option<GlobalPastFamilyInvitationCursor>,
        limit: Option<u32>,
    ) -> Result<AllPastFamilyInvitationsPagedResponse, NyxdError> {
        self.query_node_families_contract(NodeFamiliesQueryMsg::GetAllPastInvitationsPaged {
            start_after,
            limit,
        })
        .await
    }

    async fn get_past_members_for_family_paged(
        &self,
        family_id: NodeFamilyId,
        start_after: Option<PastFamilyMemberCursor>,
        limit: Option<u32>,
    ) -> Result<PastFamilyMembersPagedResponse, NyxdError> {
        self.query_node_families_contract(NodeFamiliesQueryMsg::GetPastMembersForFamilyPaged {
            family_id,
            start_after,
            limit,
        })
        .await
    }

    async fn get_past_members_for_node_paged(
        &self,
        node_id: NodeId,
        start_after: Option<PastFamilyMemberForNodeCursor>,
        limit: Option<u32>,
    ) -> Result<PastFamilyMembersForNodePagedResponse, NyxdError> {
        self.query_node_families_contract(NodeFamiliesQueryMsg::GetPastMembersForNodePaged {
            node_id,
            start_after,
            limit,
        })
        .await
    }
}

// extension trait to the query client to deal with the paged queries
// (it didn't feel appropriate to combine it with the existing trait)
#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
pub trait PagedNodeFamiliesQueryClient: NodeFamiliesQueryClient {
    async fn get_all_families(&self) -> Result<Vec<NodeFamily>, NyxdError> {
        collect_paged!(self, get_families_paged, families)
    }

    async fn get_all_family_members_for_family(
        &self,
        family_id: NodeFamilyId,
    ) -> Result<Vec<FamilyMemberRecord>, NyxdError> {
        collect_paged!(self, get_family_members_paged, members, family_id)
    }

    async fn get_all_family_members(&self) -> Result<Vec<FamilyMemberRecord>, NyxdError> {
        collect_paged!(self, get_all_family_members_paged, members)
    }

    async fn get_all_pending_invitations_for_family(
        &self,
        family_id: NodeFamilyId,
    ) -> Result<Vec<PendingFamilyInvitationDetails>, NyxdError> {
        collect_paged!(
            self,
            get_pending_invitations_for_family_paged,
            invitations,
            family_id
        )
    }

    async fn get_all_pending_invitations_for_node(
        &self,
        node_id: NodeId,
    ) -> Result<Vec<PendingFamilyInvitationDetails>, NyxdError> {
        collect_paged!(
            self,
            get_pending_invitations_for_node_paged,
            invitations,
            node_id
        )
    }

    async fn get_all_pending_invitations(
        &self,
    ) -> Result<Vec<PendingFamilyInvitationDetails>, NyxdError> {
        collect_paged!(self, get_all_pending_invitations_paged, invitations)
    }

    async fn get_all_past_invitations_for_family(
        &self,
        family_id: NodeFamilyId,
    ) -> Result<Vec<PastFamilyInvitation>, NyxdError> {
        collect_paged!(
            self,
            get_past_invitations_for_family_paged,
            invitations,
            family_id
        )
    }

    async fn get_all_past_invitations_for_node(
        &self,
        node_id: NodeId,
    ) -> Result<Vec<PastFamilyInvitation>, NyxdError> {
        collect_paged!(
            self,
            get_past_invitations_for_node_paged,
            invitations,
            node_id
        )
    }

    async fn get_all_past_invitations(&self) -> Result<Vec<PastFamilyInvitation>, NyxdError> {
        collect_paged!(self, get_all_past_invitations_paged, invitations)
    }

    async fn get_all_past_members_for_family(
        &self,
        family_id: NodeFamilyId,
    ) -> Result<Vec<PastFamilyMember>, NyxdError> {
        collect_paged!(self, get_past_members_for_family_paged, members, family_id)
    }

    async fn get_all_past_members_for_node(
        &self,
        node_id: NodeId,
    ) -> Result<Vec<PastFamilyMember>, NyxdError> {
        collect_paged!(self, get_past_members_for_node_paged, members, node_id)
    }
}

#[async_trait]
impl<T> PagedNodeFamiliesQueryClient for T where T: NodeFamiliesQueryClient {}

#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
impl<C> NodeFamiliesQueryClient for C
where
    C: CosmWasmClient + NymContractsProvider + Send + Sync,
{
    async fn query_node_families_contract<T>(
        &self,
        query: NodeFamiliesQueryMsg,
    ) -> Result<T, NyxdError>
    where
        for<'a> T: Deserialize<'a>,
    {
        let node_families_contract_address = &self
            .node_families_contract_address()
            .ok_or_else(|| NyxdError::unavailable_contract_address("node families contract"))?;
        self.query_contract_smart(node_families_contract_address, &query)
            .await
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::nyxd::contract_traits::tests::IgnoreValue;
    use nym_node_families_contract_common::QueryMsg;

    // it's enough that this compiles and clippy is happy about it
    #[allow(dead_code)]
    fn all_query_variants_are_covered<C: NodeFamiliesQueryClient + Send + Sync>(
        client: C,
        msg: NodeFamiliesQueryMsg,
    ) {
        match msg {
            NodeFamiliesQueryMsg::GetFamilyById { family_id } => {
                client.get_family_by_id(family_id).ignore()
            }
            NodeFamiliesQueryMsg::GetFamilyByOwner { owner } => {
                client.get_family_by_owner(&owner.parse().unwrap()).ignore()
            }
            NodeFamiliesQueryMsg::GetFamilyByName { name } => {
                client.get_family_by_name(name).ignore()
            }
            NodeFamiliesQueryMsg::GetFamiliesPaged { start_after, limit } => {
                client.get_families_paged(start_after, limit).ignore()
            }
            NodeFamiliesQueryMsg::GetFamilyMembership { node_id } => {
                client.get_family_membership(node_id).ignore()
            }
            NodeFamiliesQueryMsg::GetFamilyMembersPaged {
                family_id,
                start_after,
                limit,
            } => client
                .get_family_members_paged(family_id, start_after, limit)
                .ignore(),
            NodeFamiliesQueryMsg::GetAllFamilyMembersPaged { start_after, limit } => client
                .get_all_family_members_paged(start_after, limit)
                .ignore(),
            NodeFamiliesQueryMsg::GetPendingInvitation { family_id, node_id } => {
                client.get_pending_invitation(family_id, node_id).ignore()
            }
            NodeFamiliesQueryMsg::GetPendingInvitationsForFamilyPaged {
                family_id,
                start_after,
                limit,
            } => client
                .get_pending_invitations_for_family_paged(family_id, start_after, limit)
                .ignore(),
            NodeFamiliesQueryMsg::GetPendingInvitationsForNodePaged {
                node_id,
                start_after,
                limit,
            } => client
                .get_pending_invitations_for_node_paged(node_id, start_after, limit)
                .ignore(),
            NodeFamiliesQueryMsg::GetAllPendingInvitationsPaged { start_after, limit } => client
                .get_all_pending_invitations_paged(start_after, limit)
                .ignore(),
            NodeFamiliesQueryMsg::GetPastInvitationsForFamilyPaged {
                family_id,
                start_after,
                limit,
            } => client
                .get_past_invitations_for_family_paged(family_id, start_after, limit)
                .ignore(),
            NodeFamiliesQueryMsg::GetPastInvitationsForNodePaged {
                node_id,
                start_after,
                limit,
            } => client
                .get_past_invitations_for_node_paged(node_id, start_after, limit)
                .ignore(),
            NodeFamiliesQueryMsg::GetAllPastInvitationsPaged { start_after, limit } => client
                .get_all_past_invitations_paged(start_after, limit)
                .ignore(),
            NodeFamiliesQueryMsg::GetPastMembersForFamilyPaged {
                family_id,
                start_after,
                limit,
            } => client
                .get_past_members_for_family_paged(family_id, start_after, limit)
                .ignore(),
            QueryMsg::GetPastMembersForNodePaged {
                node_id,
                start_after,
                limit,
            } => client
                .get_past_members_for_node_paged(node_id, start_after, limit)
                .ignore(),
        };
    }
}