Skip to content

Commit

Permalink
[docs] Removing Sui Explorer refs (MystenLabs#16692)
Browse files Browse the repository at this point in the history
## Description 

Describe the changes or additions included in this PR.

## Test Plan 

How did you test the new or updated feature?

---
If your changes are not user-facing and do not break anything, you can
skip the following section. Otherwise, please briefly describe what has
changed under the Release Notes section.

### Type of Change (Check all that apply)

- [ ] protocol change
- [ ] 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
  • Loading branch information
ronny-mysten authored Mar 15, 2024
1 parent efda957 commit d317516
Show file tree
Hide file tree
Showing 12 changed files with 29 additions and 68 deletions.
6 changes: 3 additions & 3 deletions docs/content/concepts/tokenomics/gas-in-sui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ Finally, Sui [Storage mechanics](storage-fund.mdx#storage-fund-rewards) provide

`net_gas_fees = computation_gas_fee + storage_gas_fee - storage_rebate`

The information on net gas fees displays in [Sui Explorer](https://suiexplorer.com/) for each transaction block:
The information on net gas fees displays in a Sui network explorer for each transaction block:

![Gas Fees displayed on Sui Explorer](images/gas-fees-explorer.png "The Gas Fees section displayed on Sui Explorer")
_The Gas Fees section for a transaction block displayed on Sui Explorer_
![Gas Fees displayed on a Sui network explorer](images/gas-fees-explorer.png "The Gas Fees section displayed on a Sui network explorer")
_The Gas Fees section for a transaction block displayed on a Sui network explorer_

## Gas prices {#gas-prices}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -943,7 +943,7 @@ In a terminal or console within the project's setup directory, utilize the follo

After executing the command, the console displays the effects of the transaction.

By searching the transaction digest in the Sui Explorer, you can locate the created objects. Subsequently, select and save the `TransferPolicy ID` and the `ProtectedTP ID` from these objects into the respective fields within your .env file.
By searching the transaction digest on a Sui network explorer, you can locate the created objects. Subsequently, select and save the `TransferPolicy ID` and the `ProtectedTP ID` from these objects into the respective fields within your .env file.

- **Add Rules**

Expand Down
2 changes: 1 addition & 1 deletion docs/content/guides/developer/app-examples/plinko.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -784,7 +784,7 @@ The [`PlinkoSettings` component](https://github.com/MystenLabs/plinko-poc/blob/m

## User interaction and feedback

Game Initiation: After selecting the desired number of balls and setting the bet size for each, players can initiate a new game by pressing the **Play** button. This action starts the game, with the button becoming disabled during gameplay to prevent new games from being initiated until the current game concludes and the last ball has reached the end. Links are also provided for players to view game details on the Sui explorer for transparency and engagement.
Game Initiation: After selecting the desired number of balls and setting the bet size for each, players can initiate a new game by pressing the **Play** button. This action starts the game, with the button becoming disabled during gameplay to prevent new games from being initiated until the current game concludes and the last ball has reached the end. Links are also provided for players to view game details on a Sui network explorer for transparency and engagement.

## Related links

Expand Down
2 changes: 1 addition & 1 deletion docs/content/guides/developer/first-app/client-tssdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ function OwnedObjects({ address }: { address: string }) {
<ul>
{data.data.map((object) => (
<li key={object.data?.objectId}>
<a href={`https://suiexplorer.com/object/${object.data?.objectId}`}>
<a href={`https://example-explorer.com/object/${object.data?.objectId}`}>
{object.data?.objectId}
</a>
</li>
Expand Down
18 changes: 7 additions & 11 deletions docs/content/guides/developer/getting-started/connect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,7 @@ description: Besides Mainnet, Sui offers Testnet, Devnet, and local networks tha

Sui has Mainnet, Devnet, and Testnet networks available. You can use one of the test networks, Devnet or Testnet, to experiment with the version of Sui running on that network. You can also spin up a [local Sui network](./local-network.mdx) for local development.

The Sui Testnet and Devnet networks consist of:

* Four validator nodes operated by Mysten Labs. Clients send transactions and read requests via this endpoint: `https://fullnode.<SUI-NETWORK-VERSION>.sui.io:443` using [JSON-RPC](/references/sui-api/json-rpc-format.mdx).
* A public network [Sui Explorer](https://suiexplorer.com/) for browsing transaction history.
The Sui Testnet and Devnet networks consist of four validator nodes operated by Mysten Labs. Clients send transactions and read requests via this endpoint: `https://fullnode.<SUI-NETWORK-VERSION>.sui.io:443` using [JSON-RPC](/references/sui-api/json-rpc-format.mdx).

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 use. If connected to Localnet, use cURL to request tokens from your [local faucet](./local-network.mdx#use-the-local-faucet). The coins on these networks have no financial value. There is no faucet service for Mainnet.

Expand All @@ -18,15 +15,14 @@ See the [terms of service](https://sui.io/terms/) for using Sui networks.

{@include: ../../../snippets/data-wipe.mdx}

## Tools
## Sui CLI

Sui provides [Sui command line interface (CLI)](/references/cli/client.mdx) to interact with Sui networks:

Sui provides the following tools to interact with Sui networks:
- Create and manage your private keys
- Create example NFTs
- Call and publish Move modules

* [Sui command line interface (CLI)](/references/cli/client.mdx)
* Create and manage your private keys
* Create example NFTs
* Call and publish Move modules
* [Sui Explorer](https://github.com/MystenLabs/sui/blob/main/apps/explorer/README.md) to view transactions and objects on the network

## Environment set up

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ An address is a way to uniquely and anonymously identify an account that exists

The Sui address is unique, similarly to the way a social security number or a personal identification number is unique to one person. However, in Sui you can create and own multiple addresses, all of which are unique.

In Sui, an address is 32 bytes and is often encoded in base58 with `0x` prefix. For example, this is a valid Sui address: `0x02a212de6a9dfa3a69e22387acfbafbb1a9e591bd9d636e7895dcfc8de05f331`. You can use the [Sui Explorer](https://suiexplorer.com/) website to find more information about [this address](https://suiexplorer.com/address/0x02a212de6a9dfa3a69e22387acfbafbb1a9e591bd9d636e7895dcfc8de05f331) and the objects it owns.
In Sui, an address is 32 bytes and is often encoded in base58 with `0x` prefix. For example, this is a valid Sui address: `0x02a212de6a9dfa3a69e22387acfbafbb1a9e591bd9d636e7895dcfc8de05f331`. You can use the a Sui network explorer to find more information about this address and the objects it owns.

If you'd like to understand how a Sui address is derived from private keys and other cryptography related topics, see the [Keys and Addresses](/concepts/cryptography/transaction-auth/keys-addresses.mdx) topic.

Expand Down
24 changes: 4 additions & 20 deletions docs/content/guides/developer/getting-started/local-network.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ The response resembles the following, but with different IDs:
╰────────────────────────────────────────────────────────────────────┴────────────╯
```

## Install Sui Wallet and Sui Explorer locally
## Install Sui Wallet locally

To install and use the apps locally, you must first install [pnpm](https://pnpm.io/installation). Use the instructions appropriate for your operating system.

Expand All @@ -147,35 +147,19 @@ After you install `pnpm`, use the following command to install the required depe
pnpm install
```

After the installation completes, run the following command to install Sui Wallet and Sui Explorer:
After the installation completes, run the following command to install Sui Wallet:

```shell
pnpm turbo build
```

If you encounter an error from turbo build, confirm that there is no `package-lock.json`. If the file exists, remove it and then run the command again.

### Set up Sui Explorer on your local network

To connect the live Sui Explorer to your local network, open the URL:[https://suiexplorer.com/?network=local](https://suiexplorer.com/?network=local). The live version of Sui Explorer may not include recent updates added to the `main` branch of the Sui repo. To use Sui Explorer that includes the most recent updates, install and run Sui Explorer from your local clone of the Sui repo.

Run the following command from the `sui` root folder:

**Note:** To run the command you have `pnpm` installed. See [Install Sui Wallet and Sui Explorer locally](#install-sui-wallet-and-sui-explorer-locally) for details.

```bash
pnpm explorer dev
```

After the command completes, open your local Sui Explorer at the following URL: [http://localhost:3000/](http://localhost:3000/).

For more details about Sui Explorer, see the [Explorer README](https://github.com/MystenLabs/sui/blob/main/apps/explorer/README.md#set-up).

## Set up a local Sui Wallet

You can also use a local Sui Wallet to test with your local network. You can then see transactions executed from your local Sui Wallet on your local Sui Explorer.
You can also use a local Sui Wallet to test with your local network.

**Note:** To run the command you must have `pnpm` installed. See [Install Sui Wallet and Sui Explorer locally](#install-sui-wallet-and-sui-explorer-locally) for details.
**Note:** To run the command you must have `pnpm` installed. See [Install Sui Wallet locally](#install-sui-wallet-locally) for details.

Before you start the Sui Wallet app, update its default environment to point to your local network. To do so, first make a copy of `sui/apps/wallet/configs/environment/.env.defaults` and rename it to `.env` in the same directory. In your `.env` file, edit the first line to read `API_ENV=local` and then save the file.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ The Sui repo is a monorepo, containing all the source code that is used to build

The root folder of the Sui monorepo has the following top-level folders:

- [apps](https://github.com/MystenLabs/sui/tree/main/apps): Contains the source code for the main web applications that Mysten Labs runs, such as the `suiexplorer.com` or the `Sui Wallet`.
- [apps](https://github.com/MystenLabs/sui/tree/main/apps): Contains the source code for the main web applications that Mysten Labs runs, `Sui Wallet`.
- [crates](https://github.com/MystenLabs/sui/tree/main/crates): Contains all the Rust crates that are part of the Sui system.
- [dapps](https://github.com/MystenLabs/sui/tree/main/dapps): Contains some examples of decentralized applications built on top of Sui, such as Kiosk or Sponsored Transactions.
- [dashboards](https://github.com/MystenLabs/sui/tree/main/dashboards): Currently empty.
Expand All @@ -74,7 +74,6 @@ The root folder of the Sui monorepo has the following top-level folders:

The following primary directories offer a good starting point for exploring the Sui codebase:

- [explorer](https://github.com/MystenLabs/sui/tree/main/apps/explorer) - Browser-based object explorer for the Sui network. See the deployed application [here](https://suiexplorer.com).
- [move](https://github.com/MystenLabs/sui/tree/main/external-crates/move) - Move VM, compiler, and tools.
- [narwhal](https://github.com/MystenLabs/sui/tree/main/narwhal) - Mempool and consensus.
- [typescript-sdk](https://github.com/MystenLabs/sui/tree/main/sdk/typescript/) - the Sui TypeScript SDK.
Expand Down
5 changes: 0 additions & 5 deletions docs/content/guides/developer/sui-101/using-events.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,6 @@ Move smart contracts can call other smart contracts that emit events. For exampl
}
```

https://suiexplorer.com/txblock/bZnc1E7k1fJYLxWihfre5xCw1tX1CyAN6579zypJeiU

Here's an example of a transaction that is using the original `dee9` package.
https://suiexplorer.com/txblock/896CKHod5GQ4kzhF7EwTAGyhQBdaTb9rQS41dcL76gj8

```json
{
"id": {
Expand Down
9 changes: 1 addition & 8 deletions docs/content/guides/operator/sui-full-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -208,15 +208,8 @@ Then update the metrics address in your fullnode.yaml file to use port `9180`.
metrics-address: "0.0.0.0:9180"
```

## Sui Explorer with your Full node

[Sui Explorer](https://suiexplorer.com/) supports connections to custom RPC URLS and local networks. You can point the Explorer to your local Full node and see the transactions it syncs from the network.
1. Open a browser and go to: https://suiexplorer.com/
1. Click **Mainnet** in the network drop-down at the top right-hand corner (or three bars on smaller screens) and select **Local** to connect to a local network, or select **Custom RPC URL** and then enter the URL.

Sui Explorer displays information about the selected network.

## Monitoring

Monitor your Full node using the instructions at Logging, Tracing, Metrics, and Observability.

The default metrics port is `9184`. To change the port, edit your fullnode.yaml file.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/guides/operator/validator-tasks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ sui client call --package 0x3 --module sui_system --function rotate_operation_ca

By default the new `Cap` object is transferred to the validator address, which then could be transferred to the new delegatee address. At this point, the old `Cap` becomes invalidated and no longer represents eligibility.

To get the current valid `Cap` object's ID of a validator, use the Sui Client CLI `sui client objects` command after setting the holder as the active address. Or go to the [explorer](https://explorer.sui.io/object/0x0000000000000000000000000000000000000005) and look for `operation_cap_id` of that validator in the `validators` module.
To get the current valid `Cap` object's ID of a validator, use the Sui Client CLI `sui client objects` command after setting the holder as the active address.

### Updating the gas price survey quote

Expand Down
22 changes: 8 additions & 14 deletions docs/content/references/contribute/style-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -241,21 +241,21 @@ Use imperative verbs for tasks, procedures, and instructions.

**Example**

- **Indicative –** The Sui Explorer displays transactions on the network.
- **Imperative –** Open Sui Explorer to view transactions on the network.
- **Subjunctive –** We suggest that you view your transaction in Sui Explorer after you complete a transfer.
- **Indicative –** Sui network explorers display transactions on the network.
- **Imperative –** Open a Sui network explorer to view transactions on the network.
- **Subjunctive –** We suggest that you view your transaction in a Sui network explorer after you complete a transfer.

### Person {#person}

Use second person in most cases.

**Example**

> You can view transaction history in Sui Explorer.
> You used to could view transaction history in Sui Explorer.
**Rather than:**

> We can view transaction history in Sui Explorer.
> We used to could view transaction history in Sui Explorer.
### Present tense {#present-tense}

Expand Down Expand Up @@ -427,7 +427,7 @@ Use bulleted lists to list more than two pieces of related information, such as
<Tabs>
<TabItem value="example" label="Example" default>

Sui Explorer supports the following browsers:
Sui Explorer used to support the following browsers:

- Firefox version X or later
- Chrome version X or later
Expand All @@ -438,7 +438,7 @@ Sui Explorer supports the following browsers:

```
Sui Explorer supports the following browsers:
Sui Explorer used to support the following browsers:
- Firefox version X or later
- Chrome version X or later
Expand Down Expand Up @@ -648,7 +648,7 @@ Proper nouns include:

**Example**

> Sui Explorer
> Sui Wallet
## Product names {#product-names}

Expand All @@ -668,18 +668,12 @@ Product names are proper nouns. Capitalize all words of a product name. When ref

**Example**

> Sui Explorer
> Sui Wallet
**Example**

> You can mint an NFT directly from your Sui Wallet.
> Find transaction details in Sui Explorer.
> After you complete a transaction in your Sui Wallet, view details about the transaction on Sui Explorer.
## Slashes {#slashes}

Avoid using slashes in place of "and" or "or", such as True / False or True/False. Use True or False, or True | False in code documentation.
Expand Down

0 comments on commit d317516

Please sign in to comment.