@orbinum/sdk

Official TypeScript SDK for Orbinum — a privacy-focused blockchain built on Substrate with an EVM compatibility layer.

Installation

npm install @orbinum/sdk
# or
pnpm add @orbinum/sdk

Requirements

• Node.js 18 or later
• A running Orbinum node (Substrate WebSocket endpoint)

Quick Start

import { OrbinumClient } from '@orbinum/sdk';

const client = await OrbinumClient.connect({
    substrateWs: 'ws://localhost:9944',
    evmRpc: 'http://localhost:9933', // optional
});

const info  = await client.substrate.getChainInfo();
const root  = await client.rpcV2.privacy.getMerkleRoot();
const block = await client.substrate.getBlock('best');
const isValidator = await client.rpcV2.chain.isValidator('5GrwvaEF...');

OrbinumClient exposes the following modules:

| Property | Description | |---|---| | client.substrate | Substrate RPC — blocks, events, transactions | | client.evm | EVM JSON-RPC client (null if evmRpc not set) | | client.rpcV2 | Orbinum rpc-v2 namespaces (chain_*, privacy_*) | | client.rpcV2.chain | Chain-level queries (chain_isValidator, etc.) | | client.shieldedPool | Shielded pool extrinsics | | client.accountMapping | Alias, chain-link, and identity operations | | client.precompiles | EVM precompile wrappers (null if evmRpc not set) |

Each module can also be instantiated independently without OrbinumClient.

License

MIT