Skip to content

Commit

Permalink
update rust sdk doc (#9324)
Browse files Browse the repository at this point in the history
  • Loading branch information
0xmigo authored Jul 28, 2023
1 parent 206f529 commit 3908ec5
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
8 changes: 7 additions & 1 deletion developer-docs-site/docs/sdks/rust-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,18 @@ slug: "rust-sdk"

### Installing Rust SDK

Aptos provides an official Rust SDK in the [Aptos-core GitHub](https://github.com/aptos-labs/aptos-core/tree/main/sdk) repository. To use the Rust SDK, add the following dependency on the git repo directly, like this:
Aptos provides an official Rust SDK in the [Aptos-core GitHub](https://github.com/aptos-labs/aptos-core/tree/main/sdk) repository. To use the Rust SDK, add the following dependency and patches on the git repo directly, like this:

```toml
[dependencies]
aptos-sdk = { git = "https://github.com/aptos-labs/aptos-core", branch = "devnet" }

[patch.crates-io]
merlin = { git = "https://github.com/aptos-labs/merlin" }
```



The source code for the official Rust SDK is available in the [aptos-core GitHub repository](https://github.com/aptos-labs/aptos-core/tree/main/sdk).

## Using Rust SDK
Expand Down
3 changes: 3 additions & 0 deletions sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ This SDK provides all the necessary components for building on top of the Aptos
* `transaction_builder` - Includes helpers for constructing transactions
* `types` - Includes types for Aptos on-chain data structures

## Installing Rust SDK
Please refer to [Rust SDK Doc](https://aptos.dev/sdks/rust-sdk/) for details on how to install the Rust SDK.

## License

Aptos Core is licensed as [Apache 2.0](https://github.com/aptos-labs/aptos-core/blob/main/LICENSE).

0 comments on commit 3908ec5

Please sign in to comment.