Conversation
|
👋 aelmanaa, thanks for creating this pull request! To help reviewers, please consider creating future PRs as drafts first. This allows you to self-review and make any final changes before notifying the team. Once you're ready, you can mark it as "Ready for review" to request feedback. Thanks! |
This file contains hidden or 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
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 pull request introduces a guard to prevent misconfiguration of cross-chain token lanes where both ends use lock-release pools—a setup that causes liquidity to drain in one direction and requires manual rebalancing. The changes add explicit refusal (with an override) to the
ApplyChainUpdatesscript, update documentation to clarify the hazard and workflow, and add tests to enforce and verify the new logic.Key changes:
Lock-and-lock lane prevention logic
_refuseLockAndLockfunction toApplyChainUpdates.s.solthat checks if both ends of a lane are lock-release pools and refuses to apply the lane unlessACK_LOCK_AND_LOCK=trueis set, or warns in safe mode. This prevents accidental draining of liquidity. [1] [2] [3]lockAndLockReasonForTestfor testability and added a helper to check deployment keys for lock-release pools. [1] [2]RegistryWriterwith_activeDeploymentKeyto extract the pool type/version from a peer's project store, enabling the guard to function.Documentation updates
liquidity.md,pools.md,lanes-and-remotes.md,troubleshooting/index.md) to explain the lock-and-lock hazard, refusal behavior, override mechanism, and relevant environment variables. [1] [2] [3] [4]ACK_LOCK_AND_LOCKto the list of environment variables in both the primitive and its catalog entry. [1] [2]Testing
ApplyChainUpdatesLockAndLock.t.soltest contract to verify the new refusal logic for various peer pool configurations, including positive (refusal) and negative (allow) cases.These changes collectively ensure that dangerous lock-and-lock lanes are not created by accident, and provide clear instructions, override options, and test coverage for this behavior.