Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update connect topic to include testnet #9850

Merged
merged 3 commits into from
Mar 24, 2023

Conversation

ronny-mysten
Copy link
Contributor

Description

Updates to sui client output and adding testnet to possible networks. Left filename so that links aren't broken.

Test Plan

Locally


If your changes are not user-facing and not a breaking change, you can skip the following section. Otherwise, please indicate what changed, and then add to the Release Notes section as highlighted during the release process.

Type of Change (Check all that apply)

  • user-visible impact
  • breaking change for a client SDKs
  • breaking change for FNs (FN binary must upgrade)
  • breaking change for validators or node operators (must upgrade binaries)
  • breaking change for on-chain data layout
  • necessitate either a data wipe or data migration

Release notes

@vercel
Copy link

vercel bot commented Mar 24, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Ignored Deployments
Name Status Preview Comments Updated
explorer ⬜️ Ignored (Inspect) Mar 24, 2023 at 9:57PM (UTC)
explorer-storybook ⬜️ Ignored (Inspect) Mar 24, 2023 at 9:57PM (UTC)
wallet-adapter ⬜️ Ignored (Inspect) Mar 24, 2023 at 9:57PM (UTC)

@github-actions github-actions bot added the Type: Documentation Improvements or additions to documentation label Mar 24, 2023
* A public network [Sui Explorer](https://explorer.sui.io) for browsing transaction history.

You can [request test SUI tokens](#request-test-tokens) through the Sui [devnet-faucet](https://discordapp.com/channels/916379725201563759/971488439931392130) Discord channel. These coins have no financial value. With each Sui release, the network resets and removes all assets (coins and NFTs).
You can [request test SUI tokens](#request-test-tokens) through the Sui [devnet-faucet](https://discordapp.com/channels/916379725201563759/971488439931392130) and [testnet-faucet](https://discord.com/channels/916379725201563759/1037811694564560966) Discord channels, depending on which version of the network you're working with. These coins have no financial value. With each Sui release, the network resets and removes all assets (coins and NFTs).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to the new faucet topic for the cURL command?

@@ -41,32 +41,35 @@ See the [Sui Releases](https://github.com/MystenLabs/sui/releases) page to view

## Configure Sui client

If you previously ran `sui genesis -f` to create a local network, it created a Sui client configuration file (client.yaml) that connects to `localhost` `http://0.0.0.0:9000`. See [Connect to custom RPC endpoint](#connect-to-custom-rpc-endpoint) to update the client.yaml file.
If you previously ran `sui genesis` to create a local network, it created a Sui client configuration file (client.yaml) that connects to `localhost` at `http://0.0.0.0:9000`. See [Connect to custom RPC endpoint](#connect-to-custom-rpc-endpoint) to update the client.yaml file.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mention that you can also use sui client new-env directly instead of updating client.yaml

```

Press **Enter** to connect to Sui Devnet. To use a custom RPC server, enter the URL to the custom RPC endpoint and then press **Enter**.
Press **Enter** to connect to Sui Devnet. To use a custom RPC server or Sui Testnet, enter the URL to the correct RPC endpoint and then press **Enter**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I get asked to enter an Environment alias for the endpoint

If you previously used `sui genesis` with the force option (`-f` or `--force`), your client.yaml file already includes two RPC endpoints: localnet `http://0.0.0.0:9000` and devnet `https://fullnode.devnet.sui.io:443`). You can view the defined environments with the `sui client envs` command, and switch between them with the `sui client switch` command.
If you previously used `sui genesis` with the force option (`-f` or `--force`), your client.yaml file already includes two RPC endpoints: `localnet` at `http://0.0.0.0:9000` and `devnet` at `https://fullnode.devnet.sui.io:443`. You can view the defined environments with the `sui client envs` command, and switch between them with the `sui client switch` command.

If you previously installed a Sui client that connected to a Sui network, or created a local network, you can modify your existing `client.yaml` to change the configured RPC endpoint.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can use the sui client new-env to create a new one, and then use sui client switch --env <ALIAS> to set that as the active network

Send the following message to the channel with your client address:
!faucet `<Your client address>`
1. Request test SUI tokens in the Sui [#devnet-faucet](https://discord.com/channels/916379725201563759/971488439931392130) or [#testnet-faucet]() Discord channel. Send the following message to the relevant channel with your client address:
!faucet `<YOUR-CLIENT-ADDRESS>`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or see the Faucet topic to get tokens programmatically


When you publish a package, the IDs for the objects the compiler creates are different than the ones displayed in this example. The remainder of this topic uses `<PACKAGE_ID>` and `<FORGE_ID>` to represent the IDs for the created objects (except for console output examples). You must replace these with the values for your package.
When you publish a package, the IDs for the objects the compiler creates are different than the ones displayed in this example. The remainder of this topic uses `<PACKAGE-ID>` and `<FORGE-ID>` to represent the IDs for the created objects (except for console output examples). You must replace these with the values for your package.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should check the tutorial topics so these match

@ronny-mysten ronny-mysten enabled auto-merge (squash) March 24, 2023 21:57
@ronny-mysten ronny-mysten merged commit dc81b3d into MystenLabs:main Mar 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants