README

PHP版本的XRPL订单簿阅读器

该仓库使用XRPL订单簿（book_offers）数据集和请求的交易量，基于请求和可用流动性计算有效汇率。

可选地，可以指定某些检查（例如，订单簿另一侧的book_offers）以警告请求侧（百分比）流动性有限，以及订单簿其他侧的流动性。

这是Wietse Wind（Wietse Wind）（@XRPL Labs）的https://github.com/XRPL-Labs/XRPL-Orderbook-Reader）的PHP端口。

注意

该软件包提供原样，请先自行测试。
发现bug？在此处报告问题

要求

PHP 8.1或更高版本
Composer

安装

要安装，请运行

composer require xrplwin/xrpl-orderbook-reader

用法

use \XRPLWin\XRPL\Client;

$xrplwinapiclient = new Client([]);
$lc = new LiquidityCheck([
  # Trade:
  'from' => [
    'currency' => 'XRP'
  ],
  'amount' => 10,
  'to' => [
    'currency' => 'USD',
    'issuer' => 'rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq'
  ],  
],
[
  # Options:
  //'rates' => 'to',
  //'maxSpreadPercentage' => 4,
  //'maxSlippagePercentage' => 3,
  //'maxSlippagePercentageReverse' => 3,
  //'maxBookLines' => 500,
  'includeBookData' => true //default false
], $xrplwinapiclient);

try {
  $Liquidity = $lc->get();
} catch (\Throwable) {
  //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
 * ]
 **/

运行测试

在"tests"目录中运行所有测试。

composer test

或

./vendor/bin/phpunit --testdox

示例

请参阅sample.php

xrplwin / xrpl-orderbook-reader

维护者

详细信息

README

PHP版本的XRPL订单簿阅读器

注意

要求

安装

用法

运行测试

示例