README

一个用于访问多个不同矿池账户的实时余额和算力数据的库，由 Openclerk 和 CryptFolio 使用。

此库扩展了由 openclerk/currencies 提供的抽象货币定义和由 openclerk/accounts 提供的抽象账户定义。

安装

在您的项目 composer.json 中将 openclerk/mining-pools 包作为依赖项，然后运行 composer update 将其安装到您的项目中

{
  "require": {
    "openclerk/mining-pools": "dev-master"
  }
}

• 支持的矿池

使用

首先，根据 openclerk/currencies 定义一种从三位代码加载货币实例的方式

use \DiscoveredComponents\Currencies;
use \Openclerk\Currencies\Currency;
use \Openclerk\Currencies\CurrencyFactory;

class DiscoveredCurrencyFactory implements CurrencyFactory {

  /**
   * @return a {@link Currency} for the given currency code, or {@code null}
   *   if none could be found
   */
  public function loadCurrency($cur) {
    if (Currencies::hasKey($cur)) {
      return Currencies::getInstance($cur);
    }
    return null;
  }

}

获取矿池支持的货币

use \Monolog\Logger;

$logger = new Logger("log");
$factory = new DiscoveredCurrencyFactory();

$instance = new Account\MiningPool\Slush();
print_r($instance->fetchSupportedCurrencies($factory, $logger));
// returns ['btc', 'nmc']

获取矿池账户的当前余额（已确认、未确认、预估）和算力

use \Monolog\Logger;

$logger = new Logger("log");
$factory = new DiscoveredCurrencyFactory();

$instance = new Account\MiningPool\Slush();

$account = array(
  'api_token' => '270245-e26365e4ca8f97ddde8c76a23ec18758',
);

$balances = $instance->fetchBalances($account, $factory, $logger);
echo $balances['btc']['confirmed'];     // in BTC
echo $balances['btc']['unconfirmed'];
echo $balances['btc']['estimated'];
echo $balances['btc']['hashrate'];      // in MH/s
echo $balances['nmc']['confirmed'];     // in NMC
echo $balances['nmc']['unconfirmed'];
echo $balances['nmc']['estimated'];
echo $balances['nmc']['hashrate'];      // in MH/s

测试

每个矿池都附带一系列测试来检查每个相关服务。

composer install
vendor/bin/phpunit

要运行单个矿池的测试

vendor/bin/phpunit --bootstrap "vendor/autoload.php" test/SlushTest

要获取测试的调试输出（例如 CURL 请求和解码输出），请将 --debug 开关添加到您的 vendor/bin/phpunit 命令中。

捐赠

捐赠受赞赏.

贡献

欢迎贡献包含新矿池的拉取请求。

确保您还提供了一个相关的测试套件，以便矿池可以自动进行测试。

待办事项

1. 自动生成矿池的 README 列表
2. 链接到 CryptFolio 的实时 API
3. CI 构建服务器和测试结果链接