1 unstable release
new 0.1.0 | Feb 12, 2025 |
---|
#399 in Magic Beans
46KB
696 lines
Lumen Stellar CLI Wallet
A command-line interface (CLI) tool for interacting with the Stellar network and Soroban RPC. This tool allows you to generate keypairs, fetch balances, send XLM, fund wallets, and manage keystores securely.
Table of Contents
Overview
The Lumen Stellar CLI Wallet is designed to simplify interactions with the Stellar blockchain. Whether you're a developer testing smart contracts on Soroban or a user managing Stellar accounts, this CLI provides a simple and secure way to perform common tasks like generating keypairs, sending payments, and funding wallets using Friendbot.
Features
- Generate Keypairs : Create new Stellar public/private keypairs.
- Fetch Balances : Check the balance of any Stellar account.
- Send XLM : Transfer XLM between accounts securely.
- Keystore Management : Save and load encrypted keystores for secure storage of private keys.
- Fund Wallets : Use Stellar Testnet Friendbot or local RPC to fund accounts.
- Environment Integration : Supports API keys for local RPC configurations.
Installation
To install the Stellar Wallet CLI, follow these steps:
-
Clone the repository:
git clone <repository_url> cd <repository_directory>
-
Build the project:
cargo build --release
-
Run the CLI:
./target/release/stellar_wallet_cli
Usage
Once the CLI is running, you can perform the following operations:
-
Generate New Keypair
1. Generate New Keypair
-
Fetch Balance
2. Fetch Balance Enter Public Key: <public_key>
-
Send XLM
3. Send XLM Enter Source Secret Key: <source_secret_key> Enter Destination Public Key: <destination_public_key> Enter Amount: <amount>
-
Save Keystore
4. Save Keystore Enter Password: <password>
-
Load Keystore
5. Load Keystore Enter Password: <password>
-
Fund Wallet
6. Fund Wallet Enter Public Key to fund: <public_key>
-
Exit
9. Exit
Contribution Guidelines
Contributions are welcome! If you'd like to contribute to this project, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bugfix.
- Implement your changes.
- Commit and push your changes.
- Create a pull request.
Please ensure your code adheres to the project's coding standards and includes appropriate tests.
Code Style
- Follow Rust's idiomatic style guidelines.
- Format your code using
cargo fmt
before submitting a PR.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Dependencies
~9–22MB
~322K SLoC