Merge pull request #952 from jianghuyiyuan/development

chore: fix some comments
ubiquity · Jul 31, 2024 · 0cae716 · 0cae716
2 parents cea94a0 + 66db497
commit 0cae716
Show file tree

Hide file tree

Showing 7 changed files with 7 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -63,7 +63,7 @@ yarn workspace @ubiquity/dapp start # Run the web application at http://localhos
 
 3. We require all PRs to meet the issues expectation and/or to follow the discussions accordingly and implement all necessary changes and feedback by reviewers.
 
-4. We run [CI jobs](https://github.com/ubiquity/ubiquity-dollar/actions) all CI jobs must pass before commiting/merging a PR with no exceptions (usually a few exceptions while the PR it's getting reviewed and the maintainers highlight a job run that may skip)
+4. We run [CI jobs](https://github.com/ubiquity/ubiquity-dollar/actions) all CI jobs must pass before committing/merging a PR with no exceptions (usually a few exceptions while the PR it's getting reviewed and the maintainers highlight a job run that may skip)
 
 5. We run Solhint to enforce a pre-set selected number of rules for code quality/style on Smart Contracts
 

diff --git a/...cts/docs/src/src/dollar/interfaces/ICurveFactory.sol/interface.ICurveFactory.md b/...cts/docs/src/src/dollar/interfaces/ICurveFactory.sol/interface.ICurveFactory.md
@@ -519,7 +519,7 @@ function base_pool_count() external view returns (uint256);
 
 ### fee_receiver
 
-Returns fee reciever by pool address
+Returns fee receiver by pool address
 
 
 ```solidity

diff --git a/...r/interfaces/ICurveTwocryptoOptimized.sol/interface.ICurveTwocryptoOptimized.md b/...r/interfaces/ICurveTwocryptoOptimized.sol/interface.ICurveTwocryptoOptimized.md
@@ -8,7 +8,7 @@ Curve's CurveTwocryptoOptimized interface
 
 *Differences between Curve's crypto and stable swap meta pools (and how Ubiquity organization uses them):
 1. They contain different tokens:
-a) Curve's stable swap metapool containts Dollar/3CRVLP pair
+a) Curve's stable swap metapool contains Dollar/3CRVLP pair
 b) Curve's crypto pool contains Governance/ETH pair
 2. They use different bonding curve shapes:
 a) Curve's stable swap metapool is more straight (because underlying tokens are pegged to USD)

diff --git a/.../src/src/dollar/interfaces/IDollarMintExcess.sol/interface.IDollarMintExcess.md b/.../src/src/dollar/interfaces/IDollarMintExcess.sol/interface.IDollarMintExcess.md
@@ -14,7 +14,7 @@ Example:
 3. 10% (100 Dollars) goes for burning Dollar-Governance LP tokens:
 - Half of 10% Dollars are swapped for Governance tokens on a DEX
 - Governance tokens and half of 10% tokens are added as a liquidity to the Dollar-Governance DEX pool
-- Dollar-Governance LP tokens are transfered to 0 address (i.e. burning LP tokens)
+- Dollar-Governance LP tokens are transferred to 0 address (i.e. burning LP tokens)
 4. 40% (400 Dollars) goes to the Staking contract:
 - Swap Dollars for 3CRV LP tokens in the Curve's Dollar-3CRV MetaPool
 - Add 3CRV LP tokens to the Curve Dollar-3CRV MetaPool

diff --git a/packages/contracts/src/dollar/interfaces/ICurveFactory.sol b/packages/contracts/src/dollar/interfaces/ICurveFactory.sol
@@ -255,7 +255,7 @@ interface ICurveFactory {
     function base_pool_count() external view returns (uint256);
 
     /**
-     * @notice Returns fee reciever by pool address
+     * @notice Returns fee receiver by pool address
      * @param arg0 Pool address
      * @return Fee receiver
      */

diff --git a/packages/contracts/src/dollar/interfaces/ICurveTwocryptoOptimized.sol b/packages/contracts/src/dollar/interfaces/ICurveTwocryptoOptimized.sol
@@ -8,7 +8,7 @@ import {ICurveStableSwapMetaNG} from "./ICurveStableSwapMetaNG.sol";
  *
  * @dev Differences between Curve's crypto and stable swap meta pools (and how Ubiquity organization uses them):
  * 1. They contain different tokens:
- * a) Curve's stable swap metapool containts Dollar/3CRVLP pair
+ * a) Curve's stable swap metapool contains Dollar/3CRVLP pair
  * b) Curve's crypto pool contains Governance/ETH pair
  * 2. They use different bonding curve shapes:
  * a) Curve's stable swap metapool is more straight (because underlying tokens are pegged to USD)

diff --git a/packages/contracts/src/dollar/interfaces/IDollarMintExcess.sol b/packages/contracts/src/dollar/interfaces/IDollarMintExcess.sol
@@ -16,7 +16,7 @@ import "@openzeppelin/contracts/token/ERC1155/IERC1155Receiver.sol";
  * 3. 10% (100 Dollars) goes for burning Dollar-Governance LP tokens:
  *   - Half of 10% Dollars are swapped for Governance tokens on a DEX
  *   - Governance tokens and half of 10% tokens are added as a liquidity to the Dollar-Governance DEX pool
- *   - Dollar-Governance LP tokens are transfered to 0 address (i.e. burning LP tokens)
+ *   - Dollar-Governance LP tokens are transferred to 0 address (i.e. burning LP tokens)
  * 4. 40% (400 Dollars) goes to the Staking contract:
  *   - Swap Dollars for 3CRV LP tokens in the Curve's Dollar-3CRV MetaPool
  *   - Add 3CRV LP tokens to the Curve Dollar-3CRV MetaPool