docs: update docs for slashing #709
Open
Conversation
This file contains 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
gpsanant
reviewed
Aug 26, 2024
| * @return slashableBips the slashable bips of the given strategy owned by | ||
| * the given OperatorSet for the given operator and timestamp | ||
| */ | ||
| function getSlashableBips( |
There was a problem hiding this comment.
imo we should just return parts per 1e18 that the AVS is allowed to slash. rounding with bips just too sketch
gpsanant
reviewed
Aug 26, 2024
docs/releases/slashing-release/interfaces/core/slashing-parameter-configuration.md
Outdated
Show resolved
Hide resolved
gpsanant
reviewed
Aug 26, 2024
docs/releases/slashing-release/interfaces/core/slashing-parameter-configuration.md
Outdated
Show resolved
Hide resolved
gpsanant
reviewed
Aug 26, 2024
| Reverts if | ||
|
|
||
| 1. The `operatorSignature` is invalid or `msg.sender` is not the `operator` | ||
| 2. The sum of all magnitude allocations for a IStrategy is greater than the free magnitude that is available to allocate. |
There was a problem hiding this comment.
can we make sure all the revert conditions are here? should add
any of the operatorSets do not exist in the AVSD
gpsanant
reviewed
Aug 26, 2024
| * @param registered whether the operator is registered with the operator set | ||
| * @param lastDeregisteredTimestamp the timestamp at which the operator was last deregistered | ||
| */ | ||
| struct OperatorSetRegistrationStatus { |
There was a problem hiding this comment.
move this to operator-sets.md imo
gpsanant
reviewed
Aug 26, 2024
|
|
||
| ### modifyAllocations | ||
|
|
||
| Operators call this to set the proportions of slashable stake allocated to a list of operatorSets for a set of strategies. Depending on what the new magnitude/proportion and current magnitude value is configured to, this will either create a pending allocation or deallocation. Allocations by default have a delay of 21 days but can be one-time configured by an operator. Deallocation delays all have a built-in delay of 17.5 days until they can be "completed". There is a "completing" second step to deallocations that must take place to account for the fact that deallocations are still susceptible to slashing by the operatorSet up until the completeableTimestamp for the deallocation has passed. Pending allocations on the other hand are not slashable (referring to the added increase in magnitude). |
There was a problem hiding this comment.
no need to mention completion imo. just say that after allocation/deallocation delays have passed they automatically take effect.
gpsanant
reviewed
Aug 26, 2024
docs/releases/slashing-release/interfaces/core/slashing-parameter-configuration.md
Outdated
Show resolved
Hide resolved
gpsanant
reviewed
Aug 26, 2024
| 1. if a `MagnitudeAllocation` results in a value greater than the current magnitude, `MagnitudeAllocated` is emitted for the given (operator, IStrategy, operatorSet) | ||
| 2. if a `MagnitudeAllocation` results in a value less than the current magnitude, | ||
| `MagnitudeDeallocated` is emitted for the given (operator, IStrategy, operatorSet) | ||
| 3. |
gpsanant
reviewed
Aug 26, 2024
|
|
||
| ### modifyAllocations | ||
|
|
||
| Operators call this to set the proportions of slashable stake allocated to a list of operatorSets for a set of strategies. Depending on what the new magnitude/proportion and current magnitude value is configured to, this will either create a pending allocation or deallocation. Allocations by default have a delay of 21 days but can be one-time configured by an operator. Deallocation delays all have a built-in delay of 17.5 days until they can be "completed". There is a "completing" second step to deallocations that must take place to account for the fact that deallocations are still susceptible to slashing by the operatorSet up until the completeableTimestamp for the deallocation has passed. Pending allocations on the other hand are not slashable (referring to the added increase in magnitude). |
There was a problem hiding this comment.
there should be no default allocation delay. configutation is blocking allcoation modification.
There was a problem hiding this comment.
we are going with configurable delays but I specified here that a initial delay is required to call modifyAllocations
Co-authored-by: Gautham Anant <[email protected]>
Co-authored-by: Gautham Anant <[email protected]>
Co-authored-by: Gautham Anant <[email protected]>
also added additional reverts to modifyAllocations
|
2 similar comments
|
|
gpsanant
previously approved these changes
Aug 28, 2024
gpsanant
previously approved these changes
Aug 28, 2024
|
| #### **finalizeMigration** | ||
|
|
||
| Only callable by ServiceManager contract owner, this will mark the AVS ServiceManager contract as fully migrated and prevents any future calls to `migrateToOperatorSets`. | ||
|
|
stevennevins
approved these changes
Aug 28, 2024
|
gpsanant
reviewed
Aug 28, 2024
| * @param isSet whether the allocation delay is set. Can only be configured one time for each operator | ||
| * @param allocationDelay the delay in seconds for the operator's allocations | ||
| */ | ||
| struct AllocationDelayDetails { |
There was a problem hiding this comment.
add todo to add this to DM docs
gpsanant
reviewed
Aug 28, 2024
| @@ -63,12 +53,16 @@ interface IAVSDirectory { | |||
| /// EXTERNAL - STATE MODIFYING | |||
|
|
|||
| /** | |||
| * @notice Modifies the proportions of slashable stake allocated to a list of operatorSets for a set of strategies | |||
| * @notice Modifies the propotions of slashable stake allocated to a list of operatorSets for a set of strategies | |||
| * This will revert if the operator has never set their allocationDelay before. | |||
gpsanant
reviewed
Aug 28, 2024
| * @dev Updates freeMagnitude for the updated strategies | ||
| * @dev Must be called by the operator or with a valid operator signature | ||
| * @dev For each allocation, allocation.operatorSets MUST be ordered in ascending order according to the | ||
| * encoding of the operatorSet. This is to prevent duplicate operatorSets being passed in. The easiest way to ensure |
There was a problem hiding this comment.
ew, this is kind of gross to handle offchain, @shrimalmadhur what would you prefer
There was a problem hiding this comment.
we also have to think about LRT or every other client using this directly. I think this should be baked in solidity if possible - otherwise every other thing built on top has to think about it.
gpsanant
reviewed
Aug 28, 2024
| @@ -150,11 +146,11 @@ interface IAVSDirectory { | |||
|
|
|||
| ### modifyAllocations | |||
|
|
|||
| Operators call this to set the proportions of slashable stake allocated to a list of operatorSets for a set of strategies. Depending on what the new magnitude/proportion and current magnitude value is configured to, this will either create a pending allocation or deallocation. Allocations by default have a delay of 21 days but can be one-time configured by an operator. Deallocation delays all have a built-in delay of 17.5 days until they can be "completed". There is a "completing" second step to deallocations that must take place to account for the fact that deallocations are still susceptible to slashing by the operatorSet up until the completeableTimestamp for the deallocation has passed. Pending allocations on the other hand are not slashable (referring to the added increase in magnitude). | |||
| Operators call this to set the proportions of slashable stake allocated to a list of operatorSets for a set of strategies. Depending on what the new magnitude/proportion and current magnitude value is configured to, this will either create a pending allocation or deallocation. Allocation delays can be configured by operators but setting a new value itself has a delay of 21 days. Deallocation delays all have a built-in delay of 17.5 days until they take effect. Deallocations are still susceptible to slashing by the operatorSet up until they take effect. Pending allocations on the other hand are not slashable (referring to the added increase in magnitude). | |||
There was a problem hiding this comment.
do we really want a 21 day delay on the first setting?
gpsanant
approved these changes
Aug 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Tentative plan is to include OperatorSets and Slashing releases as one combined release. This PR is for updating docs to latest interfaces and combining files
INCOMPLETE:
middleware ServiceManagerBase with migration functions