muvon/bitclout-node-api

Implementation of Bitclout API interaction through its node

0.6.1 2021-08-26 19:51 UTC

Requires

• minter/minter-php-bip-44: ^1.2
• muvon/base58-codec: ^0.1
• muvon/kiss-binary-codec: ^0.4.0
• muvon/kiss-request-trait: ^0.9.0
• simplito/elliptic-php: ^1.0.6

Requires (Dev)

• phpunit/phpunit: ^10

MIT

• Muvon Co. Ltd

• rpc
• api
• node
• token
• blockchain
• cryptocurrency
• coin
• bitclout
• bclt

README

This package allows to interract with Bitclout node with exposed API

Installation

To install it just use composer

composer require muvon/bitclout-node-api

How to use

First of all create install of NodeAPI class

use Muvon\Bitclout\NodeAPI;

$node = NodeAPI::create([
  'read_url' => 'https://api.bitclout.com',
  'write_url' => 'https://api.bitclout.com',
  'mnemonic' => 'your mnemonic of 12 words'
]);

Config array description:

• read_url - url we use for read api calls;
• write_url - url we use for write api calls;
• url - you can pass single url for read and write operations if its the same;
• mnemonic - main account that used as reader and signer for all requests;
• private_key - pass hexed private key if not passed mnemonic;
• public_key - required only in case if you use private key as hex. In case you use mnemonic it's derived from it.

Methods available and instructions to use

generateAddress(): array

Generate new address and return full info about it

Return value is array with that structur

  {
    "address": "BC1... address",
    "public": "public key in hex format",
    "secret": {
      "private": "private key in hex format of hd path: m/44'/0'/0'/0/0",
      "seed": "main seed derived from 12 words",
      "mnemonic": "12 words mnemnoic",
    }
  }

Tests

• Get profile by username
• Get profile by pubkey
• Get address transactions