HiveXPH SDKhivexph-sdk
NPM
Developer toolkit for Hive Custom JSON and Hive Engine transactions.

Reference

Release notes

Version history for the hivexph-sdk package.

v1.2.0 — Keychain sign-in + checked token creation

  • Added hive.keychain.requestSignIn() for account ownership checks through Hive Keychain.
  • Added typed KeychainSignInInput and KeychainSignInResultexports from the package entry point.
  • Added a sign-in tab to the Keychain playground.
  • Added hive.keychainIssuer.token.create() and hive.issuer.token.create() for the Hive Engine tokens.create action.
  • Both run a preflight first: the account must hold at least the sidechain creation fee in BEE, and the symbol must not already exist. Failures throw INSUFFICIENT_BEE or TOKEN_ALREADY_EXISTS before anything is signed.
  • Added checkCreate() and the exported TokenCreationChecker for reading the fee, the BEE balance and symbol availability without creating anything.
  • Added buildCreate() offline payload previews and a create panel in the token playground.
  • Added hive.keychainIssuer.nft.create() and hive.issuer.nft.create() for the Hive Engine nft.create action, following the same flow as token creation. Only name and symbol are required; orgName, productName, maxSupply, website and the authorized issuing account / contract lists are optional.
  • NFT creation runs the same preflight: 100 BEE by default (read from nft.params) and the symbol must be free, otherwise INSUFFICIENT_BEE or NFT_ALREADY_EXISTS throws before signing. Pass skipChecks: true to opt out.
  • Added NftCreationChecker, NFT checkCreate() / buildCreate() on both issuers, and an NFT creation panel in the NFT playground.

v1.0.0 — initial stable release

  • Standardized Custom JSON payloads: { action, metadata }
  • Raw Custom JSON for protocols with their own payload shape
  • Hive Keychain signing in the browser, no key handling in the SDK
  • Backend issuer for Hive Engine token issue, transfer and burn
  • NFT issue, issue multiple, transfer and burn
  • KeychainIssuer emitting byte-identical contract actions from the frontend
  • Transaction reader with normalized, classified operations
  • One block engine feeding block, Custom JSON and payment watchers
  • Native HIVE/HBD and Layer 2 payment parsing, triggers and validation
  • Configuration system with account aliases and environment resolution
  • Stable error codes on every failure path

Stability policy

v1.0.0 established the public API contract: everything exported from hivexph-sdk is covered by semantic versioning. Breaking changes require a major version; additive changes ship as minor releases.

Note

Anything not exported from the package entry point is internal and may change in any release.