MarketRemoveLiquidityFacet.sol

MarketRemoveLiquidityFacet

Contract for managing liquidity in a market.

removeLiquidity

function removeLiquidity(address recipient, int16 tradingFeeRate, bytes data) external returns (struct LpReceipt receipt)

This function is called by the liquidity provider to remove their liquidity from the market. The liquidity provider must have previously added liquidity to the market. Throws a TooSmallAmount error if the CLB token amount of liquidity to be removed is zero.

• Parameters:

  Name	Type	Description
  recipient	address	The address to receive the removed liquidity.
  tradingFeeRate	int16	The trading fee rate for the liquidity.
  data	bytes	Additional data for the liquidity callback.

• Return Values:

  Name	Type	Description
  receipt	struct LpReceipt	The liquidity receipt.

removeLiquidityBatch

function removeLiquidityBatch(address recipient, int16[] tradingFeeRates, uint256[] clbTokenAmounts, bytes data) external returns (struct LpReceipt[] receipts)

Throws an InvalidTransferredTokenAmount error if the transferred CLB token amount does not match the expected amount (clbTokenAmounts param).

• Parameters:

  Name	Type	Description
  recipient	address	The address to receive the removed liquidity.
  tradingFeeRates	int16[]	An array of fee rates for each liquidity bin.
  clbTokenAmounts	uint256[]	An array of clb token amounts to remove as liquidity for each bin.
  data	bytes	Additional data for the liquidity callback.

• Return Values:

  Name	Type	Description
  receipts	struct LpReceipt[]	The liquidity receipt.

withdrawLiquidity

function withdrawLiquidity(uint256 receiptId, bytes data) external

Throws a NotExistLpReceipt error if the liquidity receipt does not exist. Throws an InvalidLpReceiptAction error if the action of liquidity receipt is not REMOVE_LIQUIDITY. Throws a NotWithdrawableLpReceipt error if the liquidity receipt is not withdrawable in the current oracle version.

• Parameters:

  Name	Type	Description
  receiptId	uint256	The ID of the liquidity receipt.
  data	bytes	Additional data for the liquidity callback.

withdrawLiquidityBatch

function withdrawLiquidityBatch(uint256[] receiptIds, bytes data) external

Throws a NotExistLpReceipt error if the liquidity receipt does not exist. Throws an InvalidLpReceiptAction error if the action of liquidity receipt is not REMOVE_LIQUIDITY. Throws a NotWithdrawableLpReceipt error if the liquidity receipt is not withdrawable in the current oracle version.

• Parameters:

  Name	Type	Description
  receiptIds	uint256[]	The array of the liquidity receipt IDs.
  data	bytes	Additional data for the liquidity callback.

_requireRemoveLiquidityEnabled

function _requireRemoveLiquidityEnabled(struct MarketStorage ms) internal view virtual

Throws if remove liquidity is disabled.

onERC1155Received

function onERC1155Received(address, address, uint256, uint256, bytes) external pure returns (bytes4)

_Handles the receipt of a single ERC1155 token type. This function is called at the end of a safeTransferFrom after the balance has been updated.

NOTE: To accept the transfer, this must return bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)")) (i.e. 0xf23a6e61, or its own function selector)._

• Parameters:

  Name	Type	Description
  	address
  	address
  	uint256
  	uint256
  	bytes

• Return Values:

  Name	Type	Description
  [0]	bytes4	bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)")) if transfer is allowed

onERC1155BatchReceived

function onERC1155BatchReceived(address, address, uint256[], uint256[], bytes) external pure returns (bytes4)

_Handles the receipt of a multiple ERC1155 token types. This function is called at the end of a safeBatchTransferFrom after the balances have been updated.

NOTE: To accept the transfer(s), this must return bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)")) (i.e. 0xbc197c81, or its own function selector)._

• Parameters:

  Name	Type	Description
  	address
  	address
  	uint256[]
  	uint256[]
  	bytes

• Return Values:

  Name	Type	Description
  [0]	bytes4	bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)")) if transfer is allowed

supportsInterface

function supportsInterface(bytes4 interfaceID) external pure returns (bool)

_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[EIP section] to learn more about how these ids are created.

This function call must use less than 30 000 gas._