Skip to content

Commit

Permalink
clarify WAL/FROST relationship
Browse files Browse the repository at this point in the history
  • Loading branch information
mlegner committed Oct 17, 2024
1 parent 8cdac4a commit 84b3b5b
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 19 deletions.
11 changes: 6 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,12 @@ page](./walrus-sites/tutorial-migration.md).
long, extend its lifetime or optionally delete it.

- **Epochs, tokenomics, and delegated proof of stake** Walrus is operated by a committee of storage
nodes that evolve between epochs. A native token, WAL (and its subdivision FROST), is used
to delegate stake to storage nodes, and those with high stake become part of the epoch committee.
The WAL token is also used for payments for storage. At the end of each epoch, rewards for
selecting storage nodes, storing and serving blobs are distributed to storage nodes and whose that
stake with them. All these processes are mediated by smart contracts on the Sui platform.
nodes that evolve between epochs. A native token, WAL (and its subdivision FROST, where 1 WAL is
equal to 1 billion FROST), is used to delegate stake to storage nodes, and those with high stake
become part of the epoch committee. The WAL token is also used for payments for storage. At the
end of each epoch, rewards for selecting storage nodes, storing and serving blobs are distributed
to storage nodes and whose that stake with them. All these processes are mediated by smart
contracts on the Sui platform.

- **Flexible access:** Users can interact with Walrus through a command-line interface (CLI),
software development kits (SDKs), and web2 HTTP technologies. Walrus is designed to work well
Expand Down
5 changes: 4 additions & 1 deletion docs/blog/04_testnet_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,15 @@ Payments for blob storage and extending blob expiry are denominated in Testnet W
Walrus token issued on the Sui Testnet. Testnet WAL has no value, and an unlimited supply - so no
need to covet or hoard it - its just for testing purposes and only issued on Sui Testnet.

WAL also has a smaller unit called FROST, similar to MIST for SUI. 1 WAL is equal to 1 billion
(1000000000) FROST.

To make Testnet WAL available to all who want to experiment with the Walrus Testnet we provide a
utility and smart contract to convert Testnet SUI (which also has no value) into Testnet WAL using
a one-to-one exchange rate. This is chosen arbitrarily, and generally one should not read too much
into the actual WAL denominated costs of storage on Testnet. They have been chosen arbitrarily.

- Find out how to [request Test WAL tokens](../usage/setup.md#testnet-wal-faucet) through the CLI.
Find out how to [request Test WAL tokens](../usage/setup.md#testnet-wal-faucet) through the CLI.

## Decentralization through staking & unstaking

Expand Down
28 changes: 15 additions & 13 deletions docs/usage/client-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,36 +15,38 @@ their meaning.
## Walrus system information

Information about the Walrus system is available through the `walrus info` command. For example,
<!-- (TODO - update with final) -->
`walrus info` gives an overview of the number of storage nodes and shards in the system, the maximum
blob size, and the current cost in (Testnet) WAL for storing blobs:

```console
$ walrus info

Walrus system information
Current epoch: 54
Current epoch: 2

Storage nodes
Number of nodes: 10
Number of nodes: 25
Number of shards: 1000

Blob size
Maximum blob size: 13.3 GiB (14,273,391,930 B)
Storage unit: 1.00 KiB
Storage unit: 1.00 MiB

Approximate storage prices per epoch
Price per encoded storage unit: 5 FROST
Price to store metadata: 0.0003 WAL
Marginal price per additional 1 MiB (w/o metadata): 24,195 FROST
Price per encoded storage unit: 100 FROST
Price to store metadata: 6,200 FROST
Marginal price per additional 1 MiB (w/o metadata): 500 FROST

Total price for example blob sizes
16.0 MiB unencoded (135 MiB encoded): 0.0007 WAL per epoch
512 MiB unencoded (2.33 GiB encoded): 0.012 WAL per epoch
13.3 GiB unencoded (60.5 GiB encoded): 0.317 WAL per epoch

16.0 MiB unencoded (135 MiB encoded): 13,500 FROST per epoch
512 MiB unencoded (2.33 GiB encoded): 0.0002 WAL per epoch
13.3 GiB unencoded (60.5 GiB encoded): 0.0062 WAL per epoch
```

gives an overview of the number of storage nodes and shards in the system, the maximum blob size,
and the current cost in (Testnet) WAL for storing blobs. (Note: 1 WAL = 1 000 000 000 FROST)
```admonish tip title="FROST and WAL"
FROST is the smaller unit of WAL, similar to MIST for SUI. The conversion is also the same as for
SUI: `1 WAL = 1 000 000 000 FROST`.
```

Additional information such as encoding parameters and sizes, BFT system information, and
information on the storage nodes and their shard distribution can be viewed with the `--dev`
Expand Down

0 comments on commit 84b3b5b

Please sign in to comment.