Wallet docs describing how to view account #570
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
patrickkuo
commented
Feb 25, 2022
patrickkuo
commented
- added new sections for View created account
- added new sections for Add account to the wallet
Clay-Mysten
reviewed
Feb 25, 2022
doc/wallet.md
Outdated
| ### View created accounts | ||
| The genesis process creates a configuration file `wallet.conf` for the sui wallet, | ||
| the config file contains information of the accounts and the sui network, | ||
| sui wallet uses the network information to communicate with the siu network authorities |
There was a problem hiding this comment.
Replace "siu" with "Sui"
Clay-Mysten
reviewed
Feb 25, 2022
doc/wallet.md
Outdated
| can be used subsequently to start the network. A `wallet.conf` will | ||
| also be generated to be used by the `wallet` binary to manage the | ||
| can be used subsequently to start the network. A `wallet.conf` is | ||
| also created to be used by the sui wallet to manage the |
There was a problem hiding this comment.
Capitalize Sui throughout the plain text for consistency with other docs.
Clay-Mysten
reviewed
Feb 25, 2022
doc/wallet.md
Outdated
| The genesis process creates a configuration file `wallet.conf` for the sui wallet, | ||
| the config file contains information of the accounts and the sui network, | ||
| sui wallet uses the network information to communicate with the siu network authorities | ||
| and create transactions using the key pairs reside in the config file. |
Clay-Mysten
reviewed
Feb 25, 2022
doc/wallet.md
Outdated
|
|
||
| `send_timeout`, `recv_timeout` and `buffer_size` are the network parameters. | ||
| `db_folder_path` is the path to the account's client state database, which will be storing | ||
| all the transaction data, certificates and object data belongs to the account. |
Clay-Mysten
reviewed
Feb 25, 2022
doc/wallet.md
Outdated
| all the transaction data, certificates and object data belongs to the account. | ||
|
|
||
| #### Key management | ||
| As you might have noticed, the key pairs are stored as plain text in `wellet.conf`, |
Clay-Mysten
reviewed
Feb 25, 2022
| @@ -77,15 +126,16 @@ The wallet config file path is defaulted to `./wallet.conf` if not specified. | |||
|
|
|||
| The following commands are supported by the interactive wallet: | |||
There was a problem hiding this comment.
It would be good to specify when any of these commands take arguments, such as object - does it require an object value?
There was a problem hiding this comment.
Will add the list of arg for each command in next PR
Clay-Mysten
reviewed
Feb 25, 2022
doc/wallet.md
Outdated
| ``` | ||
|
|
||
| ## Adding accounts to the wallet | ||
| Sui's genesis process will create 5 accounts by default, if that's not enough, there are 2 ways to add accounts to the Sui wallet if needed. |
There was a problem hiding this comment.
five accounts... two ways
Clay-Mysten
reviewed
Feb 25, 2022
doc/wallet.md
Outdated
| @@ -174,7 +248,6 @@ the GAS module using the following Sui Wallet command: | |||
| --pure-args x\"5986f0651a5329b90d1d76acd992021377684509909b23a9bbf79c4416afd9cf\" \ | |||
| --gas 1FD8DA0C56694229761E9A3DCE50C49AF2EA5DB1 \ | |||
| --gas-budget 1000 \ | |||
| --sender 0523fc67f30e3922147877ca56ce36a41ba122623fee86043f5c9a05d2b3bde4 | |||
| ``` | |||
|
|
|||
| This a pretty complicated command so let's explain all its parameters | |||
Clay-Mysten
approved these changes
Feb 25, 2022
awelc
approved these changes
Feb 25, 2022
| "address": "a4c0a493ce9879ea06bac93461810cf947823bb3", | ||
| "key_pair": "MTpXG/yJq0OLOknghzYRCS6D/Rz+97gpR7hZhUCUNT5pMCy49v7hZkCSHm38e+cp+sdxLgTrSAuCbDxqkF1MTg==" | ||
| }, | ||
| ... |
There was a problem hiding this comment.
It looks like a placeholder for omitted values. If it's indeed the case, then it may make sense to mention this explicitly to remove temptation to copy test this configuration verbatim.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.