Skip to main content

AmmalgamPair

Git Source

Inherits: IAmmalgamPair, TokenController

State Variables​

MINIMUM_LIQUIDITY​

uint256 private constant MINIMUM_LIQUIDITY = 10 ** 3;

BUFFER​

uint256 private constant BUFFER = 95;

unlocked​

uint256 private unlocked = 1;

satStruct​

Saturation.SaturationStruct satStruct;

Functions​

_lock​

function _lock() private view;

lock​

modifier lock();

constructor​

constructor();

mint​

function mint(
    address to
) external lock returns (uint256 liquidityShares);

burn​

function burn(
    address to
) external lock returns (uint256 amountXAssets, uint256 amountYAssets);

swap​

function swap(uint256 amountXOut, uint256 amountYOut, address to, bytes calldata data) external lock;

deposit​

function deposit(
    address to
) external lock;

updateDepositShares​

function updateDepositShares(
    uint256 depositedTokenType,
    uint256 amountAssets,
    uint256 reserveAssets,
    uint256 _missingAssets,
    address to
) private returns (uint256 adjustReserves);

withdraw​

withdraw X and/or Y

function withdraw(
    address to
) external lock;

updateWithdrawShares​

function updateWithdrawShares(address to, uint256 depositedTokenType) private returns (uint256 withdrawnAssets);

borrow​

function borrow(address to, uint256 amountXAssets, uint256 amountYAssets, bytes calldata data) external lock;

borrowHelper​

function borrowHelper(
    Validation.VerifyMaxBorrowXYParams memory maxBorrowParams,
    address to,
    uint256 amountAssets,
    uint112 reserve,
    uint256 borrowedTokenType,
    uint256 depositedTokenType
) private;

updateBorrowOrDepositSharesHelper​

function updateBorrowOrDepositSharesHelper(
    address to,
    uint256 tokenType,
    uint256 amountAssets,
    bool isRoundingUp
) private;

borrowLiquidity​

function borrowLiquidity(
    address to,
    uint256 borrowAmountLAssets,
    bytes calldata data
) external lock returns (uint256, uint256);

repay​

function repay(
    address onBehalfOf
) public lock;

repayHelper​

function repayHelper(
    address onBehalfOf,
    uint256 repayInAssets,
    uint256 reserveInAssets,
    uint256 missingInAssets,
    uint256 borrowTokenType,
    uint256 overSaturationPenaltyAmountDecreasedInAssets
) private returns (uint256 adjustedReservesInAssets);

repayLiquidity​

function repayLiquidity(
    address onBehalfOf
) public lock returns (uint256 amountXAssets, uint256 amountYAssets, uint256 repayLiquidityShares);

skim​

function skim(
    address to
) external lock;

sync​

function sync() external lock;

depletionReserveAdjustmentWhenAssetIsAdded​

When assets are depleted, a user can deposit the depleted asset and earn additional deposit credit for moving the swap curve from the adjusted amount due to assets being depleted to the original curve.

function depletionReserveAdjustmentWhenAssetIsAdded(
    uint256 amountAssets,
    uint256 reserveAssets,
    uint256 _missingAssets
) private pure returns (uint256 adjustReserves_);

accrueInterestAndSaturationPenalties​

function accrueInterestAndSaturationPenalties() private returns (uint112, uint112);

updateObservation​

function updateObservation(uint112 _reserveXAssets, uint112 _reserveYAssets, uint32 currentTimestamp) private;

validateOnUpdate​

function validateOnUpdate(address validate, address update) public;

validateSolvency​

function validateSolvency(
    address validate
) private;

hasBorrows​

function hasBorrows(uint256 borrowX, uint256 borrowY, uint256 borrowL) private pure returns (bool);

getInputParams​

function getInputParams(
    address toCheck
) private view returns (Validation.InputParams memory inputParams, bool hasBorrow);

transferAssets​

function transferAssets(address to, uint256 amountXAssets, uint256 amountYAssets) private;

calcMinLiquidityConsideringDepletion​

function calcMinLiquidityConsideringDepletion(
    uint256 amountXAssets,
    uint256 amountYAssets,
    uint256 _reserveXAssets,
    uint256 _reserveYAssets,
    uint256 activeLiquidityAssets,
    uint256 depositLiquidityAssets,
    uint256 depositLiquidityShares,
    bool isRoundingUp
) private view returns (uint256 liquidityAssets, uint256 liquidityShares);

updateSaturation​

update the saturation structure with its current position

method is virtual to override for isolating tests behavior that does not consider saturation

function updateSaturation(Validation.InputParams memory inputParams, address account) internal virtual;

Parameters

NameTypeDescription
inputParamsValidation.InputParams
accountaddressfor which the sat is updated

calcPenaltyForRepay​

calc penalty to be repaid due to over saturation. the function will reduce the penalty upto the repaid amounts

method is virtual to override for isolating tests behavior that does not consider saturation

function calcPenaltyForRepay(
    address account,
    uint256 currentSqrtPriceInXInQ128,
    uint256 repayAmountLInLAssets,
    uint256 repayAmountXInXAssets,
    uint256 repayAmountYInYAssets
)
    internal
    virtual
    returns (
        uint256 overSaturationPenaltyRemovedLInLAssets,
        uint256 overSaturationPenaltyRemovedXInXAssets,
        uint256 overSaturationPenaltyRemovedYInYAssets
    );

Parameters

NameTypeDescription
accountaddressfor which repay penalty is calculated
currentSqrtPriceInXInQ128uint256of the pair
repayAmountLInLAssetsuint256on behalf of the account
repayAmountXInXAssetsuint256on behalf of the account
repayAmountYInYAssetsuint256on behalf of the account

Returns

NameTypeDescription
overSaturationPenaltyRemovedLInLAssetsuint256the penalty to be paid in L
overSaturationPenaltyRemovedXInXAssetsuint256the penalty to be paid in X
overSaturationPenaltyRemovedYInYAssetsuint256the penalty to be paid in Y

Errors​

Locked​

error Locked();

InsufficientLiquidityMinted​

error InsufficientLiquidityMinted();

InsufficientLiquidityBurned​

error InsufficientLiquidityBurned();

InsufficientOutputAmount​

error InsufficientOutputAmount();

InsufficientInputAmount​

error InsufficientInputAmount();

InsufficientLiquidity​

error InsufficientLiquidity();

InvalidToAddress​

error InvalidToAddress();

K​

error K();

InsufficientRepayLiquidity​

error InsufficientRepayLiquidity();

Overflow​

error Overflow();