Skip to content

Commit

Permalink
command doc
Browse files Browse the repository at this point in the history
  • Loading branch information
thibault-martinez committed Dec 31, 2024
1 parent b7ec73e commit 148e666
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
11 changes: 6 additions & 5 deletions crates/iota/src/client_commands.rs
Original file line number Diff line number Diff line change
Expand Up @@ -234,11 +234,12 @@ pub enum IotaClientCommands {
#[clap(flatten)]
opts: OptsWithGas,
},
/// Generate new address and keypair with keypair scheme flag {ed25519 |
/// secp256k1 | secp256r1} with optional derivation path, default to
/// m/44'/4218'/0'/0'/0' for ed25519 or m/54'/4218'/0'/0/0 for secp256k1
/// or m/74'/4218'/0'/0/0 for secp256r1. Word length can be { word12 |
/// word15 | word18 | word21 | word24} default to word12 if not specified.
/// Generate new address and keypair with optional key scheme {ed25519 |
/// secp256k1 | secp256r1} which defaults to ed25519, optional alias which
/// defaults to a random one, optional word length { word12 | word15 |
/// word18 | word21 | word24} which defaults to word12, and optional
/// derivation path which defaults to m/44'/4218'/0'/0'/0' for ed25519,
/// m/54'/4218'/0'/0/0 for secp256k1 or m/74'/4218'/0'/0/0 for secp256r1.
#[clap(name = "new-address")]
NewAddress {
#[clap(long, default_value_t = SignatureScheme::ED25519)]
Expand Down
4 changes: 2 additions & 2 deletions docs/content/references/cli/client.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ Commands:
faucet Request gas coin from faucet. By default, it will use the active address and the active network
gas Obtain all gas objects owned by the address. An address' alias can be used instead of the address
merge-coin Merge two coin objects into one coin
new-address Generate new address and keypair with keypair scheme flag {ed25519 | secp256k1 | secp256r1} with optional derivation path, default to m/44'/4218'/0'/0'/0' for ed25519 or m/54'/4218'/0'/0/0
for secp256k1 or m/74'/4218'/0'/0/0 for secp256r1. Word length can be { word12 | word15 | word18 | word21 | word24} default to word12 if not specified
new-address Generate new address and keypair with optional key scheme {ed25519 | secp256k1 | secp256r1} which defaults to ed25519, optional alias which defaults to a random one, optional word length { word12 | word15 | word18 | word21 |
word24} which defaults to word12, and optional derivation path which defaults to m/44'/4218'/0'/0'/0' for ed25519, m/54'/4218'/0'/0/0 for secp256k1 or m/74'/4218'/0'/0/0 for secp256r1
new-env Add new IOTA environment
object Get object info
objects Obtain all objects owned by the address. It also accepts an address by its alias
Expand Down

0 comments on commit 148e666

Please sign in to comment.