Skip to main content

Installation

npm install @onchaindb/sdk

SDK Comparison

FeatureTypeScriptGoPHPPython
Package@onchaindb/sdkgithub.com/onchaindb/sdk-goonchaindb/sdkonchaindb
RuntimeNode.js 18+ / BrowserGo 1.21+PHP 8.1+Python 3.9+
Query BuilderFluent APIFluent API with Done()Fluent APIFluent API
Event SystemEventEmitterCallbacksN/AN/A
Auto-PayYesYesYesYes
LicenseMITMITMITMIT

Quick Start

import { createClient } from '@onchaindb/sdk';

const client = createClient({
  endpoint: 'https://api.onchaindb.io',
  appId: 'your-app-id',
  appKey: 'your-app-key'
});

// Store data
await client.store({
  collection: 'users',
  data: [{ name: 'Alice', email: 'alice@example.com' }]
});

// Query data
const users = await client.findMany('users', { active: true }, { limit: 10 });

Client Initialization

import { createClient } from '@onchaindb/sdk';

const client = createClient({
  endpoint: string,        // OnchainDB server endpoint
  appKey?: string,         // App API key for writes (X-App-Key header)
  userKey?: string,        // User API key for Auto-Pay (X-User-Key header)
  appId?: string,          // Application ID for automatic root building
  timeout?: number,        // Request timeout (default: 30000ms)
  retryCount?: number,     // Retry attempts (default: 3)
  retryDelay?: number,     // Retry delay (default: 1000ms)
});

API Overview