Skip to content

OpenRai/nano-core

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@openrai/nano-core

Typed Nano primitives plus practical client utilities for RPC, WebSocket, and work generation.

npm version License: MIT TypeScript


@openrai/nano-core provides typed Nano primitives and a small transport layer for applications that need reliable RPC, WebSocket, and work generation behavior without rebuilding endpoint parsing, auth handling, failover, or audit visibility. It is designed for direct use in services, scripts, and browser-capable clients, with explicit defaults and observable transport state.

📦 Installation

npm install @openrai/nano-core

(Peer dependency nanocurrency is handled internally as the cryptographic base layer for ECDSA/ed25519 hashing and signing.)

🛠 Quick Start

1. Minimal Client

The default surface should feel obvious on first read:

import { NanoClient } from '@openrai/nano-core';

const client = NanoClient.initialize({
  rpc: [
    'https://rpc.primary.example.com?apiKey=secret-rpc',
    'https://rpc.nano.to',
  ], // [Optional] Defaults to the April 2026 public RPC set
  ws: [
    'wss://ws.primary.example.com?api_key=secret-ws',
    'wss://rpc.nano.to',
  ], // [Optional] Defaults to public WebSocket endpoints
  work: [
    'https://work.primary.example.com?key=secret-work',
    'https://rpc.nano.to',
  ], // [Optional] Defaults to `https://rpc.nano.to` as the current public work endpoint
  warn: (message) => console.warn(message), // [Optional] Defaults to console.warn with nano-core prefix
});

console.log(client.getAuditReport());

1.1 Observe Endpoint Selection

Long-running services can observe which upstream endpoint became active without mutating transport configuration at runtime:

import { NanoClient } from '@openrai/nano-core';

const client = NanoClient.initialize();

const unsubscribe = client.onEndpointChange((event) => {
  console.log(event.kind, event.status, event.activeUrl, event.previousUrl);
});

console.log(client.getActiveEndpoints());
// { rpc?: string, ws?: string, work?: string }

// Later:
unsubscribe();

This is an observe-only API. It does not reconfigure pools or alter failover policy; it simply exposes which endpoint was selected after a successful RPC, WS, or work operation.

What this buys you immediately:

  • comma-separated env vars also work: NANO_RPC_URL, NANO_WS_URL, NANO_WORK_URL
  • malformed or duplicate endpoints are dropped during construction
  • API keys in query params or URL userinfo are extracted and redacted from audit output
  • failover and endpoint-local backoff happen inside the pool, not in your app code

Current built-in defaults as of April 2026:

  • RPC: https://rpc.nano.to, https://node.somenano.com/proxy, https://rainstorm.city/api, https://nanoslo.0x.no/proxy
  • WS: wss://rpc.nano.to
  • Work: https://rpc.nano.to

2. Zero-Config Prototype Mode

Out of the box, NanoClient.initialize() falls back to default public RPC / WS / work pools and auto-configures the work provider:

import { NanoClient } from '@openrai/nano-core';

const client = NanoClient.initialize();

3. Explicit Override Mode

For production environments, you can override only the pieces you care about while keeping the same normalized pool behavior:

import {
  NanoClient,
  WorkProvider,
  RemoteWorkServer,
  LocalCompute,
} from '@openrai/nano-core';

const client = NanoClient.initialize({
  network: 'mainnet', // [Optional] Defaults to 'mainnet'
  rpc: [
    'https://rpc.private.example.com?apiKey=secret-rpc',
    'https://rpc.nano.to',
  ], // [Optional] Defaults to the April 2026 public RPC set
  ws: [
    'wss://ws.private.example.com?api_key=secret-ws',
    'wss://rpc.nano.to',
  ], // [Optional] Defaults to public WebSocket endpoints
  workProvider: WorkProvider.auto({
    urls: [
      'https://work.private.example.com?key=secret-work',
    ], // [Optional] Defaults to `https://rpc.nano.to` when omitted
    remotes: [
      RemoteWorkServer.of(
        'https://work-backup.example.com',
        {
          timeoutMs: 5000, // [Optional] Defaults to 5000
          circuitBreakerMs: 30000, // [Optional] Reserved for future tuning
        },
      ),
    ], // [Optional] Additional remote work backends
    localChain: [
      LocalCompute.WEBGPU,
      LocalCompute.WASM_THREADS,
      LocalCompute.CPU,
    ], // [Optional] Local fallback order
    profiler: {
      mode: 'manual',
      preferLocalAboveMhs: 30,
      cacheStrategy: 'persistent',
    }, // [Optional] Calibration strategy overrides
    warn: (message) => console.warn(message), // [Optional] Defaults to console.warn with nano-core prefix
  }), // [Optional] Defaults to WorkProvider.auto(...) using normalized work endpoints
  warn: (message) => console.warn(message), // [Optional] Defaults to console.warn with nano-core prefix
});

4. Isomorphic Work Calibration

nano-core can probe remote and local work capabilities asynchronously, then build an execution plan without doing any heavyweight work in constructors. When profiler.mode is auto, call probe() or calibrate() explicitly during startup and reuse the resulting plan for later work generation.

const plan = await client.workProvider.probe();
console.log(plan.steps);

const profile = await client.workProvider.calibrate();
console.log(profile.activeStrategy);

5. Precision-Safe Execution

NanoAmount and NanoAddress give you typed protocol primitives immediately, even while the higher-level wallet surface is still being filled out.

import { NanoAddress, NanoAmount } from '@openrai/nano-core';

const destination = NanoAddress.parse(
  'nano_3arg3asgtigae3xckabaaewkx3bzsh7nwz7jkmjos79ihyaxwphhm6qgjps4',
);

const amount = NanoAmount.fromNano('1.25');

const wallet = await client.hydrateWallet(
  process.env.NANO_SEED,
  { index: 0 }, // [Optional] Defaults to account index 0
);

console.log({ destination, amount, wallet });

📐 Architecture Comparison

If you are migrating from existing libraries:

Feature @openrai/nano-core nano-wallet-js libnemo @nano/wallet
Concurrency Map High (Mutex Queues) High Medium Low
PoW Abstraction Adaptive JIT Profiler Dedicated Server Optional Ledger Public Rest
Type Safety High (NanoAmount) String / BigInt String String
Target Audience Enterprise & Framework Authors Legacy Node.js Lightweight Web Apps Tip-Bots

🤝 Contributing & Tier-1 Roadmap

@openrai/nano-core acts as Phase 1 of the Dual-SDK architecture (coupled alongside the higher-level @openrai/raiflow-sdk Business API).

Future phases will port the exact class structures above to:

  1. Rust: Embedded systems, high-performance PoW nodes.
  2. Go: Microservice ecosystems.
  3. Zig: Low-latency game engine integrations.

For collaboration, please refer to the github.com/OpenRai/nano-core issues board.


See docs/architecture/transport-auth.md for the transport/auth design. More advanced local-vs-remote work profiling is planned but not implemented in the current release.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors