IChromaticVault.sol

IChromaticVault

Interface for the Chromatic Vault contract.

MarketEarningAccumulated

event MarketEarningAccumulated(address market, uint256 earning)

Emitted when market earning is accumulated.

• Parameters:

  Name	Type	Description
  market	address	The address of the market.
  earning	uint256	The amount of earning accumulated.

MakerEarningDistributed

event MakerEarningDistributed(address token, uint256 earning, uint256 usedKeeperFee)

Emitted when maker earning is distributed.

• Parameters:

  Name	Type	Description
  token	address	The address of the settlement token.
  earning	uint256	The amount of earning distributed.
  usedKeeperFee	uint256	The amount of keeper fee used.

MarketEarningDistributed

event MarketEarningDistributed(address market, uint256 earning, uint256 usedKeeperFee, uint256 marketBalance)

Emitted when market earning is distributed.

• Parameters:

  Name	Type	Description
  market	address	The address of the market.
  earning	uint256	The amount of earning distributed.
  usedKeeperFee	uint256	The amount of keeper fee used.
  marketBalance	uint256	The balance of the market.

VaultEarningDistributorSet

event VaultEarningDistributorSet(address vaultEarningDistributor, address oldVaultEarningDistributor)

Emitted when the vault earning distributor address is set.

• Parameters:

  Name	Type	Description
  vaultEarningDistributor	address	The vault earning distributor address.
  oldVaultEarningDistributor	address	The old vault earning distributor address.

setVaultEarningDistributor

function setVaultEarningDistributor(address _earningDistributor) external

pendingMakerEarnings

function pendingMakerEarnings(address token) external view returns (uint256)

pendingMarketEarnings

function pendingMarketEarnings(address market) external view returns (uint256)

createMakerEarningDistributionTask

function createMakerEarningDistributionTask(address token) external

Creates a maker earning distribution task for a token.

• Parameters:

  Name	Type	Description
  token	address	The address of the settlement token.

cancelMakerEarningDistributionTask

function cancelMakerEarningDistributionTask(address token) external

Cancels a maker earning distribution task for a token.

• Parameters:

  Name	Type	Description
  token	address	The address of the settlement token.

distributeMakerEarning

function distributeMakerEarning(address token, uint256 fee, address keeper) external

Distributes the maker earning for a token to the each markets.

• Parameters:

  Name	Type	Description
  token	address	The address of the settlement token.
  fee	uint256	The keeper fee amount.
  keeper	address	The keeper address to receive fee.

createMarketEarningDistributionTask

function createMarketEarningDistributionTask(address market) external

Creates a market earning distribution task for a market.

• Parameters:

  Name	Type	Description
  market	address	The address of the market.

cancelMarketEarningDistributionTask

function cancelMarketEarningDistributionTask(address market) external

Cancels a market earning distribution task for a market.

• Parameters:

  Name	Type	Description
  market	address	The address of the market.

distributeMarketEarning

function distributeMarketEarning(address market, uint256 fee, address keeper) external

Distributes the market earning for a market to the each bins.

• Parameters:

  Name	Type	Description
  market	address	The address of the market.
  fee	uint256	The fee amount.
  keeper	address	The keeper address to receive fee.

acquireTradingLock

function acquireTradingLock() external

releaseTradingLock

function releaseTradingLock() external