pub struct Wallet {
pub name: String,
pub hotkey_name: String,
pub path: PathBuf,
/* private fields */
}Expand description
Bittensor wallet for managing keys and signing transactions
A wallet contains:
- A hotkey (required) for signing transactions
- An optional coldkey for staking operations
§Example
use bittensor_rs::wallet::Wallet;
// Load from default ~/.bittensor/wallets path
let wallet = Wallet::load("my_wallet", "my_hotkey")?;
println!("Hotkey: {}", wallet.hotkey());Fields§
§name: StringWallet name
hotkey_name: StringHotkey name
path: PathBufPath to the wallet directory
Implementations§
Source§impl Wallet
impl Wallet
Sourcepub fn load(
wallet_name: &str,
hotkey_name: &str,
) -> Result<Self, BittensorError>
pub fn load( wallet_name: &str, hotkey_name: &str, ) -> Result<Self, BittensorError>
Load a wallet from the default Bittensor wallet path
Wallets are stored in ~/.bittensor/wallets/<wallet_name>/hotkeys/<hotkey_name>
§Arguments
wallet_name- Name of the wallet directoryhotkey_name- Name of the hotkey file
§Returns
Ok(Wallet)if the wallet was loaded successfullyErr(BittensorError)if the wallet could not be loaded
§Example
use bittensor_rs::wallet::Wallet;
let wallet = Wallet::load("default", "default")?;Sourcepub fn load_from_path(
wallet_name: &str,
hotkey_name: &str,
base_path: &Path,
) -> Result<Self, BittensorError>
pub fn load_from_path( wallet_name: &str, hotkey_name: &str, base_path: &Path, ) -> Result<Self, BittensorError>
Load a wallet from a custom path
§Arguments
wallet_name- Name of the wallet directoryhotkey_name- Name of the hotkey filebase_path- Base path where wallets are stored
§Example
use bittensor_rs::wallet::Wallet;
use std::path::PathBuf;
let base_path = PathBuf::from("/custom/wallets");
let wallet = Wallet::load_from_path("my_wallet", "my_hotkey", &base_path)?;Sourcepub fn create_random(
wallet_name: &str,
hotkey_name: &str,
) -> Result<Self, BittensorError>
pub fn create_random( wallet_name: &str, hotkey_name: &str, ) -> Result<Self, BittensorError>
Create a new wallet with a random seed
§Arguments
wallet_name- Name of the wallethotkey_name- Name of the hotkey
§Returns
A new wallet with a randomly generated keypair (not saved to disk)
§Example
use bittensor_rs::wallet::Wallet;
let wallet = Wallet::create_random("test_wallet", "test_hotkey").unwrap();
assert!(!wallet.hotkey().as_str().is_empty());Sourcepub fn from_mnemonic(
wallet_name: &str,
hotkey_name: &str,
mnemonic: &str,
) -> Result<Self, BittensorError>
pub fn from_mnemonic( wallet_name: &str, hotkey_name: &str, mnemonic: &str, ) -> Result<Self, BittensorError>
Create a wallet from a mnemonic phrase
§Arguments
wallet_name- Name of the wallethotkey_name- Name of the hotkeymnemonic- BIP39 mnemonic phrase (12 or 24 words)
§Example
use bittensor_rs::wallet::Wallet;
let mnemonic = "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about";
let wallet = Wallet::from_mnemonic("test", "test", mnemonic)?;Sourcepub fn from_seed_hex(
wallet_name: &str,
hotkey_name: &str,
seed_hex: &str,
) -> Result<Self, BittensorError>
pub fn from_seed_hex( wallet_name: &str, hotkey_name: &str, seed_hex: &str, ) -> Result<Self, BittensorError>
Create a wallet from a hex seed
§Arguments
wallet_name- Name of the wallethotkey_name- Name of the hotkeyseed_hex- Hex-encoded seed (32 bytes, optionally prefixed with “0x”)
§Example
use bittensor_rs::wallet::Wallet;
let seed = "0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef";
let wallet = Wallet::from_seed_hex("test", "test", seed).unwrap();Sourcepub fn hotkey(&self) -> Hotkey
pub fn hotkey(&self) -> Hotkey
Get the hotkey address as a Hotkey type
§Example
use bittensor_rs::wallet::Wallet;
let wallet = Wallet::create_random("test", "test").unwrap();
let hotkey = wallet.hotkey();
println!("Address: {}", hotkey);Sourcepub fn account_id(&self) -> AccountId
pub fn account_id(&self) -> AccountId
Get the hotkey as an AccountId
Sourcepub fn sign_hex(&self, data: &[u8]) -> String
pub fn sign_hex(&self, data: &[u8]) -> String
Sign data and return hex-encoded signature
§Example
use bittensor_rs::wallet::Wallet;
let wallet = Wallet::create_random("test", "test").unwrap();
let sig_hex = wallet.sign_hex(b"hello");
assert_eq!(sig_hex.len(), 128); // 64 bytes = 128 hex charsSourcepub fn signer(&self) -> WalletSigner
pub fn signer(&self) -> WalletSigner
Get a subxt-compatible signer for this wallet
§Example
use bittensor_rs::wallet::Wallet;
let wallet = Wallet::create_random("test", "test").unwrap();
let signer = wallet.signer();Sourcepub fn verify(&self, data: &[u8], signature: &[u8]) -> bool
pub fn verify(&self, data: &[u8], signature: &[u8]) -> bool
Verify a signature against this wallet’s hotkey
§Arguments
data- The original data that was signedsignature- The 64-byte signature
§Returns
true if the signature is valid, false otherwise
§Example
use bittensor_rs::wallet::Wallet;
let wallet = Wallet::create_random("test", "test").unwrap();
let message = b"hello world";
let signature = wallet.sign(message);
assert!(wallet.verify(message, &signature));Sourcepub fn unlock_coldkey(&mut self, password: &str) -> Result<(), BittensorError>
pub fn unlock_coldkey(&mut self, password: &str) -> Result<(), BittensorError>
Sourcepub fn is_coldkey_unlocked(&self) -> bool
pub fn is_coldkey_unlocked(&self) -> bool
Check if the coldkey is unlocked
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Wallet
impl RefUnwindSafe for Wallet
impl Send for Wallet
impl Sync for Wallet
impl Unpin for Wallet
impl UnwindSafe for Wallet
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CheckedConversion for T
impl<T> CheckedConversion for T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T, Outer> IsWrappedBy<Outer> for T
impl<T, Outer> IsWrappedBy<Outer> for T
Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self, then passes self.deref() into the pipe function.Source§impl<T> SaturatedConversion for T
impl<T> SaturatedConversion for T
Source§fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
Source§fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
Consume self to return an equivalent value of
T. Read moreSource§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref() only in debug builds, and is erased in release
builds.Source§impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
Source§fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
The counterpart to
unchecked_from.Source§impl<T, S> UniqueSaturatedInto<T> for S
impl<T, S> UniqueSaturatedInto<T> for S
Source§fn unique_saturated_into(self) -> T
fn unique_saturated_into(self) -> T
Consume self to return an equivalent value of
T.