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

Rename standalone to local #484

Merged
merged 7 commits into from
Sep 18, 2023
Merged

Conversation

leighmcculloch
Copy link
Member

What

Rename the standalone network to local, adding a --local option to enable it, but keep the same network passphrase and keep the old --standalone around for backwards compatibility.

Why

It's very confusing that the standalone network is named standalone, because stellar-core has a standalone mode and the standalone network only sometimes runs in standalone mode.

The name standalone for the network is a carry over from the past. Once-upon-a-time the standalone network always ran stellar-core in standalone mode. Standalone mode causes stellar-core to not interact with any peer, even local peers.

With the invention of captive-core, where horizon and soroban-rpc ingest network data by running their own stellar-core's, standalone mode is largely not useful in the quickstart image. The stellar-core's run by the other services must peer with the main stellar-core validator node in the container, and so it doesn't actually run in standalone mode for the standalone network.

This has been a source of confusion and has almost led to us making technical decisions that would have been incompatible with quickstart because there was an assumption that standalone network always ran in standalone mode.

Local seems like a simple short name that clearly signals that a network is created local to the container.

Keeping the existing standalone option around seems wise for backwards compatibility. A log message is outputted when the --standalone option is used in hope folks will change to --local over time.

@leighmcculloch leighmcculloch marked this pull request as ready for review September 13, 2023 23:49
@leighmcculloch leighmcculloch enabled auto-merge (squash) September 13, 2023 23:49
start Show resolved Hide resolved
Copy link
Contributor

@sreuland sreuland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sounds good, the only feedback I can suggest is to consider sandbox rather than local as part of terminology usually associated to development purposes also.

@leighmcculloch leighmcculloch merged commit f9301f2 into master Sep 18, 2023
@leighmcculloch leighmcculloch deleted the resolve-standalone-confusion branch September 18, 2023 22:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants