From 02b46acc7e8bdb19c3f359e09f2ca5f3b0b25bc8 Mon Sep 17 00:00:00 2001 From: Jane Wang Date: Thu, 20 Jun 2024 14:13:33 -0400 Subject: [PATCH] Update CLI commands in CLI guide (#702) Co-authored-by: Jane Wang --- docs/smart-contracts/guides/cli/README.mdx | 2 +- docs/smart-contracts/guides/cli/deploy-contract.mdx | 4 ++-- .../guides/cli/deploy-stellar-asset-contract.mdx | 6 +++--- .../smart-contracts/guides/cli/extend-contract-instance.mdx | 2 +- docs/smart-contracts/guides/cli/extend-contract-storage.mdx | 4 ++-- docs/smart-contracts/guides/cli/extend-contract-wasm.mdx | 4 ++-- docs/smart-contracts/guides/cli/install-deploy.mdx | 2 +- docs/smart-contracts/guides/cli/install-wasm.mdx | 4 ++-- .../guides/cli/restore-contract-instance.mdx | 6 +++--- .../smart-contracts/guides/cli/restore-contract-storage.mdx | 4 ++-- docs/tools/developer-tools.mdx | 4 ++-- 11 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/smart-contracts/guides/cli/README.mdx b/docs/smart-contracts/guides/cli/README.mdx index 43943e489..7fd20fd95 100644 --- a/docs/smart-contracts/guides/cli/README.mdx +++ b/docs/smart-contracts/guides/cli/README.mdx @@ -3,6 +3,6 @@ title: Stellar CLI hide_table_of_contents: true --- -The [Stellar CLI] is a crucial tool for developers to use while creating and interacting with Soroban smart contracts. +The [Stellar CLI] is a crucial tool for developers to use while creating and interacting with Stellar smart contracts. [stellar cli]: ../../../tools/developer-tools.mdx#cli diff --git a/docs/smart-contracts/guides/cli/deploy-contract.mdx b/docs/smart-contracts/guides/cli/deploy-contract.mdx index 103c3294a..03260d51d 100644 --- a/docs/smart-contracts/guides/cli/deploy-contract.mdx +++ b/docs/smart-contracts/guides/cli/deploy-contract.mdx @@ -3,10 +3,10 @@ title: Deploy a Contract from Installed Wasm Bytecode hide_table_of_contents: true --- -To deploy an instance of a compiled smart contract that has already been installed onto the Stellar network, use the `soroban contract deploy` command: +To deploy an instance of a compiled smart contract that has already been installed onto the Stellar network, use the `stellar contract deploy` command: ```bash -soroban contract deploy \ +stellar contract deploy \ --source S... \ --network testnet \ --wasm-hash diff --git a/docs/smart-contracts/guides/cli/deploy-stellar-asset-contract.mdx b/docs/smart-contracts/guides/cli/deploy-stellar-asset-contract.mdx index 1f13d36c5..92a8db00b 100644 --- a/docs/smart-contracts/guides/cli/deploy-stellar-asset-contract.mdx +++ b/docs/smart-contracts/guides/cli/deploy-stellar-asset-contract.mdx @@ -14,7 +14,7 @@ The Stellar Asset Contract can be deployed for any possible Stellar asset, eithe To perform the deploy, use the following command: ```bash -soroban contract asset deploy \ +stellar contract asset deploy \ --source S... \ --network testnet \ --asset USDC:GCYEIQEWOCTTSA72VPZ6LYIZIK4W4KNGJR72UADIXUXG45VDFRVCQTYE @@ -25,7 +25,7 @@ The `asset` argument corresponds to the symbol and it's issuer address, which is The same can be done for the native [Lumens] asset: ```bash -soroban contract asset deploy \ +stellar contract asset deploy \ --source S... \ --network testnet \ --asset native @@ -40,7 +40,7 @@ Deploying the native asset will fail on testnet or mainnet as a Stellar Asset Co For any asset, the contract address can be fetched with: ```bash -soroban contract id asset \ +stellar contract id asset \ --source S... \ --network testnet \ --asset native diff --git a/docs/smart-contracts/guides/cli/extend-contract-instance.mdx b/docs/smart-contracts/guides/cli/extend-contract-instance.mdx index 8148c2f48..52e2334a6 100644 --- a/docs/smart-contracts/guides/cli/extend-contract-instance.mdx +++ b/docs/smart-contracts/guides/cli/extend-contract-instance.mdx @@ -6,7 +6,7 @@ hide_table_of_contents: true You can use the Stellar CLI to extend the TTL of a contract instance like so: ```bash -soroban contract extend \ +stellar contract extend \ --source S... \ --network testnet \ --id C... \ diff --git a/docs/smart-contracts/guides/cli/extend-contract-storage.mdx b/docs/smart-contracts/guides/cli/extend-contract-storage.mdx index 0f3c6bf05..28026ec26 100644 --- a/docs/smart-contracts/guides/cli/extend-contract-storage.mdx +++ b/docs/smart-contracts/guides/cli/extend-contract-storage.mdx @@ -6,7 +6,7 @@ hide_table_of_contents: true You can use the Stellar CLI to extend the TTL of a contract's persistent storage entry. For a storage entry that uses a simple `Symbol` as its storage key, you can run a command like so: ```bash -soroban contract extend \ +stellar contract extend \ --source S... \ --network testnet \ --id C... \ @@ -20,7 +20,7 @@ This example uses 535,679 ledgers as the new archival TTL. This is the maximum a If your storage entry uses a more advanced storage key, such as `Balance(Address)` in a token contract, you'll need to provide the key in a base64-encoded XDR form: ```bash -soroban contract extend \ +stellar contract extend \ --source S... \ --network testnet \ --id C... \ diff --git a/docs/smart-contracts/guides/cli/extend-contract-wasm.mdx b/docs/smart-contracts/guides/cli/extend-contract-wasm.mdx index 214fbd23b..b7a7acb36 100644 --- a/docs/smart-contracts/guides/cli/extend-contract-wasm.mdx +++ b/docs/smart-contracts/guides/cli/extend-contract-wasm.mdx @@ -6,7 +6,7 @@ hide_table_of_contents: true You can use the Stellar CLI to extend the TTL of a contract's Wasm bytecode. This can be done in two forms: if you do or do not have the compiled contract locally. If you do have the compiled binary on your local machine: ```bash -soroban contract extend \ +stellar contract extend \ --source S... \ --network testnet \ --wasm ../relative/path/to/soroban_contract.wasm \ @@ -19,7 +19,7 @@ This example uses 535,679 ledgers as the new archival TTL. This is the maximum a If you do not have the compiled binary on your local machine, you can still use the CLI to extend the bytecode TTL. You'll need to know the Wasm hash of the installed contract code: ```bash -soroban contract extend \ +stellar contract extend \ --source S... \ --network testnet \ --wasm-hash \ diff --git a/docs/smart-contracts/guides/cli/install-deploy.mdx b/docs/smart-contracts/guides/cli/install-deploy.mdx index b65270485..f698f2431 100644 --- a/docs/smart-contracts/guides/cli/install-deploy.mdx +++ b/docs/smart-contracts/guides/cli/install-deploy.mdx @@ -6,7 +6,7 @@ hide_table_of_contents: true You can combine the `install` and `deploy` commands of the Stellar CLI to accomplish both tasks: ```bash -soroban contract deploy \ +stellar contract deploy \ --source S... \ --network testnet \ --wasm ../relative/path/to/soroban_contract.wasm diff --git a/docs/smart-contracts/guides/cli/install-wasm.mdx b/docs/smart-contracts/guides/cli/install-wasm.mdx index 119d431ac..ea915744f 100644 --- a/docs/smart-contracts/guides/cli/install-wasm.mdx +++ b/docs/smart-contracts/guides/cli/install-wasm.mdx @@ -3,10 +3,10 @@ title: Install Wasm Bytecode hide_table_of_contents: true --- -To use the Stellar CLI to install a compiled smart contract on the ledger, use the `soroban contract install` command: +To use the Stellar CLI to install a compiled smart contract on the ledger, use the `stellar contract install` command: ```bash -soroban contract install \ +stellar contract install \ --source S... \ --network testnet \ --wasm ../relative/path/to/soroban_contract.wasm diff --git a/docs/smart-contracts/guides/cli/restore-contract-instance.mdx b/docs/smart-contracts/guides/cli/restore-contract-instance.mdx index 7b26594a1..637c5860a 100644 --- a/docs/smart-contracts/guides/cli/restore-contract-instance.mdx +++ b/docs/smart-contracts/guides/cli/restore-contract-instance.mdx @@ -1,12 +1,12 @@ --- -title: Restore an archived contract using the Soroban CLI +title: Restore an archived contract using the Stellar CLI hide_table_of_contents: true --- -If your contract instance has been archived, it can easily be restored using the Soroban CLI. +If your contract instance has been archived, it can easily be restored using the Stellar CLI. ```bash -soroban contract restore \ +stellar contract restore \ --source S... \ --network testnet \ --id C... \ diff --git a/docs/smart-contracts/guides/cli/restore-contract-storage.mdx b/docs/smart-contracts/guides/cli/restore-contract-storage.mdx index b2d84157a..8512bb1cd 100644 --- a/docs/smart-contracts/guides/cli/restore-contract-storage.mdx +++ b/docs/smart-contracts/guides/cli/restore-contract-storage.mdx @@ -6,7 +6,7 @@ hide_table_of_contents: true If a contract's persistent storage entry has been archived, you can restore it using the Stellar CLI. For a storage entry that uses a simple `Symbol` as its storage key, you can run a command like so: ```bash -soroban contract restore \ +stellar contract restore \ --source S... \ --network testnet \ --id C... \ @@ -17,7 +17,7 @@ soroban contract restore \ If your storage entry uses a more advanced storage key, such as `Balance(Address)` in a token contract, you'll need to provide the key in a base64-encoded XDR form: ```bash -soroban contract restore \ +stellar contract restore \ --source S... \ --network testnet \ --id C... \ diff --git a/docs/tools/developer-tools.mdx b/docs/tools/developer-tools.mdx index 660960b4e..ca13b3d3b 100644 --- a/docs/tools/developer-tools.mdx +++ b/docs/tools/developer-tools.mdx @@ -57,9 +57,9 @@ Ortege is an AI-powered blockchain analytics & insights tool for Stellar, making The command line interface to Soroban smart contracts. It allows you to build, deploy, and interact with smart contracts; configure identities; generate key pairs; manage networks; and more. -Install Stellar CLI as explained in [Setup](../smart-contracts/getting-started/setup#install-the-stellar-cli). +Install Stellar CLI as explained in [Setup](../smart-contracts/getting-started/setup#install-the-stellar-cli). For examples on how to use the Stellar CLI, please see [Stellar CLI Guide](../smart-contracts/guides/cli). -Auto-generated comprehensive reference documentation is available [here](https://github.com/stellar/stellar-cli/blob/main/FULL_HELP_DOCS.md). +The auto-generated comprehensive reference documentation is available [here](https://github.com/stellar/stellar-cli/blob/main/FULL_HELP_DOCS.md). ## Data Indexers