Skip to content

Commit

Permalink
updating readme with the new help text
Browse files Browse the repository at this point in the history
  • Loading branch information
logicalmechanism committed Dec 19, 2024
1 parent 6f2defd commit 5d19369
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 30 deletions.
23 changes: 10 additions & 13 deletions seedelf-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,30 +32,27 @@ Precompile binaries are available for Linux, Windows, and MacOS. These may be fo
```bash
A Cardano Stealth Wallet

Usage: seedelf-cli [OPTIONS] <COMMAND>
Usage: seedelf-cli [OPTIONS] [COMMAND]

Commands:
welcome Displays the Seedelf welcome message
wallet-info Displays wallet information
balance Displays the current wallet balance
fund An address sends ADA to a Seedelf
transfer A Seedelf sends ADA to a Seedelf
sweep A Seedelf sends ADA to an address
seedelf-new Create a new Seedelf
seedelf-all Display all Seedelfs
seedelf-remove Remove a Seedelf
help Print this message or the help of the given subcommand(s)
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
help Print this message or the help of the given subcommand(s)

Options:
--preprod Use this flag to interact with the pre-production environment
-h, --help Print help
-V, --version Print version

```

### Basic Usage

Create a Seedelf with the `seedelf-new` command. The Seedelf is funded with the `fund` command. Send funds to another Seedelf with the `transfer` command. Funds can be send to an address with the `sweep` command. Use the `--help` option to see more information.
Create a Seedelf with the `create` command. The Seedelf is funded with the `fund` command. Send funds to another Seedelf with the `transfer` command. Funds can be send to an address with the `sweep` command. Use the `--help` option to see more information.

**Some commands will prompt to open a localhost for cip30 wallet interaction.**

Expand Down
12 changes: 6 additions & 6 deletions seedelf-cli/src/commands/fund.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,27 +18,27 @@ use seedelf_cli::web_server;
#[derive(Args)]
pub struct FundArgs {
/// Seedelf to send funds too
#[arg(long, help = "The address sending funds to the Seedelf.")]
#[arg(short = 'a', long, help = "The address sending funds to the Seedelf.", display_order = 1)]
address: String,

/// Seedelf to send funds too
#[arg(long, help = "The Seedelf receiving funds.")]
#[arg(short = 's', long, help = "The Seedelf receiving funds.", display_order = 2)]
seedelf: String,

/// The amount of Lovelace to send
#[arg(long, help = "The amount of Lovelace being sent to the Seedelf.")]
#[arg(short = 'l', long, help = "The amount of Lovelace being sent to the Seedelf.", display_order = 3)]
lovelace: Option<u64>,

/// Optional repeated `policy-id`
#[arg(long = "policy-id", help = "The policy id for the asset.")]
#[arg(long = "policy-id", help = "The policy id for the asset.", display_order = 4)]
policy_id: Option<Vec<String>>,

/// Optional repeated `token-name`
#[arg(long = "token-name", help = "The token name for the asset")]
#[arg(long = "token-name", help = "The token name for the asset", display_order = 5)]
token_name: Option<Vec<String>>,

/// Optional repeated `amount`
#[arg(long = "amount", help = "The amount for the asset")]
#[arg(long = "amount", help = "The amount for the asset", display_order = 6)]
amount: Option<Vec<u64>>,
}

Expand Down
12 changes: 6 additions & 6 deletions seedelf-cli/src/commands/sweep.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,27 +27,27 @@ use seedelf_cli::setup;
#[derive(Args)]
pub struct SweepArgs {
/// address that receives the funds
#[arg(long, help = "The address receiving funds.")]
#[arg(short = 'a', long, help = "The address receiving funds.", display_order = 1)]
address: String,

/// The amount of ADA to send
#[arg(long, help = "The amount of Lovelace being sent to the address. Cannt be used with --all")]
#[arg(short = 'l', long, help = "The amount of Lovelace being sent to the address. Cannt be used with --all", display_order = 2)]
lovelace: Option<u64>,

/// Send all funds if amount is not specified
#[arg(long, help = "Send all funds. Cannot be used with --amount.")]
#[arg(long, help = "Send all funds. Cannot be used with --amount.", display_order = 3)]
all: bool,

/// Optional repeated `policy-id`
#[arg(long = "policy-id", help = "The policy id for the asset.")]
#[arg(long = "policy-id", help = "The policy id for the asset.", display_order = 4)]
policy_id: Option<Vec<String>>,

/// Optional repeated `token-name`
#[arg(long = "token-name", help = "The token name for the asset")]
#[arg(long = "token-name", help = "The token name for the asset", display_order = 5)]
token_name: Option<Vec<String>>,

/// Optional repeated `amount`
#[arg(long = "amount", help = "The amount for the asset")]
#[arg(long = "amount", help = "The amount for the asset", display_order = 6)]
amount: Option<Vec<u64>>,
}

Expand Down
10 changes: 5 additions & 5 deletions seedelf-cli/src/commands/transfer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,23 +27,23 @@ use seedelf_cli::setup;
#[derive(Args)]
pub struct TransforArgs {
/// Seedelf to send funds too
#[arg(long, help = "The Seedelf receiving funds.")]
#[arg(short = 's', long, help = "The Seedelf receiving funds.", display_order = 1)]
seedelf: String,

/// The amount of ADA to send
#[arg(long, help = "The amount of ADA being sent to the Seedelf.")]
#[arg(short = 'l', long, help = "The amount of ADA being sent to the Seedelf.", display_order = 2)]
lovelace: Option<u64>,

/// Optional repeated `policy-id`
#[arg(long = "policy-id", help = "The policy id for the asset.")]
#[arg(long = "policy-id", help = "The policy id for the asset.", display_order = 3)]
policy_id: Option<Vec<String>>,

/// Optional repeated `token-name`
#[arg(long = "token-name", help = "The token name for the asset")]
#[arg(long = "token-name", help = "The token name for the asset", display_order = 4)]
token_name: Option<Vec<String>>,

/// Optional repeated `amount`
#[arg(long = "amount", help = "The amount for the asset")]
#[arg(long = "amount", help = "The amount for the asset", display_order = 5)]
amount: Option<Vec<u64>>,
}

Expand Down

0 comments on commit 5d19369

Please sign in to comment.