Introduction

Explore our JS SDK for building applications with Lit Protocol

SDK Reference

The Lit JS SDK provides a comprehensive toolkit for integrating Lit Protocol’s decentralised authentication and cryptographic capabilities into your applications. This reference documentation covers all the methods, classes, and configuration options available in the SDK.

1. Client Setup Layer

• Lit Client Setup: Initialize and configure your connection to the Lit Protocol network
• Auth Manager Setup: Manage authentication state and session persistence across your application
• Payment Manager Setup: Deposit funds and delegate payment for network compute resources
• Auth Services Setup: Configure backend services for minting PKPs and managing OAuth-based sign-in flows

2. Authentication Options

• PKP Native Authentication: Authenticate using built-in methods like social login, WebAuthn, or OTP to create and access PKPs
• PKP Custom Authentication: Implement custom authentication flows using your own identity providers or auth methods
• EOA Authentication: Use traditional wallet-based authentication with externally owned accounts

3. Auth Context Consumption / Core API Methods

• pkpSign: Sign transactions and messages using your authenticated PKP wallet
• executeJs: Run serverless JavaScript functions with decentralized access control and key management
• encryptAndDecrypt: Encrypt data that can only be decrypted by authorized users or under specific conditions

4. PKP Wallet Management

• PKP Permissions: Control which users and applications can use your PKP for signing and decryption
• PKP Viem Account: Integrate your PKP with Viem for seamless Ethereum transaction building and signing
• PKP View Helpers: Query and inspect PKP permissions and metadata from the blockchain

5. Network Status & Monitoring

• Network Status: Check real-time health metrics and availability across Lit Protocol’s decentralized network