Skip to content

Latest commit

 

History

History
228 lines (145 loc) · 6.1 KB

CHANGELOG.md

File metadata and controls

228 lines (145 loc) · 6.1 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

1.11.0 - 2023-01-04

Changed

  • Upgrade to @hifi/protocol v1.11.0.

1.10.1 - 2023-01-04

Changed

  • Upgrade to solidity-docgen v0.6.0-beta.8.
  • Fix referenced license in README.

Fixed

  • Respond to audit finding regarding unlocked pragma (QSP-23).

1.10.0 - 2022-03-29

Changed

  • Refactor the directory trees in the generated types.
  • Refactor the ethers factories as per the latest typechain output.
  • Upgrade to the latest ethers packages.
  • Upgrade to @hifi/protocol v1.10.0.

Removed

  • Remove types for Erc20, Erc20Permit and Ownable.

1.9.1 - 2022-03-16

Fixed

  • Fix peer dependency version of @hifi/protocol.

1.9.0 - 2022-03-16

Changed

  • Change the amount argument to value in the permit function of the Erc20Permit contract.
  • Change the license from LGPL v3 to BUSL v1.1.
  • Switch from @paulrberg/contracts to @prb/contracts.
  • Switch from prb-math to @prb/math.
  • Upgrade to @hifi/protocol v1.9.0.

1.8.2 - 2022-03-04

Changed

  • Upgrade to @hifi/protocol v1.8.2.

1.8.1 - 2022-03-04

Changed

  • Upgrade to @hifi/protocol v1.8.1.

1.8.0 - 2022-03-04

Changed

  • Improve wording in README and NatSpec comments.
  • Inherit from IOwnable.sol in IHifiPoolRegistry.
  • Move the custom errors in the smart contract interface files.
  • Upgrade to @hifi/protocol v1.8.0.
  • Upgrade to @paulrberg/contracts v3.7.0.
  • Upgrade to ethers v5.5.4.
  • Upgrade to prb-math v2.4.3.

Removed

  • All *.d.ts type files.

1.7.1 - 2021-10-25

Changed

  • Upgrade to @hifi/protocol v1.7.1.

1.7.0 - 2021-10-20

Changed

  • Mark @ethersproject/abi, @ethersproject/bytes and @ethersproject/providers as normal deps instead of dev deps.
  • Move types from typechain directory to dist/types.
  • Order storage vars alphabetically.
  • Ship declaration maps and source maps with the npm package.
  • Upgrade to @hifi/protocol v1.7.0.
  • Upgrade to @paulrberg/contracts v3.6.1.
  • Upgrade to ethers v5.5.1.
  • Upgrade to prb-math v2.4.0 and remove prb-math.js dev dep.
  • Upgrade to Solidity v0.8.9.

Fixed

  • Check zero edge cases in the buyHToken and sellHToken functions in the HifiPool contract.

Removed

  • artifacts from npm package.

1.6.0 - 2021-09-24

Changed

  • Declutter README and add usage guides.
  • Polish the NatSpec comments.
  • Sync peer dependencies.
  • Update year in LICENSE.
  • Upgrade to @hifi/protocol v1.6.0.
  • Upgrade to @paulrberg/contracts v3.6.0.
  • Upgrade to prb-math v2.3.0.

1.5.0 - 2021-09-16

Added

  • getBurnOutputs function in the HifiPool contract.

Changed

  • Polish NatSpec comments.
  • Rename getMintParams function to getMintInputs.
  • Upgrade to ethers v5.4.6.
  • Upgrade to @hifi/protocol v1.5.0.
  • Upgrade to @paulrberg/contracts v3.5.2.
  • Use Solidity v0.8.7.

Fixed

  • Allow minting of LP tokens only before maturity.
  • Typos in NatSpec comments.

1.4.0 - 2021-08-13

Added

  • Ethers as a peer dependency.
  • Erc20, Erc20Permit and Ownable in the npm package bundle.
  • New HifiPoolRegistry.sol contract, to track deployed AMMs.
  • TypeChain factories in the npm package bundle.

Changed

  • Upgrade to @hifi/protocol v1.4.0.

1.3.0 - 2021-08-03

Changed

  • Reword NatSpec for constructor function.
  • Upgrade to @hifi/protocol v1.3.0.

1.2.1 - 2021-08-03

Changed

  • Fix indenting in YieldSpace.sol.

1.2.0 - 2021-08-03

Changed

  • Disable the Solidity compiler metadata hash.
  • Upgrade to @hifi/protocol v1.2.0.

Fixed

  • Include the commons.ts file in the typechain folder shipped to the npm registry.

1.1.2 - 2021-07-30

Changed

  • Affix all dependency versions.

1.1.1 - 2021-07-30

Changed

  • Improve NatSpec comments in IHifiPool.sol.

1.1.0 - 2021-07-29

Added

  • Inherit from IErc20Permit in IHifiPool.sol.
  • New constant function getMintParams in HifiPool.sol.

Changed

  • Keywords in package.json.
  • Source hTokenRequired and poolTokensMinted via the getMintParams function.
  • Various rewordings in code comments.

1.0.0 - 2021-06-28

Added

  • First release of the package.