Dubhe Stack API Reference

Complete API documentation for the entire Dubhe technology stack

Dubhe Stack API Reference

Comprehensive API documentation for the complete Dubhe technology stack, covering all four core components: Engine, Channel, OS, and Bot.

Technology Stack Overview

Dubhe provides a complete blockchain application development stack with distinct but integrated components:

Dubhe Engine

Application Development Framework

ECS-based Move framework for building fully on-chain applications with real-time capabilities.

Dubhe Channel

Off-Chain Execution Layer

High-performance execution environment for complex computations with on-chain settlement.

DubheOS

Blockchain Operating System

Complete operating system layer providing unified interfaces and resource management.

Dubhe Bot

Integration Platform

Discord and Telegram bot framework for Web3 community engagement and automation.

API Categories

Dubhe Engine APIs

Core APIs for building on-chain applications:

• Client SDK: TypeScript interface for frontend integration
• Smart Contracts: Move contract interfaces and system functions
• Schemas: Data modeling and component definitions

Dubhe Channel APIs

Off-chain execution and scaling solutions:

• Execution Layer: High-performance computation APIs
• State Channels: Channel management and settlement

DubheOS APIs

Operating system level interfaces:

• System Calls: Core OS functionality and resource access
• Runtime: Application lifecycle and process management

Dubhe Bot APIs

Integration and automation interfaces:

• Discord Integration: Bot commands, events, and community features
• Telegram Integration: Messaging, inline keyboards, and notifications

Authentication & Network

Network Configuration

// Engine Client
const engineClient = new DubheClient({
  network: 'mainnet' | 'testnet' | 'devnet' | 'localnet',
  packageId: 'YOUR_PACKAGE_ID'
});

// Channel Client  
const channelClient = new DubheChannelClient({
  endpoint: 'wss://channel.dubhe.network',
  apiKey: 'YOUR_API_KEY'
});

// OS Client
const osClient = new DubheOSClient({
  nodeUrl: 'https://os.dubhe.network',
  credentials: credentials
});

Rate Limits

Component	Query Rate	Transaction Rate
Engine	1000/min	100/min
Channel	5000/min	1000/min
OS	2000/min	500/min
Bot	100/min	50/min

Error Handling

Common Error Codes

Code	Component	Description
ENGINE_001	Engine	Component not found
CHANNEL_001	Channel	Execution timeout
OS_001	OS	Permission denied
BOT_001	Bot	Invalid webhook signature

Error Response Format

interface ApiError {
  code: string
  message: string
  component: 'engine' | 'channel' | 'os' | 'bot'
  timestamp: number
  details?: any
}

Getting Started

Choose the API documentation for your use case:

Engine API

Build on-chain applications

Channel API

Scale with off-chain execution

OS API

Access system-level features

Bot API

Integrate with communities

SDK Packages

Install the appropriate SDK for your component:

# Dubhe Engine
npm install @0xobelisk/dubhe-client

# Dubhe Channel (Coming Soon)
npm install @0xobelisk/dubhe-channel

# DubheOS (Coming Soon)  
npm install @0xobelisk/dubhe-os

# Dubhe Bot (Coming Soon)
npm install @0xobelisk/dubhe-bot