kaspeak-sdk/README.md

[](https://www.npmjs.com/package/kaspeak-sdk) [](./README.md) [](./README.ru.md)

# Kaspeak SDK

[![npm](https://img.shields.io/npm/v/kaspeak-sdk)](https://www.npmjs.com/package/kaspeak-sdk)
[![en](https://img.shields.io/badge/lang-en-red.svg)](./README.md)
[![ru](https://img.shields.io/badge/lang-ru-green.svg)](./README.ru.md)

**Kaspeak SDK** is a tool for fast and convenient development of decentralized applications on the Kaspa network.  
All network operations, message processing, data packing and unpacking, cryptography, and transaction handling are performed automatically. Developers do not need to dive into low-level networking details, manage transactions manually, or set up encryption themselves. The SDK offers a ready-made solution with a transparent API and a high level of abstraction.

---

## Features

- Transfer of text and binary data via Kaspa
- Simple definition of custom message types
- Built-in cryptographic methods (ECDH, XChaCha20-Poly1305, Schnorr)
- Efficient data compression and packaging (CBOR, Zstandard)
- Confidential messages and unique identifiers
- Usable both in browsers and in Node.js

---

## Installation

```bash
npm install kaspeak-sdk
```

---

## Quick Start and Examples

To quickly get familiar with the SDK capabilities, use the ready-made examples:

* **View all available examples:**

  ```bash
  npx kaspeak-example
  ```

* **Run a specific example:**

  ```bash
  npx kaspeak-example quick-start
  npx kaspeak-example delegate
  npx kaspeak-example secret-message
  ```

* **Run an example using npm scripts:**

  ```bash
  npm run example:quick-start
  npm run example:secret-message
  npm run example:delegate
  ```

---

## Documentation

Comprehensive guide, examples, and API reference:  
📚 https://kaspeak.github.io/kaspeak-sdk/latest/

---

## Feedback & Contribution

* Telegram chat: [RU](https://t.me/kaspeak_ru) / [EN](https://t.me/kaspeak_en)
* Support: [@kaspeak\_support](https://t.me/kaspeak_support)
* [Contribution Guidelines](./docs/en/05-meta/contributing.md)
* Twitter/X: [@KaspeakOfficial](https://x.com/KaspeakOfficial)
* Email: [kaspeak@proton.me](mailto:kaspeak@proton.me)

---

## License

MIT © Kaspeak