Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changing "Soroban CLI" to "Stellar CLI" #633

Merged
merged 33 commits into from
Jun 18, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
2315de3
Changing "Soroban CLI" to "Stellar CLI"
briwylde08 May 30, 2024
cd322a0
Update soroban-cli version. (#634)
fnando May 30, 2024
3fbd0e7
Update some CLI commands
May 30, 2024
3c8629e
Remove Deadlink - Stellar Authenticator (#637)
xiv May 31, 2024
2791a2e
Update setup.mdx (#644)
Frank-Fourier Jun 6, 2024
0ac007c
Update smart-contract-deployment.mdx (#645)
Frank-Fourier Jun 6, 2024
4c25859
[SDP-1054] Updating Stellar Docs for SDP multi-tenant (#407)
marwen-abid Jun 6, 2024
9b1ae21
Rewriting scaling documentation (#659)
mollykarcher Jun 7, 2024
077745d
rpc: add getFeeStats method documentation (#660)
2opremio Jun 7, 2024
6d8a6cc
Soroban RPC: Add document for getVersionInfo RPC (#661)
psheth9 Jun 7, 2024
e41bb76
Add a table of hardware requirements for various node types (#568)
ElliotFriend Jun 11, 2024
d479efa
Fix command for adding new networks. (#667)
fnando Jun 11, 2024
dd87e3d
Adding Tokens Overview (wayfinding) (#570)
briwylde08 Jun 12, 2024
43afa8d
Categorize Learn Section (#646)
briwylde08 Jun 12, 2024
792d9cf
Fix link (#675)
briwylde08 Jun 12, 2024
36d5f49
Learn section redirects (#678)
briwylde08 Jun 13, 2024
ab79149
Add examples of invoking contracts using Python SDK and Java SDK. (#643)
overcat Jun 13, 2024
3780715
Add hubble diagrams and data dicts (#670)
chowbao Jun 13, 2024
fd8045d
Add Passkey Library session to meeting notes (#681)
Julian-dev28 Jun 14, 2024
5f041af
Add Ortege to Block Explorers (#671)
briwylde08 Jun 14, 2024
c961713
Update Software Versions for Protocol 21: Mainnet (#685)
briwylde08 Jun 14, 2024
7b235e8
rpc: Add `getTransactions` documentation (#636)
aditya1702 Jun 14, 2024
991a4ae
Updates to Getting Started Docs (#674)
pselle Jun 14, 2024
96cf8ab
Add more detail to overlay survey instructions (#653)
bboston7 Jun 17, 2024
88eeb4a
Add admin-guide for hubble (#669)
chowbao Jun 17, 2024
2044d2f
typo fix in cli guid (#693)
rahul-soshte Jun 18, 2024
683c578
Update docs/smart-contracts/getting-started/setup.mdx
briwylde08 Jun 18, 2024
edde338
Changing "Soroban CLI" to "Stellar CLI"
briwylde08 May 30, 2024
8a80ad5
Update some CLI commands
May 30, 2024
d646559
Add more cli updates
May 30, 2024
47e8e30
Merge branch 'Soroban-Stellar-CLI' of github.com:stellar/stellar-docs…
Jun 18, 2024
9660471
Update to stellar cli
Jun 18, 2024
a8bf8c3
Fix path
Jun 18, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/learn/fundamentals/stellar-data-structures/assets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The public key of the issuing account is linked on the ledger to the asset. Resp

Assets issued on the Stellar network are accessible to smart contracts. Every Stellar asset has reserved a Stellar Asset Contract that can be deployed by anyone who wants to be able to interact with the asset from a contract.

The Soroban CLI can deploy a Stellar Asset Contract for a Stellar asset. Deploying the Stellar Asset Contract for a Stellar asset enables that asset for use with smart contracts.
The Stellar CLI can deploy a Stellar Asset Contract for a Stellar asset. Deploying the Stellar Asset Contract for a Stellar asset enables that asset for use with smart contracts.

Learn more in the [SAC section](../../../smart-contracts/tokens/stellar-asset-contract.mdx).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ The `InvokeHostFunctionOp` can be used to perform the following Soroban operatio
- Upload Wasm of the new contracts.
- Deploy new contracts using the uploaded Wasm or built-in implementations (this currently includes only the [token contract](../../../smart-contracts/tokens/stellar-asset-contract.mdx)).

[`soroban-cli`]: /docs/smart-contracts/getting-started/setup.mdx#install-the-soroban-cli
[`stellar-cli`]: /docs/smart-contracts/getting-started/setup.mdx#install-the-stellar-cli

There is only a single `InvokeHostFunctionOp` allowed per transaction. Contracts should be used to perform multiple actions atomically, for example, to deploy a new contract and initialize it atomically.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ When you compile a contract created with [soroban-sdk](../../../tools/sdks/libra

Today, these interface types are formatted using [XDR](../../encyclopedia/xdr.mdx), but this [may change](https://github.com/stellar/rs-soroban-sdk/issues/683) down the road.

The important part is that tooling can fetch these interface types to make your life easier. [Soroban CLI](../../../tools/developer-tools.mdx#cli) is the first tool to do so. Specifically, one subcommand:
The important part is that tooling can fetch these interface types to make your life easier. [Stellar CLI](../../../tools/developer-tools.mdx#cli) is the first tool to do so. Specifically, one subcommand:

## `soroban contract invoke`

Really, every smart contract is its own program, and deserves its own CLI.

So that's what Soroban CLI gives you.
So that's what Stellar CLI gives you.

A unique CLI for each smart contract. Constructed on-the-fly, right from the on-chain interface types. Including the author's comments. An _implicit CLI_.

Expand Down Expand Up @@ -69,7 +69,7 @@ Options:
-h, --help Print help
```

Like any other CLI, you can also get help for any of these subcommands using something like `native balance --help`. Soroban CLI again fetches the on-chain interface types, this time using it to generate a full list of all arguments to the function, and even generates examples.
Like any other CLI, you can also get help for any of these subcommands using something like `native balance --help`. Stellar CLI again fetches the on-chain interface types, this time using it to generate a full list of all arguments to the function, and even generates examples.

:::tip

Expand All @@ -83,13 +83,13 @@ soroban contract invoke --network testnet --id CDLZFC3SYJYDZT7K67VZ75HPJVIEUVNIX

If you're unfamiliar with the `--` double dash separator, this is a pattern used by other CLIs. Everything after the double dash, sometimes called the [slop](https://github.com/clap-rs/clap/issues/971), gets passed to the child process. An example of another CLI that makes use of this is `cargo run`.

Of course, the exact way that that Soroban CLI parses arguments is an ongoing design discussion. Representing complex custom arguments on the command line is a design challenge no blockchain CLI gets perfect yet; many, including Soroban CLI, currently use JSON. But this has downsides, and other options are possible. [How would you like to see it work?](https://docs.google.com/document/d/1LASaLyxIA2-YqLnn2NqI5NZGnEmdzx9lLh-j7n0-i4A/edit#)
Of course, the exact way that that Stellar CLI parses arguments is an ongoing design discussion. Representing complex custom arguments on the command line is a design challenge no blockchain CLI gets perfect yet; many, including Stellar CLI, currently use JSON. But this has downsides, and other options are possible. [How would you like to see it work?](https://docs.google.com/document/d/1LASaLyxIA2-YqLnn2NqI5NZGnEmdzx9lLh-j7n0-i4A/edit#)

## Already the best; just getting started

We love that Soroban will have all contract interface types available on-chain right from day one. No secondary API calls to external services, no secondary API token management, no signing in or creating an account anywhere else, and near-perfect reliability. It's a game-changer within the blockchain space.

Soroban CLI already shows how this can be built into foundational tooling to give developers delightful experiences. And this is only the beginning. At every level of the stack, you can expect—and [build](https://stellar.org/foundation/grants-and-funding)—tooling that makes interacting with any contract predictable and seamless.
Stellar CLI already shows how this can be built into foundational tooling to give developers delightful experiences. And this is only the beginning. At every level of the stack, you can expect—and [build](https://stellar.org/foundation/grants-and-funding)—tooling that makes interacting with any contract predictable and seamless.

Soon we'll have TypeScript/JavaScript libraries that mirror the behavior of `soroban contract invoke`, customized for browser & nodejs environments. You can expect GUIs that adapt to any given contract on-the-fly, functioning as interactive documentation. If you're writing contracts that make cross-contract calls, most of the code you need can also be auto-generated.

Expand Down
8 changes: 4 additions & 4 deletions docs/smart-contracts/example-contracts/TEMPLATE.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -145,14 +145,14 @@ target/wasm32-unknown-unknown/release/soroban_hello_world_contract.wasm

## Run the Contract

If you have [`soroban-cli`] installed, you can invoke contract functions using it.
If you have [`stellar-cli`] installed, you can invoke contract functions using it.

<Tabs groupId="platform" defaultValue={getPlatform()}>

<TabItem value="unix" label="macOS/Linux">

```sh
soroban contract invoke \
stellar contract invoke \
--wasm target/wasm32-unknown-unknown/release/soroban_hello_world_contract.wasm \
--id 1 \
-- \
Expand All @@ -165,7 +165,7 @@ soroban contract invoke \
<TabItem value="windows" label="Windows (PowerShell)">

```powershell
soroban contract invoke `
stellar contract invoke `
--wasm target/wasm32-unknown-unknown/release/soroban_hello_world_contract.wasm `
--id 1 `
-- `
Expand All @@ -177,7 +177,7 @@ soroban contract invoke `

</Tabs>

[`soroban-cli`]: ../getting-started/setup.mdx#install-the-soroban-cli
[`stellar-cli`]: ../getting-started/setup.mdx#install-the-stellar-cli

## Further Reading

Expand Down
42 changes: 21 additions & 21 deletions docs/smart-contracts/example-contracts/auth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -273,10 +273,10 @@ assert_eq!(client.increment(&user_2, &4), 5);

## Build the Contract

To build the contract into a `.wasm` file, use the `soroban contract build` command.
To build the contract into a `.wasm` file, use the `stellar contract build` command.

```sh
soroban contract build
stellar contract build
```

The `.wasm` file should be found in the `target` directory after building:
Expand All @@ -287,15 +287,15 @@ target/wasm32-unknown-unknown/release/soroban_auth_contract.wasm

## Run the Contract

If you have [`soroban-cli`] installed, you can invoke functions on the contract.
If you have [`stellar-cli`] installed, you can invoke functions on the contract.

But since we are dealing with authorization and signatures, we need to set up some identities to use for testing and get their public keys:

```sh
soroban keys generate acc1
soroban keys generate acc2
soroban keys address acc1
soroban keys address acc2
stellar keys generate acc1
stellar keys generate acc2
stellar keys address acc1
stellar keys address acc2
```

Example output with two public keys of identities:
Expand All @@ -305,14 +305,14 @@ GA6S566FD3EQDUNQ4IGSLXKW3TGVSTQW3TPHPGS7NWMCEIPBOKTNCSRU
GAJGHZ44IJXYFNOVRZGBCVKC2V62DB2KHZB7BEMYOWOLFQH4XP2TAM6B
```

Now the contract itself can be invoked. Notice the `--source` must be the identity name matching the address passed to the `--user` argument. This allows `soroban` tool to automatically sign the necessary payload for the invocation.
Now the contract itself can be invoked. Notice the `--source` must be the identity name matching the address passed to the `--user` argument. This allows `Stellar CLI` to automatically sign the necessary payload for the invocation.

<Tabs groupId="platform" defaultValue={getPlatform()}>

<TabItem value="unix" label="macOS/Linux">

```sh
soroban contract invoke \
stellar contract invoke \
--source acc1 \
--wasm target/wasm32-unknown-unknown/release/soroban_auth_contract.wasm \
--id 1 \
Expand All @@ -327,7 +327,7 @@ soroban contract invoke \
<TabItem value="windows" label="Windows (PowerShell)">

```powershell
soroban contract invoke `
stellar contract invoke `
--source acc1 `
--wasm target/wasm32-unknown-unknown/release/soroban_auth_contract.wasm `
--id 1 `
Expand All @@ -348,7 +348,7 @@ Run a few more increments for both accounts.
<TabItem value="unix" label="macOS/Linux">

```sh
soroban contract invoke \
stellar contract invoke \
--source acc2 \
--wasm target/wasm32-unknown-unknown/release/soroban_auth_contract.wasm \
--id 1 \
Expand All @@ -359,7 +359,7 @@ soroban contract invoke \
```

```sh
soroban contract invoke \
stellar contract invoke \
--source acc1 \
--wasm target/wasm32-unknown-unknown/release/soroban_auth_contract.wasm \
--id 1 \
Expand All @@ -370,7 +370,7 @@ soroban contract invoke \
```

```sh
soroban contract invoke \
stellar contract invoke \
--source acc2 \
--wasm target/wasm32-unknown-unknown/release/soroban_auth_contract.wasm \
--id 1 \
Expand All @@ -385,7 +385,7 @@ soroban contract invoke \
<TabItem value="windows" label="Windows (PowerShell)">

```powershell
soroban contract invoke \
stellar contract invoke \
--source acc2 \
--wasm target/wasm32-unknown-unknown/release/soroban_auth_contract.wasm \
--id 1 \
Expand All @@ -396,7 +396,7 @@ soroban contract invoke \
```

```powershell
soroban contract invoke \
stellar contract invoke \
--source acc1 \
--wasm target/wasm32-unknown-unknown/release/soroban_auth_contract.wasm \
--id 1 \
Expand All @@ -407,7 +407,7 @@ soroban contract invoke \
```

```powershell
soroban contract invoke \
stellar contract invoke \
--source acc2 \
--wasm target/wasm32-unknown-unknown/release/soroban_auth_contract.wasm \
--id 1 \
Expand All @@ -421,10 +421,10 @@ soroban contract invoke \

</Tabs>

View the data that has been stored against each user with `soroban contract read`.
View the data that has been stored against each user with `stellar contract read`.

```sh
soroban contract read --id 1
stellar contract read --id 1
```

```
Expand All @@ -439,7 +439,7 @@ It is also possible to preview the authorization payload that is being signed by
<TabItem value="unix" label="macOS/Linux">

```sh
soroban contract invoke \
stellar contract invoke \
--source acc2 \
--auth \
--wasm target/wasm32-unknown-unknown/release/soroban_auth_contract.wasm \
Expand All @@ -455,7 +455,7 @@ soroban contract invoke \
<TabItem value="windows" label="Windows (PowerShell)">

```powershell
soroban contract invoke `
stellar contract invoke `
--source acc2 `
--auth `
--wasm target/wasm32-unknown-unknown/release/soroban_auth_contract.wasm `
Expand All @@ -474,7 +474,7 @@ soroban contract invoke `
Contract auth: [{"address_with_nonce":null,"root_invocation":{"contract_id":"0000000000000000000000000000000000000000000000000000000000000001","function_name":"increment","args":[{"object":{"address":{"account":{"public_key_type_ed25519":"c7bab0288753d58d3e21cc3fa68cd2546b5f78ae6635a6f1b3fe07e03ee846e9"}}}},{"u32":123}],"sub_invocations":[]},"signature_args":[]}]
```

[`soroban-cli`]: ../getting-started/setup.mdx#install-the-soroban-cli
[`stellar-cli`]: ../getting-started/setup.mdx#install-the-stellar-cli

## Further reading

Expand Down
20 changes: 10 additions & 10 deletions docs/smart-contracts/example-contracts/cross-contract-call.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -225,10 +225,10 @@ assert_eq!(sum, 12);

## Build the Contracts

To build the contract into a `.wasm` file, use the `soroban contract build` command. Both `contract_call/contract_a` and `contract_call/contract_b` must be built, with `contract_a` being built first.
To build the contract into a `.wasm` file, use the `stellar contract build` command. Both `contract_call/contract_a` and `contract_call/contract_b` must be built, with `contract_a` being built first.

```sh
soroban contract build
stellar contract build
```

Both `.wasm` files should be found in both contract `target` directories after building both contracts:
Expand All @@ -243,20 +243,20 @@ target/wasm32-unknown-unknown/release/soroban_cross_contract_b_contract.wasm

## Run the Contract

If you have [`soroban-cli`] installed, you can invoke contract functions. Both contracts must be deployed.
If you have [`stellar-cli`] installed, you can invoke contract functions. Both contracts must be deployed.

<Tabs groupId="platform" defaultValue={getPlatform()}>

<TabItem value="unix" label="macOS/Linux">

```sh
soroban contract deploy \
stellar contract deploy \
--wasm target/wasm32-unknown-unknown/release/soroban_cross_contract_a_contract.wasm \
--id a
```

```sh
soroban contract deploy \
stellar contract deploy \
--wasm target/wasm32-unknown-unknown/release/soroban_cross_contract_b_contract.wasm \
--id b
```
Expand All @@ -266,13 +266,13 @@ soroban contract deploy \
<TabItem value="windows" label="Windows (PowerShell)">

```powershell
soroban contract deploy `
stellar contract deploy `
--wasm target/wasm32-unknown-unknown/release/soroban_cross_contract_a_contract.wasm `
--id a
```

```powershell
soroban contract deploy `
stellar contract deploy `
--wasm target/wasm32-unknown-unknown/release/soroban_cross_contract_b_contract.wasm `
--id b
```
Expand All @@ -288,7 +288,7 @@ Invoke Contract B's `add_with` function, passing in values for `x` and `y` (e.g.
<TabItem value="unix" label="macOS/Linux">

```sh
soroban contract invoke \
stellar contract invoke \
--id b \
-- \
add_with \
Expand All @@ -302,7 +302,7 @@ soroban contract invoke \
<TabItem value="windows" label="Windows (PowerShell)">

```powershell
soroban contract invoke `
stellar contract invoke `
--id b `
-- `
add_with `
Expand All @@ -323,4 +323,4 @@ The following output should occur using the code above.

Contract B's `add_with` function invoked Contract A's `add` function to do the addition.

[`soroban-cli`]: ../getting-started/setup.mdx#install-the-soroban-cli
[`stellar-cli`]: ../getting-started/setup.mdx#install-the-stellar-cli
16 changes: 8 additions & 8 deletions docs/smart-contracts/example-contracts/custom-types.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -234,10 +234,10 @@ assert_eq!(

## Build the Contract

To build the contract, use the `soroban contract build` command.
To build the contract, use the `stellar contract build` command.

```sh
soroban contract build
stellar contract build
```

A `.wasm` file should be outputted in the `target` directory:
Expand All @@ -248,14 +248,14 @@ target/wasm32-unknown-unknown/release/soroban_custom_types_contract.wasm

## Run the Contract

If you have [`soroban-cli`] installed, you can invoke contract functions in the Wasm using it.
If you have [`stellar-cli`] installed, you can invoke contract functions in the Wasm using it.

<Tabs groupId="platform" defaultValue={getPlatform()}>

<TabItem value="unix" label="macOS/Linux">

```sh
soroban contract invoke \
stellar contract invoke \
--wasm target/wasm32-unknown-unknown/release/soroban_custom_types_contract.wasm \
--id 1 \
-- \
Expand All @@ -268,7 +268,7 @@ soroban contract invoke \
<TabItem value="windows" label="Windows (PowerShell)">

```powershell
soroban contract invoke `
stellar contract invoke `
--wasm target/wasm32-unknown-unknown/release/soroban_custom_types_contract.wasm `
--id 1 `
-- `
Expand All @@ -288,14 +288,14 @@ The following output should occur using the code above.

Run it a few more times with different increment amounts to watch the count change.

Use the `soroban` to inspect what the counter is after a few runs.
Use the `stellar-cli` to inspect what the counter is after a few runs.

```sh
soroban contract read --id 1 --key STATE
stellar contract read --id 1 --key STATE
```

```
STATE,"{""count"":25,""last_incr"":15}"
```

[`soroban-cli`]: ../getting-started/setup.mdx#install-the-soroban-cli
[`stellar-cli`]: ../getting-started/setup.mdx#install-the-stellar-cli
4 changes: 2 additions & 2 deletions docs/smart-contracts/example-contracts/deployer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,7 @@ target/wasm32-unknown-unknown/release/soroban_deployer_test_contract.wasm

## Run the Contract

If you have [`soroban-cli`] installed, you can invoke the contract function to deploy the test contract.
If you have [`stellar-cli`] installed, you can invoke the contract function to deploy the test contract.

Before deploying the test contract with the deployer, install the test contract Wasm using the `install` command. The `install` command will print out the hash derived from the Wasm file (it's not just the hash of the Wasm file itself though) which should be used by the deployer.

Expand Down Expand Up @@ -536,4 +536,4 @@ The following output should occur using the code above.
5
```

[`soroban-cli`]: ../getting-started/setup.mdx#install-the-soroban-cli
[`stellar-cli`]: ../getting-started/setup.mdx#install-the-stellar-cli
Loading