For the complete documentation index, see llms.txt. This page is also available as Markdown.

Overview

Welcome to the official documentation for @neucron/ts-sdk — a type-safe TypeScript SDK for building applications on the Neucron platform.

Neucron provides wallets, digital assets, payments, invoicing, security tokens, and business tooling on Bitcoin SV. This SDK exposes those capabilities as typed methods so you can build products without wiring low-level requests yourself.

What you can build

Domain
Capabilities

Authentication

Sign up, login, profile management, password recovery

Wallets

Create wallets, addresses, balances, transaction history

Payments

Pay by address, email, or paymail; manage paymail aliases

Assets

Certificates, utility tokens, tickets, transfers, ledgers

Security tokens (Asset21)

Register, deploy, mint, redeem, freeze, blacklist, governance

Business

Business profiles, teams, members, RBAC roles

Commerce

Customers, invoices, payment collections, vendors, bills, payouts

Developer apps

Create apps, secrets, publish to the app store, blob uploads

Data integrity

Inscribe files and text on-chain for tamper-evident records

Billing

Plans, credits, subscriptions, platform invoices

Package

npm install @neucron/ts-sdk
import NeucronSDK from '@neucron/ts-sdk';

const sdk = new NeucronSDK();

SDK surface

Every feature is exposed as a property on the main client:

How this documentation is organized

  1. Quick Start — install, authenticate, and make your first calls.

  2. Core — configuration, auth, headers, responses, and errors.

  3. Features — one page per domain with feature background, then every SDK function documented with parameters, headers, query fields, request body, and response.

This documentation describes SDK functions only. Interact with Neucron through typed methods such as sdk.wallet.createWallet(...).

Requirements

  • Node.js 18+ (or a modern bundler / React Native environment)

  • TypeScript 5+ recommended (JavaScript works; types are included)

  • A Neucron account (email + password) or an existing auth token

Next step

Start with the Quick Start guide.

Last updated