From 950838ee2a90157fe13e54444e27eacb50655e19 Mon Sep 17 00:00:00 2001 From: Markus Legner Date: Thu, 17 Oct 2024 14:59:05 +0200 Subject: [PATCH] docs: minor fixes on the Testnet blog post --- docs/blog/04_testnet_update.md | 51 ++++++++++++++++---------------- docs/dev-guide/dev-operations.md | 2 +- docs/dev-guide/sui-struct.md | 2 +- docs/usage/setup.md | 2 +- docs/usage/web-api.md | 2 +- 5 files changed, 30 insertions(+), 29 deletions(-) diff --git a/docs/blog/04_testnet_update.md b/docs/blog/04_testnet_update.md index f483c338..d20e9f35 100644 --- a/docs/blog/04_testnet_update.md +++ b/docs/blog/04_testnet_update.md @@ -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) @@ -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 @@ -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. @@ -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 @@ -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. @@ -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 diff --git a/docs/dev-guide/dev-operations.md b/docs/dev-guide/dev-operations.md index c47fe090..91662491 100644 --- a/docs/dev-guide/dev-operations.md +++ b/docs/dev-guide/dev-operations.md @@ -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. diff --git a/docs/dev-guide/sui-struct.md b/docs/dev-guide/sui-struct.md index 238f6917..aea69500 100644 --- a/docs/dev-guide/sui-struct.md +++ b/docs/dev-guide/sui-struct.md @@ -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, diff --git a/docs/usage/setup.md b/docs/usage/setup.md index 7b9fab61..af095e1c 100644 --- a/docs/usage/setup.md +++ b/docs/usage/setup.md @@ -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 diff --git a/docs/usage/web-api.md b/docs/usage/web-api.md index 7f065bdd..c4cfe03b 100644 --- a/docs/usage/web-api.md +++ b/docs/usage/web-api.md @@ -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 +view this in the browser, e.g., at ``` ### Store