From 18ed14f1a9a95623515066bbcb29619fe8a6ec00 Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Wed, 20 Sep 2023 15:40:29 -0500 Subject: [PATCH] More updates to old CLI versions (#575) * docs: fixing a link to create a new issue for Soroban CLI * docs: Updating the `soroban` usage for `v20.0.0-rc2` * docs: updating link to auto-generated cli docs * docs: Updating tutorials to point to `v20` tag of the examples repo * docs: Updating "migrating from evm" article to use `v20.0.0-rc2` examples * docs: changing to `v20.0.0-rc2` examples repo in getting started section --- docs/TUTORIAL-TEMPLATE.mdx | 10 ++++----- docs/advanced-tutorials/atomic-multi-swap.mdx | 4 ++-- docs/advanced-tutorials/atomic-swap.mdx | 12 +++++----- docs/advanced-tutorials/custom-account.mdx | 10 ++++----- docs/advanced-tutorials/fuzzing.mdx | 22 +++++++++---------- docs/advanced-tutorials/liquidity-pool.mdx | 14 ++++++------ docs/advanced-tutorials/single-offer-sale.mdx | 6 ++--- .../stellar-asset-contract.mdx | 2 +- docs/advanced-tutorials/timelock.mdx | 4 ++-- docs/advanced-tutorials/tokens.mdx | 10 ++++----- docs/basic-tutorials/alloc.mdx | 10 ++++----- docs/basic-tutorials/auth.mdx | 12 +++++----- docs/basic-tutorials/cross-contract-call.mdx | 10 ++++----- docs/basic-tutorials/custom-types.mdx | 10 ++++----- docs/basic-tutorials/deployer.mdx | 10 ++++----- docs/basic-tutorials/errors.mdx | 10 ++++----- docs/basic-tutorials/events.mdx | 10 ++++----- docs/basic-tutorials/logging.mdx | 10 ++++----- docs/basic-tutorials/upgrading-contracts.mdx | 4 ++-- docs/basic-tutorials/wasm-metadata.mdx | 2 +- .../introduction-to-solidity-and-rust.mdx | 2 +- .../smart-contract-deployment.mdx | 4 ++-- docs/getting-started/setup.mdx | 6 ++--- docs/getting-started/storing-data.mdx | 4 ++-- docs/reference/soroban-cli.mdx | 4 ++-- 25 files changed, 101 insertions(+), 101 deletions(-) diff --git a/docs/TUTORIAL-TEMPLATE.mdx b/docs/TUTORIAL-TEMPLATE.mdx index 89eaae42..5c4315a2 100644 --- a/docs/TUTORIAL-TEMPLATE.mdx +++ b/docs/TUTORIAL-TEMPLATE.mdx @@ -16,17 +16,17 @@ Place each link definition at the bottom of the section it (first) is used In ::: -[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v0.9.2 -[example demonstrates]: https://github.com/stellar/soroban-examples/tree/v0.9.2/hello_world +[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2 +[example demonstrates]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/hello_world [other example]: getting-started/ ## Run the Example First go through the [Setup] process to get your development environment -configured, then clone the `v0.9.2` tag of `soroban-examples` repository: +configured, then clone the `v20.0.0-rc2` tag of `soroban-examples` repository: ```bash -git clone -b v0.9.2 https://github.com/stellar/soroban-examples +git clone -b v20.0.0-rc2 https://github.com/stellar/soroban-examples ``` Or, skip the development environment setup and open this example in @@ -67,7 +67,7 @@ impl HelloContract { mod test; ``` -Ref: https://github.com/stellar/soroban-examples/tree/v0.9.2/hello_world +Ref: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/hello_world ## How it Works diff --git a/docs/advanced-tutorials/atomic-multi-swap.mdx b/docs/advanced-tutorials/atomic-multi-swap.mdx index 9d86a345..a2f1aa4c 100644 --- a/docs/advanced-tutorials/atomic-multi-swap.mdx +++ b/docs/advanced-tutorials/atomic-multi-swap.mdx @@ -28,6 +28,6 @@ Follow the comments in the code for more information. [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][oigp] -[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v0.9.2 +[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2 [Atomic Swap]: atomic-swap.mdx -[atomic swap batching example]: https://github.com/stellar/soroban-examples/tree/v0.9.2/atomic_multiswap +[atomic swap batching example]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/atomic_multiswap diff --git a/docs/advanced-tutorials/atomic-swap.mdx b/docs/advanced-tutorials/atomic-swap.mdx index 4e7bcc10..ad65594f 100644 --- a/docs/advanced-tutorials/atomic-swap.mdx +++ b/docs/advanced-tutorials/atomic-swap.mdx @@ -30,18 +30,18 @@ Soroban token usage. [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][oigp] -[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v0.9.2 -[atomic swap example]: https://github.com/stellar/soroban-examples/tree/v0.9.2/atomic_swap +[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2 +[atomic swap example]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/atomic_swap ## Run the Example First go through the [Setup] process to get your development environment -configured, then clone the `v0.9.2` tag of `soroban-examples` repository: +configured, then clone the `v20.0.0-rc2` tag of `soroban-examples` repository: [Setup]: ../getting-started/setup.mdx ``` -git clone -b v0.9.2 https://github.com/stellar/soroban-examples +git clone -b v20.0.0-rc2 https://github.com/stellar/soroban-examples ``` Or, skip the development environment setup and open this example in [Gitpod][oigp]. @@ -131,7 +131,7 @@ fn move_token( } ``` -Ref: https://github.com/stellar/soroban-examples/tree/v0.9.2/atomic_swap +Ref: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/atomic_swap ## How it Works @@ -208,7 +208,7 @@ contract invocation. Open the [`atomic_swap/src/test.rs`] file to follow along. -[`atomic_swap/src/test.rs`]: https://github.com/stellar/soroban-examples/tree/v0.9.2/atomic_swap/src/test.rs +[`atomic_swap/src/test.rs`]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/atomic_swap/src/test.rs Refer to another examples for the general information on the test setup. diff --git a/docs/advanced-tutorials/custom-account.mdx b/docs/advanced-tutorials/custom-account.mdx index fd865181..8e3c21ae 100644 --- a/docs/advanced-tutorials/custom-account.mdx +++ b/docs/advanced-tutorials/custom-account.mdx @@ -49,19 +49,19 @@ around them yet beyond the Soroban SDK support. ::: [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][oigp] -[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v0.9.2 +[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2 -[custom account example]: https://github.com/stellar/soroban-examples/tree/v0.9.2/account +[custom account example]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/account ## Run the Example First go through the [Setup] process to get your development environment -configured, then clone the `v0.9.2` tag of `soroban-examples` repository: +configured, then clone the `v20.0.0-rc2` tag of `soroban-examples` repository: [Setup]: ../getting-started/setup.mdx ``` -git clone -b v0.9.2 https://github.com/stellar/soroban-examples +git clone -b v20.0.0-rc2 https://github.com/stellar/soroban-examples ``` Or, skip the development environment setup and open this example in [Gitpod][oigp]. @@ -319,7 +319,7 @@ function we don't exceed the spending limits. Open the [`account/src/test.rs`] file to follow along. -[`account/src/test.rs`]: https://github.com/stellar/soroban-examples/tree/v0.9.2/account/src/test.rs +[`account/src/test.rs`]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/account/src/test.rs Refer to another examples for the general information on the test setup. diff --git a/docs/advanced-tutorials/fuzzing.mdx b/docs/advanced-tutorials/fuzzing.mdx index 18eef015..026ab8db 100644 --- a/docs/advanced-tutorials/fuzzing.mdx +++ b/docs/advanced-tutorials/fuzzing.mdx @@ -25,24 +25,24 @@ with the [`proptest`] and [`proptest-arbitrary-interop`] crates. It builds on the [timelock example]. [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][oigp] -[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v0.9.2 +[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2 -[fuzzing example]: https://github.com/stellar/soroban-examples/tree/v0.9.2/fuzzing +[fuzzing example]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/fuzzing [`cargo-fuzz`]: https://docs.rs/cargo-fuzz [`arbitrary`]: https://docs.rs/arbitrary [`proptest`]: https://docs.rs/proptest [`proptest-arbitrary-interop`]: https://docs.rs/proptest-arbitrary-interop -[timelock example]: https://github.com/stellar/soroban-examples/tree/v0.9.2/timelock +[timelock example]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/timelock ## Run the Example First go through the [setup] process to get your development environment -configured, then clone the `v0.9.2` tag of `soroban-examples` repository: +configured, then clone the `v20.0.0-rc2` tag of `soroban-examples` repository: [setup]: ../getting-started/setup.mdx ```bash -git clone -b v0.9.2 https://github.com/stellar/soroban-examples +git clone -b v20.0.0-rc2 https://github.com/stellar/soroban-examples ``` You will also need the `cargo-fuzz` tool, and to run `cargo-fuzz` you will need @@ -142,7 +142,7 @@ fuzzing. The example used for this tutorial is based on the [`timelock`] example program, with some changes to demonstrate fuzzing. -[`timelock`]: https://github.com/stellar/soroban-examples/tree/v0.9.2/timelock +[`timelock`]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/timelock The contract, `ClaimableBalanceContract`, allows one party to deposit an arbitrary quantity of a token to the contract, specifying additionally: the @@ -225,8 +225,8 @@ Our `soroban-examples/fuzzing` directory looks like There are special considerations to note in the configuration of both the [contract's manifest] and the [fuzzing crate's manifest]. -[contract's manifest]: https://github.com/stellar/soroban-examples/tree/v0.9.2/fuzzing/Cargo.toml -[fuzzing crate's manifest]: https://github.com/stellar/soroban-examples/tree/v0.9.2/fuzzing/fuzz/Cargo.toml +[contract's manifest]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/fuzzing/Cargo.toml +[fuzzing crate's manifest]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/fuzzing/fuzz/Cargo.toml Within the contract's manifest one must specificy the crate type as both "cdylib" and "rlib": @@ -297,7 +297,7 @@ features = ["testutils"] First let's look at [`fuzz_target_1.rs`]. This fuzz test does two things: it first deposits an arbitrary amount, then it claims an arbitrary amount. -[`fuzz_target_1.rs`]: https://github.com/stellar/soroban-examples/tree/v0.9.2/fuzzing/fuzz/fuzz_targets/fuzz_target_1.rs +[`fuzz_target_1.rs`]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/fuzzing/fuzz/fuzz_targets/fuzz_target_1.rs Again, you can run this fuzzer from the `soroban-examples/fuzzing` directory with the following command: @@ -780,7 +780,7 @@ turn that feature on. The [`fuzz_target_2.rs`] example, demonstrates the use of `SorobanArbitrary`, the advancement of time, and more advanced fuzzing techniques. -[`fuzz_target_2.rs`]: https://github.com/stellar/soroban-examples/tree/v0.9.2/fuzzing/fuzz/fuzz_targets/fuzz_target_2.rs +[`fuzz_target_2.rs`]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/fuzzing/fuzz/fuzz_targets/fuzz_target_2.rs This fuzz test takes a much more complex input, where some of the values are user-defined types exported from the contract under test. This test is @@ -948,4 +948,4 @@ convert fuzz tests to property tests to help prevent regressions. The [`proptest.rs`] file is a translation of `fuzz_target_1.rs` to a property test. -[`proptest.rs`]: https://github.com/stellar/soroban-examples/tree/v0.9.2/fuzzing/src/proptest.rs +[`proptest.rs`]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/fuzzing/src/proptest.rs diff --git a/docs/advanced-tutorials/liquidity-pool.mdx b/docs/advanced-tutorials/liquidity-pool.mdx index 91621119..c1742656 100644 --- a/docs/advanced-tutorials/liquidity-pool.mdx +++ b/docs/advanced-tutorials/liquidity-pool.mdx @@ -50,17 +50,17 @@ here.](https://developers.stellar.org/docs/encyclopedia/liquidity-on-stellar-sde [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][oigp] -[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v0.9.2 -[liquidity pool example]: https://github.com/stellar/soroban-examples/tree/v0.9.2/liquidity_pool -[source code]: https://github.com/stellar/soroban-examples/blob/v0.9.2/liquidity_pool/src/lib.rs#L143 +[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2 +[liquidity pool example]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/liquidity_pool +[source code]: https://github.com/stellar/soroban-examples/blob/v20.0.0-rc2/liquidity_pool/src/lib.rs#L143 ## Run the Example First go through the [Setup] process to get your development environment -configured, then clone the `v0.9.2` tag of `soroban-examples` repository: +configured, then clone the `v20.0.0-rc2` tag of `soroban-examples` repository: ```bash -git clone -b v0.9.2 https://github.com/stellar/soroban-examples +git clone -b v20.0.0-rc2 https://github.com/stellar/soroban-examples ``` Or, skip the development environment setup and open this example in @@ -473,7 +473,7 @@ pub fn create_contract( -Ref: https://github.com/stellar/soroban-examples/tree/v0.9.2/liquidity_pool +Ref: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/liquidity_pool ## How it Works @@ -911,7 +911,7 @@ fn test() { } ``` -[`liquidity_pool/src/test.rs`]: https://github.com/stellar/soroban-examples/blob/v0.9.2/liquidity_pool/src/test.rs +[`liquidity_pool/src/test.rs`]: https://github.com/stellar/soroban-examples/blob/v20.0.0-rc2/liquidity_pool/src/test.rs In any test the first thing that is always required is an `Env`, which is the Soroban environment that the contract will run in. diff --git a/docs/advanced-tutorials/single-offer-sale.mdx b/docs/advanced-tutorials/single-offer-sale.mdx index 96dadb87..0eb47a17 100644 --- a/docs/advanced-tutorials/single-offer-sale.mdx +++ b/docs/advanced-tutorials/single-offer-sale.mdx @@ -28,7 +28,7 @@ a seller to set up an offer to sell token A for token B to multiple buyers. The comments in the [source code] explain how the contract should be used. [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][oigp] -[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v0.9.2 +[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2 -[single offer sale example]: https://github.com/stellar/soroban-examples/tree/v0.9.2/single_offer -[source code]: https://github.com/stellar/soroban-examples/blob/v0.9.2/single_offer/src/lib.rs +[single offer sale example]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/single_offer +[source code]: https://github.com/stellar/soroban-examples/blob/v20.0.0-rc2/single_offer/src/lib.rs diff --git a/docs/advanced-tutorials/stellar-asset-contract.mdx b/docs/advanced-tutorials/stellar-asset-contract.mdx index 3af4a6a1..ae898fc0 100644 --- a/docs/advanced-tutorials/stellar-asset-contract.mdx +++ b/docs/advanced-tutorials/stellar-asset-contract.mdx @@ -206,4 +206,4 @@ implementation. This interface can be found in the [SDK]. It extends the common [token interface](tokens.mdx). -[SDK]: https://github.com/stellar/rs-soroban-sdk/blob/v0.9.2/soroban-sdk/src/token.rs +[SDK]: https://github.com/stellar/rs-soroban-sdk/blob/v20.0.0-rc2/soroban-sdk/src/token.rs diff --git a/docs/advanced-tutorials/timelock.mdx b/docs/advanced-tutorials/timelock.mdx index 2fd528fc..baa4e97c 100644 --- a/docs/advanced-tutorials/timelock.mdx +++ b/docs/advanced-tutorials/timelock.mdx @@ -26,10 +26,10 @@ greatly simplified claimable balance similar to the [claimable balance] feature available on Stellar. [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][oigp] -[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v0.9.2 +[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2 The contract accepts deposits of an amount of a token, and allows other users to claim it before or after a time point. -[timelock example]: https://github.com/stellar/soroban-examples/tree/v0.9.2/timelock +[timelock example]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/timelock [claimable balance]: https://developers.stellar.org/docs/glossary/claimable-balance diff --git a/docs/advanced-tutorials/tokens.mdx b/docs/advanced-tutorials/tokens.mdx index f99e9a89..9b1de054 100644 --- a/docs/advanced-tutorials/tokens.mdx +++ b/docs/advanced-tutorials/tokens.mdx @@ -26,17 +26,17 @@ the [Token Interface]. [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][oigp] -[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v0.9.2 -[token example]: https://github.com/stellar/soroban-examples/tree/v0.9.2/token +[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2 +[token example]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/token [Token Interface]: ../reference/interfaces/token-interface.mdx ## Run the Example First go through the [Setup] process to get your development environment -configured, then clone the `v0.9.2` tag of `soroban-examples` repository: +configured, then clone the `v20.0.0-rc2` tag of `soroban-examples` repository: ```bash -git clone -b v0.9.2 https://github.com/stellar/soroban-examples +git clone -b v20.0.0-rc2 https://github.com/stellar/soroban-examples ``` Or, skip the development environment setup and open this example in @@ -530,7 +530,7 @@ pub enum DataKey { -Ref: https://github.com/stellar/soroban-examples/tree/v0.9.2/token +Ref: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/token ## How it Works diff --git a/docs/basic-tutorials/alloc.mdx b/docs/basic-tutorials/alloc.mdx index e73ce5e6..5ad661a4 100644 --- a/docs/basic-tutorials/alloc.mdx +++ b/docs/basic-tutorials/alloc.mdx @@ -23,21 +23,21 @@ description: Use the allocator feature in a smart contract. The [allocator example] demonstrates how to utilize the allocator feature when writing a contract. -[allocator example]: https://github.com/stellar/soroban-examples/tree/v0.9.2/alloc +[allocator example]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/alloc [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][oigp] -[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v0.9.2 +[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2 The `soroban-sdk` crate provides a lightweight bump-pointer allocator which can be used to emulate heap memory allocation in a Wasm smart contract. ## Run the Example -First go through the [Setup] process to get your development environment configured, then clone the `v0.9.2` tag of `soroban-examples` repository: +First go through the [Setup] process to get your development environment configured, then clone the `v20.0.0-rc2` tag of `soroban-examples` repository: [setup]: ../getting-started/setup.mdx ``` -git clone -b v0.9.2 https://github.com/stellar/soroban-examples +git clone -b v20.0.0-rc2 https://github.com/stellar/soroban-examples ``` Or, skip the development environment setup and open this example in [Gitpod][oigp]. @@ -96,7 +96,7 @@ impl AllocContract { } ``` -Ref: https://github.com/stellar/soroban-examples/tree/v0.9.2/alloc +Ref: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/alloc ## How it Works diff --git a/docs/basic-tutorials/auth.mdx b/docs/basic-tutorials/auth.mdx index 0a6e31c0..7fce14c1 100644 --- a/docs/basic-tutorials/auth.mdx +++ b/docs/basic-tutorials/auth.mdx @@ -27,20 +27,20 @@ authorization using the Soroban Host-managed auth framework. This example is an extension of the [storing data example]. [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][oigp] -[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v0.9.2 +[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2 [storing data example]: ../getting-started/storing-data.mdx -[auth example]: https://github.com/stellar/soroban-examples/tree/v0.9.2/auth +[auth example]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/auth ## Run the Example First go through the [Setup] process to get your development environment -configured, then clone the `v0.9.2` tag of `soroban-examples` repository: +configured, then clone the `v20.0.0-rc2` tag of `soroban-examples` repository: [Setup]: ../getting-started/setup.mdx ``` -git clone -b v0.9.2 https://github.com/stellar/soroban-examples +git clone -b v20.0.0-rc2 https://github.com/stellar/soroban-examples ``` Or, skip the development environment setup and open this example in [Gitpod][oigp]. @@ -113,7 +113,7 @@ impl IncrementContract { } ``` -Ref: https://github.com/stellar/soroban-examples/tree/v0.9.2/auth +Ref: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/auth ## How it Works @@ -188,7 +188,7 @@ user.require_auth_for_args((value,).into_val(&env)); Open the [`auth/src/test.rs`] file to follow along. -[`auth/src/test.rs`]: https://github.com/stellar/soroban-examples/tree/v0.9.2/auth/src/test.rs +[`auth/src/test.rs`]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/auth/src/test.rs ```rust title="auth/src/test.rs" fn test() { diff --git a/docs/basic-tutorials/cross-contract-call.mdx b/docs/basic-tutorials/cross-contract-call.mdx index 36ddda69..d49423bf 100644 --- a/docs/basic-tutorials/cross-contract-call.mdx +++ b/docs/basic-tutorials/cross-contract-call.mdx @@ -25,7 +25,7 @@ The [cross contract call example] demonstrates how to call a contract from another contract. [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][oigp] -[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v0.9.2 +[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2 :::info @@ -37,17 +37,17 @@ appreciated [here](https://github.com/stellar/rs-soroban-sdk/issues/new/choose). ::: -[cross contract call example]: https://github.com/stellar/soroban-examples/tree/v0.9.2/cross_contract_calls +[cross contract call example]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/cross_contract_calls ## Run the Example First go through the [Setup] process to get your development environment -configured, then clone the `v0.9.2` tag of `soroban-examples` repository: +configured, then clone the `v20.0.0-rc2` tag of `soroban-examples` repository: [Setup]: ../getting-started/setup.mdx ``` -git clone -b v0.9.2 https://github.com/stellar/soroban-examples +git clone -b v20.0.0-rc2 https://github.com/stellar/soroban-examples ``` Or, skip the development environment setup and open this example in [Gitpod][oigp]. @@ -100,7 +100,7 @@ impl ContractB { } ``` -Ref: https://github.com/stellar/soroban-examples/tree/v0.9.2/cross_contract +Ref: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/cross_contract ## How it Works diff --git a/docs/basic-tutorials/custom-types.mdx b/docs/basic-tutorials/custom-types.mdx index 8d79ae28..7855b56f 100644 --- a/docs/basic-tutorials/custom-types.mdx +++ b/docs/basic-tutorials/custom-types.mdx @@ -21,19 +21,19 @@ description: Define your data structures. The [custom types example] demonstrates how to define your own data structures that can be stored on the ledger, or used as inputs and outputs to contract invocations. This example is an extension of the [storing data example]. [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][oigp] -[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v0.9.2 +[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2 -[custom types example]: https://github.com/stellar/soroban-examples/tree/v0.9.2/custom_types +[custom types example]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/custom_types [storing data example]: getting-started/storing-data.mdx ## Run the Example -First go through the [Setup] process to get your development environment configured, then clone the `v0.9.2` tag of `soroban-examples` repository: +First go through the [Setup] process to get your development environment configured, then clone the `v20.0.0-rc2` tag of `soroban-examples` repository: [Setup]: ../getting-started/setup.mdx ``` -git clone -b v0.9.2 https://github.com/stellar/soroban-examples +git clone -b v20.0.0-rc2 https://github.com/stellar/soroban-examples ``` Or, skip the development environment setup and open this example in [Gitpod][oigp]. @@ -94,7 +94,7 @@ impl IncrementContract { } ``` -Ref: https://github.com/stellar/soroban-examples/tree/v0.9.2/custom_types +Ref: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/custom_types ## How it Works diff --git a/docs/basic-tutorials/deployer.mdx b/docs/basic-tutorials/deployer.mdx index 8d6d2d5a..ad78ea81 100644 --- a/docs/basic-tutorials/deployer.mdx +++ b/docs/basic-tutorials/deployer.mdx @@ -27,7 +27,7 @@ Here we deploy a contract on behalf of any address and initialize it atomically. [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][oigp] -[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v0.9.2 +[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2 :::info @@ -36,17 +36,17 @@ tests deploy one with the other. ::: -[deployer example]: https://github.com/stellar/soroban-examples/tree/v0.9.2/deployer +[deployer example]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/deployer ## Run the Example First go through the [Setup] process to get your development environment -configured, then clone the `v0.9.2` tag of `soroban-examples` repository: +configured, then clone the `v20.0.0-rc2` tag of `soroban-examples` repository: [Setup]: ../getting-started/setup.mdx ``` -git clone -b v0.9.2 https://github.com/stellar/soroban-examples +git clone -b v20.0.0-rc2 https://github.com/stellar/soroban-examples ``` Or, skip the development environment setup and open this example in [Gitpod][oigp]. @@ -110,7 +110,7 @@ impl Deployer { } ``` -Ref: https://github.com/stellar/soroban-examples/tree/v0.9.2/deployer +Ref: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/deployer ## How it Works diff --git a/docs/basic-tutorials/errors.mdx b/docs/basic-tutorials/errors.mdx index 6cb6af4c..6478d2cc 100644 --- a/docs/basic-tutorials/errors.mdx +++ b/docs/basic-tutorials/errors.mdx @@ -26,20 +26,20 @@ contract that invokers of the contract can understand and handle. This example is an extension of the [storing data example]. [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][oigp] -[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v0.9.2 +[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2 -[errors example]: https://github.com/stellar/soroban-examples/tree/v0.9.2/errors +[errors example]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/errors [storing data example]: getting-started/storing-data.mdx ## Run the Example First go through the [Setup] process to get your development environment -configured, then clone the `v0.9.2` tag of `soroban-examples` repository: +configured, then clone the `v20.0.0-rc2` tag of `soroban-examples` repository: [Setup]: ../getting-started/setup.mdx ``` -git clone -b v0.9.2 https://github.com/stellar/soroban-examples +git clone -b v20.0.0-rc2 https://github.com/stellar/soroban-examples ``` Or, skip the development environment setup and open this example in [Gitpod][oigp]. @@ -123,7 +123,7 @@ impl IncrementContract { } ``` -Ref: https://github.com/stellar/soroban-examples/tree/v0.9.2/errors +Ref: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/errors ## How it Works diff --git a/docs/basic-tutorials/events.mdx b/docs/basic-tutorials/events.mdx index f53440c1..2072c3cf 100644 --- a/docs/basic-tutorials/events.mdx +++ b/docs/basic-tutorials/events.mdx @@ -22,20 +22,20 @@ The [events example] demonstrates how to publish events from a contract. This example is an extension of the [storing data example]. [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][oigp] -[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v0.9.2 +[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2 -[events example]: https://github.com/stellar/soroban-examples/tree/v0.9.2/events +[events example]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/events [storing data example]: getting-started/storing-data.mdx ## Run the Example First go through the [Setup] process to get your development environment -configured, then clone the `v0.9.2` tag of `soroban-examples` repository: +configured, then clone the `v20.0.0-rc2` tag of `soroban-examples` repository: [Setup]: ../getting-started/setup.mdx ``` -git clone -b v0.9.2 https://github.com/stellar/soroban-examples +git clone -b v20.0.0-rc2 https://github.com/stellar/soroban-examples ``` Or, skip the development environment setup and open this example in [Gitpod][oigp]. @@ -89,7 +89,7 @@ impl IncrementContract { } ``` -Ref: https://github.com/stellar/soroban-examples/tree/v0.9.2/events +Ref: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/events ## How it Works diff --git a/docs/basic-tutorials/logging.mdx b/docs/basic-tutorials/logging.mdx index 0d2fa841..ccd6ae8f 100644 --- a/docs/basic-tutorials/logging.mdx +++ b/docs/basic-tutorials/logging.mdx @@ -21,13 +21,13 @@ description: Use logs to debug smart contracts. The [logging example] demonstrates how to log for the purpose of debugging. [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][oigp] -[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v0.9.2 +[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2 Logs in contracts are only visible in tests, or when executing contracts using [`soroban-cli`]. Logs are only compiled into the contract if the `debug-assertions` Rust compiler option is enabled. -[logging example]: https://github.com/stellar/soroban-examples/tree/v0.9.2/hello_world +[logging example]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/hello_world :::tip @@ -50,12 +50,12 @@ example] for how to produce structured events. ## Run the Example First go through the [Setup] process to get your development environment -configured, then clone the `v0.9.2` tag of `soroban-examples` repository: +configured, then clone the `v20.0.0-rc2` tag of `soroban-examples` repository: [Setup]: ../getting-started/setup.mdx ``` -git clone -b v0.9.2 https://github.com/stellar/soroban-examples +git clone -b v20.0.0-rc2 https://github.com/stellar/soroban-examples ``` Or, skip the development environment setup and open this example in [Gitpod][oigp]. @@ -99,7 +99,7 @@ impl Contract { } ``` -Ref: https://github.com/stellar/soroban-examples/tree/v0.9.2/logging +Ref: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/logging ## How it Works diff --git a/docs/basic-tutorials/upgrading-contracts.mdx b/docs/basic-tutorials/upgrading-contracts.mdx index 70b3e754..9d50b103 100644 --- a/docs/basic-tutorials/upgrading-contracts.mdx +++ b/docs/basic-tutorials/upgrading-contracts.mdx @@ -21,9 +21,9 @@ description: Upgrade a WASM smart contract. The [upgradeable contract example] demonstrates how to upgrade a Wasm contract. [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][oigp] -[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v0.9.2 +[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2 -[upgradeable contract example]: https://github.com/stellar/soroban-examples/tree/v0.9.2/upgradeable_contract +[upgradeable contract example]: https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/upgradeable_contract ## Code diff --git a/docs/basic-tutorials/wasm-metadata.mdx b/docs/basic-tutorials/wasm-metadata.mdx index 415c2c0b..34d9a181 100644 --- a/docs/basic-tutorials/wasm-metadata.mdx +++ b/docs/basic-tutorials/wasm-metadata.mdx @@ -39,4 +39,4 @@ pub trait LiquidityPoolTrait {... ``` [contractmeta!]: https://docs.rs/soroban-sdk/0.9.2/soroban_sdk/macro.contractmeta.html -[liquidity pool example]: https://github.com/stellar/soroban-examples/blob/v0.9.2/liquidity_pool/src/lib.rs#L152-L155 +[liquidity pool example]: https://github.com/stellar/soroban-examples/blob/v20.0.0-rc2/liquidity_pool/src/lib.rs#L152-L155 diff --git a/docs/fundamentals-and-concepts/migrating-from-evm/introduction-to-solidity-and-rust.mdx b/docs/fundamentals-and-concepts/migrating-from-evm/introduction-to-solidity-and-rust.mdx index ffe183a9..2f99fbab 100644 --- a/docs/fundamentals-and-concepts/migrating-from-evm/introduction-to-solidity-and-rust.mdx +++ b/docs/fundamentals-and-concepts/migrating-from-evm/introduction-to-solidity-and-rust.mdx @@ -30,7 +30,7 @@ Or if you want to jump right in, you can open up our examples in a ready to go d [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][oigp] -[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v0.9.2 +[oigp]: https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2 # Summary diff --git a/docs/fundamentals-and-concepts/migrating-from-evm/smart-contract-deployment.mdx b/docs/fundamentals-and-concepts/migrating-from-evm/smart-contract-deployment.mdx index 36d0bc8b..f2fd396c 100644 --- a/docs/fundamentals-and-concepts/migrating-from-evm/smart-contract-deployment.mdx +++ b/docs/fundamentals-and-concepts/migrating-from-evm/smart-contract-deployment.mdx @@ -189,10 +189,10 @@ If you haven't already setup up the dev environment for Soroban, you can get sta This project requires using the `soroban_token_contract.wasm` file which you will need to import manually. -First, you will need to clone the `v0.9.2` tag of `soroban-examples` repository: +First, you will need to clone the `v20.0.0-rc2` tag of `soroban-examples` repository: ```bash -git clone -b v0.9.2 https://github.com/stellar/soroban-examples +git clone -b v20.0.0-rc2 https://github.com/stellar/soroban-examples ``` Then, navigate to the `soroban-examples/token` directory diff --git a/docs/getting-started/setup.mdx b/docs/getting-started/setup.mdx index 9b399531..681eca52 100644 --- a/docs/getting-started/setup.mdx +++ b/docs/getting-started/setup.mdx @@ -80,7 +80,7 @@ cargo install --locked --version 20.0.0-rc2 soroban-cli :::info Report issues and share feedback about the Soroban CLI -[here](https://github.com/stellar/soroban-cli/issues/new/choose). +[here](https://github.com/stellar/soroban-tools/issues/new/choose). ::: @@ -102,19 +102,19 @@ CLI Reference: https://github.com/stellar/soroban-tools/tree/main/docs/soroban-c Usage: soroban [OPTIONS] Commands: + completion Print shell completion code for the specified shell contract Tools for smart contract developers config Read and update config events Watch the network for contract events lab Experiment with early features and expert tools version Print version information - completion Print shell completion code for the specified shell Options: --global Use global config -f, --filter-logs Filter logs output. To turn on "soroban_cli::log::footprint=debug" or off "=off". Can also use env var `RUST_LOG` -q, --quiet Do not write logs to stderr including `INFO` -v, --verbose Log DEBUG events - --very-verbose Log DEBUG and TRACE events + --very-verbose Log DEBUG and TRACE events [aliases: vv] --list List installed plugins. E.g. `soroban-hello` -h, --help Print help (see more with '--help') -V, --version Print version diff --git a/docs/getting-started/storing-data.mdx b/docs/getting-started/storing-data.mdx index 682984a3..0b37211d 100644 --- a/docs/getting-started/storing-data.mdx +++ b/docs/getting-started/storing-data.mdx @@ -26,8 +26,8 @@ import TabItem from "@theme/TabItem"; Now that we've built a basic Hello World example to see the rough structure of Soroban contracts, we'll write a simple contract that stores and retrieves data. This will help you see the basics of Soroban's storage system. We'll also organize the two contracts as one combined project using a Cargo Workspace, which is a common pattern for Soroban projects. -This is going to follow along with the [increment example](https://github.com/stellar/soroban-examples/tree/v0.9.2/increment), which has a single function that increments an internal counter and returns the value. If you want to see a working example, [try it in -GitPod](https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v0.9.2). +This is going to follow along with the [increment example](https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2/increment), which has a single function that increments an internal counter and returns the value. If you want to see a working example, [try it in +GitPod](https://gitpod.io/#https://github.com/stellar/soroban-examples/tree/v20.0.0-rc2). This tutorial assumes that you've already completed the previous steps in Getting Started: [Setup](./setup.mdx) and [Hello World](./hello-world.mdx). diff --git a/docs/reference/soroban-cli.mdx b/docs/reference/soroban-cli.mdx index 8e81ced0..f7f2a2d8 100644 --- a/docs/reference/soroban-cli.mdx +++ b/docs/reference/soroban-cli.mdx @@ -9,14 +9,14 @@ Soroban CLI is the command line interface to Soroban. It allows you to build, de Install Soroban CLI as explained in [Setup](../getting-started/setup). Auto-generated comprehensive reference documentation is available at: -https://github.com/stellar/soroban-tools/blob/v0.8.0/docs/soroban-cli-full-docs.md +https://github.com/stellar/soroban-tools/blob/v20.0.0-rc2/docs/soroban-cli-full-docs.md Subscribe to releases on the GitHub repository: https://github.com/stellar/soroban-tools :::info -Report issues and share feedback about Soroban CLI here: +Report issues and share feedback about Soroban CLI here: https://github.com/stellar/soroban-tools/issues/new/choose :::