Circles SDK v2

A comprehensive TypeScript SDK for the Circles protocol.

📚 API Documentation

View Complete API Documentation →

Detailed API reference with types, classes, and interfaces for all packages.

🚀 Quick Start

Installation

bun install
bun run build

Basic Usage

Core SDK - Contract Interaction

import { Core } from '@aboutcircles/sdk-core';

const core = new Core();

const tx = core.hubV2.groupMint(
  '0x1234567890123456789012345678901234567890',
  ['0xRecipient1', '0xRecipient2'],
  [BigInt(100), BigInt(200)],
  '0x'
);

RPC SDK - Data Queries

import { CirclesRpc } from '@aboutcircles/sdk-rpc';

const rpc = new CirclesRpc('https://rpc.circlesubi.network/');

// Get balance
const balance = await rpc.circlesV2.getTotalBalance('0xYourAddress');

// Find transfer path
const path = await rpc.circlesV2.findPath({
  from: '0xSenderAddress',
  to: '0xRecipientAddress',
  targetFlow: BigInt(100)
});

📦 Packages

• @aboutcircles/sdk - Main SDK package
• @aboutcircles/sdk-core - Contract wrappers for direct blockchain interaction
• @aboutcircles/sdk-rpc - RPC client for querying Circles data and pathfinding
• @aboutcircles/sdk-types - Shared TypeScript types
• @aboutcircles/sdk-abis - Contract ABIs
• @aboutcircles/sdk-utils - Utility functions
• @aboutcircles/sdk-profiles - Profile management
• @aboutcircles/sdk-pathfinder - Transfer pathfinding algorithms
• @aboutcircles/sdk-transfers - Transfer operations
• @aboutcircles/sdk-runner - Transaction execution

💡 Examples

Explore comprehensive examples in the examples/ directory:

Core SDK:

• Basic Usage - Core initialization
• HubV2 Operations - Contract operations
• BaseGroup Management - Group creation

RPC SDK:

• RPC Client - Client configuration
• Balance & Pathfinding
• Trust Relations
• Avatar Info
• Profiles

View all examples →

Run examples:

bun run examples                           # All examples
bun run examples/core/01-basic-usage.ts    # Specific example

🛠️ Development

# Build
bun run build              # All packages
bun run build:core         # Core package
bun run build:rpc          # RPC package

# Development (watch mode)
bun run dev               # All packages
bun run dev:core          # Core package

# Documentation
bun run docs              # Generate API docs

# Publishing
bun run publish           # Build and publish all packages

# Clean
bun run clean             # Remove build artifacts

📄 License

MIT