Getting started

Introduction

hivexph-sdk builds, signs, broadcasts and reads Hive Custom JSON transactions. One namespaced client covers configurations, signing, RPC, Keychain, Hive Engine issuance, transaction reading and block streaming.

Open the playground

What it does

Custom JSON is Hive's general-purpose operation for application data. This SDK standardizes it into a predictable { action, metadata } envelope, keeps protocol-specific payloads (like Hive Engine) untouched when they need to be raw, and gives you a single client object for every runtime.

TypeScript

import { HiveClient } from "hivexph-sdk";

const hive = new HiveClient();

hive.configs   // named configurations + account aliases
hive.rpc       // JSON-RPC communication
hive.keychain  // browser signing through Hive Keychain
hive.issuer    // backend Hive Engine token + NFT issuance
hive.reader    // read a transaction + multi-filter stream dispatcher
hive.blocks    // the one core block stream
hive.customJson// parse + watch standardized custom_json
hive.payments  // native HIVE/HBD + Layer 2 payments and watch()

Install

Shell

npm install hivexph-sdk

Two signing paths

Browser signing and backend signing are deliberately separate APIs. They share pure action builders, so both emit byte-identical payloads, but they never share keys, aliases or configuration.

Keys

The SDK never stores a private key. Backend keys are resolved from environment variables at call time; browser transactions are signed by the Hive Keychain extension.

Where to go next

Start with the quick start, then read architecture for how the namespaces fit together.