https://github.com/mikesposito/walleth
A Rust library for easily create, manage, use and protect Ethereum accounts.
https://github.com/mikesposito/walleth
accounts ethereum library rust wallet webassembly
Last synced: 6 months ago
JSON representation
A Rust library for easily create, manage, use and protect Ethereum accounts.
- Host: GitHub
- URL: https://github.com/mikesposito/walleth
- Owner: mikesposito
- License: mit
- Created: 2023-09-15T18:02:37.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-08T23:31:16.000Z (over 1 year ago)
- Last Synced: 2025-04-13T11:12:19.284Z (6 months ago)
- Topics: accounts, ethereum, library, rust, wallet, webassembly
- Language: Rust
- Homepage:
- Size: 86.9 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# walleth
A (WIP) Rust library for easily create, manage, use and protect Ethereum accounts. Interacting with keys and signing transactions securely (will be) made as easy as breathing.
> [!WARNING]
> This library is under development and APIs are rapidly changing iIncluding this README!). Make sure to lock to a specific crate version to avoid updates.
## Features
- [x] 💳 Multiple BIP39 HD wallets management
- [x] 🔐 Built-in encryption for all keys managed
- [x] ✨ Built-in bytes serialization / deserialization for the entire keychain
- [x] 🚧 Customizable wallet classes (HD, single, etc..)
- [ ] 🌎 Built-in network scraper
- [ ] 🛒 Built-in transaction manager
- [ ] ⚡️ Built-in JSON-RPC Provider engine
## Usage
### Create a new keychain
```rust
use walleth::keychain::Keychain;
use walleth::hdkey::HDKey;
let mut keychain = Keychain::::new();
```
### Add a new HD Wallet to the keychain
```rust
use walleth::keychain::Keychain;
use walleth::hdkey::{HDKey, hdkey_factory};
let mut keychain = Keychain::::new();
let hdwallet = keychain.add_multi_keypair(hdkey_factory, None).unwrap();
```
### Add a new HD Wallet to the keychain with a specific mnemonic
```rust
use walleth::keychain::Keychain;
use walleth::hdkey::{HDKey, hdkey_factory};
let mnemonic = "grocery belt target explain clay essay focus spatial skull brain measure matrix toward visual protect owner stone scale slim ghost panda exact combine game".to_string();
let mut keychain = Keychain::::new();
let hdwallet = keychain.add_multi_keypair(hdkey_factory, Some(mnemonic)).unwrap();
```
### Derive keys and sign
```rust
use walleth::{
keychain::Keychain,
hdkey::{HDKey, hdkey_factory},
identity::{
MultiKeyPair,
AccountDeriver,
signer::{Signer, Signable}
},
};
let mut keychain = Keychain::::new();
let hdwallet = keychain.add_multi_keypair(hdkey_factory, None).unwrap();
// Derive an account at path
let account = hdwallet.account_at(0).unwrap();
// Sign a message
let signature = hdwallet.sign(&account, "Hello".as_bytes()).unwrap();
// Verify signature
hdwallet.verify(&account, "Hello".as_bytes(), &signature);
```
> [!NOTE]
> See [documentation page](https://docs.rs/walleth/0.1.0/walleth) for more information about the available methods and modules, and how to use them.