Hive-PHP - A real PHP library for Hive

<h1>Hive-PHP <p dir="auto">This one took a while despite having some demand from PHP developers. But it is finally here. <p dir="auto">The serialization and signing are done natively on PHP. Every line of code has been written by me. <p dir="auto">I did not test all the operations but all the operations should work. Please do test if you can and let me know if there are any problems. <p dir="auto">The documentation is available on both gitlab and packagist. But for the sake of keeping them on blockchain will put them here too. <hr /> <h3>Installation <pre><code>composer require mahdiyari/hive-php <h3>Initialization <pre><code>$hive = new Hive($options?); <p dir="auto">Example: <pre><code>include 'vendor/autoload.php'; use Hive\Hive; $hive = new Hive(); // or // default options - these are already configured $options = array( 'rpcNodes'=> [ 'https://api.hive.blog', 'https://rpc.ausbit.dev', 'https://rpc.ecency.com', 'https://api.pharesim.me', 'https://api.deathwing.me' ], 'chainId'=> 'beeab0de00000000000000000000000000000000000000000000000000000000', 'timeout'=> 7 ); // Will try the next node after 7 seconds of waiting for response // Or on a network failure $hive = new Hive($options); <h3>Usage <h3>API calls: <pre><code>$hive->call($method, $params); <p dir="auto">Example: <pre><code>$result = $hive->call('condenser_api.get_accounts', '[["mahdiyari"]]'); // returns the result as an array echo $result[0]['name']; // "mahdiyari" echo $result[0]['hbd_balance']; // "123456.000 HBD" <h3>Private Key: <pre><code>$hive->privateKeyFrom($string); $hive->privateKeyFromLogin($username, $password, $role); <p dir="auto">Example: <pre><code>$privateKey = $hive->privateKeyFrom('5JRaypasxMx1L97ZUX7YuC5Psb5EAbF821kkAGtBj7xCJFQcbLg'); // or $privateKey = $hive->privateKeyFromLogin('username', 'hive password', 'role'); // role: "posting" or "active" or etc echo $privateKey->stringKey; // 5JRaypasxMx1L97ZUX7YuC5Psb5EAbF821kkAGtBj7xCJFQcbLg <h3>Public Key: <pre><code>$hive->publicKeyFrom($string); $privateKey->createPublic() <p dir="auto">Example: <pre><code>$publicKey = $hive->publicKeyFrom('STM6aGPtxMUGnTPfKLSxdwCHbximSJxzrRjeQmwRW9BRCdrFotKLs'); // or $publicKey = $privateKey->createPublic(); echo $publicKey->toString(); // STM6aGPtxMUGnTPfKLSxdwCHbximSJxzrRjeQmwRW9BRCdrFotKLs <h3>Signing <pre><code>$privateKey->sign($hash256); <p dir="auto">Example: <pre><code>$message = hash('sha256', 'My super cool message to be signed'); $signature = $privateKey->sign($message); echo $signature; // 1f8e46aa5cbc215f82119e172e3dd73396ad0d2231619d3d71688eff73f2b83474084eb970955d1f1f9c2a7281681d138ca49fe90ac58bf069549afe961685d932 <h3>Verifying <pre><code>$publicKey->verify($hash256, $signature); <p dir="auto">Example: <pre><code>$verified = $publicKey->verify($message, $signature); var_dump($verified); // bool(true) <h3>Transactions <p dir="auto">There are two ways to broadcast a transaction. <h4>Manual broadcast <p dir="auto">Example: <pre><code>$vote = new stdClass; $vote->voter = 'guest123'; $vote->author = 'blocktrades'; $vote->permlink = '11th-update-of-2022-on-blocktrades-work-on-hive-software'; $vote->weight = 5000; $op = array("vote", $vote); // transaction built $trx = $hive->createTransaction([$op]); // transaction signed $hive->signTransaction($trx, $privateKey); // will return trx_id on success $result = $hive->broadcastTransaction($trx); var_dump($result); // array(1) { // 'trx_id' => // string(40) "2062bb47ed0c4c001843058129470fe5a8211735" // } <h4>Inline broadcast <p dir="auto">Example: <pre><code>$result = $hive->broadcast($privateKey, 'vote', ['guest123', 'blocktrades', '11th-update-of-2022-on-blocktrades-work-on-hive-software', 5000]); var_dump($result); // array(1) { // 'trx_id' => // string(40) "2062bb47ed0c4c001843058129470fe5a8211735" // } <h3>Notes for Transactions <p dir="auto">Operations are in the following format when broadcasting manually: <pre><code>array('operation_name', object(operation_params)) <p dir="auto">example: <pre><code>$vote = new stdClass; $vote->voter = 'guest123'; $vote->author = 'blocktrades'; $vote->permlink = '11th-update-of-2022-on-blocktrades-work-on-hive-software'; $vote->weight = 5000; $op = array("vote", $vote); <p dir="auto">Any parameter in opreation that is JSON (not to be confused with json strings), should be passed as an object. <p dir="auto">Example: <p dir="auto">The <code>beneficiaries field in <code>comment_options is in JSON format like this: <pre><code>$beneficiaries = '[0, {"beneficiaries": [{"account": "mahdiyari","weight": 10000}]}]'; <p dir="auto">We should convert that into an object. <pre><code>$beneficiaries = json_decode($beneficiaries); <p dir="auto">(beneficiaries go inside the extensions) <pre><code>$result = $hive->broadcast($privateKey, 'comment_options', ['author', 'permlink', '1000000.000 HBD', 10000, true, true, [$beneficiaries]]); <hr /> <h3>How to know the operation parameters <p dir="auto">Easiest way is to find the operation on a block explorer. <p dir="auto"><span>e.g. <a href="https://hiveblocks.com/tx/2062bb47ed0c4c001843058129470fe5a8211735" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://hiveblocks.com/tx/2062bb47ed0c4c001843058129470fe5a8211735 <p dir="auto">You can also search the operation in <code>/lib/Helpers/Serializer.php to get an idea of what parameters it requires. <hr /> <h3>Any missing features? <p dir="auto">Create an issue or reach out to me. <hr /> <h3>License <p dir="auto">MIT <hr /> <p dir="auto">I hope PHP developers enjoy this and get away from the "hacks" they used so far to interact with Hive blockchain. <p dir="auto"><br /><span>Composer package: <a href="https://packagist.org/packages/mahdiyari/hive-php" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://packagist.org/packages/mahdiyari/hive-php<span> Gitlab repository: <a href="https://gitlab.com/mahdiyari/hive-php" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://gitlab.com/mahdiyari/hive-php <hr /> <p dir="auto">Almost forgot the bonus content!<br /> <center><img src="https://images.hive.blog/768x0/https://files.peakd.com/file/peakd-hive/mahdiyari/23u69hbZXgiGLqYX8oRkxmTH1CFYbSFSZfNfTABRG8u349MPiZi6j3GrsJwM1kUyDhAfP.jpg" alt="cute-kitten.jpg" srcset="https://images.hive.blog/768x0/https://files.peakd.com/file/peakd-hive/mahdiyari/23u69hbZXgiGLqYX8oRkxmTH1CFYbSFSZfNfTABRG8u349MPiZi6j3GrsJwM1kUyDhAfP.jpg 1x, https://images.hive.blog/1536x0/https://files.peakd.com/file/peakd-hive/mahdiyari/23u69hbZXgiGLqYX8oRkxmTH1CFYbSFSZfNfTABRG8u349MPiZi6j3GrsJwM1kUyDhAfP.jpg 2x" /><br /> <sub><span>Made with ❤️ by <a href="/@mahdiyari">@mahdiyari<br /> <sub>Image source: pixabay.com