diff --git a/packages/contracts/docs/src/SUMMARY.md b/packages/contracts/docs/src/SUMMARY.md index 8bf6c6264..9f8fa8d0b 100644 --- a/packages/contracts/docs/src/SUMMARY.md +++ b/packages/contracts/docs/src/SUMMARY.md @@ -44,6 +44,7 @@ - [ICurveFactory](src/dollar/interfaces/ICurveFactory.sol/interface.ICurveFactory.md) - [ICurveStableSwapFactoryNG](src/dollar/interfaces/ICurveStableSwapFactoryNG.sol/interface.ICurveStableSwapFactoryNG.md) - [ICurveStableSwapMetaNG](src/dollar/interfaces/ICurveStableSwapMetaNG.sol/interface.ICurveStableSwapMetaNG.md) + - [ICurveStableSwapNG](src/dollar/interfaces/ICurveStableSwapNG.sol/interface.ICurveStableSwapNG.md) - [ICurveTwocryptoOptimized](src/dollar/interfaces/ICurveTwocryptoOptimized.sol/interface.ICurveTwocryptoOptimized.md) - [IDepositZap](src/dollar/interfaces/IDepositZap.sol/interface.IDepositZap.md) - [IDiamondCut](src/dollar/interfaces/IDiamondCut.sol/interface.IDiamondCut.md) @@ -91,6 +92,7 @@ - [MockChainLinkFeed](src/dollar/mocks/MockChainLinkFeed.sol/contract.MockChainLinkFeed.md) - [MockCurveFactory](src/dollar/mocks/MockCurveFactory.sol/contract.MockCurveFactory.md) - [MockCurveStableSwapMetaNG](src/dollar/mocks/MockCurveStableSwapMetaNG.sol/contract.MockCurveStableSwapMetaNG.md) + - [MockCurveStableSwapNG](src/dollar/mocks/MockCurveStableSwapNG.sol/contract.MockCurveStableSwapNG.md) - [MockCurveTwocryptoOptimized](src/dollar/mocks/MockCurveTwocryptoOptimized.sol/contract.MockCurveTwocryptoOptimized.md) - [MockERC20](src/dollar/mocks/MockERC20.sol/contract.MockERC20.md) - [IMockFacet](src/dollar/mocks/MockFacet.sol/interface.IMockFacet.md) diff --git a/packages/contracts/docs/src/src/dollar/Diamond.sol/contract.Diamond.md b/packages/contracts/docs/src/src/dollar/Diamond.sol/contract.Diamond.md index 4a9bffd89..586b7ba67 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/Diamond.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/Diamond.sol) Contract that implements diamond proxy pattern diff --git a/packages/contracts/docs/src/src/dollar/Diamond.sol/struct.DiamondArgs.md b/packages/contracts/docs/src/src/dollar/Diamond.sol/struct.DiamondArgs.md index 890f97e0a..7bc4e25b1 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/Diamond.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/Diamond.sol) Struct used for `Diamond` constructor args diff --git a/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 1f2ce4364..abb3aaabe 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/access/AccessControlInternal.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/access/AccessControlInternal.sol) Role-based access control system diff --git a/packages/contracts/docs/src/src/dollar/core/CreditNft.sol/contract.CreditNft.md b/packages/contracts/docs/src/src/dollar/core/CreditNft.sol/contract.CreditNft.md index 0b3e59826..3349c9fd0 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/core/CreditNft.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/core/CreditNft.sol) **Inherits:** [ERC1155Ubiquity](/src/dollar/core/ERC1155Ubiquity.sol/abstract.ERC1155Ubiquity.md), [ICreditNft](/src/dollar/interfaces/ICreditNft.sol/interface.ICreditNft.md) diff --git a/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 b67c4f63b..b5139b8c3 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/core/ERC1155Ubiquity.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/core/ERC1155Ubiquity.sol) **Inherits:** Initializable, ERC1155BurnableUpgradeable, ERC1155PausableUpgradeable, UUPSUpgradeable diff --git a/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 5dab62800..ad1e55c9d 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/core/ERC20Ubiquity.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/core/ERC20Ubiquity.sol) **Inherits:** Initializable, UUPSUpgradeable, ERC20Upgradeable, ERC20PermitUpgradeable, ERC20PausableUpgradeable diff --git a/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 aa9c8ed67..c11fac9d8 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/core/StakingShare.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/core/StakingShare.sol) **Inherits:** [ERC1155Ubiquity](/src/dollar/core/ERC1155Ubiquity.sol/abstract.ERC1155Ubiquity.md), ERC1155URIStorageUpgradeable diff --git a/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 f65679b6e..717ba21b4 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/core/UbiquityCreditToken.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/core/UbiquityCreditToken.sol) **Inherits:** [ERC20Ubiquity](/src/dollar/core/ERC20Ubiquity.sol/abstract.ERC20Ubiquity.md) diff --git a/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 8be5b933f..0ba2a4d20 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/core/UbiquityDollarToken.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/core/UbiquityDollarToken.sol) **Inherits:** [ERC20Ubiquity](/src/dollar/core/ERC20Ubiquity.sol/abstract.ERC20Ubiquity.md) diff --git a/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 8bd84acd2..350f0376d 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/core/UbiquityGovernanceToken.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/core/UbiquityGovernanceToken.sol) **Inherits:** [ERC20Ubiquity](/src/dollar/core/ERC20Ubiquity.sol/abstract.ERC20Ubiquity.md) diff --git a/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 4ef2b1da8..e922066d0 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/AccessControlFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/AccessControlFacet.sol) **Inherits:** [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md), [IAccessControl](/src/dollar/interfaces/IAccessControl.sol/interface.IAccessControl.md), [AccessControlInternal](/src/dollar/access/AccessControlInternal.sol/abstract.AccessControlInternal.md) diff --git a/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 b1b2816be..1112cd311 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/BondingCurveFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/BondingCurveFacet.sol) **Inherits:** [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md), [IBondingCurve](/src/dollar/interfaces/IBondingCurve.sol/interface.IBondingCurve.md) diff --git a/packages/contracts/docs/src/src/dollar/facets/ChefFacet.sol/contract.ChefFacet.md b/packages/contracts/docs/src/src/dollar/facets/ChefFacet.sol/contract.ChefFacet.md index 4cb994ed7..b33233191 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/ChefFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/ChefFacet.sol) **Inherits:** [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md) diff --git a/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 cce998de2..a14a69fe8 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/CollectableDustFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/CollectableDustFacet.sol) **Inherits:** [ICollectableDust](/src/dollar/interfaces/utils/ICollectableDust.sol/interface.ICollectableDust.md), [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md) diff --git a/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 f227e6cd0..b6c81c8a1 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/CreditClockFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/CreditClockFacet.sol) **Inherits:** [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md) diff --git a/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 da04f4418..7c936f3a4 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/CreditNftManagerFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/CreditNftManagerFacet.sol) **Inherits:** [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md) diff --git a/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 4bfd56caf..644ec2b57 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/CreditNftRedemptionCalculatorFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/CreditNftRedemptionCalculatorFacet.sol) **Inherits:** [ICreditNftRedemptionCalculator](/src/dollar/interfaces/ICreditNftRedemptionCalculator.sol/interface.ICreditNftRedemptionCalculator.md) diff --git a/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 f8165625c..890b07c60 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/CreditRedemptionCalculatorFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/CreditRedemptionCalculatorFacet.sol) **Inherits:** [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md), [ICreditRedemptionCalculator](/src/dollar/interfaces/ICreditRedemptionCalculator.sol/interface.ICreditRedemptionCalculator.md) diff --git a/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 b9036c77f..610c41018 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/CurveDollarIncentiveFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/CurveDollarIncentiveFacet.sol) **Inherits:** [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md) diff --git a/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 c2314df8e..44c181b57 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/DiamondCutFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/DiamondCutFacet.sol) **Inherits:** [IDiamondCut](/src/dollar/interfaces/IDiamondCut.sol/interface.IDiamondCut.md) diff --git a/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 4b3a7a464..bf69ff665 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/DiamondLoupeFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/DiamondLoupeFacet.sol) **Inherits:** [IDiamondLoupe](/src/dollar/interfaces/IDiamondLoupe.sol/interface.IDiamondLoupe.md), IERC165 diff --git a/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 8c5bd512e..4aa7551f3 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/DirectGovernanceFarmerFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/DirectGovernanceFarmerFacet.sol) **Inherits:** [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md) diff --git a/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 e8754369c..2087b2249 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/DollarMintCalculatorFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/DollarMintCalculatorFacet.sol) **Inherits:** [IDollarMintCalculator](/src/dollar/interfaces/IDollarMintCalculator.sol/interface.IDollarMintCalculator.md) diff --git a/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 cae19bfe2..57812d374 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/DollarMintExcessFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/DollarMintExcessFacet.sol) **Inherits:** [IDollarMintExcess](/src/dollar/interfaces/IDollarMintExcess.sol/interface.IDollarMintExcess.md) diff --git a/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 59ec46bff..416c8cb7b 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/ManagerFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/ManagerFacet.sol) **Inherits:** [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md) @@ -204,6 +204,23 @@ function setStableSwapMetaPoolAddress(address _stableSwapMetaPoolAddress) extern |`_stableSwapMetaPoolAddress`|`address`|Curve Dollar-3CRV MetaPool address| +### setStableSwapPlainPoolAddress + +Sets Curve's Dollar-Stablecoin plain pool address + +*`_stableSwapPlainPoolAddress` is used to fetch Dollar price in USD* + + +```solidity +function setStableSwapPlainPoolAddress(address _stableSwapPlainPoolAddress) external onlyAdmin; +``` +**Parameters** + +|Name|Type|Description| +|----|----|-----------| +|`_stableSwapPlainPoolAddress`|`address`|Curve's Dollar-Stablecoin plain pool address| + + ### setStakingContractAddress Sets staking contract address @@ -546,6 +563,21 @@ function stableSwapMetaPoolAddress() external view returns (address); |``|`address`|Curve MetaPool address| +### stableSwapPlainPoolAddress + +Returns Curve's plain pool address for Dollar-Stablecoin pair + + +```solidity +function stableSwapPlainPoolAddress() external view returns (address); +``` +**Returns** + +|Name|Type|Description| +|----|----|-----------| +|``|`address`|Curve's plain pool address for Dollar-Stablecoin pair| + + ### stakingContractAddress Returns staking address 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 57f622393..5ea242cc2 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/OwnershipFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/OwnershipFacet.sol) **Inherits:** [IERC173](/src/dollar/interfaces/IERC173.sol/interface.IERC173.md) diff --git a/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 024b15eea..e9a187887 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/StakingFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/StakingFacet.sol) **Inherits:** [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md), [IStaking](/src/dollar/interfaces/IStaking.sol/interface.IStaking.md) diff --git a/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 66d1c4393..f242db400 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/StakingFormulasFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/StakingFormulasFacet.sol) **Inherits:** [IUbiquityFormulas](/src/dollar/interfaces/IUbiquityFormulas.sol/interface.IUbiquityFormulas.md) diff --git a/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 b4d5e7501..643976e9c 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/facets/UbiquityPoolFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/facets/UbiquityPoolFacet.sol) **Inherits:** [IUbiquityPool](/src/dollar/interfaces/IUbiquityPool.sol/interface.IUbiquityPool.md), [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md) @@ -233,6 +233,24 @@ function governanceEthPoolAddress() external view returns (address); |``|`address`|Pool address| +### stableUsdPriceFeedInformation + +Returns chainlink price feed information for stable/USD pair + +*Here stable coin refers to the 1st coin in the Curve's stable/Dollar plain pool* + + +```solidity +function stableUsdPriceFeedInformation() external view returns (address, uint256); +``` +**Returns** + +|Name|Type|Description| +|----|----|-----------| +|``|`address`|Price feed address and staleness threshold in seconds| +|``|`uint256`|| + + ### mintDollar Mints Dollars in exchange for collateral tokens @@ -548,6 +566,26 @@ function setRedemptionDelayBlocks(uint256 newRedemptionDelayBlocks) external onl |`newRedemptionDelayBlocks`|`uint256`|Redemption delay in blocks| +### setStableUsdChainLinkPriceFeed + +Sets chainlink params for stable/USD price feed + +*Here stable coin refers to the 1st coin in the Curve's stable/Dollar plain pool* + + +```solidity +function setStableUsdChainLinkPriceFeed(address newPriceFeedAddress, uint256 newStalenessThreshold) + external + onlyAdmin; +``` +**Parameters** + +|Name|Type|Description| +|----|----|-----------| +|`newPriceFeedAddress`|`address`|New chainlink price feed address for stable/USD pair| +|`newStalenessThreshold`|`uint256`|New threshold in seconds when chainlink's stable/USD price feed answer should be considered stale| + + ### toggleCollateral Toggles (i.e. enables/disables) a particular collateral token diff --git a/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 861d39d56..5924c7b2a 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IAccessControl.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/interfaces/IAccessControl.sol) Access contol interface diff --git a/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 30d9ac92b..eb6c8db85 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IBondingCurve.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/interfaces/IBondingCurve.sol) Interface based on Bancor formula diff --git a/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 0aebf2205..ae1e1a360 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/ICreditNft.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/interfaces/ICreditNft.sol) **Inherits:** IERC1155Upgradeable diff --git a/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 0b828b064..1550c966d 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/ICreditNftManager.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/interfaces/ICreditNftManager.sol) **Inherits:** IERC1155Receiver diff --git a/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 d84cfcd77..991b78065 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/ICreditNftRedemptionCalculator.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/interfaces/ICreditNftRedemptionCalculator.sol) Contract interface for calculating amount of Credit NFTs to mint on Dollars burn diff --git a/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 039780736..186aabcea 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/ICreditRedemptionCalculator.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/interfaces/ICreditRedemptionCalculator.sol) Contract interface for calculating amount of Credits to mint on Dollars burn diff --git a/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 c561c7fe4..853b37fe9 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/ICurveFactory.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 index 04902cd38..5eaa243e4 100644 --- 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 @@ -1,5 +1,5 @@ # ICurveStableSwapFactoryNG -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/ICurveStableSwapFactoryNG.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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). 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 803e2f115..6b6d57f4b 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/ICurveStableSwapMetaNG.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/interfaces/ICurveStableSwapMetaNG.sol) **Inherits:** IERC20 diff --git a/packages/contracts/docs/src/src/dollar/interfaces/ICurveStableSwapNG.sol/interface.ICurveStableSwapNG.md b/packages/contracts/docs/src/src/dollar/interfaces/ICurveStableSwapNG.sol/interface.ICurveStableSwapNG.md new file mode 100644 index 000000000..919dd8d79 --- /dev/null +++ b/packages/contracts/docs/src/src/dollar/interfaces/ICurveStableSwapNG.sol/interface.ICurveStableSwapNG.md @@ -0,0 +1,9 @@ +# ICurveStableSwapNG +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/interfaces/ICurveStableSwapNG.sol) + +**Inherits:** +[ICurveStableSwapMetaNG](/src/dollar/interfaces/ICurveStableSwapMetaNG.sol/interface.ICurveStableSwapMetaNG.md) + +Curve's interface for plain pool which contains only USD pegged assets + + diff --git a/packages/contracts/docs/src/src/dollar/interfaces/ICurveTwocryptoOptimized.sol/interface.ICurveTwocryptoOptimized.md b/packages/contracts/docs/src/src/dollar/interfaces/ICurveTwocryptoOptimized.sol/interface.ICurveTwocryptoOptimized.md index 2a478e996..b481cce04 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/ICurveTwocryptoOptimized.sol/interface.ICurveTwocryptoOptimized.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/ICurveTwocryptoOptimized.sol/interface.ICurveTwocryptoOptimized.md @@ -1,5 +1,5 @@ # ICurveTwocryptoOptimized -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/ICurveTwocryptoOptimized.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/interfaces/ICurveTwocryptoOptimized.sol) **Inherits:** [ICurveStableSwapMetaNG](/src/dollar/interfaces/ICurveStableSwapMetaNG.sol/interface.ICurveStableSwapMetaNG.md) 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 984de34b6..1e1450be9 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IDepositZap.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 f82147b7d..b39a9e798 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IDiamondCut.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 ecbe39943..4eec6ba63 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IDiamondLoupe.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 e51fc8802..3df18eed2 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IDollarAmoMinter.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 53f926873..7afbabc76 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IDollarMintCalculator.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 68396607b..e2819803f 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IDollarMintExcess.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 c7aca6f5e..3c82bd924 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IERC1155Ubiquity.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 3493e579a..d8b96989c 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IERC173.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 0ab555cee..fffc1d013 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IERC20Ubiquity.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 6a7a81664..d051977e5 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IStableSwap3Pool.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 945d7288f..9a3ab359b 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IStaking.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 7e7c9800e..8eba51781 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IStakingShare.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 a976a94ca..4e2031333 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IUbiquityChef.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 6aeee7b57..32d1bf4fb 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IUbiquityDollarManager.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 44b903f54..f3b8d4995 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IUbiquityDollarToken.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 328b24425..c4674de21 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IUbiquityFormulas.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 69d00d90c..97c909827 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IUbiquityGovernance.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 0eaa83c48..4edbe485d 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/IUbiquityPool.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/interfaces/IUbiquityPool.sol) Ubiquity pool interface @@ -230,6 +230,24 @@ function governanceEthPoolAddress() external view returns (address); |``|`address`|Pool address| +### stableUsdPriceFeedInformation + +Returns chainlink price feed information for stable/USD pair + +*Here stable coin refers to the 1st coin in the Curve's stable/Dollar plain pool* + + +```solidity +function stableUsdPriceFeedInformation() external view returns (address, uint256); +``` +**Returns** + +|Name|Type|Description| +|----|----|-----------| +|``|`address`|Price feed address and staleness threshold in seconds| +|``|`uint256`|| + + ### mintDollar Mints Dollars in exchange for collateral tokens @@ -568,6 +586,24 @@ function setRedemptionDelayBlocks(uint256 newRedemptionDelayBlocks) external; |`newRedemptionDelayBlocks`|`uint256`|Redemption delay in blocks| +### setStableUsdChainLinkPriceFeed + +Sets chainlink params for stable/USD price feed + +*Here stable coin refers to the 1st coin in the Curve's stable/Dollar plain pool* + + +```solidity +function setStableUsdChainLinkPriceFeed(address newPriceFeedAddress, uint256 newStalenessThreshold) external; +``` +**Parameters** + +|Name|Type|Description| +|----|----|-----------| +|`newPriceFeedAddress`|`address`|New chainlink price feed address for stable/USD pair| +|`newStalenessThreshold`|`uint256`|New threshold in seconds when chainlink's stable/USD price feed answer should be considered stale| + + ### toggleCollateral Toggles (i.e. enables/disables) a particular collateral token diff --git a/packages/contracts/docs/src/src/dollar/interfaces/README.md b/packages/contracts/docs/src/src/dollar/interfaces/README.md index de219e29d..07bf9c282 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/README.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/README.md @@ -11,6 +11,7 @@ - [ICurveFactory](ICurveFactory.sol/interface.ICurveFactory.md) - [ICurveStableSwapFactoryNG](ICurveStableSwapFactoryNG.sol/interface.ICurveStableSwapFactoryNG.md) - [ICurveStableSwapMetaNG](ICurveStableSwapMetaNG.sol/interface.ICurveStableSwapMetaNG.md) +- [ICurveStableSwapNG](ICurveStableSwapNG.sol/interface.ICurveStableSwapNG.md) - [ICurveTwocryptoOptimized](ICurveTwocryptoOptimized.sol/interface.ICurveTwocryptoOptimized.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 364bfc5d0..f091bb6cd 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/interfaces/utils/ICollectableDust.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 159a642d5..79b39d82a 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/AddressUtils.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 13139a504..d56bd179a 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/Constants.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 8c6745a12..2f78e2180 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/LibAccessControl.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 65d865fb9..2ebd71ed8 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/LibAppStorage.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 d0e00aeae..6fdefab38 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/LibAppStorage.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 9bbb845af..2343ec655 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/LibAppStorage.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/libraries/LibAppStorage.sol) Shared struct used as a storage in the `LibAppStorage` library @@ -14,6 +14,7 @@ struct AppStorage { address stakingShareAddress; address stakingContractAddress; address stableSwapMetaPoolAddress; + address stableSwapPlainPoolAddress; address curve3PoolTokenAddress; address treasuryAddress; address governanceTokenAddress; 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 d438bb524..f3dab6080 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/LibBondingCurve.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 a1fef6131..fc8110d0d 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/LibChef.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 b123c612f..347f30520 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/LibCollectableDust.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 aa48122b7..94c992388 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/LibCreditClock.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 18d7132da..6444f5436 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/LibCreditNftManager.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 854a83be0..58cc497b1 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/LibCreditNftRedemptionCalculator.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 0b750b32f..e393fb354 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/LibCreditRedemptionCalculator.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 d64b0d609..7472606ed 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/LibCurveDollarIncentive.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 54d5e2b9e..ae9d1d893 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/LibDiamond.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 1fa594cdf..2ef8dbe0a 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/LibDiamond.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 6d318819b..680022e2a 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/LibDirectGovernanceFarmer.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 2df480445..66205deb1 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/LibDollarMintCalculator.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 4bec05f94..75e185469 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/LibDollarMintExcess.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 0fc70e4fe..b732cc8d5 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/LibStaking.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 86df03b52..07370cfd7 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/LibStakingFormulas.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 0f7412309..ecf031349 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/LibUbiquityPool.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/libraries/LibUbiquityPool.sol) Ubiquity pool library @@ -204,7 +204,11 @@ function getDollarInCollateral(uint256 collateralIndex, uint256 dollarAmount) in ### getDollarPriceUsd -Returns Ubiquity Dollar token USD price (1e6 precision) from Curve Metapool (Ubiquity Dollar, Curve Tri-Pool LP) +Returns Ubiquity Dollar token USD price (1e6 precision) from Curve plain pool (Stable coin, Ubiquity Dollar) +How it works: +1. Fetch Stable/USD quote from chainlink +2. Fetch Dollar/Stable quote from Curve's plain pool +3. Calculate Dollar token price in USD ```solidity @@ -295,6 +299,24 @@ function governanceEthPoolAddress() internal view returns (address); |``|`address`|Pool address| +### stableUsdPriceFeedInformation + +Returns chainlink price feed information for stable/USD pair + +*Here stable coin refers to the 1st coin in the Curve's stable/Dollar plain pool* + + +```solidity +function stableUsdPriceFeedInformation() internal view returns (address, uint256); +``` +**Returns** + +|Name|Type|Description| +|----|----|-----------| +|``|`address`|Price feed address and staleness threshold in seconds| +|``|`uint256`|| + + ### mintDollar Mints Dollars in exchange for collateral tokens @@ -640,6 +662,24 @@ function setRedemptionDelayBlocks(uint256 newRedemptionDelayBlocks) internal; |`newRedemptionDelayBlocks`|`uint256`|Redemption delay in blocks| +### setStableUsdChainLinkPriceFeed + +Sets chainlink params for stable/USD price feed + +*Here stable coin refers to the 1st coin in the Curve's stable/Dollar plain pool* + + +```solidity +function setStableUsdChainLinkPriceFeed(address newPriceFeedAddress, uint256 newStalenessThreshold) internal; +``` +**Parameters** + +|Name|Type|Description| +|----|----|-----------| +|`newPriceFeedAddress`|`address`|New chainlink price feed address for stable/USD pair| +|`newStalenessThreshold`|`uint256`|New threshold in seconds when chainlink's stable/USD price feed answer should be considered stale| + + ### toggleCollateral Toggles (i.e. enables/disables) a particular collateral token @@ -776,6 +816,14 @@ Emitted when a new redemption delay in blocks is set event RedemptionDelayBlocksSet(uint256 redemptionDelayBlocks); ``` +### StableUsdPriceFeedSet +Emitted on setting chainlink's price feed for stable/USD pair + + +```solidity +event StableUsdPriceFeedSet(address newPriceFeedAddress, uint256 newStalenessThreshold); +``` + ## Structs ### UbiquityPoolStorage Struct used as a storage for this library @@ -810,6 +858,8 @@ struct UbiquityPoolStorage { address ethUsdPriceFeedAddress; uint256 ethUsdPriceFeedStalenessThreshold; address governanceEthPoolAddress; + address stableUsdPriceFeedAddress; + uint256 stableUsdPriceFeedStalenessThreshold; } ``` 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 67520213d..814c5a5b8 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/libraries/UintUtils.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 bc99692e2..bdddae550 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/mocks/MockChainLinkFeed.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 cdf9bad1b..b6f1aedb6 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/mocks/MockCurveFactory.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 ec5d55321..2f205fe0a 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/mocks/MockCurveStableSwapMetaNG.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/mocks/MockCurveStableSwapMetaNG.sol) **Inherits:** [ICurveStableSwapMetaNG](/src/dollar/interfaces/ICurveStableSwapMetaNG.sol/interface.ICurveStableSwapMetaNG.md), [MockERC20](/src/dollar/mocks/MockERC20.sol/contract.MockERC20.md) diff --git a/packages/contracts/docs/src/src/dollar/mocks/MockCurveStableSwapNG.sol/contract.MockCurveStableSwapNG.md b/packages/contracts/docs/src/src/dollar/mocks/MockCurveStableSwapNG.sol/contract.MockCurveStableSwapNG.md new file mode 100644 index 000000000..f0f7db8b5 --- /dev/null +++ b/packages/contracts/docs/src/src/dollar/mocks/MockCurveStableSwapNG.sol/contract.MockCurveStableSwapNG.md @@ -0,0 +1,15 @@ +# MockCurveStableSwapNG +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/mocks/MockCurveStableSwapNG.sol) + +**Inherits:** +[ICurveStableSwapNG](/src/dollar/interfaces/ICurveStableSwapNG.sol/interface.ICurveStableSwapNG.md), [MockCurveStableSwapMetaNG](/src/dollar/mocks/MockCurveStableSwapMetaNG.sol/contract.MockCurveStableSwapMetaNG.md) + + +## Functions +### constructor + + +```solidity +constructor(address _token0, address _token1) MockCurveStableSwapMetaNG(_token0, _token1); +``` + diff --git a/packages/contracts/docs/src/src/dollar/mocks/MockCurveTwocryptoOptimized.sol/contract.MockCurveTwocryptoOptimized.md b/packages/contracts/docs/src/src/dollar/mocks/MockCurveTwocryptoOptimized.sol/contract.MockCurveTwocryptoOptimized.md index 2938a5f2a..5d2a2d0d1 100644 --- a/packages/contracts/docs/src/src/dollar/mocks/MockCurveTwocryptoOptimized.sol/contract.MockCurveTwocryptoOptimized.md +++ b/packages/contracts/docs/src/src/dollar/mocks/MockCurveTwocryptoOptimized.sol/contract.MockCurveTwocryptoOptimized.md @@ -1,5 +1,5 @@ # MockCurveTwocryptoOptimized -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/mocks/MockCurveTwocryptoOptimized.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/mocks/MockCurveTwocryptoOptimized.sol) **Inherits:** [ICurveTwocryptoOptimized](/src/dollar/interfaces/ICurveTwocryptoOptimized.sol/interface.ICurveTwocryptoOptimized.md), [MockCurveStableSwapMetaNG](/src/dollar/mocks/MockCurveStableSwapMetaNG.sol/contract.MockCurveStableSwapMetaNG.md) 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 028e873ed..afff63c42 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/mocks/MockERC20.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 8d1597702..966fd10b6 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/mocks/MockFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 054bca4e9..fc048cf5d 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/mocks/MockFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 0aec88198..07891b9b6 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/mocks/MockFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 42f05ac32..bf86c5bf1 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/mocks/MockFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 f7dadadb4..c83bf1a01 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/mocks/MockFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 db5338312..60c371d56 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/mocks/MockFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 c41b584bd..efe287ada 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/mocks/MockFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 6a0cfb653..3a2eb9504 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/mocks/MockFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 efd2d510d..a281d4338 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/mocks/MockShareV1.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/mocks/MockShareV1.sol) **Inherits:** [StakingShare](/src/dollar/core/StakingShare.sol/contract.StakingShare.md) diff --git a/packages/contracts/docs/src/src/dollar/mocks/README.md b/packages/contracts/docs/src/src/dollar/mocks/README.md index 8bd2b704c..bac383871 100644 --- a/packages/contracts/docs/src/src/dollar/mocks/README.md +++ b/packages/contracts/docs/src/src/dollar/mocks/README.md @@ -4,6 +4,7 @@ - [MockChainLinkFeed](MockChainLinkFeed.sol/contract.MockChainLinkFeed.md) - [MockCurveFactory](MockCurveFactory.sol/contract.MockCurveFactory.md) - [MockCurveStableSwapMetaNG](MockCurveStableSwapMetaNG.sol/contract.MockCurveStableSwapMetaNG.md) +- [MockCurveStableSwapNG](MockCurveStableSwapNG.sol/contract.MockCurveStableSwapNG.md) - [MockCurveTwocryptoOptimized](MockCurveTwocryptoOptimized.sol/contract.MockCurveTwocryptoOptimized.md) - [MockERC20](MockERC20.sol/contract.MockERC20.md) - [IMockFacet](MockFacet.sol/interface.IMockFacet.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 f0ef2ad22..f1ba0e84c 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/upgradeInitializers/DiamondInit.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/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 bb38269ef..40aa3dba5 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/562529d3970008a3b47fdae4073c66a60be478ff/src/dollar/utils/SafeAddArray.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8aaa03cffd9aba9b0325a42c35c9bebd3a97267d/src/dollar/utils/SafeAddArray.sol) Wrappers over Solidity's array push operations with added check