-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update all docs following the Testnet redeployment (#202)
Co-authored-by: Alexandros Tzimas <[email protected]> Co-authored-by: George Danezis <[email protected]> Co-authored-by: giac-mysten <[email protected]>
- Loading branch information
1 parent
b433d7f
commit 91ec49a
Showing
24 changed files
with
325 additions
and
254 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
# Announcing Testnet v2 | ||
|
||
Published on: 2025-01-16 | ||
|
||
We are today redeploying the Walrus Testnet to incorporate various improvements, including some | ||
backwards-incompatible changes. Make sure to get the latest binary and configuration as described | ||
in the [setup section](../usage/setup.md). | ||
|
||
Note that all blob data on the previous Testnet instance has been wiped. All blobs need to be | ||
re-uploaded to the new Testnet instance, including Walrus Sites. In addition, there is a new version | ||
of the WAL token, so your previous WAL tokens will not work anymore. To use the Testnet v2, you | ||
need to obtain new WAL tokens. | ||
|
||
In the following sections, we describe the notable changes and the actions required for existing | ||
Walrus Sites. | ||
|
||
## Epoch duration | ||
|
||
The epoch duration has been increased from one day to two days to emphasize that this duration is | ||
different from Sui epochs (at Mainnet, epochs will likely be multiple weeks long). In addition, the | ||
maximum number of epochs a blob can be stored for has been reduced from 200 to 183 (corresponding | ||
to one year). | ||
|
||
The `walrus store` command now also supports the `--epochs max` flag, which will store | ||
the blob for the maximum number of epochs. Note that the `--epochs` flag is now mandatory. | ||
|
||
## New features | ||
|
||
Besides many improvements to the contracts and the storage-node service, the latest Walrus release | ||
also brings several user-facing improvements. | ||
|
||
- The `walrus store` command now supports storing multiple files at once. This is faster and more | ||
cost-effective compared to storing each file separately as transactions can be batched through | ||
[PTBs](https://docs.sui.io/concepts/transactions/prog-txn-blocks). Notably, this is compatible | ||
with glob patterns offered by many shells, so you can for example run a command like `walrus store | ||
*.png --epochs 100` to store all PNG files in the current directory. | ||
- The `walrus` CLI now supports creating, funding, and extending *shared blobs* using the `walrus | ||
share`, `walrus store --share`, and `walrus fund-shared-blob` commands. Shared blobs are an | ||
example of collectively managed and funded blobs. See the [shared blobs | ||
section](../usage/client-cli.md#shared-blobs) for more details. | ||
|
||
## New WAL token | ||
|
||
Along with the redeployment of Walrus, we have also deployed a fresh WAL contract. This | ||
means that you cannot use any WAL token from the previous Testnet instance with the new Testnet | ||
instance. You need to request new WAL tokens through the [Testnet WAL | ||
faucet](../usage/setup.md#testnet-wal-faucet). | ||
|
||
## Backwards-incompatible changes | ||
|
||
One reason for a full redeployment is to allow us to make some changes that are | ||
backwards-incompatible. Many of those are related to the contracts and thus less visible to users. | ||
There are, however, some changes that may affect you. | ||
|
||
### Configuration files | ||
|
||
The format of the configuration files for storage nodes and clients has been changed. Make sure to | ||
use the latest version of the configuration files, see the [configuration | ||
section](../usage/setup.md#configuration). | ||
|
||
### CLI options | ||
|
||
Several CLI options of the `walrus` CLI have been changed. Notably, all "short" variants of options | ||
(e.g., `-e` instead of `--epochs`) have been removed to prevent future confusion with new options. | ||
Additionally, the `--epochs` flag is now mandatory for the `walrus store` command (this also affects | ||
the [JSON API](../usage/json-api.md)). | ||
|
||
Please refer to the CLI help (`walrus --help`, or `walrus <command> --help`) for further details. | ||
|
||
### HTTP APIs | ||
|
||
The paths, request, and response formats of the HTTP APIs have changed for the storage nodes, and | ||
also the aggregator and publisher. Please refer to the section on the [HTTP | ||
API](../usage/web-api.md) for further details. | ||
|
||
## Effects on and actions required for existing Walrus Sites | ||
|
||
The Walrus Sites contracts have not changed, which means that all corresponding objects on Sui are | ||
still valid. However, the resources now point to blob IDs that do not yet exist on the new Testnet. | ||
The easiest way to fix existing sites is to simply update them with the `--force` flag: | ||
|
||
```sh | ||
site-builder update --epochs <number of epochs> --force <path to site> <existing site object> | ||
``` | ||
|
||
## New Move contracts & documentation | ||
|
||
As part of the new Testnet release of Walrus, the Move smart contracts have been updated; the | ||
deployed version can be found in the [`walrus-docs` | ||
repository](https://github.com/MystenLabs/walrus-docs/tree/main/contracts). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,7 @@ | ||
system_object: 0x50b84b68eb9da4c6d904a929f43638481c09c03be6274b8569778fe085c1590d | ||
staking_object: 0x37c0e4d7b36a2f64d51bba262a1791f844cfd88f31379f1b7c04244061d43914 | ||
walrus_package: 0x3d35ad1028562025f6f24336f0298d3775ba896bbbb63be7ad5b9fee8255dd89 | ||
exchange_object: | ||
- 0x0e60a946a527902c90bbc71240435728cd6dc26b9e8debc69f09b71671c3029b | ||
- 0x8a23a552895e341bca0106861786e014b5bb2f576bd7f76754226cc92266a0ee | ||
- 0x7c469c2b189379bff42874742c292934c03cde9d0a2c20f293f1a32f8eece68c | ||
- 0x59e7fa1b967c739ce676a7a3d8de444ac165f742421ba3b17656e2aee9fe541e | ||
system_object: 0x98ebc47370603fe81d9e15491b2f1443d619d1dab720d586e429ed233e1255c1 | ||
staking_object: 0x20266a17b4f1a216727f3eef5772f8d486a9e3b5e319af80a5b75809c035561d | ||
exchange_objects: | ||
- 0x59ab926eb0d94d0d6d6139f11094ea7861914ad2ecffc7411529c60019133997 | ||
- 0x89127f53890840ab6c52fca96b4a5cf853d7de52318d236807ad733f976eef7b | ||
- 0x9f9b4f113862e8b1a3591d7955fadd7c52ecc07cf24be9e3492ce56eb8087805 | ||
- 0xb60118f86ecb38ec79e74586f1bb184939640911ee1d63a84138d080632ee28a |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.