Conversation
Contributor
|
✅ No conflicts with other open PRs targeting |
|
Contributor
There was a problem hiding this comment.
Pull request overview
Risk Rating: LOW
This PR updates Chainlink node configuration documentation to describe SVR/OEV “multiplexing” behavior by introducing CustomURLs alongside the legacy CustomURL for EVM.Transactions.TransactionManagerV2.
Changes:
- Document new
CustomURLsoption and deprecate legacyCustomURLwording indocs/CONFIG.md. - Update the EVM chain config example (
core/config/docs/chains-evm.toml) to includeCustomURLs. - Add a changeset entry for the documentation update.
Scrupulous human review recommended for:
- The behavioral guarantees described for
CustomURLs(primary vs secondary, “fire-and-forget”) and the claimed mutual exclusivity withCustomURLin:docs/CONFIG.md(TransactionManagerV2 section)core/config/docs/chains-evm.toml(TransactionManagerV2 example)
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/CONFIG.md | Adds CustomURLs documentation and deprecates legacy CustomURL wording for TransactionManagerV2. |
| core/config/docs/chains-evm.toml | Updates the example EVM chain config to include CustomURLs and updated comments. |
| .changeset/long-ants-give.md | Adds a patch changeset describing the documentation update. |
| @@ -17703,6 +17703,7 @@ MinAttempts configures the minimum number of broadcasted attempts a transaction | |||
| Enabled = false # Default | |||
| BlockTime = '10s' # Example | |||
| CustomURL = 'https://example.api.io' # Example | |||
| ```toml | ||
| CustomURLs = ['https://relay.example/api', 'https://ofa-secondary.example/api'] # Example | ||
| ``` | ||
| CustomURLs configures an ordered list of OFA URLs: the first entry is primary (determines broadcast outcome); additional entries are multiplexed as secondaries (fire-and-forget). Cannot be used together with CustomURL in the same configuration. |
| BlockTime = '10s' # Example | ||
| # CustomURL configures the base url of a custom endpoint used by the ChainDualBroadcast chain type. | ||
| # CustomURL configures the base url of a custom endpoint used by the dual broadcast functionality. (legacy single endpoint). Deprecated: use CustomURLs instead. | ||
| CustomURL = 'https://example.api.io' # Example |
| "chainlink": patch | ||
| --- | ||
|
|
||
| #updated #nops Updated documentation around SVR multiplexing. |
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.
Supports
Proper documentation for SVR multiplexing (smartcontractkit/chainlink-evm#445).