API Reference

Welcome to the AAstar SDK API Reference. Our SDK is designed with a "Pre-check first, Action second" philosophy, providing tools for different ecosystem roles.

📦 Packages Overview

Package	Purpose
@aastar/sdk	Meta Package - The most intuitive entry point for all developers.
@aastar/core	Shared Logic - Essential roles, contract addresses, and requirement checkers.
@aastar/account	Smart Accounts - ERC-4337 account utilities and factories.
@aastar/paymaster	Gas Sponsoring - Client and middleware for Paymaster operations.
@aastar/tokens	Finance - Tools for GT staking and XPNTs management.
@aastar/identity	Reputation - Community reputation scoring and SBT management.
@aastar/analytics	Metrics - Real-time ecosystem monitoring and data retrieval.
@aastar/dapp	React Hooks - Ready-to-use hooks for frontend integration.

---

🚀 Installation & Quick Start

pnpm add @aastar/sdk viem

1. Initialize Client

import { createPublicClient, createWalletClient, http } from 'viem';
import { sepolia } from 'viem/chains';
import { createCommunityClient, createOperatorClient } from '@aastar/sdk';

const publicClient = createPublicClient({ chain: sepolia, transport: http() });
const walletClient = createWalletClient({ chain: sepolia, transport: http() });

const community = createCommunityClient({ publicClient, walletClient });

2. "Pre-check" Pattern

Avoid reverts and save gas by checking requirements off-chain first.

const check = await community.checkLaunchRequirements(myAddress, parseEther("33"));
if (check.success) {
    await community.launchCommunity({ name: "My DAO" });
}

---

🏗️ Core Scenarios

🏛️ For Community Owners

Manage your community registry, configure SBT rules, and handle user onboarding.

• Registry Actions
• SBT Actions

⚙️ For Operators

Onboard as a Paymaster operator, stake GToken, and manage your collateral.

• Operator Client
• Staking Actions

📊 For Finance & Analytics

Monitor tokenomics, handle GToken staking, and track ecosystem metrics.

• Finance Client
• Analytics Client

---

📚 Complete Examples

Practical implementations for common scenarios:

• Operator Flow
• Community Flow
• End User Flow

---

🔧 TypeScript Support

All packages are written in TypeScript with full type definitions.

import type { 
  SupportedNetwork, 
  ClientConfig, 
  RoleRequirement
} from '@aastar/core';

---

🛡️ Error Handling

import { AAStarError } from '@aastar/sdk';

try {
  // ... SDK call
} catch (error) {
  if (error instanceof AAStarError) {
    console.error(error.code, error.message);
  }
}