Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enforcement of API Protocol versions in Client/Signer/Aggregator #633

Closed
4 tasks
jpraynaud opened this issue Dec 2, 2022 · 0 comments · Fixed by #641
Closed
4 tasks

Enforcement of API Protocol versions in Client/Signer/Aggregator #633

jpraynaud opened this issue Dec 2, 2022 · 0 comments · Fixed by #641
Assignees
Labels
D-medium Difficulty: medium P-medium Priority: medium task

Comments

@jpraynaud
Copy link
Member

jpraynaud commented Dec 2, 2022

Issue

In order to help signers and client operators know if they are running a stale version of the API protocol and facilitate the overall upgrade process of the nodes, we need to put in place a verification mechanism. This mechanism must be optional, if no version is provider by the HTTP client, the verification is skipped.

We need to have signers and client stop and display an error message requesting for an update of the node in case of incompatible API_VERSION detected between signer & aggregator or client & aggregator.

For instance, the Aggregator could return a specific HTTP error code and this would trigger an exit from the signer/client.

Protocol versions are compatible if they share the same minor.

To do

  • If Aggregator version !== Signer/Client version: display an error "You need to upgrade your node to version X.Y"
  • If the version is not provided, the version is ignored.
  • Add units tests or maybe integration tests
  • Maybe add a dev blog post (if it brings added value to SPOs)

Relates to #565

@jpraynaud jpraynaud added D-medium Difficulty: medium P-medium Priority: medium task labels Dec 2, 2022
@ghubertpalo ghubertpalo self-assigned this Dec 6, 2022
@ghubertpalo ghubertpalo mentioned this issue Dec 13, 2022
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
D-medium Difficulty: medium P-medium Priority: medium task
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants