IMarket

Overview

Generic single-market proxy roll-up. Specific market flavors implement this interface.

IMarket

Composes the four caller-permission slices for a single market: - IMarketActions: permissionless spot trading (buy, sell, redeem, exercise) and donate. - IMarketLeverageActions: permissionless collateral, debt, and atomic expand/shrink flows. - IMarketGroupAdmin: market-group-admin operations (flags, floor raises, group revenue). - IMarketViews: read-only views (also extends ERC-165). Proxy model: OpenZeppelin BeaconProxy per market, sharing logic via the directory’s single market beacon.Storage initialization is intentionally NOT part of this public surface. It is the private factory↔market contract IMarketInitializer, defined inside avm-program.

Functions

balances

Inherited from IMarketViews.

function balances() returns (struct MarketBalances) view

Returns

• MarketBalances

borrow

Inherited from IMarketLeverageActions.

Draw a reserve-token cash advance against the caller’s collateral.

@grossDebtIncrease — Gross reserve-token debt to add. Borrow fees are withheld from proceeds.

function borrow(RawTokenQuantity grossDebtIncrease) nonpayable

Parameters

• grossDebtIncrease — RawTokenQuantity

buyWithExactAvmTokensOut

Inherited from IMarketActions.

Buy an exact AVM token output amount.

@avmTokensOut — Exact AVM tokens to receive.

@maxReserveTokensIn — Slippage ceiling on gross reserve tokens spent before buy fees are removed.

@receiver — Receiver of minted AVM tokens.

function buyWithExactAvmTokensOut(RawTokenQuantity avmTokensOut, RawTokenQuantity maxReserveTokensIn, address receiver) nonpayable

Parameters

• avmTokensOut — RawTokenQuantity
• maxReserveTokensIn — RawTokenQuantity
• receiver — address

buyWithExactReserveTokensIn

Inherited from IMarketActions.

Buy using an exact reserve-token input amount.

@grossReserveTokensIn — Exact reserve tokens the caller will spend before buy fees are removed.

@minAvmTokensOut — Slippage floor on AVM tokens received.

@receiver — Receiver of minted AVM tokens.

function buyWithExactReserveTokensIn(RawTokenQuantity grossReserveTokensIn, RawTokenQuantity minAvmTokensOut, address receiver) nonpayable

Parameters

• grossReserveTokensIn — RawTokenQuantity
• minAvmTokensOut — RawTokenQuantity
• receiver — address

collectGroupRevenue

Inherited from IMarketGroupAdmin.

function collectGroupRevenue(RawTokenQuantity amount, address recipient) returns (RawTokenQuantity) nonpayable

Parameters

• amount — RawTokenQuantity
• recipient — address

Returns

• collected — RawTokenQuantity

depositCollateral

Inherited from IMarketLeverageActions.

Pledge AVM tokens as collateral to a position keyed by onBehalfOf.

@amount — AVM tokens to pledge.

@onBehalfOf — Position holder being credited; may differ from the caller.

function depositCollateral(RawTokenQuantity amount, address onBehalfOf) nonpayable

Parameters

• amount — RawTokenQuantity
• onBehalfOf — address

directory

Inherited from IMarketViews.

function directory() returns (address) view

Returns

• address

donateLiquidity

Inherited from IMarketActions.

Donate reserve tokens into the market’s internally accounted reserve.

This is a benign, permissionless reserve top-up. It does not mint AVM, create a position, change engineState, or raise the floor. The market has reserve surplus when its accounted reserve plus outstanding debt exceeds the current total area under the curve. That surplus may later be consumed by a separate floor raise from excess liquidity, but donation itself only stores the liquidity.

@amount — Reserve-token amount to transfer into the market reserve.

function donateLiquidity(RawTokenQuantity amount) nonpayable

Parameters

• amount — RawTokenQuantity

engine

Inherited from IMarketViews.

Current pricing engine resolved through the directory for marketKind().

function engine() returns (address) view

Returns

• address

engineState

Inherited from IMarketViews.

Opaque, engine-defined state for the current engine().

The encoding is private to the engine. Bytes returned here MUST NOT be passed to a different engine route unless that engine explicitly supports the same encoding.

function engineState() returns (bytes) view

Returns

• bytes

exerciseOptionTokens

Inherited from IMarketActions.

Burn option tokens at the floor price and mint matching AVM to receiver.

function exerciseOptionTokens(RawTokenQuantity optionTokenAmount, RawTokenQuantity maxReserveTokensIn, address receiver) nonpayable

Parameters

• optionTokenAmount — RawTokenQuantity
• maxReserveTokensIn — RawTokenQuantity
• receiver — address

expandWithExactAvmOut

Inherited from ILeveragedPositionManagement.

Buy and collateralize exact AVM using newly opened debt plus caller wallet reserve.

@avmCollateralAdded — Exact AVM collateral added to the caller’s position.

@grossDebtIncrease — Exact gross reserve-token debt added to the caller’s position.

@maxReserveFromUser — Slippage ceiling on reserve tokens pulled from the caller’s wallet.

function expandWithExactAvmOut(RawTokenQuantity avmCollateralAdded, RawTokenQuantity grossDebtIncrease, RawTokenQuantity maxReserveFromUser) nonpayable

Parameters

• avmCollateralAdded — RawTokenQuantity
• grossDebtIncrease — RawTokenQuantity
• maxReserveFromUser — RawTokenQuantity

expandWithExactReserveIn

Inherited from ILeveragedPositionManagement.

Spend exact wallet reserve plus exact newly opened debt to buy and collateralize AVM.

@grossDebtIncrease — Exact gross reserve-token debt added to the caller’s position.

@minAvmCollateral — Slippage floor on AVM collateral added to the position.

@reserveFromUser — Exact reserve tokens pulled from the caller’s wallet.

function expandWithExactReserveIn(RawTokenQuantity reserveFromUser, RawTokenQuantity grossDebtIncrease, RawTokenQuantity minAvmCollateral) nonpayable

Parameters

• reserveFromUser — RawTokenQuantity
• grossDebtIncrease — RawTokenQuantity
• minAvmCollateral — RawTokenQuantity

flags

Inherited from IMarketViews.

function flags() returns (struct MarketFlags) view

Returns

• MarketFlags

getPosition

Inherited from IMarketViews.

function getPosition(address holder) returns (struct DataTypes.PersonalPosition) view

Parameters

• holder — address

Returns

• position — DataTypes.PersonalPosition

groupId

Inherited from IMarketViews.

function groupId() returns (GroupId) view

Returns

• GroupId

marketId

Inherited from IMarketViews.

function marketId() returns (MarketId) view

Returns

• MarketId

marketKind

Inherited from IMarketViews.

function marketKind() returns (MarketKind) view

Returns

• MarketKind

netIssuedSupply

Inherited from IMarketViews.

Net-issued supply: the portion of AVM supply issued along the trading curve, in raw token units.

Reverts with Errors.NegativeNetIssuedSupply if the offset exceeds total supply, which indicates corrupted accounting.

function netIssuedSupply() returns (RawTokenQuantity) view

Returns

• RawTokenQuantity

raiseFloorFromExcessLiquidity

Inherited from IMarketGroupAdmin.

Raise floor using surplus reserve liquidity already held by the market.

This is the separate operation that may consume surplus created by donateLiquidity; donation itself does not raise the floor.

@newFloorPrice — Target floor price as an unsigned Fixed18 exchange rate (reserve token per AVM token).

function raiseFloorFromExcessLiquidity(ExchangeRate newFloorPrice) nonpayable

Parameters

• newFloorPrice — ExchangeRate

raiseFloorPreserveArea

Inherited from IMarketGroupAdmin.

Raise floor while preserving curve area by explicitly choosing the new ramp end.

@newFloorPrice — Target floor price as an unsigned Fixed18 exchange rate (reserve token per AVM token).

@newRampEndSupply — Target ramp-end x-value as an unscaled raw count of the AVM token’s smallest unit.

function raiseFloorPreserveArea(RawTokenQuantity newRampEndSupply, ExchangeRate newFloorPrice) nonpayable

Parameters

• newRampEndSupply — RawTokenQuantity
• newFloorPrice — ExchangeRate

redeemAtFloorWithExactAvmTokensIn

Inherited from IMarketActions.

Redeem an exact AVM token amount at the current floor price.

Floor redemption is a permissionless constant-price sell. It burns exact AVM input, applies the normal sell fee to the gross floor-price reserve output, and commits the engine’s floor-redemption state transition. No slippage bound is required because the floor price is guaranteed not to decrease.

@avmTokensIn — Exact AVM tokens to redeem and burn.

@receiver — Receiver of net reserve-token proceeds.

function redeemAtFloorWithExactAvmTokensIn(RawTokenQuantity avmTokensIn, address receiver) nonpayable

Parameters

• avmTokensIn — RawTokenQuantity
• receiver — address

repay

Inherited from IMarketLeverageActions.

Repay an outstanding cash advance on a position keyed by onBehalfOf.

@amount — Reserve tokens to repay (capped at outstanding debt).

@onBehalfOf — Position holder whose debt is being reduced.

function repay(RawTokenQuantity amount, address onBehalfOf) nonpayable

Parameters

• amount — RawTokenQuantity
• onBehalfOf — address

sellWithExactAvmTokensIn

Inherited from IMarketActions.

Sell using an exact AVM token input amount.

@avmTokensIn — Exact AVM tokens to sell.

@minReserveTokensOut — Slippage floor on net reserve tokens received after sell fees.

@receiver — Receiver of reserve-token proceeds.

function sellWithExactAvmTokensIn(RawTokenQuantity avmTokensIn, RawTokenQuantity minReserveTokensOut, address receiver) nonpayable

Parameters

• avmTokensIn — RawTokenQuantity
• minReserveTokensOut — RawTokenQuantity
• receiver — address

sellWithExactReserveTokensOut

Inherited from IMarketActions.

Sell for an exact reserve-token output amount after fees.

@maxAvmTokensIn — Slippage ceiling on AVM tokens sold.

@netReserveTokensOut — Exact reserve tokens the receiver gets after sell fees.

@receiver — Receiver of reserve-token proceeds.

function sellWithExactReserveTokensOut(RawTokenQuantity netReserveTokensOut, RawTokenQuantity maxAvmTokensIn, address receiver) nonpayable

Parameters

• netReserveTokensOut — RawTokenQuantity
• maxAvmTokensIn — RawTokenQuantity
• receiver — address

setMarketFlags

Inherited from IMarketGroupAdmin.

function setMarketFlags(struct MarketFlags newFlags) nonpayable

Parameters

• newFlags — MarketFlags

shrinkWithExactAvmIn

Inherited from ILeveragedPositionManagement.

Sell exact AVM collateral, repay exact debt, and send residual reserve to the caller.

@avmCollateralRemoved — Exact AVM collateral removed from the caller’s position and sold.

@debtDecrease — Exact reserve-token debt repaid from the sell proceeds.

@minReserveTokensToUser — Slippage floor on actual reserve tokens sent to the caller after fees and repayment.

function shrinkWithExactAvmIn(RawTokenQuantity avmCollateralRemoved, RawTokenQuantity debtDecrease, RawTokenQuantity minReserveTokensToUser) nonpayable

Parameters

• avmCollateralRemoved — RawTokenQuantity
• debtDecrease — RawTokenQuantity
• minReserveTokensToUser — RawTokenQuantity

shrinkWithExactReserveOut

Inherited from ILeveragedPositionManagement.

Sell enough AVM collateral to repay exact debt and send exact reserve tokens to the caller.

@debtDecrease — Exact reserve-token debt repaid from the sell proceeds.

@maxAvmCollateralRemoved — Slippage ceiling on AVM collateral removed and sold.

@netReserveTokensToUser — Exact reserve tokens sent to the caller after sell fees and debt repayment.

function shrinkWithExactReserveOut(RawTokenQuantity netReserveTokensToUser, RawTokenQuantity debtDecrease, RawTokenQuantity maxAvmCollateralRemoved) nonpayable

Parameters

• netReserveTokensToUser — RawTokenQuantity
• debtDecrease — RawTokenQuantity
• maxAvmCollateralRemoved — RawTokenQuantity

snapshot

Inherited from IMarketViews.

function snapshot() returns (struct DataTypes.MarketStateSnapshot) view

Returns

• DataTypes.MarketStateSnapshot

state

Inherited from IMarketViews.

State of the market, with no derived values.

function state() returns (struct MarketState) view

Returns

• MarketState

supplyOffset

Inherited from IMarketViews.

Signed count of AVM tokens (raw units) that exist off the trading curve: option exercises add to it, floor redemptions subtract.

Net-issued (curve) supply is totalSupply() - supplyOffset(); the market prices every trade at net-issued supply, never total supply.

function supplyOffset() returns (int256) view

Returns

• int256

supportsInterface

Returns true if this contract implements the interface defined by interfaceId. See the corresponding https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[ERC section] to learn more about how these ids are created. This function call must use less than 30 000 gas.

function supportsInterface(bytes4 interfaceId) returns (bool) view

Parameters

• interfaceId — bytes4

Returns

• bool

tenantId

Inherited from IMarketViews.

Tenant that owns this market’s group.

Resolved dynamically through IAvmDirectoryViews.getMarketGroup. A group’s tenant is fixed at group creation, so this value is stable for the market’s lifetime.

function tenantId() returns (TenantId) view

Returns

• TenantId

tokens

Inherited from IMarketViews.

function tokens() returns (struct TokenSet) view

Returns

• TokenSet

withdrawCollateral

Inherited from IMarketLeverageActions.

Reclaim pledged AVM collateral. Always flows to the caller’s own position.

@amount — AVM tokens to withdraw.

function withdrawCollateral(RawTokenQuantity amount) nonpayable

Parameters

• amount — RawTokenQuantity