From af8370b4547da2f7a9d067329d1a45141339b9f2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 24 Oct 2023 12:45:19 +0000 Subject: [PATCH] docs: auto generate NATSPEC docs --- packages/contracts/docs/book.toml | 4 +- packages/contracts/docs/src/SUMMARY.md | 3 +- .../dollar/Diamond.sol/contract.Diamond.md | 2 +- .../dollar/Diamond.sol/struct.DiamondArgs.md | 2 +- .../contract.DirectGovernanceFarmer.md | 2 +- .../abstract.AccessControlInternal.md | 2 +- .../core/CreditNft.sol/contract.CreditNft.md | 2 +- .../abstract.ERC1155Ubiquity.md | 2 +- .../abstract.ERC20Ubiquity.md | 2 +- .../docs/src/src/dollar/core/README.md | 1 - .../StakingShare.sol/contract.StakingShare.md | 2 +- .../contract.UbiquityCreditToken.md | 2 +- .../contract.UbiquityDollarToken.md | 2 +- .../contract.UbiquityGovernanceToken.md | 2 +- .../contract.AccessControlFacet.md | 2 +- .../contract.BondingCurveFacet.md | 2 +- .../ChefFacet.sol/contract.ChefFacet.md | 2 +- .../contract.CollectableDustFacet.md | 2 +- .../contract.CreditClockFacet.md | 68 ++++++++++ .../contract.CreditNftManagerFacet.md | 2 +- ...ract.CreditNftRedemptionCalculatorFacet.md | 2 +- ...ontract.CreditRedemptionCalculatorFacet.md | 2 +- .../contract.CurveDollarIncentiveFacet.md | 2 +- .../contract.DiamondCutFacet.md | 2 +- .../contract.DiamondLoupeFacet.md | 2 +- .../contract.DollarMintCalculatorFacet.md | 2 +- .../contract.DollarMintExcessFacet.md | 2 +- .../ManagerFacet.sol/contract.ManagerFacet.md | 2 +- .../contract.OwnershipFacet.md | 2 +- .../docs/src/src/dollar/facets/README.md | 1 + .../StakingFacet.sol/contract.StakingFacet.md | 2 +- .../contract.StakingFormulasFacet.md | 2 +- .../contract.TWAPOracleDollar3poolFacet.md | 2 +- .../contract.UbiquityPoolFacet.md | 2 +- .../interface.IAccessControl.md | 2 +- .../interface.IBondingCurve.md | 2 +- .../ICreditNft.sol/interface.ICreditNft.md | 2 +- .../interface.ICreditNftManager.md | 2 +- ...nterface.ICreditNftRedemptionCalculator.md | 2 +- .../interface.ICreditRedemptionCalculator.md | 2 +- .../interface.ICurveFactory.md | 2 +- .../IDepositZap.sol/interface.IDepositZap.md | 2 +- .../IDiamondCut.sol/interface.IDiamondCut.md | 2 +- .../interface.IDiamondLoupe.md | 2 +- .../interface.IDollarMintCalculator.md | 2 +- .../interface.IDollarMintExcess.md | 2 +- .../interface.IERC1155Ubiquity.md | 2 +- .../IERC173.sol/interface.IERC173.md | 2 +- .../interface.IERC20Ubiquity.md | 2 +- .../IIncentive.sol/interface.IIncentive.md | 2 +- .../interfaces/IJar.sol/interface.IJar.md | 2 +- .../IMetaPool.sol/interface.IMetaPool.md | 2 +- .../interface.IStableSwap3Pool.md | 2 +- .../IStaking.sol/interface.IStaking.md | 2 +- .../interface.IStakingShare.md | 2 +- .../interface.ITWAPOracleDollar3pool.md | 2 +- .../interface.IUbiquityChef.md | 2 +- .../interface.IUbiquityDollarManager.md | 2 +- .../interface.IUbiquityDollarToken.md | 2 +- .../interface.IUbiquityFormulas.md | 2 +- .../interface.IUbiquityGovernanceToken.md | 2 +- .../interface.IUbiquityPool.md | 2 +- .../interface.ICollectableDust.md | 2 +- .../AddressUtils.sol/library.AddressUtils.md | 2 +- .../Constants.sol/constants.Constants.md | 2 +- .../library.EnumerableSet.md | 2 +- .../library.LibAccessControl.md | 2 +- .../LibAppStorage.sol/contract.Modifiers.md | 2 +- .../library.LibAppStorage.md | 2 +- .../LibAppStorage.sol/struct.AppStorage.md | 2 +- .../library.LibBondingCurve.md | 2 +- .../libraries/LibChef.sol/library.LibChef.md | 2 +- .../library.LibCollectableDust.md | 2 +- .../library.LibCreditClock.md | 123 ++++++++++++++++++ .../library.LibCreditNftManager.md | 2 +- ...ibrary.LibCreditNftRedemptionCalculator.md | 2 +- .../library.LibCreditRedemptionCalculator.md | 2 +- .../library.LibCurveDollarIncentive.md | 2 +- .../error.InitializationFunctionReverted.md | 2 +- .../LibDiamond.sol/library.LibDiamond.md | 2 +- .../library.LibDollarMintCalculator.md | 2 +- .../library.LibDollarMintExcess.md | 2 +- .../LibStaking.sol/library.LibStaking.md | 2 +- .../library.LibStakingFormulas.md | 2 +- .../library.LibTWAPOracle.md | 2 +- .../library.LibUbiquityPool.md | 2 +- .../docs/src/src/dollar/libraries/README.md | 1 + .../UintUtils.sol/library.UintUtils.md | 2 +- .../contract.MockCurveFactory.md | 2 +- .../mocks/MockERC20.sol/contract.MockERC20.md | 2 +- .../MockMetaPool.sol/contract.MockMetaPool.md | 2 +- .../MockShareV1.sol/contract.BondingShare.md | 2 +- .../contract.MockTWAPOracleDollar3pool.md | 2 +- .../DiamondInit.sol/contract.DiamondInit.md | 2 +- .../SafeAddArray.sol/library.SafeAddArray.md | 2 +- 95 files changed, 285 insertions(+), 92 deletions(-) create mode 100644 packages/contracts/docs/src/src/dollar/facets/CreditClockFacet.sol/contract.CreditClockFacet.md create mode 100644 packages/contracts/docs/src/src/dollar/libraries/LibCreditClock.sol/library.LibCreditClock.md diff --git a/packages/contracts/docs/book.toml b/packages/contracts/docs/book.toml index d1d902a2e..8cd34475e 100644 --- a/packages/contracts/docs/book.toml +++ b/packages/contracts/docs/book.toml @@ -3,10 +3,10 @@ src = "src" title = "" [output.html] -no-section-label = true -additional-js = ["solidity.min.js"] additional-css = ["book.css"] +additional-js = ["solidity.min.js"] git-repository-url = "https://github.com/ubiquity/ubiquity-dollar" +no-section-label = true [output.html.fold] enable = true diff --git a/packages/contracts/docs/src/SUMMARY.md b/packages/contracts/docs/src/SUMMARY.md index 83d7e4109..eaffe369e 100644 --- a/packages/contracts/docs/src/SUMMARY.md +++ b/packages/contracts/docs/src/SUMMARY.md @@ -5,7 +5,6 @@ - [❱ access](src/dollar/access/README.md) - [AccessControlInternal](src/dollar/access/AccessControlInternal.sol/abstract.AccessControlInternal.md) - [❱ core](src/dollar/core/README.md) - - [CreditClock](src/dollar/core/CreditClock.sol/contract.CreditClock.md) - [CreditNft](src/dollar/core/CreditNft.sol/contract.CreditNft.md) - [ERC1155Ubiquity](src/dollar/core/ERC1155Ubiquity.sol/abstract.ERC1155Ubiquity.md) - [ERC20Ubiquity](src/dollar/core/ERC20Ubiquity.sol/abstract.ERC20Ubiquity.md) @@ -18,6 +17,7 @@ - [BondingCurveFacet](src/dollar/facets/BondingCurveFacet.sol/contract.BondingCurveFacet.md) - [ChefFacet](src/dollar/facets/ChefFacet.sol/contract.ChefFacet.md) - [CollectableDustFacet](src/dollar/facets/CollectableDustFacet.sol/contract.CollectableDustFacet.md) + - [CreditClockFacet](src/dollar/facets/CreditClockFacet.sol/contract.CreditClockFacet.md) - [CreditNftManagerFacet](src/dollar/facets/CreditNftManagerFacet.sol/contract.CreditNftManagerFacet.md) - [CreditNftRedemptionCalculatorFacet](src/dollar/facets/CreditNftRedemptionCalculatorFacet.sol/contract.CreditNftRedemptionCalculatorFacet.md) - [CreditRedemptionCalculatorFacet](src/dollar/facets/CreditRedemptionCalculatorFacet.sol/contract.CreditRedemptionCalculatorFacet.md) @@ -74,6 +74,7 @@ - [LibBondingCurve](src/dollar/libraries/LibBondingCurve.sol/library.LibBondingCurve.md) - [LibChef](src/dollar/libraries/LibChef.sol/library.LibChef.md) - [LibCollectableDust](src/dollar/libraries/LibCollectableDust.sol/library.LibCollectableDust.md) + - [LibCreditClock](src/dollar/libraries/LibCreditClock.sol/library.LibCreditClock.md) - [LibCreditNftManager](src/dollar/libraries/LibCreditNftManager.sol/library.LibCreditNftManager.md) - [LibCreditNftRedemptionCalculator](src/dollar/libraries/LibCreditNftRedemptionCalculator.sol/library.LibCreditNftRedemptionCalculator.md) - [LibCreditRedemptionCalculator](src/dollar/libraries/LibCreditRedemptionCalculator.sol/library.LibCreditRedemptionCalculator.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 da34ad8b7..ee8b816b9 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/Diamond.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 3fb956234..d9e99a274 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/Diamond.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/Diamond.sol) Struct used for `Diamond` constructor args diff --git a/packages/contracts/docs/src/src/dollar/DirectGovernanceFarmer.sol/contract.DirectGovernanceFarmer.md b/packages/contracts/docs/src/src/dollar/DirectGovernanceFarmer.sol/contract.DirectGovernanceFarmer.md index 2dc73fce0..ce5b401ff 100644 --- a/packages/contracts/docs/src/src/dollar/DirectGovernanceFarmer.sol/contract.DirectGovernanceFarmer.md +++ b/packages/contracts/docs/src/src/dollar/DirectGovernanceFarmer.sol/contract.DirectGovernanceFarmer.md @@ -1,5 +1,5 @@ # DirectGovernanceFarmer -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/DirectGovernanceFarmer.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/DirectGovernanceFarmer.sol) **Inherits:** ReentrancyGuard 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 96d3edf8a..988cfc68e 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/access/AccessControlInternal.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 97fcfa1b5..4768412a3 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/core/CreditNft.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 26e2d8220..8fde16eeb 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/core/ERC1155Ubiquity.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 9054f74a1..cec68072e 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/core/ERC20Ubiquity.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/core/ERC20Ubiquity.sol) **Inherits:** Initializable, UUPSUpgradeable, ERC20Upgradeable, ERC20PermitUpgradeable, ERC20PausableUpgradeable diff --git a/packages/contracts/docs/src/src/dollar/core/README.md b/packages/contracts/docs/src/src/dollar/core/README.md index 53f8a4659..c6373b440 100644 --- a/packages/contracts/docs/src/src/dollar/core/README.md +++ b/packages/contracts/docs/src/src/dollar/core/README.md @@ -1,7 +1,6 @@ # Contents -- [CreditClock](CreditClock.sol/contract.CreditClock.md) - [CreditNft](CreditNft.sol/contract.CreditNft.md) - [ERC1155Ubiquity](ERC1155Ubiquity.sol/abstract.ERC1155Ubiquity.md) - [ERC20Ubiquity](ERC20Ubiquity.sol/abstract.ERC20Ubiquity.md) 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 2cacd8c62..732f92da7 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/core/StakingShare.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 3b2fa9ebf..93b0665cd 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/core/UbiquityCreditToken.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 2119e85ac..26eac624e 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/core/UbiquityDollarToken.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 0ca8aac7b..6a3407fdd 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/core/UbiquityGovernanceToken.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 00683b7da..bd725a7d9 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/facets/AccessControlFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 3c6fe3685..41347d70b 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/facets/BondingCurveFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 6ae1868b4..2367d8b31 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/facets/ChefFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 3937303fc..fb1045069 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/facets/CollectableDustFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 new file mode 100644 index 000000000..8d442a809 --- /dev/null +++ b/packages/contracts/docs/src/src/dollar/facets/CreditClockFacet.sol/contract.CreditClockFacet.md @@ -0,0 +1,68 @@ +# CreditClockFacet +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/facets/CreditClockFacet.sol) + +**Inherits:** +[Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md) + +CreditClock Facet + + +## Functions +### setManager + +Updates the manager address + + +```solidity +function setManager(address _manager) external onlyAdmin; +``` +**Parameters** + +|Name|Type|Description| +|----|----|-----------| +|`_manager`|`address`|New manager address| + + +### getManager + +Returns the manager address + + +```solidity +function getManager() external view returns (address); +``` +**Returns** + +|Name|Type|Description| +|----|----|-----------| +|``|`address`|Manager address| + + +### setRatePerBlock + +Sets rate to apply from this block onward + + +```solidity +function setRatePerBlock(bytes16 _ratePerBlock) external onlyAdmin; +``` +**Parameters** + +|Name|Type|Description| +|----|----|-----------| +|`_ratePerBlock`|`bytes16`|ABDKMathQuad new rate per block to apply from this block onward| + + +### getRate + + +```solidity +function getRate(uint256 blockNumber) external view; +``` +**Parameters** + +|Name|Type|Description| +|----|----|-----------| +|`blockNumber`|`uint256`|Block number to get the rate for. 0 for current block.| + + 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 b8319e47c..8a1d107ae 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/facets/CreditNftManagerFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 bd2ac711a..7d6fd9757 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/facets/CreditNftRedemptionCalculatorFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 864b4554a..825fbebc5 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/facets/CreditRedemptionCalculatorFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 60bd7f2ca..c520e15c1 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/facets/CurveDollarIncentiveFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 7d703b902..1652426de 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/facets/DiamondCutFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 39c090168..bf6691de2 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/facets/DiamondLoupeFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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/DollarMintCalculatorFacet.sol/contract.DollarMintCalculatorFacet.md b/packages/contracts/docs/src/src/dollar/facets/DollarMintCalculatorFacet.sol/contract.DollarMintCalculatorFacet.md index 670354a2d..ef8312e92 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/facets/DollarMintCalculatorFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 5110f1b58..e9c8d4cce 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/facets/DollarMintExcessFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 702451cc2..4b337d806 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/facets/ManagerFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/facets/ManagerFacet.sol) **Inherits:** [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md) diff --git a/packages/contracts/docs/src/src/dollar/facets/OwnershipFacet.sol/contract.OwnershipFacet.md b/packages/contracts/docs/src/src/dollar/facets/OwnershipFacet.sol/contract.OwnershipFacet.md index e42fdacd6..6bf0adf11 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/facets/OwnershipFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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/README.md b/packages/contracts/docs/src/src/dollar/facets/README.md index 9c77f2ef3..9cf3b1f6e 100644 --- a/packages/contracts/docs/src/src/dollar/facets/README.md +++ b/packages/contracts/docs/src/src/dollar/facets/README.md @@ -5,6 +5,7 @@ - [BondingCurveFacet](BondingCurveFacet.sol/contract.BondingCurveFacet.md) - [ChefFacet](ChefFacet.sol/contract.ChefFacet.md) - [CollectableDustFacet](CollectableDustFacet.sol/contract.CollectableDustFacet.md) +- [CreditClockFacet](CreditClockFacet.sol/contract.CreditClockFacet.md) - [CreditNftManagerFacet](CreditNftManagerFacet.sol/contract.CreditNftManagerFacet.md) - [CreditNftRedemptionCalculatorFacet](CreditNftRedemptionCalculatorFacet.sol/contract.CreditNftRedemptionCalculatorFacet.md) - [CreditRedemptionCalculatorFacet](CreditRedemptionCalculatorFacet.sol/contract.CreditRedemptionCalculatorFacet.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 0adfb1bff..07b069636 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/facets/StakingFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 57c0222ca..7982a0526 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/facets/StakingFormulasFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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/TWAPOracleDollar3poolFacet.sol/contract.TWAPOracleDollar3poolFacet.md b/packages/contracts/docs/src/src/dollar/facets/TWAPOracleDollar3poolFacet.sol/contract.TWAPOracleDollar3poolFacet.md index ff837152c..433b4cad8 100644 --- a/packages/contracts/docs/src/src/dollar/facets/TWAPOracleDollar3poolFacet.sol/contract.TWAPOracleDollar3poolFacet.md +++ b/packages/contracts/docs/src/src/dollar/facets/TWAPOracleDollar3poolFacet.sol/contract.TWAPOracleDollar3poolFacet.md @@ -1,5 +1,5 @@ # TWAPOracleDollar3poolFacet -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/facets/TWAPOracleDollar3poolFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/facets/TWAPOracleDollar3poolFacet.sol) **Inherits:** [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md), [ITWAPOracleDollar3pool](/src/dollar/interfaces/ITWAPOracleDollar3pool.sol/interface.ITWAPOracleDollar3pool.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 c6ef402d9..de1ef44ee 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/facets/UbiquityPoolFacet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/facets/UbiquityPoolFacet.sol) **Inherits:** [Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md), [IUbiquityPool](/src/dollar/interfaces/IUbiquityPool.sol/interface.IUbiquityPool.md) diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IAccessControl.sol/interface.IAccessControl.md b/packages/contracts/docs/src/src/dollar/interfaces/IAccessControl.sol/interface.IAccessControl.md index d720c5308..2eeb2b64e 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IAccessControl.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 a9f9735d4..c94af2c31 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IBondingCurve.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 3e0807783..c75181c59 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/ICreditNft.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 8004f6f68..97e7bd0bf 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/ICreditNftManager.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 5d0fabd36..716e821b2 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/ICreditNftRedemptionCalculator.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 aac8db772..8b5dafbcd 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/ICreditRedemptionCalculator.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 9c7363e65..6e145393f 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/ICurveFactory.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/interfaces/ICurveFactory.sol) Curve Factory interface 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 046bb8392..f0b219ac4 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IDepositZap.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 da1d5f681..49b4b8902 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IDiamondCut.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 debc54073..2257ae27f 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IDiamondLoupe.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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/IDollarMintCalculator.sol/interface.IDollarMintCalculator.md b/packages/contracts/docs/src/src/dollar/interfaces/IDollarMintCalculator.sol/interface.IDollarMintCalculator.md index fc198795f..4d34b5e21 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IDollarMintCalculator.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 ad0e51dfd..2d2ac83ec 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IDollarMintExcess.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 a113c9f4d..72eec3e03 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IERC1155Ubiquity.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 d928d4111..587f75665 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IERC173.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 777fa372e..a923506a0 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IERC20Ubiquity.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/interfaces/IERC20Ubiquity.sol) **Inherits:** IERC20, IERC20Permit diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IIncentive.sol/interface.IIncentive.md b/packages/contracts/docs/src/src/dollar/interfaces/IIncentive.sol/interface.IIncentive.md index c20d9b728..900a2bb21 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IIncentive.sol/interface.IIncentive.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IIncentive.sol/interface.IIncentive.md @@ -1,5 +1,5 @@ # IIncentive -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IIncentive.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/interfaces/IIncentive.sol) Incentive contract interface diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IJar.sol/interface.IJar.md b/packages/contracts/docs/src/src/dollar/interfaces/IJar.sol/interface.IJar.md index 323e71b98..50e724251 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IJar.sol/interface.IJar.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IJar.sol/interface.IJar.md @@ -1,5 +1,5 @@ # IJar -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IJar.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/interfaces/IJar.sol) **Inherits:** IERC20 diff --git a/packages/contracts/docs/src/src/dollar/interfaces/IMetaPool.sol/interface.IMetaPool.md b/packages/contracts/docs/src/src/dollar/interfaces/IMetaPool.sol/interface.IMetaPool.md index b4883b33c..228d903f4 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/IMetaPool.sol/interface.IMetaPool.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/IMetaPool.sol/interface.IMetaPool.md @@ -1,5 +1,5 @@ # IMetaPool -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IMetaPool.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/interfaces/IMetaPool.sol) Curve MetaPool interface 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 b5ef1347a..6c166c560 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IStableSwap3Pool.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 056eb8d75..34dc42442 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IStaking.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 380d77d30..16aef596f 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IStakingShare.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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/ITWAPOracleDollar3pool.sol/interface.ITWAPOracleDollar3pool.md b/packages/contracts/docs/src/src/dollar/interfaces/ITWAPOracleDollar3pool.sol/interface.ITWAPOracleDollar3pool.md index 11b0a5adc..738c4f130 100644 --- a/packages/contracts/docs/src/src/dollar/interfaces/ITWAPOracleDollar3pool.sol/interface.ITWAPOracleDollar3pool.md +++ b/packages/contracts/docs/src/src/dollar/interfaces/ITWAPOracleDollar3pool.sol/interface.ITWAPOracleDollar3pool.md @@ -1,5 +1,5 @@ # ITWAPOracleDollar3pool -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/ITWAPOracleDollar3pool.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/interfaces/ITWAPOracleDollar3pool.sol) TWAP oracle interface for Curve MetaPool 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 d969879ed..a0cb32946 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IUbiquityChef.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 7c9d06571..949ccd41d 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IUbiquityDollarManager.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 fc4512686..69e4ab228 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IUbiquityDollarToken.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 3d2fcdeaf..ad1d276ef 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IUbiquityFormulas.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 0d9abb24b..ab7a08f2c 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IUbiquityGovernance.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 59c752a7e..2c6e248ed 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/IUbiquityPool.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/interfaces/IUbiquityPool.sol) Ubiquity pool interface 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 5e905e793..8997444e3 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/interfaces/utils/ICollectableDust.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 5189972bd..7e46d460b 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/AddressUtils.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 6c14b69db..d003974de 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/Constants.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/libraries/Constants.sol) ### DEFAULT_ADMIN_ROLE *Default admin role name* diff --git a/packages/contracts/docs/src/src/dollar/libraries/EnumerableSet.sol/library.EnumerableSet.md b/packages/contracts/docs/src/src/dollar/libraries/EnumerableSet.sol/library.EnumerableSet.md index a525be8f6..d20eeb571 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/EnumerableSet.sol/library.EnumerableSet.md +++ b/packages/contracts/docs/src/src/dollar/libraries/EnumerableSet.sol/library.EnumerableSet.md @@ -1,5 +1,5 @@ # EnumerableSet -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/EnumerableSet.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/libraries/EnumerableSet.sol) Set implementation with enumeration functions 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 c51005afc..f2d87164c 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/LibAccessControl.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 46138a36a..247916ed9 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/LibAppStorage.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 c5fcb9376..12b425a63 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/LibAppStorage.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 97fe597e0..7b3dcd743 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/LibAppStorage.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/libraries/LibAppStorage.sol) Shared struct used as a storage in the `LibAppStorage` library diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibBondingCurve.sol/library.LibBondingCurve.md b/packages/contracts/docs/src/src/dollar/libraries/LibBondingCurve.sol/library.LibBondingCurve.md index 6702eeb63..0dd2338c5 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/LibBondingCurve.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 6bbe25b78..a41a8b8f5 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/LibChef.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 8fe7fc74d..f2086d4c5 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/LibCollectableDust.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 new file mode 100644 index 000000000..29d2db33f --- /dev/null +++ b/packages/contracts/docs/src/src/dollar/libraries/LibCreditClock.sol/library.LibCreditClock.md @@ -0,0 +1,123 @@ +# LibCreditClock +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/libraries/LibCreditClock.sol) + +Library for Credit Clock Facet + + +## State Variables +### CREDIT_CLOCK_STORAGE_POSITION +Storage slot used to store data for this library + + +```solidity +bytes32 constant CREDIT_CLOCK_STORAGE_POSITION = + bytes32(uint256(keccak256("ubiquity.contracts.credit.clock.storage")) - 1); +``` + + +## Functions +### creditClockStorage + +Returns struct used as a storage for this library + + +```solidity +function creditClockStorage() internal pure returns (CreditClockData storage data); +``` +**Returns** + +|Name|Type|Description| +|----|----|-----------| +|`data`|`CreditClockData`|Struct used as a storage| + + +### setManager + +Updates the manager address + + +```solidity +function setManager(address _manager) internal; +``` +**Parameters** + +|Name|Type|Description| +|----|----|-----------| +|`_manager`|`address`|New manager address| + + +### getManager + +Returns the manager address + + +```solidity +function getManager() internal view returns (address); +``` +**Returns** + +|Name|Type|Description| +|----|----|-----------| +|``|`address`|Manager address| + + +### setRatePerBlock + +Sets rate to apply from this block onward + + +```solidity +function setRatePerBlock(bytes16 _ratePerBlock) internal; +``` +**Parameters** + +|Name|Type|Description| +|----|----|-----------| +|`_ratePerBlock`|`bytes16`|ABDKMathQuad new rate per block to apply from this block onward| + + +### getRate + +Calculates `rateStartValue * (1 / ((1 + ratePerBlock)^blockNumber - rateStartBlock)))` + + +```solidity +function getRate(uint256 blockNumber) internal view returns (bytes16 rate); +``` +**Parameters** + +|Name|Type|Description| +|----|----|-----------| +|`blockNumber`|`uint256`|Block number to get the rate for. 0 for current block.| + +**Returns** + +|Name|Type|Description| +|----|----|-----------| +|`rate`|`bytes16`|ABDKMathQuad rate calculated for the block number| + + +## Events +### SetRatePerBlock +Emitted when depreciation rate per block is updated + + +```solidity +event SetRatePerBlock(uint256 rateStartBlock, bytes16 rateStartValue, bytes16 ratePerBlock); +``` + +## Structs +### CreditClockData +Struct used as a storage for the current library + + +```solidity +struct CreditClockData { + IAccessControl accessControl; + uint256 rateStartBlock; + bytes16 rateStartValue; + bytes16 ratePerBlock; + bytes16 one; +} +``` + 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 baea92487..daf49c6ce 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/LibCreditNftManager.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 71962c8f4..fc8777c56 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/LibCreditNftRedemptionCalculator.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 d3fb47a4a..e0059dd08 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/LibCreditRedemptionCalculator.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 37dfc80e3..e6b87e518 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/LibCurveDollarIncentive.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 75ba1031a..f5ea6d4ea 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/LibDiamond.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 65d9628b6..613525bab 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/LibDiamond.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/libraries/LibDiamond.sol) Library used for diamond facets and selector modifications 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 35b2d003f..24a6c4994 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/LibDollarMintCalculator.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 070c25a77..d67dec8f3 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/LibDollarMintExcess.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 727e2b0e9..057740a18 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/LibStaking.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 a0a6d9246..01a68ad37 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/LibStakingFormulas.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/libraries/LibStakingFormulas.sol) Library for staking formulas diff --git a/packages/contracts/docs/src/src/dollar/libraries/LibTWAPOracle.sol/library.LibTWAPOracle.md b/packages/contracts/docs/src/src/dollar/libraries/LibTWAPOracle.sol/library.LibTWAPOracle.md index 5c20feb99..2085ef7b0 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/LibTWAPOracle.sol/library.LibTWAPOracle.md +++ b/packages/contracts/docs/src/src/dollar/libraries/LibTWAPOracle.sol/library.LibTWAPOracle.md @@ -1,5 +1,5 @@ # LibTWAPOracle -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/LibTWAPOracle.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/libraries/LibTWAPOracle.sol) Library used for Curve TWAP oracle in the Dollar MetaPool 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 100477565..7385db723 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/LibUbiquityPool.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/libraries/LibUbiquityPool.sol) Ubiquity pool library diff --git a/packages/contracts/docs/src/src/dollar/libraries/README.md b/packages/contracts/docs/src/src/dollar/libraries/README.md index 5c12e8fbb..018a10498 100644 --- a/packages/contracts/docs/src/src/dollar/libraries/README.md +++ b/packages/contracts/docs/src/src/dollar/libraries/README.md @@ -11,6 +11,7 @@ - [LibBondingCurve](LibBondingCurve.sol/library.LibBondingCurve.md) - [LibChef](LibChef.sol/library.LibChef.md) - [LibCollectableDust](LibCollectableDust.sol/library.LibCollectableDust.md) +- [LibCreditClock](LibCreditClock.sol/library.LibCreditClock.md) - [LibCreditNftManager](LibCreditNftManager.sol/library.LibCreditNftManager.md) - [LibCreditNftRedemptionCalculator](LibCreditNftRedemptionCalculator.sol/library.LibCreditNftRedemptionCalculator.md) - [LibCreditRedemptionCalculator](LibCreditRedemptionCalculator.sol/library.LibCreditRedemptionCalculator.md) 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 80504ed79..b072f05e0 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/libraries/UintUtils.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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/MockCurveFactory.sol/contract.MockCurveFactory.md b/packages/contracts/docs/src/src/dollar/mocks/MockCurveFactory.sol/contract.MockCurveFactory.md index e8656d4f8..9e9b77fb6 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/mocks/MockCurveFactory.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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/MockERC20.sol/contract.MockERC20.md b/packages/contracts/docs/src/src/dollar/mocks/MockERC20.sol/contract.MockERC20.md index fe1a9cab0..562148e41 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/mocks/MockERC20.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/mocks/MockERC20.sol) **Inherits:** ERC20 diff --git a/packages/contracts/docs/src/src/dollar/mocks/MockMetaPool.sol/contract.MockMetaPool.md b/packages/contracts/docs/src/src/dollar/mocks/MockMetaPool.sol/contract.MockMetaPool.md index 63b8cd02a..d8340c688 100644 --- a/packages/contracts/docs/src/src/dollar/mocks/MockMetaPool.sol/contract.MockMetaPool.md +++ b/packages/contracts/docs/src/src/dollar/mocks/MockMetaPool.sol/contract.MockMetaPool.md @@ -1,5 +1,5 @@ # MockMetaPool -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/mocks/MockMetaPool.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/mocks/MockMetaPool.sol) **Inherits:** [MockERC20](/src/dollar/mocks/MockERC20.sol/contract.MockERC20.md) 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 1bb252d33..a9d9d8145 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/mocks/MockShareV1.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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/MockTWAPOracleDollar3pool.sol/contract.MockTWAPOracleDollar3pool.md b/packages/contracts/docs/src/src/dollar/mocks/MockTWAPOracleDollar3pool.sol/contract.MockTWAPOracleDollar3pool.md index b90c03a78..32270fd7e 100644 --- a/packages/contracts/docs/src/src/dollar/mocks/MockTWAPOracleDollar3pool.sol/contract.MockTWAPOracleDollar3pool.md +++ b/packages/contracts/docs/src/src/dollar/mocks/MockTWAPOracleDollar3pool.sol/contract.MockTWAPOracleDollar3pool.md @@ -1,5 +1,5 @@ # MockTWAPOracleDollar3pool -[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/mocks/MockTWAPOracleDollar3pool.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/mocks/MockTWAPOracleDollar3pool.sol) ## State Variables 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 0acbd9872..c4e11e4a0 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/upgradeInitializers/DiamondInit.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/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 b3ff086e5..ea69b13dc 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/edf5f533467baa5ab7defe2b4b5180fa47724cdb/src/dollar/utils/SafeAddArray.sol) +[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/8e774eecb089180805d9583f0e7776529582e747/src/dollar/utils/SafeAddArray.sol) Wrappers over Solidity's array push operations with added check