Skip to content

Commit

Permalink
add natspec
Browse files Browse the repository at this point in the history
  • Loading branch information
davidbrai committed Oct 10, 2023
1 parent 3b536b0 commit a1d52a2
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions packages/nouns-contracts/contracts/NounsAuctionHouseV2.sol
Original file line number Diff line number Diff line change
Expand Up @@ -355,6 +355,7 @@ contract NounsAuctionHouseV2 is
/**
* @notice Get past auction settlements.
* @dev Returns settlements in reverse order, meaning settlements[0] will be the most recent auction price.
* Skips auctions where there was no winner, i.e. no bids.
* @param auctionCount The number of price observations to get.
* @return settlements An array of type `Settlement`, where each Settlement includes a timestamp,
* the Noun ID of that auction, the winning bid amount, and the winner's address.
Expand Down Expand Up @@ -397,6 +398,7 @@ contract NounsAuctionHouseV2 is
/**
* @notice Get past auction prices.
* @dev Returns prices in reverse order, meaning prices[0] will be the most recent auction price.
* Skips auctions where there was no winner, i.e. no bids.
* @param auctionCount The number of price observations to get.
* @return prices An array of uint256 prices.
*/
Expand Down Expand Up @@ -433,6 +435,7 @@ contract NounsAuctionHouseV2 is
/**
* @notice Get a range of past auction settlements.
* @dev Returns prices in chronological order, as opposed to `getSettlements(count)` which returns prices in reverse order.
* Skips auctions where there was no winner, i.e. no bids.
* @param startId the first Noun ID to get prices for.
* @param endId end Noun ID (up to, but not including).
* @return settlements An array of type `Settlement`, where each Settlement includes a timestamp,
Expand Down Expand Up @@ -472,6 +475,7 @@ contract NounsAuctionHouseV2 is
/**
* @notice Get a range of past auction prices.
* @dev Returns prices in chronological order, as opposed to `getPrices(count)` which returns prices in reverse order.
* Skips auctions where there was no winner, i.e. no bids.
* @param startId the first Noun ID to get prices for.
* @param endId end Noun ID (up to, but not including).
* @return prices An array of uint256 prices.
Expand Down

0 comments on commit a1d52a2

Please sign in to comment.