docs(protocol): roll v1.6.0

chore(amm,flash-swap,protocol,proxy-target): fix "prepack" script
hifi-finance · Sep 24, 2021 · a5e4dba · a5e4dba
1 parent 881eee5
commit a5e4dba
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 6 deletions.
diff --git a/packages/amm/package.json b/packages/amm/package.json
@@ -107,7 +107,7 @@
     "lint": "yarn lint:sol && yarn lint:ts && yarn prettier:check",
     "lint:sol": "solhint --config ../../.solhint.json --max-warnings 0 \"contracts/**/*.sol\"",
     "lint:ts": "eslint --config ../../.eslintrc.yaml --ignore-path ../../.eslintignore --ext .js,.ts .",
-    "prepack": "yarn build",
+    "prepack": "yarn build:contracts",
     "prettier": "prettier --config ../../.prettierrc.js --ignore-path ../../.prettierignore --write \"**/*.{js,json,md,sol,ts,yaml,yml}\"",
     "prettier:check": "prettier --check --config ../../.prettierrc.js --ignore-path ../../.prettierignore \"**/*.{js,json,md,sol,ts,yaml,yml}\"",
     "test": "hardhat test",

diff --git a/packages/flash-swap/package.json b/packages/flash-swap/package.json
@@ -102,7 +102,7 @@
     "lint": "yarn lint:sol && yarn lint:ts && yarn prettier:check",
     "lint:sol": "solhint --config ./.solhint.json --max-warnings 0 \"contracts/**/*.sol\"",
     "lint:ts": "eslint --config ../../.eslintrc.yaml --ignore-path ../../.eslintignore --ext .js,.ts .",
-    "prepack": "yarn build",
+    "prepack": "yarn build:contracts",
     "prettier": "prettier --config ../../.prettierrc.js --ignore-path ../../.prettierignore --write \"**/*.{js,json,md,sol,ts,yaml,yml}\"",
     "prettier:check": "prettier --check --config ../../.prettierrc.js --ignore-path ../../.prettierignore \"**/*.{js,json,md,sol,ts,yaml,yml}\"",
     "test": "hardhat test",

diff --git a/packages/protocol/CHANGELOG.md b/packages/protocol/CHANGELOG.md
@@ -5,6 +5,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic
 Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.6.0] - 2021-09-24
+
+### Added
+
+- Collateral ceilings.
+
+### Changed
+
+- Declutter README and add usage guides
+- Polish the NatSpec comments.
+- Refactor `DEFAULT_COLLATERALIZATION_RATIO` to `DEFAULT_COLLATERAL_RATIO` in the `SFintrollerV1` contract.
+- Refactor `COLLATERALIZATION_RATIO_LOWER_BOUND` to `COLLATERAL_RATIO_LOWER_BOUND` in the `SFintrollerV1` contract.
+- Refactor `COLLATERALIZATION_RATIO_UPPER_BOUND` to `COLLATERAL_RATIO_UPPER_BOUND` in the `SFintrollerV1` contract.
+- Refactor `collateralizationRatio` to `collateralRatio` in the `BalanceSheetV1` and the `FintrollerV1` contracts.
+- Refactor `collateralizationRatio` to `ratio` in the `Collateral` struct in the `SFintrollerV1` contract.
+- Sync peer dependencies.
+- The `hypothetical` prefix to `new` in the variables used in the `BalanceSheetV1` contract.
+- Update year in LICENSE.
+- Upgrade to `@openzeppelin/contracts-upgradeable` v4.3.2.
+- Upgrade to `@paulrberg/contracts` v3.6.0.
+- Upgrade to `prb-math` v2.3.0.
+
 ## [1.5.0] - 2021-09-16
 
 ### Added
@@ -15,7 +37,7 @@ Versioning](https://semver.org/spec/v2.0.0.html).
 ### Changed
 
 - Improve wording in NatSpec comments.
-- Refactor all test `burn` and `mint` functions to `__godMode_burn` and `__godMode_mint`
+- Refactor all test `burn` and `mint` functions to `__godMode_burn` and `__godMode_mint`.
 - Set the list of non-recoverable tokens in the `HToken` contract constructor.
 - Upgrade to `ethers` v5.4.6.
 - Upgrade to `@paulrberg/contracts` v3.5.2.
@@ -45,5 +67,6 @@ Versioning](https://semver.org/spec/v2.0.0.html).
 
 - Zero edge case in `getSeizableCollateralAmount` function.
 
+[1.6.0]: https://github.com/hifi-finance/hifi/compare/@hifi/protocol@1.5.0...@hifi/protocol@1.6.0
 [1.5.0]: https://github.com/hifi-finance/hifi/compare/@hifi/protocol@1.4.0...@hifi/protocol@1.5.0
 [1.4.0]: https://github.com/hifi-finance/hifi/releases/tag/@hifi/protocol@1.4.0
diff --git a/packages/protocol/package.json b/packages/protocol/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@hifi/protocol",
   "description": "The core Hifi fixed-rate, fixed-term lending protocol",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "author": {
     "name": "Hifi",
     "email": "contact@hifi.finance",
@@ -108,7 +108,7 @@
     "lint": "yarn lint:sol && yarn lint:ts && yarn prettier:check",
     "lint:sol": "solhint --config ../../.solhint.json --max-warnings 0 \"contracts/**/*.sol\"",
     "lint:ts": "eslint --config ../../.eslintrc.yaml --ignore-path ../../.eslintignore --ext .js,.ts .",
-    "prepack": "yarn build",
+    "prepack": "yarn build:contracts",
     "prettier": "prettier --config ../../.prettierrc.js --ignore-path ../../.prettierignore --write \"**/*.{js,json,md,sol,ts,yaml,yml}\"",
     "prettier:check": "prettier --check --config ../../.prettierrc.js --ignore-path ../../.prettierignore \"**/*.{js,json,md,sol,ts,yaml,yml}\"",
     "test": "hardhat test",

diff --git a/packages/proxy-target/package.json b/packages/proxy-target/package.json
@@ -83,7 +83,7 @@
     "lint": "yarn lint:sol && yarn lint:ts && yarn prettier:check",
     "lint:sol": "solhint --config ../../.solhint.json --max-warnings 0 \"contracts/**/*.sol\"",
     "lint:ts": "eslint --config ../../.eslintrc.yaml --ignore-path ../../.eslintignore --ext .js,.ts .",
-    "prepack": "yarn build",
+    "prepack": "yarn build:contracts",
     "prettier": "prettier --config ../../.prettierrc.js --ignore-path ../../.prettierignore --write \"**/*.{js,json,md,sol,ts,yaml,yml}\"",
     "prettier:check": "prettier --check --config ../../.prettierrc.js --ignore-path ../../.prettierignore \"**/*.{js,json,md,sol,ts,yaml,yml}\"",
     "typechain": "hardhat typechain"