Skip to main content

Quick Start

Nitrolite is our official SDK for creating high-performance decentralized applications. It provides a comprehensive set of functions and types to establish WebSocket connections with ClearNode and manage application sessions.

Prerequisites​

Before you begin working with Nitrolite, ensure that you have:

  • Node.js: Version 16 or later
  • Package Manager: npm, yarn, or pnpm
  • Development Environment:
    • For frontend: React, Vue, or similar framework
    • For backend: Node.js environment
  • Channel Setup: Create a channel from your account at apps.yellow.com

Installation​

You can install Nitrolite using your preferred package manager:

npm install @erc7824/nitrolite

ClearNode WebSocket​

ClearNode WebSocket URL: wss://clearnet.yellow.com/ws

Build with AI​

We have generated a llms-full.txt file that converts all our documentation into a single markdown document following the https://llmstxt.org/ standard.

Complete Workflow​

Next steps​

Building applications with Nitrolite involves these key steps:

  1. Channel Creation: Create a channel from your account at apps.yellow.com
  2. ClearNode Connection: Establish WebSocket connection for off-chain messaging
  3. Application Sessions: Create sessions to run specific applications
  4. Session Closure: Properly close application sessions when finished

We recommend working through these guides in sequence to understand the complete application workflow. Each guide builds on concepts from previous sections.

Start with the Channel Creation guide to begin your journey with Nitrolite applications.