docs: auto generate NATSPEC docs

ubiquity · Mar 30, 2024 · 6fad4c3 · 6fad4c3
1 parent b595120
commit 6fad4c3
Show file tree

Hide file tree

Showing 97 changed files with 178 additions and 94 deletions.
diff --git a/packages/contracts/docs/src/SUMMARY.md b/packages/contracts/docs/src/SUMMARY.md
@@ -42,6 +42,7 @@
       - [ICreditNftRedemptionCalculator](src/dollar/interfaces/ICreditNftRedemptionCalculator.sol/interface.ICreditNftRedemptionCalculator.md)
       - [ICreditRedemptionCalculator](src/dollar/interfaces/ICreditRedemptionCalculator.sol/interface.ICreditRedemptionCalculator.md)
       - [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)
       - [IDepositZap](src/dollar/interfaces/IDepositZap.sol/interface.IDepositZap.md)
       - [IDiamondCut](src/dollar/interfaces/IDiamondCut.sol/interface.IDiamondCut.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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/Diamond.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/Diamond.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/access/AccessControlInternal.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/core/CreditNft.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/core/ERC1155Ubiquity.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/core/ERC20Ubiquity.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/core/StakingShare.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/core/UbiquityCreditToken.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/core/UbiquityDollarToken.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/core/UbiquityGovernanceToken.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/facets/AccessControlFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/facets/BondingCurveFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/facets/ChefFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/facets/CollectableDustFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/facets/CreditClockFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/facets/CreditNftManagerFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/facets/CreditNftRedemptionCalculatorFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/facets/CreditRedemptionCalculatorFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/facets/CurveDollarIncentiveFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/facets/DiamondCutFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/facets/DiamondLoupeFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/facets/DirectGovernanceFarmerFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/facets/DollarMintCalculatorFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/facets/DollarMintExcessFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/facets/ManagerFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/facets/ManagerFacet.sol)
 
 **Inherits:**
 [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md)

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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/facets/OwnershipFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/facets/StakingFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/facets/StakingFormulasFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/facets/UbiquityPoolFacet.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/facets/UbiquityPoolFacet.sol)
 
 **Inherits:**
 [IUbiquityPool](/src/dollar/interfaces/IUbiquityPool.sol/interface.IUbiquityPool.md), [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md)

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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/IAccessControl.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/IBondingCurve.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/ICreditNft.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/ICreditNftManager.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/ICreditNftRedemptionCalculator.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/ICreditRedemptionCalculator.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/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/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/ICurveFactory.sol)
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/ICurveFactory.sol)
 
 Curve Factory interface
 

diff --git a/...interfaces/ICurveStableSwapFactoryNG.sol/interface.ICurveStableSwapFactoryNG.md b/...interfaces/ICurveStableSwapFactoryNG.sol/interface.ICurveStableSwapFactoryNG.md
@@ -0,0 +1,54 @@
+# ICurveStableSwapFactoryNG
+[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/ICurveStableSwapFactoryNG.sol)
+
+Factory allows the permissionless deployment of up to
+eight-coin plain pools (ex: DAI-USDT-USDC) and metapools (ex: USDT-3CRV).
+Liquidity pool and LP token share the same contract.
+
+
+## Functions
+### deploy_metapool
+
+Deploys a stableswap NG metapool
+
+
+```solidity
+function deploy_metapool(
+    address _base_pool,
+    string memory _name,
+    string memory _symbol,
+    address _coin,
+    uint256 _A,
+    uint256 _fee,
+    uint256 _offpeg_fee_multiplier,
+    uint256 _ma_exp_time,
+    uint256 _implementation_idx,
+    uint8 _asset_type,
+    bytes4 _method_id,
+    address _oracle
+) external returns (address);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_base_pool`|`address`|Address of the base pool to pair the token with. For tripool (DAI-USDT-USDC) use its pool address at 0xbEbc44782C7dB0a1A60Cb6fe97d0b483032FF1C7.|
+|`_name`|`string`|Name of the new metapool, ex: `Dollar/3CRV`|
+|`_symbol`|`string`|Symbol for the new metapool’s LP token - will be concatenated with the base pool symbol, ex: `Dollar3CRV`|
+|`_coin`|`address`|Address of the coin being used in the metapool, ex: use Dollar token address|
+|`_A`|`uint256`|Amplification coefficient. If set to 0 then bonding curve acts like Uniswap. Any >0 value makes the bonding curve to swap at 1:1 constant price, the more `_A` the longer the constant price period. Curve recommends set it to 100 for crypto collateralizard stablecoins. This parameter can be updated later.|
+|`_fee`|`uint256`|Trade fee, given as an integer with 1e10 precision, ex: 40000000 = 0.04% fee|
+|`_offpeg_fee_multiplier`|`uint256`|Off-peg multiplier. Curve recommends set it to `20000000000`. This parameter can be updated later. More info: https://docs.curve.fi/stableswap-exchange/stableswap-ng/pools/overview/#dynamic-fees|
+|`_ma_exp_time`|`uint256`|MA time; set as time_in_seconds / ln(2), ex: 866 = 600 seconds, 2597 = 1800 seconds. This parameter can be updated later.|
+|`_implementation_idx`|`uint256`|Index of the metapool implementation to use. Can be retrieved via `ICurveStableSwapFactoryNG.metapool_implementations()`. There is only 1 metapool implementation right now so use index `0`.|
+|`_asset_type`|`uint8`|Asset type of the pool as an integer. Available asset type indexes: - 0: Standard ERC20 token with no additional features - 1: Oracle - token with rate oracle (e.g. wstETH) - 2: Rebasing - token with rebase (e.g. stETH) - 3: ERC4626 - token with convertToAssets method (e.g. sDAI) Dollar is a standard ERC20 token so we should use asset type with index `0`.|
+|`_method_id`|`bytes4`|First four bytes of the Keccak-256 hash of the function signatures of the oracle addresses that give rate oracles. This is applied only to asset type `1` (Oracle). For Dollar token deployment set empty.|
+|`_oracle`|`address`|Rate oracle address. This is applied only to asset type `1` (Oracle). For Dollar token deployment set empty address.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`address`|Deployed metapool address|
+
+