nym-bandwidth-controller 1.21.4

Crate for controlling the use of zknym credentials to ensure constant bandwidth availability for NymVPN app
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

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

use nym_credentials::{ecash::bandwidth::CredentialSpendingData, IssuedTicketBook};
use nym_crypto::asymmetric::ed25519;
use nym_ecash_time::OffsetDateTime;
use nym_validator_client::nym_api::EpochId;

pub use controller::BandwidthController;
pub use nym_credentials_interface::TicketType;
pub use ticketbooks::AvailableTicketbooks;
pub use traits::{
    BandwidthTicketProvider, CredentialFetcher, CredentialFetcherError,
    CredentialPublicDataFetcher, FetcherError,
};

pub mod config;
mod controller;
pub mod error;
mod in_flight;
pub mod mock;
mod readiness;
pub mod requests;
mod ticketbooks;
mod traits;

pub const DEFAULT_TICKETS_TO_SPEND: u32 = 1;

pub const UPGRADE_MODE_JWT_TYPE: &str = "UPGRADE_MODE_JWT";

#[derive(Clone, Debug)]
pub struct PreparedCredential {
    /// The cryptographic material required for spending the underlying credential.
    pub data: CredentialSpendingData,

    /// The (DKG) epoch id under which the credential has been issued so that the verifier
    /// could use correct verification key for validation.
    pub epoch_id: EpochId,

    /// Auxiliary metadata associated with the withdrawn credential
    pub metadata: PreparedCredentialMetadata,
}

#[derive(Copy, Clone, Debug)]
pub struct PreparedCredentialMetadata {
    /// The database id of the stored credential.
    pub ticketbook_id: i64,

    /// The number of tickets withdrawn in this credential
    pub tickets_withdrawn: u32,

    /// The amount of tickets used INCLUDING those tickets that JUST got withdrawn
    pub used_tickets: u32,
}

#[derive(Copy, Clone, Debug)]
pub struct EcashTicketRequest {
    pub ticket_type: TicketType,
    pub gateway_id: ed25519::PublicKey,
    pub tickets_to_spend: u32,
    pub spend_time: OffsetDateTime,
}

pub enum NymCredential {
    Ticketbook(Box<IssuedTicketBook>),
    UpgradeModeToken {
        jwt: String,
        expiration: OffsetDateTime,
    },
}