Skip to content

feat(amm): Introduce swap external function with full Natspec documentation #118

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Oct 3, 2025
Merged

feat(amm): Introduce swap external function with full Natspec documentation #118

merged 1 commit into from
Oct 3, 2025

Conversation

0xRiz0
Copy link
Member

@0xRiz0 0xRiz0 commented Oct 3, 2025

Description

This PR adds a fully documented swap external function to the TestAMMContract, implementing the classic constant product AMM formula (x * y = k). This enables token swapping within a selected market pool while providing slippage protection, reserve updates, and event hooks for off-chain monitoring.

✅ Key Features

  • New Swap Functionality
function swap(
    bytes32 _marketId,
    uint256 _amountIn,
    uint256 _amountOutMinimum,
    bool _zeroForOne
) external

@0xRiz0 0xRiz0 self-assigned this Oct 3, 2025
@0xRiz0 0xRiz0 added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 3, 2025
@0xRiz0 0xRiz0 merged commit 1db4f75 into main Oct 3, 2025
0 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@0xRiz0 0xRiz0

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@0xRiz0