@@ -112,9 +112,12 @@ def bid_debt(
112112 ) -> contract .ContractFunction :
113113 """Binding for `bidDebt` on the Auctioneer contract.
114114
115+ Place a bid to liquidate a CDP that is undercollateralized
116+
115117 Parameters
116118 ----------
117119 debtor : eth_typing.ChecksumAddress
120+ The address of the CDP owner
118121 liquidatable_round : int
119122 ntn_amount : int
120123
@@ -136,9 +139,12 @@ def bid_interest(
136139 ) -> contract .ContractFunction :
137140 """Binding for `bidInterest` on the Auctioneer contract.
138141
142+ Place a bid on an interest auction
143+
139144 Parameters
140145 ----------
141146 auction : int
147+ The ID of the auction
142148 ntn_amount : int
143149
144150 Returns
@@ -157,9 +163,12 @@ def get_auction(
157163 ) -> Auction :
158164 """Binding for `getAuction` on the Auctioneer contract.
159165
166+ Get an auction by ID
167+
160168 Parameters
161169 ----------
162170 auction : int
171+ The ID of the auction
163172
164173 Returns
165174 -------
@@ -180,9 +189,12 @@ def get_collateral_token(
180189 ) -> eth_typing .ChecksumAddress :
181190 """Binding for `getCollateralToken` on the Auctioneer contract.
182191
192+ Get the address of the collateral token
193+
183194 Returns
184195 -------
185196 eth_typing.ChecksumAddress
197+ the address of the collateral token
186198 """
187199 return_value = self ._contract .functions .getCollateralToken ().call ()
188200 return eth_typing .ChecksumAddress (return_value )
@@ -192,9 +204,12 @@ def get_config(
192204 ) -> Config :
193205 """Binding for `getConfig` on the Auctioneer contract.
194206
207+ Get the current Auctioneer configuration
208+
195209 Returns
196210 -------
197211 Config
212+ the current configuration
198213 """
199214 return_value = self ._contract .functions .getConfig ().call ()
200215 return Config (
@@ -209,9 +224,12 @@ def get_proceed_address(
209224 ) -> eth_typing .ChecksumAddress :
210225 """Binding for `getProceedAddress` on the Auctioneer contract.
211226
227+ Get the proceed address
228+
212229 Returns
213230 -------
214231 eth_typing.ChecksumAddress
232+ the proceed address
215233 """
216234 return_value = self ._contract .functions .getProceedAddress ().call ()
217235 return eth_typing .ChecksumAddress (return_value )
@@ -223,9 +241,13 @@ def max_liquidation_return(
223241 ) -> int :
224242 """Binding for `maxLiquidationReturn` on the Auctioneer contract.
225243
244+ Get the maximum amount of NTN that can be returned to a liquidator for a given
245+ CDP
246+
226247 Parameters
227248 ----------
228249 debtor : eth_typing.ChecksumAddress
250+ The address of the CDP owner
229251 liquidatable_round : int
230252
231253 Returns
@@ -244,9 +266,12 @@ def min_interest_payment(
244266 ) -> int :
245267 """Binding for `minInterestPayment` on the Auctioneer contract.
246268
269+ Get the minimum amount of NTN that can be paid for an interest auction
270+
247271 Parameters
248272 ----------
249273 auction : int
274+ The ID of the auction
250275
251276 Returns
252277 -------
@@ -262,9 +287,12 @@ def open_auctions(
262287 ) -> typing .List [Auction ]:
263288 """Binding for `openAuctions` on the Auctioneer contract.
264289
290+ Get all open interest auctions
291+
265292 Returns
266293 -------
267294 typing.List[Auction]
295+ An array of all open interest auctions
268296 """
269297 return_value = self ._contract .functions .openAuctions ().call ()
270298 return [
@@ -283,9 +311,12 @@ def set_interest_auction_discount(
283311 ) -> contract .ContractFunction :
284312 """Binding for `setInterestAuctionDiscount` on the Auctioneer contract.
285313
314+ Set the interest auction discount
315+
286316 Parameters
287317 ----------
288318 discount : int
319+ The discount applied to the interest auction
289320
290321 Returns
291322 -------
@@ -302,9 +333,12 @@ def set_interest_auction_duration(
302333 ) -> contract .ContractFunction :
303334 """Binding for `setInterestAuctionDuration` on the Auctioneer contract.
304335
336+ Set the interest auction duration
337+
305338 Parameters
306339 ----------
307340 duration : int
341+ The duration of the interest auction
308342
309343 Returns
310344 -------
@@ -321,9 +355,12 @@ def set_interest_auction_threshold(
321355 ) -> contract .ContractFunction :
322356 """Binding for `setInterestAuctionThreshold` on the Auctioneer contract.
323357
358+ Set the interest auction threshold
359+
324360 Parameters
325361 ----------
326362 threshold : int
363+ The threshold for starting an interest auction
327364
328365 Returns
329366 -------
@@ -340,9 +377,12 @@ def set_liquidation_auction_duration(
340377 ) -> contract .ContractFunction :
341378 """Binding for `setLiquidationAuctionDuration` on the Auctioneer contract.
342379
380+ Set the liquidation auction duration
381+
343382 Parameters
344383 ----------
345384 duration : int
385+ The duration of the liquidation auction
346386
347387 Returns
348388 -------
@@ -359,6 +399,8 @@ def set_proceed_address(
359399 ) -> contract .ContractFunction :
360400 """Binding for `setProceedAddress` on the Auctioneer contract.
361401
402+ Set the proceeds address
403+
362404 Parameters
363405 ----------
364406 proceed_address_ : eth_typing.ChecksumAddress
@@ -666,7 +708,7 @@ def set_proceed_address(
666708 {
667709 "indexed" : False ,
668710 "internalType" : "uint256" ,
669- "name" : "startRound " ,
711+ "name" : "startTimestamp " ,
670712 "type" : "uint256" ,
671713 },
672714 ],
0 commit comments