docs: drop deprecated parity-ethereum / openethereum references#22267
Open
ozpool wants to merge 1 commit intosmartcontractkit:developfrom
Open
docs: drop deprecated parity-ethereum / openethereum references#22267ozpool wants to merge 1 commit intosmartcontractkit:developfrom
ozpool wants to merge 1 commit intosmartcontractkit:developfrom
Conversation
Both parity-ethereum and openethereum have been unmaintained for years,
yet they still appear in user-facing docs and config comments as if they
were supported execution clients. Drop those mentions:
- README.md: remove the "Parity/Openethereum" entry from the
officially-supported-clients list. Geth and Besu remain.
- core/config/docs/chains-evm.toml: the MaxInFlight comment used
"geth and parity" as the comparison point for the conservative
default; reword to mention only geth.
- ccip/config/evm/Gnosis_Mainnet.toml: the AuRa-finality comment
framed Gnosis Chain in terms of parity behaviour. Reword to
describe AuRa directly without the parity comparison and fix the
legacy "xDai" name to "Gnosis Chain".
The corresponding section of the generated docs/CONFIG.md is left
alone; it is regenerated from the toml comment automatically.
Closes smartcontractkit#4018.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #4018.
The issue is labeled
acceptedandgood first issue. @pappas999's comment on the issue sets the direction:Both
parity-ethereumand its successoropenethereumhave been unmaintained for years; mentioning them as officially supported execution clients is misleading. This PR drops those references in three places, with intentionally tight scope.Changes
README.md— Remove theParity/Openethereumentry from the Officially supported execution-client list. Geth and Besu remain.core/config/docs/chains-evm.toml— TheMaxInFlightdoc-comment used "geth and parity" as the comparison point for the conservative default of 16. Reword to mention only geth.ccip/config/evm/Gnosis_Mainnet.toml— The AuRa-finality comment framed Gnosis Chain finality in terms of parity. Reword to describe AuRa directly and use the current name "Gnosis Chain" instead of the legacy "xDai".docs/CONFIG.mdis generated from the toml comments; left untouched so the build's regen step keeps it in sync.Out of scope
The
tools/docker/directory still has adocker-compose.paritynet.yamlthat's wired up via thecomposescript. That's functional dev tooling, not a doc reference, so I left it alone — happy to follow up with a separate PR if maintainers want the parity dev images dropped too.Diff
Verification
Doc-only change.
go build ./...andgo vet ./...would not exercise these paths. Local checks: