(fix): use lp tokens and fix burns not working correctly

Author: markharding

Diff for: Controllers/Cli/Blockchain.php

@@ -153,7 +153,7 @@ public function uniswap_user()
         $username = $this->getOpt('username');
         $user = new \Minds\Entities\User($username);
         //$address = '0x177fd9efd24535e73b81e99e7f838cdef265e6cb';
-        $address = strtolower('0x1c4830fD39a9C7B72f0F745Bb16026225744E966');
+        $address = strtolower('0x678e47Ad94eF3bBBc306374f6418fD6193B179D4');
 
         $uniswap = Di::_()->get('Blockchain\Uniswap\Client');
         $response = $uniswap->getUser($address);
@@ -174,18 +174,30 @@ public function uniswap_mints()
     public function liquidity_share()
     {
         $username = $this->getOpt('username');
-        $user = new \Minds\Entities\User($username);
+        $user = Di::_()->get('EntitiesBuilder')->getByUserByIndex($username);
 
         $liquidityManager = Di::_()->get('Blockchain\LiquidityPositions\Manager')
             ->setUser($user);
 
         var_dump($liquidityManager->getLiquidityTokenShare());
     }
 
+    public function liquidity_summary()
+    {
+        $username = $this->getOpt('username');
+        $user = Di::_()->get('EntitiesBuilder')->getByUserByIndex($username);
+
+        $liquidityManager = Di::_()->get('Blockchain\LiquidityPositions\Manager')
+            ->setUser($user)
+            ->setChainId(Util::ETHEREUM_CHAIN_ID);
+
+        var_dump($liquidityManager->getSummary());
+    }
+
     public function liquidity_providers_summaries()
     {
         $liquidityManager = Di::_()->get('Blockchain\LiquidityPositions\Manager');
-        $summaries = $liquidityManager->getAllProvidersSummaries();
+        $summaries = $liquidityManager->setChainId(Util::ETHEREUM_CHAIN_ID)->getAllProvidersSummaries();
         var_dump($summaries);
     }
 

Diff for: Core/Blockchain/LiquidityPositions/LiquidityPositionSummary.php

@@ -24,6 +24,8 @@
  * @method self setLiquiditySpotOptOut(bool $optOut)
  * @method bool getLiquiditySpotOptOut()
  * @method bool isLiquiditySpotOptOut()
+ * @method self setLpPosition(BigDecimal $lpPosition)
+ * @method BigDecimal getLpPosition()
  */
 class LiquidityPositionSummary
 {
@@ -52,6 +54,8 @@ class LiquidityPositionSummary
 
     /** @var LiquidityCurrencyValues */
     protected $shareOfLiquidity;
+    
+    protected BigDecimal $lpPosition;
 
     /** @var bool */
     protected $liquiditySpotOptOut = false;

Diff for: Core/Blockchain/LiquidityPositions/Manager.php

@@ -148,6 +148,8 @@ public function getSummary(): LiquidityPositionSummary
 
         $tokenSharePct = $providedLiquidityMINDS->dividedBy($totalLiquidityTokens, null, RoundingMode::FLOOR);
 
+        $mintsToLPPosition = BigDecimal::sum(...(array_map([$this, 'uniswapMintsToLPPosition'], $approvedMints) ?: [0]));
+        $burnsToLPPosition = BigDecimal::sum(...(array_map([$this, 'uniswapMintsToLPPosition'], $approvedBurns) ?: [0]));
 
         //
         // Total liquidity
@@ -165,6 +167,9 @@ public function getSummary(): LiquidityPositionSummary
         // Share of liquidity
         //
 
+        // This is the number of LP tokens a user holders. We use this for rewards.
+        $lpPosition = $mintsToLPPosition->minus($burnsToLPPosition);
+
         $shareOfLiquidityMINDS = $providedLiquidityMINDS->dividedBy($totalLiquidityMINDS, null, RoundingMode::FLOOR);
         $shareOfLiquidityUSD = $providedLiquidityUSD->dividedBy($totalLiquidityUSD, null, RoundingMode::FLOOR);
 
@@ -187,6 +192,7 @@ public function getSummary(): LiquidityPositionSummary
                     ->setUsd($shareOfLiquidityUSD)
                     ->setMinds($shareOfLiquidityMINDS)
             )
+            ->setLpPosition($lpPosition)
             ->setLiquiditySpotOptOut($this->user->isLiquiditySpotOptOut() || count($this->user->getNsfw()));
 
         // How to calculate a multiplier
@@ -299,4 +305,14 @@ private function uniswapMintsToMINDS(UniswapMintEntity $uniswapMint): BigDecimal
         // Verifying ->getPair()->getToken0()->getId() should be able to do this?
         return $uniswapMint->getAmount0();
     }
+
+    /**
+     * To be used by PHP array_map as callback
+     * @param UniswapMintEntity $uniswapMint
+     * @return BigDecimal
+     */
+    private function uniswapMintsToLPPosition(UniswapMintEntity $uniswapMint): BigDecimal
+    {
+        return $uniswapMint->getLiquidity();
+    }
 }

Diff for: Core/Blockchain/Uniswap/Client.php

@@ -70,7 +70,7 @@ public function getUser(string $id, int $asOf = null): UniswapUserEntity
                       reserveUSD
                     }
                 }
-                burns(where: { to: $id}) {
+                burns(where: { sender: $id}) {
                     id
                     to
                     amount0

Diff for: Core/Rewards/Manager.php

@@ -239,7 +239,7 @@ public function calculate(RewardsQueryOpts $opts = null): void
                         $liquidityScores[$liquiditySummary->getUserGuid()] = BigDecimal::of(0);
                     }
 
-                    $liquidityScores[$liquiditySummary->getUserGuid()] = $liquidityScores[$liquiditySummary->getUserGuid()]->plus($liquiditySummary->getProvidedLiquidity()->getUsd());
+                    $liquidityScores[$liquiditySummary->getUserGuid()] = $liquidityScores[$liquiditySummary->getUserGuid()]->plus($liquiditySummary->getLpPosition());
                 }
             }
 

Diff for: Spec/Core/Blockchain/LiquidityPositions/ManagerSpec.php

@@ -96,11 +96,13 @@ public function it_should_return_liquidity_share(User $user)
         // so we calculate a 100% yield
         $uniswapUser->setMints([
             (new UniswapMintEntity()) // 20% of pool
+                ->setLiquidity(BigDecimal::of(0.5))
                 ->setAmount0(BigDecimal::of(0.25))
                 ->setAmount1(BigDecimal::of(0.5))
                 ->setAmountUSD(BigDecimal::of(0.5))
                 ->setPair($pairs[0]),
             (new UniswapMintEntity()) // 5% of pool
+                ->setLiquidity(BigDecimal::of(0.5))
                 ->setAmount0(BigDecimal::of(0.125)) // 50% of 0.5 (the pair2 amount)
                 ->setAmount1(BigDecimal::of(0.25))
                 ->setAmountUSD(BigDecimal::of(0.25))
@@ -110,6 +112,7 @@ public function it_should_return_liquidity_share(User $user)
         // We burn 5% of our initially provided supply, giving us 20% in total
         $uniswapUser->setBurns([
             (new UniswapBurnEntity()) // 5% of pool
+                ->setLiquidity(BigDecimal::of(0.5))
                 ->setAmount0(BigDecimal::of(0.125)) // 50% of 0.5 (the pair2 amount)
                 ->setAmount1(BigDecimal::of(0.25))
                 ->setAmountUSD(BigDecimal::of(0.25))

Diff for: Spec/Core/Rewards/ManagerSpec.php

@@ -144,10 +144,8 @@ public function it_should_calculate_rewards()
                 ->willReturn([
                     (new LiquidityPositionSummary())
                         ->setUserGuid('123')
-                        ->setProvidedLiquidity(
-                            (new LiquidityCurrencyValues())
-                                ->setUsd(BigDecimal::of(10))
-                                ->setMinds(BigDecimal::of(10))
+                        ->setLpPosition(
+                            BigDecimal::of(10)
                         ),
                 ]);
 
@@ -240,10 +238,8 @@ public function it_should_calculate_holding_rewards_when_balance_already_populat
                 ->willReturn([
                     (new LiquidityPositionSummary())
                         ->setUserGuid('123')
-                        ->setProvidedLiquidity(
-                            (new LiquidityCurrencyValues())
-                                ->setUsd(BigDecimal::of(10))
-                                ->setMinds(BigDecimal::of(10))
+                        ->setLpPosition(
+                            BigDecimal::of(10)
                         ),
                 ]);