seedelf-cli 0.4.10

Seedelf: A Cardano Stealth Wallet
Documentation

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 installed then the seedelf-cli may be installed directly from crates.io.

cargo install seedelf-cli

The install command can be used to update the 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-platform

Installing on the path:

cargo install --path seedelf-cli --bin seedelf-cli
seedelf-cli help

Building for release:

cargo build --release --bin seedelf-cli 
./target/release/seedelf-cli help

Running it locally:

cargo run -- help

Using The CLI

See all functions with the help command.

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
  external  External wallet 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, defaults to 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

This command will generate an encrypted secret key for the wallet. The welcome command will prompt the user for a password and a name for the secret key file. The wallet will use this secret key for all spending-related actions. The user must keep the secret key safe and secure. Keep this file safe! The wallet stores the encrypted secret key file on the local machine inside the home directory under the $HOME/.seedelf folder.

The following action will create a Seedelf token with the create command.

seedelf-cli create [OPTIONS] --address <ADDRESS>

The available [OPTIONS] may be viewed with the --help parameter. The <ADDRESS> parameter in the create command is the address paying for the Seedelf token mint transaction. This address must come from a CIP30-enabled wallet. The create command will use a local web server to generate a website at http://127.0.0.1:44203/. The website will ask the user to select a wallet from the dropdown in the top right corner. The website will prompt the user to enable the wallet and sign the transaction. The Transaction CBOR section shows the CBOR of the signed transaction.

At this point, the wallet may receive funds from other CIP30 wallets or Seedelfs. Users may fund their own Seedelf and others by using the fund command.

seedelf-cli fund [OPTIONS] --address <ADDRESS> --seedelf <SEEDELF>

The available [OPTIONS] may be viewed with the --help parameter. The <ADDRESS> parameter used in the fund command is the address supplying the value and paying for the transaction. The <SEEDELF> parameter is the Seedelf receiving the funds. The fund command is similar to the create command as it generates a local website for CIP30 interactions.

The user may send funds to another Seedelf address using the transfer command and back to a CIP30 wallet using the sweep command.

Use seedelf-cli help to view all available commands and the --help option to see more information about a specific command.

dApp Interactions: The Sweep-Fund Flow

We suggest the following flow to interact with dApps. This flow has the best user experience and uses the already existing tech stack on Cardano. The idea is to use a new CIP30 wallet, which is wholly disconnected from the user's owned wallets and is dapp enabled. The user will sweep funds from Seedelf into that new wallet. The user may interact with the dApp of choice. The resulting funds after interaction may fund your Seedelf. For simplicity, Seedelf provides an external wallet that may receive funds without invoking the contract. The external sweep command can return the funds to the contract. The user may send funds with the fund command.

Example: Purchase Tokens with 25 ADA From A Dex On Mainnet

Using the fund command:

seedelf-cli sweep --address <NEW_WALLET_ADDRESS> --lovelace 25000000
# Purchase tokens from dex with 25 ADA
seedelf-cli fund [OPTIONS] --address <NEW_WALLET_ADDRESS> --seedelf <SEEDELF>

Using the external wallet:

seedelf-cli sweep --address <NEW_WALLET_ADDRESS> --lovelace 25000000
# Purchase tokens from dex with 25 ADA
# Send tokens and remaining ada from the new wallet to the external wallet
seedelf-cli external sweep

The user may view the external wallet address with the external balance command.

seedelf-cli external balance

The benefit of the external wallet method is that it can be used to accumulate many UTxOs that can later be sent into the wallet.

Privacy is preserved with this method because the new wallet address is funded directly from Seedelf, removing all linkability as ownership can only be assumed and not proven. Funding a seedelf from the new wallet is private as the new wallet is anonymous, and the contract does not link the UTxO to the seedelf. Privacy preservation is maintained when using the external address as long as the linkability of the original wallet and the external wallet is never connected or created. The flow Seedelf -> New Wallet -> dAPP -> New Wallet -> Seedelf and Seedelf -> New Wallet -> dAPP -> New Wallet -> External Wallet -> Seedelf will be private.

Contact

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