From 4d53d2a9c7f84d777d683d1efd4abe5d309eef3b Mon Sep 17 00:00:00 2001
From: dianakocsis <diana.kocsis@uniswap.org>
Date: Tue, 24 Sep 2024 12:04:48 -0400
Subject: [PATCH] comments, selector, and reference

---
 src/PositionDescriptor.sol          | 1 +
 src/libraries/AddressStringUtil.sol | 1 +
 src/libraries/SafeERC20Namer.sol    | 7 ++++---
 3 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/src/PositionDescriptor.sol b/src/PositionDescriptor.sol
index 4b318e16..b7ee4d84 100644
--- a/src/PositionDescriptor.sol
+++ b/src/PositionDescriptor.sol
@@ -51,6 +51,7 @@ contract PositionDescriptor is IPositionDescriptor {
         (PoolKey memory poolKey, PositionInfo positionInfo) = positionManager.getPoolAndPositionInfo(tokenId);
         (, int24 tick,,) = poolManager.getSlot0(poolKey.toId());
 
+        // If possible, flip currencies to get the larger currency as the base currency, so that the price (quote/base) is more readable
         // flip if currency0 priority is greater than currency1 priority
         bool _flipRatio = flipRatio(Currency.unwrap(poolKey.currency0), Currency.unwrap(poolKey.currency1));
 
diff --git a/src/libraries/AddressStringUtil.sol b/src/libraries/AddressStringUtil.sol
index bb6aff30..b80404c8 100644
--- a/src/libraries/AddressStringUtil.sol
+++ b/src/libraries/AddressStringUtil.sol
@@ -3,6 +3,7 @@ pragma solidity ^0.8.20;
 
 /// @title AddressStringUtil
 /// @notice provides utility functions for converting addresses to strings
+/// @dev Reference: https://github.com/Uniswap/solidity-lib/blob/master/contracts/libraries/AddressStringUtil.sol
 library AddressStringUtil {
     /// @notice Converts an address to the uppercase hex string, extracting only len bytes (up to 20, multiple of 2)
     /// @param addr the address to convert
diff --git a/src/libraries/SafeERC20Namer.sol b/src/libraries/SafeERC20Namer.sol
index 47764d2c..c1b07070 100644
--- a/src/libraries/SafeERC20Namer.sol
+++ b/src/libraries/SafeERC20Namer.sol
@@ -1,11 +1,13 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.20;
 
+import "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 import "./AddressStringUtil.sol";
 
 /// @title SafeERC20Namer
 /// @notice produces token descriptors from inconsistent or absent ERC20 symbol implementations that can return string or bytes32
 /// this library will always produce a string symbol to represent the token
+/// @dev Reference: https://github.com/Uniswap/solidity-lib/blob/master/contracts/libraries/SafeERC20Namer.sol
 library SafeERC20Namer {
     function bytes32ToString(bytes32 x) private pure returns (string memory) {
         bytes memory bytesString = new bytes(32);
@@ -37,7 +39,7 @@ library SafeERC20Namer {
     /// @return the token symbol
     function callAndParseStringReturn(address token, bytes4 selector) private view returns (string memory) {
         (bool success, bytes memory data) = token.staticcall(abi.encodeWithSelector(selector));
-        // if not implemented, or returns empty data, return empty string
+        // if not implemented, return empty string
         if (!success) {
             return "";
         }
@@ -55,8 +57,7 @@ library SafeERC20Namer {
     /// @param token the token address
     /// @return the token symbol
     function tokenSymbol(address token) internal view returns (string memory) {
-        // 0x95d89b41 = bytes4(keccak256("symbol()"))
-        string memory symbol = callAndParseStringReturn(token, 0x95d89b41);
+        string memory symbol = callAndParseStringReturn(token, IERC20Metadata.symbol.selector);
         if (bytes(symbol).length == 0) {
             // fallback to 6 uppercase hex of address
             return addressToSymbol(token);