Change default network to local

Open
#686 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
42/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Stale
Tech stack
docker, shell

Research direction

Review the quickstart image's startup path for the no-parameter case, and compare its behavior with the stellar-cli stellar container start command, which already defaults to local mode. Done means an unconfigured image starts on the local network and users can explicitly select testnet with --testnet.

Written by the indexing model from the issue text.

Description

I think the default network of the image should change from testnet to local.

This will be a breaking change.

Why:

The quickstart image is primarily intended for use during development and testing. It's defaults should operate to serve that purpose. When folks are testing they typically test either against the public test network or a local network. When testing against the public test network the easiest path to access is to approach is to communicate directly with the SDF hosted testnet RPC at https://soroban-testnet.stellar.org or the SDF hosted testnet Horizon at https://horizon-testnet.stellar.org. The quickstart image only adds value to setup when running a local network.

Today the image when started without any other parameters defaults connecting to testnet. This means for the default common case a developer needs to read the docs and pass additional parameters.

The stellar-cli has a stellar container start command that defaults already to starting the container in local mode for the same reason.

Impact:

For anyone using this image without parameters to connect to testnet, they will see the container instead connect to local and will need to add a parameter --testnet.

cc @stellar/devx @janewang

Dominant language
Shell
Stars
222
Forks
236
Avg merge
1d 12h
Merged PRs (30d)
12

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from stellar/quickstart

All issues in stellar/quickstart

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.