docs: finish the watch-tower rename - #53
Merged
Merged
Conversation
#41 renamed the polling agent to "monitoring service" in `docs/`, but left README.md untouched, so the user-facing document still described the term the rename was meant to retire. Five references there, plus a stale comment in the TWAP tests. The two glossary parentheticals in `docs/architecture.md` and `docs/discovery.md` go as well. They were written while the rename was in flight, to bridge readers arriving from upstream. Keeping "historically called watch-towers" in the documents that retire the term preserves it instead. The link to `cowprotocol/tenderly-watch-tower` in the local-deployment section is dropped rather than relabelled. It points at upstream's specific implementation, which is not the monitoring service this repository describes, and nothing in the local-deployment instructions depends on that tool in particular. `docs/discovery.md` reworded to "support handlers" rather than "service handlers", since removing the parenthetical left "monitoring service service handlers". Remaining occurrences are confined to `broadcast/StandardJsonInput/*.json`. Those are verbatim flattened-source verification inputs, not prose, and are stale for other reasons; they are left alone here.
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
1 participant
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.
Part of #35, first bullet. Does not close it; see below.
#41 renamed the polling agent to "monitoring service" across
docs/, but README.md was never touched. The user-facing document was still the one describing the term the rename was meant to retire.What changed
README.md, five references. Four are the generic polling-agent sense and become "off-chain monitoring service" or "monitoring services", matching the terminology #41 established.
The fifth is the link to
cowprotocol/tenderly-watch-towerin the local-deployment section. Dropped rather than relabelled: it points at upstream's specific implementation, which is not the monitoring service this repository describes, and nothing in the surroundinganvilinstructions depends on that tool in particular. The sentence now refers generically to running a monitoring service against the deployment.docs/architecture.mdanddocs/discovery.md, the two glossary parentheticals.architecture.mddropped "(historically called watch-towers)", anddiscovery.mddropped "(the polling agent historically called a watch-tower; "monitoring service" hereafter)".These were bridges for readers arriving from upstream, written while the rename was in flight. This is a judgement call and the easiest thing here to disagree with. The argument for keeping them is that upstream's term is what someone will have in their head when they arrive. The argument against, which I went with: the documents that retire the term are the wrong place to keep it alive, and a reader who knows the upstream term will map it from context in one sentence.
discovery.mdneeded a small reword. Removing the parenthetical left "let an off-chain monitoring service service handlers", so that is now "support handlers".test/ComposableCow.twap.t.sol, one stale comment, no behaviour.What is deliberately left
broadcast/StandardJsonInput/*.jsonstill contain the term, six files. Those are verbatim flattened-source verification inputs rather than prose, so rewriting the term inside them would corrupt what they are for.They are stale independently of this: they carry pre-typed-errors signatures such as
PollTryNextBlock(string reason), and one is still namedComposableCoW.jsonin the old casing. Given #46 established there are no deployments, the whole ofbroadcast/is arguably dead weight, but that is a separate call from a terminology fix, and deleting deployment history deserves its own PR.Why #35 stays open
Its third bullet asks for the canonical deployments manifest (chainId to registry address, deploy block, ABI version, topic0 set).
deployments/networks.jsonis"networks": {}after #46, and there is nothing to publish until something is deployed. The verdict-permanence bullet was covered by #41.Verification
Docs and one comment only, no source change. 166 tests pass,
forge fmt --checkclean, build clean.rg -ni 'watch.?tower|tenderly'returns nothing outsidebroadcast/.