Skip to content

Commit

Permalink
Updating links to moved artifacts (MystenLabs#4822)
Browse files Browse the repository at this point in the history
* Updating links to moved artifacts

* Update install.md

* Copyedits
  • Loading branch information
randall-Mysten authored Sep 27, 2022
1 parent cbba1da commit 2adab04
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 77 deletions.
52 changes: 15 additions & 37 deletions doc/src/build/devnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,10 @@ title: Connect to Sui Devnet

Welcome to the Sui Devnet. We are hosting a public Devnet for the community to experiment with our tech and help to shape the future of the Sui network. It exists to gain operational experience with the Sui software in a public setting prior to our Mainnet launch.

To instead [contribute](../contribute/index.md) to Sui itself, you may experiment with the advanced [Sui CLI client](../build/cli-client.md) at the command line.


The Sui Devnet currently consists of:

* A four-validator network with all nodes operated by Mysten Labs. Clients send transactions and read requests via this endpoint: gateway.devnet.sui.io:443 using [JSON-RPC](../build/json-rpc.md)
* A public network [Sui Explorer](https://github.com/MystenLabs/sui/tree/main/apps/explorer#readme) for browsing transaction history: https://explorer.devnet.sui.io
* A public network [Sui Explorer](https://explorer.devnet.sui.io) for browsing transaction history.
* A [Discord channel](https://discordapp.com/channels/916379725201563759/971488439931392130) for requesting test coins that can be used to pay for gas on the test network. These coins have no financial value and will disappear each time we reset the network.

Many improvements to the Sui Devnet are underway, such as the ability to run full nodes and use a browser-based wallet. See the [Sui Devnet blog post](https://medium.com/mysten-labs/sui-devnet-public-release-a2be304ff36b) announcement for full details on upcoming features. All Devnet usage is subject to our [terms of service](https://sui.io/terms/).
Expand All @@ -19,17 +16,16 @@ Many improvements to the Sui Devnet are underway, such as the ability to run ful

We provide the following tools for users to interact with the Sui Devnet:

* The [Sui Wallet command line interface (CLI)](../build/cli-client.md)
* The [Sui command line interface (CLI)](../build/cli-client.md)
* create and manage your private keys
* submit transactions for creating example NFTs
* call and publish Move modules
* [Sui Explorer](https://github.com/MystenLabs/sui/tree/main/apps/explorer#readme) - view transactions and objects
* [Sui Explorer](https://github.com/MystenLabs/sui/blob/main/apps/explorer/README.md) - view transactions and objects

## Prerequisites

### Set up environment
## Environment set up

You may simply [install Sui](../build/install.md) and then request test tokens as described in the install docs. To use the Sui Devnet, you will need:
You can [install Sui](../build/install.md) and then request test tokens as described in the install docs. To use the Sui Devnet, you need:

1. Sui [test coins (tokens)](#request-gas-tokens) requested through [Discord](https://discordapp.com/channels/916379725201563759/971488439931392130).
1. the [`git` command line interface](https://git-scm.com/download/).
Expand All @@ -46,7 +42,7 @@ You should see the path to the command. Otherwise, reinstall.
In addition, to conduct advanced work such as publishing a Move module or making a Move call, also obtain the [Sui source code](../build/install.md#source-code); for simplicity, we recommend installing in `~/sui` or using an environment variable.

### Set up Sui CLI client, connect to gateway
## Configure the Sui client

Now set up your Sui CLI client and connect to Devnet. Note you can manually change the Gateway URL if you have already configured a Sui CLI client.

Expand All @@ -73,11 +69,11 @@ $ sui client switch --rpc https://gateway.devnet.sui.io:443
> **Tip:** If you run into issues, reset the Sui configuration by removing its directory, by default located at `~/.sui/sui_config`. Then reinstall [Sui binaries](../build/install.md#binaries).
## Basic testing
## Validating
Note that in the following sections, the object ID's, addresses, and authority signatures used are example values only. Sui generates unique values for each of these, so you see different values when you run the commands.

### Request gas tokens
## Request gas tokens

1. Join [Discord](https://discord.gg/sui) If you haven’t already.
1. Find your address by running:
Expand All @@ -87,7 +83,7 @@ Note that in the following sections, the object ID's, addresses, and authority s
1. Request tokens in the [#devnet-faucet](https://discord.com/channels/916379725201563759/971488439931392130)
channel per the [SUI tokens](../build/install.md#sui-tokens) install documentation.

### Mint an example NFT
## Mint an example NFT

To create a Non-Fungible Token (NFT), run:
```shell
Expand All @@ -104,19 +100,19 @@ Owner: Account Address ( 9E9A9D406961E478AA80F4A6B2B167673F3DF8BA )
Type: 0x2::devnet_nft::DevNetNFT
```

The above command created an object with ID `ED883F6812AF447B9B0CE220DA5EA9E0F58012FE`. Note you may use `Sui CLI client` to [view objects owned by the address](../build/cli-client.md#view-objects-owned-by-the-address).
The preceding command created an object with ID `ED883F6812AF447B9B0CE220DA5EA9E0F58012FE`. Use the `Sui CLI client` to [view objects owned by the address](../build/cli-client.md#view-objects-owned-by-the-address).

Now you can view the created object in the [Sui Explorer](https://explorer.devnet.sui.io) by appending the object ID to:
https://explorer.devnet.sui.io/objects/

![Example NFT](../../static/example-nft.png "Example NFT")

Note you may easily customize the name, description, or image of the NFT upon creation, like so:
The following example command demonstrates how to customize the name, description, or image of the NFT:
```shell
$ sui client create-example-nft --url=https://user-images.githubusercontent.com/76067158/166136286-c60fe70e-b982-4813-932a-0414d0f55cfb.png --description="The greatest chef in the world" --name="Greatest Chef"
```

Which results in a new object ID:
The command returns a new object ID:
```shell
Successfully created an ExampleNFT:
Expand All @@ -126,28 +122,10 @@ Owner: Account Address ( 9E9A9D406961E478AA80F4A6B2B167673F3DF8BA )
Type: 0x2::devnet_nft::DevNetNFT
```

That you can similarly view at:
You can view details about the object in Sui Explorer:
https://explorer.devnet.sui.io/objects/EC97467A40A1305FFDEF7019C3045FBC7AA31E29

![Custom NFT](../../static/custom-nft.png "Custom NFT")

See all transactions on the [home page](https://explorer.devnet.sui.io) and find the transaction hash under *Latest Transactions*:

![Explorer home](../../static/explorer-home.png "Explorer home")

To get to the *Transaction Details* view in Sui Explorer after minting an NFT, click on the *Last Transaction ID* field in the *Object View*.

![Transaction details](../../static/transaction-details.png "Transaction details")

Click on any address to see the objects it owns:

![Owned objects](../../static/owned-objects.png "Owned objects")

See the [Sui Explorer README](https://github.com/MystenLabs/sui/tree/main/apps/explorer#readme) for more details.

## Advanced testing

### Publish a Move module
## Publish a Move module

Publish a sample Move package containing code developed in the [Sui Move tutorial](../build/move/write-package.md) as follows (assuming you installed the source code in `~sui` as advised in set up):
```shell
Expand Down Expand Up @@ -179,7 +157,7 @@ Two important things happened as a result of publishing this package:
Specific object IDs displayed above may differ from one Sui installation to the other, so we will use the following placeholders for them (respectively): <PACKAGE_ID> and <FORGE_ID>. Whenever you see these used in the command line, for example when calling Move functions in the next section, *replace them with actual object IDs*.
### Make a Move call
## Make a Move call
In the previous section, we learned how to publish a Move package; and in this section, we will learn how to call into functions defined in this package. As a result of publishing a package, we obtained the new package object ID (<PACKAGE_ID>) and ID of the `Forge` object (<FORGE_ID>) that can be used to create swords and transfer them to other players.
Expand Down
11 changes: 1 addition & 10 deletions doc/src/build/fullnode.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Run a Sui Fullnode
---

We welcome you to run your own Sui fullnode! Sui fullnodes run a service that
Sui fullnodes run a service that
stores the full blockchain state and history. They service reads, either for
end clients or by helping other fullnodes get up-to-date with the latest
transactions that have been committed to the chain.
Expand All @@ -15,15 +15,6 @@ transactions (or a block of transactions), the validator will push that block
to a fullnode (potentially a number of fullnodes) who will then in turn
disseminate it to the rest of the network.

**Important**: For [potential validators](https://sui.io/resources-sui/validator-registration-open/),
running a Sui fullnode is an absolute
prerequisite. We encourage auditors, bridges, state mirrors and other
interested parties to join us. At this time, we offer no guarantees on performance
or stability of our fullnode software. We expect things to evolve and stabilize
over time, and we're seeking feedback in the form of [Sui Code Bug issues filed in
GitHub](https://github.com/MystenLabs/sui/issues/new/choose) for any problems
encountered.

## Features

Sui fullnodes exist to:
Expand Down
40 changes: 16 additions & 24 deletions doc/src/build/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,47 +2,39 @@
title: Install Sui
---

Welcome to the Sui development environment! This site is available in two versions in the menu at top left: the default and stable [Devnet](https://docs.sui.io/devnet/learn) branch and the [Latest build](https://docs.sui.io/learn) upstream `main` branch. Use the `devnet` version for app development on top of Sui. Use the Latest build `main` branch for [contributing to the Sui blockchain](../contribute/index.md) itself. Always check and submit fixes to the `main` branch.
Welcome to the Sui development environment! This site is available in two versions in the menu at top left: the default and stable [Devnet](https://docs.sui.io/devnet/learn) branch and the [Latest build](https://docs.sui.io/learn) upstream `main` branch. Use the `devnet` version for app development on top of Sui. Use the Latest build `main` branch for [contributing to the Sui blockchain](../contribute/index.md). Always check and submit fixes to the `main` branch.

## Summary

To immediately get started using Sui:
To get started using Sui:

1. Meet the [prerequisites](#prerequisites).
1. Install the [binaries](#binaries).
1. Install [prerequisites](#prerequisites).
1. Install Sui [binaries](#binaries).
1. Configure an [Integrated Development Environment (IDE)](#integrated-development-environment).
1. Request [SUI tokens](#sui-tokens) to evaluate Devnet and Sui Wallet
1. Optionally, download the [source code](#source-code) to have local
access to examples and modify Sui itself.

> **Tip:** Assuming you on macOS or Linux, have `curl`, Rust Cargo, the `git` command, and a GitHub account
> (see [Prerequisites](#prerequisites)), you can download the `sui-setup.sh` script
> and run it to conduct all of the setup below, **including removal of any existing
> sui assets**. To use it, run these commands in a terminal:
> ```shell
> $ curl https://raw.githubusercontent.com/MystenLabs/sui/main/doc/utils/sui-setup.sh -o sui-setup.sh
> chmod 755 sui-setup.sh
> ./sui-setup.sh
> ```
## Install with a script

If you're using macOS or Linux and already have `curl`, Rust Cargo, the `git` command, and a GitHub account (see [Prerequisites](#prerequisites)), you can download the `sui-setup.sh` script and run it install Sui, including removal of any existing Sui assets.
```shell
$ curl https://raw.githubusercontent.com/MystenLabs/sui/main/doc/utils/sui-setup.sh -o sui-setup.sh
chmod 755 sui-setup.sh
./sui-setup.sh
```

## Supported OSes

The following operating systems (OSes) have been tested and are supported for
running Sui:
Sui supports the following operating systems:

* [Linux](#linux-specific) - Ubuntu version 18.04 (Bionic Beaver)
* [macOS](#macOS-specific) - macOS Monterey
* [Microsoft Windows](#microsoft-windows-specific) - Windows 11

First install the [General packages](#general-packages) (plus [Brew](#brew) if on macOS), then install the OS-specific packages.
## Prerequisites

At a minimum, you should have a machine capable of installing command line tools (namely, a terminal).
First install the packages outlined this section. Then add the additional dependencies
below for your operating system.
Here are the packages required by operating system:
Sui requires the following prerequisities, listed by operating system:

|Package/OS |Linux | macOS| Windows 11|
--- | :---: | :---:| :---:|
Expand Down Expand Up @@ -209,7 +201,7 @@ And ensure the `.cargo/bin` directory appears. Access the help for any of these
> **Important:** Make sure your entire toolchain stays up-to-date. If you encounter issues building and installing the Sui binaries, update all packages above and re-install.
## Integrated Development Environment
For Move development, we recommend the [Visual Studio Code (vscode)](https://code.visualstudio.com/) IDE with the Move Analyzer language server plugin installed:
For Move development, we recommend the [Visual Studio Code](https://code.visualstudio.com/) IDE with the Move Analyzer language server plugin installed:

```shell
$ cargo install --git https://github.com/move-language/move move-analyzer --features "address20"
Expand Down Expand Up @@ -252,7 +244,7 @@ You can start exploring Sui's source code by looking into the following primary
* [sui_programmability](https://github.com/MystenLabs/sui/tree/main/sui_programmability) - Sui's Move language integration also including games and other Move code examples for testing and reuse
* [sui_core](https://github.com/MystenLabs/sui/tree/main/crates/sui-core) - authority server and Sui Gateway
* [sui-types](https://github.com/MystenLabs/sui/tree/main/crates/sui-types) - coins, gas, and other object types
* [explorer](https://github.com/MystenLabs/sui/tree/main/explorer) - object explorer for the Sui network
* [explorer](https://github.com/MystenLabs/sui/tree/main/apps/explorer) - object explorer for the Sui network
* [sui-network](https://github.com/MystenLabs/sui/tree/main/crates/sui-network) - networking interfaces

## Rustdoc
Expand Down
13 changes: 7 additions & 6 deletions doc/src/explore/index.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,27 @@
---
title: Exploring Sui
title: Explore Sui
---

Now that you've [learned](../learn/index.md) about Sui and started [building](../build/index.md) it, use the contents of this section to delve into Sui more deeply.

Find answers to common questions about our [roadmap](https://github.com/MystenLabs/sui/blob/main/ROADMAP.md) and more in our [FAQ](../contribute/faq.md).

## DevNet and Testnet
## Devnet and Testnet

Experiment with:

* [Sui DevNet](../build/devnet.md) - to gain operational experience with the Sui software in a public setting
* [Sui Incentivized Testnet](https://sui.io/resources-sui/announcing-sui-incentivized-testnet/) - will feature a menu of incentives to encourage and reward meaningful participation during the Testnet waves
* [Sui Devnet](../build/devnet.md) - to gain operational experience with the Sui software in a public setting

## Tutorial

Taking an end-to-end [tutorial](../explore/tutorials.md) from starting a Sui network locally to publishing a TicTacToe game on Sui and playing it.

## Examples

Try out [examples](../explore/examples.md) supplied by the Sui team to help you understand how objects are structured and manipulated.

## Prototypes

View projects built by third parties demonstrating the power of Sui.

[Prototypes](../explore/prototypes.md) - pre-alpha game prototypes that showcase the power of NFTs on Sui:
Expand Down Expand Up @@ -48,5 +50,4 @@ View projects built by third parties demonstrating the power of Sui.

## Sui Explorer

Navigate the [Sui Explorer](https://explorer.devnet.sui.io/) to see the latest transactions and objects. Read the [Sui Explorer README](https://github.com/MystenLabs/sui/tree/main/apps/explorer#readme) for instructions on how to run the Explorer locally.
https://explorer.devnet.sui.io/
Navigate the [Sui Explorer](https://explorer.devnet.sui.io/) to see transaction and object details. Read the [Sui Explorer README](https://github.com/MystenLabs/sui/tree/main/apps/explorer#readme) for instructions on how to run the Explorer locally.

0 comments on commit 2adab04

Please sign in to comment.