Skip to content

Commit

Permalink
fix: additional pr comments
Browse files Browse the repository at this point in the history
  • Loading branch information
giac-mysten committed Jun 12, 2024
1 parent 6f57e41 commit cda5d0a
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 37 deletions.
4 changes: 2 additions & 2 deletions docs/walrus-sites/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ which is

In summary:

- Walrus Sites are served through a portal; in this case, `https://walrus.site`. There can be many
portals, and anyone can host one.
- Walrus Sites are served through a Portal; in this case, `https://walrus.site`. There can be many
Portals, and anyone can host one.
- The subdomain on the URL points to a specific object on Sui, that allows the browser to fetch and
render the site resources. This pointer can be:
- A SuiNS name, such as `flatland` in `https://flatland.walrus.site`; or
Expand Down
9 changes: 4 additions & 5 deletions docs/walrus-sites/tutorial-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,12 @@ following variables in the config file:

- `package`: the object ID of the Walrus Sites package on Sui. This must always be specified in the
config, and is already appropriately configured in `assets/example-config.yaml`.
- `module`: the name of the module in the Walrus Sites package.
- `portal`: the name of the portal through which the site will be viewed; this only affects the
- `portal`: the name of the Portal through which the site will be viewed; this only affects the
output of the CLI, and nothing else (default: `walrus.site`).
All Walrus Sites are accessible through any portal independent of this setting.
All Walrus Sites are accessible through any Portal independent of this setting.
- `general`: these are general options, that can be configured both through the CLI and the config:
- `rpc_url`: The URL of the Sui RPC node to use. If not set, the `site-builder` will infer it from the
wallet.
- `rpc_url`: The URL of the Sui RPC node to use. If not set, the `site-builder` will infer it from
the wallet.
- `wallet`: Pointer to the Sui wallet to be used. By default, it uses the system-wide wallet (the
one from `sui client addresses`).
- `walrus_binary`: Pointer to the `walrus` binary. By default, this is expected to be run from
Expand Down
46 changes: 16 additions & 30 deletions docs/walrus-sites/tutorial-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,13 @@ Then, follow these additional setup steps.

Download the latest `walrus` binary for your architecture from
`https://storage.googleapis.com/mysten-walrus-binaries/walrus-v0.1.0-a0fb8c9-<arch>`, where `<arch>`
is your architecture. If you are on a Macbook with M* chip, substitute `macos-arm64`. Other
possible values are `macos-x86_64` or `ubuntu-x86_64`.
is your architecture. The available options are listed in this table:

| OS | CPU | Architecture |
|--------|---------------|-----------------|
| MacOS | Apple Silicon | `macos-arm64` |
| MacOS | Intel 64bit | `macos-x86_64` |
| Ubuntu | Intel 64bit | `ubuntu-x86_64` |

Then, add it to your `$PATH`. For example, on MacOS you can copy it to
`/Users/myusername/.local/bin/` (check what directories are in your `$PATH` by running `echo
Expand All @@ -30,44 +35,19 @@ Walrus client
Usage: walrus [OPTIONS] <COMMAND>
Commands:
store Store a new blob into Walrus
read Read a blob from Walrus, given the blob ID
publisher Run a publisher service at the provided network address
aggregator Run an aggregator service at the provided network address
daemon Run a client daemon at the provided network address, combining
the functionality of an aggregator and a publisher
info Print information about the Walrus storage system this client
is connected to
json Run the client by specifying the arguments in a JSON string;
CLI options are ignored
blob-id Encode the specified file to obtain its blob ID
help Print this message or the help of the given subcommand(s)
Options:
-c, --config <CONFIG>
The path to the wallet configuration file.
-w, --wallet <WALLET>
The path to the Sui wallet configuration file.
-g, --gas-budget <GAS_BUDGET>
The gas budget for transactions [default: 500000000]
-h, --help
Print help (see more with '--help')
-V, --version
Print version
```

If, for any reason, you don't want to add `walrus` to `$PATH`, place the binary in your preferred
directory, and remember to configure a pointer to the binary in the `site-builder` config (more on
this later).
this [later](./tutorial-config.md)).

## Point your Sui CLI to testnet, and get some SUI

Walrus is currently deployed on Sui Testnet. Therefore, you have to ensure that your Sui CLI is
configured accordingly:

``` bash
``` txt
sui client envs
╭──────────┬──────────────────────────────────────┬────────╮
│ alias │ url │ active │
Expand All @@ -79,6 +59,12 @@ sui client envs
╰──────────┴──────────────────────────────────────┴────────╯
```

If the `active` network is not `testnet`, switch to `testnet` by running:

``` sh
sui client switch --envs testnet
```

Further, make sure you have at least 2 separate gas coins, with at least 1 SUI each, by running `sui
client gas`. If you don't have enough SUI, you can hit the testnet faucet by running.

Expand Down

0 comments on commit cda5d0a

Please sign in to comment.