CavosSDK

new CavosSDK(config: CavosConfig)

interface CavosConfig {
  appId: string;
  network?: 'sepolia' | 'mainnet';
  paymasterApiKey?: string;
  starknetRpcUrl?: string;
  enableLogging?: boolean;
  passkeyModal?: {
    title?: string;
    description?: string;
    buttonText?: string;
  };
}

async init(): Promise<void>

async login(
  provider: 'google' | 'apple' | 'firebase',
  credentials?: { email: string; password: string },
  redirectUri?: string
): Promise<void>

await sdk.login('google');
await sdk.login('apple');

await sdk.login('firebase', {
  email: 'user@example.com',
  password: 'password123'
});

async register(
  provider: 'firebase',
  credentials: { email: string; password: string }
): Promise<void>

await sdk.register('firebase', {
  email: 'user@example.com',
  password: 'secure123'
});
// User receives verification email

async isEmailVerified(email: string): Promise<boolean>

const verified = await sdk.isEmailVerified('user@example.com');
if (!verified) {
  showResendButton();
}

async resendVerificationEmail(email: string): Promise<void>

await sdk.resendVerificationEmail('user@example.com');
// User receives new verification email

async loginWithGoogle(redirectUri?: string): Promise<void>

async loginWithApple(redirectUri?: string): Promise<void>

async handleCallback(authDataString: string): Promise<void>

async logout(): Promise<void>

isAuthenticated(): boolean

getUserInfo(): UserInfo | null

async deleteAccount(): Promise<void>

async createWallet(): Promise<void>

getAddress(): string | null

async hasWallet(): Promise<boolean>

async getBalance(): Promise<string>

getFundingAddress(): string | null

async isAccountDeployed(): Promise<boolean>

getWalletStatus(): WalletStatus

const status = sdk.getWalletStatus();

console.log('Deployed:', status.isDeployed);
console.log('Session active:', status.isSessionActive);
console.log('Ready:', status.isReady);

interface WalletStatus {
  isDeployed: boolean;      // Account contract deployed on-chain
  isSessionActive: boolean; // Session key registered and not expired
  isReady: boolean;         // Both deployed and session active
}

async deployAccount(): Promise<string>

async retryWalletUnlock(): Promise<void>

async hasPasskeyOnlyWallet(): Promise<boolean>

async loadPasskeyOnlyWallet(): Promise<void>

async recoverWalletWithPasskey(): Promise<void>

async clearPasskeyOnlyWallet(): Promise<void>

async execute(
  calls: Call | Call[],
  options?: { gasless?: boolean }
): Promise<string>

async signMessage(message: string | TypedData): Promise<Signature>

hasActiveSession(): boolean

async createSession(): Promise<void>

async registerCurrentSession(): Promise<string>

const txHash = await sdk.registerCurrentSession();
console.log('Session registered:', txHash);

async revokeSession(sessionKey?: string): Promise<string>

// Revoke current session
await sdk.revokeSession();

// Revoke specific session
await sdk.revokeSession('0x123abc...');

async emergencyRevokeAllSessions(): Promise<string>

await sdk.emergencyRevokeAllSessions();

exportSession(): string

const token = sdk.exportSession();
console.log('Session token:', token);

// Use in Cavos CLI
// export CAVOS_TOKEN="<token>"
// cavos balance

getOnramp(provider: 'RAMP_NETWORK'): string

getAccount(): Account | null

getSessionAccount(): Account | null

async deleteWallet(): Promise<void>