ICollateralBidActions

Functions

buyCollateral

Buys collateral tokens from a collateral auction

This method will fail if the purchased amount is lower than the minimum, or the bid higher than the specified amount

function buyCollateral(
  address _coinJoin,
  address _collateralJoin,
  address _collateralAuctionHouse,
  uint256 _auctionId,
  uint256 _minCollateralAmount,
  uint256 _bidAmount
) external;

Parameters

Name	Type	Description
`_coinJoin`	`address`	Address of the CoinJoin contract
`_collateralJoin`	`address`	Address of the CollateralJoin contract
`_collateralAuctionHouse`	`address`	Address of the CollateralAuctionHouse contract
`_auctionId`	`uint256`	Id of the auction to bid on
`_minCollateralAmount`	`uint256`	Minimum amount of collateral tokens to buy [wad]
`_bidAmount`	`uint256`	Amount of system coins to bid [wad]

Errors

ColActions_InvalidAdjustedBid

Throws if the adjusted bid is invalid

error ColActions_InvalidAdjustedBid();

ColActions_InsufficientCollateralReceived

Throws if the received collateral is less than the minimum

error ColActions_InsufficientCollateralReceived(uint256 _minCollateralAmount, uint256 _received);