Skip to content

Commit f86d63b

Browse files
sagpatilfnando
andauthored
Improve payment amount parameter description (#2056)
* Improve payment amount parameter description - Clarify that amount is specified in stroops - Add explanation of stroop to asset conversion (1 stroop = 0.0000001 of asset) - Update both source code comment and generated documentation - Example: 1 XLM = 10_000_000 stroops * Generate docs. --------- Co-authored-by: Nando Vieira <me@fnando.com>
1 parent 8e85237 commit f86d63b

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

FULL_HELP_DOCS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1874,7 +1874,7 @@ Sends an amount in a specific asset to a destination account
18741874
* `--asset <ASSET>` — Asset to send, default native, e.i. XLM
18751875

18761876
Default value: `native`
1877-
* `--amount <AMOUNT>` — Amount of the aforementioned asset to send. e.g. `10_000_000` (1 XLM)
1877+
* `--amount <AMOUNT>` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = 10_000_000 stroops)
18781878

18791879

18801880

@@ -2214,7 +2214,7 @@ Sends an amount in a specific asset to a destination account
22142214
* `--asset <ASSET>` — Asset to send, default native, e.i. XLM
22152215

22162216
Default value: `native`
2217-
* `--amount <AMOUNT>` — Amount of the aforementioned asset to send. e.g. `10_000_000` (1 XLM)
2217+
* `--amount <AMOUNT>` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = 10_000_000 stroops)
22182218

22192219

22202220

cmd/soroban-cli/src/commands/tx/new/payment.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ pub struct Args {
1919
/// Asset to send, default native, e.i. XLM
2020
#[arg(long, default_value = "native")]
2121
pub asset: builder::Asset,
22-
/// Amount of the aforementioned asset to send. e.g. `10_000_000` (1 XLM)
22+
/// Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = 10_000_000 stroops).
2323
#[arg(long)]
2424
pub amount: builder::Amount,
2525
}

0 commit comments

Comments
 (0)