README

Logo of Hive PHP Lib

This library offers your a set of PHP functions to interact with HIVE blockchain & Hive Engine sidechain.

NOTE : This version does not contains all cryptographic functions (for keys, signature, ...). They will be added after.

Features

Very easy to install & use,
No more external dependencies than PHP (>=7.4) and cURL,
Debug mode with request & result display,
PSR-1, PSR-12 and PHP-PDS compliant.

Installation

Install this library with Composer :

composer require hive/hive-php-lib

Include autoloader and load the classes you need :

require __DIR__ . '/vendor/autoload.php';

use Hive\PhpLib\Hive\Condenser as HiveCondenser;
use Hive\PhpLib\HiveEngine\Blockchain as HeBlockchain;

Create the $config array with your settings :

$config = [
    "debug" => false,
    "disableSsl" => false,
    "heNode" => "api.hive-engine.com/rpc",
    "hiveNode" => "anyx.io",
    "throwExceptions" => false
];

HiveLib style

Init API :

$hiveApi = new HiveCondenser($config); // For Hive Condenser API
$heApi = new HeBlockchain($config); // For HiveEngine API Blockchain methods

You can now use all methods in the selected API :

$result = $hiveApi->findProposal(211); // Condenser Hive API
$result = $heApi->getStatus(); // Blockchain HiveEngine API

Raw style

You can also use the raw style. Just init the Layer instead the API and use call() function :

use Hive\PhpLib\HiveLayer as HiveLayer;

$layer = new HiveLayer($config);
$result = $layer->call('condenser_api.get_accounts', [["unklebonehead"]]);

If you want the full raw style methods list, please check:

HIVE API deffinitions page.
HiveEngine Dev Portal

Documentation

All the documentation can be found here.

Examples

There is a small example page into the resources/example/ folder.

Contributing

Please see CONTRIBUTING for details.

You can also join the Discord server to talk with the team, make feedback or ask questions and get support.

License

Please see the License File for more information about license.

Thanks

Dragos Roua who made the PHP Hive Tools lib,
Mahdi Yari, who create hive-php lib,
Unkle Bonehead, the crazy beta tester who break many things,
Paiva with his contributions,
All the BBC Discord members for the support.

hive / hive-php-lib

Maintainers

Details