stellar / quickstart

Home of the stellar/quickstart docker image for development and testing
Apache License 2.0
186 stars 206 forks source link

Enable ENABLE_DIAGNOSTICS_FOR_TX_SUBMISSION on rpc when --enable-soroban-diagnostic-events is in use #580

Closed leighmcculloch closed 6 months ago

leighmcculloch commented 6 months ago

What

Enable ENABLE_DIAGNOSTICS_FOR_TX_SUBMISSION on rpc when --enable-soroban-diagnostic-events is in use.

Also, disable the future variant builds.

Why

When --enable-soroban-diagnostic-events is enabled on the meta generating stellar-core's, diagnostic events are generated in transaction meta of applied transactions and visible in the places that horizon and rpc expose the events.

Stellar-core also generates diagnostic events for some transactions that fail immediately without being added to the queue. That feature is controlled by a separate config flag, ENABLE_DIAGNOSTICS_FOR_TX_SUBMISSION.

For the sake of simplicity I've tied it into the existing --enable-soroban-diagnostic-events since developers who are testing likely want both on or none on. This is different to operators who deploy horizon and rpc who may wish to enable only submission diagnostics but not meta diagnostics because of the resource cost differences. It doesn't seem worth adding separate configs for that in quickstart given the focus on it as a developer tool. The more knobs we add, the harder it is to use.

The future build is disabled because the future releases and futurenet deployment are intended for preview releases of which one has not yet been released since the testnet and mainnet launches. The current versions of soroban-rpc doesn't support ENABLE_DIAGNOSTICS_FOR_TX_SUBMISSION and instead of adding in more logic to support that feature not being available on some variants, taking a tradeoff to simply not build future variants for now. The existing future variant image will continue to work just fine in the interim, it just won't get this or subsequent updates until the next preview release.

Close #562