Skip to content

Commit

Permalink
Wallet topic updates (MystenLabs#8791)
Browse files Browse the repository at this point in the history 
## Description 

Content additions to reflect product changes

## Test Plan 

Manually

---
If your changes are not user-facing and not a breaking change, you can
skip the following section. Otherwise, please indicate what changed, and
then add to the Release Notes section as highlighted during the release
process.

### Type of Change (Check all that apply)

- [ ] user-visible impact
- [ ] breaking change for a client SDKs
- [ ] breaking change for FNs (FN binary must upgrade)
- [ ] breaking change for validators or node operators (must upgrade
binaries)
- [ ] breaking change for on-chain data layout
- [ ] necessitate either a data wipe or data migration

### Release notes
  • Loading branch information
@randall-Mysten
randall-Mysten authored Mar 2, 2023
1 parent b59c6ed commit 5a84124
Showing 1 changed file with 69 additions and 26 deletions.
95 changes: 69 additions & 26 deletions doc/src/explore/wallet-browser.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,31 @@
title: Sui Wallet
---

This topic describes how to install and use the [Sui Wallet browser extension](https://chrome.google.com/webstore/detail/sui-wallet/opcgpfmipidbgpenhmajoajpbobppdil). You can use the Sui Wallet to create an address, complete transactions, mint NFTs, view or manage assets on the Sui network, and connect with blockchain dApps on Web3.
This topic describes how to install and use the [Sui Wallet browser extension](https://chrome.google.com/webstore/detail/sui-wallet/opcgpfmipidbgpenhmajoajpbobppdil).

The early versions of Sui Wallet let you experiment with the Sui network for testing. The Sui network is still in development, and the tokens have no real value. Accounts reset with each deployment of a new version of the network, typically weekly. View the [devnet-updates](https://discord.com/channels/916379725201563759/1004638487078772736) channel in Discord for updates about the network.
The early versions of Sui Wallet let you experiment with the Sui network for testing. The Sui network is still in development, and the tokens have no real value. Accounts reset with each deployment of a new version of the network. View the [devnet-updates](https://discord.com/channels/916379725201563759/1004638487078772736) channel in Discord for updates about the network.

To test more advanced features not available in Sui Wallet, see [Sui CLI client](../build/cli-client.md).

## Sui Wallet features

You can use Sui Wallet to:

* Mint NFTs
* Stake and earn SUI
* Transfer coins and NFTs to another address
* View your coins, tokens, and NFTs
* View recent transactions
* Auto split/merge coins to the exact transfer amount
* Easily access transaction history in the [Sui Explorer](https://explorer.sui.io/)
* Create Sui accounts (addresses)
* Import private keys from other wallets (must be a 32 or 64 byte address)
* Mint NFTs
* Stake and earn SUI
* Transfer coins and NFTs to another address
* View your coins, tokens, and NFTs
* View recent transactions
* Auto split/merge coins to the exact transfer amount
* Easily access transaction history in the [Sui Explorer](https://explorer.sui.io/)

Note that in the current release, Sui Wallet includes buttons to **Buy**, **Swap**, and **Stake & Earn SUI**. These are placeholders for functionality included in future versions of Sui Wallet.
In the current release, Sui Wallet includes **Buy** and **Swap** buttons. These are placeholders for functionality included in future versions of Sui Wallet.

## Install the Sui Wallet browser extension

To use Sui Wallet you must install a Chrome browser extension. You can use the extension with any browser that supports Chrome extensions from the Chrome Web Store.
To use Sui Wallet, you must install a Chrome browser extension. You can use the extension with any browser that supports Chrome extensions from the Chrome Web Store.

1. Using a chromium-based browser, open the [Sui Wallet](https://chrome.google.com/webstore/detail/sui-wallet/opcgpfmipidbgpenhmajoajpbobppdil) page on the Chrome Web Store.
1. Click **Add to Chrome**.
Expand Down Expand Up @@ -54,27 +56,67 @@ You can use your Sui Wallet on multiple devices and browsers. After you create a

1. Open the Sui Wallet extension in your browser and then click **Get Started**.
1. Click **Import an Existing Wallet**.
1. Enter your 12-word recovery phrase, and then click **Continue**.
1. Under **Create Password**, enter a password for your wallet.
1. Enter the 12-word recovery phrase for the account to import, and then click **Continue**.
1. Under **Create Password**, enter a password for this account address.
This is not a global password for Sui Wallet. It applies only to this installation in this browser.
1. Under **Confirm Password**, enter the same password to confirm it.
1. Click **Import**.
1. Click **Open Sui Wallet**.

Sui Wallet prompts you to enter your password when you open it after the first use.

## Create another account address

You can create and use multiple accounts in Sui wallet.

**To add another account address**
1. Click the menu (the three bars at the top-right corner of the wallet interface), then click **Accounts**.
1. Click **Create New Account**.

The wallet displays the new account. To use the new account, select it from the drop-down list on the **Coins** tab, or select the address to use when you connect the wallet to a site or app.

## Import an account to your wallet

You can import an account from a previous installation of Sui Wallet or from another wallet provider. To import an account, the account address must be either 32 or 64 bytes.

**To import an account to Sui Wallet**
1. Click the menu (the three bars at the top-right corner of the wallet interface), then click **Accounts**.
1. Click **Import Private Key**.
1. Enter or paste the private key for the account to import, then click **Continue**.
1. Enter the wallet password and then click **Import**.

The wallet displays the **Accounts** page with the imported account listed.

## Export the private key for an account

You can export the private key for an account to import to another wallet. You should be very careful with the private key. Anyone can use the private key to import the associated account. If someone else knows your private key, they can take over the account and cause you to lose access to it. Never share a private key.

**To export the private key for an account**
1. Click the menu (the three bars at the top-right corner of the wallet interface), then click **Accounts**.
1. Click the address of the account to export the key from.
1. Click **Export Private Key**.
1. Enter the wallet password, then click **Continue**.
1. Click **Copy** to copy the private key to your clipboard.

You can then paste the private to import it to a different wallet.

To view the private key, make sure that no one can see your screen, and then click the crossed-out eye icon in the bottom right corner.

## Add SUI tokens to your Sui Wallet

When you first open the wallet, you have no coins in it. You can add test SUI coins to your wallet using the faucet in Discord.

**To get SUI test coins using the wallet**
After you install the wallet extension, click **Request Devnet SUI tokens**. In some cases, you can click it three times to get three tokens. Usually, you can click it once or twice and then it disappears. If this happens, you can find the button instead on the wallet settings page by clicking the three bars in the top-right corner of the wallet interface. The button is displayed there only after you successfully use it the first time (up to three requests). Note that you can request SUI coins only three times every 60 minutes. After you click the button, SUI test tokens appear in your wallet on the **Coins** tab.

**To get SUI test coins through Discord**
1. Click **Coins**.
1. Click the small clipboard icon next to your address to copy it.
1. Click **Coins**.
1. Click the small clipboard icon next to your address to copy it.
It's near the top of the wallet and starts with 0x.
1. Go to the Discord faucet channel for the network you use:
1. Go to the Discord faucet channel for the network you use:
* [devnet-faucet](https://discord.com/channels/916379725201563759/971488439931392130) channel in Discord.
* [testnet-faucet](https://discord.com/channels/916379725201563759/1037811694564560966).
1. Use the `!faucet` command with your wallet address to request tokens:
* [testnet-faucet](https://discord.com/channels/916379725201563759/1037811694564560966). This channel may not be available at all times.
1. Use the `!faucet` command with your wallet address to request tokens:
`!faucet 0x6c04ed5110554acf59ff1b535129548dd9a0c741`
Replace the address in the command with your wallet address.

Expand Down Expand Up @@ -103,8 +145,8 @@ You can lock your wallet to prevent unauthorized access. You must enter your pas
You can also set a timer to automatically lock your wallet after a period of idle time, up to 30 minutes.

1. Click the menu (the three bars) at the top-right corner of the Sui Wallet interface.
1. Click **Account**.
1. In the field under **AUTO-LOCK TIMER**, enter the number of minutes to wait, up to 30, before the wallet locks, and then click **Save**.
1. Click **Auto-lock**.
1. Enter the number of minutes to wait, up to 30, before the wallet locks, and then click **Save**.

The wallet remains unlocked for the number of minutes you specify, even if you switch tabs in your browser.

Expand All @@ -127,18 +169,19 @@ You can send coins from your wallet to another address.

1. Open the Sui Wallet extension in your browser.
1. Click **Coins** and then click **Send**.
1. In the **Amount** field, enter the number of SUI to send, and then click **Continue**.
1. In the **Amount** field, enter the amount of SUI to send, and then click **Continue**.
1. Enter the recipient's address, then click **Send Coins Now**.

## Stake and earn SUI (Testnet only)
## Stake and earn SUI

While the Testnet network is available, you can try out staking to earn SUI. When you stake SUI, you delegate your SUI tokens to a validator to stake. The validator then pays you rewards for delegating your SUI to stake. Note that SUI tokens have no value. The rewards are for testing purposes and have no real value.
You can try out staking SUI to earn rewards. These rewards are not real and are for testing purposes only. When you stake SUI, you delegate your SUI tokens to a validator to stake. The validator then pays you rewards for delegating your SUI for them to stake. Note that SUI tokens have no value on test networks.

**To stake SUI and earn rewards**
1. Open your wallet and click **Coins**.
1. Click **Stake & Earn SUI**.
1. Select a validator to stake with.
1. Choose an amount of SUI to stake.
Be sure to enter an amount that leaves enough SUI in your wallet to cover gas fees.
Enter an amount that leaves sufficient SUI in your wallet to cover gas fees.
1. Click **Stake Now**.

Your stake starts earning rewards at the start of the next epoch.
Expand All @@ -163,7 +206,7 @@ Sui Explorer opens with the details for your wallet address displayed.

You can mint an example Sui NFT directly from Sui Wallet.

Click **Apps**, then click **Mint an NFT**. In the current version you can mint only example NFTs.
Click **Apps**, then click **Mint an NFT**. In the current version, you can mint only example NFTs.

## Create a new NFT

Expand Down Expand Up @@ -213,4 +256,4 @@ You can easily disconnect your wallet from a connected app.
1. Click **Apps** and then click **Active Connections**.
1. Click the app to disconnect from your wallet, then click **Disconnect**.

Your wallet immediately disconnects from the app and returns to the **Apps** tab.
Your wallet immediately disconnects from the app and displays the **Apps** tab.

0 comments on commit 5a84124

Please sign in to comment.