Fix SDK rust install instructions + odds and ends

iotaledger · Jul 24, 2023 · 09a8db2 · 09a8db2
1 parent 922519f
commit 09a8db2
Show file tree

Hide file tree

Showing 9 changed files with 28 additions and 11 deletions.
diff --git a/shimmer/develop/how-tos/backup_security.md b/shimmer/develop/how-tos/backup_security.md
@@ -42,7 +42,7 @@ You can create a new Stronghold snapshot on the fly to allow a user to leave you
 
 ## How to Rekey a Stronghold/Password Rotation
 
-To change a Stronghold password, you read a snapshot into a vault and then write it out with a new encryption password. You can view this [code](https://github.com/iotaledger/wallet.rs/blob/d1b8893d73aae35dfcf7c5c8006e2177988d25d0/src/stronghold.rs#L436-L451) for the source.
+To change a Stronghold password, you read a snapshot into a vault and then write it out with a new encryption password. You can view this [code](https://github.com/iotaledger/iota-sdk/blob/develop/sdk/src/client/stronghold/mod.rs#L296-L409) for the source.
 
 :::note
 

diff --git a/shimmer/docs/introduction-docs/docs/explanations/faq.md b/shimmer/docs/introduction-docs/docs/explanations/faq.md
@@ -8,8 +8,7 @@ keywords:
   - transactions
   - hornet
   - libraries
-  - wallet.rs
-  - iota.rs
+  - iota-sdk
   - Firefly
   - explanation
 ---
@@ -22,6 +21,8 @@ TODO: Update for Stardust/Shimmer.
 
 ## Which Libraries are Available for Stardust?
 
+You can use the [IOTA-SDK](../../../iota-sdk/docs/welcome.md) to interact with nodes running the Stardust protocol.
+
 ## What is Dust Protection and How Does it Work?
 
 ## When is a Transaction on the Network Considered Final/Irreversible?

diff --git a/shimmer/docs/iota-sdk/docs/getting-started/rust.mdx b/shimmer/docs/iota-sdk/docs/getting-started/rust.mdx
@@ -88,13 +88,29 @@ set OPENSSL_DIR="C:\Program Files\OpenSSL-Win64"
 
 ### Install the SDK Using Cargo
 
-To start using the IOTA SDK in your Rust project, you can include the following dependencies in your `Cargo.toml` file:
+<Tabs>
+<TabItem value="cargo" label="Cargo add">
+
+To start using the IOTA SDK in your Rust project, you can include it as a dependencies in your project's `Cargo.toml` by running:
+
+```bash
+cargo add iota-sdk
+```
+
+</TabItem>
+
+<TabItem value="manual" label="Cargo.toml">
+
+To start using the IOTA SDK in your Rust project, you can include the following line under `dependencies` in your `Cargo.toml`:
 
 ```toml
 [dependencies]
-iota-sdk = { branch = "develop" }
+iota-sdk = "1.0.0"
 ```
 
+</TabItem>
+</Tabs>
+
 ### Build the SDK from Source
 
 1. Download the repository to any directory you choose:

diff --git a/shimmer/docs/iota.js/admonitions/_iotars.md b/shimmer/docs/iota.js/admonitions/_iotars.md
@@ -1,6 +1,6 @@
 :::info Iota.rs
 
-Though this library is functionally complete, the [iota.rs](https://wiki.iota.org/iota.rs/welcome) library is maintained
+Though this library is functionally complete, the [IOTA SDK](https://wiki.iota.org/shimmer/iota-sdk/welcome) is maintained
 by more contributors, more performant and
 has the latest features.
 

diff --git a/shimmer/docs/iota.js/admonitions/_wallet_transaction_recommendation.md b/shimmer/docs/iota.js/admonitions/_wallet_transaction_recommendation.md
@@ -1,7 +1,7 @@
 :::info
 
 Though it is possible to send transactions with iota.rs, we strongly recommend that you use the official
-[wallet.rs](https://wiki.iota.org/wallet.rs/welcome) library together with the
+[IOTA SDK](https://wiki.iota.org/shimmer/iota-sdk/welcome) together with the
 [stronghold.rs](https://wiki.iota.org/stronghold.rs/welcome) enclave for value-based transfers. This combination
 incorporates the best security practices while dealing with seeds, related addresses, and `UTXO`.
 

diff --git a/shimmer/docs/iota.js/docs/welcome.md b/shimmer/docs/iota.js/docs/welcome.md
@@ -14,7 +14,7 @@ keywords:
 :::caution
 
 This is documentation for iota.js, which is no longer actively maintained.
-For up-to-date documentation, see the the documentation for its successor the [IOTA SDK](/iota-sdk/welcome).
+For up-to-date documentation, see the documentation for its successor the [IOTA SDK](/iota-sdk/welcome).
 
 :::
 

diff --git a/shimmer/docs/iota.rs/docs/welcome.md b/shimmer/docs/iota.rs/docs/welcome.md
@@ -14,7 +14,7 @@ keywords:
 :::caution
 
 This is documentation for iota.rs, which is no longer actively maintained.
-For up-to-date documentation, see the the documentation for its successor the [IOTA SDK](/iota-sdk/welcome).
+For up-to-date documentation, see the documentation for its successor the [IOTA SDK](/iota-sdk/welcome).
 
 :::
 

diff --git a/shimmer/docs/wallet.rs/docs/welcome.md b/shimmer/docs/wallet.rs/docs/welcome.md
@@ -15,7 +15,7 @@ keywords:
 :::caution
 
 This is documentation for wallet.rs, which is no longer actively maintained.
-For up-to-date documentation, see the the documentation for its successor the [IOTA SDK](/iota-sdk/welcome).
+For up-to-date documentation, see the documentation for its successor the [IOTA SDK](/iota-sdk/welcome).
 
 :::
 

diff --git a/shimmer/learn/token/buying.md b/shimmer/learn/token/buying.md
@@ -13,4 +13,4 @@ You can buy Shimmer tokens currently on the following exchanges and marketplaces
 - [Soonaverse](https://soonaverse.com/tokens/all): Buy with IOTA Tokens
 - [Iotabee](https://iotabee.com/swap): Swap IOTA for SMR
 
-If you are an exchange that would like to integrate Shimmer, take a look at our [exchange guide](/wallet.rs/how_tos/exchange_guide).
+If you are an exchange that would like to integrate Shimmer, take a look at our [exchange guide](iota-sdk/how-tos/exchange-guide).