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 mysten-sui-wallet.md #55

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update mysten-sui-wallet.md #55

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
260 changes: 7 additions & 253 deletions mysten-sui-wallet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,254 +1,8 @@

# Sui Wallet by Mysten Labs

Use the [Sui Wallet browser extension](https://chrome.google.com/webstore/detail/sui-wallet/opcgpfmipidbgpenhmajoajpbobppdil) to manage your digital assets on the Sui network. Sui Wallet displays the coins and NFTs in your account, and lets you easily acquire new ones and transfer ones you own. You can also use Sui Wallet to stake your SUI and earn rewards. Connect Sui Wallet to dApps running on Sui to perform transactions, then view the transaction details on Sui Explorer.

## Sui Wallet features

Sui Wallet makes it easy for you to:

- Create Sui accounts (addresses)
- Import private keys from other wallets (must be a 32 or 64 byte address)
- Stake and earn SUI
- Transfer coins and NFTs to another address
- View your coins, tokens, and NFTs
- Auto split/merge coins to the exact transfer amount
- View transaction history and details in Sui Explorer

To test more advanced features not available in Sui Wallet, see [Sui Client CLI](https://docs.sui.io/build/cli-client).

## Install Sui Wallet

To use Sui Wallet, just install the 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**.
1. Acknowledge the message about permissions for the extension, and then click **Add Extension**.

## Create a new wallet

If you don't yet have a Sui Wallet, create a new one. To import an existing wallet, see [Import an existing Sui Wallet](#import-an-existing-sui-wallet).

1. Open the Sui Wallet extension in your browser and then click **Get Started**.
1. Click **Create a New Wallet**.
1. Under **Create Password**, enter a password for your wallet.
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 the checkbox to accept the Terms of Service.
1. Click **Create Wallet**.
1. Click the crossed-out eye icon to display the recovery phrase.
1. Copy the recovery phrase and store it in a safe location, then click the checkbox for **I saved my recovery phrase**.
1. Click **Open Sui Wallet**.

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

If you lose access to your wallet, you can recover it only with the recovery phrase. If you lose the recovery phrase, you lose access to your wallet and any coins or NFTs stored in it.

## Import an existing Sui Wallet

You can use your Sui Wallet on multiple devices and browsers. After you create a Sui Wallet, use the 12-word recovery phrase to import your wallet to a new browser or device.

1. Open the Sui Wallet extension in your browser and then click **Get Started**.
1. Click **Import an Existing Wallet**.
1. Enter the 12-word recovery phrase for the account to import, and then click **Continue**.
You can position the cursor in the field for word 1 and then paste all 12 words at the same time.
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 address

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 key 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.

## View Sui Wallet details

To view details about your Sui Wallet, including the Account ID, current network, and installed version, click the menu (the three bars) at the top-right corner of the Sui Wallet interface.

## Reset your Sui Wallet password

If you forget the password for your Sui Wallet you can reset it using your 12-word recovery phrase.

1. Click **Forgot password?** on the **Welcome Back** page.
1. Enter your 12-word recovery phrase, and then click **Continue**.
1. Enter a password, then confirm the password.
1. Click **Reset**.

## Lock your Sui Wallet

You can lock your wallet to prevent unauthorized access. You must enter your password to unlock it.

1. Click the menu (the three bars) at the top-right corner of the Sui Wallet interface.
1. Click **Lock Wallet**.

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 **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.

## View your wallet balance

To view your wallet balance, click **Coins**. The wallet shows your SUI balance and lists the other coins in your wallet, if any.

## Send coins

You can send coins from your wallet to another address.

1. Click **Coins** and then click **Send**.
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

You can stake SUI to earn rewards for helping secure the network. When you stake SUI, you delegate your SUI tokens to a validator to stake. The validator then pays you rewards for staking your SUI with them.

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, then click **Select Amount**.
1. Enter the amount of SUI to stake.
Enter an amount that leaves sufficient SUI in your wallet to cover gas fees.
1. Click **Stake Now**.
1. Review the transaction confirmation, then click the check mark to close it.
1. Click the X to close the **Stake & Earn SUI** page.

The wallet displays when you start earning rewards for your stake in the next epoch.

## View current stake

To view details about your current stakes, click **Currently Staked** on the **Coins** tab of the Wallet. Details include: the amount you staked, the validator you chose, amount earned so far, and the validator commission.

## Withdraw your staked SUI

You can withdraw your staked SUI at any time. You might want to stake with a different validator with better rewards, or use your SUI for something else. When you request a withdraw, your stake ends immediately. Validators distribute rewards at the end of each epoch.

You can't withdraw a stake request that hasn't started earning rewards yet. You can request a withdraw after the next epoch starts and the stake becomes active.

1. Click the **Coins** tab, then click **Currently Staked**.
1. Click the validator to withdraw your stake from.
1. Click **Unstake SUI**.
1. Click **Unstake Now**.
1. Click the check mark to close the **Transaction** page, then click X to close the **Staking** page and return to the **Coins** tab.

## View recent transaction details

The wallet displays the recent transactions to and from your wallet on the **Activity** tab. Click on any transaction to view transaction details. To view additional details, click **VIEW ON EXPLORER**.

## View all transactions in Sui Explorer

You can view all transactions for your address in Sui Explorer.

To view all of the transactions and objects associated with your account address, click **Apps** and then click **View your account on Sui Explorer**.

Sui Explorer opens and displays details for your wallet address.

## View your NFTs

Click the **NFTs** tab to view all of the NFTS that you mint, purchase, or receive in your wallet. This includes any NFTs that you obtain from connected apps. Click on an NFT to view additional details about it, view a larger NFT image, send the NFT to another address, or view additional details in Sui Explorer.

## Send an NFT

You can use Sui Wallet to send an NFT to another address.
1. Click **NFTs**.
1. Click on the NFT to send, and then click **Send NFT**.
1. Enter the recipient address then click **Send NFT Now**.
1. Click **Done** to return to the wallet.

## Wallet Playground

You can view and try out some apps that already support Sui Wallet from the **Playground** on the **Apps** tab. The apps displayed let you connect your Sui Wallet and use SUI tokens to interact with them, perform transactions, and obtain NFTs that go directly to your connected wallet.

Click on an app to open the site for the app. Follow the guidance on the site to connect your wallet. After you connect your wallet to an app you can view the app on the **Active Connections** page.

## View connected apps

To view the apps with active connections to your wallet, click **Apps**. By default, the **Playground** view displays. Click **Active Connections** to view the connected apps.

To open the site associated with the app, click on the app and then click **View**.

## Disconnect from an app

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 displays the **Apps** tab.

## Use Sui Wallet for testing

You can use Sui Wallet with other Sui networks to test new or updated apps on Sui. In addition to **Sui Mainnet**, Sui Wallet supports connecting to **Sui Testnet**, **Sui Devnet**, a **Local** network, or a **Custom RPC URL** on a network you create.

To learn how to create a local network, see [Create a Local Sui Network](https://docs.sui.io/build/sui-local-network).

**Change the active network connection**
1. Click the menu (the three bars) at the top-right corner of the Sui Wallet interface.
1. Click **Network**.
1. Click the network to use.
A checkmark displays next to the active network.

## Get SUI tokens for testing

When you first open the wallet, you have no coins in it. You can add test SUI coins to your wallet to use for testing. These tokens have no value and you can use them only on the Sui network you obtain them for, such as Devnet or Testnet.

**To get SUI test coins using the wallet**
After you install the wallet extension, select one of the test networks, either Devnet or Testnet. If you have no coins in the wallet, a button displays to request tokens.Click **Request Devnet SUI tokens** or **Request Testnet SUI tokens**, depending on the network you chose. After you have coins in your wallet, the button moves to the **Settings** page. To access the **Settings** page, click the three bars in the top-right corner of the wallet interface.

**Note:** you can request SUI coins only once 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.
It's near the top of the wallet and starts with 0x.
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). 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.

The channel bot displays a message confirming your request.
curl --location --request POST 'https://faucet.devnet.sui.io/v1/gas' \
--header 'Content-Type: application/json' \
--data-raw '{
"FixedAmountRequest": {10
"recipient": "<0x1eba97d636f7eed73ba12f14d83f2f15e5a508964824f258415b3d906ad273c1>"
}
}'