docs: auto generate NATSPEC docs

ubiquity · Oct 24, 2023 · af8370b · af8370b
1 parent 8e774ee
commit af8370b
Show file tree

Hide file tree

Showing 95 changed files with 285 additions and 92 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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/...cs/src/src/dollar/DirectGovernanceFarmer.sol/contract.DirectGovernanceFarmer.md b/...cs/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/...c/src/dollar/access/AccessControlInternal.sol/abstract.AccessControlInternal.md b/...c/src/dollar/access/AccessControlInternal.sol/abstract.AccessControlInternal.md
@@ -1,5 +1,5 @@
 # AccessControlInternal
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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
@@ -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/...tracts/docs/src/src/dollar/core/ERC1155Ubiquity.sol/abstract.ERC1155Ubiquity.md b/...tracts/docs/src/src/dollar/core/ERC1155Ubiquity.sol/abstract.ERC1155Ubiquity.md
@@ -1,5 +1,5 @@
 # ERC1155Ubiquity
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/.../contracts/docs/src/src/dollar/core/ERC20Ubiquity.sol/abstract.ERC20Ubiquity.md b/.../contracts/docs/src/src/dollar/core/ERC20Ubiquity.sol/abstract.ERC20Ubiquity.md
@@ -1,5 +1,5 @@
 # ERC20Ubiquity
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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
@@ -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/...es/contracts/docs/src/src/dollar/core/StakingShare.sol/contract.StakingShare.md b/...es/contracts/docs/src/src/dollar/core/StakingShare.sol/contract.StakingShare.md
@@ -1,5 +1,5 @@
 # StakingShare
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/...ocs/src/src/dollar/core/UbiquityCreditToken.sol/contract.UbiquityCreditToken.md b/...ocs/src/src/dollar/core/UbiquityCreditToken.sol/contract.UbiquityCreditToken.md
@@ -1,5 +1,5 @@
 # UbiquityCreditToken
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/...ocs/src/src/dollar/core/UbiquityDollarToken.sol/contract.UbiquityDollarToken.md b/...ocs/src/src/dollar/core/UbiquityDollarToken.sol/contract.UbiquityDollarToken.md
@@ -1,5 +1,5 @@
 # UbiquityDollarToken
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/...src/dollar/core/UbiquityGovernanceToken.sol/contract.UbiquityGovernanceToken.md b/...src/dollar/core/UbiquityGovernanceToken.sol/contract.UbiquityGovernanceToken.md
@@ -1,5 +1,5 @@
 # UbiquityGovernanceToken
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/...ocs/src/src/dollar/facets/AccessControlFacet.sol/contract.AccessControlFacet.md b/...ocs/src/src/dollar/facets/AccessControlFacet.sol/contract.AccessControlFacet.md
@@ -1,5 +1,5 @@
 # AccessControlFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/.../docs/src/src/dollar/facets/BondingCurveFacet.sol/contract.BondingCurveFacet.md b/.../docs/src/src/dollar/facets/BondingCurveFacet.sol/contract.BondingCurveFacet.md
@@ -1,5 +1,5 @@
 # BondingCurveFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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
@@ -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/...src/src/dollar/facets/CollectableDustFacet.sol/contract.CollectableDustFacet.md b/...src/src/dollar/facets/CollectableDustFacet.sol/contract.CollectableDustFacet.md
@@ -1,5 +1,5 @@
 # CollectableDustFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/...ts/docs/src/src/dollar/facets/CreditClockFacet.sol/contract.CreditClockFacet.md b/...ts/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|
+|----|----|-----------|
+|`<none>`|`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/...c/src/dollar/facets/CreditNftManagerFacet.sol/contract.CreditNftManagerFacet.md b/...c/src/dollar/facets/CreditNftManagerFacet.sol/contract.CreditNftManagerFacet.md
@@ -1,5 +1,5 @@
 # CreditNftManagerFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/...NftRedemptionCalculatorFacet.sol/contract.CreditNftRedemptionCalculatorFacet.md b/...NftRedemptionCalculatorFacet.sol/contract.CreditNftRedemptionCalculatorFacet.md
@@ -1,5 +1,5 @@
 # CreditNftRedemptionCalculatorFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/...CreditRedemptionCalculatorFacet.sol/contract.CreditRedemptionCalculatorFacet.md b/...CreditRedemptionCalculatorFacet.sol/contract.CreditRedemptionCalculatorFacet.md
@@ -1,5 +1,5 @@
 # CreditRedemptionCalculatorFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/...llar/facets/CurveDollarIncentiveFacet.sol/contract.CurveDollarIncentiveFacet.md b/...llar/facets/CurveDollarIncentiveFacet.sol/contract.CurveDollarIncentiveFacet.md
@@ -1,5 +1,5 @@
 # CurveDollarIncentiveFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/...acts/docs/src/src/dollar/facets/DiamondCutFacet.sol/contract.DiamondCutFacet.md b/...acts/docs/src/src/dollar/facets/DiamondCutFacet.sol/contract.DiamondCutFacet.md
@@ -1,5 +1,5 @@
 # DiamondCutFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/.../docs/src/src/dollar/facets/DiamondLoupeFacet.sol/contract.DiamondLoupeFacet.md b/.../docs/src/src/dollar/facets/DiamondLoupeFacet.sol/contract.DiamondLoupeFacet.md
@@ -1,5 +1,5 @@
 # DiamondLoupeFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/...llar/facets/DollarMintCalculatorFacet.sol/contract.DollarMintCalculatorFacet.md b/...llar/facets/DollarMintCalculatorFacet.sol/contract.DollarMintCalculatorFacet.md
@@ -1,5 +1,5 @@
 # DollarMintCalculatorFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/...c/src/dollar/facets/DollarMintExcessFacet.sol/contract.DollarMintExcessFacet.md b/...c/src/dollar/facets/DollarMintExcessFacet.sol/contract.DollarMintExcessFacet.md
@@ -1,5 +1,5 @@
 # DollarMintExcessFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/.../contracts/docs/src/src/dollar/facets/ManagerFacet.sol/contract.ManagerFacet.md b/.../contracts/docs/src/src/dollar/facets/ManagerFacet.sol/contract.ManagerFacet.md
@@ -1,5 +1,5 @@
 # ManagerFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/...tracts/docs/src/src/dollar/facets/OwnershipFacet.sol/contract.OwnershipFacet.md b/...tracts/docs/src/src/dollar/facets/OwnershipFacet.sol/contract.OwnershipFacet.md
@@ -1,5 +1,5 @@
 # OwnershipFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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
@@ -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/.../contracts/docs/src/src/dollar/facets/StakingFacet.sol/contract.StakingFacet.md b/.../contracts/docs/src/src/dollar/facets/StakingFacet.sol/contract.StakingFacet.md
@@ -1,5 +1,5 @@
 # StakingFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/...src/src/dollar/facets/StakingFormulasFacet.sol/contract.StakingFormulasFacet.md b/...src/src/dollar/facets/StakingFormulasFacet.sol/contract.StakingFormulasFacet.md
@@ -1,5 +1,5 @@
 # StakingFormulasFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/...ar/facets/TWAPOracleDollar3poolFacet.sol/contract.TWAPOracleDollar3poolFacet.md b/...ar/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/.../docs/src/src/dollar/facets/UbiquityPoolFacet.sol/contract.UbiquityPoolFacet.md b/.../docs/src/src/dollar/facets/UbiquityPoolFacet.sol/contract.UbiquityPoolFacet.md
@@ -1,5 +1,5 @@
 # UbiquityPoolFacet
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/...s/docs/src/src/dollar/interfaces/IAccessControl.sol/interface.IAccessControl.md b/...s/docs/src/src/dollar/interfaces/IAccessControl.sol/interface.IAccessControl.md
@@ -1,5 +1,5 @@
 # IAccessControl
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/...cts/docs/src/src/dollar/interfaces/IBondingCurve.sol/interface.IBondingCurve.md b/...cts/docs/src/src/dollar/interfaces/IBondingCurve.sol/interface.IBondingCurve.md
@@ -1,5 +1,5 @@
 # IBondingCurve
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/...contracts/docs/src/src/dollar/interfaces/ICreditNft.sol/interface.ICreditNft.md b/...contracts/docs/src/src/dollar/interfaces/ICreditNft.sol/interface.ICreditNft.md
@@ -1,5 +1,5 @@
 # ICreditNft
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/.../src/src/dollar/interfaces/ICreditNftManager.sol/interface.ICreditNftManager.md b/.../src/src/dollar/interfaces/ICreditNftManager.sol/interface.ICreditNftManager.md
@@ -1,5 +1,5 @@
 # ICreditNftManager
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/.../ICreditNftRedemptionCalculator.sol/interface.ICreditNftRedemptionCalculator.md b/.../ICreditNftRedemptionCalculator.sol/interface.ICreditNftRedemptionCalculator.md
@@ -1,5 +1,5 @@
 # ICreditNftRedemptionCalculator
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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/...rfaces/ICreditRedemptionCalculator.sol/interface.ICreditRedemptionCalculator.md b/...rfaces/ICreditRedemptionCalculator.sol/interface.ICreditRedemptionCalculator.md
@@ -1,5 +1,5 @@
 # ICreditRedemptionCalculator
-[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/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