From cc15ee51403d48ad3b394e0a18526c9ca7b3d656 Mon Sep 17 00:00:00 2001 From: loziniak Date: Sun, 27 Oct 2024 23:53:38 +0100 Subject: [PATCH] chore(autonomi): minor clarifications --- autonomi/Cargo.toml | 2 +- autonomi/src/lib.rs | 6 ++++++ evmlib/src/wallet.rs | 2 +- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/autonomi/Cargo.toml b/autonomi/Cargo.toml index 3da273183e..7f4fb00ac0 100644 --- a/autonomi/Cargo.toml +++ b/autonomi/Cargo.toml @@ -14,7 +14,7 @@ crate-type = ["cdylib", "rlib"] [features] default = ["data", "vault"] -full = ["data", "registers", "vault"] +full = ["data", "registers", "vault", "fs"] data = [] vault = ["data", "registers"] fs = ["tokio/fs", "data"] diff --git a/autonomi/src/lib.rs b/autonomi/src/lib.rs index c73bef1378..d7441a6736 100644 --- a/autonomi/src/lib.rs +++ b/autonomi/src/lib.rs @@ -24,7 +24,13 @@ //! //! # Features //! +//! - `fs`: Up/download files and directories from filesystem +//! - `registers`: Operate on register datatype +//! - `data`: Operate on raw bytes and chunks +//! - `vault`: Operate on Vault datatype +//! - `full`: All of above //! - `local`: Discover local peers using mDNS. Useful for development. +//! - `loud`: Print debug information to stdout // docs.rs generation will enable unstable `doc_cfg` feature #![cfg_attr(docsrs, feature(doc_cfg))] diff --git a/evmlib/src/wallet.rs b/evmlib/src/wallet.rs index b9504f69a1..8b82834456 100644 --- a/evmlib/src/wallet.rs +++ b/evmlib/src/wallet.rs @@ -52,7 +52,7 @@ impl Wallet { Self::new(network, random()) } - /// Creates a new Wallet based on the given private_key. It will fail with Error::PrivateKeyInvalid if private_key is invalid. + /// Creates a new Wallet based on the given Ethereum private key. It will fail with Error::PrivateKeyInvalid if private_key is invalid. pub fn new_from_private_key(network: Network, private_key: &str) -> Result { let wallet = from_private_key(private_key)?; Ok(Self::new(network, wallet))