Wallet

Struct Wallet 

Source
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: String

Wallet name

§hotkey_name: String

Hotkey name

§path: PathBuf

Path to the wallet directory

Implementations§

Source§

impl Wallet

Source

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 directory
  • hotkey_name - Name of the hotkey file
§Returns
  • Ok(Wallet) if the wallet was loaded successfully
  • Err(BittensorError) if the wallet could not be loaded
§Example
use bittensor_rs::wallet::Wallet;

let wallet = Wallet::load("default", "default")?;
Source

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 directory
  • hotkey_name - Name of the hotkey file
  • base_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)?;
Source

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 wallet
  • hotkey_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());
Source

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 wallet
  • hotkey_name - Name of the hotkey
  • mnemonic - 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)?;
Source

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 wallet
  • hotkey_name - Name of the hotkey
  • seed_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();
Source

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);
Source

pub fn account_id(&self) -> AccountId

Get the hotkey as an AccountId

Source

pub fn sign(&self, data: &[u8]) -> Vec<u8>

Sign data with the hotkey

§Arguments
  • data - The data to sign
§Returns

A 64-byte signature

§Example
use bittensor_rs::wallet::Wallet;

let wallet = Wallet::create_random("test", "test").unwrap();
let signature = wallet.sign(b"hello world");
assert_eq!(signature.len(), 64);
Source

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 chars
Source

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();
Source

pub fn keypair(&self) -> &Pair

Get the underlying keypair (for advanced usage)

Source

pub fn verify(&self, data: &[u8], signature: &[u8]) -> bool

Verify a signature against this wallet’s hotkey

§Arguments
  • data - The original data that was signed
  • signature - 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));
Source

pub fn unlock_coldkey(&mut self, password: &str) -> Result<(), BittensorError>

Load and unlock the coldkey with a password

The coldkey is stored in <wallet_path>/coldkey and is encrypted.

§Arguments
  • password - The password to decrypt the coldkey
§Returns
  • Ok(()) if the coldkey was loaded and decrypted
  • Err(BittensorError) if loading or decryption failed
Source

pub fn is_coldkey_unlocked(&self) -> bool

Check if the coldkey is unlocked

Source

pub fn coldkey(&self) -> Option<Hotkey>

Get the coldkey address if unlocked

Trait Implementations§

Source§

impl Clone for Wallet

Source§

fn clone(&self) -> Wallet

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Wallet

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CheckedConversion for T

Source§

fn checked_from<T>(t: T) -> Option<Self>
where Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more
Source§

fn checked_into<T>(self) -> Option<T>
where Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> FmtForward for T

Source§

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,

Causes self to use its Display implementation when Debug-formatted.
Source§

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,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

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,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

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,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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 more
Source§

impl<T, Outer> IsWrappedBy<Outer> for T
where Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

Source§

fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

Source§

fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where 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) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

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
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

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
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatedConversion for T

Source§

fn saturated_from<T>(t: T) -> Self
where Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more
Source§

fn saturated_into<T>(self) -> T
where Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

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

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
where Self: Borrow<B>, B: ?Sized,

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
where Self: BorrowMut<B>, B: ?Sized,

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
where Self: AsRef<R>, R: ?Sized,

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
where Self: AsMut<R>, R: ?Sized,

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
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T> UncheckedInto<T> for S
where T: UncheckedFrom<S>,

Source§

fn unchecked_into(self) -> T

The counterpart to unchecked_from.
Source§

impl<T, S> UniqueSaturatedInto<T> for S
where T: Bounded, S: TryInto<T>,

Source§

fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> JsonSchemaMaybe for T

Source§

impl<T> MaybeDebug for T
where T: Debug,

Source§

impl<T> MaybeRefUnwindSafe for T
where T: RefUnwindSafe,

Source§

impl<T> MaybeSend for T
where T: Send,