mirror of
https://github.com/mimblewimble/grin-wallet.git
synced 2025-03-14 13:01:10 +03:00
b4eeb50c66
* udpate for beta release * initial tor explorations * rustfmt * basic tor tx send working * rustfmt * add tor proxy info to config file * rustfmt * add utilities to output tor hidden service configuration files * output tor config as part of listener startup * rustfmt * fully automate config and startup of tor process * rustfmt * remove unnecessary process kill commands from listener * rustfmt * assume defaults for tor sending config if section doesn't exist in grin-wallet.toml * rustfmt * ignore tor dev test * update default paths output by config, compilation + confirmed working on windows * rustfmt * fix on osx/unix * add timeout to tor connector, remove unwrap in client * allow specifiying tor address without 'http://[].onion' on the command line * fix api test * rustfmt * update address derivation path as per spec * rustfmt * move tor init to separate function * rustfmt * re-ignore tor dev test * listen on tor by default if tor available * rustfmt * test fix * remove explicit send via tor flag, and assume tor if address fits * rustfmt
336 lines
11 KiB
YAML
336 lines
11 KiB
YAML
name: grin-wallet
|
|
about: Reference Grin Wallet
|
|
author: The Grin Team
|
|
|
|
args:
|
|
- floonet:
|
|
help: Run grin against the Floonet (as opposed to mainnet)
|
|
long: floonet
|
|
takes_value: false
|
|
- usernet:
|
|
help: Run grin as a local-only network. Doesn't block peer connections but will not connect to any peer or seed
|
|
long: usernet
|
|
takes_value: false
|
|
- pass:
|
|
help: Wallet passphrase used to encrypt wallet seed
|
|
short: p
|
|
long: pass
|
|
takes_value: true
|
|
- account:
|
|
help: Wallet account to use for this operation
|
|
short: a
|
|
long: account
|
|
takes_value: true
|
|
default_value: default
|
|
- data_dir:
|
|
help: Directory in which to store wallet files
|
|
short: dd
|
|
long: data_dir
|
|
takes_value: true
|
|
- external:
|
|
help: Listen on 0.0.0.0 interface to allow external connections (default is 127.0.0.1)
|
|
short: e
|
|
long: external
|
|
takes_value: false
|
|
- show_spent:
|
|
help: Show spent outputs on wallet output commands
|
|
short: s
|
|
long: show_spent
|
|
takes_value: false
|
|
- api_server_address:
|
|
help: Api address of running node on which to check inputs and post transactions
|
|
short: r
|
|
long: api_server_address
|
|
takes_value: true
|
|
subcommands:
|
|
- account:
|
|
about: List wallet accounts or create a new account
|
|
args:
|
|
- create:
|
|
help: Create a new wallet account with provided name
|
|
short: c
|
|
long: create
|
|
takes_value: true
|
|
- listen:
|
|
about: Runs the wallet in listening mode waiting for transactions
|
|
args:
|
|
- port:
|
|
help: Port on which to run the wallet listener
|
|
short: l
|
|
long: port
|
|
takes_value: true
|
|
- method:
|
|
help: Which method to use for communication
|
|
short: m
|
|
long: method
|
|
possible_values:
|
|
- http
|
|
- keybase
|
|
default_value: http
|
|
takes_value: true
|
|
- no_tor:
|
|
help: Don't start TOR listener when starting HTTP listener
|
|
short: n
|
|
long: no_tor
|
|
takes_value: false
|
|
- owner_api:
|
|
about: Runs the wallet's local web API
|
|
args:
|
|
- port:
|
|
help: Port on which to run the wallet owner listener
|
|
short: l
|
|
long: port
|
|
takes_value: true
|
|
- run_foreign:
|
|
help: Also run the Foreign API
|
|
long: run_foreign
|
|
takes_value: false
|
|
- send:
|
|
about: Builds a transaction to send coins and sends to the specified listener directly
|
|
args:
|
|
- amount:
|
|
help: Number of coins to send with optional fraction, e.g. 12.423
|
|
index: 1
|
|
- minimum_confirmations:
|
|
help: Minimum number of confirmations required for an output to be spendable
|
|
short: c
|
|
long: min_conf
|
|
default_value: "10"
|
|
takes_value: true
|
|
- selection_strategy:
|
|
help: Coin/Output selection strategy.
|
|
short: s
|
|
long: selection
|
|
possible_values:
|
|
- all
|
|
- smallest
|
|
default_value: all
|
|
takes_value: true
|
|
- estimate_selection_strategies:
|
|
help: Estimates all possible Coin/Output selection strategies.
|
|
short: e
|
|
long: estimate-selection
|
|
- change_outputs:
|
|
help: Number of change outputs to generate (mainly for testing)
|
|
short: o
|
|
long: change_outputs
|
|
default_value: "1"
|
|
takes_value: true
|
|
- method:
|
|
help: Method for sending this transaction
|
|
short: m
|
|
long: method
|
|
possible_values:
|
|
- http
|
|
- file
|
|
- self
|
|
- keybase
|
|
default_value: http
|
|
takes_value: true
|
|
- dest:
|
|
help: Send the transaction to the provided server (start with http://) or save as file.
|
|
short: d
|
|
long: dest
|
|
takes_value: true
|
|
- fluff:
|
|
help: Fluff the transaction (ignore Dandelion relay protocol)
|
|
short: f
|
|
long: fluff
|
|
- message:
|
|
help: Optional participant message to include
|
|
short: g
|
|
long: message
|
|
takes_value: true
|
|
- stored_tx:
|
|
help: If present, use the previously stored Unconfirmed transaction with given id
|
|
short: t
|
|
long: stored_tx
|
|
takes_value: true
|
|
- slate_version:
|
|
help: Target slate version to output/send to receiver
|
|
short: v
|
|
long: slate_version
|
|
takes_value: true
|
|
- receive:
|
|
about: Processes a transaction file to accept a transfer from a sender
|
|
args:
|
|
- message:
|
|
help: Optional participant message to include
|
|
short: g
|
|
long: message
|
|
takes_value: true
|
|
- input:
|
|
help: Partial transaction to process, expects the sender's transaction file.
|
|
short: i
|
|
long: input
|
|
takes_value: true
|
|
- finalize:
|
|
about: Processes a receiver's transaction file to finalize a transfer.
|
|
args:
|
|
- input:
|
|
help: Partial transaction to process, expects the receiver's transaction file.
|
|
short: i
|
|
long: input
|
|
takes_value: true
|
|
- fluff:
|
|
help: Fluff the transaction (ignore Dandelion relay protocol)
|
|
short: f
|
|
long: fluff
|
|
- invoice:
|
|
about: Initialize an invoice transaction.
|
|
args:
|
|
- amount:
|
|
help: Number of coins to invoice with optional fraction, e.g. 12.423
|
|
index: 1
|
|
- message:
|
|
help: Optional participant message to include
|
|
short: g
|
|
long: message
|
|
takes_value: true
|
|
- slate_version:
|
|
help: Target slate version to output/send to receiver
|
|
short: v
|
|
long: slate_version
|
|
takes_value: true
|
|
- dest:
|
|
help: Name of destination slate output file
|
|
short: d
|
|
long: dest
|
|
takes_value: true
|
|
- pay:
|
|
about: Spend coins to pay the provided invoice transaction
|
|
args:
|
|
- minimum_confirmations:
|
|
help: Minimum number of confirmations required for an output to be spendable
|
|
short: c
|
|
long: min_conf
|
|
default_value: "10"
|
|
takes_value: true
|
|
- selection_strategy:
|
|
help: Coin/Output selection strategy.
|
|
short: s
|
|
long: selection
|
|
possible_values:
|
|
- all
|
|
- smallest
|
|
default_value: all
|
|
takes_value: true
|
|
- estimate_selection_strategies:
|
|
help: Estimates all possible Coin/Output selection strategies.
|
|
short: e
|
|
long: estimate-selection
|
|
- method:
|
|
help: Method for sending the processed invoice back to the invoice creator
|
|
short: m
|
|
long: method
|
|
possible_values:
|
|
- file
|
|
- http
|
|
- self
|
|
default_value: file
|
|
takes_value: true
|
|
- dest:
|
|
help: Send the transaction to the provided server (start with http://) or save as file.
|
|
short: d
|
|
long: dest
|
|
takes_value: true
|
|
- message:
|
|
help: Optional participant message to include
|
|
short: g
|
|
long: message
|
|
takes_value: true
|
|
- input:
|
|
help: Partial transaction to process, expects the invoicer's transaction file.
|
|
short: i
|
|
long: input
|
|
takes_value: true
|
|
- outputs:
|
|
about: Raw wallet output info (list of outputs)
|
|
- txs:
|
|
about: Display transaction information
|
|
args:
|
|
- id:
|
|
help: If specified, display transaction with given Id and all associated Inputs/Outputs
|
|
short: i
|
|
long: id
|
|
takes_value: true
|
|
- txid:
|
|
help: If specified, display transaction with given TxID UUID and all associated Inputs/Outputs
|
|
short: t
|
|
long: txid
|
|
takes_value: true
|
|
- repost:
|
|
about: Reposts a stored, completed but unconfirmed transaction to the chain, or dumps it to a file
|
|
args:
|
|
- id:
|
|
help: Transaction ID containing the stored completed transaction
|
|
short: i
|
|
long: id
|
|
takes_value: true
|
|
- dumpfile:
|
|
help: File name to duMp the transaction to instead of posting
|
|
short: m
|
|
long: dumpfile
|
|
takes_value: true
|
|
- fluff:
|
|
help: Fluff the transaction (ignore Dandelion relay protocol)
|
|
short: f
|
|
long: fluff
|
|
- cancel:
|
|
about: Cancels a previously created transaction, freeing previously locked outputs for use again
|
|
args:
|
|
- id:
|
|
help: The ID of the transaction to cancel
|
|
short: i
|
|
long: id
|
|
takes_value: true
|
|
- txid:
|
|
help: The TxID UUID of the transaction to cancel
|
|
short: t
|
|
long: txid
|
|
takes_value: true
|
|
- info:
|
|
about: Basic wallet contents summary
|
|
args:
|
|
- minimum_confirmations:
|
|
help: Minimum number of confirmations required for an output to be spendable
|
|
short: c
|
|
long: min_conf
|
|
default_value: "10"
|
|
takes_value: true
|
|
- init:
|
|
about: Initialize a new wallet seed file and database
|
|
args:
|
|
- here:
|
|
help: Create wallet files in the current directory instead of the default ~/.grin directory
|
|
short: h
|
|
long: here
|
|
takes_value: false
|
|
- short_wordlist:
|
|
help: Generate a 12-word recovery phrase/seed instead of default 24
|
|
short: s
|
|
long: short_wordlist
|
|
takes_value: false
|
|
- recover:
|
|
help: Initialize new wallet using a recovery phrase
|
|
short: r
|
|
long: recover
|
|
takes_value: false
|
|
- recover:
|
|
about: Recover a wallet.seed file from a recovery phrase (default) or displays a recovery phrase for an existing seed file
|
|
args:
|
|
- display:
|
|
help: Display wallet recovery phrase
|
|
short: d
|
|
long: display
|
|
takes_value: false
|
|
- restore:
|
|
about: Restores a wallet contents from a seed file
|
|
- check:
|
|
about: Checks a wallet's outputs against a live node, repairing and restoring missing outputs if required
|
|
args:
|
|
- delete_unconfirmed:
|
|
help: Delete any unconfirmed outputsm unlock any locked outputs and delete associated transactions while doing the check.
|
|
short: d
|
|
long: delete_unconfirmed
|
|
takes_value: false
|