Merge pull request #148 from apollodao/dev/v0.5.2

Prepare release v0.5.2

.github/workflows/cc.yml

@@ -16,4 +16,4 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Check all commit messages for adherence
-        uses: webiny/action-conventional-commits@v1.1.0
+        uses: bilalshaikh42/action-conventional-commits@v2.0.1

.github/workflows/check.yml

@@ -14,8 +14,11 @@ jobs:
       - name: Checkout sources
         uses: actions/checkout@v3
 
-      - name: Run cargo check
-        uses: actions-rs/cargo@v1
-        with:
-          command: check
-          args: --all-features
+      - name: Install cargo make
+        uses: davidB/rust-cargo-make@v1
+
+      - name: Install stable Rust
+        run: cargo make install-stable
+
+      - name: Check
+        run: cargo make check

.github/workflows/licenses.yml

@@ -22,13 +22,11 @@ jobs:
       - name: Checkout sources
         uses: actions/checkout@v3
 
+      - name: Install cargo make
+        uses: davidB/rust-cargo-make@v1
+
       - name: Install stable toolchain
-        uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: 1.59.0
-          target: wasm32-unknown-unknown
-          override: true
+        run: cargo make install-stable
 
       - name: run cargo deny
         uses: EmbarkStudios/cargo-deny-action@v1

.github/workflows/lint-format.yml

@@ -14,37 +14,25 @@ jobs:
       - name: Checkout sources
         uses: actions/checkout@v3
 
-      - name: Install nightly toolchain
-        uses: actions-rs/toolchain@v1
+      - name: Set up Go 1.21.6
+        uses: actions/setup-go@v5
         with:
-          profile: minimal
-          toolchain: nightly
-          components: rustfmt, clippy
+          go-version: "1.21.6"
 
-      - name: Install cargo-machete
-        uses: actions-rs/cargo@v1
-        with:
-          command: install
-          args: cargo-machete
+      - name: Install cargo make
+        uses: davidB/rust-cargo-make@v1
+
+      - name: Install nightly toolchain
+        run: cargo make install-nightly
 
       - name: Run cargo clippy
-        uses: actions-rs/cargo@v1
-        with:
-          toolchain: nightly
-          command: clippy
-          args: --all-features -- -D warnings
+        run: cargo make clippy-check
 
       - name: Run cargo fmt
-        uses: actions-rs/cargo@v1
-        with:
-          toolchain: nightly
-          command: fmt
-          args: --all -- --check --verbose
+        run: cargo make format-check
 
       - name: Run cargo machete
-        uses: actions-rs/cargo@v1
-        with:
-          command: machete
+        run: cargo make machete-check
 
       - name: Lint todo comments
-        run: ./scripts/todo-lint.sh
+        run: cargo make todo-check

.github/workflows/test.yml

@@ -5,6 +5,7 @@ on:
 
 env:
   RUSTFLAGS: -D warnings
+  TEST_RUNNER: osmosis-test-tube
 
 jobs:
   test:
@@ -14,13 +15,16 @@ jobs:
       - name: Checkout sources
         uses: actions/checkout@v3
 
-      - name: Install stable toolchain
-        uses: actions-rs/toolchain@v1
+      - name: Set up Go 1.21.6
+        uses: actions/setup-go@v5
         with:
-          profile: minimal
-          toolchain: 1.65.0
-          target: wasm32-unknown-unknown
-          override: true
+          go-version: "1.21.6"
+
+      - name: Install cargo make
+        uses: davidB/rust-cargo-make@v1
+
+      - name: Install stable toolchain
+        run: cargo make install-stable
 
       - name: Run unit tests
         uses: actions-rs/cargo@v1
@@ -50,22 +54,22 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: test
-          args: --locked --test osmosis_tests
+          args: --locked --test osmosis_tests --all-features
         env:
           RUST_BACKTRACE: 1
 
       - name: Run astroport integration tests
         uses: actions-rs/cargo@v1
         with:
           command: test
-          args: --locked --test astroport_tests
+          args: --locked --test astroport_tests --all-features
         env:
           RUST_BACKTRACE: 1
 
       - name: Run osmosis property tests
         uses: actions-rs/cargo@v1
         with:
           command: test
-          args: --locked --test osmosis_proptests
+          args: --locked --test osmosis_proptests --all-features
         env:
           RUST_BACKTRACE: 1

CHANGELOG.md

@@ -0,0 +1,82 @@
+# Changelog
+
+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).
+
+# [0.5.2] - 2024-02-13
+
+### Changed
+
+- Deprecated `implemenations` module in favor of new crates `cw-dex-astroport` and `cw-dex-osmosis`.
+  - This is to avoid breaking changes in `cw-dex` when one of the implementations change.
+
+# [0.5.1] - 2024-02-06
+
+### Changed
+
+- Added support in `AstroportPool` for custom pool type `astroport-pair-xyk-sale-tax`.
+
+# [0.5.0] - 2023-10-30
+
+### Added
+
+- Added support for Astroport's passive concentrated liquidity pool type.
+
+### Changed
+
+- Changed `AstroportPool` to use the new Astroport liquidity manager contract which supports directly passing a min_out for provide and withdraw liquidity.
+  - This is a breaking change as `AstroportPool::new` now takes an argument `liquidity_manager: Addr`.
+- Changed fn `get_pool_for_lp_token` in `Pool` to take an argument `astroport_liquidity_manager: Option<Addr>`. This is needed to support using the new liquidity manager contract.
+- Bump `cw-it` to `0.2.2`
+
+# [0.4.1] - 2023-10-25
+
+### Added
+
+- fn `claim_rewards` on `AstroportStaking` now unwraps any CW20-wrapped native tokens claimed from the staking contract.
+  - See the astroport [native-coin-wrapper](https://github.com/astroport-fi/astroport-core/tree/main/contracts/periphery/native-coin-wrapper) contract.
+
+# [0.4.0] - 2023-09-26
+
+### Changed
+
+- Changed field `astro_addr: Addr` to `astro_token: AssetInfo` on struct `AstroportStaking`.
+  - This is a breaking change.
+  - This is to support chains where ASTRO is a native token.
+- Implemented `Pool::get_pool_for_lp_token` for Astroport.
+- Upgraded dependencies
+  - Upgraded osmosis-std to 0.19.2
+  - Upgraded cw-it to 0.2.1
+
+# [0.3.1] - 2023-07-20
+
+### Changed
+
+Use `StdError::generic_err` instead of constructing a literal `StdError` in `cw-dex/src/error.rs`,
+so that we don't have to fill the backtraces field.
+
+## [0.3.0] - 2023-07-17
+
+Note: This relase contains breaking API changes.
+
+### Changed
+
+- Upgraded dependencies
+    - Upgraded osmosis-std to 0.16.0
+    - Upgraded astroport to 2.8.0
+- Removed argument `sender` of function `simulate_swap` of trait `Pool`.
+    - This is no longer needed with the new API of Osmosis v16.
+
+## [0.2.0] - 2023-06-06
+
+### Security
+
+- Add argument `min_out: AssetList,` to function `withdraw_liquidity` of trait `Pool`.
+  - Note: This is a breaking change.
+  - Note: This argument is currently ignored for Astroport as they do not support minimum output amounts for withdrawal liquidity. Support will be added in a future release.
+
+### Added
+
+- Use `min_out` argument in function `withdraw_liquidity` of implementation of trait `Pool` for `OsmosisPool`.