Arcium TypeScript SDK - API Reference

This documentation provides comprehensive API reference for the Arcium TypeScript SDK packages. These SDKs enable developers to interact with encrypted Solana programs and the Arcium network.

Looking for more information about the Arcium network?

To learn more about Arcium:

• Arcium Documentation - Learn about network architecture, encrypted computation concepts, and platform overview
• Developer Documentation - Technical guides, tutorials, and best practices

API Reference Overview

This API reference covers the following TypeScript SDK packages:

Available SDK Packages

📦 Client SDK (@arcium-hq/client)

The Client SDK provides functionality for interacting with encrypted Solana programs on the Arcium network.

• Browse API Documentation → Complete API reference for the Client SDK
• NPM Package

npm install @arcium-hq/client

pnpm add @arcium-hq/client

yarn add @arcium-hq/client

bun add @arcium-hq/client

• Key Features:
  • Handle encryption/decryption operations
  • Fetch Arcium network PDAs
  • Track computation status and results

📖 Reader SDK (@arcium-hq/reader)

The Reader SDK enables fetching and monitoring on-chain data from Arcium network programs.

• Browse API Documentation → Complete API reference for the Reader SDK
• NPM Package

npm install @arcium-hq/reader

pnpm add @arcium-hq/reader

yarn add @arcium-hq/reader

bun add @arcium-hq/reader

• Key Features:
  • Query computation states and results
  • Fetch network account addresses (nodes, clusters, MXEs)
  • Subscribe to real-time computation updates
  • Monitor cluster and MXE status

Getting Started

For implementation guides and tutorials on using these SDKs:

1. Visit the Arcium Developer Documentation
2. Check out code examples
3. Join the community for support and discussions