Skip to content

docs: align with unified approveService + expireServiceRequest#146

Merged
drewstone merged 1 commit intomainfrom
docs/sync-unified-approval
May 5, 2026
Merged

docs: align with unified approveService + expireServiceRequest#146
drewstone merged 1 commit intomainfrom
docs/sync-unified-approval

Conversation

@drewstone
Copy link
Copy Markdown
Contributor

Summary

Brings the protocol reference docs back in sync with what tnt-core actually exposes today.

  • ITangleServices reference (manual + generated mirror): the four removed `approveServiceWith*` variants are out, replaced by the single `approveService(ApprovalParams)` entrypoint plus `expireServiceRequest`, `getTeeCommitmentRoot`, `teeNonceFor`, and `blsPopMessage` (which were already on the contract but not documented in the reference page).
  • Auth surface table: four approval rows collapsed to one with a note on the opt-in fields (empty `securityCommitments`, zero `blsPubkey`, empty `teeCommitments`).
  • Slashing doc: per-asset commitment narrative now points at the unified entrypoint.
  • `scripts/check-tnt-core-sync.mjs`: was actively failing because it asserted on the removed signatures. Updated to gate on the new surface — re-running against the current tnt-core checkout passes.

Why now

`yarn check:tnt-core-sync` was broken (asserts `function approveServiceWithBls(` is present in tnt-core source; that signature no longer exists). CI doesn't currently invoke this script but it's intended as a contributor tripwire — a broken tripwire is worse than no tripwire.

Test plan

  • `TNT_CORE_DIR=/path/to/tnt-core node scripts/check-tnt-core-sync.mjs` → "tnt-core sync checks passed"
  • `yarn prettier --write` clean on all touched files
  • No remaining `approveServiceWith` or `approveService(requestId, stakingPercent)` references under `pages/`

tnt-core PR #119 collapsed five approveServiceWith* variants into one
approveService(ApprovalParams). PR #122 declared expireServiceRequest
on ITangleServices. Updates here:

- ITangleServices reference (and generated mirror): replace
  approveService(uint64,uint8) + 4 approveServiceWith* blocks with the
  unified entrypoint; document expireServiceRequest, getTeeCommitmentRoot,
  teeNonceFor, blsPopMessage.
- auth-surface: collapse the four approveServiceWith* table rows into
  one approveService(ApprovalParams) row with a note on opt-in fields.
- slashing: rename the per-asset commitment narrative reference from
  approveServiceWithCommitments to approveService(ApprovalParams) with
  non-empty securityCommitments.
- check-tnt-core-sync: stop tripwiring on the removed signatures; gate
  on the new unified entrypoint plus expireServiceRequest /
  getTeeCommitmentRoot / teeNonceFor.
@netlify
Copy link
Copy Markdown

netlify Bot commented May 5, 2026

Deploy Preview for tangle-docs ready!

Name Link
🔨 Latest commit 6043035
🔍 Latest deploy log https://app.netlify.com/projects/tangle-docs/deploys/69fa290b5781a9000860125a
😎 Deploy Preview https://deploy-preview-146--tangle-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@drewstone drewstone merged commit e976e83 into main May 5, 2026
9 checks passed
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