dex: streamline PositionManager
#4098
Merged
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
hdevalence
force-pushed
the
dex-positionmanager-streamline
branch
from
999c33d to
d33971e
Compare
hdevalence
commented
Mar 26, 2024
Comment on lines
+207
to
+219
| // Handle "close-on-fill": automatically flip the position state to "closed" if | ||
| // either of the reserves are zero. | ||
| if position.close_on_fill { | ||
| if position.reserves.r1 == 0u64.into() || position.reserves.r2 == 0u64.into() { | ||
| tracing::debug!( | ||
| id = ?position.id(), | ||
| r1 = ?position.reserves.r1, | ||
| r2 = ?position.reserves.r2, | ||
| "marking position as closed due to close-on-fill" | ||
| ); | ||
| position.state = position::State::Closed; | ||
| } | ||
| } |
There was a problem hiding this comment.
@erwanor this can be done safely now that we're distinguishing position execution from other position handling
There was a problem hiding this comment.
This looks great, I think we should add a guard just to be paranoid against indexing/validation failures. The reasoning is that the inflation bug was two-pronged: you could create positions with duplicate IDs, and position execution/handling was commingled.
hdevalence
commented
Mar 26, 2024
Comment on lines
+271
to
+273
| let mut position_1 = SellOrder::parse_str("100gm@1gn")?.into_position(OsRng); | ||
| position_1.close_on_fill = true; | ||
| let position_2 = SellOrder::parse_str("100gm@1.1gn")?.into_position(OsRng); |
There was a problem hiding this comment.
this is much nicer for writing tests than many of the existing methods (which were made prior to this api)
This implements an API suggestion originally made by @cronokirby to expose context-specific methods for updating positions. We maintain a single `put_position` method on the `Inner` trait so that we're able to have a single point where we edit any necessary indexes, but this is now not exposed to callers. Instead they call a scope-specific method that calls `put_position` internally. Currently there's still room to improve the API safety but we'll want to potentially change the signature of `put_position` to ensure that this remains efficient. It would be ideal if it were possible to do all reads up front and concurrently. Further investigation on this point would be desirable. This commit has a security-critical change in that the logic for position withdrawals' balance commitment changes, and it'd be good to get review on that part in particular.
hdevalence
force-pushed
the
dex-positionmanager-streamline
branch
from
c69ba97 to
01c416a
Compare
erwanor
reviewed
Mar 26, 2024
|
|
||
| /// Withdraw from a closed position, incrementing its sequence number. | ||
| /// | ||
| /// Updates the position's reserves and rewards to zero and returns the withdrawn balance. |
There was a problem hiding this comment.
It doesn't actually zero the rewards, right?
erwanor
approved these changes
Mar 26, 2024
| .reserves | ||
| .balance(&metadata.phi.pair) | ||
| .commit(Fr::zero()); | ||
| let expected_reserves_commitment = actual_reserves.commit(Fr::zero()); |
There was a problem hiding this comment.
ACK: I am convinced that this is correct because position_withdraw returns the withdrawn reserves
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.
This implements an API suggestion originally made by @cronokirby to expose context-specific methods for updating positions.
We maintain a single
put_positionmethod on theInnertrait so that we'reable to have a single point where we edit any necessary indexes, but this is
now not exposed to callers. Instead they call a scope-specific method that
calls
put_positioninternally.Currently there's still room to improve the API safety but we'll want to
potentially change the signature of
put_positionto ensure that this remainsefficient. It would be ideal if it were possible to do all reads up front and
concurrently. Further investigation on this point would be desirable.
This commit has a security-critical change in that the logic for position
withdrawals' balance commitment changes, and it'd be good to get review on that
part in particular.