NOTE: this is still a draft, so it's subject to changes. This alert will be removed as soon as final version will be available

πŸ› οΈ@hsuite/smartnode-sdk - SmartNode Software Development Kit

πŸš€ Comprehensive SDK for SmartNode services and multi-ledger blockchain operations

Enterprise-grade TypeScript SDK providing unified access to SmartNode network operations, validator management, and complete Hedera Hashgraph integration with extensible architecture for multi-blockchain support.


πŸ“š Table of Contents


✨ Quick Start

Installation

npm install @hsuite/smartnode-sdk

Basic Setup

Basic Usage


πŸ—οΈ Architecture

Hierarchical SDK Structure

The SDK provides a comprehensive, hierarchical structure through the SmartNodeSdkService:

Core Components

🌐 SmartNode Services

  • General Operations - Node identification, status monitoring, network management

  • Validator Management - Consensus, token, and account validator operations

  • Network Coordination - Multi-node communication and coordination

⚑ Hedera Hashgraph Integration

  • Account Services - Complete account lifecycle management

  • Transaction Services - Transaction submission and monitoring

  • Consensus Service (HCS) - Topic management and messaging

  • Token Service (HTS) - Token operations and management

πŸ”„ Extensible Architecture

  • Multi-Ledger Support - Ready for Ripple and other blockchain integrations

  • Modular Design - Independent service modules with clear separation

  • Type-Safe Configuration - Full TypeScript support with runtime validation

Module Structure


πŸ”§ API Reference

SmartNodeSdkService

Core SDK Structure

SmartNode Services

GeneralSdk - Core SmartNode Operations

getIdentifier(): Promise<ISmartNetwork.IOperator.IEntity>

  • Retrieves SmartNode operator entity details

  • Returns: Unique identifier and node details

  • Usage: Node identification in network operations

getStatus(): Promise<ISmartNetwork.ISmartNode.IState>

  • Gets current operational status and health metrics

  • Returns: Node status, uptime, performance metrics

  • Usage: Health monitoring and diagnostics

getNetwork(): Promise<Array<ISmartNetwork.INetwork.IEntity>>

  • Retrieves comprehensive list of whitelisted smart-nodes

  • Returns: Array of network entities with status and capabilities

  • Usage: Network topology and node discovery

getUtilities(): Promise<any>

  • Retrieves HSuite utility tokens and capabilities

  • Returns: Available utilities and their configurations

  • Usage: Feature discovery and capability assessment

ValidatorsSdk - Validator Management

Consensus Validators:

  • addConsensusValidator(params): Promise<string> - Submit new consensus validator

  • readConsensusValidator(timestamp): Promise<IValidators.IConsensus.IValidationParams> - Retrieve consensus validator

Token Validators:

  • addTokenValidator(params): Promise<string> - Submit new token validator

  • readTokenValidator(timestamp): Promise<IValidators.IToken.IValidationParams> - Retrieve token validator

Account Validators:

  • addAccountValidator(params): Promise<string> - Submit new account validator

  • readAccountValidator(timestamp): Promise<IValidators.IAccount.IValidationParams> - Retrieve account validator

Hedera Hashgraph Services

AccountsHashgraphSdk - Account Management

Account Information:

  • getInfo(accountId): Promise<IHashgraph.ILedger.IAccounts.IResponse.IInfo> - Account details

  • getKeys(accountId): Promise<any> - Account public keys

  • getAccountBalance(accountId): Promise<any> - Account balance query

Account Lifecycle:

  • createAccount(params): Promise<any> - Create new account

  • updateAccount(accountId, params): Promise<any> - Update account properties

  • deleteAccount(accountId, params): Promise<any> - Delete account

Transfer Operations:

  • transferHbar(params): Promise<any> - HBAR transfers

  • transferToken(params): Promise<any> - Fungible token transfers

  • transferNftToken(params): Promise<any> - NFT transfers

TransactionsHashgraphSdk - Transaction Management

Transaction Operations:

  • Transaction submission and status monitoring

  • Transaction history and queries

  • Fee estimation and optimization

  • Batch transaction processing

HcsHashgraphSdk - Hedera Consensus Service

Topic Management:

  • Topic creation, update, and deletion

  • Topic configuration and permissions

  • Topic information retrieval

Message Operations:

  • Message submission to topics

  • Message retrieval and history

  • Subscription management

HtsHashgraphSdk - Hedera Token Service

Token Management:

  • Token creation and configuration

  • Token information queries

  • Supply management operations

Token Operations:

  • Token transfers and approvals

  • NFT minting and burning

  • Token association and dissociation

Configuration Interfaces

SDK Options Interface


πŸ“– Guides

SmartNode Network Guide

Learn about SmartNode network operations and topology management. Comprehensive guide covering network architecture, node discovery, consensus mechanisms, validator management, and enterprise-grade SmartNode deployment and operations.

Validator Setup Guide

Configure and manage validators across different topics. Advanced configuration guide covering validator deployment, consensus topic management, validation rules, performance monitoring, and enterprise validator infrastructure management.

Hedera Integration Guide

Complete guide to using Hedera Hashgraph services through the SDK. Detailed integration guide covering Hedera account management, transaction processing, token operations, consensus service, and enterprise Hedera blockchain integration.


🎯 Examples

SmartNode Network Operations

Validator Management Operations

Hedera Account Management

Hedera Consensus Service Operations

Hedera Token Service Operations

Comprehensive SDK Integration


πŸ”— Integration

Required Dependencies

Environment Variables

Module Configuration

Integration with HSuite Ecosystem


πŸš€ Enterprise SDK: Comprehensive SmartNode integration with full TypeScript support and enterprise-grade reliability.

🌐 Multi-Ledger Ready: Extensible architecture supporting Hedera Hashgraph with planned Ripple integration.

⚑ Developer Focused: Type-safe APIs with comprehensive documentation and extensive example implementations.


Built with ❀️ by the HSuite Team Copyright © 2025 HSuite. All rights reserved.

Last updated