Skip to content

Commit

Permalink
Announce Rust SDK, make small, related improvements (MystenLabs#3791)
Browse files Browse the repository at this point in the history
* Announce Rust SDK, make small, related improvements

* Add SDK section to JSON RPC doc linking to Rust and TypeScript SDKs
  • Loading branch information
Clay-Mysten authored Aug 6, 2022
1 parent c70ef22 commit 7c3dc6b
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 14 deletions.
9 changes: 7 additions & 2 deletions doc/src/build/json-rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,18 @@ Export a local user variable to store the hardcoded hostname + port that the loc
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:

* 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 JSON-RPC API

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

> **Tip:** If your application is written in JavaScript or TypeScript, follow the [TypeScript SDK documentation](https://github.com/MystenLabs/sui/tree/main/sdk/typescript) and [reference files](https://www.npmjs.com/package/@mysten/sui.js).
## Sui JSON-RPC methods

### rpc.discover
Expand Down
2 changes: 1 addition & 1 deletion doc/src/build/rust-sdk.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Sui Rust SDK
title: Interact with Sui over Rust SDK
---

## Overview
Expand Down
4 changes: 2 additions & 2 deletions doc/src/learn/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ For a deep dive into Sui technology, see the [Sui Smart Contracts Platform](http

The following list includes the recent updates to Sui and the documentation:

* Interact with the Sui network using our new [Rust SDK](../build/rust-sdk.md), a collection of Rust language [JSON-RPC wrapper and crypto utilities](https://github.com/MystenLabs/sui/tree/main/crates/sui-sdk).
* Sui now supports development using [Microsoft Windows 11, macOS, and Linux](../build/install.md#supported-oses). See [install Sui](../build/install.md#prerequisites) for the prerequisites of each operating system.
* You can now [register to participate](https://airtable.com/shr3phh3FCZYhZUDF) in [Sui Incentivized Testnet as a validator](https://sui.io/resources-sui/validator-registration-open/)!
* This site is now 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.
* Sui now supports development using [Microsoft Windows 11, macOS, and Linux](../build/install.md#supported-oses). See [install Sui](../build/install.md#prerequisites) for the prerequisites of each operating system.
* `sui::id` is now `sui::object` and `VersionedID` is now `Info`. Use the [Object module](https://github.com/MystenLabs/sui/blob/main/crates/sui-framework/sources/object.move) that has [replaced the former ID.move.](https://github.com/MystenLabs/sui/pull/3241)
* Find a list of [single-writer apps](../learn/single-writer-apps.md) that would benefit from Sui's advantages in handling [simple transactions](../learn/how-sui-works.md#simple-transactions).
* Sui [version 0.6.1](https://github.com/MystenLabs/sui/releases/tag/devnet-0.6.1) released to DevNet. See the [#sui-release-notes](https://discord.com/channels/916379725201563759/974444055259910174) channel in Discord for details on this and prior releases.
* Install the [Sui Wallet Browser Extension](../explore/wallet-browser.md) to create NFTs, transfer coins, and carry out common transactions in a Chrome tab.

For a complete view of all changes in the Sui `devnet` branch, see:
Expand Down
2 changes: 1 addition & 1 deletion doc/src/navconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@
"fileName": "build/sui-json"
},
{
"label": "See Sui JSON-RPC API reference",
"label": "See JSON-RPC API Reference",
"link": "https://docs.sui.io/sui-jsonrpc",
"external": true
},
Expand Down
16 changes: 8 additions & 8 deletions doc/src/siteconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -126,14 +126,18 @@
"name": "See what's New",
"sublist": [
{
"name": "Apply to be a Validator",
"url": "https://sui.io/resources-sui/validator-registration-open/",
"external": true
"name": "Make Rust SDK Calls",
"url": "/build/rust-sdk"
},
{
"name": "Use Almost Any OS",
"name": "Run Windows, Linux, macOS",
"url": "/build/install#supported-oses"
},
{
"name": "Apply to be a Validator",
"url": "https://sui.io/resources-sui/validator-registration-open/",
"external": true
},
{
"name": "Try Sui Wallet Browser Extension",
"url": "/explore/wallet-browser"
Expand All @@ -147,10 +151,6 @@
"name": "Use Move VSCode Plugin",
"url": "https://sui.io/resources-sui/announcing-enhanced-move-vs-code-plugin",
"external": true
},
{
"name": "Run a Fullnode",
"url": "/build/fullnode"
}
]
},
Expand Down

0 comments on commit 7c3dc6b

Please sign in to comment.