iota-sdk 1.0.1

The IOTA SDK provides developers with a seamless experience to develop on IOTA by providing account abstractions and clients to interact with node APIs.
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

// Copyright 2023 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

use std::path::{Path, PathBuf};

use serde::{Deserialize, Serialize};
use zeroize::Zeroizing;

use crate::wallet::storage::{constants::default_storage_path, StorageKind};

#[cfg(feature = "storage")]
#[cfg_attr(docsrs, doc(cfg(feature = "storage")))]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct StorageOptions {
    pub(crate) path: PathBuf,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub(crate) encryption_key: Option<Zeroizing<[u8; 32]>>,
    pub(crate) kind: StorageKind,
}

#[cfg(feature = "storage")]
impl Default for StorageOptions {
    fn default() -> Self {
        Self {
            path: default_storage_path().into(),
            encryption_key: None,
            kind: StorageKind::default(),
        }
    }
}

impl StorageOptions {
    /// Creates a new [`StorageOptions`].
    pub fn new(path: PathBuf, kind: StorageKind) -> Self {
        Self {
            path,
            encryption_key: None,
            kind,
        }
    }

    /// Adds an encryption key to the [`StorageOptions`].
    pub fn with_encryption_key(mut self, encryption_key: [u8; 32]) -> Self {
        self.encryption_key = Some(Zeroizing::new(encryption_key));
        self
    }

    /// Returns the path of the [`StorageOptions`];
    pub fn path(&self) -> &Path {
        &self.path
    }

    /// Returns the encryption key of the [`StorageOptions`];
    pub fn encryption_key(&self) -> Option<&[u8; 32]> {
        self.encryption_key.as_deref()
    }

    /// Returns the kind of the [`StorageOptions`];
    pub fn kind(&self) -> StorageKind {
        self.kind
    }
}