@plutoxyz/frame-js

A comprehensive library for integrating with Pluto's privacy-preserving verification system.

Quick Start

npm install @plutoxyz/frame-js

import Pluto, { PageHooks } from "@plutoxyz/frame-js";

const hooks: PageHooks = {
  onSuccess: (proof) => console.log("Verification successful:", proof),
  onError: (error) => console.error("Verification failed:", error),
};

await Pluto.initialize(hooks);
await Pluto.connect(`
  const balance = await getAccountBalance();
  await prove('bank_balance', balance);
`);

Features

• 🔌 WebSocket Client - Real-time communication with automatic reconnection
• 🌐 API Functions - Pre-built functions for all Pluto endpoints
• 📝 Prompt Utilities - Validation and initialization for user prompts
• 💾 Storage Layer - Cross-platform storage abstraction
• 🔧 HTTP Utilities - Robust error handling for API calls

Documentation

Core Functionality

• API Reference - All endpoint functions (submitOauth, getProof, etc.)
• WebSocket Guide - Real-time messaging and event handling
• Utilities - Prompt validation, storage, and HTTP helpers

Examples

• Basic Usage - Simple integration examples
• Advanced WebSocket - Custom WebSocket integrations
• Custom Integration - Building custom flows

TypeScript Support

Full TypeScript support with comprehensive type definitions:

import {
  PromptRequest,
  SocketActionTypes,
  WebSocketClient,
} from "@plutoxyz/frame-js";

React Support

For React applications, use our React wrapper:

npm install @plutoxyz/react-frame

React-frame re-exports all frame-js functionality with additional React hooks and components.

License

MIT