CavosSDK

new CavosSDK(config: CavosConfig)

interface CavosConfig {
  appId: string;                        // Required: App ID from https://cavos.xyz/dashboard
  network?: 'sepolia' | 'mainnet';      // Default: 'sepolia'
  paymasterApiKey?: string;             // Cavos Paymaster API key
  paymasterUrl?: string;                // Custom paymaster endpoint URL
  starknetRpcUrl?: string;              // Custom Starknet RPC URL
  backendUrl?: string;                  // Default: 'https://cavos.xyz'
  enableLogging?: boolean;              // Default: false
  session?: SessionConfig;              // Session duration and default policy
  oauthWallet?: Partial<OAuthWalletConfig>; // Advanced: custom class hash / registry
  slot?: SlotConfig;                   // Cartridge Slot (Katana) configuration
}

interface SlotConfig {
  rpcUrl: string;                   // Required: RPC URL of your Slot
  chainId?: string;                 // Hex of internal chain ID
  relayerAddress?: string;          // Optional: custom relayer
  relayerPrivateKey?: string;       // Optional: relayer private key
}

interface SessionConfig {
  sessionDuration?: number;         // Seconds (default: 86400 = 24h)
  renewalGracePeriod?: number;      // Seconds (default: 172800 = 48h)
  defaultPolicy?: SessionKeyPolicy;
}

interface SessionKeyPolicy {
  allowedContracts: string[];
  spendingLimits: Array<{ token: string; limit: bigint }>;
  maxCallsPerTx: number;
}

async init(): Promise<void>

const sdk = new CavosSDK({ appId: 'your-app-id', network: 'sepolia' });
await sdk.init();

static handlePopupCallback(): boolean

async login(provider: 'google' | 'apple'): Promise<void>

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

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

await sdk.sendMagicLink('user@example.com');
// Listen for completion:
sdk.onAuthChange(() => {
  console.log('Auth complete:', sdk.getAddress());
});

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

async logout(): Promise<void>

isAuthenticated(): boolean

getUserInfo(): UserInfo | null

getAddress(): string | null

async getBalance(): Promise<string>

async isAccountDeployed(): Promise<boolean>

async deployAccount(): Promise<string>

getWalletStatus(): WalletStatus

interface WalletStatus {
  isDeploying: boolean;
  isDeployed: boolean;
  isRegistering: boolean;
  isSessionActive: boolean;
  isReady: boolean;
  pendingDeployTxHash?: string;
}

onWalletStatusChange(listener: (status: WalletStatus) => void): () => void

const unsubscribe = sdk.onWalletStatusChange((status) => {
  if (status.isReady) console.log('Wallet ready at:', sdk.getAddress());
});

onAuthChange(cb: () => void): () => void

getSessionPublicKey(): string | null

async getAssociatedWallets(): Promise<{ address: string; name?: string }[]>

async switchWallet(name?: string): Promise<void>

getFundingAddress(): string | null

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

async executeOnSlot(calls: Call | Call[]): Promise<string>

async signMessage(typedData: TypedData): Promise<string[]>

async registerCurrentSession(): Promise<string>

updateSessionPolicy(policy: SessionKeyPolicy): void

async renewSession(): Promise<string>

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

const pubKey = sdk.getSessionPublicKey();
if (pubKey) await sdk.revokeSession(pubKey);

async emergencyRevokeAllSessions(): Promise<string>

exportSession(): string

const token = sdk.exportSession();
// cavos session import <token>

getOnramp(provider: 'RAMP_NETWORK'): string

getAccount(): Account | null