Cleanup

Author: zgrguric

README.md

@@ -3,16 +3,15 @@
 [![Total Downloads](https://img.shields.io/packagist/dt/xrplwin/xrpl-orderbook-reader.svg?style=flat)](https://packagist.org/packages/xrplwin/xrpl-orderbook-reader)
 
 # XRPL Orderbook Reader for PHP
-
-This is PHP port of https://github.com/XRPL-Labs/XRPL-Orderbook-Reader by [Wietse Wind](https://github.com/WietseWind) ([@XRPL Labs](https://github.com/XRPL-Labs))
-
 This repository takes XRPL Orderbook (`book_offers`) datasets and requested volume to
 exchange and calculates the effective exchange rates based on the requested and available liquidity.
 
 Optionally certain checks can be specified (eg. `book_offers` on the other side of the book)
 to warn for limited (percentage) liquidity on the requested side, and possibly other side
 of the order book.
 
+This is PHP port of https://github.com/XRPL-Labs/XRPL-Orderbook-Reader by [Wietse Wind](https://github.com/WietseWind) ([@XRPL Labs](https://github.com/XRPL-Labs))
+
 # Note
 
 This package is provided as is, please test it yourself first.  
@@ -35,38 +34,47 @@ use \XRPLWin\XRPL\Client;
 
 $xrplwinapiclient = new Client([]);
 $lc = new LiquidityCheck([
-    # Trade:
-    'from' => [
-        'currency' => 'XRP'
-    ],
-    'to' => [
-        'currency' => 'USD',
-        'issuer' => 'rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq'
-    ],
-    'amount' => 10,
-    'limit' => 100
+  # Trade:
+  'from' => [
+    'currency' => 'XRP'
+  ],
+  'amount' => 10,
+  'to' => [
+    'currency' => 'USD',
+    'issuer' => 'rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq'
+  ],  
 ],
 [
-    # Options:
-    //'rates' => 'to',
-    //'maxSpreadPercentage' => 4
-    //'maxSlippagePercentage' => 3
-    //'maxSlippagePercentageReverse' => 3
-    'includeBookData' => true //default false
+  # Options:
+  //'rates' => 'to',
+  //'maxSpreadPercentage' => 4,
+  //'maxSlippagePercentage' => 3,
+  //'maxSlippagePercentageReverse' => 3,
+  //'maxBookLines' => 500,
+  'includeBookData' => true //default false
 ], $xrplwinapiclient);
 
 try {
-    $Liquidity = $lc->get();
+  $Liquidity = $lc->get();
 } catch (\Exception) {
-    //Unable to connect to provided XRPL server...
-    $Liquidity = [
-        'rate' => null,
-        'safe' => false,
-        'errors' => ['CONNECT_ERROR']
-    ];
+  //Unable to connect to provided XRPL server...
+  $Liquidity = [
+    'rate' => null,
+    'safe' => false,
+    'errors' => ['CONNECT_ERROR']
+  ];
 }
 
-print_r($Liquidity); //['rate' => NUMBER, 'safe' => BOOLEAN, 'errors' => ARRAY, 'books' => ARRAY]
+print_r($Liquidity); 
+/**
+ * [
+ *   'rate' => NUMBER,
+ *   'safe' => BOOLEAN,
+ *   'errors' => ARRAY,
+ *   'books' => ARRAY
+ * ]
+ **/
+//
 ```
 ## Running tests
 Run all tests in "tests" directory.
@@ -80,4 +88,4 @@ or
 
 ### Sample
 
-See [dev.php](dev.php) for sample.
+See [sample.php](sample.php)

dev.php sample.phpdev.php renamed to sample.php

@@ -16,15 +16,7 @@ class LiquidityCheck
   const ERROR_MAX_SLIPPAGE_EXCEEDED = 'MAX_SLIPPAGE_EXCEEDED';
   const ERROR_MAX_REVERSE_SLIPPAGE_EXCEEDED = 'MAX_REVERSE_SLIPPAGE_EXCEEDED';
 
-  const PRECISION = 17;
-  /**
-   * PRECISION_CAPPED:
-   * Due to divisions, calculated values must be rounded to PRECISION, 
-   * sum of fields _I_Spend_Capped and _I_Get_Capped can be very close approximation of 
-   * TradeAmount. To create correct comparison of TradeAmount === _I_Spend_Capped or _I_Get_Capped,
-   * those fields are rounded to ROUNDING_MODE of PRECISION_CAPPED precision.
-   */
-  const PRECISION_CAPPED = 10;
+  const NATURAL_PRECISION = 17;
   const ROUNDING_MODE = RoundingMode::HALF_UP;
 
   protected XRPLWinClient $client;
@@ -270,7 +262,7 @@ private function detectErrors(array $book, array $bookReversed): array
     }
 
     if($this->options['maxSpreadPercentage']) {
-      $spread = BigDecimal::one()->minus(  $startRate->dividedBy($startRateReverse,self::PRECISION,self::ROUNDING_MODE) )->multipliedBy(100)->abs();
+      $spread = BigDecimal::one()->minus(  $startRate->dividedBy($startRateReverse,self::NATURAL_PRECISION,self::ROUNDING_MODE) )->multipliedBy(100)->abs();
 
       //todo: log
 
@@ -279,7 +271,7 @@ private function detectErrors(array $book, array $bookReversed): array
     }
 
     if($this->options['maxSlippagePercentage']) {
-      $slippage = BigDecimal::one()->minus(  $startRate->dividedBy($finalRate,self::PRECISION,self::ROUNDING_MODE) )->multipliedBy(100)->abs();
+      $slippage = BigDecimal::one()->minus(  $startRate->dividedBy($finalRate,self::NATURAL_PRECISION,self::ROUNDING_MODE) )->multipliedBy(100)->abs();
       //die((string)$finalRate);
       //todo: log
 
@@ -288,7 +280,7 @@ private function detectErrors(array $book, array $bookReversed): array
     }
 
     if($this->options['maxSlippagePercentageReverse']) {
-      $slippage = BigDecimal::one()->minus(  $startRateReverse->dividedBy($finalRateReverse,self::PRECISION,self::ROUNDING_MODE) )->multipliedBy(100)->abs();
+      $slippage = BigDecimal::one()->minus(  $startRateReverse->dividedBy($finalRateReverse,self::NATURAL_PRECISION,self::ROUNDING_MODE) )->multipliedBy(100)->abs();
 
       //todo: log
 

src/LiquidityCheck.php

@@ -200,7 +200,7 @@ public static function parse(array $offers, array $from, array $to, mixed $amoun
       unset($v['_I_Spend']);
       unset($v['_I_Get']);
       unset($v['taker_pays_funded']);
-
+      unset($v['taker_gets_funded']);
       unset($v['index']);
       unset($v['owner_funds']);
       unset($v['quality']);

src/LiquidityParser.php

@@ -367,7 +367,7 @@ public function renderTable(array $data): void
 
           } else {
             $table->addColumn(
-              'Value: '.$v->value
+              $v->value
             );
           }
         }