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

Add emergency section in the README #380

Merged
merged 9 commits into from
Jan 16, 2024

Conversation

Jean-Grimal
Copy link
Contributor

Fixes #375

Should I add subsections about rogue guardian and owner takeover ?
I haven't done it yet because it require to deploy a new vault and to migrate positions to this new vault, and I was not sure such operations should be explained/described in this file.

@Jean-Grimal Jean-Grimal requested review from a team, adhusson, Rubilmax, QGarchery, MerlinEgalite and MathisGD and removed request for a team January 5, 2024 09:31
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Jean-Grimal and others added 3 commits January 5, 2024 13:49
Co-authored-by: Quentin Garchery <QGarchery@users.noreply.github.com>
Signed-off-by: Jean-Grimal <83286814+Jean-Grimal@users.noreply.github.com>
@julien-devatom julien-devatom requested review from a team, ghivert, mlgarchery, oumar-fall and julien-devatom and removed request for a team January 5, 2024 13:26
Copy link
Contributor

@QGarchery QGarchery left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Two other scenario we could document:

  1. the guardian suspects bad behavior from the curator/owner -> revoke everything continuously, explain the situation, and can advocate for removing funds if no solution can be found
  2. the allocators can pause the deposits (for example in case of a suspected contract bug involving depositing funds) by setting the supplyQueue to the empty list

Do you thing we should add them @morpho-org/onchain-reviewers ?

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@MerlinEgalite
Copy link
Contributor

LGTM

Two other scenario we could document:

  1. the guardian suspects bad behavior from the curator/owner -> revoke everything continuously, explain the situation, and can advocate for removing funds if no solution can be found
  2. the allocators can pause the deposits (for example in case of a suspected contract bug involving depositing funds) by setting the supplyQueue to the empty list

Do you thing we should add them @morpho-org/onchain-reviewers ?

Indeed I think it's worth it.

README.md Show resolved Hide resolved
Copy link
Collaborator

@adhusson adhusson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This README is what vault owners will read during an emergency, so, so it should directly link to default bundles for emergency situations, or link to a specific doc page that has those bundles.

Jean-Grimal and others added 2 commits January 8, 2024 09:52
Co-authored-by: Merlin Egalite <44097430+MerlinEgalite@users.noreply.github.com>
Signed-off-by: Jean-Grimal <83286814+Jean-Grimal@users.noreply.github.com>
@Rubilmax
Copy link
Contributor

Rubilmax commented Jan 8, 2024

This README is what vault owners will read during an emergency, so, so it should directly link to default bundles for emergency situations, or link to a specific doc page that has those bundles.

I don't get your suggestion: we can't prepare bundles because they are specific to MM addresses and configuration?

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@adhusson
Copy link
Collaborator

adhusson commented Jan 8, 2024

we can't prepare bundles because they are specific to MM addresses and configuration?

(I had default Safe bundle skeletons in mind) After discussion with Romain the best would be foundry script with options. That's enough for EOA allocators, and the resulting tx will also be convertible into Safe bundles. @MerlinEgalite @Rubilmax

@Rubilmax
Copy link
Contributor

Rubilmax commented Jan 8, 2024

we can't prepare bundles because they are specific to MM addresses and configuration?

(I had default Safe bundle skeletons in mind) After discussion with Romain the best would be foundry script with options. That's enough for EOA allocators, and the resulting tx will also be convertible into Safe bundles. @MerlinEgalite @Rubilmax

moved the discussion to #383!

Co-authored-by: Quentin Garchery <QGarchery@users.noreply.github.com>
Signed-off-by: Jean-Grimal <83286814+Jean-Grimal@users.noreply.github.com>
Rubilmax
Rubilmax previously approved these changes Jan 8, 2024
README.md Outdated Show resolved Hide resolved
@MerlinEgalite
Copy link
Contributor

ah formatting is broken it seems @Jean-Grimal

@MerlinEgalite MerlinEgalite merged commit 32d6433 into main Jan 16, 2024
7 checks passed
@MerlinEgalite MerlinEgalite deleted the feat/add-emergency-section-readme branch January 16, 2024 07:50
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.

Create emergency section in README with step actions
5 participants