Merge branch 'main'

Author: danielattilasimon

docs/sdk/lib-ethers.borrowingoperationoptionalparams.borrowingfeedecaytoleranceminutes.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@liquity/lib-ethers](./lib-ethers.md) &gt; [BorrowingOperationOptionalParams](./lib-ethers.borrowingoperationoptionalparams.md) &gt; [borrowingFeeDecayToleranceMinutes](./lib-ethers.borrowingoperationoptionalparams.borrowingfeedecaytoleranceminutes.md)
+
+## BorrowingOperationOptionalParams.borrowingFeeDecayToleranceMinutes property
+
+Control the amount of extra gas included attached to the transaction.
+
+<b>Signature:</b>
+
+```typescript
+borrowingFeeDecayToleranceMinutes?: number;
+```
+
+## Remarks
+
+Transactions that borrow LUSD must pay a variable borrowing fee, which is added to the Trove's debt. This fee increases whenever a redemption occurs, and otherwise decays exponentially. Due to this decay, a Trove's collateral ratio can end up being higher than initially calculated if the transaction is pending for a long time. When this happens, the backend has to iterate over the sorted list of Troves to find a new position for the Trove, which costs extra gas.
+
+The SDK can estimate how much the gas costs of the transaction may increase due to this decay, and can include additional gas to ensure that it will still succeed, even if it ends up pending for a relatively long time. This parameter specifies the length of time that should be covered by the extra gas.
+
+Default: 60 minutes.
+

docs/sdk/lib-ethers.borrowingoperationoptionalparams.maxborrowingrate.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@liquity/lib-ethers](./lib-ethers.md) &gt; [BorrowingOperationOptionalParams](./lib-ethers.borrowingoperationoptionalparams.md) &gt; [maxBorrowingRate](./lib-ethers.borrowingoperationoptionalparams.maxborrowingrate.md)
+
+## BorrowingOperationOptionalParams.maxBorrowingRate property
+
+Maximum acceptable [borrowing rate](./lib-base.fees.borrowingrate.md) (default: current borrowing rate plus 0.5%).
+
+<b>Signature:</b>
+
+```typescript
+maxBorrowingRate?: Decimalish;
+```

docs/sdk/lib-ethers.borrowingoperationoptionalparams.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@liquity/lib-ethers](./lib-ethers.md) &gt; [BorrowingOperationOptionalParams](./lib-ethers.borrowingoperationoptionalparams.md)
+
+## BorrowingOperationOptionalParams interface
+
+Optional parameters of a transaction that borrows LUSD.
+
+<b>Signature:</b>
+
+```typescript
+export interface BorrowingOperationOptionalParams 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [borrowingFeeDecayToleranceMinutes?](./lib-ethers.borrowingoperationoptionalparams.borrowingfeedecaytoleranceminutes.md) | number | <i>(Optional)</i> Control the amount of extra gas included attached to the transaction. |
+|  [maxBorrowingRate?](./lib-ethers.borrowingoperationoptionalparams.maxborrowingrate.md) | [Decimalish](./lib-base.decimalish.md) | <i>(Optional)</i> Maximum acceptable [borrowing rate](./lib-base.fees.borrowingrate.md) (default: current borrowing rate plus 0.5%). |
+

docs/sdk/lib-ethers.ethersliquity.adjusttrove.md

@@ -9,15 +9,15 @@ Adjust existing Trove by changing its collateral, debt, or both.
 <b>Signature:</b>
 
 ```typescript
-adjustTrove(params: TroveAdjustmentParams<Decimalish>, maxBorrowingRate?: Decimalish, overrides?: EthersTransactionOverrides): Promise<TroveAdjustmentDetails>;
+adjustTrove(params: TroveAdjustmentParams<Decimalish>, maxBorrowingRateOrOptionalParams?: Decimalish | BorrowingOperationOptionalParams, overrides?: EthersTransactionOverrides): Promise<TroveAdjustmentDetails>;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  params | [TroveAdjustmentParams](./lib-base.troveadjustmentparams.md)<!-- -->&lt;[Decimalish](./lib-base.decimalish.md)<!-- -->&gt; | Parameters of the adjustment. |
-|  maxBorrowingRate | [Decimalish](./lib-base.decimalish.md) | Maximum acceptable [borrowing rate](./lib-base.fees.borrowingrate.md) if <code>params</code> includes <code>borrowLUSD</code>. |
+|  maxBorrowingRateOrOptionalParams | [Decimalish](./lib-base.decimalish.md) \| [BorrowingOperationOptionalParams](./lib-ethers.borrowingoperationoptionalparams.md) |  |
 |  overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) |  |
 
 <b>Returns:</b>
@@ -26,7 +26,7 @@ Promise&lt;[TroveAdjustmentDetails](./lib-base.troveadjustmentdetails.md)<!-- --
 
 ## Exceptions
 
-Throws [EthersTransactionFailedError](./lib-ethers.etherstransactionfailederror.md) in case of transaction failure.
+Throws [EthersTransactionFailedError](./lib-ethers.etherstransactionfailederror.md) in case of transaction failure. Throws [EthersTransactionCancelledError](./lib-ethers.etherstransactioncancellederror.md) if the transaction is cancelled or replaced.
 
 ## Remarks
 

docs/sdk/lib-ethers.ethersliquity.approveunitokens.md

@@ -25,7 +25,7 @@ Promise<void>
 
 ## Exceptions
 
-Throws [EthersTransactionFailedError](./lib-ethers.etherstransactionfailederror.md) in case of transaction failure.
+Throws [EthersTransactionFailedError](./lib-ethers.etherstransactionfailederror.md) in case of transaction failure. Throws [EthersTransactionCancelledError](./lib-ethers.etherstransactioncancellederror.md) if the transaction is cancelled or replaced.
 
 ## Remarks
 

docs/sdk/lib-ethers.ethersliquity.borrowlusd.md

@@ -26,7 +26,7 @@ Promise&lt;[TroveAdjustmentDetails](./lib-base.troveadjustmentdetails.md)<!-- --
 
 ## Exceptions
 
-Throws [EthersTransactionFailedError](./lib-ethers.etherstransactionfailederror.md) in case of transaction failure.
+Throws [EthersTransactionFailedError](./lib-ethers.etherstransactionfailederror.md) in case of transaction failure. Throws [EthersTransactionCancelledError](./lib-ethers.etherstransactioncancellederror.md) if the transaction is cancelled or replaced.
 
 ## Remarks
 

docs/sdk/lib-ethers.ethersliquity.claimcollateralsurplus.md

@@ -24,7 +24,7 @@ Promise<void>
 
 ## Exceptions
 
-Throws [EthersTransactionFailedError](./lib-ethers.etherstransactionfailederror.md) in case of transaction failure.
+Throws [EthersTransactionFailedError](./lib-ethers.etherstransactionfailederror.md) in case of transaction failure. Throws [EthersTransactionCancelledError](./lib-ethers.etherstransactioncancellederror.md) if the transaction is cancelled or replaced.
 
 ## Remarks
 

docs/sdk/lib-ethers.ethersliquity.closetrove.md

@@ -24,5 +24,5 @@ Promise&lt;[TroveClosureDetails](./lib-base.troveclosuredetails.md)<!-- -->&gt;
 
 ## Exceptions
 
-Throws [EthersTransactionFailedError](./lib-ethers.etherstransactionfailederror.md) in case of transaction failure.
+Throws [EthersTransactionFailedError](./lib-ethers.etherstransactionfailederror.md) in case of transaction failure. Throws [EthersTransactionCancelledError](./lib-ethers.etherstransactioncancellederror.md) if the transaction is cancelled or replaced.
 

docs/sdk/lib-ethers.ethersliquity.depositcollateral.md

@@ -25,7 +25,7 @@ Promise&lt;[TroveAdjustmentDetails](./lib-base.troveadjustmentdetails.md)<!-- --
 
 ## Exceptions
 
-Throws [EthersTransactionFailedError](./lib-ethers.etherstransactionfailederror.md) in case of transaction failure.
+Throws [EthersTransactionFailedError](./lib-ethers.etherstransactionfailederror.md) in case of transaction failure. Throws [EthersTransactionCancelledError](./lib-ethers.etherstransactioncancellederror.md) if the transaction is cancelled or replaced.
 
 ## Remarks
 

docs/sdk/lib-ethers.ethersliquity.depositlusdinstabilitypool.md

@@ -26,7 +26,7 @@ Promise<[StabilityDepositChangeDetails](./lib-base.stabilitydepositchangedeta
 
 ## Exceptions
 
-Throws [EthersTransactionFailedError](./lib-ethers.etherstransactionfailederror.md) in case of transaction failure.
+Throws [EthersTransactionFailedError](./lib-ethers.etherstransactionfailederror.md) in case of transaction failure. Throws [EthersTransactionCancelledError](./lib-ethers.etherstransactioncancellederror.md) if the transaction is cancelled or replaced.
 
 ## Remarks