Skip to content

docs: monitoring-service terminology, verdict permanence, deployments manifest - #41

Open
mfw78 wants to merge 1 commit into
feat/discovery-interfacesfrom
docs/monitoring-service-deployments
Open

docs: monitoring-service terminology, verdict permanence, deployments manifest#41
mfw78 wants to merge 1 commit into
feat/discovery-interfacesfrom
docs/monitoring-service-deployments

Conversation

@mfw78

@mfw78 mfw78 commented Jul 11, 2026

Copy link
Copy Markdown
  • "watch-tower" → "off-chain monitoring service" across docs and NatSpec
  • verdict permanence documented: INVALID uniformly terminal, NEEDS_INPUT acquisition semantics, the Restriction overlay; breaking-changes table extended
  • canonical deployments/networks.json manifest (chainId → registry address, deploy block, topic0 set) with schema README

Issues

Advances #35. The verdict-permanence rows and the deployments/networks.json schema land here, but three of the issue's asks are not finished:

  • the rename leaves docs/architecture.md L12 reading "off-chain monitoring service (historically called a watch-tower)s", L102 still reads Watch-Tower, and README.md is untouched (5 occurrences)
  • L145 still says "The swap guard is not consulted by checkOrder", which feat!: separate swap-guard restriction from the generator verdict #38 made false (the guard is applied in the shared _poll), and the L220 PollResult snippet omits restriction; the changelog at L554 still describes swap-guard restriction as an INVALID verdict
  • networks.json carries an empty networks object, so no chainId -> address / deployBlock / topic0 entry is actually published

Closes #15 - the issue is superseded by the discovery set as a whole (#36 spec, #37-#41 implementation), not by any single PR in it; this is the last of that set. The delivered design differs from the issue's literal proposal: there is no typeId() or version() getter, descriptorURI() returns string[] on a sidecar rather than string on IConditionalOrderGenerator, and BaseConditionalOrder deliberately does not default them. The supersession is recorded in the design note on #15.

Part of #1.

@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch from a3af0b8 to da2512b Compare July 30, 2026 03:50
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch 2 times, most recently from ea5d427 to d822b7d Compare July 30, 2026 04:01
@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch from 60a398f to 4e49284 Compare July 30, 2026 06:59
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch from d822b7d to 1befa00 Compare July 30, 2026 06:59
@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch from 4e49284 to c14cebe Compare July 30, 2026 07:02
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch from 1befa00 to 1043cdd Compare July 30, 2026 07:02
@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch from c14cebe to 8db0db6 Compare July 30, 2026 07:07
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch from 1043cdd to 0104481 Compare July 30, 2026 07:07
@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch from 8db0db6 to a353d2b Compare July 30, 2026 07:09
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch 2 times, most recently from 83539c7 to 9c72493 Compare July 30, 2026 07:14
mfw78 added a commit that referenced this pull request Jul 30, 2026
Nothing in this tree is deployed, and the artefacts still said
otherwise.

- **removes the legacy root `networks.json`** (274 lines, 8 contracts x
8 chains). Those are *upstream's* addresses, for contracts this fork no
longer matches after the generateOrder rename, typed errors, poll
interface and proof-payload changes. Leaving the file invited them to be
read as this fork's own deployments. When this fork does deploy, the
canonical record is `deployments/networks.json`, landing in #41.
- **`dev/verify-contracts.sh`** was the file's only consumer. It now
fails with a clear message instead of feeding `null` addresses into
`forge verify-contract`.
- **drops the README address table** and states plainly that there are
no deployments.
- **reframes the audit list.** It previously read "The above deployed
contracts have been audited by" directly under the address table. Those
audits cover upstream before this work, so leaving it unqualified
alongside an unaudited warning would have been contradictory.
- **adds a warning under the README title** that the fork is unaudited,
not deployed, and substantially changed.

**BREAKING**: `networks.json` is removed. Any consumer resolving
addresses from it was resolving upstream deployments, not this fork's.

## How to test

```sh
rg '0x[0-9a-fA-F]{40}' README.md   # no addresses left
test -f networks.json               # gone
./dev/verify-contracts.sh 1         # fails with the no-deployments message
```

Part of #1.
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch from 9c72493 to 99bfe4a Compare July 30, 2026 07:18
@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch from 1adff10 to 45aafa9 Compare July 30, 2026 07:22
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch from 99bfe4a to 2c7570f Compare July 30, 2026 07:22
@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch from 45aafa9 to 790f4ad Compare July 30, 2026 07:26
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch from 2c7570f to 47bf1e7 Compare July 30, 2026 07:26
@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch from 790f4ad to 7be42fc Compare July 30, 2026 07:33
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch 2 times, most recently from a1f8a8a to e343718 Compare July 30, 2026 08:23
@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch from 7be42fc to 9e8cd3e Compare July 30, 2026 08:23
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch from e343718 to 7a5a798 Compare July 30, 2026 08:42
@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch from 9e8cd3e to 5663501 Compare July 30, 2026 08:42
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch from 7a5a798 to a060d1c Compare July 30, 2026 09:51
@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch from 2fc05f5 to 5dda0ce Compare July 30, 2026 09:54
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch from a060d1c to 09f41a3 Compare July 30, 2026 09:54
@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch from 5dda0ce to edabf32 Compare July 30, 2026 10:24
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch from 09f41a3 to 4ea86b7 Compare July 30, 2026 10:24
@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch from edabf32 to bdd4dd8 Compare July 30, 2026 10:40
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch 2 times, most recently from 7a4d81a to 0cb431a Compare July 30, 2026 12:54
@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch 2 times, most recently from 38f6ba1 to b851f74 Compare July 30, 2026 13:07
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch from 0cb431a to 2c23662 Compare July 30, 2026 13:07
@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch from b851f74 to b469984 Compare July 30, 2026 13:19
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch 3 times, most recently from f13c656 to deee630 Compare July 30, 2026 14:25
@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch 2 times, most recently from c2dc973 to 9c527b7 Compare July 30, 2026 23:43
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch from deee630 to 84cb438 Compare July 30, 2026 23:43
@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch from 9c527b7 to e36b654 Compare July 30, 2026 23:51
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch from 84cb438 to 933737d Compare July 30, 2026 23:51
@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch from e36b654 to 34ef864 Compare July 31, 2026 00:06
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch from 933737d to 140abeb Compare July 31, 2026 00:06
@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch from 34ef864 to 97120da Compare July 31, 2026 00:12
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch 2 times, most recently from 49c05c3 to a2b4d6d Compare July 31, 2026 00:14
@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch 2 times, most recently from f659bd8 to 429f6ad Compare July 31, 2026 04:00
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch from a2b4d6d to 3e2f141 Compare July 31, 2026 04:00
@mfw78
mfw78 force-pushed the feat/discovery-interfaces branch from 429f6ad to 3d2c877 Compare July 31, 2026 05:26
@mfw78
mfw78 force-pushed the docs/monitoring-service-deployments branch from 3e2f141 to 58308d7 Compare July 31, 2026 05:26
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.

1 participant