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

# Elacity Javascript/Typescript SDK Documentation

Welcome to the official documentation for Elacity's JavaScript SDKs. This suite of tools enables you to integrate Elacity's backend services, manage NFTs, interact with smart contracts, and build rich media experiences.

## SDK Packages

The Elacity SDK suite is designed to be modular, type-safe, and easy to integrate into any modern JavaScript or TypeScript environment. Each package serves a specific purpose:

### 🌐 [@elacity-js/api](https://elacity.gitbook.io/elacity-sdks/documentation/api/summary.md)

REST and GraphQL API client for interacting with Elacity's backend services:

* Multi-network support (Elastos, Base, Arbitrum Sepolia)
* SIWE (Sign-In with Ethereum) authentication
* Services for NFTs, Channels, and Identity management

[→ View API documentation](https://elacity.gitbook.io/elacity-sdks/documentation/api/summary.md)

***

### ⚡ [@elacity-js/contracts](https://github.com/Elacity/wiki/blob/main/documentation/contracts/README.md)

Framework-agnostic smart contract wrappers for interacting with Elacity's on-chain contracts:

* Support for popular libraries (Ethers.js, Viem, Web3.js)
* Type-safe contract interactions
* Factory, vault, and token contract wrappers

[→ View Contracts documentation](https://github.com/Elacity/wiki/blob/main/documentation/contracts/README.md)

***

### 🎬 [@elacity-js/media-player](https://elacity.gitbook.io/elacity-sdks/documentation/media-player/summary.md)

WebAssembly-based media player for DRM-protected MPEG-DASH streaming with blockchain-based key retrieval:

**⚠️ Browser-Only Platform**: Built entirely on [Media Source Extensions (MSE)](https://www.w3.org/TR/media-source/), requiring browser environment with SharedArrayBuffer support (COOP/COEP headers required).

* MPEG-DASH adaptive streaming support
* Blockchain DRM integration (Lit Protocol, Web3 DRM)
* NFT-gated content access
* Multi-codec support (H.264, AV1, VP9)
* **Browser-only**: Cannot run in Node.js or server-side environments

[→ View Media Player documentation](https://elacity.gitbook.io/elacity-sdks/documentation/media-player/summary.md)

***

### 🎥 [@elacity-js/media-packager](https://elacity.gitbook.io/elacity-sdks/documentation/media-packager/summary.md)

Media upload, processing, and NFT minting package:

* Complete media upload workflow (thumbnail, file, transcode, encode)
* Strategy pattern for automatic listener selection (Firebase real-time or polling)
* Cross-platform support (browser and Node.js)
* Optional blockchain minting integration
* Background job tracking for long-running workflows

[→ View Media documentation](https://elacity.gitbook.io/elacity-sdks/documentation/media-packager/summary.md)

***

### 📦 [@elacity-js/common](https://elacity.gitbook.io/elacity-sdks/documentation/common/summary.md)

Common utilities and shared interfaces used across all SDK packages:

* **Authentication**: Shared `AuthUser` and `AuthSigner` interfaces for SIWE-based authentication
* **Pagination**: Global types for handling large data sets efficiently
* **Storage**: Shared interfaces for session persistence

[→ View Common documentation](https://elacity.gitbook.io/elacity-sdks/documentation/common/summary.md)

***

## Metadata Standards

Canonical metadata JSON schemas and examples are documented in [metadata/schemas](https://elacity.gitbook.io/elacity-sdks/metadata/schemas.md).

## Getting Started

Choose the package that best fits your needs:

* **Building a web app with backend integration?** Start with the [API package](https://elacity.gitbook.io/elacity-sdks/documentation/api/summary.md)
* **Uploading and minting media content?** Use the [Media package](https://elacity.gitbook.io/elacity-sdks/documentation/media-packager/summary.md)
* **Interacting directly with smart contracts?** Check out the [Contracts package](https://github.com/Elacity/wiki/blob/main/documentation/contracts/README.md)
* **Playing DRM-protected media?** Use the [Media Player package](https://elacity.gitbook.io/elacity-sdks/documentation/media-player/summary.md)
* **Need shared utilities?** Explore the [Common package](https://elacity.gitbook.io/elacity-sdks/documentation/common/summary.md)

## Support

For issues, questions, or contributions, please visit our GitHub repository or contact the Elacity team.
