rusk-wallet 0.3.0

A library providing functionalities to create wallets compatible with Dusk
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

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
//
// Copyright (c) DUSK NETWORK. All rights reserved.

//! # Dusk Wallet Lib
//!
//! The `dusk_wallet` library aims to provide an easy and convenient way of
//! interfacing with the Dusk Network.
//!
//! Clients can use `Wallet` to create their Dusk wallet, send transactions
//! through the network of their choice, stake and claim rewards, etc.

#![deny(missing_docs)]
#![deny(clippy::pedantic)]

mod cache;
mod clients;
mod crypto;
mod error;
mod gql;
mod rues;
mod store;
mod wallet;

pub mod currency;
pub mod dat;
pub mod gas;

pub use dusk_core::stake::EPOCH;
pub use error::Error;
pub use gql::{BlockData, BlockTransaction, GraphQL};
pub use rues::HttpClient as RuesHttpClient;
pub use wallet::{
    Address, DecodedNote, Profile, SecureWalletFile, Wallet, WalletPath,
};

use currency::Dusk;

/// The maximum allowed size for function names, set to 64 bytes
pub const MAX_FUNCTION_NAME_SIZE: usize = 64;
/// The largest amount of Dusk that is possible to convert
pub const MAX_CONVERTIBLE: Dusk = Dusk::MAX;
/// The smallest amount of Dusk that is possible to convert
pub const MIN_CONVERTIBLE: Dusk = Dusk::new(1);
/// Max addresses the wallet can store
pub const MAX_PROFILES: usize = get_max_profiles();
/// Size in bytes of the IV used to encrypt wallet data
pub const IV_SIZE: usize = 12;
/// Size in bytes of the salt used to encrypt wallet data
pub const SALT_SIZE: usize = 32;
/// Number of PBKDF2 rounds used to derive the key for encrypting wallet data
pub const PBKDF2_ROUNDS: u32 = 10_000;

const DEFAULT_MAX_PROFILES: usize = 2;

// # Panics
// The function is const and will panic during compilation if the value is
// invalid or larger that 255.
const fn get_max_profiles() -> usize {
    match option_env!("WALLET_MAX_PROFILES") {
        Some(v) => match konst::primitive::parse_usize(v) {
            Ok(e) if e > 255 => {
                panic!("WALLET_MAX_PROFILES must be lower or equal to 255")
            }
            Ok(e) if e > 0 => e,
            _ => panic!("Invalid WALLET_MAX_PROFILES"),
        },
        None => DEFAULT_MAX_PROFILES,
    }
}