Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update wallet.md #1008

Merged
merged 2 commits into from
Mar 21, 2022
Merged

Update wallet.md #1008

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c71da5
Update wallet.md
Clay-Mysten Mar 21, 2022
c8a09d9
Update wallet.md
Clay-Mysten Mar 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 18 additions & 10 deletions doc/src/build/wallet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,17 @@ interface, *Wallet CLI*.

## Setup

Follow the instructions to [install Sui binaries](install.md). Then
create a directory where your Sui configuration files will live - let
us name this directory `sui_instance` and let us assume that it lives
in another directory designated by the `$SUI_ROOT` environment
variable:

```shell
cd "$SUI_ROOT"
mkdir sui_instance
```
1. Follow the instructions to [install Sui binaries](install.md).
1. Create a directory where all of your Sui-related work will reside.
1. Create a $SUI_ROOT` environment variable pointing to that new directory:
```
export SUI_ROOT=/path/to/directory
```
1. Create a `sui_instance` subdirectory in `$SUI_ROOT`:
```shell
cd "$SUI_ROOT"
mkdir sui_instance
```

## Genesis

Expand Down Expand Up @@ -140,6 +141,13 @@ NOTE: For logs, set `RUST_LOG=debug` before invoking `sui start`.
The network config file path defaults to `./network.conf` if not
specified.

If you see errors when trying to start Sui network, particularly if
you did not start with a fresh `"$SUI_ROOT"/sui_instance` (e.g, did
[custom wallet configuration](#wallet-configuration) or
started/restarted Sui instance multiple time), you should remove
`"$SUI_ROOT"/sui_instance` directory containing configuration files
and recreate [Sui genesis state](#genesis).

## Using the wallet
The following commands are supported by the wallet:

Expand Down