Standard Request

The package provides various way to call JSON-RPC methods.

You can use them interchangeably, if needed. However, if you don’t plan to unit-test your application, helper method is preferred as it’s easiest one to use.

Note: method names are case-insensitive, so getBlock() and getblock() will yield the same result.

Helper

Helper functions provide an easy way to call JSON-RPC methods. They are, however, make testing somewhat difficult and can cause name collisions.

The following example illustrates the use of bitcoind() helper to call the getBlock() method.

<?php

namespace App\Http\Controllers;

class BitcoinController extends Controller
{
  /**
   * Get block info.
   *
   * @return \Illuminate\Http\JsonResponse
   */
   public function blockInfo()
   {
      $hash = '000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f';
      $block = bitcoind()->getBlock($hash);
      return response()->json($block->get());
   }
}

Trait

Using traits makes a clear declaration of class dependence and, if needed, traits could be easily replaced via namespace.

The following example illustrates the use of Denpa\Bitcoin\Traits\Bitcoind trait to call the getBlock() method.

<?php

namespace App\Http\Controllers;

use Denpa\Bitcoin\Traits\Bitcoind;

class BitcoinController extends Controller
{
  use Bitcoind;

  /**
   * Get block info.
   *
   * @return \Illuminate\Http\JsonResponse
   */
   public function blockInfo()
   {
      $hash = '000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f';
      $block = $this->bitcoind()->getBlock($hash);
      return response()->json($block->get());
   }
}

Facade

Facades provide a convenient way to make calls and Laravel makes them easy to mock. However, they are using static calls which in some cases might be undesirable.

The following example illustrates the use of Denpa\Bitcoin\Facades\Bitcoind facade to call the getBlock() method:

<?php

namespace App\Http\Controllers;

use Denpa\Bitcoin\Facades\Bitcoind;

class BitcoinController extends Controller
{
  /**
   * Get block info.
   *
   * @return \Illuminate\Http\JsonResponse
   */
   public function blockInfo()
   {
      $hash = '000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f';
      $block = Bitcoind::getBlock($hash);
      return response()->json($block->get());
   }
}

Automatic Injection

Automatic injection are easiest of bunch to test and, as with traits, is considered by many to be preferred way to access class dependencies due to explicit declaration.

The following example illustrates the use of automatic injection by type-hinting \Denpa\Bitcoin\ClientFactory to call the getBlock() method:

<?php

namespace App\Http\Controllers;

use Denpa\Bitcoin\LaravelClient as BitcoinClient;

class BitcoinController extends Controller
{
  /**
   * Get block info.
   *
   * @param  \Denpa\Bitcoin\Client  $bitcoind
   * @return \Illuminate\Http\JsonResponse
   */
   public function blockInfo(BitcoinClient $bitcoind)
   {
      $hash = '000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f';
      $block = $bitcoind->getBlock($hash);
      return response()->json($block->get());
   }
}

Note on multiple configurations

When using automatic injection with more than one configuration defined in config file, you should type-hint Denpa\Bitcoin\ClientFactory instead of Denpa\Bitcoin\Client to use client() method.

<?php

namespace App\Http\Controllers;

use Denpa\Bitcoin\ClientFactory;

class LitecoinController extends Controller
{
  /**
   * Get block info from litecoin.
   *
   * @param  \Denpa\Bitcoin\ClientFactory  $factory
   * @return \Illuminate\Http\JsonResponse
   */
   public function litecoinBlockInfo(ClientFactory $factory)
   {
      $hash = '3e68d2f1e226cd78dc595b5432b5f00db5d89fc1ddf525d55176a84af65fa0b0';
      $litecoind = $factory->client('litecoin');
      $block = $litecoind->getBlock($hash);
      return response()->json($block->get());
   }
}

See Multiple Daemons section to learn more about defining and using multiple configurations.