docs: auto generate NATSPEC docs

ubiquity · Apr 24, 2024 · db2a5d0 · db2a5d0
1 parent 8aaa03c
commit db2a5d0
Show file tree

Hide file tree

Showing 102 changed files with 283 additions and 98 deletions.
diff --git a/packages/contracts/docs/src/SUMMARY.md b/packages/contracts/docs/src/SUMMARY.md
@@ -44,6 +44,7 @@
       - [ICurveFactory](src/dollar/interfaces/ICurveFactory.sol/interface.ICurveFactory.md)
       - [ICurveStableSwapFactoryNG](src/dollar/interfaces/ICurveStableSwapFactoryNG.sol/interface.ICurveStableSwapFactoryNG.md)
       - [ICurveStableSwapMetaNG](src/dollar/interfaces/ICurveStableSwapMetaNG.sol/interface.ICurveStableSwapMetaNG.md)
+      - [ICurveStableSwapNG](src/dollar/interfaces/ICurveStableSwapNG.sol/interface.ICurveStableSwapNG.md)
       - [ICurveTwocryptoOptimized](src/dollar/interfaces/ICurveTwocryptoOptimized.sol/interface.ICurveTwocryptoOptimized.md)
       - [IDepositZap](src/dollar/interfaces/IDepositZap.sol/interface.IDepositZap.md)
       - [IDiamondCut](src/dollar/interfaces/IDiamondCut.sol/interface.IDiamondCut.md)
@@ -91,6 +92,7 @@
       - [MockChainLinkFeed](src/dollar/mocks/MockChainLinkFeed.sol/contract.MockChainLinkFeed.md)
       - [MockCurveFactory](src/dollar/mocks/MockCurveFactory.sol/contract.MockCurveFactory.md)
       - [MockCurveStableSwapMetaNG](src/dollar/mocks/MockCurveStableSwapMetaNG.sol/contract.MockCurveStableSwapMetaNG.md)
+      - [MockCurveStableSwapNG](src/dollar/mocks/MockCurveStableSwapNG.sol/contract.MockCurveStableSwapNG.md)
       - [MockCurveTwocryptoOptimized](src/dollar/mocks/MockCurveTwocryptoOptimized.sol/contract.MockCurveTwocryptoOptimized.md)
       - [MockERC20](src/dollar/mocks/MockERC20.sol/contract.MockERC20.md)
       - [IMockFacet](src/dollar/mocks/MockFacet.sol/interface.IMockFacet.md)

diff --git a/packages/contracts/docs/src/src/dollar/Diamond.sol/contract.Diamond.md b/packages/contracts/docs/src/src/dollar/Diamond.sol/contract.Diamond.md
@@ -1,5 +1,5 @@
 # Diamond
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/Diamond.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/Diamond.sol)
 
 Contract that implements diamond proxy pattern
 

diff --git a/packages/contracts/docs/src/src/dollar/Diamond.sol/struct.DiamondArgs.md b/packages/contracts/docs/src/src/dollar/Diamond.sol/struct.DiamondArgs.md
@@ -1,5 +1,5 @@
 # DiamondArgs
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/Diamond.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/Diamond.sol)
 
 Struct used for `Diamond` constructor args
 

diff --git a/...c/src/dollar/access/AccessControlInternal.sol/abstract.AccessControlInternal.md b/...c/src/dollar/access/AccessControlInternal.sol/abstract.AccessControlInternal.md
@@ -1,5 +1,5 @@
 # AccessControlInternal
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/access/AccessControlInternal.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/access/AccessControlInternal.sol)
 
 Role-based access control system
 

diff --git a/packages/contracts/docs/src/src/dollar/core/CreditNft.sol/contract.CreditNft.md b/packages/contracts/docs/src/src/dollar/core/CreditNft.sol/contract.CreditNft.md
@@ -1,5 +1,5 @@
 # CreditNft
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/core/CreditNft.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/core/CreditNft.sol)
 
 **Inherits:**
 [ERC1155Ubiquity](/src/dollar/core/ERC1155Ubiquity.sol/abstract.ERC1155Ubiquity.md), [ICreditNft](/src/dollar/interfaces/ICreditNft.sol/interface.ICreditNft.md)

diff --git a/...tracts/docs/src/src/dollar/core/ERC1155Ubiquity.sol/abstract.ERC1155Ubiquity.md b/...tracts/docs/src/src/dollar/core/ERC1155Ubiquity.sol/abstract.ERC1155Ubiquity.md
@@ -1,5 +1,5 @@
 # ERC1155Ubiquity
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/core/ERC1155Ubiquity.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/core/ERC1155Ubiquity.sol)
 
 **Inherits:**
 Initializable, ERC1155BurnableUpgradeable, ERC1155PausableUpgradeable, UUPSUpgradeable

diff --git a/.../contracts/docs/src/src/dollar/core/ERC20Ubiquity.sol/abstract.ERC20Ubiquity.md b/.../contracts/docs/src/src/dollar/core/ERC20Ubiquity.sol/abstract.ERC20Ubiquity.md
@@ -1,5 +1,5 @@
 # ERC20Ubiquity
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/core/ERC20Ubiquity.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/core/ERC20Ubiquity.sol)
 
 **Inherits:**
 Initializable, UUPSUpgradeable, ERC20Upgradeable, ERC20PermitUpgradeable, ERC20PausableUpgradeable

diff --git a/...es/contracts/docs/src/src/dollar/core/StakingShare.sol/contract.StakingShare.md b/...es/contracts/docs/src/src/dollar/core/StakingShare.sol/contract.StakingShare.md
@@ -1,5 +1,5 @@
 # StakingShare
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/core/StakingShare.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/core/StakingShare.sol)
 
 **Inherits:**
 [ERC1155Ubiquity](/src/dollar/core/ERC1155Ubiquity.sol/abstract.ERC1155Ubiquity.md), ERC1155URIStorageUpgradeable

diff --git a/...ocs/src/src/dollar/core/UbiquityCreditToken.sol/contract.UbiquityCreditToken.md b/...ocs/src/src/dollar/core/UbiquityCreditToken.sol/contract.UbiquityCreditToken.md
@@ -1,5 +1,5 @@
 # UbiquityCreditToken
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/core/UbiquityCreditToken.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/core/UbiquityCreditToken.sol)
 
 **Inherits:**
 [ERC20Ubiquity](/src/dollar/core/ERC20Ubiquity.sol/abstract.ERC20Ubiquity.md)

diff --git a/...ocs/src/src/dollar/core/UbiquityDollarToken.sol/contract.UbiquityDollarToken.md b/...ocs/src/src/dollar/core/UbiquityDollarToken.sol/contract.UbiquityDollarToken.md
@@ -1,5 +1,5 @@
 # UbiquityDollarToken
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/core/UbiquityDollarToken.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/core/UbiquityDollarToken.sol)
 
 **Inherits:**
 [ERC20Ubiquity](/src/dollar/core/ERC20Ubiquity.sol/abstract.ERC20Ubiquity.md)

diff --git a/...src/dollar/core/UbiquityGovernanceToken.sol/contract.UbiquityGovernanceToken.md b/...src/dollar/core/UbiquityGovernanceToken.sol/contract.UbiquityGovernanceToken.md
@@ -1,5 +1,5 @@
 # UbiquityGovernanceToken
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/core/UbiquityGovernanceToken.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/core/UbiquityGovernanceToken.sol)
 
 **Inherits:**
 [ERC20Ubiquity](/src/dollar/core/ERC20Ubiquity.sol/abstract.ERC20Ubiquity.md)

diff --git a/...ocs/src/src/dollar/facets/AccessControlFacet.sol/contract.AccessControlFacet.md b/...ocs/src/src/dollar/facets/AccessControlFacet.sol/contract.AccessControlFacet.md
@@ -1,5 +1,5 @@
 # AccessControlFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/AccessControlFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/AccessControlFacet.sol)
 
 **Inherits:**
 [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md), [IAccessControl](/src/dollar/interfaces/IAccessControl.sol/interface.IAccessControl.md), [AccessControlInternal](/src/dollar/access/AccessControlInternal.sol/abstract.AccessControlInternal.md)

diff --git a/.../docs/src/src/dollar/facets/BondingCurveFacet.sol/contract.BondingCurveFacet.md b/.../docs/src/src/dollar/facets/BondingCurveFacet.sol/contract.BondingCurveFacet.md
@@ -1,5 +1,5 @@
 # BondingCurveFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/BondingCurveFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/BondingCurveFacet.sol)
 
 **Inherits:**
 [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md), [IBondingCurve](/src/dollar/interfaces/IBondingCurve.sol/interface.IBondingCurve.md)

diff --git a/packages/contracts/docs/src/src/dollar/facets/ChefFacet.sol/contract.ChefFacet.md b/packages/contracts/docs/src/src/dollar/facets/ChefFacet.sol/contract.ChefFacet.md
@@ -1,5 +1,5 @@
 # ChefFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/ChefFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/ChefFacet.sol)
 
 **Inherits:**
 [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md)

diff --git a/...src/src/dollar/facets/CollectableDustFacet.sol/contract.CollectableDustFacet.md b/...src/src/dollar/facets/CollectableDustFacet.sol/contract.CollectableDustFacet.md
@@ -1,5 +1,5 @@
 # CollectableDustFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/CollectableDustFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/CollectableDustFacet.sol)
 
 **Inherits:**
 [ICollectableDust](/src/dollar/interfaces/utils/ICollectableDust.sol/interface.ICollectableDust.md), [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md)

diff --git a/...ts/docs/src/src/dollar/facets/CreditClockFacet.sol/contract.CreditClockFacet.md b/...ts/docs/src/src/dollar/facets/CreditClockFacet.sol/contract.CreditClockFacet.md
@@ -1,5 +1,5 @@
 # CreditClockFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/CreditClockFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/CreditClockFacet.sol)
 
 **Inherits:**
 [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md)

diff --git a/...c/src/dollar/facets/CreditNftManagerFacet.sol/contract.CreditNftManagerFacet.md b/...c/src/dollar/facets/CreditNftManagerFacet.sol/contract.CreditNftManagerFacet.md
@@ -1,5 +1,5 @@
 # CreditNftManagerFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/CreditNftManagerFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/CreditNftManagerFacet.sol)
 
 **Inherits:**
 [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md)

diff --git a/...NftRedemptionCalculatorFacet.sol/contract.CreditNftRedemptionCalculatorFacet.md b/...NftRedemptionCalculatorFacet.sol/contract.CreditNftRedemptionCalculatorFacet.md
@@ -1,5 +1,5 @@
 # CreditNftRedemptionCalculatorFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/CreditNftRedemptionCalculatorFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/CreditNftRedemptionCalculatorFacet.sol)
 
 **Inherits:**
 [ICreditNftRedemptionCalculator](/src/dollar/interfaces/ICreditNftRedemptionCalculator.sol/interface.ICreditNftRedemptionCalculator.md)

diff --git a/...CreditRedemptionCalculatorFacet.sol/contract.CreditRedemptionCalculatorFacet.md b/...CreditRedemptionCalculatorFacet.sol/contract.CreditRedemptionCalculatorFacet.md
@@ -1,5 +1,5 @@
 # CreditRedemptionCalculatorFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/CreditRedemptionCalculatorFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/CreditRedemptionCalculatorFacet.sol)
 
 **Inherits:**
 [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md), [ICreditRedemptionCalculator](/src/dollar/interfaces/ICreditRedemptionCalculator.sol/interface.ICreditRedemptionCalculator.md)

diff --git a/...llar/facets/CurveDollarIncentiveFacet.sol/contract.CurveDollarIncentiveFacet.md b/...llar/facets/CurveDollarIncentiveFacet.sol/contract.CurveDollarIncentiveFacet.md
@@ -1,5 +1,5 @@
 # CurveDollarIncentiveFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/CurveDollarIncentiveFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/CurveDollarIncentiveFacet.sol)
 
 **Inherits:**
 [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md)

diff --git a/...acts/docs/src/src/dollar/facets/DiamondCutFacet.sol/contract.DiamondCutFacet.md b/...acts/docs/src/src/dollar/facets/DiamondCutFacet.sol/contract.DiamondCutFacet.md
@@ -1,5 +1,5 @@
 # DiamondCutFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/DiamondCutFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/DiamondCutFacet.sol)
 
 **Inherits:**
 [IDiamondCut](/src/dollar/interfaces/IDiamondCut.sol/interface.IDiamondCut.md)

diff --git a/.../docs/src/src/dollar/facets/DiamondLoupeFacet.sol/contract.DiamondLoupeFacet.md b/.../docs/src/src/dollar/facets/DiamondLoupeFacet.sol/contract.DiamondLoupeFacet.md
@@ -1,5 +1,5 @@
 # DiamondLoupeFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/DiamondLoupeFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/DiamondLoupeFacet.sol)
 
 **Inherits:**
 [IDiamondLoupe](/src/dollar/interfaces/IDiamondLoupe.sol/interface.IDiamondLoupe.md), IERC165

diff --git a/.../facets/DirectGovernanceFarmerFacet.sol/contract.DirectGovernanceFarmerFacet.md b/.../facets/DirectGovernanceFarmerFacet.sol/contract.DirectGovernanceFarmerFacet.md
@@ -1,5 +1,5 @@
 # DirectGovernanceFarmerFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/DirectGovernanceFarmerFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/DirectGovernanceFarmerFacet.sol)
 
 **Inherits:**
 [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md)

diff --git a/...llar/facets/DollarMintCalculatorFacet.sol/contract.DollarMintCalculatorFacet.md b/...llar/facets/DollarMintCalculatorFacet.sol/contract.DollarMintCalculatorFacet.md
@@ -1,5 +1,5 @@
 # DollarMintCalculatorFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/DollarMintCalculatorFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/DollarMintCalculatorFacet.sol)
 
 **Inherits:**
 [IDollarMintCalculator](/src/dollar/interfaces/IDollarMintCalculator.sol/interface.IDollarMintCalculator.md)

diff --git a/...c/src/dollar/facets/DollarMintExcessFacet.sol/contract.DollarMintExcessFacet.md b/...c/src/dollar/facets/DollarMintExcessFacet.sol/contract.DollarMintExcessFacet.md
@@ -1,5 +1,5 @@
 # DollarMintExcessFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/DollarMintExcessFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/DollarMintExcessFacet.sol)
 
 **Inherits:**
 [IDollarMintExcess](/src/dollar/interfaces/IDollarMintExcess.sol/interface.IDollarMintExcess.md)

diff --git a/.../contracts/docs/src/src/dollar/facets/ManagerFacet.sol/contract.ManagerFacet.md b/.../contracts/docs/src/src/dollar/facets/ManagerFacet.sol/contract.ManagerFacet.md
@@ -1,5 +1,5 @@
 # ManagerFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/ManagerFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/ManagerFacet.sol)
 
 **Inherits:**
 [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md)
@@ -204,6 +204,23 @@ function setStableSwapMetaPoolAddress(address _stableSwapMetaPoolAddress) extern
 |`_stableSwapMetaPoolAddress`|`address`|Curve Dollar-3CRV MetaPool address|
 
 
+### setStableSwapPlainPoolAddress
+
+Sets Curve's Dollar-Stablecoin plain pool address
+
+*`_stableSwapPlainPoolAddress` is used to fetch Dollar price in USD*
+
+
+```solidity
+function setStableSwapPlainPoolAddress(address _stableSwapPlainPoolAddress) external onlyAdmin;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_stableSwapPlainPoolAddress`|`address`|Curve's Dollar-Stablecoin plain pool address|
+
+
 ### setStakingContractAddress
 
 Sets staking contract address
@@ -546,6 +563,21 @@ function stableSwapMetaPoolAddress() external view returns (address);
 |`<none>`|`address`|Curve MetaPool address|
 
 
+### stableSwapPlainPoolAddress
+
+Returns Curve's plain pool address for Dollar-Stablecoin pair
+
+
+```solidity
+function stableSwapPlainPoolAddress() external view returns (address);
+```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`address`|Curve's plain pool address for Dollar-Stablecoin pair|
+
+
 ### stakingContractAddress
 
 Returns staking address

diff --git a/...tracts/docs/src/src/dollar/facets/OwnershipFacet.sol/contract.OwnershipFacet.md b/...tracts/docs/src/src/dollar/facets/OwnershipFacet.sol/contract.OwnershipFacet.md
@@ -1,5 +1,5 @@
 # OwnershipFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/OwnershipFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/OwnershipFacet.sol)
 
 **Inherits:**
 [IERC173](/src/dollar/interfaces/IERC173.sol/interface.IERC173.md)

diff --git a/.../contracts/docs/src/src/dollar/facets/StakingFacet.sol/contract.StakingFacet.md b/.../contracts/docs/src/src/dollar/facets/StakingFacet.sol/contract.StakingFacet.md
@@ -1,5 +1,5 @@
 # StakingFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/StakingFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/StakingFacet.sol)
 
 **Inherits:**
 [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md), [IStaking](/src/dollar/interfaces/IStaking.sol/interface.IStaking.md)

diff --git a/...src/src/dollar/facets/StakingFormulasFacet.sol/contract.StakingFormulasFacet.md b/...src/src/dollar/facets/StakingFormulasFacet.sol/contract.StakingFormulasFacet.md
@@ -1,5 +1,5 @@
 # StakingFormulasFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/StakingFormulasFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/StakingFormulasFacet.sol)
 
 **Inherits:**
 [IUbiquityFormulas](/src/dollar/interfaces/IUbiquityFormulas.sol/interface.IUbiquityFormulas.md)

diff --git a/.../docs/src/src/dollar/facets/UbiquityPoolFacet.sol/contract.UbiquityPoolFacet.md b/.../docs/src/src/dollar/facets/UbiquityPoolFacet.sol/contract.UbiquityPoolFacet.md
@@ -1,5 +1,5 @@
 # UbiquityPoolFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/UbiquityPoolFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/UbiquityPoolFacet.sol)
 
 **Inherits:**
 [IUbiquityPool](/src/dollar/interfaces/IUbiquityPool.sol/interface.IUbiquityPool.md), [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md)
@@ -233,6 +233,24 @@ function governanceEthPoolAddress() external view returns (address);
 |`<none>`|`address`|Pool address|
 
 
+### stableUsdPriceFeedInformation
+
+Returns chainlink price feed information for stable/USD pair
+
+*Here stable coin refers to the 1st coin in the Curve's stable/Dollar plain pool*
+
+
+```solidity
+function stableUsdPriceFeedInformation() external view returns (address, uint256);
+```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`address`|Price feed address and staleness threshold in seconds|
+|`<none>`|`uint256`||
+
+
 ### mintDollar
 
 Mints Dollars in exchange for collateral tokens
@@ -548,6 +566,26 @@ function setRedemptionDelayBlocks(uint256 newRedemptionDelayBlocks) external onl
 |`newRedemptionDelayBlocks`|`uint256`|Redemption delay in blocks|
 
 
+### setStableUsdChainLinkPriceFeed
+
+Sets chainlink params for stable/USD price feed
+
+*Here stable coin refers to the 1st coin in the Curve's stable/Dollar plain pool*
+
+
+```solidity
+function setStableUsdChainLinkPriceFeed(address newPriceFeedAddress, uint256 newStalenessThreshold)
+    external
+    onlyAdmin;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`newPriceFeedAddress`|`address`|New chainlink price feed address for stable/USD pair|
+|`newStalenessThreshold`|`uint256`|New threshold in seconds when chainlink's stable/USD price feed answer should be considered stale|
+
+
 ### toggleCollateral
 
 Toggles (i.e. enables/disables) a particular collateral token

diff --git a/...s/docs/src/src/dollar/interfaces/IAccessControl.sol/interface.IAccessControl.md b/...s/docs/src/src/dollar/interfaces/IAccessControl.sol/interface.IAccessControl.md
@@ -1,5 +1,5 @@
 # IAccessControl
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IAccessControl.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/interfaces/IAccessControl.sol)
 
 Access contol interface
 

diff --git a/...cts/docs/src/src/dollar/interfaces/IBondingCurve.sol/interface.IBondingCurve.md b/...cts/docs/src/src/dollar/interfaces/IBondingCurve.sol/interface.IBondingCurve.md
@@ -1,5 +1,5 @@
 # IBondingCurve
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IBondingCurve.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/interfaces/IBondingCurve.sol)
 
 Interface based on Bancor formula
 

diff --git a/...contracts/docs/src/src/dollar/interfaces/ICreditNft.sol/interface.ICreditNft.md b/...contracts/docs/src/src/dollar/interfaces/ICreditNft.sol/interface.ICreditNft.md
@@ -1,5 +1,5 @@
 # ICreditNft
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/ICreditNft.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/interfaces/ICreditNft.sol)
 
 **Inherits:**
 IERC1155Upgradeable

diff --git a/.../src/src/dollar/interfaces/ICreditNftManager.sol/interface.ICreditNftManager.md b/.../src/src/dollar/interfaces/ICreditNftManager.sol/interface.ICreditNftManager.md
@@ -1,5 +1,5 @@
 # ICreditNftManager
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/ICreditNftManager.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/interfaces/ICreditNftManager.sol)
 
 **Inherits:**
 IERC1155Receiver

diff --git a/.../ICreditNftRedemptionCalculator.sol/interface.ICreditNftRedemptionCalculator.md b/.../ICreditNftRedemptionCalculator.sol/interface.ICreditNftRedemptionCalculator.md
@@ -1,5 +1,5 @@
 # ICreditNftRedemptionCalculator
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/ICreditNftRedemptionCalculator.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/interfaces/ICreditNftRedemptionCalculator.sol)
 
 Contract interface for calculating amount of Credit NFTs to mint on Dollars burn
 

diff --git a/...rfaces/ICreditRedemptionCalculator.sol/interface.ICreditRedemptionCalculator.md b/...rfaces/ICreditRedemptionCalculator.sol/interface.ICreditRedemptionCalculator.md
@@ -1,5 +1,5 @@
 # ICreditRedemptionCalculator
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/ICreditRedemptionCalculator.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/interfaces/ICreditRedemptionCalculator.sol)
 
 Contract interface for calculating amount of Credits to mint on Dollars burn
 

diff --git a/...cts/docs/src/src/dollar/interfaces/ICurveFactory.sol/interface.ICurveFactory.md b/...cts/docs/src/src/dollar/interfaces/ICurveFactory.sol/interface.ICurveFactory.md
@@ -1,5 +1,5 @@
 # ICurveFactory
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/ICurveFactory.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/interfaces/ICurveFactory.sol)
 
 Curve Factory interface