Skip to content

Commit

Permalink
[clean up] - Remove rest server and update docs (#1654)
Browse files Browse the repository at this point in the history
* Remove rest server and update docs

* remove unused deps

* Update json-rpc.md

Remove eponymous links for future proofing

* Update wallet.md

Fix small article disagreement in "a RPC"

Co-authored-by: Clay-Mysten <100217682+Clay-Mysten@users.noreply.github.com>
  • Loading branch information
patrickkuo and Clay-Mysten authored Apr 29, 2022
1 parent 4d1332c commit ca9046f
Show file tree
Hide file tree
Showing 17 changed files with 19 additions and 2,095 deletions.
505 changes: 0 additions & 505 deletions Cargo.lock

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions doc/src/build/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ Here is our recommended workflow to interact with Sui:
1. [Debug](../build/move.md#debugging-a-package) a package.
1. [Publish](../build/move.md#publishing-a-package) a package.
1. [Create](../build/wallet.md#genesis) and [Start](../build/wallet.md#starting-the-network) a *local Sui network*.
1. [Start](../build/rest-api.md#start-local-rest-server) a *local REST Gateway server*.
1. [Connect](../build/wallet.md#rest-gateway) to the Sui network Gateway service with the *Sui Wallet*.
1. [Start](../build/json-rpc.md#start-local-rpc-server) a *local JSON-RPC Gateway server*.
1. [Connect](../build/wallet.md#rpc-gateway) to the Sui network Gateway service with the *Sui Wallet*.
1. Build dApps:
1. [Use](../build/rest-api.md) *Sui REST Server and REST API* to interact with a local Sui network.
1. [Use](../build/json-rpc.md) *Sui RPC Server and JSON-RPC API* to interact with a local Sui network.
1. [Employ](../build/sui-json.md) *SuiJSON format* to align JSON inputs more closely with Move call arguments.


Expand Down
3 changes: 1 addition & 2 deletions doc/src/build/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ $ cargo install --git https://github.com/MystenLabs/sui.git sui
This will put these binaries in your `PATH` (ex. under `~/.cargo/bin`) that provide these command line interfaces (CLIs):
* [`sui-move`](move.md): Build and test Move packages.
* [`wallet`](wallet.md): Run a local Sui network and gateway service accessible via the wallet CLI. The wallet CLI manage keypairs to sign/send transactions.
* [`rest_server`](rest-api.md): Run a local Sui network and gateway service accessible via a REST interface.
* [`rpc-server`](json-rpc.md): Run a local Sui network and gateway service accessible via an RPC interface.

Confirm the install with:
Expand Down Expand Up @@ -65,5 +64,5 @@ Continue your journey through:

* [Smart Contracts with Move](move.md)
* [Wallet Quick Start](wallet.md)
* [REST Server API](rest-api.md)
* [RPC Server API](json-rpc.md)
* [End-to-End tutorial](../explore/tutorials.md)
8 changes: 4 additions & 4 deletions doc/src/build/json-rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,10 +211,10 @@ curl --location --request POST $SUI_RPC_HOST \
```

#### 2, Sign the transaction
Follow the instructions to [sign the transaction](rest-api.md#2-sign-the-transaction-using-the-sui-signtool).
Follow the instructions to [sign the transaction](#2-sign-the-transaction-using-the-sui-signtool).

#### 3, Execute the transaction
Follow the instructions to [execute the transaction](rest-api.md#3-execute-the-transaction-using-the-transaction-data-signature-and-public-key).
Follow the instructions to [execute the transaction](#3-execute-the-transaction-using-the-transaction-data-signature-and-public-key).

Arguments are passed in, and type will be inferred from function
signature. Gas usage is capped by the gas_budget. The `transfer`
Expand Down Expand Up @@ -282,10 +282,10 @@ Copy the outputting base64 representation of the compiled Move module into the
REST publish endpoint.

#### 2, Sign the transaction
Follow the instructions to [sign the transaction](json-rpc.md#2-sign-the-transaction-using-the-sui-signtool).
Follow the instructions to [sign the transaction](#2-sign-the-transaction-using-the-sui-signtool).

#### 3, Execute the transaction
Follow the instructions to [execute the transaction](rest-api.md#3-execute-the-transaction-using-the-transaction-data-signature-and-public-key).
Follow the instructions to [execute the transaction](#3-execute-the-transaction-using-the-transaction-data-signature-and-public-key).

Below you can see a truncated sample output of [sui_publish](#sui_publish). One of the results of executing this command is generation of a package object representing the published Move code. An ID of the package object can be used as an argument for subsequent Move calls to functions defined in this package.

Expand Down
317 changes: 0 additions & 317 deletions doc/src/build/rest-api.md

This file was deleted.

8 changes: 4 additions & 4 deletions doc/src/build/wallet.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,14 +132,14 @@ As the name suggests, embedded gateway embeds the gateway logic into the applica
all data will be stored locally and the application will make direct
connection to the validators.

#### Rest gateway
You can also connect the wallet to the Sui network via a [Rest Gateway](rest-api.md#start-local-rest-server);
To use the rest gateway, update `wallet.conf`'s `gateway` section to:
#### RPC gateway
You can also connect the wallet to the Sui network via an [RPC Gateway](json-rpc.md#start-local-rpc-server);
To use the RPC gateway, update `wallet.conf`'s `gateway` section to:
```json
{
...
"gateway": {
"rest":"http://127.0.0.1:5001"
"rpc":"http://127.0.0.1:5001"
},
...
}
Expand Down
Loading

0 comments on commit ca9046f

Please sign in to comment.