muvon / bitclout-node-api
通过其节点实现Bitclout API交互
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
README
此软件包允许通过公开API与Bitclout节点交互
安装
只需使用Composer即可安装
composer require muvon/bitclout-node-api
使用方法
首先创建NodeAPI类的实例
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' ]);
配置数组说明
- read_url - 用于读取API调用的URL;
- write_url - 用于写入API调用的URL;
- url - 如果读取和写入操作使用相同的URL,您可以传递单个URL;
- mnemonic - 作为所有请求的读取器和签名的主账户;
- private_key - 如果未传递助记词,则传递十六进制私钥;
- public_key - 仅在您使用十六进制私钥的情况下需要。如果您使用助记词,它将从它派生出来。
可用的方法和使用说明
generateAddress(): array
生成新地址并返回其完整信息
返回值是具有以下结构的数组
{ "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", } }
测试
- 通过用户名获取配置文件
- 通过公钥获取配置文件
- 获取地址交易