Skip to content

Commit

Permalink
docs: minor fixes on the Testnet blog post (#148)
Browse files Browse the repository at this point in the history
  • Loading branch information
mlegner authored Oct 17, 2024
1 parent 95a8abb commit 8b4df5e
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 29 deletions.
51 changes: 26 additions & 25 deletions docs/blog/04_testnet_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,20 @@ epochs, and blob deletion.
## Blob deletion

The most important user-facing new feature is optional blob deletion. The uploader of a blob can
optionally indicate a blob is "deletable". This information is stored in the Sui blob meta-data
optionally indicate a blob is "deletable". This information is stored in the Sui blob metadata
object, and is also included in the event denoting when the blob is certified. Subsequently, the
owner of the Sui blob meta-data object can "delete" it. As a result storage for the remaining
owner of the Sui blob metadata object can "delete" it. As a result storage for the remaining
period is reclaimed and can be used by subsequent blob storage operations.

Blob deletion allows more fine grained storage cost management: smart contracts that wrap blob
meta-data objects can define logic that stores blobs and delete them to minimize costs, and reclaim
Blob deletion allows more fine-grained storage cost management: smart contracts that wrap blob
metadata objects can define logic that stores blobs and delete them to minimize costs, and reclaim
storage space before Walrus epochs end.

However, blob deletion is not an effective privacy mechanism in itself: copies of the blob may exist
outside Walrus storage nodes on caches and end-user stores
or devices. Furthermore, if the identical blob is stored by multiple Walrus users, the blob will
still be available on Walrus until no copy exists. Thus deleting your own copy of a blob cannot
guarantee that it is deleted from Walrus as a whole.
outside Walrus storage nodes on caches and end-user stores or devices. Furthermore, if the identical
blob is stored by multiple Walrus users, the blob will still be available on Walrus until no copy
exists. Thus deleting your own copy of a blob cannot guarantee that it is deleted from Walrus as a
whole.

- Find out how to
[upload and delete deletable blobs](../usage/client-cli.md#reclaiming-space-via-deletable-blobs)
Expand All @@ -33,13 +33,14 @@ guarantee that it is deleted from Walrus as a whole.

## Epochs

Walrus Testnet enables multiple epochs. Initially an epoch is a single day to ensure the logic of
epoch change is thoroughly tested. At Mainnet epochs will likely be multiple weeks long.
Walrus Testnet enables multiple epochs. Initially, the epoch duration is set to a single day to
ensure the logic of epoch change is thoroughly tested. At Mainnet, epochs will likely be multiple
weeks long.

Now stored blob expiry epoch is meaningful, and blobs will become unavailable after their expiry
epoch. The store command may be used to extend the expiry epoch of a blob that is still available.
This operation is efficient and only affects payments and meta-data, and does not re-upload blob
contents.
The progress of epochs makes the expiry epoch of blobs meaningful, and blobs will become unavailable
after their expiry epoch. The store command may be used to extend the expiry epoch of a blob that is
still available. This operation is efficient and only affects payments and metadata, and does not
re-upload blob contents.

- Find out the [current epoch](../usage/client-cli.md#walrus-system-information) through the CLI.
- Find out how to store a blob for
Expand All @@ -48,8 +49,8 @@ contents.
## The WAL token and the Testnet WAL faucet

Payments for blob storage and extending blob expiry are denominated in Testnet WAL, a
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.
Walrus token issued on the Sui Testnet. Testnet WAL has no value, and an unlimited supply; so no
need to covet or hoard it, it's 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.
Expand All @@ -59,7 +60,7 @@ utility and smart contract to convert Testnet SUI (which also has no value) into
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 Testnet WAL tokens](../usage/setup.md#testnet-wal-faucet) through the CLI.

## Decentralization through staking & unstaking

Expand All @@ -68,11 +69,11 @@ re-staked with other operators or used to purchase storage.

Each epoch storage nodes are selected and allocated storage shards according to their delegated
stake. At the end of each epoch payments for storing blobs for the epoch are distributed to storage
nodes and those that delegate stake to them. Furthermore, important network parameters - such as
total available storage and storage price - are set by the selected storage operators each epoch
nodes and those that delegate stake to them. Furthermore, important network parameters (such as
total available storage and storage price) are set by the selected storage operators each epoch
according to their stake weight.

A staking web dApps is provided to experiment with this functionality. Community members have also
A staking web dApp is provided to experiment with this functionality. Community members have also
created explorers that can be used to view storage nodes when considering who to stake with. Staking
ensures that the ultimate governance of Walrus, directly in terms of storage nodes, and indirectly
in terms of parameters and software they chose, rests with WAL Token holders.
Expand All @@ -82,14 +83,14 @@ storage node committee changes: better shard allocation mechanisms upon changes
stake; efficient ways to sync state between storage nodes; as well as better ways for storage nodes
to follow Sui event streams.

- Explore the [Walrus staking dApp](https://stake.walrus.site)
- Look at recent activity on the [Walrus Explorer](https://walruscan.com/testnet/home)
- Explore the [Walrus staking dApp](https://stake.walrus.site).
- Look at recent activity on the [Walrus Explorer](https://walruscan.com/testnet/home).

## New Move contracts & documentation

As part of the Testnet release of Walrus the documentation and Move Smart contracts have been
updated, and can be found at the [Walrus-docs repository](https://github.com/MystenLabs/walrus-docs)
and as a [Walrus Docs Site](https://docs.walrus.site/).
As part of the Testnet release of Walrus, the documentation and Move Smart contracts have been
updated, and can be found in the [`walrus-docs`
repository](https://github.com/MystenLabs/walrus-docs).

## New Walrus Sites features

Expand Down
2 changes: 1 addition & 1 deletion docs/dev-guide/dev-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ available on storage nodes to recover it within the specified epochs.

## Delete

Stored blobs can be optionally set as deletable by the user that creates them. This meta-data is
Stored blobs can be optionally set as deletable by the user that creates them. This metadata is
stored in the Sui blob object, and whether a blob is deletable or not is included in certified blob
events. A deletable blob may be deleted by the owner of the blob object, to reclaim and re-use
the storage resource associated with it.
Expand Down
2 changes: 1 addition & 1 deletion docs/dev-guide/sui-struct.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ certified, a `BlobCertified` is emitted containing information about the blob ID
after which the blob will be deleted. Before that epoch the blob is guaranteed to be available.

```move
/// Signals that a blob with meta-data has been registered.
/// Signals that a blob with metadata has been registered.
public struct BlobRegistered has copy, drop {
epoch: u32,
blob_id: u256,
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ adapt most of those.
```

You can download the latest build from our Google Cloud Storage (GCS) bucket (correctly setting the
`$SYSTEM` variable)`:
`$SYSTEM` variable):

```sh
SYSTEM= # set this to your system: ubuntu-x86_64, ubuntu-x86_64-generic, macos-x86_64, macos-arm64, windows-x86_64.exe
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/web-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ PUBLISHER=https://publisher.walrus-testnet.walrus.space

```admonish tip title="API specification"
Walrus aggregators and publishers expose their API specifications at the path `/v1/api`. You can
view this in the browser` e.g., at <https://aggregator.walrus-testnet.walrus.space/v1/api>
view this in the browser, e.g., at <https://aggregator.walrus-testnet.walrus.space/v1/api>
```

### Store
Expand Down

0 comments on commit 8b4df5e

Please sign in to comment.