Skip to content

Commit

Permalink
minor edits on staking page
Browse files Browse the repository at this point in the history
  • Loading branch information
mlegner committed Oct 17, 2024
1 parent a0d20ce commit 6272bb4
Showing 1 changed file with 32 additions and 36 deletions.
68 changes: 32 additions & 36 deletions docs/usage/stake.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Shards are assigned to storage nodes every epoch, roughly proportional to the am
that was delegated to them. By staking with a storage node, users also earn rewards, as they
will receive a share of the storage fees.

Since moving shards from one storage node to another requires transferring a lot of data and
Since moving shards from one storage node to another requires transferring a lot of data, and
storage nodes potentially need to expand their storage capacity, the selection of the committee
for the next epoch is done ahead of time, in the middle of the previous epoch. This provides
sufficient time to storage node operators to provision additional resources, if needed.
sufficient time to storage-node operators to provision additional resources, if needed.

For stake to affect the shard distribution in epoch `e` and become "active", it must be staked
before the committee for this epoch has been selected, meaning that it has to be staked before
Expand All @@ -20,53 +20,49 @@ that epoch.
Unstaking has a similar delay: because unstaking funds only has an effect on the committee in
the next committee selection, the stake will remain active until that committee takes over.
This means that, to unstake at the start of epoch `e`, the user needs to "request withdrawal"
before the midpoint of epoch `e - 1`. Otherwise, i.e., if the user unstakes after this point,
before the midpoint of epoch `e - 1`. Otherwise, that is, if the user unstakes after this point,
the stake will remain active, and continue to accrue rewards, throughout epoch `e`, and the
balance and rewards will be available to withdraw at the start of epoch `e + 1`.

## How to stake
## How to stake with the Walrus Staking dApp

### Walrus Staking dApp
The Walrus Staking dApp allows users to stake (or unstake) to any of the storage nodes of the
system.

The Walrus Staking dApp allows users to stake (or unstake) to any of the storage nodes of the system
To use the dApp, visit <https://stake.walrus.site> and connect your wallet:

### How to use the dApp

- Visit [https://stake.walrus.site](https://stake.walrus.site)
- Connect your wallet
- Click the `Connect Wallet` button at the top right corner
- Select the wallet (if the wallet was connected before this and the next step wont be required)
- Approve the connection
- (Make sure the selected wallet network is Testnet)
- Click the `Connect Wallet` button at the top right corner.
- Select the wallet (if the wallet was connected before, this and the next step won't be required).
- Approve the connection.
- (Make sure the selected wallet network is Testnet).

### Exchange Testnet SUI to WAL

To be able to stake you will need to have WAL in your wallet.
You can exchange your Testnet SUI to WAL using the dApp
To be able to stake you will need to have Testnet WAL in your wallet.
You can exchange your Testnet SUI to WAL using the dApp as follows:

- Click the `Get WAL` button
- Select the amount of SUI
- And click `Exchange`
- (Follow the instructions in your wallet to approve the transaction)
- Click the `Get WAL` button.
- Select the amount of SUI. This will be exchanged to WAL at a 1:1 rate.
- And click `Exchange`.
- *Follow the instructions in your wallet to approve the transaction.*

### Stake

- Find the Storage node that you want to stake to
- Below the system stats there is the list of the `Current Committee` of storage nodes
- You can select one of the nodes in that list
- or if the storage node is not in the current committee
- find all the Storage nodes at the bottom of the page
- Once you selected the Storage node click the stake button
- Select the amount of WAL
- Click Stake
- (Follow the instructions in your wallet to approve the transaction)
- Find the storage node that you want to stake to.
- Below the system stats, there is the list of the "Current Committee" of storage nodes.
- You can select one of the nodes in that list or, if the storage node is not in the current
committee, you find all the storage nodes at the bottom of the page.
- Once you selected the storage node, click the stake button.
- Select the amount of WAL.
- Click Stake.
- *Follow the instructions in your wallet to approve the transaction.*

### Unstake

- Find the `Staked WAL` you want to unstake
- Below the `Current Committee` list you will find all your `Staked WAL`
- Also you can expand a Storage Node and find all your stakes with that node
- Depending on the state of the `Staked WAL` you will be able to unstake or Withdraw your funds
- Click the `Unstake` or `Withdraw` button
- Click continue to confirm your action
- (Follow the instructions in your wallet to approve the transaction)
- Find the `Staked WAL` you want to unstake.
- Below the "Current Committee" list you will find all your `Staked WAL`.
- Also you can expand a storage node and find all your stakes with that node.
- Depending on the state of the `Staked WAL` you will be able to unstake or Withdraw your funds.
- Click the `Unstake` or `Withdraw` button.
- Click continue to confirm your action.
- *Follow the instructions in your wallet to approve the transaction.*

0 comments on commit 6272bb4

Please sign in to comment.