IMarketState.sol

IMarketState

Interface for accessing the state of a market contract.

factory

function factory() external view returns (contract IChromaticMarketFactory)

Returns the factory contract for the market.

• Return Values:

  Name	Type	Description
  [0]	contract IChromaticMarketFactory	The factory contract.

settlementToken

function settlementToken() external view returns (contract IERC20Metadata)

Returns the settlement token of the market.

• Return Values:

  Name	Type	Description
  [0]	contract IERC20Metadata	The settlement token.

oracleProvider

function oracleProvider() external view returns (contract IOracleProvider)

Returns the oracle provider contract for the market.

• Return Values:

  Name	Type	Description
  [0]	contract IOracleProvider	The oracle provider contract.

clbToken

function clbToken() external view returns (contract ICLBToken)

Returns the CLB token contract for the market.

• Return Values:

  Name	Type	Description
  [0]	contract ICLBToken	The CLB token contract.

vault

function vault() external view returns (contract IChromaticVault)

Returns the vault contract for the market.

• Return Values:

  Name	Type	Description
  [0]	contract IChromaticVault	The vault contract.

protocolFeeRate

function protocolFeeRate() external view returns (uint16)

Returns the protocol fee rate

• Return Values:

  Name	Type	Description
  [0]	uint16	The protocol fee rate for the market

updateProtocolFeeRate

function updateProtocolFeeRate(uint16 _protocolFeeRate) external

Update the new protocol fee rate

• Parameters:

  Name	Type	Description
  _protocolFeeRate	uint16	new protocol fee rate for the market

positionMode

function positionMode() external view returns (enum PositionMode)

Returns the position mode

• Return Values:

  Name	Type	Description
  [0]	enum PositionMode	The position mode for the market

updatePositionMode

function updatePositionMode(enum PositionMode _positionMode) external

Update the new position mode

• Parameters:

  Name	Type	Description
  _positionMode	enum PositionMode	new position mode for the market

liquidityMode

function liquidityMode() external view returns (enum LiquidityMode)

Returns the liquidity mode

• Return Values:

  Name	Type	Description
  [0]	enum LiquidityMode	The liquidity mode for the market

updateLiquidityMode

function updateLiquidityMode(enum LiquidityMode _liquidityMode) external

Update the new liquidity mode

• Parameters:

  Name	Type	Description
  _liquidityMode	enum LiquidityMode	new liquidity mode for the market

displayMode

function displayMode() external view returns (enum DisplayMode)

Returns the display mode

• Return Values:

  Name	Type	Description
  [0]	enum DisplayMode	The display mode for the market

updateDisplayMode

function updateDisplayMode(enum DisplayMode _displayMode) external

Update the new display mode

• Parameters:

  Name	Type	Description
  _displayMode	enum DisplayMode	new display mode for the market