diff --git a/packages/contracts/docs/src/SUMMARY.md b/packages/contracts/docs/src/SUMMARY.md index 38914f12e..df88283a0 100644 --- 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 index c44e56de2..403c3b05a 100644 --- 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 index c5bdb0fec..ad707be83 100644 --- 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/packages/contracts/docs/src/src/dollar/access/AccessControlInternal.sol/abstract.AccessControlInternal.md b/packages/contracts/docs/src/src/dollar/access/AccessControlInternal.sol/abstract.AccessControlInternal.md index c6c387f72..bf1db6e95 100644 --- a/packages/contracts/docs/src/src/dollar/access/AccessControlInternal.sol/abstract.AccessControlInternal.md +++ b/packages/contracts/docs/src/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 index 09b30e19f..06bebb4a2 100644 --- 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/packages/contracts/docs/src/src/dollar/core/ERC1155Ubiquity.sol/abstract.ERC1155Ubiquity.md b/packages/contracts/docs/src/src/dollar/core/ERC1155Ubiquity.sol/abstract.ERC1155Ubiquity.md index a8b9eecb5..6a1c635c0 100644 --- a/packages/contracts/docs/src/src/dollar/core/ERC1155Ubiquity.sol/abstract.ERC1155Ubiquity.md +++ b/packages/contracts/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/packages/contracts/docs/src/src/dollar/core/ERC20Ubiquity.sol/abstract.ERC20Ubiquity.md b/packages/contracts/docs/src/src/dollar/core/ERC20Ubiquity.sol/abstract.ERC20Ubiquity.md index e6f330afc..ccc629805 100644 --- a/packages/contracts/docs/src/src/dollar/core/ERC20Ubiquity.sol/abstract.ERC20Ubiquity.md +++ b/packages/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/packages/contracts/docs/src/src/dollar/core/StakingShare.sol/contract.StakingShare.md b/packages/contracts/docs/src/src/dollar/core/StakingShare.sol/contract.StakingShare.md index 02ed875a6..b649753d4 100644 --- a/packages/contracts/docs/src/src/dollar/core/StakingShare.sol/contract.StakingShare.md +++ b/packages/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/packages/contracts/docs/src/src/dollar/core/UbiquityCreditToken.sol/contract.UbiquityCreditToken.md b/packages/contracts/docs/src/src/dollar/core/UbiquityCreditToken.sol/contract.UbiquityCreditToken.md index cf447fdc5..1e88c8506 100644 --- a/packages/contracts/docs/src/src/dollar/core/UbiquityCreditToken.sol/contract.UbiquityCreditToken.md +++ b/packages/contracts/docs/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/packages/contracts/docs/src/src/dollar/core/UbiquityDollarToken.sol/contract.UbiquityDollarToken.md b/packages/contracts/docs/src/src/dollar/core/UbiquityDollarToken.sol/contract.UbiquityDollarToken.md index fc82513b2..64f8a8634 100644 --- a/packages/contracts/docs/src/src/dollar/core/UbiquityDollarToken.sol/contract.UbiquityDollarToken.md +++ b/packages/contracts/docs/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/packages/contracts/docs/src/src/dollar/core/UbiquityGovernanceToken.sol/contract.UbiquityGovernanceToken.md b/packages/contracts/docs/src/src/dollar/core/UbiquityGovernanceToken.sol/contract.UbiquityGovernanceToken.md index eadbc178a..11a7e6ee6 100644 --- a/packages/contracts/docs/src/src/dollar/core/UbiquityGovernanceToken.sol/contract.UbiquityGovernanceToken.md +++ b/packages/contracts/docs/src/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/packages/contracts/docs/src/src/dollar/facets/AccessControlFacet.sol/contract.AccessControlFacet.md b/packages/contracts/docs/src/src/dollar/facets/AccessControlFacet.sol/contract.AccessControlFacet.md index 76574b3ed..e3ed3b7e9 100644 --- a/packages/contracts/docs/src/src/dollar/facets/AccessControlFacet.sol/contract.AccessControlFacet.md +++ b/packages/contracts/docs/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/packages/contracts/docs/src/src/dollar/facets/BondingCurveFacet.sol/contract.BondingCurveFacet.md b/packages/contracts/docs/src/src/dollar/facets/BondingCurveFacet.sol/contract.BondingCurveFacet.md index a640248bf..2ecbec9a3 100644 --- a/packages/contracts/docs/src/src/dollar/facets/BondingCurveFacet.sol/contract.BondingCurveFacet.md +++ b/packages/contracts/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 index e1001d670..4068bccbf 100644 --- 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/packages/contracts/docs/src/src/dollar/facets/CollectableDustFacet.sol/contract.CollectableDustFacet.md b/packages/contracts/docs/src/src/dollar/facets/CollectableDustFacet.sol/contract.CollectableDustFacet.md index 70a093802..ef8a6f09f 100644 --- a/packages/contracts/docs/src/src/dollar/facets/CollectableDustFacet.sol/contract.CollectableDustFacet.md +++ b/packages/contracts/docs/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/packages/contracts/docs/src/src/dollar/facets/CreditClockFacet.sol/contract.CreditClockFacet.md b/packages/contracts/docs/src/src/dollar/facets/CreditClockFacet.sol/contract.CreditClockFacet.md index 9e5f66b8f..c426b964f 100644 --- a/packages/contracts/docs/src/src/dollar/facets/CreditClockFacet.sol/contract.CreditClockFacet.md +++ b/packages/contracts/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/packages/contracts/docs/src/src/dollar/facets/CreditNftManagerFacet.sol/contract.CreditNftManagerFacet.md b/packages/contracts/docs/src/src/dollar/facets/CreditNftManagerFacet.sol/contract.CreditNftManagerFacet.md index 961312fc1..dce01f17e 100644 --- a/packages/contracts/docs/src/src/dollar/facets/CreditNftManagerFacet.sol/contract.CreditNftManagerFacet.md +++ b/packages/contracts/docs/src/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/packages/contracts/docs/src/src/dollar/facets/CreditNftRedemptionCalculatorFacet.sol/contract.CreditNftRedemptionCalculatorFacet.md b/packages/contracts/docs/src/src/dollar/facets/CreditNftRedemptionCalculatorFacet.sol/contract.CreditNftRedemptionCalculatorFacet.md index 1ad4c4073..837e58ecd 100644 --- a/packages/contracts/docs/src/src/dollar/facets/CreditNftRedemptionCalculatorFacet.sol/contract.CreditNftRedemptionCalculatorFacet.md +++ b/packages/contracts/docs/src/src/dollar/facets/CreditNftRedemptionCalculatorFacet.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/packages/contracts/docs/src/src/dollar/facets/CreditRedemptionCalculatorFacet.sol/contract.CreditRedemptionCalculatorFacet.md b/packages/contracts/docs/src/src/dollar/facets/CreditRedemptionCalculatorFacet.sol/contract.CreditRedemptionCalculatorFacet.md index d6c734e99..3c7aba062 100644 --- a/packages/contracts/docs/src/src/dollar/facets/CreditRedemptionCalculatorFacet.sol/contract.CreditRedemptionCalculatorFacet.md +++ b/packages/contracts/docs/src/src/dollar/facets/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/packages/contracts/docs/src/src/dollar/facets/CurveDollarIncentiveFacet.sol/contract.CurveDollarIncentiveFacet.md b/packages/contracts/docs/src/src/dollar/facets/CurveDollarIncentiveFacet.sol/contract.CurveDollarIncentiveFacet.md index f236fd343..2435fbee3 100644 --- a/packages/contracts/docs/src/src/dollar/facets/CurveDollarIncentiveFacet.sol/contract.CurveDollarIncentiveFacet.md +++ b/packages/contracts/docs/src/src/dollar/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/packages/contracts/docs/src/src/dollar/facets/DiamondCutFacet.sol/contract.DiamondCutFacet.md b/packages/contracts/docs/src/src/dollar/facets/DiamondCutFacet.sol/contract.DiamondCutFacet.md index 78318bb33..b966c6daa 100644 --- a/packages/contracts/docs/src/src/dollar/facets/DiamondCutFacet.sol/contract.DiamondCutFacet.md +++ b/packages/contracts/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/packages/contracts/docs/src/src/dollar/facets/DiamondLoupeFacet.sol/contract.DiamondLoupeFacet.md b/packages/contracts/docs/src/src/dollar/facets/DiamondLoupeFacet.sol/contract.DiamondLoupeFacet.md index 43f64df22..a27af5ad0 100644 --- a/packages/contracts/docs/src/src/dollar/facets/DiamondLoupeFacet.sol/contract.DiamondLoupeFacet.md +++ b/packages/contracts/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/packages/contracts/docs/src/src/dollar/facets/DirectGovernanceFarmerFacet.sol/contract.DirectGovernanceFarmerFacet.md b/packages/contracts/docs/src/src/dollar/facets/DirectGovernanceFarmerFacet.sol/contract.DirectGovernanceFarmerFacet.md index d1f0e3f84..86993f2a1 100644 --- a/packages/contracts/docs/src/src/dollar/facets/DirectGovernanceFarmerFacet.sol/contract.DirectGovernanceFarmerFacet.md +++ b/packages/contracts/docs/src/src/dollar/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/packages/contracts/docs/src/src/dollar/facets/DollarMintCalculatorFacet.sol/contract.DollarMintCalculatorFacet.md b/packages/contracts/docs/src/src/dollar/facets/DollarMintCalculatorFacet.sol/contract.DollarMintCalculatorFacet.md index 188f6520e..cf5959af4 100644 --- a/packages/contracts/docs/src/src/dollar/facets/DollarMintCalculatorFacet.sol/contract.DollarMintCalculatorFacet.md +++ b/packages/contracts/docs/src/src/dollar/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/packages/contracts/docs/src/src/dollar/facets/DollarMintExcessFacet.sol/contract.DollarMintExcessFacet.md b/packages/contracts/docs/src/src/dollar/facets/DollarMintExcessFacet.sol/contract.DollarMintExcessFacet.md index a19d551bf..430c53bbc 100644 --- a/packages/contracts/docs/src/src/dollar/facets/DollarMintExcessFacet.sol/contract.DollarMintExcessFacet.md +++ b/packages/contracts/docs/src/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/packages/contracts/docs/src/src/dollar/facets/ManagerFacet.sol/contract.ManagerFacet.md b/packages/contracts/docs/src/src/dollar/facets/ManagerFacet.sol/contract.ManagerFacet.md index 63e44d858..cd09c7069 100644 --- a/packages/contracts/docs/src/src/dollar/facets/ManagerFacet.sol/contract.ManagerFacet.md +++ b/packages/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/packages/contracts/docs/src/src/dollar/facets/OwnershipFacet.sol/contract.OwnershipFacet.md b/packages/contracts/docs/src/src/dollar/facets/OwnershipFacet.sol/contract.OwnershipFacet.md index d3b7c5d4e..e452ed02b 100644 --- a/packages/contracts/docs/src/src/dollar/facets/OwnershipFacet.sol/contract.OwnershipFacet.md +++ b/packages/contracts/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/packages/contracts/docs/src/src/dollar/facets/StakingFacet.sol/contract.StakingFacet.md b/packages/contracts/docs/src/src/dollar/facets/StakingFacet.sol/contract.StakingFacet.md index b2bb5fa75..5cb114168 100644 --- a/packages/contracts/docs/src/src/dollar/facets/StakingFacet.sol/contract.StakingFacet.md +++ b/packages/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/packages/contracts/docs/src/src/dollar/facets/StakingFormulasFacet.sol/contract.StakingFormulasFacet.md b/packages/contracts/docs/src/src/dollar/facets/StakingFormulasFacet.sol/contract.StakingFormulasFacet.md index 1c0382850..f55804329 100644 --- a/packages/contracts/docs/src/src/dollar/facets/StakingFormulasFacet.sol/contract.StakingFormulasFacet.md +++ b/packages/contracts/docs/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/packages/contracts/docs/src/src/dollar/facets/UbiquityPoolFacet.sol/contract.UbiquityPoolFacet.md b/packages/contracts/docs/src/src/dollar/facets/UbiquityPoolFacet.sol/contract.UbiquityPoolFacet.md index 4f9b5daa1..19377dfc8 100644 --- a/packages/contracts/docs/src/src/dollar/facets/UbiquityPoolFacet.sol/contract.UbiquityPoolFacet.md +++ b/packages/contracts/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/packages/contracts/docs/src/src/dollar/interfaces/IAccessControl.sol/interface.IAccessControl.md b/packages/contracts/docs/src/src/dollar/interfaces/IAccessControl.sol/interface.IAccessControl.md index 1ce598243..0de528e0b 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IAccessControl.sol/interface.IAccessControl.md +++ b/packages/contracts/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/packages/contracts/docs/src/src/dollar/interfaces/IBondingCurve.sol/interface.IBondingCurve.md b/packages/contracts/docs/src/src/dollar/interfaces/IBondingCurve.sol/interface.IBondingCurve.md index 5d90aef50..8c1931e3f 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IBondingCurve.sol/interface.IBondingCurve.md +++ b/packages/contracts/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/packages/contracts/docs/src/src/dollar/interfaces/ICreditNft.sol/interface.ICreditNft.md b/packages/contracts/docs/src/src/dollar/interfaces/ICreditNft.sol/interface.ICreditNft.md index 07fdb85a2..30ba2538c 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/ICreditNft.sol/interface.ICreditNft.md +++ b/packages/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/packages/contracts/docs/src/src/dollar/interfaces/ICreditNftManager.sol/interface.ICreditNftManager.md b/packages/contracts/docs/src/src/dollar/interfaces/ICreditNftManager.sol/interface.ICreditNftManager.md index c1fda66d2..ce6e16ac2 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/ICreditNftManager.sol/interface.ICreditNftManager.md +++ b/packages/contracts/docs/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/packages/contracts/docs/src/src/dollar/interfaces/ICreditNftRedemptionCalculator.sol/interface.ICreditNftRedemptionCalculator.md b/packages/contracts/docs/src/src/dollar/interfaces/ICreditNftRedemptionCalculator.sol/interface.ICreditNftRedemptionCalculator.md index 82155502b..f8679e9de 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/ICreditNftRedemptionCalculator.sol/interface.ICreditNftRedemptionCalculator.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/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/packages/contracts/docs/src/src/dollar/interfaces/ICreditRedemptionCalculator.sol/interface.ICreditRedemptionCalculator.md b/packages/contracts/docs/src/src/dollar/interfaces/ICreditRedemptionCalculator.sol/interface.ICreditRedemptionCalculator.md index bd6dfbfe1..3e2da65d4 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/ICreditRedemptionCalculator.sol/interface.ICreditRedemptionCalculator.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/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/packages/contracts/docs/src/src/dollar/interfaces/ICurveFactory.sol/interface.ICurveFactory.md b/packages/contracts/docs/src/src/dollar/interfaces/ICurveFactory.sol/interface.ICurveFactory.md index 80cb8d8bb..57e7487c0 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/ICurveFactory.sol/interface.ICurveFactory.md +++ b/packages/contracts/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/packages/contracts/docs/src/src/dollar/interfaces/ICurveStableSwapFactoryNG.sol/interface.ICurveStableSwapFactoryNG.md b/packages/contracts/docs/src/src/dollar/interfaces/ICurveStableSwapFactoryNG.sol/interface.ICurveStableSwapFactoryNG.md new file mode 100644 index 000000000..162bce8ef --- /dev/null +++ b/packages/contracts/docs/src/src/dollar/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| +|----|----|-----------| +|``|`address`|Deployed metapool address| + + diff --git a/packages/contracts/docs/src/src/dollar/interfaces/ICurveStableSwapMetaNG.sol/interface.ICurveStableSwapMetaNG.md b/packages/contracts/docs/src/src/dollar/interfaces/ICurveStableSwapMetaNG.sol/interface.ICurveStableSwapMetaNG.md index e511db4ab..66102f149 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/ICurveStableSwapMetaNG.sol/interface.ICurveStableSwapMetaNG.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/ICurveStableSwapMetaNG.sol/interface.ICurveStableSwapMetaNG.md @@ -1,5 +1,5 @@ # ICurveStableSwapMetaNG -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/ICurveStableSwapMetaNG.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/ICurveStableSwapMetaNG.sol) **Inherits:** IERC20 @@ -53,6 +53,27 @@ function add_liquidity(uint256[2] memory _amounts, uint256 _min_mint_amount, add |``|`uint256`|The amount of LP tokens that were minted in the deposit| +### balances + +Getter for the current balance of coin `i` within the pool + + +```solidity +function balances(uint256 i) external view returns (uint256); +``` +**Parameters** + +|Name|Type|Description| +|----|----|-----------| +|`i`|`uint256`|Coin index| + +**Returns** + +|Name|Type|Description| +|----|----|-----------| +|``|`uint256`|Coin balance| + + ### calc_token_amount Estimates the amount of LP tokens minted or burned based on a deposit or withdrawal diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IDepositZap.sol/interface.IDepositZap.md b/packages/contracts/docs/src/src/dollar/interfaces/IDepositZap.sol/interface.IDepositZap.md index 25dd65888..6f7574368 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IDepositZap.sol/interface.IDepositZap.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IDepositZap.sol/interface.IDepositZap.md @@ -1,5 +1,5 @@ # IDepositZap -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/IDepositZap.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/IDepositZap.sol) Interface for Curve's Deposit Zap diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IDiamondCut.sol/interface.IDiamondCut.md b/packages/contracts/docs/src/src/dollar/interfaces/IDiamondCut.sol/interface.IDiamondCut.md index 2e48ac885..a6b87c3db 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IDiamondCut.sol/interface.IDiamondCut.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IDiamondCut.sol/interface.IDiamondCut.md @@ -1,5 +1,5 @@ # IDiamondCut -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/IDiamondCut.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/IDiamondCut.sol) Interface that allows modifications to diamond function selector mapping diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IDiamondLoupe.sol/interface.IDiamondLoupe.md b/packages/contracts/docs/src/src/dollar/interfaces/IDiamondLoupe.sol/interface.IDiamondLoupe.md index fca6e7be7..9dd8cc3f6 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IDiamondLoupe.sol/interface.IDiamondLoupe.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IDiamondLoupe.sol/interface.IDiamondLoupe.md @@ -1,5 +1,5 @@ # IDiamondLoupe -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/IDiamondLoupe.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/IDiamondLoupe.sol) A loupe is a small magnifying glass used to look at diamonds. These functions look at diamonds. diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IDollarAmoMinter.sol/interface.IDollarAmoMinter.md b/packages/contracts/docs/src/src/dollar/interfaces/IDollarAmoMinter.sol/interface.IDollarAmoMinter.md index 2572e4ed8..352897cf6 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IDollarAmoMinter.sol/interface.IDollarAmoMinter.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IDollarAmoMinter.sol/interface.IDollarAmoMinter.md @@ -1,5 +1,5 @@ # IDollarAmoMinter -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/IDollarAmoMinter.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/IDollarAmoMinter.sol) AMO minter interface diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IDollarMintCalculator.sol/interface.IDollarMintCalculator.md b/packages/contracts/docs/src/src/dollar/interfaces/IDollarMintCalculator.sol/interface.IDollarMintCalculator.md index e051a9530..02da23dd4 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IDollarMintCalculator.sol/interface.IDollarMintCalculator.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IDollarMintCalculator.sol/interface.IDollarMintCalculator.md @@ -1,5 +1,5 @@ # IDollarMintCalculator -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/IDollarMintCalculator.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/IDollarMintCalculator.sol) Interface for calculating amount of Dollars to be minted diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IDollarMintExcess.sol/interface.IDollarMintExcess.md b/packages/contracts/docs/src/src/dollar/interfaces/IDollarMintExcess.sol/interface.IDollarMintExcess.md index b4273dc6e..29f692cfa 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IDollarMintExcess.sol/interface.IDollarMintExcess.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IDollarMintExcess.sol/interface.IDollarMintExcess.md @@ -1,5 +1,5 @@ # IDollarMintExcess -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/IDollarMintExcess.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/IDollarMintExcess.sol) Interface for distributing excess Dollars when `mintClaimableDollars()` is called diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IERC1155Ubiquity.sol/interface.IERC1155Ubiquity.md b/packages/contracts/docs/src/src/dollar/interfaces/IERC1155Ubiquity.sol/interface.IERC1155Ubiquity.md index 6be58dff5..39b5ff1d1 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IERC1155Ubiquity.sol/interface.IERC1155Ubiquity.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IERC1155Ubiquity.sol/interface.IERC1155Ubiquity.md @@ -1,5 +1,5 @@ # IERC1155Ubiquity -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/IERC1155Ubiquity.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/IERC1155Ubiquity.sol) **Inherits:** IERC1155 diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IERC173.sol/interface.IERC173.md b/packages/contracts/docs/src/src/dollar/interfaces/IERC173.sol/interface.IERC173.md index 68fcf5d7b..873663582 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IERC173.sol/interface.IERC173.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IERC173.sol/interface.IERC173.md @@ -1,5 +1,5 @@ # IERC173 -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/IERC173.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/IERC173.sol) ERC-173 Contract Ownership Standard diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IERC20Ubiquity.sol/interface.IERC20Ubiquity.md b/packages/contracts/docs/src/src/dollar/interfaces/IERC20Ubiquity.sol/interface.IERC20Ubiquity.md index dc7e28eca..722abefe1 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IERC20Ubiquity.sol/interface.IERC20Ubiquity.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IERC20Ubiquity.sol/interface.IERC20Ubiquity.md @@ -1,5 +1,5 @@ # IERC20Ubiquity -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/IERC20Ubiquity.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/IERC20Ubiquity.sol) **Inherits:** IERC20, IERC20Permit diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IStableSwap3Pool.sol/interface.IStableSwap3Pool.md b/packages/contracts/docs/src/src/dollar/interfaces/IStableSwap3Pool.sol/interface.IStableSwap3Pool.md index 4e1211d59..cd0d0155b 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IStableSwap3Pool.sol/interface.IStableSwap3Pool.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IStableSwap3Pool.sol/interface.IStableSwap3Pool.md @@ -1,5 +1,5 @@ # IStableSwap3Pool -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/IStableSwap3Pool.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/IStableSwap3Pool.sol) Curve TriPool interface diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IStaking.sol/interface.IStaking.md b/packages/contracts/docs/src/src/dollar/interfaces/IStaking.sol/interface.IStaking.md index 4277ad1c4..d1c9362df 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IStaking.sol/interface.IStaking.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IStaking.sol/interface.IStaking.md @@ -1,5 +1,5 @@ # IStaking -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/IStaking.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/IStaking.sol) Staking interface diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IStakingShare.sol/interface.IStakingShare.md b/packages/contracts/docs/src/src/dollar/interfaces/IStakingShare.sol/interface.IStakingShare.md index 75b7d752b..f62f68bfe 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IStakingShare.sol/interface.IStakingShare.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IStakingShare.sol/interface.IStakingShare.md @@ -1,5 +1,5 @@ # IStakingShare -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/IStakingShare.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/IStakingShare.sol) **Inherits:** [IERC1155Ubiquity](/src/dollar/interfaces/IERC1155Ubiquity.sol/interface.IERC1155Ubiquity.md) diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityChef.sol/interface.IUbiquityChef.md b/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityChef.sol/interface.IUbiquityChef.md index 06781f76b..d14673c67 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityChef.sol/interface.IUbiquityChef.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityChef.sol/interface.IUbiquityChef.md @@ -1,5 +1,5 @@ # IUbiquityChef -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/IUbiquityChef.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/IUbiquityChef.sol) Interface for staking Dollar-3CRV LP tokens for Governance tokens reward diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityDollarManager.sol/interface.IUbiquityDollarManager.md b/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityDollarManager.sol/interface.IUbiquityDollarManager.md index 5c2178145..23b17fc66 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityDollarManager.sol/interface.IUbiquityDollarManager.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityDollarManager.sol/interface.IUbiquityDollarManager.md @@ -1,5 +1,5 @@ # IUbiquityDollarManager -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/IUbiquityDollarManager.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/IUbiquityDollarManager.sol) **Inherits:** [IAccessControl](/src/dollar/interfaces/IAccessControl.sol/interface.IAccessControl.md) diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityDollarToken.sol/interface.IUbiquityDollarToken.md b/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityDollarToken.sol/interface.IUbiquityDollarToken.md index c46740eae..c451c35b4 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityDollarToken.sol/interface.IUbiquityDollarToken.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityDollarToken.sol/interface.IUbiquityDollarToken.md @@ -1,5 +1,5 @@ # IUbiquityDollarToken -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/IUbiquityDollarToken.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/IUbiquityDollarToken.sol) **Inherits:** [IERC20Ubiquity](/src/dollar/interfaces/IERC20Ubiquity.sol/interface.IERC20Ubiquity.md) diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityFormulas.sol/interface.IUbiquityFormulas.md b/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityFormulas.sol/interface.IUbiquityFormulas.md index d5cac72d7..abe8c8bb0 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityFormulas.sol/interface.IUbiquityFormulas.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityFormulas.sol/interface.IUbiquityFormulas.md @@ -1,5 +1,5 @@ # IUbiquityFormulas -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/IUbiquityFormulas.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/IUbiquityFormulas.sol) Interface for staking formulas diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityGovernance.sol/interface.IUbiquityGovernanceToken.md b/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityGovernance.sol/interface.IUbiquityGovernanceToken.md index e12ccc412..bb6bc19ea 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityGovernance.sol/interface.IUbiquityGovernanceToken.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityGovernance.sol/interface.IUbiquityGovernanceToken.md @@ -1,5 +1,5 @@ # IUbiquityGovernanceToken -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/IUbiquityGovernance.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/IUbiquityGovernance.sol) **Inherits:** [IERC20Ubiquity](/src/dollar/interfaces/IERC20Ubiquity.sol/interface.IERC20Ubiquity.md) diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityPool.sol/interface.IUbiquityPool.md b/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityPool.sol/interface.IUbiquityPool.md index 6d5956fc4..9bb5ae54d 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityPool.sol/interface.IUbiquityPool.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IUbiquityPool.sol/interface.IUbiquityPool.md @@ -1,5 +1,5 @@ # IUbiquityPool -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/IUbiquityPool.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/IUbiquityPool.sol) Ubiquity pool interface diff --git a/packages/contracts/docs/src/src/dollar/interfaces/README.md b/packages/contracts/docs/src/src/dollar/interfaces/README.md index 3a1440f86..2cc419d03 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/README.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/README.md @@ -9,6 +9,7 @@ - [ICreditNftRedemptionCalculator](ICreditNftRedemptionCalculator.sol/interface.ICreditNftRedemptionCalculator.md) - [ICreditRedemptionCalculator](ICreditRedemptionCalculator.sol/interface.ICreditRedemptionCalculator.md) - [ICurveFactory](ICurveFactory.sol/interface.ICurveFactory.md) +- [ICurveStableSwapFactoryNG](ICurveStableSwapFactoryNG.sol/interface.ICurveStableSwapFactoryNG.md) - [ICurveStableSwapMetaNG](ICurveStableSwapMetaNG.sol/interface.ICurveStableSwapMetaNG.md) - [IDepositZap](IDepositZap.sol/interface.IDepositZap.md) - [IDiamondCut](IDiamondCut.sol/interface.IDiamondCut.md) diff --git a/packages/contracts/docs/src/src/dollar/interfaces/utils/ICollectableDust.sol/interface.ICollectableDust.md b/packages/contracts/docs/src/src/dollar/interfaces/utils/ICollectableDust.sol/interface.ICollectableDust.md index 36efe657c..20ca75fe8 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/utils/ICollectableDust.sol/interface.ICollectableDust.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/utils/ICollectableDust.sol/interface.ICollectableDust.md @@ -1,5 +1,5 @@ # ICollectableDust -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/interfaces/utils/ICollectableDust.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/interfaces/utils/ICollectableDust.sol) Interface for collecting dust (i.e. not part of a protocol) tokens sent to a contract diff --git a/packages/contracts/docs/src/src/dollar/libraries/AddressUtils.sol/library.AddressUtils.md b/packages/contracts/docs/src/src/dollar/libraries/AddressUtils.sol/library.AddressUtils.md index 3e316364f..e531416ae 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/AddressUtils.sol/library.AddressUtils.md +++ b/packages/contracts/docs/src/src/dollar/libraries/AddressUtils.sol/library.AddressUtils.md @@ -1,5 +1,5 @@ # AddressUtils -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/AddressUtils.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/AddressUtils.sol) Address utils diff --git a/packages/contracts/docs/src/src/dollar/libraries/Constants.sol/constants.Constants.md b/packages/contracts/docs/src/src/dollar/libraries/Constants.sol/constants.Constants.md index 99df41cee..2fdc74d6c 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/Constants.sol/constants.Constants.md +++ b/packages/contracts/docs/src/src/dollar/libraries/Constants.sol/constants.Constants.md @@ -1,5 +1,5 @@ # Constants -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/Constants.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/Constants.sol) ### DEFAULT_ADMIN_ROLE *Default admin role name* diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibAccessControl.sol/library.LibAccessControl.md b/packages/contracts/docs/src/src/dollar/libraries/LibAccessControl.sol/library.LibAccessControl.md index afea80cd0..cb8fe3b83 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibAccessControl.sol/library.LibAccessControl.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibAccessControl.sol/library.LibAccessControl.md @@ -1,5 +1,5 @@ # LibAccessControl -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/LibAccessControl.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/LibAccessControl.sol) Access control library diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md b/packages/contracts/docs/src/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md index 2de78e2b4..504db39bd 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md @@ -1,5 +1,5 @@ # Modifiers -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/LibAppStorage.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/LibAppStorage.sol) Contract includes modifiers shared across all protocol's contracts diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibAppStorage.sol/library.LibAppStorage.md b/packages/contracts/docs/src/src/dollar/libraries/LibAppStorage.sol/library.LibAppStorage.md index 98185c063..711ffd61d 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibAppStorage.sol/library.LibAppStorage.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibAppStorage.sol/library.LibAppStorage.md @@ -1,5 +1,5 @@ # LibAppStorage -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/LibAppStorage.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/LibAppStorage.sol) Library used as a shared storage among all protocol libraries diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibAppStorage.sol/struct.AppStorage.md b/packages/contracts/docs/src/src/dollar/libraries/LibAppStorage.sol/struct.AppStorage.md index 295ecf160..e3cabeb6f 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibAppStorage.sol/struct.AppStorage.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibAppStorage.sol/struct.AppStorage.md @@ -1,5 +1,5 @@ # AppStorage -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/LibAppStorage.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/LibAppStorage.sol) Shared struct used as a storage in the `LibAppStorage` library diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibBondingCurve.sol/library.LibBondingCurve.md b/packages/contracts/docs/src/src/dollar/libraries/LibBondingCurve.sol/library.LibBondingCurve.md index 57f48b647..14b5c1f1c 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibBondingCurve.sol/library.LibBondingCurve.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibBondingCurve.sol/library.LibBondingCurve.md @@ -1,5 +1,5 @@ # LibBondingCurve -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/LibBondingCurve.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/LibBondingCurve.sol) Bonding curve library based on Bancor formula diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibChef.sol/library.LibChef.md b/packages/contracts/docs/src/src/dollar/libraries/LibChef.sol/library.LibChef.md index ef52a4c80..02aa208e8 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibChef.sol/library.LibChef.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibChef.sol/library.LibChef.md @@ -1,5 +1,5 @@ # LibChef -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/LibChef.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/LibChef.sol) Library for staking Dollar-3CRV LP tokens for Governance tokens reward diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibCollectableDust.sol/library.LibCollectableDust.md b/packages/contracts/docs/src/src/dollar/libraries/LibCollectableDust.sol/library.LibCollectableDust.md index fcc325e61..606c37388 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibCollectableDust.sol/library.LibCollectableDust.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibCollectableDust.sol/library.LibCollectableDust.md @@ -1,5 +1,5 @@ # LibCollectableDust -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/LibCollectableDust.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/LibCollectableDust.sol) Library for collecting dust (i.e. not part of a protocol) tokens sent to a contract diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibCreditClock.sol/library.LibCreditClock.md b/packages/contracts/docs/src/src/dollar/libraries/LibCreditClock.sol/library.LibCreditClock.md index d7ef30389..b21f39dee 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibCreditClock.sol/library.LibCreditClock.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibCreditClock.sol/library.LibCreditClock.md @@ -1,5 +1,5 @@ # LibCreditClock -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/LibCreditClock.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/LibCreditClock.sol) Library for Credit Clock Facet diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibCreditNftManager.sol/library.LibCreditNftManager.md b/packages/contracts/docs/src/src/dollar/libraries/LibCreditNftManager.sol/library.LibCreditNftManager.md index 852f5c5f5..8cd845f87 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibCreditNftManager.sol/library.LibCreditNftManager.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibCreditNftManager.sol/library.LibCreditNftManager.md @@ -1,5 +1,5 @@ # LibCreditNftManager -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/LibCreditNftManager.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/LibCreditNftManager.sol) Library for basic credit issuing and redemption mechanism for Credit NFT and Credit holders diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibCreditNftRedemptionCalculator.sol/library.LibCreditNftRedemptionCalculator.md b/packages/contracts/docs/src/src/dollar/libraries/LibCreditNftRedemptionCalculator.sol/library.LibCreditNftRedemptionCalculator.md index c3128a5cc..8c635d87b 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibCreditNftRedemptionCalculator.sol/library.LibCreditNftRedemptionCalculator.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibCreditNftRedemptionCalculator.sol/library.LibCreditNftRedemptionCalculator.md @@ -1,5 +1,5 @@ # LibCreditNftRedemptionCalculator -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/LibCreditNftRedemptionCalculator.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/LibCreditNftRedemptionCalculator.sol) Library for calculating amount of Credit NFTs to mint on Dollars burn diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibCreditRedemptionCalculator.sol/library.LibCreditRedemptionCalculator.md b/packages/contracts/docs/src/src/dollar/libraries/LibCreditRedemptionCalculator.sol/library.LibCreditRedemptionCalculator.md index 298881941..dab021f90 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibCreditRedemptionCalculator.sol/library.LibCreditRedemptionCalculator.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibCreditRedemptionCalculator.sol/library.LibCreditRedemptionCalculator.md @@ -1,5 +1,5 @@ # LibCreditRedemptionCalculator -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/LibCreditRedemptionCalculator.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/LibCreditRedemptionCalculator.sol) Library for calculating amount of Credits to mint on Dollars burn diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibCurveDollarIncentive.sol/library.LibCurveDollarIncentive.md b/packages/contracts/docs/src/src/dollar/libraries/LibCurveDollarIncentive.sol/library.LibCurveDollarIncentive.md index b62c0d7c8..39ea27c71 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibCurveDollarIncentive.sol/library.LibCurveDollarIncentive.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibCurveDollarIncentive.sol/library.LibCurveDollarIncentive.md @@ -1,5 +1,5 @@ # LibCurveDollarIncentive -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/LibCurveDollarIncentive.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/LibCurveDollarIncentive.sol) Library adds buy incentive and sell penalty for Curve's Dollar-3CRV MetaPool diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibDiamond.sol/error.InitializationFunctionReverted.md b/packages/contracts/docs/src/src/dollar/libraries/LibDiamond.sol/error.InitializationFunctionReverted.md index f24b72a0e..f2245b263 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibDiamond.sol/error.InitializationFunctionReverted.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibDiamond.sol/error.InitializationFunctionReverted.md @@ -1,5 +1,5 @@ # InitializationFunctionReverted -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/LibDiamond.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/LibDiamond.sol) Error thrown when `initializeDiamondCut()` fails diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibDiamond.sol/library.LibDiamond.md b/packages/contracts/docs/src/src/dollar/libraries/LibDiamond.sol/library.LibDiamond.md index 3c8150294..83583f8ca 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibDiamond.sol/library.LibDiamond.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibDiamond.sol/library.LibDiamond.md @@ -1,5 +1,5 @@ # LibDiamond -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/LibDiamond.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/LibDiamond.sol) Library used for diamond facets and selector modifications diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibDirectGovernanceFarmer.sol/library.LibDirectGovernanceFarmer.md b/packages/contracts/docs/src/src/dollar/libraries/LibDirectGovernanceFarmer.sol/library.LibDirectGovernanceFarmer.md index 03eca4a18..4f4a7d17b 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibDirectGovernanceFarmer.sol/library.LibDirectGovernanceFarmer.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibDirectGovernanceFarmer.sol/library.LibDirectGovernanceFarmer.md @@ -1,5 +1,5 @@ # LibDirectGovernanceFarmer -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/LibDirectGovernanceFarmer.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/LibDirectGovernanceFarmer.sol) ## State Variables diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibDollarMintCalculator.sol/library.LibDollarMintCalculator.md b/packages/contracts/docs/src/src/dollar/libraries/LibDollarMintCalculator.sol/library.LibDollarMintCalculator.md index c1d12bcbf..3a6b8bd8e 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibDollarMintCalculator.sol/library.LibDollarMintCalculator.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibDollarMintCalculator.sol/library.LibDollarMintCalculator.md @@ -1,5 +1,5 @@ # LibDollarMintCalculator -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/LibDollarMintCalculator.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/LibDollarMintCalculator.sol) Calculates amount of Dollars ready to be minted when TWAP price (i.e. Dollar price) > 1$ diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibDollarMintExcess.sol/library.LibDollarMintExcess.md b/packages/contracts/docs/src/src/dollar/libraries/LibDollarMintExcess.sol/library.LibDollarMintExcess.md index 9eaecae63..2682d35ca 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibDollarMintExcess.sol/library.LibDollarMintExcess.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibDollarMintExcess.sol/library.LibDollarMintExcess.md @@ -1,5 +1,5 @@ # LibDollarMintExcess -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/LibDollarMintExcess.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/LibDollarMintExcess.sol) Library for distributing excess Dollars when `mintClaimableDollars()` is called diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibStaking.sol/library.LibStaking.md b/packages/contracts/docs/src/src/dollar/libraries/LibStaking.sol/library.LibStaking.md index fb06d3009..18a72e170 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibStaking.sol/library.LibStaking.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibStaking.sol/library.LibStaking.md @@ -1,5 +1,5 @@ # LibStaking -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/LibStaking.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/LibStaking.sol) Staking library diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibStakingFormulas.sol/library.LibStakingFormulas.md b/packages/contracts/docs/src/src/dollar/libraries/LibStakingFormulas.sol/library.LibStakingFormulas.md index 846b216ff..168c49b0c 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibStakingFormulas.sol/library.LibStakingFormulas.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibStakingFormulas.sol/library.LibStakingFormulas.md @@ -1,5 +1,5 @@ # LibStakingFormulas -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/LibStakingFormulas.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/LibStakingFormulas.sol) Library for staking formulas diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibUbiquityPool.sol/library.LibUbiquityPool.md b/packages/contracts/docs/src/src/dollar/libraries/LibUbiquityPool.sol/library.LibUbiquityPool.md index 52b198c91..3cc5bc167 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibUbiquityPool.sol/library.LibUbiquityPool.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibUbiquityPool.sol/library.LibUbiquityPool.md @@ -1,5 +1,5 @@ # LibUbiquityPool -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/LibUbiquityPool.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/LibUbiquityPool.sol) Ubiquity pool library diff --git a/packages/contracts/docs/src/src/dollar/libraries/UintUtils.sol/library.UintUtils.md b/packages/contracts/docs/src/src/dollar/libraries/UintUtils.sol/library.UintUtils.md index b10888d3a..960ca71eb 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/UintUtils.sol/library.UintUtils.md +++ b/packages/contracts/docs/src/src/dollar/libraries/UintUtils.sol/library.UintUtils.md @@ -1,5 +1,5 @@ # UintUtils -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/libraries/UintUtils.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/libraries/UintUtils.sol) *Derived from https://github.com/OpenZeppelin/openzeppelin-contracts/ (MIT license)* diff --git a/packages/contracts/docs/src/src/dollar/mocks/MockChainLinkFeed.sol/contract.MockChainLinkFeed.md b/packages/contracts/docs/src/src/dollar/mocks/MockChainLinkFeed.sol/contract.MockChainLinkFeed.md index 83d37e9cb..ef943a917 100644 --- a/packages/contracts/docs/src/src/dollar/mocks/MockChainLinkFeed.sol/contract.MockChainLinkFeed.md +++ b/packages/contracts/docs/src/src/dollar/mocks/MockChainLinkFeed.sol/contract.MockChainLinkFeed.md @@ -1,5 +1,5 @@ # MockChainLinkFeed -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/mocks/MockChainLinkFeed.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/mocks/MockChainLinkFeed.sol) **Inherits:** AggregatorV3Interface diff --git a/packages/contracts/docs/src/src/dollar/mocks/MockCurveFactory.sol/contract.MockCurveFactory.md b/packages/contracts/docs/src/src/dollar/mocks/MockCurveFactory.sol/contract.MockCurveFactory.md index d6777da65..4e9ae6472 100644 --- a/packages/contracts/docs/src/src/dollar/mocks/MockCurveFactory.sol/contract.MockCurveFactory.md +++ b/packages/contracts/docs/src/src/dollar/mocks/MockCurveFactory.sol/contract.MockCurveFactory.md @@ -1,5 +1,5 @@ # MockCurveFactory -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/mocks/MockCurveFactory.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/mocks/MockCurveFactory.sol) **Inherits:** [ICurveFactory](/src/dollar/interfaces/ICurveFactory.sol/interface.ICurveFactory.md) diff --git a/packages/contracts/docs/src/src/dollar/mocks/MockCurveStableSwapMetaNG.sol/contract.MockCurveStableSwapMetaNG.md b/packages/contracts/docs/src/src/dollar/mocks/MockCurveStableSwapMetaNG.sol/contract.MockCurveStableSwapMetaNG.md index a4b8f29d5..caf3f3bed 100644 --- a/packages/contracts/docs/src/src/dollar/mocks/MockCurveStableSwapMetaNG.sol/contract.MockCurveStableSwapMetaNG.md +++ b/packages/contracts/docs/src/src/dollar/mocks/MockCurveStableSwapMetaNG.sol/contract.MockCurveStableSwapMetaNG.md @@ -1,5 +1,5 @@ # MockCurveStableSwapMetaNG -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/mocks/MockCurveStableSwapMetaNG.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/mocks/MockCurveStableSwapMetaNG.sol) **Inherits:** [ICurveStableSwapMetaNG](/src/dollar/interfaces/ICurveStableSwapMetaNG.sol/interface.ICurveStableSwapMetaNG.md), [MockERC20](/src/dollar/mocks/MockERC20.sol/contract.MockERC20.md) @@ -51,6 +51,13 @@ function add_liquidity(uint256[2] memory _amounts, uint256 _min_mint_amount, add returns (uint256 result); ``` +### balances + + +```solidity +function balances(uint256) external pure returns (uint256); +``` + ### calc_token_amount diff --git a/packages/contracts/docs/src/src/dollar/mocks/MockERC20.sol/contract.MockERC20.md b/packages/contracts/docs/src/src/dollar/mocks/MockERC20.sol/contract.MockERC20.md index cf6934665..cbb586a71 100644 --- a/packages/contracts/docs/src/src/dollar/mocks/MockERC20.sol/contract.MockERC20.md +++ b/packages/contracts/docs/src/src/dollar/mocks/MockERC20.sol/contract.MockERC20.md @@ -1,5 +1,5 @@ # MockERC20 -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/mocks/MockERC20.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/mocks/MockERC20.sol) **Inherits:** ERC20 diff --git a/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/constants.MockFacet.md b/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/constants.MockFacet.md index de754ab0f..7d8e205a7 100644 --- a/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/constants.MockFacet.md +++ b/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/constants.MockFacet.md @@ -1,5 +1,5 @@ # Constants -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/mocks/MockFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/mocks/MockFacet.sol) ### NEW_STORAGE_POSITION diff --git a/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/contract.MockFacetInitializer.md b/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/contract.MockFacetInitializer.md index cf9911015..7d6990e16 100644 --- a/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/contract.MockFacetInitializer.md +++ b/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/contract.MockFacetInitializer.md @@ -1,5 +1,5 @@ # MockFacetInitializer -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/mocks/MockFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/mocks/MockFacet.sol) ## Functions diff --git a/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/contract.MockFacetWithExtendedStorageWriteFunctions.md b/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/contract.MockFacetWithExtendedStorageWriteFunctions.md index 8fd2f77b2..8e8109fcb 100644 --- a/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/contract.MockFacetWithExtendedStorageWriteFunctions.md +++ b/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/contract.MockFacetWithExtendedStorageWriteFunctions.md @@ -1,5 +1,5 @@ # MockFacetWithExtendedStorageWriteFunctions -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/mocks/MockFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/mocks/MockFacet.sol) **Inherits:** [IMockFacet](/src/dollar/mocks/MockFacet.sol/interface.IMockFacet.md) diff --git a/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/contract.MockFacetWithPureFunctions.md b/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/contract.MockFacetWithPureFunctions.md index a652fd4d1..a2ba1e611 100644 --- a/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/contract.MockFacetWithPureFunctions.md +++ b/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/contract.MockFacetWithPureFunctions.md @@ -1,5 +1,5 @@ # MockFacetWithPureFunctions -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/mocks/MockFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/mocks/MockFacet.sol) **Inherits:** [IMockFacet](/src/dollar/mocks/MockFacet.sol/interface.IMockFacet.md) diff --git a/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/contract.MockFacetWithStorageWriteFunctions.md b/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/contract.MockFacetWithStorageWriteFunctions.md index c16ee6ad7..40bdd9a19 100644 --- a/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/contract.MockFacetWithStorageWriteFunctions.md +++ b/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/contract.MockFacetWithStorageWriteFunctions.md @@ -1,5 +1,5 @@ # MockFacetWithStorageWriteFunctions -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/mocks/MockFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/mocks/MockFacet.sol) **Inherits:** [IMockFacet](/src/dollar/mocks/MockFacet.sol/interface.IMockFacet.md) diff --git a/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/interface.IMockFacet.md b/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/interface.IMockFacet.md index 72d973d9f..75f9320ec 100644 --- a/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/interface.IMockFacet.md +++ b/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/interface.IMockFacet.md @@ -1,5 +1,5 @@ # IMockFacet -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/mocks/MockFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/mocks/MockFacet.sol) ## Functions diff --git a/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/struct.NewSimpleStorage.md b/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/struct.NewSimpleStorage.md index 8650bace7..a192d7223 100644 --- a/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/struct.NewSimpleStorage.md +++ b/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/struct.NewSimpleStorage.md @@ -1,5 +1,5 @@ # NewSimpleStorage -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/mocks/MockFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/mocks/MockFacet.sol) ```solidity diff --git a/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/struct.NewStorageExtended.md b/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/struct.NewStorageExtended.md index 7bb0e7c2e..46d4056e7 100644 --- a/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/struct.NewStorageExtended.md +++ b/packages/contracts/docs/src/src/dollar/mocks/MockFacet.sol/struct.NewStorageExtended.md @@ -1,5 +1,5 @@ # NewStorageExtended -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/mocks/MockFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/mocks/MockFacet.sol) ```solidity diff --git a/packages/contracts/docs/src/src/dollar/mocks/MockShareV1.sol/contract.BondingShare.md b/packages/contracts/docs/src/src/dollar/mocks/MockShareV1.sol/contract.BondingShare.md index 9917fdfcf..cf9fa7f45 100644 --- a/packages/contracts/docs/src/src/dollar/mocks/MockShareV1.sol/contract.BondingShare.md +++ b/packages/contracts/docs/src/src/dollar/mocks/MockShareV1.sol/contract.BondingShare.md @@ -1,5 +1,5 @@ # BondingShare -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/mocks/MockShareV1.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/mocks/MockShareV1.sol) **Inherits:** [StakingShare](/src/dollar/core/StakingShare.sol/contract.StakingShare.md) diff --git a/packages/contracts/docs/src/src/dollar/upgradeInitializers/DiamondInit.sol/contract.DiamondInit.md b/packages/contracts/docs/src/src/dollar/upgradeInitializers/DiamondInit.sol/contract.DiamondInit.md index 08737b7c6..611836c88 100644 --- a/packages/contracts/docs/src/src/dollar/upgradeInitializers/DiamondInit.sol/contract.DiamondInit.md +++ b/packages/contracts/docs/src/src/dollar/upgradeInitializers/DiamondInit.sol/contract.DiamondInit.md @@ -1,5 +1,5 @@ # DiamondInit -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/upgradeInitializers/DiamondInit.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/upgradeInitializers/DiamondInit.sol) **Inherits:** [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md) diff --git a/packages/contracts/docs/src/src/dollar/utils/SafeAddArray.sol/library.SafeAddArray.md b/packages/contracts/docs/src/src/dollar/utils/SafeAddArray.sol/library.SafeAddArray.md index 28b8240a8..dbcf58448 100644 --- a/packages/contracts/docs/src/src/dollar/utils/SafeAddArray.sol/library.SafeAddArray.md +++ b/packages/contracts/docs/src/src/dollar/utils/SafeAddArray.sol/library.SafeAddArray.md @@ -1,5 +1,5 @@ # SafeAddArray -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/501e69f1c1c7c1a4291867db587c06a5387026e0/src/dollar/utils/SafeAddArray.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/b59512059f70e70f7d719ba196d6f1f9322569a0/src/dollar/utils/SafeAddArray.sol) Wrappers over Solidity's array push operations with added check