Skip to content

Latest commit

 

History

History
89 lines (64 loc) · 3.01 KB

README.md

File metadata and controls

89 lines (64 loc) · 3.01 KB

seedelf-cli

The seedelf-cli is a Rust implementation of the Seedelf stealth wallet protocol. It uses Cardano collateral provider, Koios, and Pallas. The wallet is primarily terminal-based but uses a static HTML web interface for CIP30 interactions when required.

Note: Wallet Is Currently In Beta

Installation

Precompile binaries are available for Linux, Windows, and MacOS. These may be found in the latest release.

If you are running Linux, MacOS, or Unix-like OS, run the following command on your terminal and follow the instructions.

curl -fsSL https://raw.githubusercontent.com/logical-mechanism/Seedelf-Wallet/refs/heads/main/util/seedelf-init.sh | bash

If you have [rust/cargo installed] (https://www.rust-lang.org/tools/install), the seedelf-cli can be installed directly from crates.io.

cargo install seedelf-cli

Building From Source

First, clone the repo and enter the cli subfolder.

git clone https://github.com/logical-mechanism/Seedelf-Wallet
cd Seedelf-Wallet/seedelf-cli

Installing on the path:

cargo install --path .

Building for release:

cargo build --release

Running it locally:

cargo run -- help

Using The Seedelf CLI

seedelf-cli help
A Cardano Stealth Wallet

Usage: seedelf-cli [OPTIONS] [COMMAND]

Commands:
 welcome   Displays the seedelf-cli welcome message
 create    Create a new Seedelf in the wallet
 remove    Remove a Seedelf from the wallet
 balance   Displays the current wallet information, seedelfs, and balance
 fund      An address sends funds to a Seedelf
 transfer  A Seedelf sends funds to a Seedelf
 sweep     A Seedelf sends funds to an address
 util      Utility functions for seedelf-cli
 dapp      dApp functions for seedelf-cli
 help      Print this message or the help of the given subcommand(s)

Options:
 --preprod            Use this flag to interact with the pre-production environment
 --variant <VARIANT>  Use this for different variants of the contract, default to the most recent variant [default: 1]
 -h, --help               Print help
 -V, --version            Print version

Basic Usage

Get started with the wallet using the welcome command.

seedelf-cli welcome

Create a Seedelf with the create command. A CIP30 wallet may fund a Seedelf address with the fund command. The user may send funds to another Seedelf address using the transfer command. The' sweep' command can send funds to a CIP30 wallet. Use the --help option to see more information.

The wallet will create an encrypted secret key file on the local machine inside the home directory under the $HOME/.seedelf folder. The wallet will prompt the user for a password and a name for the secret key file. Keep this file safe!

Contact

For questions, suggestions, or concerns, please reach out to support@logicalmechanism.io.