Skip to content

Commit

Permalink
Update CLI commands in CLI guide (#702)
Browse files Browse the repository at this point in the history
Co-authored-by: Jane Wang <[email protected]>
  • Loading branch information
janewang and Jane Wang authored Jun 20, 2024
1 parent 1fcf583 commit 02b46ac
Show file tree
Hide file tree
Showing 11 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion docs/smart-contracts/guides/cli/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/smart-contracts/guides/cli/deploy-contract.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 <hex-encoded-wasm-hash>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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... \
Expand Down
4 changes: 2 additions & 2 deletions docs/smart-contracts/guides/cli/extend-contract-storage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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... \
Expand All @@ -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... \
Expand Down
4 changes: 2 additions & 2 deletions docs/smart-contracts/guides/cli/extend-contract-wasm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand All @@ -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 <hex-encoded-wasm-hash> \
Expand Down
2 changes: 1 addition & 1 deletion docs/smart-contracts/guides/cli/install-deploy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/smart-contracts/guides/cli/install-wasm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/smart-contracts/guides/cli/restore-contract-instance.mdx
Original file line number Diff line number Diff line change
@@ -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... \
Expand Down
4 changes: 2 additions & 2 deletions docs/smart-contracts/guides/cli/restore-contract-storage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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... \
Expand All @@ -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... \
Expand Down
4 changes: 2 additions & 2 deletions docs/tools/developer-tools.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 02b46ac

Please sign in to comment.