Skip to content

Commit 73d1dc8

Browse files
duelinggaloisduelinggalois
authored
Updated contract docs for opened pull request feature/debt-revoke-allowance
1 parent 776e9d0 commit 73d1dc8

52 files changed

Lines changed: 112 additions & 121 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/developer-guide/contracts/AmmalgamPair.sol/contract.AmmalgamPair.md‎

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AmmalgamPair
2-
[Git Source](https://github.com/Ammalgam-Protocol/core-v1/blob/2b185eab2df708b55f7ffa534655c69f626e73b3/contracts/AmmalgamPair.sol)
2+
[Git Source](https://github.com/Ammalgam-Protocol/core-v1/blob/6a977aaedd1994271bc7ffff9754778774735fac/contracts/AmmalgamPair.sol)
33

44
**Inherits:**
55
[IAmmalgamPair](/docs/developer-guide/contracts/interfaces/IAmmalgamPair.sol/interface.IAmmalgamPair.md), [TokenController](/docs/developer-guide/contracts/tokens/TokenController.sol/contract.TokenController.md)
@@ -369,14 +369,7 @@ Liquidation based on change of saturation because of time.
369369

370370

371371
```solidity
372-
function resetSaturation(
373-
Validation.InputParams memory inputParams,
374-
address borrower,
375-
address to,
376-
uint256 depositLToBeTransferredInLAssets,
377-
uint256 depositXToBeTransferredInXAssets,
378-
uint256 depositYToBeTransferredInYAssets
379-
) private;
372+
function resetSaturation(Validation.InputParams memory inputParams, address borrower, address to) private;
380373
```
381374
**Parameters**
382375

@@ -385,9 +378,6 @@ function resetSaturation(
385378
|`inputParams`|`Validation.InputParams`||
386379
|`borrower`|`address`|The account being liquidated.|
387380
|`to`|`address`|The account to send the liquidated deposit to|
388-
|`depositLToBeTransferredInLAssets`|`uint256`|The amount of L to be transferred to the liquidator.|
389-
|`depositXToBeTransferredInXAssets`|`uint256`|The amount of X to be transferred to the liquidator.|
390-
|`depositYToBeTransferredInYAssets`|`uint256`|The amount of Y to be transferred to the liquidator.|
391381

392382

393383
### liquidateLeverage

‎docs/developer-guide/contracts/SaturationAndGeometricTWAPState.sol/contract.SaturationAndGeometricTWAPState.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# SaturationAndGeometricTWAPState
2-
[Git Source](https://github.com/Ammalgam-Protocol/core-v1/blob/2b185eab2df708b55f7ffa534655c69f626e73b3/contracts/SaturationAndGeometricTWAPState.sol)
2+
[Git Source](https://github.com/Ammalgam-Protocol/core-v1/blob/6a977aaedd1994271bc7ffff9754778774735fac/contracts/SaturationAndGeometricTWAPState.sol)
33

44
**Inherits:**
55
Initializable, [ISaturationAndGeometricTWAPState](/docs/developer-guide/contracts/interfaces/ISaturationAndGeometricTWAPState.sol/interface.ISaturationAndGeometricTWAPState.md), OwnableUpgradeable
@@ -249,7 +249,7 @@ function calcSatChangeRatioBips(
249249
uint256 liqSqrtPriceInYInQ72,
250250
address pairAddress,
251251
address account
252-
) external view virtual isInitialized returns (uint256 ratioNetXBips, uint256 ratioNetYBips);
252+
) external view virtual isInitialized returns (uint256 ratioBips);
253253
```
254254
**Parameters**
255255

@@ -265,8 +265,7 @@ function calcSatChangeRatioBips(
265265

266266
|Name|Type|Description|
267267
|----|----|-----------|
268-
|`ratioNetXBips`|`uint256`|The ratio representing the change in netX saturation for account.|
269-
|`ratioNetYBips`|`uint256`|The ratio representing the change in netY saturation for account.|
268+
|`ratioBips`|`uint256`|The ratio representing the change saturation for account.|
270269

271270

272271
### getObservations

‎docs/developer-guide/contracts/factories/AmmalgamFactory.sol/contract.AmmalgamFactory.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AmmalgamFactory
2-
[Git Source](https://github.com/Ammalgam-Protocol/core-v1/blob/2b185eab2df708b55f7ffa534655c69f626e73b3/contracts/factories/AmmalgamFactory.sol)
2+
[Git Source](https://github.com/Ammalgam-Protocol/core-v1/blob/6a977aaedd1994271bc7ffff9754778774735fac/contracts/factories/AmmalgamFactory.sol)
33

44
**Inherits:**
55
[IAmmalgamFactory](/docs/developer-guide/contracts/interfaces/factories/IAmmalgamFactory.sol/interface.IAmmalgamFactory.md)

‎docs/developer-guide/contracts/factories/ERC20DebtLiquidityTokenFactory.sol/contract.ERC20DebtLiquidityTokenFactory.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ERC20DebtLiquidityTokenFactory
2-
[Git Source](https://github.com/Ammalgam-Protocol/core-v1/blob/2b185eab2df708b55f7ffa534655c69f626e73b3/contracts/factories/ERC20DebtLiquidityTokenFactory.sol)
2+
[Git Source](https://github.com/Ammalgam-Protocol/core-v1/blob/6a977aaedd1994271bc7ffff9754778774735fac/contracts/factories/ERC20DebtLiquidityTokenFactory.sol)
33

44
**Inherits:**
55
[ITokenFactory](/docs/developer-guide/contracts/interfaces/factories/ITokenFactory.sol/interface.ITokenFactory.md)

‎docs/developer-guide/contracts/factories/ERC20LiquidityTokenFactory.sol/contract.ERC20LiquidityTokenFactory.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ERC20LiquidityTokenFactory
2-
[Git Source](https://github.com/Ammalgam-Protocol/core-v1/blob/2b185eab2df708b55f7ffa534655c69f626e73b3/contracts/factories/ERC20LiquidityTokenFactory.sol)
2+
[Git Source](https://github.com/Ammalgam-Protocol/core-v1/blob/6a977aaedd1994271bc7ffff9754778774735fac/contracts/factories/ERC20LiquidityTokenFactory.sol)
33

44
**Inherits:**
55
[ITokenFactory](/docs/developer-guide/contracts/interfaces/factories/ITokenFactory.sol/interface.ITokenFactory.md)

‎docs/developer-guide/contracts/factories/ERC4626DebtTokenFactory.sol/contract.ERC4626DebtTokenFactory.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ERC4626DebtTokenFactory
2-
[Git Source](https://github.com/Ammalgam-Protocol/core-v1/blob/2b185eab2df708b55f7ffa534655c69f626e73b3/contracts/factories/ERC4626DebtTokenFactory.sol)
2+
[Git Source](https://github.com/Ammalgam-Protocol/core-v1/blob/6a977aaedd1994271bc7ffff9754778774735fac/contracts/factories/ERC4626DebtTokenFactory.sol)
33

44
**Inherits:**
55
[ITokenFactory](/docs/developer-guide/contracts/interfaces/factories/ITokenFactory.sol/interface.ITokenFactory.md)

‎docs/developer-guide/contracts/factories/ERC4626DepositTokenFactory.sol/contract.ERC4626DepositTokenFactory.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ERC4626DepositTokenFactory
2-
[Git Source](https://github.com/Ammalgam-Protocol/core-v1/blob/2b185eab2df708b55f7ffa534655c69f626e73b3/contracts/factories/ERC4626DepositTokenFactory.sol)
2+
[Git Source](https://github.com/Ammalgam-Protocol/core-v1/blob/6a977aaedd1994271bc7ffff9754778774735fac/contracts/factories/ERC4626DepositTokenFactory.sol)
33

44
**Inherits:**
55
[ITokenFactory](/docs/developer-guide/contracts/interfaces/factories/ITokenFactory.sol/interface.ITokenFactory.md)

‎docs/developer-guide/contracts/interfaces/IAmmalgamPair.sol/interface.IAmmalgamPair.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# IAmmalgamPair
2-
[Git Source](https://github.com/Ammalgam-Protocol/core-v1/blob/2b185eab2df708b55f7ffa534655c69f626e73b3/contracts/interfaces/IAmmalgamPair.sol)
2+
[Git Source](https://github.com/Ammalgam-Protocol/core-v1/blob/6a977aaedd1994271bc7ffff9754778774735fac/contracts/interfaces/IAmmalgamPair.sol)
33

44
**Inherits:**
55
[ITransferValidator](/docs/developer-guide/contracts/interfaces/callbacks/ITransferValidator.sol/interface.ITransferValidator.md)

‎docs/developer-guide/contracts/interfaces/ISaturationAndGeometricTWAPState.sol/interface.ISaturationAndGeometricTWAPState.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ISaturationAndGeometricTWAPState
2-
[Git Source](https://github.com/Ammalgam-Protocol/core-v1/blob/2b185eab2df708b55f7ffa534655c69f626e73b3/contracts/interfaces/ISaturationAndGeometricTWAPState.sol)
2+
[Git Source](https://github.com/Ammalgam-Protocol/core-v1/blob/6a977aaedd1994271bc7ffff9754778774735fac/contracts/interfaces/ISaturationAndGeometricTWAPState.sol)
33

44

55
## Functions
@@ -156,7 +156,7 @@ function calcSatChangeRatioBips(
156156
uint256 liqSqrtPriceInYInQ72,
157157
address pairAddress,
158158
address account
159-
) external view returns (uint256 ratioNetXBips, uint256 ratioNetYBips);
159+
) external view returns (uint256 ratioBips);
160160
```
161161
**Parameters**
162162

@@ -172,8 +172,7 @@ function calcSatChangeRatioBips(
172172

173173
|Name|Type|Description|
174174
|----|----|-----------|
175-
|`ratioNetXBips`|`uint256`|The ratio representing the change in netX saturation for account.|
176-
|`ratioNetYBips`|`uint256`|The ratio representing the change in netY saturation for account.|
175+
|`ratioBips`|`uint256`|The ratio representing the change in saturation for account.|
177176

178177

179178
### configLongTermInterval

‎docs/developer-guide/contracts/interfaces/callbacks/IAmmalgamCallee.sol/interface.IBorrowCallback.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# IBorrowCallback
2-
[Git Source](https://github.com/Ammalgam-Protocol/core-v1/blob/2b185eab2df708b55f7ffa534655c69f626e73b3/contracts/interfaces/callbacks/IAmmalgamCallee.sol)
2+
[Git Source](https://github.com/Ammalgam-Protocol/core-v1/blob/6a977aaedd1994271bc7ffff9754778774735fac/contracts/interfaces/callbacks/IAmmalgamCallee.sol)
33

44

55
## Functions

0 commit comments

Comments
 (0)