Skip to content

Commit 320063c

Browse files
committed
chore: renaming of the getPool for consistency
1 parent f11a379 commit 320063c

6 files changed

Lines changed: 31 additions & 51 deletions

File tree

contracts/interfaces/IFPMMFactory.sol

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -79,14 +79,6 @@ interface IFPMMFactory {
7979
*/
8080
function governance() external view returns (address);
8181

82-
/**
83-
* @notice Gets the address of the deployed FPMM for a token pair.
84-
* @param token0 The address of the first token
85-
* @param token1 The address of the second token
86-
* @return The address of the deployed FPMM for the token pair
87-
*/
88-
function deployedFPMMs(address token0, address token1) external view returns (address);
89-
9082
/**
9183
* @notice Gets the list of deployed FPMM addresses.
9284
* @return The list of deployed FPMM addresses
@@ -132,7 +124,7 @@ interface IFPMMFactory {
132124
function isPool(address token0, address token1) external view returns (bool);
133125

134126
/**
135-
* @notice Gets the address of the deployed FPMM for a token pair.
127+
* @notice Gets the address of the deployed FPMM for a token pair..
136128
* @param token0 The address of the first token
137129
* @param token1 The address of the second token
138130
* @return The address of the deployed FPMM for the token pair

contracts/swap/FPMMFactory.sol

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -109,12 +109,6 @@ contract FPMMFactory is IFPMMFactory, OwnableUpgradeable {
109109
return $.governance;
110110
}
111111

112-
/// @inheritdoc IFPMMFactory
113-
function deployedFPMMs(address token0, address token1) public view returns (address) {
114-
FPMMFactoryStorage storage $ = _getFPMMStorage();
115-
return $.deployedFPMMs[token0][token1];
116-
}
117-
118112
/// @inheritdoc IFPMMFactory
119113
function deployedFPMMAddresses() public view returns (address[] memory) {
120114
FPMMFactoryStorage storage $ = _getFPMMStorage();
@@ -139,7 +133,7 @@ contract FPMMFactory is IFPMMFactory, OwnableUpgradeable {
139133
(token0, token1) = sortTokens(token0, token1);
140134

141135
if (isPool(token0, token1)) {
142-
return deployedFPMMs(token0, token1);
136+
return getPool(token0, token1);
143137
}
144138

145139
(address precomputedProxyAddress, ) = _computeProxyAddressAndSalt(token0, token1);
@@ -156,13 +150,13 @@ contract FPMMFactory is IFPMMFactory, OwnableUpgradeable {
156150

157151
/// @inheritdoc IFPMMFactory
158152
function isPool(address token0, address token1) public view returns (bool) {
159-
return deployedFPMMs(token0, token1) != address(0);
153+
return getPool(token0, token1) != address(0);
160154
}
161155

162156
/// @inheritdoc IFPMMFactory
163-
function getPool(address token0, address token1) external view returns (address) {
164-
require(isPool(token0, token1), "FPMMFactory: POOL_NOT_FOUND");
165-
return deployedFPMMs(token0, token1);
157+
function getPool(address token0, address token1) public view returns (address) {
158+
FPMMFactoryStorage storage $ = _getFPMMStorage();
159+
return $.deployedFPMMs[token0][token1];
166160
}
167161

168162
/* ============================================================ */

contracts/swap/router/Router.sol

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ contract Router is IRouter, ERC2771Context {
126126
uint256 amountADesired,
127127
uint256 amountBDesired
128128
) public view returns (uint256 amountA, uint256 amountB, uint256 liquidity) {
129-
address _pool = IFPMMFactory(_factory).deployedFPMMs(tokenA, tokenB);
129+
address _pool = IFPMMFactory(_factory).getPool(tokenA, tokenB);
130130
(uint256 reserveA, uint256 reserveB) = (0, 0);
131131
uint256 _totalSupply = 0;
132132
if (_pool != address(0)) {
@@ -156,7 +156,7 @@ contract Router is IRouter, ERC2771Context {
156156
address _factory,
157157
uint256 liquidity
158158
) public view returns (uint256 amountA, uint256 amountB) {
159-
address _pool = IFPMMFactory(_factory).deployedFPMMs(tokenA, tokenB);
159+
address _pool = IFPMMFactory(_factory).getPool(tokenA, tokenB);
160160

161161
if (_pool == address(0)) {
162162
return (0, 0);
@@ -180,7 +180,7 @@ contract Router is IRouter, ERC2771Context {
180180
if (amountADesired < amountAMin) revert InsufficientAmountADesired();
181181
if (amountBDesired < amountBMin) revert InsufficientAmountBDesired();
182182
// create the pool if it doesn't exist yet
183-
address _pool = IFPMMFactory(defaultFactory).deployedFPMMs(tokenA, tokenB);
183+
address _pool = IFPMMFactory(defaultFactory).getPool(tokenA, tokenB);
184184
if (_pool == address(0)) {
185185
revert PoolDoesNotExist();
186186
}

test/integration/protocol/FPMM/FPMMFactoryTests.t.sol

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,8 @@ contract FPMMFactoryTests is FPMMBaseIntegration {
157157

158158
(address token0, address token1) = _sortTokens(address(tokenA), address(tokenB));
159159

160-
assertEq(factory.deployedFPMMs(token0, token1), fpmm);
161-
assertEq(factory.deployedFPMMs(token1, token0), address(0));
160+
assertEq(factory.getPool(token0, token1), fpmm);
161+
assertEq(factory.getPool(token1, token0), address(0));
162162
assertTrue(factory.isPool(address(token0), address(token1)));
163163
assertFalse(factory.isPool(address(token1), address(token0)));
164164

@@ -221,7 +221,7 @@ contract FPMMFactoryTests is FPMMBaseIntegration {
221221
);
222222

223223
assertTrue(fpmm != address(0));
224-
assertEq(factory.deployedFPMMs(address(tokenA), address(tokenC)), fpmm);
224+
assertEq(factory.getPool(address(tokenA), address(tokenC)), fpmm);
225225
assertTrue(factory.isPool(address(tokenA), address(tokenC)));
226226

227227
// Verify custom configuration
@@ -259,13 +259,7 @@ contract FPMMFactoryTests is FPMMBaseIntegration {
259259
(address token0, address token1) = _sortTokens(address(tokenA), address(tokenB));
260260

261261
assertEq(factory.getPool(token0, token1), fpmm);
262-
vm.expectRevert("FPMMFactory: POOL_NOT_FOUND");
263-
factory.getPool(token1, token0);
264-
}
265-
266-
function test_getPool_whenPoolDoesNotExist_shouldRevert() public {
267-
vm.expectRevert("FPMMFactory: POOL_NOT_FOUND");
268-
factory.getPool(address(tokenA), address(tokenB));
262+
assertEq(factory.getPool(token1, token0), address(0));
269263
}
270264

271265
function test_deployedFPMMs_whenPoolExists_shouldReturnPoolAddress() public {
@@ -279,13 +273,13 @@ contract FPMMFactoryTests is FPMMBaseIntegration {
279273

280274
(address token0, address token1) = _sortTokens(address(tokenA), address(tokenB));
281275

282-
assertEq(factory.deployedFPMMs(token0, token1), fpmm);
283-
assertEq(factory.deployedFPMMs(token1, token0), address(0));
276+
assertEq(factory.getPool(token0, token1), fpmm);
277+
assertEq(factory.getPool(token1, token0), address(0));
284278
}
285279

286280
function test_deployedFPMMs_whenPoolDoesNotExist_shouldReturnZeroAddress() public view {
287-
assertEq(factory.deployedFPMMs(address(tokenA), address(tokenB)), address(0));
288-
assertEq(factory.deployedFPMMs(address(tokenB), address(tokenA)), address(0));
281+
assertEq(factory.getPool(address(tokenA), address(tokenB)), address(0));
282+
assertEq(factory.getPool(address(tokenB), address(tokenA)), address(0));
289283
}
290284

291285
function test_deployedFPMMAddresses_whenPoolsDeployed_shouldReturnAllAddresses() public {
@@ -331,7 +325,7 @@ contract FPMMFactoryTests is FPMMBaseIntegration {
331325
function test_getOrPrecomputeProxyAddress_whenPoolDoesNotExist_shouldReturnPrecomputedAddress() public {
332326
address precomputedAddress = factory.getOrPrecomputeProxyAddress(address(tokenA), address(tokenB));
333327
assertTrue(precomputedAddress != address(0));
334-
assertEq(factory.deployedFPMMs(address(tokenA), address(tokenB)), address(0));
328+
assertEq(factory.getPool(address(tokenA), address(tokenB)), address(0));
335329

336330
vm.prank(governance);
337331
address fpmm = factory.deployFPMM(

test/integration/protocol/FPMM/RouterTests.t.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ contract RouterTests is FPMMBaseIntegration {
259259
assertEq(amount1, amount1Desired);
260260
assertEq(liquidity, 100e18 - 1e3);
261261

262-
address pool = factory.deployedFPMMs(token0, token1);
262+
address pool = factory.getPool(token0, token1);
263263
assertEq(IERC20(pool).balanceOf(alice), liquidity);
264264

265265
vm.stopPrank();

test/unit/swap/FPMM/FPMMFactory.t.sol

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -706,7 +706,7 @@ abstract contract FPMMFactoryTest_DeployFPMM is FPMMFactoryTest {
706706
address deployedProxy = deploy("celo");
707707

708708
assertEq(deployedProxy, expectedProxy);
709-
assertEq(factoryCelo.deployedFPMMs(expectedToken0, expectedToken1), deployedProxy);
709+
assertEq(factoryCelo.getPool(expectedToken0, expectedToken1), deployedProxy);
710710
assertEq(factoryCelo.deployedFPMMAddresses().length, 1);
711711
assertEq(factoryCelo.deployedFPMMAddresses()[0], deployedProxy);
712712

@@ -753,7 +753,7 @@ abstract contract FPMMFactoryTest_DeployFPMM is FPMMFactoryTest {
753753
vm.selectFork(celoFork);
754754
vm.prank(governanceCelo);
755755
address celoFPMMProxy = deploy("celo");
756-
assertEq(celoFPMMProxy, factoryCelo.deployedFPMMs(token0Celo, token1Celo));
756+
assertEq(celoFPMMProxy, factoryCelo.getPool(token0Celo, token1Celo));
757757

758758
vm.selectFork(opFork);
759759
vm.prank(deployer);
@@ -766,7 +766,7 @@ abstract contract FPMMFactoryTest_DeployFPMM is FPMMFactoryTest {
766766

767767
vm.prank(governanceOp);
768768
address opFPMMProxy = deploy("op");
769-
assertEq(opFPMMProxy, factoryOp.deployedFPMMs(token0Op, token1Op));
769+
assertEq(opFPMMProxy, factoryOp.getPool(token0Op, token1Op));
770770

771771
assertEq(opFPMMProxy, celoFPMMProxy);
772772
}
@@ -951,8 +951,8 @@ contract FPMMFactoryTest_SortTokens is FPMMFactoryTest {
951951
assertEq(fpmm.token1(), higherToken); // Should be sorted to higher address
952952

953953
// Verify the factory mapping uses sorted tokens
954-
assertEq(factoryCelo.deployedFPMMs(lowerToken, higherToken), deployedProxy);
955-
assertEq(factoryCelo.deployedFPMMs(higherToken, lowerToken), address(0)); // Should not exist
954+
assertEq(factoryCelo.getPool(lowerToken, higherToken), deployedProxy);
955+
assertEq(factoryCelo.getPool(higherToken, lowerToken), address(0)); // Should not exist
956956
}
957957

958958
function testSortTokens_integrationWithGetOrPrecomputeProxyAddress_shouldUseSortedTokens() public {
@@ -978,7 +978,7 @@ contract FPMMFactoryTest_SortTokens is FPMMFactoryTest {
978978
assertEq(deployedProxy, precomputedAddress);
979979

980980
// Verify the factory mapping uses sorted tokens
981-
assertEq(factoryCelo.deployedFPMMs(lowerToken, higherToken), deployedProxy);
981+
assertEq(factoryCelo.getPool(lowerToken, higherToken), deployedProxy);
982982
}
983983

984984
function testSortTokens_deploymentMappingConsistency_shouldUseSortedTokensInMapping() public {
@@ -998,8 +998,8 @@ contract FPMMFactoryTest_SortTokens is FPMMFactoryTest {
998998
);
999999

10001000
// Verify the factory mapping only exists for sorted tokens
1001-
assertEq(factoryCelo.deployedFPMMs(lowerToken, higherToken), deployedProxy);
1002-
assertEq(factoryCelo.deployedFPMMs(higherToken, lowerToken), address(0));
1001+
assertEq(factoryCelo.getPool(lowerToken, higherToken), deployedProxy);
1002+
assertEq(factoryCelo.getPool(higherToken, lowerToken), address(0));
10031003

10041004
// Verify deployedFPMMAddresses contains the deployed proxy
10051005
address[] memory deployedAddresses = factoryCelo.deployedFPMMAddresses();
@@ -1025,12 +1025,12 @@ contract FPMMFactoryTest_SortTokens is FPMMFactoryTest {
10251025
address proxyBC1 = factoryCelo.deployFPMM(address(fpmmImplementationCelo), tokenB, tokenC, referenceRateFeedID);
10261026

10271027
// Verify mappings use sorted tokens
1028-
assertEq(factoryCelo.deployedFPMMs(tokenA, tokenB), proxyAB1);
1029-
assertEq(factoryCelo.deployedFPMMs(tokenB, tokenC), proxyBC1);
1028+
assertEq(factoryCelo.getPool(tokenA, tokenB), proxyAB1);
1029+
assertEq(factoryCelo.getPool(tokenB, tokenC), proxyBC1);
10301030

10311031
// Verify reverse mappings don't exist
1032-
assertEq(factoryCelo.deployedFPMMs(tokenB, tokenA), address(0));
1033-
assertEq(factoryCelo.deployedFPMMs(tokenC, tokenB), address(0));
1032+
assertEq(factoryCelo.getPool(tokenB, tokenA), address(0));
1033+
assertEq(factoryCelo.getPool(tokenC, tokenB), address(0));
10341034

10351035
// Verify deployed addresses list
10361036
address[] memory deployedAddresses = factoryCelo.deployedFPMMAddresses();

0 commit comments

Comments
 (0)