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

Update docs about how to dev with quickstart and soroban #501

Merged
merged 1 commit into from
Sep 21, 2023
Merged
Changes from all commits
Commits
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
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,22 +71,20 @@ are finalized faster than on deployed networks.

### Soroban Development

For local development of smart contracts on Stellar using [Soroban], run a `local` network and the Soroban stack locally via the `stellar/quickstart:soroban-dev` image:
For local development of smart contracts on Stellar using [Soroban], run a `local` network and the Soroban stack locally via the `stellar/quickstart:testing` image:

```
$ docker run --rm -it \
-p "8000:8000" \
--name stellar \
stellar/quickstart:soroban-dev \
stellar/quickstart:testing \
--local \
--enable-soroban-rpc
```

This will run development versions of stellar-core, horizon, friendbot, and soroban-rpc server that are Soroban enabled.
This will run the release-candidate versions of stellar-core, horizon, friendbot, and soroban-rpc server that are Soroban enabled.

**Warning: The Soroban RPC Server is in early development and the version included in any quickstart image is a development release with no production capabilities and no API compatibility guarantee. Not recommended for use in production or any environment requiring stability or safety.**

The Soroban RPC server is supported only with the `--local` and `--futurenet` network options.
The Soroban RPC server is supported only with the `--local`, `--futurenet`, `--testnet` network options.

To enable the Soroban RPC server provide the following command line flags when starting the container:
`--enable-soroban-rpc`
Expand Down