nym-credentials 1.20.4

Crate for using Nym's zknym credentials
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

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

use crate::ecash::bandwidth::issued::CURRENT_SERIALIZATION_REVISION;
use nym_credentials_interface::CompactEcashError;
use nym_crypto::asymmetric::x25519::KeyRecoveryError;
use nym_validator_client::{nym_api::error::NymAPIError, ValidatorClientError};
use thiserror::Error;

#[derive(Debug, Error)]
pub enum Error {
    #[error("IO error")]
    IOError(#[from] std::io::Error),

    #[error("failed to deserialize a recovery credential: {source}")]
    RecoveryCredentialDeserializationFailure { source: bincode::Error },

    #[error("failed to (de)serialize provided credential using revision {revision}: {source}")]
    SerializationFailure {
        #[source]
        source: bincode::Error,
        revision: u8,
    },

    #[error("unsupported data serialization revision {revision}. the current (and max supported) version is {CURRENT_SERIALIZATION_REVISION}")]
    UnsupportedSerializationRevision { revision: u8 },

    #[error("unknown data serialization revision {revision}. the current (and max supported) version is {CURRENT_SERIALIZATION_REVISION}")]
    UnknownSerializationRevision { revision: u8 },

    #[error("Could not contact any validator")]
    NoValidatorsAvailable,

    #[error("Ran into a Compact ecash error - {0}")]
    CompactEcashError(#[from] CompactEcashError),

    #[error("Ran into a validator client error - {0}")]
    ValidatorClientError(#[from] ValidatorClientError),

    #[error("Nym API request failed - {0}")]
    NymAPIError(Box<NymAPIError>),

    #[error("Bandwidth operation overflowed. {0}")]
    BandwidthOverflow(String),

    #[error("There is not associated bandwidth for the given client")]
    MissingBandwidth,

    #[error("Could not parse the key - {0}")]
    ParsePublicKey(#[from] KeyRecoveryError),

    #[error("Could not gather enough signature shares. Try again using the recovery command")]
    NotEnoughShares,

    #[error("Could not aggregate signature shares - {0}. Try again using the recovery command")]
    SignatureAggregationError(CompactEcashError),

    #[error("Could not deserialize bandwidth voucher - {0}")]
    BandwidthVoucherDeserializationError(String),

    #[error("the provided issuance data wasn't prepared for a bandwidth voucher")]
    NotABandwdithVoucher,

    #[error("failed to create a secp256k1 signature")]
    Secp256k1SignFailure,
}

impl From<NymAPIError> for Error {
    fn from(e: NymAPIError) -> Self {
        Error::NymAPIError(Box::new(e))
    }
}