Skip to content

Commit

Permalink
Replace Open RPC in footer and JSON-RPC doc, fix numerous links throu… (
Browse files Browse the repository at this point in the history
MystenLabs#3907)

* Replace Open RPC in footer and JSON-RPC doc, fix numerous links throughout

* Update doc/src/build/json-rpc.md

Co-authored-by: Randall DuBois <109545725+randall-Mysten@users.noreply.github.com>

* Remove reference to Open RPC example

Co-authored-by: Randall DuBois <109545725+randall-Mysten@users.noreply.github.com>
  • Loading branch information
Clay-Mysten and randall-Mysten authored Aug 11, 2022
1 parent c5ec447 commit db72458
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 14 deletions.
13 changes: 7 additions & 6 deletions doc/src/build/json-rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,20 @@ export SUI_RPC_HOST=http://127.0.0.1:5001

## Sui software development kits

You may sign transactions and interact with the Sui network using:
You can sign transactions and interact with the Sui network using any of the following:

* the [Sui Rust SDK](rust-sdk.md), a collection of Rust language JSON-RPC wrapper and crypto utilities.
* the [Sui TypeScript SDK](https://github.com/MystenLabs/sui/tree/main/sdk/typescript) and [reference files](https://www.npmjs.com/package/@mysten/sui.js).
* [Sui Rust SDK](rust-sdk.md), a collection of Rust language JSON-RPC wrapper and crypto utilities.
* [Sui TypeScript SDK](https://github.com/MystenLabs/sui/tree/main/sdk/typescript) and [reference files](https://www.npmjs.com/package/@mysten/sui.js).
* [Sui API Reference](https://docs.sui.io/sui-jsonrpc) for all available methods.

## Sui JSON-RPC API

In the following sections we will show how to use Sui's JSON-RPC API with
the `curl` command.

## Sui JSON-RPC methods
## Sui JSON-RPC examples

This section includes example calls to the SUI JSON-RPC interface using `curl`. See the [Sui API Reference](https://docs.sui.io/sui-jsonrpc) for the latest list of all available methods.

### rpc.discover

Expand All @@ -63,8 +66,6 @@ curl --location --request POST $SUI_RPC_HOST \
--data-raw '{ "jsonrpc":"2.0", "method":"rpc.discover","id":1}'
```

You can see an example of the discovery service in the [OpenRPC Playground](https://playground.open-rpc.org/?schemaUrl=https://raw.githubusercontent.com/MystenLabs/sui/main/crates/sui-open-rpc/spec/openrpc.json).

### sui_syncAccountState

Synchronize client state with validators with the following command,
Expand Down
2 changes: 1 addition & 1 deletion doc/src/build/move/write-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ $ which sui
Now proceed to creating a package directory structure in the current
directory, parallel to the `sui` repository. It will contain an
empty manifest file and an empty module source file following the
[Move code organization](index.md#move-code-organization)
[Move code organization](../move/index.md#move-code-organization)
described earlier.

So from the same directory containing the `sui` repository create a
Expand Down
2 changes: 1 addition & 1 deletion doc/src/contribute/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Use these online resources:
* Sui Website: [https://sui.io/](https://sui.io/)
* Sui Developer Portal: [https://docs.sui.io/](https://docs.sui.io/)
* Sui Smart Contract White Paper: [https://sui.io/whitepaper](https://sui.io/whitepaper)
* SDK reference: [Sui JSON-RPC](https://playground.open-rpc.org/?uiSchema%5BappBar%5D%5Bui:splitView%5D=false&schemaUrl=https://raw.githubusercontent.com/MystenLabs/sui/main/crates/sui-open-rpc/spec/openrpc.json&uiSchema%5BappBar%5D%5Bui:input%5D=false)
* Sui API Reference: [Sui JSON-RPC](https://docs.sui.io/sui-jsonrpc)


### What does Sui offer over other blockchains?
Expand Down
2 changes: 1 addition & 1 deletion doc/src/explore/devnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Experiment with Sui Devnet

Welcome to the beginnings of the Sui Devnet. It exists now to gain operational experience with the Sui software in a public setting. 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: https://gateway.devnet.sui.io:443/ using [JSON-RPC](../build/json-rpc.md)
* 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/explorer/client#readme) for browsing transaction history: https://explorer.devnet.sui.io
* 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.

Expand Down
4 changes: 2 additions & 2 deletions doc/src/explore/prototypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ With Sui, we believe game developers should not be limited by the platform perfo

## How we did it

Created by game development studio GenITeam, these prototypes use both the Unity SDK and Sui [APIs](https://playground.open-rpc.org/?uiSchema%5BappBar%5D%5Bui:splitView%5D=false&schemaUrl=https://raw.githubusercontent.com/MystenLabs/sui/main/crates/sui-open-rpc/spec/openrpc.json&uiSchema%5BappBar%5D%5Bui:input%5D=false).
Created by game development studio GenITeam, these prototypes use both the Unity SDK and Sui [APIs](https://docs.sui.io/sui-jsonrpc).

GenITeam’s developers who worked on this collaboration are neither smart contract nor Move developers. Based on their input, we created a data model and shared simple APIs. With these APIs, geniteam was able to mint fully on-chain NFTs that are mutable, own other on-chain assets, and freely transfer to other applications.

Expand Down Expand Up @@ -234,5 +234,5 @@ Gameplay:

## Further reading

* Check out Sui [APIs](https://playground.open-rpc.org/?uiSchema%5BappBar%5D%5Bui:splitView%5D=false&schemaUrl=https://raw.githubusercontent.com/MystenLabs/sui/main/crates/sui-open-rpc/spec/openrpc.json&uiSchema%5BappBar%5D%5Bui:input%5D=false).
* Check out Sui [APIs](https://docs.sui.io/sui-jsonrpc).
* Learn about Sui [objects](../build/objects.md).
2 changes: 1 addition & 1 deletion doc/src/learn/why-move.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Why Move?
---

In Sui, you write [Smart Contracts](../build/move.md) with the Move Programming language. This page links to key [Move](https://golden.com/wiki/Move_(programming_language)-MNA4DZ6) resources and compares the [Move](https://github.com/move-language/move/tree/main/language/documentation) and Solidity programming languages. For a full description of the issues with traditional smart contract languages, see the [Move Problem Statement](https://github.com/MystenLabs/awesome-move/blob/main/docs/problem_statement.md).
In Sui, you write [Smart Contracts](../build/move/index.md) with the Move Programming language. This page links to key [Move](https://golden.com/wiki/Move_(programming_language)-MNA4DZ6) resources and compares the [Move](https://github.com/move-language/move/tree/main/language/documentation) and Solidity programming languages. For a full description of the issues with traditional smart contract languages, see the [Move Problem Statement](https://github.com/MystenLabs/awesome-move/blob/main/docs/problem_statement.md).

## Sui Move

Expand Down
4 changes: 2 additions & 2 deletions doc/src/siteconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@
"link": "/build/move"
},
{
"title": "SDK Reference",
"link": "https://playground.open-rpc.org/?uiSchema%5BappBar%5D%5Bui:splitView%5D=false&schemaUrl=https://raw.githubusercontent.com/MystenLabs/sui/main/crates/sui-open-rpc/spec/openrpc.json&uiSchema%5BappBar%5D%5Bui:input%5D=false",
"title": "API Reference",
"link": "https://docs.sui.io/sui-jsonrpc",
"external": true
},
{
Expand Down

0 comments on commit db72458

Please sign in to comment.