nym-compact-ecash 1.20.4

Nym's ecash implementation
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

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

#![warn(clippy::expect_used)]
#![warn(clippy::unwrap_used)]
#![warn(clippy::todo)]
#![warn(clippy::dbg_macro)]

use nym_bls12_381_fork::Scalar;
use std::sync::OnceLock;

pub use crate::error::CompactEcashError;
pub use crate::traits::Bytable;
pub use common_types::{BlindedSignature, Signature};
pub use helpers::{date_scalar, type_scalar};
pub use nym_bls12_381_fork::G1Projective;
pub use scheme::aggregation::aggregate_verification_keys;
pub use scheme::aggregation::aggregate_wallets;
pub use scheme::identify;
pub use scheme::keygen::ttp_keygen;
pub use scheme::keygen::{generate_keypair_user, generate_keypair_user_from_seed};
pub use scheme::keygen::{
    KeyPairAuth, PublicKeyUser, SecretKeyAuth, SecretKeyUser, VerificationKeyAuth,
};
pub use scheme::setup;
pub use scheme::withdrawal::issue;
pub use scheme::withdrawal::issue_verify;
pub use scheme::withdrawal::withdrawal_request;
pub use scheme::withdrawal::WithdrawalRequest;
pub use scheme::PartialWallet;
pub use scheme::PayInfo;
pub use setup::GroupParameters;
pub use traits::Base58;

pub mod common_types;
pub mod constants;
pub mod error;
mod helpers;
pub mod proofs;
pub mod scheme;
pub mod tests;
mod traits;
pub mod utils;

pub type Attribute = Scalar;
pub type EncodedTicketType = u8;
pub type EncodedDate = u32;

pub fn ecash_parameters() -> &'static setup::Parameters {
    static ECASH_PARAMS: OnceLock<setup::Parameters> = OnceLock::new();
    ECASH_PARAMS.get_or_init(|| setup::Parameters::new(constants::NB_TICKETS))
}

pub fn ecash_group_parameters() -> &'static setup::GroupParameters {
    static ECASH_PARAMS: OnceLock<setup::GroupParameters> = OnceLock::new();
    ECASH_PARAMS.get_or_init(|| setup::GroupParameters::new(constants::ATTRIBUTES_LEN))
}

// if anything changes here you MUST correctly increase semver of this library
pub(crate) fn binary_serialiser() -> impl bincode::Options {
    use bincode::Options;
    bincode::DefaultOptions::new()
        .with_big_endian()
        .with_varint_encoding()
}