Struct Wallet 

pub struct Wallet { /* private fields */ }

A unified wallet that can hold either SR25519 or ED25519 keys

Security

This struct handles sensitive cryptographic material and implements secure memory practices:

• Cloning: This struct implements Clone to support wallet management. Cloning duplicates private key material in memory. For shared access without duplication, wrap in Arc<Wallet>.

• Memory Zeroing: The underlying sp_core::Pair types (SR25519 and ED25519) implement secure memory clearing on drop. However, cloned instances each maintain their own copy until dropped.

• Best Practices:

  • Minimize the lifetime of wallet instances
  • Use Arc<Wallet> for shared access
  • Avoid logging or printing wallet contents
  • Drop wallets explicitly when no longer needed

Example

use apex_sdk_substrate::wallet::{Wallet, KeyPairType};
use std::sync::Arc;

// For single ownership
let wallet = Wallet::new_random();
// Use wallet...
drop(wallet); // Explicitly drop when done

// For shared access (recommended)
let wallet = Arc::new(Wallet::new_random());
let wallet_clone = Arc::clone(&wallet); // Increments reference count, no key duplication

Implementations

impl Wallet

pub fn new_random() -> Self

Create a new random wallet with SR25519 keys

pub fn new_random_with_type(key_type: KeyPairType) -> Self

Create a new random wallet with specified key type

pub fn from_mnemonic(mnemonic: &str, key_type: KeyPairType) -> Result<Self>

Create wallet from mnemonic phrase

pub fn from_mnemonic_with_path( mnemonic: &str, path: Option<&str>, key_type: KeyPairType, ) -> Result<Self>

Create wallet from mnemonic phrase with derivation path

pub fn from_seed(seed: &[u8], key_type: KeyPairType) -> Result<Self>

Create wallet from private key (seed)

pub fn generate_mnemonic() -> String

Generate a new mnemonic phrase

pub fn with_ss58_format(self, format: u16) -> Self

Set the SS58 address format (network prefix)

pub fn public_key(&self) -> Vec<u8>

Get the public key as bytes

pub fn address(&self) -> String

Get the SS58-encoded address

pub fn key_type(&self) -> KeyPairType

Get the key pair type

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

Sign a message

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

Verify a signature

pub fn seed(&self) -> Option<[u8; 32]>

Get the seed/private key (if available) Note: This should be kept secure and not exposed in production

pub fn sr25519_pair(&self) -> Option<&Pair>

Get the SR25519 pair for signing (if this is an SR25519 wallet)

pub fn ed25519_pair(&self) -> Option<&Pair>

Get the ED25519 pair for signing (if this is an ED25519 wallet)

Trait Implementations

impl Clone for Wallet

fn clone(&self) -> Wallet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Wallet

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

Formats the value using the given formatter.

impl Drop for Wallet

fn drop(&mut self)

Executes the destructor for this type.