From 872342e060bfc31c3ab6a1deb7b1d3050ea7e19d Mon Sep 17 00:00:00 2001 From: Juan Ignacio Ubeira Date: Wed, 21 Jun 2023 12:19:08 -0300 Subject: [PATCH] Refactor: move `Version` to `solidity-utils`. (#2525) --- pkg/interfaces/CHANGELOG.md | 1 + .../contracts/liquidity-mining/IChildChainGauge.sol | 2 +- .../{pool-utils => solidity-utils/helpers}/IVersion.sol | 0 .../contracts/gauges/ChildChainGaugeFactory.sol | 2 +- .../contracts/gauges/ethereum/SingleRecipientGauge.sol | 2 +- pkg/pool-stable/contracts/ComposableStablePool.sol | 2 +- pkg/pool-stable/contracts/ComposableStablePoolFactory.sol | 2 +- pkg/pool-utils/CHANGELOG.md | 6 ++++++ pkg/pool-weighted/contracts/managed/ManagedPool.sol | 2 +- pkg/pool-weighted/contracts/managed/ManagedPoolFactory.sol | 2 +- pkg/solidity-utils/CHANGELOG.md | 6 ++++++ .../contracts/helpers}/Version.sol | 2 +- pkg/{pool-utils => solidity-utils}/test/Version.test.ts | 0 13 files changed, 21 insertions(+), 8 deletions(-) rename pkg/interfaces/contracts/{pool-utils => solidity-utils/helpers}/IVersion.sol (100%) rename pkg/{pool-utils/contracts => solidity-utils/contracts/helpers}/Version.sol (93%) rename pkg/{pool-utils => solidity-utils}/test/Version.test.ts (100%) diff --git a/pkg/interfaces/CHANGELOG.md b/pkg/interfaces/CHANGELOG.md index c08d096cfd..021bf5e7dd 100644 --- a/pkg/interfaces/CHANGELOG.md +++ b/pkg/interfaces/CHANGELOG.md @@ -21,6 +21,7 @@ - Refactored `IL2GaugeCheckpointer`. - Removed `isSupportedGaugeType` from interface. - Bumped minimum compiler version from `0.7.0` to `0.7.1` in `BalancerErrors`. +- `IVersion` moved from `pool-utils` to `solidity-utils`. ## 0.4.0 (2023-03-15) diff --git a/pkg/interfaces/contracts/liquidity-mining/IChildChainGauge.sol b/pkg/interfaces/contracts/liquidity-mining/IChildChainGauge.sol index d4df179287..b9721fdc17 100644 --- a/pkg/interfaces/contracts/liquidity-mining/IChildChainGauge.sol +++ b/pkg/interfaces/contracts/liquidity-mining/IChildChainGauge.sol @@ -14,7 +14,7 @@ pragma solidity >=0.7.0 <0.9.0; -import "../pool-utils/IVersion.sol"; +import "../solidity-utils/helpers/IVersion.sol"; import "./ILiquidityGaugeFactory.sol"; // For compatibility, we're keeping the same function names as in the original Curve code, including the mixed-case diff --git a/pkg/interfaces/contracts/pool-utils/IVersion.sol b/pkg/interfaces/contracts/solidity-utils/helpers/IVersion.sol similarity index 100% rename from pkg/interfaces/contracts/pool-utils/IVersion.sol rename to pkg/interfaces/contracts/solidity-utils/helpers/IVersion.sol diff --git a/pkg/liquidity-mining/contracts/gauges/ChildChainGaugeFactory.sol b/pkg/liquidity-mining/contracts/gauges/ChildChainGaugeFactory.sol index fcf3fa15cd..e14f1234e4 100644 --- a/pkg/liquidity-mining/contracts/gauges/ChildChainGaugeFactory.sol +++ b/pkg/liquidity-mining/contracts/gauges/ChildChainGaugeFactory.sol @@ -16,7 +16,7 @@ pragma solidity ^0.7.0; pragma experimental ABIEncoderV2; import "@balancer-labs/v2-interfaces/contracts/liquidity-mining/IChildChainGauge.sol"; -import "@balancer-labs/v2-pool-utils/contracts/Version.sol"; +import "@balancer-labs/v2-solidity-utils/contracts/helpers/Version.sol"; import "./BaseGaugeFactory.sol"; diff --git a/pkg/liquidity-mining/contracts/gauges/ethereum/SingleRecipientGauge.sol b/pkg/liquidity-mining/contracts/gauges/ethereum/SingleRecipientGauge.sol index a7fb149ec1..3bb7ec9c63 100644 --- a/pkg/liquidity-mining/contracts/gauges/ethereum/SingleRecipientGauge.sol +++ b/pkg/liquidity-mining/contracts/gauges/ethereum/SingleRecipientGauge.sol @@ -15,7 +15,7 @@ pragma solidity ^0.7.0; import "@balancer-labs/v2-interfaces/contracts/liquidity-mining/IFeeDistributor.sol"; -import "@balancer-labs/v2-pool-utils/contracts/Version.sol"; +import "@balancer-labs/v2-solidity-utils/contracts/helpers/Version.sol"; import "@balancer-labs/v2-solidity-utils/contracts/openzeppelin/SafeERC20.sol"; import "../StakelessGauge.sol"; diff --git a/pkg/pool-stable/contracts/ComposableStablePool.sol b/pkg/pool-stable/contracts/ComposableStablePool.sol index 6edc1cb02f..c24087f1b2 100644 --- a/pkg/pool-stable/contracts/ComposableStablePool.sol +++ b/pkg/pool-stable/contracts/ComposableStablePool.sol @@ -19,7 +19,7 @@ import "@balancer-labs/v2-interfaces/contracts/pool-stable/StablePoolUserData.so import "@balancer-labs/v2-interfaces/contracts/solidity-utils/helpers/BalancerErrors.sol"; import "@balancer-labs/v2-interfaces/contracts/standalone-utils/IProtocolFeePercentagesProvider.sol"; import "@balancer-labs/v2-interfaces/contracts/pool-utils/IRateProvider.sol"; -import "@balancer-labs/v2-interfaces/contracts/pool-utils/IVersion.sol"; +import "@balancer-labs/v2-interfaces/contracts/solidity-utils/helpers/IVersion.sol"; import "@balancer-labs/v2-solidity-utils/contracts/math/FixedPoint.sol"; import "@balancer-labs/v2-solidity-utils/contracts/math/Math.sol"; diff --git a/pkg/pool-stable/contracts/ComposableStablePoolFactory.sol b/pkg/pool-stable/contracts/ComposableStablePoolFactory.sol index 6e7f35cc46..db5be0a704 100644 --- a/pkg/pool-stable/contracts/ComposableStablePoolFactory.sol +++ b/pkg/pool-stable/contracts/ComposableStablePoolFactory.sol @@ -16,7 +16,7 @@ pragma solidity ^0.7.0; pragma experimental ABIEncoderV2; import "@balancer-labs/v2-interfaces/contracts/pool-utils/IPoolVersion.sol"; -import "@balancer-labs/v2-interfaces/contracts/pool-utils/IVersion.sol"; +import "@balancer-labs/v2-interfaces/contracts/solidity-utils/helpers/IVersion.sol"; import "@balancer-labs/v2-interfaces/contracts/vault/IVault.sol"; import "@balancer-labs/v2-pool-utils/contracts/factories/BasePoolFactory.sol"; diff --git a/pkg/pool-utils/CHANGELOG.md b/pkg/pool-utils/CHANGELOG.md index f54d2e1c06..95f75bd87a 100644 --- a/pkg/pool-utils/CHANGELOG.md +++ b/pkg/pool-utils/CHANGELOG.md @@ -1,5 +1,11 @@ # Changelog +## Unreleased + +### Breaking changes + +- Removed `Version` contract. It is now part of `v2-solidity-utils` since it will be used more generally. + ## 4.1.1 (2023-06-05) ### Bugfix diff --git a/pkg/pool-weighted/contracts/managed/ManagedPool.sol b/pkg/pool-weighted/contracts/managed/ManagedPool.sol index 29ddee384c..df79d9dcd6 100644 --- a/pkg/pool-weighted/contracts/managed/ManagedPool.sol +++ b/pkg/pool-weighted/contracts/managed/ManagedPool.sol @@ -15,7 +15,7 @@ pragma solidity ^0.7.0; pragma experimental ABIEncoderV2; -import "@balancer-labs/v2-interfaces/contracts/pool-utils/IVersion.sol"; +import "@balancer-labs/v2-interfaces/contracts/solidity-utils/helpers/IVersion.sol"; import "@balancer-labs/v2-interfaces/contracts/pool-utils/IRecoveryModeHelper.sol"; import "@balancer-labs/v2-interfaces/contracts/pool-weighted/IExternalWeightedMath.sol"; import "@balancer-labs/v2-interfaces/contracts/pool-weighted/WeightedPoolUserData.sol"; diff --git a/pkg/pool-weighted/contracts/managed/ManagedPoolFactory.sol b/pkg/pool-weighted/contracts/managed/ManagedPoolFactory.sol index 18f9f72735..b02218cc6a 100644 --- a/pkg/pool-weighted/contracts/managed/ManagedPoolFactory.sol +++ b/pkg/pool-weighted/contracts/managed/ManagedPoolFactory.sol @@ -21,7 +21,7 @@ import "@balancer-labs/v2-interfaces/contracts/pool-weighted/IExternalWeightedMa import "@balancer-labs/v2-interfaces/contracts/standalone-utils/IProtocolFeePercentagesProvider.sol"; import "@balancer-labs/v2-pool-utils/contracts/factories/BasePoolFactory.sol"; -import "@balancer-labs/v2-pool-utils/contracts/Version.sol"; +import "@balancer-labs/v2-solidity-utils/contracts/helpers/Version.sol"; import "./ManagedPool.sol"; diff --git a/pkg/solidity-utils/CHANGELOG.md b/pkg/solidity-utils/CHANGELOG.md index 9bb6d1484f..3992c30bd5 100644 --- a/pkg/solidity-utils/CHANGELOG.md +++ b/pkg/solidity-utils/CHANGELOG.md @@ -1,5 +1,11 @@ # Changelog +## Unreleased + +### Misc + +- Added `Version` contract. + ## 4.0.0 (2023-03-23) ### Breaking Changes diff --git a/pkg/pool-utils/contracts/Version.sol b/pkg/solidity-utils/contracts/helpers/Version.sol similarity index 93% rename from pkg/pool-utils/contracts/Version.sol rename to pkg/solidity-utils/contracts/helpers/Version.sol index 8e0f62a528..939951a57f 100644 --- a/pkg/pool-utils/contracts/Version.sol +++ b/pkg/solidity-utils/contracts/helpers/Version.sol @@ -14,7 +14,7 @@ pragma solidity ^0.7.0; -import "@balancer-labs/v2-interfaces/contracts/pool-utils/IVersion.sol"; +import "@balancer-labs/v2-interfaces/contracts/solidity-utils/helpers/IVersion.sol"; /** * @notice Retrieves a contract's version set at creation time from storage. diff --git a/pkg/pool-utils/test/Version.test.ts b/pkg/solidity-utils/test/Version.test.ts similarity index 100% rename from pkg/pool-utils/test/Version.test.ts rename to pkg/solidity-utils/test/Version.test.ts