grin/doc/wallet.md
Andrew Bellenie 7ef752f61c Breakout listen -i to separate method (#337)
* Rename wallet 'receive' to 'listen'
* Handle use of previous 'receive' command gracefully and clarify docs
* Move listen port from main wallet config to subcommand and break input out into own file method
* Clean up arg description
* Add placeholder to docs for file method in wallet
* Tidy wallet help text
* Rename pending wallet 'receive' to 'request'
* Restore receive method for file based transactions
2017-12-14 01:13:04 +01:00

63 lines
1.9 KiB
Markdown

# Grin - Basic Wallet
## Wallet Files
A Grin wallet maintains its state in the following files -
```
wallet.seed # *** passphrase protected seed file (keep this private) ***
wallet.dat # wallet outputs (both spent and unspent)
wallet.lock # lock file, prevents multiple processes writing to wallet.dat
```
By default Grin will look for these in the current working directory.
## Basic Wallet Commands
`grin wallet --help` will display usage info about the following.
### grin wallet init
Before using a wallet a new seed file `wallet.seed` needs to be generated via `grin wallet init` -
```
grin wallet init
Generating wallet seed file at: ./wallet.seed
```
### grin wallet info
Some (very) basic information about current wallet outputs can be displayed with `grin wallet info` -
```
grin wallet -p "password" info
Using wallet seed file at: ./wallet.seed
Outputs -
key_id, height, lock_height, status, spendable?, coinbase?, value
----------------------------------
96805837571719c692b6, 21, 24, Spent, false, true, 50000000000
...
```
### grin wallet listen
Starts a listening wallet server. This is needed for the `grin wallet send -d <destination wallet server>` command to work.
### grin wallet send
Builds a transaction to send someone some coins. Creates and outputs a transaction.
- add -d <destination server> to request a destination wallet from the given server address and port, and then push the transaction to the network
- add -s <strategy> to choose between selection strategies. If you're experimenting, or the destination is not reliable, it is currently recommendable to use the strategy `smallest`
### grin wallet receive
Replaced by `listen` (see above). The `receive` command might later be recycled to actively accept one or several specific transactions.
### grin wallet request
(tbd)
### grin wallet burn
*TESTING ONLY*: Burns the provided amount to a known key. Similar to send but burns an output to allow single-party
transactions.