Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: fix broken links in docs #738

Merged
merged 1 commit into from
Jul 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/contracts/docs/book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title = ""
no-section-label = true
additional-js = ["solidity.min.js"]
additional-css = ["book.css"]
git-repository-url = "https://github.com/rndquu/ubiquity-dollar"
git-repository-url = "https://github.com/ubiquity/ubiquity-dollar"

[output.html.fold]
enable = true
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Diamond
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/Diamond.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/Diamond.sol)

Contract that implements diamond proxy pattern

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# DiamondArgs
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/Diamond.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/Diamond.sol)

Struct used for `Diamond` constructor args

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# DirectGovernanceFarmer
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/DirectGovernanceFarmer.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/DirectGovernanceFarmer.sol)

**Inherits:**
ReentrancyGuard
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AccessControlInternal
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/access/AccessControlInternal.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/access/AccessControlInternal.sol)

Role-based access control system

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# CreditClock
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/core/CreditClock.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/core/CreditClock.sol)

CreditClock contract

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# CreditNft
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/core/CreditNft.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/core/CreditNft.sol)

**Inherits:**
[ERC1155Ubiquity](/src/dollar/core/ERC1155Ubiquity.sol/contract.ERC1155Ubiquity.md), [ICreditNft](/src/dollar/interfaces/ICreditNft.sol/interface.ICreditNft.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ERC1155Ubiquity
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/core/ERC1155Ubiquity.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/core/ERC1155Ubiquity.sol)

**Inherits:**
ERC1155, ERC1155Burnable, ERC1155Pausable
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ERC20Ubiquity
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/core/ERC20Ubiquity.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/core/ERC20Ubiquity.sol)

**Inherits:**
ERC20Permit, ERC20Pausable, [IERC20Ubiquity](/src/dollar/interfaces/IERC20Ubiquity.sol/interface.IERC20Ubiquity.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# StakingShare
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/core/StakingShare.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/core/StakingShare.sol)

**Inherits:**
[ERC1155Ubiquity](/src/dollar/core/ERC1155Ubiquity.sol/contract.ERC1155Ubiquity.md), ERC1155URIStorage
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# UbiquityCreditToken
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/core/UbiquityCreditToken.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/core/UbiquityCreditToken.sol)

**Inherits:**
[ERC20Ubiquity](/src/dollar/core/ERC20Ubiquity.sol/abstract.ERC20Ubiquity.md)
Expand Down Expand Up @@ -43,9 +43,9 @@ modifier onlyCreditBurner();

### raiseCapital

Raises capital in the form of Ubiquity Credit Token (only redeemable when Ubiquity Dollar > 1$)
Raises capital in the form of Ubiquity Credit Token

*You should be minter to call this function*
*CREDIT_TOKEN_MINTER_ROLE access control role is required to call this function*


```solidity
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# UbiquityDollarToken
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/core/UbiquityDollarToken.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/core/UbiquityDollarToken.sol)

**Inherits:**
[ERC20Ubiquity](/src/dollar/core/ERC20Ubiquity.sol/abstract.ERC20Ubiquity.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# UbiquityGovernanceToken
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/core/UbiquityGovernanceToken.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/core/UbiquityGovernanceToken.sol)

**Inherits:**
[ERC20Ubiquity](/src/dollar/core/ERC20Ubiquity.sol/abstract.ERC20Ubiquity.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AccessControlFacet
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/facets/AccessControlFacet.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/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)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# BondingCurveFacet
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/facets/BondingCurveFacet.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/facets/BondingCurveFacet.sol)

**Inherits:**
[Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md), [IBondingCurve](/src/dollar/interfaces/IBondingCurve.sol/interface.IBondingCurve.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ChefFacet
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/facets/ChefFacet.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/facets/ChefFacet.sol)

**Inherits:**
[Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# CollectableDustFacet
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/facets/CollectableDustFacet.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/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)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# CreditNftManagerFacet
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/facets/CreditNftManagerFacet.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/facets/CreditNftManagerFacet.sol)

**Inherits:**
[Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# CreditNftRedemptionCalculatorFacet
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/facets/CreditNftRedemptionCalculatorFacet.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/facets/CreditNftRedemptionCalculatorFacet.sol)

**Inherits:**
[ICreditNftRedemptionCalculator](/src/dollar/interfaces/ICreditNftRedemptionCalculator.sol/interface.ICreditNftRedemptionCalculator.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# CreditRedemptionCalculatorFacet
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/facets/CreditRedemptionCalculatorFacet.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/facets/CreditRedemptionCalculatorFacet.sol)

**Inherits:**
[Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md), [ICreditRedemptionCalculator](/src/dollar/interfaces/ICreditRedemptionCalculator.sol/interface.ICreditRedemptionCalculator.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# CurveDollarIncentiveFacet
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/facets/CurveDollarIncentiveFacet.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/facets/CurveDollarIncentiveFacet.sol)

**Inherits:**
[Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# DiamondCutFacet
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/facets/DiamondCutFacet.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/facets/DiamondCutFacet.sol)

**Inherits:**
[IDiamondCut](/src/dollar/interfaces/IDiamondCut.sol/interface.IDiamondCut.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# DiamondLoupeFacet
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/facets/DiamondLoupeFacet.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/facets/DiamondLoupeFacet.sol)

**Inherits:**
[IDiamondLoupe](/src/dollar/interfaces/IDiamondLoupe.sol/interface.IDiamondLoupe.md), IERC165
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# DollarMintCalculatorFacet
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/facets/DollarMintCalculatorFacet.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/facets/DollarMintCalculatorFacet.sol)

**Inherits:**
[IDollarMintCalculator](/src/dollar/interfaces/IDollarMintCalculator.sol/interface.IDollarMintCalculator.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# DollarMintExcessFacet
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/facets/DollarMintExcessFacet.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/facets/DollarMintExcessFacet.sol)

**Inherits:**
[IDollarMintExcess](/src/dollar/interfaces/IDollarMintExcess.sol/interface.IDollarMintExcess.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ManagerFacet
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/facets/ManagerFacet.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/facets/ManagerFacet.sol)

**Inherits:**
[Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# OwnershipFacet
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/facets/OwnershipFacet.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/facets/OwnershipFacet.sol)

**Inherits:**
[IERC173](/src/dollar/interfaces/IERC173.sol/interface.IERC173.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# StakingFacet
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/facets/StakingFacet.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/facets/StakingFacet.sol)

**Inherits:**
[Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md), [IStaking](/src/dollar/interfaces/IStaking.sol/interface.IStaking.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# StakingFormulasFacet
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/facets/StakingFormulasFacet.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/facets/StakingFormulasFacet.sol)

**Inherits:**
[IUbiquityFormulas](/src/dollar/interfaces/IUbiquityFormulas.sol/interface.IUbiquityFormulas.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# TWAPOracleDollar3poolFacet
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/facets/TWAPOracleDollar3poolFacet.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/facets/TWAPOracleDollar3poolFacet.sol)

**Inherits:**
[Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md), [ITWAPOracleDollar3pool](/src/dollar/interfaces/ITWAPOracleDollar3pool.sol/interface.ITWAPOracleDollar3pool.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# UbiquityPoolFacet
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/facets/UbiquityPoolFacet.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/facets/UbiquityPoolFacet.sol)

**Inherits:**
[Modifiers](/src/dollar/libraries/LibAppStorage.sol/contract.Modifiers.md), [IUbiquityPool](/src/dollar/interfaces/IUbiquityPool.sol/interface.IUbiquityPool.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# IAccessControl
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/interfaces/IAccessControl.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/interfaces/IAccessControl.sol)

Access contol interface

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# IBondingCurve
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/interfaces/IBondingCurve.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/interfaces/IBondingCurve.sol)

Interface based on Bancor formula

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ICreditNft
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/interfaces/ICreditNft.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/interfaces/ICreditNft.sol)

**Inherits:**
IERC1155
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ICreditNftManager
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/interfaces/ICreditNftManager.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/interfaces/ICreditNftManager.sol)

**Inherits:**
IERC1155Receiver
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ICreditNftRedemptionCalculator
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/interfaces/ICreditNftRedemptionCalculator.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/interfaces/ICreditNftRedemptionCalculator.sol)

Contract interface for calculating amount of Credit NFTs to mint on Dollars burn

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ICreditRedemptionCalculator
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/interfaces/ICreditRedemptionCalculator.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/interfaces/ICreditRedemptionCalculator.sol)

Contract interface for calculating amount of Credits to mint on Dollars burn

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ICurveFactory
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/interfaces/ICurveFactory.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/interfaces/ICurveFactory.sol)

Curve Factory interface

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# IDepositZap
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/interfaces/IDepositZap.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/interfaces/IDepositZap.sol)

Interface for Curve's Deposit Zap

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# IDiamondCut
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/interfaces/IDiamondCut.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/interfaces/IDiamondCut.sol)

Interface that allows modifications to diamond function selector mapping

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# IDiamondLoupe
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/interfaces/IDiamondLoupe.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/interfaces/IDiamondLoupe.sol)

A loupe is a small magnifying glass used to look at diamonds.
These functions look at diamonds.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# IDollarMintCalculator
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/interfaces/IDollarMintCalculator.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/interfaces/IDollarMintCalculator.sol)

Interface for calculating amount of Dollars to be minted

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# IDollarMintExcess
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/interfaces/IDollarMintExcess.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/interfaces/IDollarMintExcess.sol)

Interface for distributing excess Dollars when `mintClaimableDollars()` is called

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# IERC1155Ubiquity
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/interfaces/IERC1155Ubiquity.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/interfaces/IERC1155Ubiquity.sol)

**Inherits:**
IERC1155
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# IERC173
[Git Source](https://github.com/rndquu/ubiquity-dollar/blob/acaf5012d59fae725859d662b4b531abaa7ec8f5/src/dollar/interfaces/IERC173.sol)
[Git Source](https://github.com/ubiquity/ubiquity-dollar/blob/ccc689b8b816039996240d21714a491a27963d57/packages/contracts/src/dollar/interfaces/IERC173.sol)

ERC-173 Contract Ownership Standard

Expand Down
Loading
Loading