Position descriptor

.forge-snapshots/PositionManager_burn_empty.snap

@@ -1 +1 @@
-50413
+50481

.forge-snapshots/PositionManager_burn_empty_native.snap

@@ -1 +1 @@
-50413
+50481

.forge-snapshots/PositionManager_burn_nonEmpty_native_withClose.snap

@@ -1 +1 @@
-125541
+125609

.forge-snapshots/PositionManager_burn_nonEmpty_native_withTakePair.snap

@@ -1 +1 @@
-124988
+125056

.forge-snapshots/PositionManager_burn_nonEmpty_withClose.snap

@@ -1 +1 @@
-132394
+132462

.forge-snapshots/PositionManager_burn_nonEmpty_withTakePair.snap

@@ -1 +1 @@
-131841
+131909

.forge-snapshots/PositionManager_collect_native.snap

@@ -1 +1 @@
-146241
+146326

.forge-snapshots/PositionManager_collect_sameRange.snap

@@ -1 +1 @@
-154807
+154892

.forge-snapshots/PositionManager_collect_withClose.snap

@@ -1 +1 @@
-154807
+154892

.forge-snapshots/PositionManager_collect_withTakePair.snap

@@ -1 +1 @@
-154128
+154213

.forge-snapshots/PositionManager_decreaseLiquidity_native.snap

@@ -1 +1 @@
-111938
+112006

.forge-snapshots/PositionManager_decreaseLiquidity_withClose.snap

@@ -1 +1 @@
-119688
+119773

.forge-snapshots/PositionManager_decreaseLiquidity_withTakePair.snap

@@ -1 +1 @@
-119009
+119094

.forge-snapshots/PositionManager_decrease_burnEmpty.snap

@@ -1 +1 @@
-135191
+135259

.forge-snapshots/PositionManager_decrease_burnEmpty_native.snap

@@ -1 +1 @@
-128338
+128406

.forge-snapshots/PositionManager_decrease_sameRange_allLiquidity.snap

@@ -1 +1 @@
-132375
+132460

.forge-snapshots/PositionManager_decrease_take_take.snap

@@ -1 +1 @@
-120264
+120349

.forge-snapshots/PositionManager_increaseLiquidity_erc20_withClose.snap

@@ -1 +1 @@
-158992
+159077

.forge-snapshots/PositionManager_increaseLiquidity_erc20_withSettlePair.snap

@@ -1 +1 @@
-157932
+158017

.forge-snapshots/PositionManager_increaseLiquidity_native.snap

@@ -1 +1 @@
-140819
+140904

.forge-snapshots/PositionManager_increase_autocompoundExactUnclaimedFees.snap

@@ -1 +1 @@
-136318
+136403

.forge-snapshots/PositionManager_increase_autocompoundExcessFeesCredit.snap

@@ -1 +1 @@
-177299
+177384

.forge-snapshots/PositionManager_increase_autocompound_clearExcess.snap

@@ -1 +1 @@
-147975
+148060

.forge-snapshots/PositionManager_mint_native.snap

@@ -1 +1 @@
-364680
+364765

.forge-snapshots/PositionManager_mint_nativeWithSweep_withClose.snap

@@ -1 +1 @@
-373203
+373288

.forge-snapshots/PositionManager_mint_nativeWithSweep_withSettlePair.snap

@@ -1 +1 @@
-372426
+372511

.forge-snapshots/PositionManager_mint_onSameTickLower.snap

@@ -1 +1 @@
-317528
+317613

.forge-snapshots/PositionManager_mint_onSameTickUpper.snap

@@ -1 +1 @@
-318198
+318283

.forge-snapshots/PositionManager_mint_sameRange.snap

@@ -1 +1 @@
-243767
+243852

.forge-snapshots/PositionManager_mint_settleWithBalance_sweep.snap

@@ -1 +1 @@
-418947
+419032

.forge-snapshots/PositionManager_mint_warmedPool_differentRange.snap

@@ -1 +1 @@
-323559
+323644

.forge-snapshots/PositionManager_mint_withClose.snap

@@ -1 +1 @@
-420081
+420166

.forge-snapshots/PositionManager_mint_withSettlePair.snap

@@ -1 +1 @@
-419139
+419224

.forge-snapshots/PositionManager_multicall_initialize_mint.snap

@@ -1 +1 @@
-464241
+464348

.forge-snapshots/PositionManager_permit.snap

@@ -1 +1 @@
-79076
+79064

.forge-snapshots/PositionManager_unsubscribe.snap

@@ -1 +1 @@
-59238
+59260

script/DeployPositionDescriptor.s.sol

@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.20;
+
+import "forge-std/console2.sol";
+import "forge-std/Script.sol";
+
+import {IPoolManager} from "@uniswap/v4-core/src/interfaces/IPoolManager.sol";
+import {PositionDescriptor} from "../src/PositionDescriptor.sol";
+
+contract DeployPositionDescriptorTest is Script {
+    function setUp() public {}
+
+    function run(address poolManager, address weth, string memory nativeCurrencyLabel)
+        public
+        returns (PositionDescriptor positionDescriptor)
+    {
+        vm.startBroadcast();
+
+        positionDescriptor = new PositionDescriptor(IPoolManager(poolManager), weth, nativeCurrencyLabel);
+        console2.log("PositionDescriptor", address(positionDescriptor));
+
+        vm.stopBroadcast();
+    }
+}

script/DeployPosm.s.sol

@@ -8,18 +8,22 @@ import {IPoolManager} from "@uniswap/v4-core/src/interfaces/IPoolManager.sol";
 import {StateView} from "../src/lens/StateView.sol";
 import {PositionManager} from "../src/PositionManager.sol";
 import {IAllowanceTransfer} from "permit2/src/interfaces/IAllowanceTransfer.sol";
+import {IPositionDescriptor} from "../src/interfaces/IPositionDescriptor.sol";
 
 contract DeployPosmTest is Script {
     function setUp() public {}
 
-    function run(address poolManager, address permit2, uint256 unsubscribeGasLimit)
+    function run(address poolManager, address permit2, uint256 unsubscribeGasLimit, address positionDescriptor)
         public
         returns (PositionManager posm)
     {
         vm.startBroadcast();
 
         posm = new PositionManager{salt: hex"03"}(
-            IPoolManager(poolManager), IAllowanceTransfer(permit2), unsubscribeGasLimit
+            IPoolManager(poolManager),
+            IAllowanceTransfer(permit2),
+            unsubscribeGasLimit,
+            IPositionDescriptor(positionDescriptor)
         );
         console2.log("PositionManager", address(posm));
 

src/PositionDescriptor.sol

@@ -0,0 +1,132 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity 0.8.26;
+
+import {IPoolManager} from "@uniswap/v4-core/src/interfaces/IPoolManager.sol";
+import {Currency, CurrencyLibrary} from "@uniswap/v4-core/src/types/Currency.sol";
+import {IHooks} from "@uniswap/v4-core/src/interfaces/IHooks.sol";
+import {StateLibrary} from "@uniswap/v4-core/src/libraries/StateLibrary.sol";
+import {PoolKey} from "@uniswap/v4-core/src/types/PoolKey.sol";
+import {PoolId, PoolIdLibrary} from "@uniswap/v4-core/src/types/PoolId.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {IPositionManager} from "./interfaces/IPositionManager.sol";
+import {IPositionDescriptor} from "./interfaces/IPositionDescriptor.sol";
+import {PositionInfo, PositionInfoLibrary} from "./libraries/PositionInfoLibrary.sol";
+import {Descriptor} from "./libraries/Descriptor.sol";
+import {CurrencyRatioSortOrder} from "./libraries/CurrencyRatioSortOrder.sol";
+import {SafeERC20Namer} from "./libraries/SafeERC20Namer.sol";
+
+/// @title Describes NFT token positions
+/// @notice Produces a string containing the data URI for a JSON metadata string
+contract PositionDescriptor is IPositionDescriptor {
+    using StateLibrary for IPoolManager;
+    using PoolIdLibrary for PoolKey;
+    using CurrencyLibrary for Currency;
+    using PositionInfoLibrary for PositionInfo;
+
+    // mainnet addresses
+    address private constant DAI = 0x6B175474E89094C44Da98b954EedeAC495271d0F;
+    address private constant USDC = 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48;
+    address private constant USDT = 0xdAC17F958D2ee523a2206206994597C13D831ec7;
+    address private constant TBTC = 0x8dAEBADE922dF735c38C80C7eBD708Af50815fAa;
+    address private constant WBTC = 0x2260FAC5E5542a773Aa44fBCfeDf7C193bc2C599;
+
+    address public immutable WETH9;
+    string public nativeCurrencyLabel;
+
+    IPoolManager public immutable poolManager;
+
+    constructor(IPoolManager _poolManager, address _WETH9, string memory _nativeCurrencyLabel) {
+        poolManager = _poolManager;
+        WETH9 = _WETH9;
+        nativeCurrencyLabel = _nativeCurrencyLabel;
+    }
+
+    /// @inheritdoc IPositionDescriptor
+    function tokenURI(IPositionManager positionManager, uint256 tokenId)
+        external
+        view
+        override
+        returns (string memory)
+    {
+        (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));
+
+        // If not flipped, quote currency is currency1, base currency is currency0
+        // If flipped, quote currency is currency0, base currency is currency1
+        Currency quoteCurrency = !_flipRatio ? poolKey.currency1 : poolKey.currency0;
+        Currency baseCurrency = !_flipRatio ? poolKey.currency0 : poolKey.currency1;
+
+        return Descriptor.constructTokenURI(
+            Descriptor.ConstructTokenURIParams({
+                tokenId: tokenId,
+                quoteCurrency: quoteCurrency,
+                baseCurrency: baseCurrency,
+                quoteCurrencySymbol: quoteCurrency.isAddressZero()
+                    ? nativeCurrencyLabel
+                    : SafeERC20Namer.tokenSymbol(Currency.unwrap(quoteCurrency)),
+                baseCurrencySymbol: baseCurrency.isAddressZero()
+                    ? nativeCurrencyLabel
+                    : SafeERC20Namer.tokenSymbol(Currency.unwrap(baseCurrency)),
+                quoteCurrencyDecimals: quoteCurrency.isAddressZero()
+                    ? 18
+                    : IERC20Metadata(Currency.unwrap(quoteCurrency)).decimals(),
+                baseCurrencyDecimals: baseCurrency.isAddressZero()
+                    ? 18
+                    : IERC20Metadata(Currency.unwrap(baseCurrency)).decimals(),
+                flipRatio: _flipRatio,
+                tickLower: positionInfo.tickLower(),
+                tickUpper: positionInfo.tickUpper(),
+                tickCurrent: tick,
+                tickSpacing: poolKey.tickSpacing,
+                fee: poolKey.fee,
+                poolManager: address(poolManager),
+                hooks: address(poolKey.hooks)
+            })
+        );
+    }
+
+    /// @notice Returns true if currency0 has higher priority than currency1
+    /// @param currency0 The first currency
+    /// @param currency1 The second currency
+    /// @return flipRatio True if currency0 has higher priority than currency1
+    function flipRatio(address currency0, address currency1) public view returns (bool) {
+        return currencyRatioPriority(currency0) > currencyRatioPriority(currency1);
+    }
+
+    /// @notice Returns the priority of a currency.
+    /// For certain currencies on mainnet, the smaller the currency, the higher the priority
+    /// @param currency The currency
+    /// @return priority The priority of the currency
+    function currencyRatioPriority(address currency) public view returns (int256) {
+        // Currencies in order of priority on mainnet: USDC, USDT, DAI, ETH, WETH, TBTC, WBTC
+        // weth is different address on different chains. passed in constructor
+
+        // native currency
+        if (currency == address(0)) {
+            return CurrencyRatioSortOrder.DENOMINATOR;
+        }
+        if (currency == WETH9) {
+            return CurrencyRatioSortOrder.DENOMINATOR_2;
+        }
+        if (block.chainid == 1) {
+            if (currency == USDC) {
+                return CurrencyRatioSortOrder.NUMERATOR_MOST;
+            } else if (currency == USDT) {
+                return CurrencyRatioSortOrder.NUMERATOR_MORE;
+            } else if (currency == DAI) {
+                return CurrencyRatioSortOrder.NUMERATOR;
+            } else if (currency == TBTC) {
+                return CurrencyRatioSortOrder.DENOMINATOR_MORE;
+            } else if (currency == WBTC) {
+                return CurrencyRatioSortOrder.DENOMINATOR_MOST;
+            } else {
+                return 0;
+            }
+        }
+        return 0;
+    }
+}