mirror of
https://github.com/aljazceru/nutshell.git
synced 2026-01-06 18:34:20 +01:00
Adjust some help for CLI
This commit is contained in:
@@ -90,8 +90,7 @@ vim .env
|
||||
To use the wallet with the [public test mint](#test-instance), you need to change the appropriate entries in the `.env` file.
|
||||
|
||||
#### Test instance
|
||||
*Warning: this instance is just for demonstration only. Currently, only Lightning deposits work but not withdrawals. The server could vanish at any moment so consider any Satoshis you deposit a donation. I will add Lightning withdrawals soon so unless someone comes up with a huge inflation bug, you might be able to claim them back at a later point in time.*
|
||||
|
||||
*Warning: this instance is just for demonstration only. The server could vanish at any moment so consider any Satoshis you deposit a donation. You can withdraw you funds with the function [cashu pay.](#pay-a-lightning-invoice)*
|
||||
|
||||
Change the appropriate `.env` file settings to
|
||||
```bash
|
||||
|
||||
@@ -74,7 +74,7 @@ def coro(f):
|
||||
return wrapper
|
||||
|
||||
|
||||
@cli.command("invoice", help="Create Lighting invoice.")
|
||||
@cli.command("invoice", help="Generate a BOLT11 Lightning invoice to fund your Cashu wallet.")
|
||||
@click.argument("amount", type=int)
|
||||
@click.option("--hash", default="", help="Hash of the paid invoice.", type=str)
|
||||
@click.pass_context
|
||||
@@ -120,7 +120,7 @@ async def invoice(ctx, amount: int, hash: str):
|
||||
return
|
||||
|
||||
|
||||
@cli.command("pay", help="Pay Lightning invoice.")
|
||||
@cli.command("pay", help="Pay a Lightning invoice to send you tokens from the mint into the Lightning Network.")
|
||||
@click.argument("invoice", type=str)
|
||||
@click.option(
|
||||
"--yes", "-y", default=False, is_flag=True, help="Skip confirmation.", type=bool
|
||||
@@ -220,7 +220,8 @@ async def receive(ctx, coin: str, lock: str):
|
||||
wallet.status()
|
||||
|
||||
|
||||
@cli.command("burn", help="Burn spent coins.")
|
||||
@cli.command("burn", help="Burn spent coins. After spednding some coins you need to burn them to prevent the wallet to do a double spent."
|
||||
"This will be blocked by the mint, cause it holds the info about all spent coins .")
|
||||
@click.argument("coin", required=False, type=str)
|
||||
@click.option("--all", "-a", default=False, is_flag=True, help="Burn all spent coins.")
|
||||
@click.option(
|
||||
@@ -250,7 +251,8 @@ async def burn(ctx, coin: str, all: bool, force: bool):
|
||||
wallet.status()
|
||||
|
||||
|
||||
@cli.command("pending", help="Show pending coins.")
|
||||
@cli.command("pending", help="Show pending coins. This shows all the coins that was already used to send but not claimed yet by the receiver."
|
||||
"If you want to cancel the send ,you can claim the cains again with the receive command")
|
||||
@click.pass_context
|
||||
@coro
|
||||
async def pending(ctx):
|
||||
|
||||
Reference in New Issue
Block a user