> For the complete documentation index, see [llms.txt](https://timechain.gitbook.io/neucron-javascript-sdk/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://timechain.gitbook.io/neucron-javascript-sdk/overview.md).

# 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 Blockchain. 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

```bash
npm install @neucron/ts-sdk
```

```typescript
import NeucronSDK from '@neucron/ts-sdk';

const sdk = new NeucronSDK();
```

## SDK surface

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

```typescript
sdk.auth          // Authentication
sdk.wallet        // Wallets & transactions
sdk.paymail       // Paymail aliases
sdk.pay           // BSV payments
sdk.assets        // Digital assets
sdk.asset21       // Security / regulated tokens
sdk.utility       // Utility tokens
sdk.dataIntegrity // On-chain inscriptions
sdk.assetSwap     // Asset swaps
sdk.business      // Business profiles
sdk.team          // Teams & invites
sdk.members       // Business members
sdk.rbac          // Roles & permissions
sdk.apps          // Developer apps
sdk.blob          // File / image uploads
sdk.customer      // Customers
sdk.invoice       // Invoices & payment collections
sdk.vendor        // Vendors & expenses
sdk.bill          // Vendor bills
sdk.payout        // Payouts
sdk.billing       // Platform billing & subscriptions
```

## How this documentation is organized

1. [**Quick Start**](/neucron-javascript-sdk/quick-start.md) — install, authenticate, and make your first calls.
2. [**Core**](/neucron-javascript-sdk/core.md) — configuration, auth, headers, responses, and errors.
3. [**Features**](broken://pages/602dfd733e6699f299f2f9d8bbfa5ddfbf967f83) — one page per domain with feature background, then every SDK function documented with parameters, headers, query fields, request body, and response.

{% hint style="info" %}
This documentation describes **SDK functions only**. Interact with Neucron through typed methods such as `sdk.wallet.createWallet(...)`.
{% endhint %}

## 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**](/neucron-javascript-sdk/quick-start.md) guide.